Use scalar instead of embedded_scm for context mod overrides.
[lilypond/mpolesky.git] / lily / custos-engraver.cc
blob8709c87f0ae9ebe710a30678e4349c95c8530ec3
1 /*
2 custos-engraver.cc -- implement Custos_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2009 Juergen Reuter <reuter@ipd.uka.de>,
7 Han-Wen Nienhuys <hanwen@xs4all.nl>
8 */
10 #include "engraver.hh"
11 #include "bar-line.hh"
12 #include "item.hh"
13 #include "note-head.hh"
14 #include "pitch.hh"
15 #include "staff-symbol-referencer.hh"
16 #include "stream-event.hh"
17 #include "warn.hh"
19 #include "translator.icc"
22 * This class implements an engraver for custos symbols.
24 * FIXME: note heads inside of ligatures (i.e. ligature heads) are
25 * sometimes not recognized by this engraver. --jr
27 class Custos_engraver : public Engraver
29 public:
30 TRANSLATOR_DECLARATIONS (Custos_engraver);
31 void start_translation_timestep ();
32 DECLARE_ACKNOWLEDGER (bar);
33 DECLARE_ACKNOWLEDGER (note_head);
34 void process_acknowledged ();
35 void stop_translation_timestep ();
36 virtual void finalize ();
38 private:
39 Item *create_custos ();
40 bool custos_permitted_;
41 vector<Grob*> custodes_;
42 vector<Pitch> pitches_;
45 Custos_engraver::Custos_engraver ()
47 custos_permitted_ = false;
50 void
51 Custos_engraver::stop_translation_timestep ()
54 delay typeset until we're at the next moment, so we can silence custodes at the end of the piece.
56 pitches_.clear ();
58 custos_permitted_ = false;
61 void
62 Custos_engraver::start_translation_timestep ()
64 custodes_.clear ();
67 void
68 Custos_engraver::acknowledge_bar (Grob_info /* info */)
70 custos_permitted_ = true;
73 void
74 Custos_engraver::acknowledge_note_head (Grob_info info)
76 Stream_event *ev = info.event_cause ();
77 if (ev && ev->in_event_class ("note-event"))
81 ideally, we'd do custos->set_parent (Y_AXIS, notehead),
82 but since the note head lives on the other system, we can't
84 So we copy the position from the note head pitch. We
85 don't look at the staff-position, since we can't be sure
86 whether Clef_engraver already applied a vertical shift.
88 pitches_.push_back (*unsmob_pitch (ev->get_property ("pitch")));
92 void
93 Custos_engraver::process_acknowledged ()
95 if (scm_is_string (get_property ("whichBar")))
96 custos_permitted_ = true;
98 if (custos_permitted_)
100 for (vsize i = pitches_.size (); i--;)
102 Item *c = create_custos ();
104 int p = pitches_[i].steps ();
105 SCM c0 = get_property ("middleCPosition");
106 if (scm_is_number (c0))
107 p += scm_to_int (c0);
109 c->set_property ("staff-position",
110 scm_from_int (p));
113 pitches_.clear ();
117 Item *
118 Custos_engraver::create_custos ()
120 Item *custos = make_item ("Custos", SCM_EOL);
122 custodes_.push_back (custos);
124 return custos;
127 void
128 Custos_engraver::finalize ()
130 for (vsize i = custodes_.size (); i--;)
131 custodes_[i]->suicide ();
132 custodes_.clear ();
135 ADD_ACKNOWLEDGER (Custos_engraver, bar);
136 ADD_ACKNOWLEDGER (Custos_engraver, note_head);
138 ADD_TRANSLATOR (Custos_engraver,
139 /* doc */
140 "Engrave custodes.",
142 /* create */
143 "Custos ",
145 /* read */
148 /* write */