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 "bar-line.hh"
18 #include "text-interface.hh"
19 #include "grob-array.hh"
20 #include "axis-group-interface.hh"
23 put stuff over or next to bars. Examples: bar numbers, marginal notes,
26 class Mark_engraver : public Engraver
29 void create_items (Music *);
34 TRANSLATOR_DECLARATIONS (Mark_engraver);
37 virtual bool try_music (Music *ev);
38 void process_music ();
39 void stop_translation_timestep ();
41 DECLARE_ACKNOWLEDGER (break_aligned);
44 Mark_engraver::Mark_engraver ()
51 Mark_engraver::acknowledge_break_aligned (Grob_info inf)
53 Grob *s = inf.grob ();
55 && (get_property ("rehearsalMarkAlignSymbol")
56 == s->get_property ("break-align-symbol"))
57 && Axis_group_interface::has_interface (s))
60 RehearsalMark cannot be break-aligned, since the width of the
61 object should not be taken into alignment considerations.
63 text_->set_parent (s, X_AXIS);
68 Mark_engraver::stop_translation_timestep ()
72 text_->set_object ("side-support-elements",
73 grob_list_to_grob_array (get_property ("stavesFound")));
80 Mark_engraver::create_items (Music *ev)
85 text_ = make_item ("RehearsalMark", ev->self_scm ());
89 Mark_engraver::try_music (Music *r)
96 TODO: make the increment function in Scheme.
99 Mark_engraver::process_music ()
103 create_items (mark_ev_);
109 SCM m = mark_ev_->get_property ("label");
110 SCM proc = get_property ("markFormatter");
111 if (!Text_interface::is_markup (m)
112 && ly_is_procedure (proc))
114 if (!scm_is_number (m))
115 m = get_property ("rehearsalMark");
117 if (scm_integer_p (m) == SCM_BOOL_T
118 && scm_exact_p (m) == SCM_BOOL_T)
120 int mark_count = scm_to_int (m);
122 context ()->set_property ("rehearsalMark",
123 scm_from_int (mark_count));
126 if (scm_is_number (m))
127 m = scm_call_2 (proc, m, context ()->self_scm ());
129 /* FIXME: constant error message. */
130 warning (_ ("rehearsalMark must have integer value"));
133 if (Text_interface::is_markup (m))
134 text_->set_property ("text", m);
136 warning (_ ("mark label must be a markup object"));
140 #include "translator.icc"
142 ADD_ACKNOWLEDGER (Mark_engraver, break_aligned);
144 ADD_TRANSLATOR (Mark_engraver,
145 /* doc */ "This engraver will create RehearsalMark objects. "
146 "It puts them on top of all staves (which is taken from "
147 "the property @code{stavesFound}). If moving this engraver "
148 "to a different context, "
149 "@ref{Staff_collecting_engraver} must move along, otherwise all marks"
150 "end up on the same Y-location",
151 /* create */ "RehearsalMark",
152 /* accept */ "mark-event",
153 /* read */ "rehearsalMark rehearsalMarkAlignSymbol markFormatter stavesFound",