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--2009 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   bool current_lyric_is_skip_;
  29
  30 public:
  31   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
  32
  33 protected:
  34
  35   DECLARE_ACKNOWLEDGER (lyric_syllable);
  36   DECLARE_TRANSLATOR_LISTENER (hyphen);
  37
  38   virtual void finalize ();
  39
  40   void stop_translation_timestep ();
  41   void process_music ();
  42 };
  43
  44 Hyphen_engraver::Hyphen_engraver ()
  45 {
  46   current_lyric_is_skip_ = false;
  47   hyphen_ = 0;
  48   finished_hyphen_ = 0;
  49   finished_ev_ = 0;
  50   ev_ = 0;
  51 }
  52
  53 void
  54 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
  55 {
  56   Item *item = i.item ();
  57   SCM text = item->get_property ("text");
  58   current_lyric_is_skip_ = ly_is_equal (text, scm_from_locale_string (" "));
  59
  60   if (!hyphen_ && !current_lyric_is_skip_)
  61     hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
  62
  63   if (hyphen_)
  64     hyphen_->set_bound (LEFT, item);
  65
  66   if (finished_hyphen_ && !current_lyric_is_skip_)
  67     finished_hyphen_->set_bound (RIGHT, item);
  68 }
  69
  70 IMPLEMENT_TRANSLATOR_LISTENER (Hyphen_engraver, hyphen);
  71 void
  72 Hyphen_engraver::listen_hyphen (Stream_event *ev)
  73 {
  74   ASSIGN_EVENT_ONCE (ev_, ev);
  75 }
  76
  77 void
  78 completize_hyphen (Spanner *sp)
  79 {
  80   if (!sp->get_bound (RIGHT))
  81     {
  82       extract_item_set (sp, "heads", heads);
  83       if (heads.size ())
  84         sp->set_bound (RIGHT, heads.back ());
  85     }
  86 }
  87
  88 void
  89 Hyphen_engraver::finalize ()
  90 {
  91   if (hyphen_)
  92     {
  93       completize_hyphen (hyphen_);
  94
  95       if (!hyphen_->get_bound (RIGHT))
  96         {
  97           hyphen_->warning (_ ("removing unterminated hyphen"));
  98           hyphen_->suicide ();
  99         }
 100
 101       hyphen_ = 0;
 102     }
 103
 104   if (finished_hyphen_)
 105     {
 106       completize_hyphen (finished_hyphen_);
 107
 108       if (!finished_hyphen_->get_bound (RIGHT))
 109         {
 110           if (finished_ev_)
 111             finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
 112           finished_hyphen_->suicide ();
 113         }
 114       finished_hyphen_ = 0;
 115     }
 116 }
 117
 118 void
 119 Hyphen_engraver::process_music ()
 120 {
 121   if (ev_)
 122     hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 123 }
 124
 125 void
 126 Hyphen_engraver::stop_translation_timestep ()
 127 {
 128   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
 129     {
 130       finished_hyphen_ = 0;
 131       finished_ev_ = 0;
 132     }
 133
 134   if (finished_hyphen_ && hyphen_ && !current_lyric_is_skip_)
 135     {
 136       programming_error ("hyphen not finished yet");
 137       finished_hyphen_ = 0;
 138       finished_ev_ = 0;
 139     }
 140
 141   if (hyphen_)
 142     {
 143       finished_hyphen_ = hyphen_;
 144       finished_ev_ = ev_;
 145     }
 146
 147   hyphen_ = 0;
 148   ev_ = 0;
 149 }
 150
 151 ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
 152
 153 ADD_TRANSLATOR (Hyphen_engraver,
 154                 /* doc */
 155                 "Create lyric hyphens and distance constraints between words.",
 156
 157                 /* create */
 158                 "LyricHyphen "
 159                 "LyricSpace ",
 160
 161                 /* read */
 162                 "",
 163
 164                 /* write */
 165                 ""
 166                 );