]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/instrument-name-engraver.cc
Run `make grand-replace'.
[lilypond.git] / lily / instrument-name-engraver.cc
index 590600ef8a8f3a4c3d5cbea80ad7a5252e0ba57f..f38216f16e7d4980a5ecf1c1d3b5f17fb45647f7 100644 (file)
-/*   
-  instrument-name-engraver.cc --  implement Instrument_name_engraver
-  
+/*
+  instrument-name-engraver.cc -- implement Instrument_name_engraver
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 2000--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+
+  (c) 2000--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
 #include "engraver.hh"
-#include "item.hh"
-#include "bar-line.hh"
-#include "system-start-delimiter.hh"
+#include "pointer-group-interface.hh"
 #include "side-position-interface.hh"
-#include "align-interface.hh"
 #include "axis-group-interface.hh"
-#include "translator-group.hh"
-#include "text-item.hh"
+#include "align-interface.hh"
+#include "text-interface.hh"
+#include "system.hh"
+
+#include "translator.icc"
 
 class Instrument_name_engraver : public Engraver
 {
-  Item *text_;
-  Grob *delim_ ;
-  
-  void create_text ();
 public:
-  TRANSLATOR_DECLARATIONS(Instrument_name_engraver);
+  TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
 
-  virtual void initialize ();
-  virtual void acknowledge_grob (Grob_info);
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
-};
+protected:
+  Spanner *text_spanner_;
 
+  SCM long_text_;
+  SCM short_text_;
 
+  vector<Grob*> axis_groups_;
+  
+  virtual void finalize ();
+  DECLARE_ACKNOWLEDGER (axis_group);
+  void process_music ();
+  void start_spanner ();
+  void consider_start_spanner ();
+  void stop_spanner ();
+};
 
 Instrument_name_engraver::Instrument_name_engraver ()
 {
-  text_ = 0;
-  delim_ =0;
-}
-
+  text_spanner_ = 0;
 
-void
-Instrument_name_engraver::initialize ()
-{
-  daddy_trans_->set_property ("instrumentSupport", SCM_EOL); 
+  long_text_ = SCM_EOL;
+  short_text_ = SCM_EOL;
 }
 
 void
-Instrument_name_engraver::stop_translation_timestep ()
+Instrument_name_engraver::process_music ()
 {
-  if (text_)
-    {
-      text_->set_grob_property ("side-support-elements",
-                               get_property ("instrumentSupport"));
-      typeset_grob (text_);
-      text_ = 0;
-    }
+  consider_start_spanner ();
 }
 
 void
-Instrument_name_engraver::create_text ()
+Instrument_name_engraver::consider_start_spanner ()
 {
-   if (!text_)
+  SCM long_text = get_property ("instrumentName");
+  SCM short_text = get_property ("shortInstrumentName");
+
+  if (!(Text_interface::is_markup (long_text)
+       || Text_interface::is_markup (short_text)))
     {
-      SCM txt = get_property ("instrument");
+      long_text = get_property ("vocalName");
+      short_text = get_property ("shortVocalName");
+    }
   
-      if (now_mom () > Moment (0))
-       txt = get_property ("instr");
-      
-      if (!new_markup_p (txt))
-       return ; 
-          
-      text_ = new Item (get_property ("InstrumentName"));
-      
-      if (text_->get_grob_property ("text") != txt)
-       text_->set_grob_property ("text", txt);
+  if ((Text_interface::is_markup (long_text)
+       || Text_interface::is_markup (short_text))
+      && (!text_spanner_
+         || short_text_ != short_text
+         || long_text_ != long_text))
+    {
+      if (text_spanner_)
+       stop_spanner ();
 
-      if (new_markup_p (txt))
-       text_->set_grob_property ("molecule-callback", new_markup_brewer());
       
-      if (delim_)
-        text_->set_parent (delim_, Y_AXIS);
-      
-      announce_grob (text_, SCM_EOL);
+      short_text_ = short_text;
+      long_text_ = long_text;
+
+      start_spanner ();
     }
 }
 
 void
-Instrument_name_engraver::acknowledge_grob (Grob_info i)
+Instrument_name_engraver::start_spanner ()
 {
-  if (Bar_line::has_interface (i.grob_))
-    {
-      create_text();
-    }
-
-  if (dynamic_cast<Spanner*> (i.grob_)
-      && i.grob_->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
-    return;
+  text_spanner_ = make_spanner ("InstrumentName", SCM_EOL);
+         
+  Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
+  text_spanner_->set_bound (LEFT, col);
+  text_spanner_->set_property ("text", short_text_);
+  text_spanner_->set_property ("long-text", long_text_);
 
   /*
-    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.
+    UGH, should handle this in Score_engraver.
   */
-  if (dynamic_cast<Spanner*> (i.grob_)
-      && ((Axis_group_interface::has_interface (i.grob_)
-          && Axis_group_interface::axis_b (i.grob_, Y_AXIS)))
-      && !Align_interface::has_interface (i.grob_))
+  Grob *system = unsmob_grob (get_property ("rootSystem"));
+  if (system)
+    Axis_group_interface::add_element (system, text_spanner_);
+  else
+    text_spanner_->programming_error ("cannot find root system");
+}
+
+
+void
+Instrument_name_engraver::acknowledge_axis_group (Grob_info info)
+{
+  if (dynamic_cast<Spanner *> (info.grob ())
+      && Axis_group_interface::has_axis (info.grob (), Y_AXIS)
+
+      /* ugh. */
+
+      && !info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
+      && !info.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))
+      && (!Align_interface::has_interface (info.grob ())))
     {
-      SCM nl = gh_cons (i.grob_->self_scm (),
-                       get_property ("instrumentSupport"));
+      axis_groups_.push_back (info.grob ());
+    }
+}
 
-      daddy_trans_->set_property ("instrumentSupport", nl);
+void
+Instrument_name_engraver::finalize ()
+{
+  if (text_spanner_)
+    {
+      stop_spanner ();
     }
 }
 
 void
-Instrument_name_engraver::process_music ()
+Instrument_name_engraver::stop_spanner ()
 {
-  /*
-    Also create text if barlines in other groups. This allows
-    a name to be attached to lyrics or chords. 
-   */
-  if (gh_string_p (get_property ("whichBar")))
-    create_text();
+  for (vsize i = 0; i < axis_groups_.size (); i++)
+    Pointer_group_interface::add_grob (text_spanner_, ly_symbol2scm ("elements"), axis_groups_[i]);
+  
+  text_spanner_->set_bound (RIGHT,
+                           unsmob_grob (get_property ("currentCommandColumn")));
+
+  Pointer_group_interface::set_ordered (text_spanner_, ly_symbol2scm ("elements"), false);
+
+  text_spanner_ = 0;
 }
 
-ENTER_DESCRIPTION(Instrument_name_engraver,
-/* descr */       " Prints the name of the instrument (specified by "
-" @code{Staff.instrument} and @code{Staff.instr}) "
-"at the left of the staff. ",
-/* creats*/       "InstrumentName",
-/* accepts */     "",
-/* acks  */      "bar-line-interface axis-group-interface",
-/* reads */       "instrument instr",
-/* write */       "");
+#include "translator.icc"
+
+ADD_ACKNOWLEDGER (Instrument_name_engraver, axis_group);
+
+ADD_TRANSLATOR (Instrument_name_engraver,
+               /* doc */
+               "Create a system start text for instrument or vocal names.",
+               
+               /* create */
+               "InstrumentName ",
+               
+               /* read */
+               "currentCommandColumn "
+               "shortInstrumentName "
+               "instrumentName "
+               "shortVocalName "
+               "vocalName ",
+
+               /* write */
+               ""
+               );