lily/text-spanner-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "engraver.hh"
  21
  22 #include "international.hh"
  23 #include "note-column.hh"
  24 #include "pointer-group-interface.hh"
  25 #include "side-position-interface.hh"
  26 #include "spanner.hh"
  27 #include "stream-event.hh"
  28
  29 #include "translator.icc"
  30
  31 class Text_spanner_engraver : public Engraver
  32 {
  33 public:
  34   TRANSLATOR_DECLARATIONS (Text_spanner_engraver);
  35 protected:
  36   virtual void finalize ();
  37   void listen_text_span (Stream_event *);
  38   void acknowledge_note_column (Grob_info);
  39   void stop_translation_timestep ();
  40   void process_music ();
  41
  42 private:
  43   Spanner *span_;
  44   Spanner *finished_;
  45   Stream_event *current_event_;
  46   Drul_array<Stream_event *> event_drul_;
  47   void typeset_all ();
  48 };
  49
  50 Text_spanner_engraver::Text_spanner_engraver ()
  51 {
  52   finished_ = 0;
  53   current_event_ = 0;
  54   span_ = 0;
  55   event_drul_.set (0, 0);
  56 }
  57
  58 void
  59 Text_spanner_engraver::listen_text_span (Stream_event *ev)
  60 {
  61   Direction d = to_dir (ev->get_property ("span-direction"));
  62   ASSIGN_EVENT_ONCE (event_drul_[d], ev);
  63 }
  64
  65 void
  66 Text_spanner_engraver::process_music ()
  67 {
  68   if (event_drul_[STOP])
  69     {
  70       if (!span_)
  71         event_drul_[STOP]->origin ()->warning (_ ("cannot find start of text spanner"));
  72       else
  73         {
  74           finished_ = span_;
  75           announce_end_grob (finished_, SCM_EOL);
  76           span_ = 0;
  77           current_event_ = 0;
  78         }
  79     }
  80
  81   if (event_drul_[START])
  82     {
  83       if (current_event_)
  84         event_drul_[START]->origin ()->warning (_ ("already have a text spanner"));
  85       else
  86         {
  87           current_event_ = event_drul_[START];
  88           span_ = make_spanner ("TextSpanner", event_drul_[START]->self_scm ());
  89           if (Direction d = to_dir (current_event_->get_property ("direction")))
  90             span_->set_property ("direction", scm_from_int (d));
  91
  92           Side_position_interface::set_axis (span_, Y_AXIS);
  93           event_drul_[START] = 0;
  94         }
  95     }
  96 }
  97
  98 void
  99 Text_spanner_engraver::typeset_all ()
 100 {
 101   if (finished_)
 102     {
 103       if (!finished_->get_bound (RIGHT))
 104         {
 105           Grob *e = unsmob<Grob> (get_property ("currentMusicalColumn"));
 106           finished_->set_bound (RIGHT, e);
 107         }
 108       finished_ = 0;
 109     }
 110 }
 111
 112 void
 113 Text_spanner_engraver::stop_translation_timestep ()
 114 {
 115   if (span_ && !span_->get_bound (LEFT))
 116     {
 117       Grob *e = unsmob<Grob> (get_property ("currentMusicalColumn"));
 118       span_->set_bound (LEFT, e);
 119     }
 120
 121   typeset_all ();
 122   event_drul_.set (0, 0);
 123 }
 124
 125 void
 126 Text_spanner_engraver::finalize ()
 127 {
 128   typeset_all ();
 129   if (span_)
 130     {
 131       current_event_->origin ()->warning (_ ("unterminated text spanner"));
 132       span_->suicide ();
 133       span_ = 0;
 134     }
 135 }
 136
 137 void
 138 Text_spanner_engraver::acknowledge_note_column (Grob_info info)
 139 {
 140   if (span_)
 141     {
 142       Pointer_group_interface::add_grob (span_,
 143                                          ly_symbol2scm ("note-columns"),
 144                                          info.grob ());
 145       if (!span_->get_bound (LEFT))
 146         add_bound_item (span_, info.grob ());
 147     }
 148   else if (finished_)
 149     {
 150       Pointer_group_interface::add_grob (finished_,
 151                                          ly_symbol2scm ("note-columns"),
 152                                          info.grob ());
 153       if (!finished_->get_bound (RIGHT))
 154         add_bound_item (finished_, info.grob ());
 155     }
 156 }
 157
 158
 159 void
 160 Text_spanner_engraver::boot ()
 161 {
 162   ADD_LISTENER (Text_spanner_engraver, text_span);
 163   ADD_ACKNOWLEDGER (Text_spanner_engraver, note_column);
 164 }
 165
 166 ADD_TRANSLATOR (Text_spanner_engraver,
 167                 /* doc */
 168                 "Create text spanner from an event.",
 169
 170                 /* create */
 171                 "TextSpanner ",
 172
 173                 /* read */
 174                 "currentMusicalColumn ",
 175
 176                 /* write */
 177                 ""
 178                );