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--2005 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
  13 #include "warn.hh"
  14 #include "item.hh"
  15 #include "spanner.hh"
  16 #include "pointer-group-interface.hh"
  17
  18 class Hyphen_engraver : public Engraver
  19 {
  20   Music *ev_;
  21   Spanner *hyphen_;
  22   Spanner *finished_hyphen_;
  23 public:
  24   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
  25
  26 protected:
  27   DECLARE_ACKNOWLEDGER (lyric_syllable);
  28   virtual void finalize ();
  29   virtual bool try_music (Music *);
  30   void stop_translation_timestep ();
  31   void process_music ();
  32 private:
  33 };
  34
  35 Hyphen_engraver::Hyphen_engraver ()
  36 {
  37   hyphen_ = 0;
  38   finished_hyphen_ = 0;
  39   ev_ = 0;
  40 }
  41
  42 void
  43 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
  44 {
  45   Item *item = i.item ();
  46   if (hyphen_)
  47     hyphen_->set_bound (LEFT, item);
  48
  49   if (finished_hyphen_)
  50     finished_hyphen_->set_bound (RIGHT, item);
  51 }
  52
  53 bool
  54 Hyphen_engraver::try_music (Music *r)
  55 {
  56   if (ev_)
  57     return false;
  58
  59   ev_ = r;
  60   return true;
  61 }
  62
  63 void
  64 completize_hyphen (Spanner *sp)
  65 {
  66   if (!sp->get_bound (RIGHT))
  67     {
  68       extract_item_set (sp, "heads", heads);
  69       if (heads.size ())
  70         sp->set_bound (RIGHT, heads.top ());
  71     }
  72 }
  73
  74 void
  75 Hyphen_engraver::finalize ()
  76 {
  77   if (hyphen_)
  78     {
  79       completize_hyphen (hyphen_);
  80
  81       if (!hyphen_->get_bound (RIGHT))
  82         {
  83           hyphen_->warning (_ ("removing unterminated hyphen"));
  84           hyphen_->suicide ();
  85         }
  86
  87       hyphen_ = 0;
  88     }
  89
  90   if (finished_hyphen_)
  91     {
  92       completize_hyphen (finished_hyphen_);
  93
  94       if (!finished_hyphen_->get_bound (RIGHT))
  95         {
  96           finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
  97           finished_hyphen_->suicide ();
  98         }
  99       finished_hyphen_ = 0;
 100     }
 101 }
 102
 103 void
 104 Hyphen_engraver::process_music ()
 105 {
 106   if (ev_)
 107     hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 108 }
 109
 110 void
 111 Hyphen_engraver::stop_translation_timestep ()
 112 {
 113   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
 114     finished_hyphen_ = 0;
 115
 116   if (finished_hyphen_ && hyphen_)
 117     {
 118       programming_error ("hyphen not finished yet");
 119       finished_hyphen_ = 0;
 120     }
 121
 122   if (hyphen_)
 123     finished_hyphen_ = hyphen_;
 124   hyphen_ = 0;
 125
 126   ev_ = 0;
 127 }
 128
 129 #include "translator.icc"
 130
 131 ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
 132
 133 ADD_TRANSLATOR (Hyphen_engraver,
 134                 /* doc */ "Create lyric hyphens",
 135                 /* create */ "LyricHyphen",
 136                 /* accept */ "hyphen-event",
 137                 /* read */ "",
 138                 /* write */ "");