2 axis-group-engraver.cc -- implement Axis_group_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1999--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "paper-column.hh"
11 #include "axis-group-interface.hh"
12 #include "engraver.hh"
13 #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 () const;
30 virtual void add_element (Grob*) ;
32 TRANSLATOR_DECLARATIONS(Axis_group_engraver);
35 Axis_group_engraver::Axis_group_engraver ()
41 Axis_group_engraver::process_music ()
45 staffline_ = get_spanner ();
47 Grob * it = unsmob_grob (get_property ("currentCommandColumn"));
49 staffline_->set_bound (LEFT,it);
51 announce_grob(staffline_, SCM_EOL);
56 Axis_group_engraver::get_spanner () const
58 return new Spanner (get_property ("VerticalAxisGroup"));
62 TODO: should we junk minimumVerticalExtent/extraVerticalExtent ?
66 Axis_group_engraver::finalize ()
70 programming_error ("Huh? This context never lived?");
74 String type = get_daddy_grav ()->context_name ();
75 SCM dims = get_property ("verticalExtent");
77 if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
78 && gh_number_p (ly_cdr (dims)))
80 staffline_->set_extent (Grob::preset_extent_proc, Y_AXIS);
81 staffline_->set_grob_property ("Y-extent", dims);
84 dims = get_property ("minimumVerticalExtent");
85 if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
86 && gh_number_p (ly_cdr (dims)))
87 staffline_->set_grob_property ("minimum-Y-extent", dims);
89 dims = get_property ("extraVerticalExtent");
90 if (gh_pair_p (dims) && gh_number_p (ly_car (dims))
91 && gh_number_p (ly_cdr (dims)))
92 staffline_->set_grob_property ("extra-Y-extent", dims);
94 Grob * it = unsmob_grob (get_property ("currentCommandColumn"));
97 staffline_->set_bound (RIGHT,it);
99 typeset_grob (staffline_);
104 Axis_group_engraver::acknowledge_grob (Grob_info i)
106 elts_.push (i.grob_);
110 maybe should check if our parent is set, because we now get a
111 cyclic parent relationship if we have two Axis_group_engravers in
114 Axis_group_engraver::process_acknowledged_grobs ()
117 for (int i=0; i < elts_.size (); i++)
119 Grob *par = elts_[i]->get_parent (Y_AXIS);
121 if (!par || !Axis_group_interface::has_interface (par))
122 if (elts_[i]->is_empty (Y_AXIS))
125 We have to do _something_, otherwise staff objects will
126 end up with System as parent.
129 elts_[i]->set_parent (staffline_, Y_AXIS);
132 add_element (elts_[i]);
138 Axis_group_engraver::add_element (Grob*e)
140 Axis_group_interface::add_element (staffline_, e);
143 /****************************************************************/
147 maybenot such a good idea after all., to put class declarations in
152 #include "hara-kiri-group-spanner.hh"
153 #include "rhythmic-head.hh"
155 class Hara_kiri_engraver : public Axis_group_engraver
158 virtual Spanner*get_spanner ()const;
159 virtual void acknowledge_grob (Grob_info);
160 virtual void add_element (Grob *e);
162 TRANSLATOR_DECLARATIONS(Hara_kiri_engraver);
166 Hara_kiri_engraver::add_element (Grob*e)
168 Hara_kiri_group_spanner::add_element (staffline_, e);
173 Hara_kiri_engraver::get_spanner () const
175 Spanner * sp = new Spanner (get_property ("RemoveEmptyVerticalGroup"));
181 Hara_kiri_engraver::acknowledge_grob (Grob_info i)
183 Axis_group_engraver::acknowledge_grob (i);
184 if (i.grob_->internal_has_interface (ly_symbol2scm ("rhythmic-grob-interface")))
186 Hara_kiri_group_spanner::add_interesting_item (staffline_, i.grob_);
191 Hara_kiri_engraver::Hara_kiri_engraver()
195 ENTER_DESCRIPTION(Hara_kiri_engraver,
196 /* descr */ "Like Axis_group_engraver, but make a hara kiri spanner, and add "
197 "interesting items (ie. note heads, lyric syllables and normal rests) ",
198 /* creats*/ "RemoveEmptyVerticalGroup",
200 /* acks */ "grob-interface",
204 ENTER_DESCRIPTION(Axis_group_engraver,
205 /* descr */ "Group all objects created in this context in a VerticalAxisGroup spanner.",
206 /* creats*/ "VerticalAxisGroup",
208 /* acks */ "grob-interface",
209 /* reads */ "verticalExtent minimumVerticalExtent extraVerticalExtent",