2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--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/>.
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"
35 Put stuff in a Spanner with an Axis_group_interface.
36 Use as last element of a context.
38 class Axis_group_engraver : public Engraver
45 void process_music ();
46 virtual void initialize ();
47 virtual void finalize ();
48 DECLARE_ACKNOWLEDGER (grob);
49 void process_acknowledged ();
50 virtual Spanner *get_spanner ();
51 virtual void add_element (Grob *);
52 virtual bool must_be_last () const;
53 virtual void derived_mark () const;
56 TRANSLATOR_DECLARATIONS (Axis_group_engraver);
60 Axis_group_engraver::Axis_group_engraver ()
63 interesting_ = SCM_EOL;
68 Axis_group_engraver::initialize ()
70 active_ = !to_boolean (get_property ("hasAxisGroup"));
72 context ()->set_property ("hasAxisGroup", SCM_BOOL_T);
76 Axis_group_engraver::derived_mark () const
78 scm_gc_mark (interesting_);
83 Axis_group_engraver::must_be_last () const
89 Axis_group_engraver::process_music ()
91 if (!staffline_ && active_)
93 staffline_ = get_spanner ();
94 Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
95 staffline_->set_bound (LEFT, it);
97 interesting_ = get_property ("keepAliveInterfaces");
101 Axis_group_engraver::get_spanner ()
103 return make_spanner ("VerticalAxisGroup", SCM_EOL);
107 Axis_group_engraver::finalize ()
111 Grob *it = unsmob<Grob> (get_property ("currentCommandColumn"));
112 staffline_->set_bound (RIGHT, it);
114 Pointer_group_interface::set_ordered (staffline_, ly_symbol2scm ("elements"), false);
119 Axis_group_engraver::acknowledge_grob (Grob_info i)
122 elts_.push_back (i.grob ());
124 if (staffline_ && to_boolean(staffline_->get_property("remove-empty")))
126 for (SCM s = interesting_; scm_is_pair (s); s = scm_cdr (s))
128 if (i.grob ()->internal_has_interface (scm_car (s)))
129 Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob ());
135 maybe should check if our parent is set, because we now get a
136 cyclic parent relationship if we have two Axis_group_engravers in
139 Axis_group_engraver::process_acknowledged ()
144 for (vsize i = 0; i < elts_.size (); i++)
146 if (!unsmob<Grob> (elts_[i]->get_object ("axis-group-parent-Y")))
148 if (staffline_->get_parent (Y_AXIS)
149 && staffline_->get_parent (Y_AXIS) == elts_[i])
151 staffline_->warning (_ ("Axis_group_engraver: vertical group already has a parent"));
152 staffline_->warning (_ ("are there two Axis_group_engravers?"));
153 staffline_->warning (_ ("removing this vertical group"));
154 staffline_->suicide ();
158 add_element (elts_[i]);
165 Axis_group_engraver::add_element (Grob *e)
167 Axis_group_interface::add_element (staffline_, e);
170 ADD_ACKNOWLEDGER (Axis_group_engraver, grob);
172 ADD_TRANSLATOR (Axis_group_engraver,
174 "Group all objects created in this context in a"
175 " @code{VerticalAxisGroup} spanner.",
178 "VerticalAxisGroup ",
181 "currentCommandColumn "
182 "keepAliveInterfaces "