]> git.donarmstrong.com Git - lilypond.git/blob - lily/break-align-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / break-align-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
5
6   LilyPond is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   LilyPond is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
18 */
19 #include "engraver.hh"
20 #include "protected-scm.hh"
21 #include "break-align-interface.hh"
22 #include "align-interface.hh"
23 #include "axis-group-interface.hh"
24 #include "context.hh"
25 #include "translator-group.hh"
26 #include "item.hh"
27
28 #include "translator.icc"
29
30 class Break_align_engraver : public Engraver
31 {
32   Item *align_;
33   SCM column_alist_;
34   Item *left_edge_;
35
36   void add_to_group (SCM, Item *);
37   void create_alignment (Grob_info);
38 protected:
39   void stop_translation_timestep ();
40   virtual void derived_mark () const;
41 public:
42   TRANSLATOR_DECLARATIONS (Break_align_engraver);
43   void acknowledge_break_aligned (Grob_info);
44   void acknowledge_break_alignable (Grob_info);
45 };
46
47 void
48 Break_align_engraver::stop_translation_timestep ()
49 {
50   column_alist_ = SCM_EOL;
51
52   align_ = 0;
53   left_edge_ = 0;
54 }
55
56 Break_align_engraver::Break_align_engraver (Context *c)
57   : Engraver (c)
58 {
59   column_alist_ = SCM_EOL;
60   left_edge_ = 0;
61   align_ = 0;
62 }
63
64 void
65 Break_align_engraver::derived_mark () const
66 {
67   scm_gc_mark (column_alist_);
68 }
69
70 void
71 Break_align_engraver::acknowledge_break_alignable (Grob_info inf)
72 {
73   /*
74     Special case for MetronomeMark: filter out items which will be aligned
75     on note heads rather than prefatory material
76   */
77   if (!Item::is_non_musical (inf.item ()))
78     return;
79
80   if (!align_)
81     create_alignment (inf);
82
83   Grob *g = inf.grob ();
84
85   if (!g->get_parent (X_AXIS))
86     g->set_parent (align_, X_AXIS);
87 }
88
89 void
90 Break_align_engraver::acknowledge_break_aligned (Grob_info inf)
91 {
92   if (Item *item = dynamic_cast<Item *> (inf.grob ()))
93     {
94       /*
95         Removed check for item->empty (X_AXIS). --hwn 20/1/04
96       */
97       if (item->get_parent (X_AXIS))
98         return;
99
100       if (!Item::is_non_musical (item))
101         return;
102
103       SCM align_name = item->get_property ("break-align-symbol");
104       if (!scm_is_symbol (align_name))
105         return;
106
107       if (!align_)
108         create_alignment (inf);
109
110       add_to_group (align_name, item);
111     }
112 }
113
114 void
115 Break_align_engraver::create_alignment (Grob_info inf)
116 {
117   align_ = make_item ("BreakAlignment", SCM_EOL);
118
119   Context *origin = inf.origin_contexts (this)[0];
120
121   Translator_group *tg = origin->implementation ();
122   Engraver *random_source = unsmob<Engraver> (scm_car (tg->get_simple_trans_list ()));
123   if (!random_source)
124     random_source = this;
125
126   /*
127     Make left edge appear to come from same context as clef/bar-line etc.
128   */
129   left_edge_ = random_source->make_item ("LeftEdge", SCM_EOL);
130   add_to_group (left_edge_->get_property ("break-align-symbol"),
131                 left_edge_);
132 }
133
134 void
135 Break_align_engraver::add_to_group (SCM align_name, Item *item)
136 {
137   SCM s = scm_assoc (align_name, column_alist_);
138   Item *group = 0;
139
140   if (scm_is_true (s))
141     {
142       Grob *e = unsmob<Grob> (scm_cdr (s));
143       group = dynamic_cast<Item *> (e);
144     }
145   else
146     {
147       group = make_item ("BreakAlignGroup", item->self_scm ());
148
149       group->set_property ("break-align-symbol", align_name);
150       group->set_parent (align_, Y_AXIS);
151
152       column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
153
154       Break_alignment_interface::add_element (align_, group);
155     }
156   Axis_group_interface::add_element (group, item);
157 }
158
159 void
160 Break_align_engraver::boot ()
161 {
162   ADD_ACKNOWLEDGER (Break_align_engraver, break_aligned);
163   ADD_ACKNOWLEDGER (Break_align_engraver, break_alignable);
164 }
165
166 ADD_TRANSLATOR (Break_align_engraver,
167                 /* doc */
168                 "Align grobs with corresponding @code{break-align-symbols}"
169                 " into groups, and order the groups according to"
170                 " @code{breakAlignOrder}.  The left edge of the alignment gets"
171                 " a separate group, with a symbol @code{left-edge}.",
172
173                 /* create */
174                 "BreakAlignment "
175                 "BreakAlignGroup "
176                 "LeftEdge ",
177
178                 /* read */
179                 "",
180
181                 /* write */
182                 ""
183                );