]> git.donarmstrong.com Git - lilypond.git/blob - lily/laissez-vibrer-engraver.cc
Doc-es: various updates.
[lilypond.git] / lily / laissez-vibrer-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6
7   LilyPond is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   LilyPond is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "engraver.hh"
22 #include "item.hh"
23 #include "pointer-group-interface.hh"
24 #include "stream-event.hh"
25
26 #include "translator.icc"
27
28 class Laissez_vibrer_engraver : public Engraver
29 {
30   Stream_event *event_;
31   Grob *lv_column_;
32   vector<Grob *> lv_ties_;
33
34   void stop_translation_timestep ();
35   void acknowledge_note_head (Grob_info);
36 protected:
37   void listen_laissez_vibrer (Stream_event *);
38 public:
39   TRANSLATOR_DECLARATIONS (Laissez_vibrer_engraver);
40 };
41
42 Laissez_vibrer_engraver::Laissez_vibrer_engraver (Context *c)
43   : Engraver (c)
44 {
45   event_ = 0;
46   lv_column_ = 0;
47 }
48
49 void
50 Laissez_vibrer_engraver::stop_translation_timestep ()
51 {
52   event_ = 0;
53   lv_column_ = 0;
54   lv_ties_.clear ();
55 }
56
57 void
58 Laissez_vibrer_engraver::listen_laissez_vibrer (Stream_event *ev)
59 {
60   ASSIGN_EVENT_ONCE (event_, ev);
61 }
62
63 void
64 Laissez_vibrer_engraver::acknowledge_note_head (Grob_info inf)
65 {
66   /* use the heard event_ for all note heads, or an individual event for just
67    * a single note head (attached as an articulation inside a chord) */
68   Stream_event *tie_ev = event_;
69   Grob *head = inf.grob ();
70   Stream_event *note_ev = unsmob<Stream_event> (head->get_property ("cause"));
71   if (!tie_ev && note_ev && note_ev->in_event_class ("note-event"))
72     {
73       SCM articulations = note_ev->get_property ("articulations");
74       for (SCM s = articulations; !tie_ev && scm_is_pair (s); s = scm_cdr (s))
75         {
76           Stream_event *ev = unsmob<Stream_event> (scm_car (s));
77           if (ev && ev->in_event_class ("laissez-vibrer-event"))
78             tie_ev = ev;
79         }
80     }
81
82   if (!tie_ev)
83     return;
84
85   SCM cause = tie_ev->self_scm ();
86
87   if (!lv_column_)
88     lv_column_ = make_item ("LaissezVibrerTieColumn", cause);
89
90   Grob *lv_tie = make_item ("LaissezVibrerTie", cause);
91   lv_tie->set_object ("note-head", head->self_scm ());
92
93   Pointer_group_interface::add_grob (lv_column_, ly_symbol2scm ("ties"),
94                                      lv_tie);
95
96   if (is_direction (unsmob<Stream_event> (cause)->get_property ("direction")))
97     {
98       Direction d = to_dir (unsmob<Stream_event> (cause)->get_property ("direction"));
99       lv_tie->set_property ("direction", scm_from_int (d));
100     }
101
102   lv_tie->set_parent (lv_column_, Y_AXIS);
103
104   lv_ties_.push_back (lv_tie);
105 }
106
107 void
108 Laissez_vibrer_engraver::boot ()
109 {
110   ADD_LISTENER (Laissez_vibrer_engraver, laissez_vibrer);
111   ADD_ACKNOWLEDGER (Laissez_vibrer_engraver, note_head);
112 }
113
114 ADD_TRANSLATOR (Laissez_vibrer_engraver,
115                 /* doc */
116                 "Create laissez vibrer items.",
117
118                 /* create */
119                 "LaissezVibrerTie "
120                 "LaissezVibrerTieColumn ",
121
122                 /* read */
123                 "",
124
125                 /* write */
126                 ""
127                );