2 axis-group-engraver.cc -- implement Axis_group_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "paper-column.hh"
11 #include "axis-group-interface.hh"
12 #include "engraver-group-engraver.hh"
17 Put stuff in a Spanner with an Axis_group_interface.
18 Use as last element of a context.
20 class Axis_group_engraver : public Engraver
24 Link_array<Grob> elts_;
25 virtual void process_music ();
26 virtual void finalize ();
27 virtual void acknowledge_grob (Grob_info);
28 virtual void process_acknowledged_grobs ();
29 virtual Spanner* get_spanner () ;
30 virtual void add_element (Grob*) ;
32 TRANSLATOR_DECLARATIONS (Axis_group_engraver);
35 Axis_group_engraver::Axis_group_engraver ()
42 Axis_group_engraver::process_music ()
46 staffline_ = get_spanner ();
48 Grob * it = unsmob_grob (get_property ("currentCommandColumn"));
50 staffline_->set_bound (LEFT,it);
55 Axis_group_engraver::get_spanner ()
57 return make_spanner ("VerticalAxisGroup", SCM_EOL);
61 TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?
65 Axis_group_engraver::finalize ()
70 String type = context ()->context_name ();
71 SCM dims = get_property ("verticalExtent");
73 if (is_number_pair (dims))
74 staffline_->set_extent (dims, Y_AXIS);
76 dims = get_property ("minimumVerticalExtent");
77 if (is_number_pair (dims) )
78 staffline_->set_property ("minimum-Y-extent", dims);
80 dims = get_property ("extraVerticalExtent");
81 if (is_number_pair (dims))
82 staffline_->set_property ("extra-Y-extent", dims);
84 Grob * it = unsmob_grob (get_property ("currentCommandColumn"));
86 staffline_->set_bound (RIGHT,it);
92 Axis_group_engraver::acknowledge_grob (Grob_info i)
98 maybe should check if our parent is set, because we now get a
99 cyclic parent relationship if we have two Axis_group_engravers in
102 Axis_group_engraver::process_acknowledged_grobs ()
107 for (int i=0; i < elts_.size (); i++)
109 Grob *par = elts_[i]->get_parent (Y_AXIS);
111 if (!par || !Axis_group_interface::has_interface (par))
113 if (staffline_->get_parent (Y_AXIS)
114 && staffline_->get_parent (Y_AXIS) == elts_[i])
116 String msg = _("Axis_group_engraver: vertical group already has a parent.\n"
117 "Do you have two Axis_group_engravers?\n"
118 "Killing this vertical group.");
119 staffline_->warning (msg);
120 staffline_->suicide ();
124 else if (elts_[i]->is_empty (Y_AXIS))
127 We have to do _something_, otherwise staff objects will
128 end up with System as parent.
131 elts_[i]->set_parent (staffline_, Y_AXIS);
134 add_element (elts_[i]);
141 Axis_group_engraver::add_element (Grob*e)
143 Axis_group_interface::add_element (staffline_, e);
146 /****************************************************************/
150 maybenot such a good idea after all., to put class declarations in
155 #include "hara-kiri-group-spanner.hh"
156 #include "rhythmic-head.hh"
158 class Hara_kiri_engraver : public Axis_group_engraver
161 virtual Spanner*get_spanner ();
162 virtual void acknowledge_grob (Grob_info);
163 virtual void add_element (Grob *e);
165 TRANSLATOR_DECLARATIONS (Hara_kiri_engraver);
169 Hara_kiri_engraver::add_element (Grob*e)
171 Hara_kiri_group_spanner::add_element (staffline_, e);
176 Hara_kiri_engraver::get_spanner ()
178 Spanner * sp = make_spanner ("RemoveEmptyVerticalGroup", SCM_EOL);
184 Hara_kiri_engraver::acknowledge_grob (Grob_info i)
186 Axis_group_engraver::acknowledge_grob (i);
188 && (i.grob_->internal_has_interface (ly_symbol2scm ("rhythmic-grob-interface"))
189 || i.grob_->internal_has_interface (ly_symbol2scm ("lyric-interface")))
192 Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
197 Hara_kiri_engraver::Hara_kiri_engraver ()
201 ENTER_DESCRIPTION (Hara_kiri_engraver,
202 /* descr */ "Like Axis_group_engraver, but make a hara-kiri spanner, and add "
203 "interesting items (ie. note heads, lyric syllables and normal rests) ",
204 /* creats*/ "RemoveEmptyVerticalGroup",
206 /* acks */ "grob-interface",
210 ENTER_DESCRIPTION (Axis_group_engraver,
211 /* descr */ "Group all objects created in this context in a VerticalAxisGroup spanner.",
212 /* creats*/ "VerticalAxisGroup",
214 /* acks */ "grob-interface",
215 /* reads */ "verticalExtent minimumVerticalExtent extraVerticalExtent",