lily/hyphen-engraver.cc

   1 /*
   2   hyphen-engraver.cc -- implement Hyphen_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2007 Glen Prideaux <glenprideaux@iname.com>,
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>,
   8   Jan Nieuwenhuizen <janneke@gnu.org>
   9 */
  10
  11 #include "engraver.hh"
  12 #include "international.hh"
  13 #include "item.hh"
  14 #include "pointer-group-interface.hh"
  15 #include "spanner.hh"
  16 #include "stream-event.hh"
  17 #include "warn.hh"
  18
  19 #include "translator.icc"
  20
  21 class Hyphen_engraver : public Engraver
  22 {
  23   Stream_event *ev_;
  24   Stream_event *finished_ev_;
  25
  26   Spanner *hyphen_;
  27   Spanner *finished_hyphen_;
  28
  29 public:
  30   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
  31
  32 protected:
  33
  34   DECLARE_ACKNOWLEDGER (lyric_syllable);
  35   DECLARE_TRANSLATOR_LISTENER (hyphen);
  36
  37   virtual void finalize ();
  38
  39   void stop_translation_timestep ();
  40   void process_music ();
  41 };
  42
  43 Hyphen_engraver::Hyphen_engraver ()
  44 {
  45   hyphen_ = 0;
  46   finished_hyphen_ = 0;
  47   finished_ev_ = 0;
  48   ev_ = 0;
  49 }
  50
  51 void
  52 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
  53 {
  54   Item *item = i.item ();
  55
  56   if (!hyphen_)
  57     hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
  58
  59   if (hyphen_)
  60     hyphen_->set_bound (LEFT, item);
  61
  62   if (finished_hyphen_)
  63     finished_hyphen_->set_bound (RIGHT, item);
  64 }
  65
  66 IMPLEMENT_TRANSLATOR_LISTENER (Hyphen_engraver, hyphen);
  67 void
  68 Hyphen_engraver::listen_hyphen (Stream_event *ev)
  69 {
  70   ASSIGN_EVENT_ONCE (ev_, ev);
  71 }
  72
  73 void
  74 completize_hyphen (Spanner *sp)
  75 {
  76   if (!sp->get_bound (RIGHT))
  77     {
  78       extract_item_set (sp, "heads", heads);
  79       if (heads.size ())
  80         sp->set_bound (RIGHT, heads.back ());
  81     }
  82 }
  83
  84 void
  85 Hyphen_engraver::finalize ()
  86 {
  87   if (hyphen_)
  88     {
  89       completize_hyphen (hyphen_);
  90
  91       if (!hyphen_->get_bound (RIGHT))
  92         {
  93           hyphen_->warning (_ ("removing unterminated hyphen"));
  94           hyphen_->suicide ();
  95         }
  96
  97       hyphen_ = 0;
  98     }
  99
 100   if (finished_hyphen_)
 101     {
 102       completize_hyphen (finished_hyphen_);
 103
 104       if (!finished_hyphen_->get_bound (RIGHT))
 105         {
 106           if (finished_ev_)
 107             finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
 108           finished_hyphen_->suicide ();
 109         }
 110       finished_hyphen_ = 0;
 111     }
 112 }
 113
 114 void
 115 Hyphen_engraver::process_music ()
 116 {
 117   if (ev_)
 118     hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 119 }
 120
 121 void
 122 Hyphen_engraver::stop_translation_timestep ()
 123 {
 124   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
 125     {
 126       finished_hyphen_ = 0;
 127       finished_ev_ = 0;
 128     }
 129
 130   if (finished_hyphen_ && hyphen_)
 131     {
 132       programming_error ("hyphen not finished yet");
 133       finished_hyphen_ = 0;
 134       finished_ev_ = 0;
 135     }
 136
 137   if (hyphen_)
 138     {
 139       finished_hyphen_ = hyphen_;
 140       finished_ev_ = ev_;
 141     }
 142
 143   hyphen_ = 0;
 144   ev_ = 0;
 145 }
 146
 147 ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
 148
 149 ADD_TRANSLATOR (Hyphen_engraver,
 150                 /* doc */
 151                 "Create lyric hyphens and distance constraints between words.",
 152
 153                 /* create */
 154                 "LyricHyphen "
 155                 "LyricSpace ",
 156
 157                 /* read */
 158                 "",
 159
 160                 /* write */
 161                 ""
 162                 );