]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/instrument-name-engraver.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / instrument-name-engraver.cc
index e16a53c9273a1f674a510a6c7628d1ea6969c211..288a68b5a73e88849ac97f11fa6fa399996001c6 100644 (file)
-/*   
-  new-staff-margin-engraver.cc --  implement Instrument_name_engraver
-  
+/*
+  instrument-name-engraver.cc -- implement Instrument_name_engraver
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+
+  (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
 #include "engraver.hh"
-#include "text-item.hh"
-#include "bar.hh"
-#include "span-bar.hh"
+#include "bar-line.hh"
+#include "system-start-delimiter.hh"
+#include "side-position-interface.hh"
+#include "align-interface.hh"
+#include "axis-group-interface.hh"
+#include "context.hh"
+#include "text-interface.hh"
+#include "grob-array.hh"
+
+#include "translator.icc"
 
 class Instrument_name_engraver : public Engraver
 {
-  Text_item *text_;
-
-  void create_text (SCM s);
+  bool first_;
 public:
-  VIRTUAL_COPY_CONS(Translator);
-  Instrument_name_engraver ();
+  TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
 
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_pre_move_processing ();
-};
+protected:
+  Grob *text_;
+
+  virtual void create_text ();
+  virtual void initialize ();
 
-ADD_THIS_TRANSLATOR(Instrument_name_engraver);
+  DECLARE_ACKNOWLEDGER (bar_line);
+  DECLARE_ACKNOWLEDGER (axis_group);
+
+  void stop_translation_timestep ();
+  void process_music ();
+};
 
 Instrument_name_engraver::Instrument_name_engraver ()
 {
   text_ = 0;
+  first_ = true;
 }
 
+void
+Instrument_name_engraver::initialize ()
+{
+  context ()->set_property ("instrumentSupport", SCM_EOL);
+}
 
 void
-Instrument_name_engraver::do_pre_move_processing ()
+Instrument_name_engraver::stop_translation_timestep ()
 {
   if (text_)
     {
-      typeset_element (text_);
+      text_->set_object ("side-support-elements",
+                        grob_list_to_grob_array (get_property ("instrumentSupport")));
       text_ = 0;
     }
+
+  first_ = false;
 }
 
 void
-Instrument_name_engraver::create_text (SCM txt)
+Instrument_name_engraver::create_text ()
 {
-  if(!text_)
-    {
-      text_ = new Text_item;
-      text_->set_elt_property ("text", txt);
-      text_->set_elt_property ("breakable", SCM_BOOL_T);
-
-      /*
-       TODO: use more lispish names for break-align-symbols
-       */
-      text_->set_elt_property ("break-align-symbol", ly_symbol2scm ("Instrument_name"));
-      text_->set_elt_property ("visibility-lambda",
-                              scm_eval (ly_symbol2scm ("begin-of-line-visible")));
-
-      announce_element (Score_element_info (text_,0));
-    }
+  if (text_)
+    return;
+
+  SCM txt = get_property ("instrument");
+
+  if (now_mom () > Moment (0))
+    txt = get_property ("instr");
+  /*
+    UGH.
+  */
+  if (txt == SCM_EOL)
+    return;
+
+  text_ = make_item ("InstrumentName", SCM_EOL);
+
+  if (text_->get_property ("text") != txt)
+    text_->set_property ("text", txt);
 }
 
 void
-Instrument_name_engraver::acknowledge_element (Score_element_info i)
+Instrument_name_engraver::acknowledge_bar_line (Grob_info info)
 {
-  SCM s = get_property ("instrument");
-  
-  if (now_mom () > Moment (0))
-    s = get_property ("instr");
+  (void) info;
+  create_text ();
+}
 
-  if (gh_string_p (s))
+void
+Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
+{
+  /*
+    Ugh - typechecking for pedal and dynamic sucks.
+  */
+  if (dynamic_cast<Spanner *> (info.grob ())
+      && (info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
+         || info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))))
+    return;
+
+  /*
+    Hang the instrument names on the staves, but not on the alignment
+    groups enclosing that staff. The alignment has no real location,
+    but is only a vehicle for the placement routine it contains, and
+    therefore the location of its refpoint won't be very useful.
+
+    We could also just use stavesFound, but lets keep this working
+    without staffs as well.
+  */
+  if (dynamic_cast<Spanner *> (info.grob ())
+      && ((Axis_group_interface::has_interface (info.grob ())
+          && Axis_group_interface::has_axis (info.grob (), Y_AXIS)))
+      && !Align_interface::has_interface (info.grob ()))
     {
-      if (Bar* b= dynamic_cast<Bar*> (i.elem_l_))
-       {
-         create_text (s);
-         if (Span_bar* s= dynamic_cast<Span_bar*> (b))
-           {
-             text_->set_parent (s, Y_AXIS);
-           }
-       }
+      SCM nl = scm_cons (info.grob ()->self_scm (),
+                        get_property ("instrumentSupport"));
+
+      context ()->set_property ("instrumentSupport", nl);
     }
 }
 
+void
+Instrument_name_engraver::process_music ()
+{
+  /*
+    Also create text if barlines in other groups. This allows
+    a name to be attached to lyrics or chords.
+  */
+  if (scm_is_string (get_property ("whichBar"))
+      || first_)
+    create_text ();
+}
+
+#include "translator.icc"
+
+ADD_ACKNOWLEDGER (Instrument_name_engraver, bar_line);
+ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
+
+ADD_TRANSLATOR (Instrument_name_engraver,
+               /* doc */ " Prints the name of the instrument (specified by "
+               " @code{Staff.instrument} and @code{Staff.instr}) "
+               "at the left of the staff. ",
+               /* create */ "InstrumentName",
+               /* accept */ "",
+               /* read */ "instrument instr",
+               /* write */ "");
+
+/****************************************************************/
+
+class Vocal_name_engraver : public Instrument_name_engraver
+{
+public:
+  TRANSLATOR_DECLARATIONS (Vocal_name_engraver);
+  virtual void create_text ();
+};
+
+Vocal_name_engraver::Vocal_name_engraver ()
+{
+}
+
+void
+Vocal_name_engraver::create_text ()
+{
+  if (text_)
+    return;
+
+  SCM txt = get_property ("vocalName");
+
+  if (now_mom () > Moment (0))
+    txt = get_property ("vocNam");
+
+  /*
+    UGH.
+  */
+  if (txt == SCM_EOL)
+    return;
 
+  text_ = make_item ("VocalName", SCM_EOL);
 
+  if (text_->get_property ("text") != txt)
+    text_->set_property ("text", txt);
+}
 
+ADD_ACKNOWLEDGER (Vocal_name_engraver, bar_line);
+ADD_ACKNOWLEDGER (Vocal_name_engraver, axis_group);
+ADD_TRANSLATOR (Vocal_name_engraver,
+               /* doc */ " Prints the name of the a lyric voice (specified by "
+               " @code{Staff.vocalName} and @code{Staff.vocNam}) "
+               "at the left of the staff. ",
+               /* create */ "VocalName",
+               /* accept */ "",
+               /* read */ "vocNam vocalName",
+               /* write */ "");