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@cs.uu.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         {
  71           sp->set_bound (RIGHT, heads.top ());
  72         }
  73     }
  74 }
  75
  76 void
  77 Hyphen_engraver::finalize ()
  78 {
  79   if (hyphen_)
  80     {
  81       completize_hyphen (hyphen_);
  82
  83       if (!hyphen_->get_bound (RIGHT))
  84         {
  85           hyphen_->warning (_ ("removing unterminated hyphen"));
  86           hyphen_->suicide ();
  87         }
  88
  89       hyphen_ = 0;
  90     }
  91
  92   if (finished_hyphen_)
  93     {
  94       completize_hyphen (finished_hyphen_);
  95
  96       if (!finished_hyphen_->get_bound (RIGHT))
  97         {
  98           finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
  99           finished_hyphen_->suicide ();
 100         }
 101       finished_hyphen_ = 0;
 102     }
 103 }
 104
 105 void
 106 Hyphen_engraver::process_music ()
 107 {
 108   if (ev_)
 109     {
 110       hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 111     }
 112 }
 113
 114 void
 115 Hyphen_engraver::stop_translation_timestep ()
 116 {
 117   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
 118     {
 119       finished_hyphen_ = 0;
 120     }
 121
 122   if (finished_hyphen_ && hyphen_)
 123     {
 124       programming_error ("hyphen not finished yet");
 125       finished_hyphen_ = 0;
 126     }
 127
 128   if (hyphen_)
 129     finished_hyphen_ = hyphen_;
 130   hyphen_ = 0;
 131
 132   ev_ = 0;
 133 }
 134
 135 #include "translator.icc"
 136
 137 ADD_ACKNOWLEDGER(Hyphen_engraver,lyric_syllable);
 138 ADD_TRANSLATOR (Hyphen_engraver,
 139                 /* descr */ "Create lyric hyphens",
 140                 /* creats*/ "LyricHyphen",
 141                 /* accepts */ "hyphen-event",
 142                 /* reads */ "",
 143                 /* write */ "");