2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2014 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/>.
20 #include "engraver.hh"
22 #include "axis-group-interface.hh"
23 #include "hara-kiri-group-spanner.hh"
24 #include "pointer-group-interface.hh"
26 #include "international.hh"
30 #include "translator.icc"
33 Put stuff in a Spanner with an Axis_group_interface.
34 Use as last element of a context.
36 class Axis_group_engraver : public Engraver
43 void process_music ();
44 virtual void initialize ();
45 virtual void finalize ();
46 DECLARE_ACKNOWLEDGER (grob);
47 void process_acknowledged ();
48 virtual Spanner *get_spanner ();
49 virtual void add_element (Grob *);
50 virtual bool must_be_last () const;
51 virtual void derived_mark () const;
54 TRANSLATOR_DECLARATIONS (Axis_group_engraver);
58 Axis_group_engraver::Axis_group_engraver ()
61 interesting_ = SCM_EOL;
66 Axis_group_engraver::initialize ()
68 active_ = !to_boolean (get_property ("hasAxisGroup"));
70 context ()->set_property ("hasAxisGroup", SCM_BOOL_T);
74 Axis_group_engraver::derived_mark () const
76 scm_gc_mark (interesting_);
81 Axis_group_engraver::must_be_last () const
87 Axis_group_engraver::process_music ()
89 if (!staffline_ && active_)
91 staffline_ = get_spanner ();
92 Grob *it = Grob::unsmob (get_property ("currentCommandColumn"));
93 staffline_->set_bound (LEFT, it);
95 interesting_ = get_property ("keepAliveInterfaces");
99 Axis_group_engraver::get_spanner ()
101 return make_spanner ("VerticalAxisGroup", SCM_EOL);
105 Axis_group_engraver::finalize ()
109 Grob *it = Grob::unsmob (get_property ("currentCommandColumn"));
110 staffline_->set_bound (RIGHT, it);
112 Pointer_group_interface::set_ordered (staffline_, ly_symbol2scm ("elements"), false);
117 Axis_group_engraver::acknowledge_grob (Grob_info i)
120 elts_.push_back (i.grob ());
122 if (staffline_ && to_boolean(staffline_->get_property("remove-empty")))
124 for (SCM s = interesting_; scm_is_pair (s); s = scm_cdr (s))
126 if (i.grob ()->internal_has_interface (scm_car (s)))
127 Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob ());
133 maybe should check if our parent is set, because we now get a
134 cyclic parent relationship if we have two Axis_group_engravers in
137 Axis_group_engraver::process_acknowledged ()
142 for (vsize i = 0; i < elts_.size (); i++)
144 if (!Grob::is_smob (elts_[i]->get_object ("axis-group-parent-Y")))
146 if (staffline_->get_parent (Y_AXIS)
147 && staffline_->get_parent (Y_AXIS) == elts_[i])
149 staffline_->warning (_ ("Axis_group_engraver: vertical group already has a parent"));
150 staffline_->warning (_ ("are there two Axis_group_engravers?"));
151 staffline_->warning (_ ("removing this vertical group"));
152 staffline_->suicide ();
156 add_element (elts_[i]);
163 Axis_group_engraver::add_element (Grob *e)
165 Axis_group_interface::add_element (staffline_, e);
168 ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
170 ADD_TRANSLATOR (Axis_group_engraver,
172 "Group all objects created in this context in a"
173 " @code{VerticalAxisGroup} spanner.",
176 "VerticalAxisGroup ",
179 "currentCommandColumn "
180 "keepAliveInterfaces "