lily/instrument-name-engraver.cc

   1 /*
   2   instrument-name-engraver.cc -- implement Instrument_name_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "engraver.hh"
  10 #include "bar-line.hh"
  11 #include "system-start-delimiter.hh"
  12 #include "side-position-interface.hh"
  13 #include "align-interface.hh"
  14 #include "axis-group-interface.hh"
  15 #include "context.hh"
  16 #include "text-interface.hh"
  17 #include "grob-array.hh"
  18
  19 class Instrument_name_engraver : public Engraver
  20 {
  21   bool first_;
  22 public:
  23   TRANSLATOR_DECLARATIONS (Instrument_name_engraver);
  24
  25 protected:
  26   Grob *text_;
  27
  28   virtual void create_text ();
  29   virtual void initialize ();
  30   virtual void acknowledge_grob (Grob_info);
  31   virtual void stop_translation_timestep ();
  32   virtual void process_music ();
  33
  34 };
  35
  36 Instrument_name_engraver::Instrument_name_engraver ()
  37 {
  38   text_ = 0;
  39   first_ = true;
  40 }
  41
  42 void
  43 Instrument_name_engraver::initialize ()
  44 {
  45   context ()->set_property ("instrumentSupport", SCM_EOL);
  46 }
  47
  48 void
  49 Instrument_name_engraver::stop_translation_timestep ()
  50 {
  51   if (text_)
  52     {
  53       text_->set_object ("side-support-elements",
  54                          grob_list_to_grob_array (get_property ("instrumentSupport")));
  55       text_ = 0;
  56     }
  57
  58   first_ = false;
  59 }
  60
  61 void
  62 Instrument_name_engraver::create_text ()
  63 {
  64   if (text_)
  65     return;
  66
  67   SCM txt = get_property ("instrument");
  68
  69   if (now_mom () > Moment (0))
  70     txt = get_property ("instr");
  71   /*
  72     UGH.
  73   */
  74   if (txt == SCM_EOL)
  75     return;
  76
  77   text_ = make_item ("InstrumentName", SCM_EOL);
  78
  79   if (text_->get_property ("text") != txt)
  80     text_->set_property ("text", txt);
  81 }
  82
  83 void
  84 Instrument_name_engraver::acknowledge_grob (Grob_info i)
  85 {
  86   if (Bar_line::has_interface (i.grob ()))
  87     {
  88       create_text ();
  89     }
  90
  91   /*
  92     Ugh - typechecking for pedal and dynamic sucks.
  93   */
  94   if (dynamic_cast<Spanner *> (i.grob ())
  95       && (i.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface"))
  96           || i.grob ()->internal_has_interface (ly_symbol2scm ("piano-pedal-interface"))))
  97     return;
  98
  99   /*
 100     Hang the instrument names on the staves, but not on the alignment
 101     groups enclosing that staff. The alignment has no real location,
 102     but is only a vehicle for the placement routine it contains, and
 103     therefore the location of its refpoint won't be very useful.
 104
 105     We could also just use stavesFound, but lets keep this working
 106     without staffs as well.
 107   */
 108   if (dynamic_cast<Spanner *> (i.grob ())
 109       && ((Axis_group_interface::has_interface (i.grob ())
 110            && Axis_group_interface::has_axis (i.grob (), Y_AXIS)))
 111       && !Align_interface::has_interface (i.grob ()))
 112     {
 113       SCM nl = scm_cons (i.grob ()->self_scm (),
 114                          get_property ("instrumentSupport"));
 115
 116       context ()->set_property ("instrumentSupport", nl);
 117     }
 118 }
 119
 120 void
 121 Instrument_name_engraver::process_music ()
 122 {
 123   /*
 124     Also create text if barlines in other groups. This allows
 125     a name to be attached to lyrics or chords.
 126   */
 127   if (scm_is_string (get_property ("whichBar"))
 128       || first_)
 129     create_text ();
 130 }
 131
 132 ADD_TRANSLATOR (Instrument_name_engraver,
 133                 /* descr */ " Prints the name of the instrument (specified by "
 134                 " @code{Staff.instrument} and @code{Staff.instr}) "
 135                 "at the left of the staff. ",
 136                 /* creats*/ "InstrumentName",
 137                 /* accepts */ "",
 138                 /* acks  */ "bar-line-interface axis-group-interface",
 139                 /* reads */ "instrument instr",
 140                 /* write */ "");
 141
 142 /****************************************************************/
 143
 144 class Vocal_name_engraver : public Instrument_name_engraver
 145 {
 146 public:
 147   TRANSLATOR_DECLARATIONS (Vocal_name_engraver);
 148   virtual void create_text ();
 149 };
 150
 151 Vocal_name_engraver::Vocal_name_engraver ()
 152 {
 153 }
 154
 155 void
 156 Vocal_name_engraver::create_text ()
 157 {
 158   if (text_)
 159     return;
 160
 161   SCM txt = get_property ("vocalName");
 162
 163   if (now_mom () > Moment (0))
 164     txt = get_property ("vocNam");
 165
 166   /*
 167     UGH.
 168   */
 169   if (txt == SCM_EOL)
 170     return;
 171
 172   text_ = make_item ("VocalName", SCM_EOL);
 173
 174   if (text_->get_property ("text") != txt)
 175     text_->set_property ("text", txt);
 176 }
 177
 178 ADD_TRANSLATOR (Vocal_name_engraver,
 179                 /* descr */ " Prints the name of the a lyric voice (specified by "
 180                 " @code{Staff.vocalName} and @code{Staff.vocNam}) "
 181                 "at the left of the staff. ",
 182                 /* creats*/ "VocalName",
 183                 /* accepts */ "",
 184                 /* acks  */ "bar-line-interface axis-group-interface",
 185                 /* reads */ "vocNam vocalName",
 186                 /* write */ "");