2 mark-engraver.cc -- implement Mark_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
12 #include "engraver.hh"
14 #include "axis-group-interface.hh"
15 #include "bar-line.hh"
17 #include "grob-array.hh"
18 #include "international.hh"
20 #include "text-interface.hh"
24 put stuff over or next to bars. Examples: bar numbers, marginal notes,
27 class Mark_engraver : public Engraver
30 void create_items (Music *);
35 TRANSLATOR_DECLARATIONS (Mark_engraver);
38 virtual bool try_music (Music *ev);
39 void process_music ();
40 void stop_translation_timestep ();
42 DECLARE_ACKNOWLEDGER (break_alignment);
43 DECLARE_ACKNOWLEDGER (break_aligned);
46 Mark_engraver::Mark_engraver ()
53 This is a flawed approach, since various break-aligned objects may
54 not appear depending on key signature etc.
56 We keep it in case someone puts the engraver in a lower context than score.
59 Mark_engraver::acknowledge_break_aligned (Grob_info inf)
61 Grob *s = inf.grob ();
63 && !text_->get_parent (X_AXIS)
64 && (text_->get_property_data (ly_symbol2scm ("break-align-symbol"))
65 == s->get_property_data (ly_symbol2scm ("break-align-symbol")))
66 && Axis_group_interface::has_interface (s))
69 RehearsalMark cannot be break-aligned, since the width of the
70 object should not be taken into alignment considerations.
72 text_->set_parent (s, X_AXIS);
77 Mark_engraver::acknowledge_break_alignment (Grob_info inf)
79 Grob *s = inf.grob ();
81 && dynamic_cast<Item *> (s))
83 text_->set_parent (s, X_AXIS);
89 Mark_engraver::stop_translation_timestep ()
93 text_->set_object ("side-support-elements",
94 grob_list_to_grob_array (get_property ("stavesFound")));
101 Mark_engraver::create_items (Music *ev)
106 text_ = make_item ("RehearsalMark", ev->self_scm ());
110 Mark_engraver::try_music (Music *r)
117 TODO: make the increment function in Scheme.
120 Mark_engraver::process_music ()
124 create_items (mark_ev_);
130 SCM m = mark_ev_->get_property ("label");
131 SCM proc = get_property ("markFormatter");
132 if (!Text_interface::is_markup (m)
133 && ly_is_procedure (proc))
135 if (!scm_is_number (m))
136 m = get_property ("rehearsalMark");
138 if (scm_integer_p (m) == SCM_BOOL_T
139 && scm_exact_p (m) == SCM_BOOL_T)
141 int mark_count = scm_to_int (m);
143 context ()->set_property ("rehearsalMark",
144 scm_from_int (mark_count));
147 if (scm_is_number (m))
148 m = scm_call_2 (proc, m, context ()->self_scm ());
150 /* FIXME: constant error message. */
151 warning (_ ("rehearsalMark must have integer value"));
154 if (Text_interface::is_markup (m))
155 text_->set_property ("text", m);
157 warning (_ ("mark label must be a markup object"));
161 #include "translator.icc"
163 ADD_ACKNOWLEDGER (Mark_engraver, break_aligned);
164 ADD_ACKNOWLEDGER (Mark_engraver, break_alignment);
166 ADD_TRANSLATOR (Mark_engraver,
167 /* doc */ "This engraver will create RehearsalMark objects. "
168 "It puts them on top of all staves (which is taken from "
169 "the property @code{stavesFound}). If moving this engraver "
170 "to a different context, "
171 "@ref{Staff_collecting_engraver} must move along, otherwise all marks"
172 "end up on the same Y-location",
173 /* create */ "RehearsalMark",
174 /* accept */ "mark-event",
175 /* read */ "rehearsalMark rehearsalMarkAlignSymbol markFormatter stavesFound",