]> git.donarmstrong.com Git - lilypond.git/blob - lily/rhythmic-column-engraver.cc
Merge with master
[lilypond.git] / lily / rhythmic-column-engraver.cc
1 /*
2   rhythmic-column-engraver.cc -- implement Rhythmic_column_engraver
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 */
8
9 #include "engraver.hh"
10 #include "rhythmic-head.hh"
11 #include "stem.hh"
12 #include "note-column.hh"
13 #include "item.hh"
14 #include "dot-column.hh"
15 #include "pointer-group-interface.hh"
16
17 #include "translator.icc"
18
19 /*
20   this engraver  glues together stems, rests and note heads into a NoteColumn
21   grob.
22
23   It also generates spacing objects.  Originally, we have tried to
24   have the spacing functionality at different levels.
25
26   - by simply using the sequence of Separation-item as
27   spacing-sequences (at staff level). Unfortunately, this fucks up if
28   there are different kinds of tuplets in different voices (8th and
29   8ths triplets combined made the program believe there were 1/12 th
30   notes.).
31
32   Doing it in a separate engraver using timing info is generally
33   complicated (start/end time management), and fucks up if a voice
34   changes staff.
35
36   Now we do it from here again. This has the problem that voices can
37   appear and disappear at will, leaving lots of loose ends (the note
38   spacing engraver don't know where to connect the last note of the
39   voice on the right with), but we don't complain about those, and let
40   the default spacing do its work.
41 */
42
43 class Rhythmic_column_engraver : public Engraver
44 {
45   vector<Grob*> rheads_;
46   Grob *stem_;
47   Grob *note_column_;
48   Grob *dotcol_;
49
50   TRANSLATOR_DECLARATIONS (Rhythmic_column_engraver);
51 protected:
52
53   DECLARE_ACKNOWLEDGER (dot_column);
54   DECLARE_ACKNOWLEDGER (stem);
55   DECLARE_ACKNOWLEDGER (rhythmic_head);
56   void process_acknowledged ();
57   void stop_translation_timestep ();
58 };
59
60 Rhythmic_column_engraver::Rhythmic_column_engraver ()
61 {
62
63   stem_ = 0;
64   note_column_ = 0;
65   dotcol_ = 0;
66 }
67
68
69 void
70 Rhythmic_column_engraver::process_acknowledged ()
71 {
72   if (rheads_.size ())
73     {
74       if (!note_column_)
75         {
76           note_column_ = make_item ("NoteColumn", rheads_[0]->self_scm ());
77         }
78
79       for (vsize i = 0; i < rheads_.size (); i++)
80         {
81           if (!rheads_[i]->get_parent (X_AXIS))
82             Note_column::add_head (note_column_, rheads_[i]);
83         }
84       rheads_.resize (0);
85     }
86
87   if (note_column_)
88     {
89       if (dotcol_
90           && !dotcol_->get_parent (X_AXIS))
91         Note_column::set_dotcol (note_column_, dotcol_);
92
93       if (stem_
94           && !stem_->get_parent (X_AXIS))
95         {
96           Note_column::set_stem (note_column_, stem_);
97           stem_ = 0;
98         }
99     }
100 }
101
102 void
103 Rhythmic_column_engraver::acknowledge_stem (Grob_info i)
104 {
105   stem_ = i.grob ();
106 }
107
108 void
109 Rhythmic_column_engraver::acknowledge_rhythmic_head (Grob_info i)
110 {
111   rheads_.push_back (i.grob ());
112 }
113
114 void
115 Rhythmic_column_engraver::acknowledge_dot_column (Grob_info i)
116 {
117   dotcol_ = i.grob ();
118 }
119
120 void
121 Rhythmic_column_engraver::stop_translation_timestep ()
122 {
123   note_column_ = 0;
124   dotcol_ = 0;
125   stem_ = 0;
126 }
127
128 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, dot_column);
129 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, stem);
130 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, rhythmic_head);
131
132 ADD_TRANSLATOR (Rhythmic_column_engraver,
133                 /* doc */ "Generates NoteColumn, an objects that groups stems, noteheads and rests.",
134                 /* create */ "NoteColumn",
135                 /* read */ "",
136                 /* write */ "");