lily/text-spanner-engraver.cc

   1 /*
   2   text-spanner-engraver.cc -- implement Text_spanner_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2000--2007 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include "engraver.hh"
  10
  11 #include "international.hh"
  12 #include "note-column.hh"
  13 #include "pointer-group-interface.hh"
  14 #include "side-position-interface.hh"
  15 #include "spanner.hh"
  16 #include "stream-event.hh"
  17
  18 #include "translator.icc"
  19
  20 class Text_spanner_engraver : public Engraver
  21 {
  22 public:
  23   TRANSLATOR_DECLARATIONS (Text_spanner_engraver);
  24 protected:
  25   virtual void finalize ();
  26   DECLARE_TRANSLATOR_LISTENER (text_span);
  27   DECLARE_ACKNOWLEDGER (note_column);
  28   void stop_translation_timestep ();
  29   void process_music ();
  30
  31 private:
  32   Spanner *span_;
  33   Spanner *finished_;
  34   Stream_event *current_event_;
  35   Drul_array<Stream_event *> event_drul_;
  36   void typeset_all ();
  37 };
  38
  39 Text_spanner_engraver::Text_spanner_engraver ()
  40 {
  41   finished_ = 0;
  42   current_event_ = 0;
  43   span_ = 0;
  44   event_drul_[START] = 0;
  45   event_drul_[STOP] = 0;
  46 }
  47
  48 IMPLEMENT_TRANSLATOR_LISTENER (Text_spanner_engraver, text_span);
  49 void
  50 Text_spanner_engraver::listen_text_span (Stream_event *ev)
  51 {
  52   Direction d = to_dir (ev->get_property ("span-direction"));
  53   ASSIGN_EVENT_ONCE (event_drul_[d], ev);
  54 }
  55
  56 void
  57 Text_spanner_engraver::process_music ()
  58 {
  59   if (event_drul_[STOP])
  60     {
  61       if (!span_)
  62         event_drul_[STOP]->origin ()->warning (_ ("cannot find start of text spanner"));
  63       else
  64         {
  65           finished_ = span_;
  66           span_ = 0;
  67           current_event_ = 0;
  68         }
  69     }
  70
  71   if (event_drul_[START])
  72     {
  73       if (current_event_)
  74         event_drul_[START]->origin ()->warning (_ ("already have a text spanner"));
  75       else
  76         {
  77           current_event_ = event_drul_[START];
  78           span_ = make_spanner ("TextSpanner", event_drul_[START]->self_scm ());
  79
  80           Side_position_interface::set_axis (span_, Y_AXIS);
  81           event_drul_[START] = 0;
  82         }
  83     }
  84 }
  85
  86 void
  87 Text_spanner_engraver::typeset_all ()
  88 {
  89   if (finished_)
  90     {
  91       if (!finished_->get_bound (RIGHT))
  92         {
  93           Grob *e = unsmob_grob (get_property ("currentMusicalColumn"));
  94           finished_->set_bound (RIGHT, e);
  95         }
  96       finished_ = 0;
  97     }
  98 }
  99
 100 void
 101 Text_spanner_engraver::stop_translation_timestep ()
 102 {
 103   if (span_ && !span_->get_bound (LEFT))
 104     {
 105       Grob *e = unsmob_grob (get_property ("currentMusicalColumn"));
 106       span_->set_bound (LEFT, e);
 107     }
 108
 109   typeset_all ();
 110   event_drul_[START] = 0;
 111   event_drul_[STOP] = 0;
 112 }
 113
 114 void
 115 Text_spanner_engraver::finalize ()
 116 {
 117   typeset_all ();
 118   if (span_)
 119     {
 120       current_event_->origin ()->warning (_ ("unterminated text spanner"));
 121       span_->suicide ();
 122       span_ = 0;
 123     }
 124 }
 125
 126
 127 void
 128 Text_spanner_engraver::acknowledge_note_column (Grob_info info)
 129 {
 130   if (!span_)
 131     return;
 132
 133   Pointer_group_interface::add_grob (span_,
 134                                      ly_symbol2scm ("note-columns"),
 135                                      info.grob());
 136   add_bound_item (span_, info.grob ());
 137 }
 138
 139 ADD_ACKNOWLEDGER (Text_spanner_engraver, note_column);
 140
 141 ADD_TRANSLATOR (Text_spanner_engraver,
 142                 /* doc */
 143                 "Create text spanner from an event.",
 144                 /* create */
 145                 "TextSpanner ",
 146                 /* read */
 147                 "",
 148                 /* write */
 149                 ""
 150                 );