/*
- custos-engraver.cc -- implement Custos_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2000--2015 Juergen Reuter <reuter@ipd.uka.de>,
+ Han-Wen Nienhuys <hanwen@xs4all.nl>
- (C) 2000 Juergen Reuter <reuterj@ira.uka.de>,
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
- Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "engraver.hh"
-#include "bar.hh"
#include "item.hh"
#include "note-head.hh"
+#include "pitch.hh"
#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
#include "warn.hh"
-#include "musical-request.hh"
+
+#include "translator.icc"
/*
- This class implements an engraver for custos symbols.
-*/
+ * This class implements an engraver for custos symbols.
+ *
+ * FIXME: note heads inside of ligatures (i.e. ligature heads) are
+ * sometimes not recognized by this engraver. --jr
+ */
class Custos_engraver : public Engraver
{
public:
- Custos_engraver();
- virtual void start_translation_timestep();
- virtual void acknowledge_grob(Grob_info);
- virtual void create_grobs ();
- virtual void stop_translation_timestep ();
+ TRANSLATOR_DECLARATIONS (Custos_engraver);
+ void start_translation_timestep ();
+ void acknowledge_bar (Grob_info);
+ void acknowledge_note_head (Grob_info);
+ void process_acknowledged ();
+ void stop_translation_timestep ();
virtual void finalize ();
- VIRTUAL_COPY_CONS(Translator);
private:
- Item * create_custos();
- bool custos_permitted;
- Link_array<Grob> custos_arr_;
- Array<Pitch> pitches_;
+ Item *create_custos ();
+ bool custos_permitted_;
+ vector<Grob *> custodes_;
+ vector<Pitch> pitches_;
};
-Custos_engraver::Custos_engraver ()
+Custos_engraver::Custos_engraver (Context *c)
+ : Engraver (c)
{
- custos_permitted = false;
+ custos_permitted_ = false;
}
-
void
-Custos_engraver::stop_translation_timestep()
+Custos_engraver::stop_translation_timestep ()
{
/*
delay typeset until we're at the next moment, so we can silence custodes at the end of the piece.
- */
+ */
+ pitches_.clear ();
+
+ custos_permitted_ = false;
}
void
Custos_engraver::start_translation_timestep ()
{
- for (int i = custos_arr_.size (); i--;)
- {
- typeset_grob (custos_arr_[i]);
- }
- custos_arr_.clear ();
- pitches_.clear ();
-
- custos_permitted = false;
+ custodes_.clear ();
}
+void
+Custos_engraver::acknowledge_bar (Grob_info /* info */)
+{
+ custos_permitted_ = true;
+}
void
-Custos_engraver::acknowledge_grob (Grob_info info)
+Custos_engraver::acknowledge_note_head (Grob_info info)
{
- Item *item = dynamic_cast <Item *>(info.elem_l_);
- if (item)
+ Stream_event *ev = info.event_cause ();
+ if (ev && ev->in_event_class ("note-event"))
{
- if (Bar::has_interface (info.elem_l_))
- custos_permitted = true;
- else if (Note_head::has_interface (info.elem_l_))
- {
-
- /*
- ideally, we'd do custos->set_parent (Y_AXIS, notehead),
- but since the note head lives on the other system, we can't
-
- So we copy the position from the note head pitch. We
- don't look at the staff-position, since we can't be sure
- whether Clef_engraver already applied a vertical shift.
- */
- Note_req * nr = dynamic_cast<Note_req*> (info.req_l_);
- if (nr)
- pitches_.push (*unsmob_pitch (nr->get_mus_property ("pitch")));
- }
+
+ /*
+ ideally, we'd do custos->set_parent (Y_AXIS, notehead),
+ but since the note head lives on the other system, we can't
+
+ So we copy the position from the note head pitch. We
+ don't look at the staff-position, since we can't be sure
+ whether Clef_engraver already applied a vertical shift.
+ */
+ pitches_.push_back (*unsmob<Pitch> (ev->get_property ("pitch")));
}
}
void
-Custos_engraver::create_grobs ()
+Custos_engraver::process_acknowledged ()
{
- if (gh_string_p (get_property( "whichBar")))
- custos_permitted = true;
-
- if (custos_permitted)
+ if (scm_is_string (get_property ("whichBar")))
+ custos_permitted_ = true;
+
+ if (custos_permitted_)
{
- for (int i = pitches_.size (); i--;)
- {
- Item *c = create_custos ();
-
- c->set_grob_property ("staff-position",
- gh_int2scm (pitches_[i].steps ()));
-
- }
+ for (vsize i = pitches_.size (); i--;)
+ {
+ Item *c = create_custos ();
+
+ int p = pitches_[i].steps ();
+ SCM c0 = get_property ("middleCPosition");
+ if (scm_is_number (c0))
+ p += scm_to_int (c0);
+
+ c->set_property ("staff-position",
+ scm_from_int (p));
+ }
pitches_.clear ();
}
}
-Item*
-Custos_engraver::create_custos()
+Item *
+Custos_engraver::create_custos ()
{
- SCM basicProperties = get_property ("Custos");
- Item* custos = new Item (basicProperties);
-
- announce_grob (custos, 0);
- custos_arr_.push (custos);
-
+ Item *custos = make_item ("Custos", SCM_EOL);
+
+ custodes_.push_back (custos);
+
return custos;
}
void
Custos_engraver::finalize ()
{
- for (int i = custos_arr_.size (); i--;)
- {
- custos_arr_[i]->suicide ();
- typeset_grob (custos_arr_[i]);
- }
- custos_arr_.clear ();
+ for (vsize i = custodes_.size (); i--;)
+ custodes_[i]->suicide ();
+ custodes_.clear ();
}
-ADD_THIS_TRANSLATOR (Custos_engraver);
+void
+Custos_engraver::boot ()
+{
+ ADD_ACKNOWLEDGER (Custos_engraver, bar);
+ ADD_ACKNOWLEDGER (Custos_engraver, note_head);
+}
+
+ADD_TRANSLATOR (Custos_engraver,
+ /* doc */
+ "Engrave custodes.",
+
+ /* create */
+ "Custos ",
+
+ /* read */
+ "",
+
+ /* write */
+ ""
+ );