]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/custos-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / custos-engraver.cc
index 63ae946016b860d42fdbb708b95a4c472d61ca15..8b5eb08ef816afb86b1469f6254b71578ef4e3f0 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (C) 2000 Juergen Reuter <reuterj@ira.uka.de>,
-
-  Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
+  (c) 2000--2008 Juergen Reuter <reuter@ipd.uka.de>,
+  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "engraver.hh"
-#include "bar.hh"
+#include "bar-line.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);
-  void deprecated_process_music ();
-  virtual void create_grobs ();
-  virtual void stop_translation_timestep ();
-  virtual void do_removal_processing ();
-  VIRTUAL_COPY_CONS(Translator);
+  TRANSLATOR_DECLARATIONS (Custos_engraver);
+  void start_translation_timestep ();
+  DECLARE_ACKNOWLEDGER (bar);
+  DECLARE_ACKNOWLEDGER (note_head);
+  void process_acknowledged ();
+  void stop_translation_timestep ();
+  virtual void finalize ();
 
 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_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 ();
 }
 
-
-/*
-  TODO check if this works with forced bar lines?
- */
 void
-Custos_engraver::deprecated_process_music ()
+Custos_engraver::acknowledge_bar (Grob_info info)
 {
-  if (gh_string_p (get_property( "whichBar")))
-    custos_permitted = true;
+  (void) 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 ()
 {
-  deprecated_process_music ();
+  if (scm_is_string (get_property ("whichBar")))
+    custos_permitted_ = true;
 
-  if (custos_permitted)
+  if (custos_permitted_)
     {
-      for (int i = pitches_.size (); i--;)
+      for (vsize i = pitches_.size (); i--;)
        {
          Item *c = create_custos ();
-         
-         c->set_grob_property ("staff-position",
-                              gh_int2scm (pitches_[i].steps ()));
-         
+
+         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::do_removal_processing ()
+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);
+ADD_ACKNOWLEDGER (Custos_engraver, bar);
+ADD_ACKNOWLEDGER (Custos_engraver, note_head);
+
+ADD_TRANSLATOR (Custos_engraver,
+               /* doc */
+               "Engrave custodes.",
+
+               /* create */
+               "Custos ",
+
+               /* read */
+               "",
 
+               /* write */
+               ""
+               );