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--2006 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 "warn.hh"
  17
  18 class Hyphen_engraver : public Engraver
  19 {
  20   Music *ev_;
  21   Music *finished_ev_;
  22
  23   Spanner *hyphen_;
  24   Spanner *finished_hyphen_;
  25
  26 public:
  27   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
  28
  29 protected:
  30
  31   DECLARE_ACKNOWLEDGER (lyric_syllable);
  32
  33   virtual void finalize ();
  34   virtual bool try_music (Music *);
  35
  36   void stop_translation_timestep ();
  37   void process_music ();
  38 };
  39
  40 Hyphen_engraver::Hyphen_engraver ()
  41 {
  42   hyphen_ = 0;
  43   finished_hyphen_ = 0;
  44   finished_ev_ = 0;
  45   ev_ = 0;
  46 }
  47
  48 void
  49 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
  50 {
  51   Item *item = i.item ();
  52
  53   if (!hyphen_)
  54     hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
  55
  56   if (hyphen_)
  57     hyphen_->set_bound (LEFT, item);
  58
  59   if (finished_hyphen_)
  60     finished_hyphen_->set_bound (RIGHT, item);
  61 }
  62
  63 bool
  64 Hyphen_engraver::try_music (Music *r)
  65 {
  66   if (ev_)
  67     return false;
  68
  69   ev_ = r;
  70   return true;
  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 #include "translator.icc"
 148
 149 ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
 150
 151 ADD_TRANSLATOR (Hyphen_engraver,
 152                 /* doc */ "Create lyric hyphens and "
 153                 "distance constraints between words.",
 154                 /* create */ "LyricHyphen LyricSpace",
 155                 /* accept */ "hyphen-event",
 156                 /* read */ "",
 157                 /* write */ "");