2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
21 #include "paper-column.hh"
22 #include "align-interface.hh"
23 #include "axis-group-interface.hh"
24 #include "engraver.hh"
25 #include "international.hh"
27 #include "pointer-group-interface.hh"
28 #include "grob-array.hh"
30 #include "translator.icc"
32 class Vertical_align_engraver : public Engraver
35 bool qualifies (Grob_info) const;
36 SCM id_to_group_hashtab_;
39 TRANSLATOR_DECLARATIONS (Vertical_align_engraver);
40 void acknowledge_axis_group (Grob_info);
43 virtual void derived_mark () const;
44 void process_music ();
45 virtual void finalize ();
46 virtual void initialize ();
52 Vertical_align_engraver::boot ()
54 ADD_ACKNOWLEDGER (Vertical_align_engraver, axis_group);
57 ADD_TRANSLATOR (Vertical_align_engraver,
59 "Catch groups (staves, lyrics lines, etc.) and stack them"
74 Vertical_align_engraver::Vertical_align_engraver ()
77 id_to_group_hashtab_ = SCM_EOL;
82 Vertical_align_engraver::derived_mark () const
84 scm_gc_mark (id_to_group_hashtab_);
88 Vertical_align_engraver::initialize ()
90 id_to_group_hashtab_ = scm_c_make_hash_table (11);
94 Vertical_align_engraver::process_music ()
96 if (!valign_ && !scm_is_null (id_to_group_hashtab_))
98 if (to_boolean (get_property ("hasAxisGroup")))
100 warning (_ ("Ignoring Vertical_align_engraver in VerticalAxisGroup"));
101 id_to_group_hashtab_ = SCM_EOL;
105 top_level_ = to_boolean (get_property ("topLevelAlignment"));
107 valign_ = make_spanner (top_level_ ? "VerticalAlignment" : "StaffGrouper", SCM_EOL);
108 valign_->set_bound (LEFT, unsmob<Grob> (get_property ("currentCommandColumn")));
109 Align_interface::set_ordered (valign_);
114 Vertical_align_engraver::finalize ()
118 valign_->set_bound (RIGHT, unsmob<Grob> (get_property ("currentCommandColumn")));
124 Vertical_align_engraver::qualifies (Grob_info i) const
126 int sz = i.origin_contexts ((Translator *)this).size ();
128 return sz > 0 && has_interface<Axis_group_interface> (i.grob ())
129 && !i.grob ()->get_parent (Y_AXIS)
130 && !to_boolean (i.grob ()->get_property ("no-alignment"))
131 && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
135 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
137 if (scm_is_null (id_to_group_hashtab_))
140 if (top_level_ && qualifies (i))
142 string id = i.context ()->id_string ();
144 scm_hash_set_x (id_to_group_hashtab_, ly_string2scm (id),
145 i.grob ()->self_scm ());
147 SCM before_id = i.context ()->get_property ("alignAboveContext");
148 SCM after_id = i.context ()->get_property ("alignBelowContext");
150 SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
151 SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
153 Grob *before_grob = unsmob<Grob> (before);
154 Grob *after_grob = unsmob<Grob> (after);
156 Align_interface::add_element (valign_, i.grob ());
158 if (before_grob || after_grob)
160 Grob_array *ga = unsmob<Grob_array> (valign_->get_object ("elements"));
161 vector<Grob *> &arr = ga->array_reference ();
163 Grob *added = arr.back ();
165 for (vsize i = 0; i < arr.size (); i++)
167 if (arr[i] == before_grob)
169 arr.insert (arr.begin () + i, added);
171 /* Only set staff affinity if it already has one. That way we won't
172 set staff-affinity on things that don't want it (like staves). */
173 if (scm_is_number (added->get_property ("staff-affinity")))
174 added->set_property ("staff-affinity", scm_from_int (DOWN));
177 else if (arr[i] == after_grob)
179 arr.insert (arr.begin () + i + 1, added);
180 if (scm_is_number (added->get_property ("staff-affinity")))
181 added->set_property ("staff-affinity", scm_from_int (UP));
187 else if (qualifies (i))
189 Pointer_group_interface::add_grob (valign_, ly_symbol2scm ("elements"), i.grob ());
190 if (!unsmob<Grob> (i.grob ()->get_object ("staff-grouper")))
191 i.grob ()->set_object ("staff-grouper", valign_->self_scm ());