lily/new-dynamic-engraver.cc

   1 /*
   2   new-dynamic-engraver.cc -- implement New_dynamic_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2008--2009 Han-Wen Nienhuys <hanwen@lilypond.org>
   7
   8 */
   9
  10
  11 #include "engraver.hh"
  12
  13 #include "hairpin.hh"
  14 #include "international.hh"
  15 #include "item.hh"
  16 #include "note-column.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "self-alignment-interface.hh"
  19 #include "spanner.hh"
  20 #include "stream-event.hh"
  21 #include "text-interface.hh"
  22
  23 #include "translator.icc"
  24
  25 class New_dynamic_engraver : public Engraver
  26 {
  27   TRANSLATOR_DECLARATIONS (New_dynamic_engraver);
  28   DECLARE_ACKNOWLEDGER (note_column);
  29   DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
  30   DECLARE_TRANSLATOR_LISTENER (span_dynamic);
  31
  32 protected:
  33   virtual void process_music ();
  34   virtual void stop_translation_timestep ();
  35   virtual void finalize ();
  36
  37 private:
  38   string get_spanner_type (Stream_event *ev);
  39
  40   Drul_array<Stream_event *> accepted_spanevents_drul_;
  41   Spanner *current_spanner_;
  42   Spanner *finished_spanner_;
  43
  44   Item *script_;
  45   Stream_event *script_event_;
  46   Stream_event *current_span_event_;
  47 };
  48
  49 New_dynamic_engraver::New_dynamic_engraver ()
  50 {
  51   script_event_ = 0;
  52   current_span_event_ = 0;
  53   script_ = 0;
  54   finished_spanner_ = 0;
  55   current_spanner_ = 0;
  56   accepted_spanevents_drul_.set (0, 0);
  57 }
  58
  59 IMPLEMENT_TRANSLATOR_LISTENER (New_dynamic_engraver, absolute_dynamic);
  60 void
  61 New_dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
  62 {
  63   ASSIGN_EVENT_ONCE (script_event_, ev);
  64 }
  65
  66 IMPLEMENT_TRANSLATOR_LISTENER (New_dynamic_engraver, span_dynamic);
  67 void
  68 New_dynamic_engraver::listen_span_dynamic (Stream_event *ev)
  69 {
  70   Direction d = to_dir (ev->get_property ("span-direction"));
  71
  72   ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[d], ev);
  73 }
  74
  75
  76 void
  77 New_dynamic_engraver::process_music ()
  78 {
  79   if (current_spanner_
  80       && (accepted_spanevents_drul_[STOP] || script_event_ || accepted_spanevents_drul_[START]))
  81     {
  82       Stream_event *ender = accepted_spanevents_drul_[STOP];
  83       if (!ender)
  84         ender = script_event_;
  85
  86       if (!ender)
  87         ender = accepted_spanevents_drul_[START];
  88
  89       finished_spanner_ = current_spanner_;
  90       announce_end_grob (finished_spanner_, ender->self_scm ());
  91       current_spanner_ = 0;
  92       current_span_event_ = 0;
  93     }
  94
  95   if (accepted_spanevents_drul_[START])
  96     {
  97       current_span_event_ = accepted_spanevents_drul_[START];
  98
  99       string start_type = get_spanner_type (current_span_event_);
 100       SCM cresc_type = get_property ((start_type + "Spanner").c_str ());
 101
 102       if (cresc_type == ly_symbol2scm ("text"))
 103         {
 104           current_spanner_
 105             = make_spanner ("DynamicTextSpanner",
 106                             accepted_spanevents_drul_[START]->self_scm ());
 107
 108           SCM text = get_property ((start_type + "Text").c_str ());
 109           if (Text_interface::is_markup (text))
 110             {
 111               current_spanner_->set_property ("text", text);
 112             }
 113         }
 114       else
 115         {
 116           if (cresc_type != ly_symbol2scm ("hairpin"))
 117             {
 118               string as_string = ly_scm_write_string (cresc_type);
 119               current_span_event_
 120                 ->origin()->warning (_f ("unknown crescendo style: %s\ndefaulting to hairpin.", as_string.c_str()));
 121             }
 122           current_spanner_ = make_spanner ("Hairpin",
 123                                            current_span_event_->self_scm ());
 124           if (finished_spanner_)
 125             {
 126               Pointer_group_interface::add_grob (finished_spanner_,
 127                                                  ly_symbol2scm ("adjacent-hairpins"),
 128                                                  current_spanner_);
 129
 130               Pointer_group_interface::add_grob (current_spanner_,
 131                                                  ly_symbol2scm ("adjacent-hairpins"),
 132                                                  finished_spanner_);
 133             }
 134         }
 135     }
 136
 137   if (script_event_)
 138     {
 139       script_ = make_item ("DynamicText", script_event_->self_scm ());
 140       script_->set_property ("text",
 141                              script_event_->get_property ("text"));
 142
 143       if (finished_spanner_)
 144         finished_spanner_->set_bound (RIGHT, script_);
 145       if (current_spanner_)
 146         {
 147           current_spanner_->set_bound (LEFT, script_);
 148
 149           if (!Hairpin::has_interface (current_spanner_))
 150             set_nested_property (current_spanner_,
 151                                  scm_list_3 (ly_symbol2scm ("bound-details"),
 152                                              ly_symbol2scm ("left"),
 153                                              ly_symbol2scm ("attach-dir")
 154                                              ),
 155                                  scm_from_int (RIGHT));
 156
 157         }
 158     }
 159 }
 160
 161
 162
 163 void
 164 New_dynamic_engraver::stop_translation_timestep ()
 165 {
 166   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 167     finished_spanner_->set_bound (RIGHT,
 168                                   unsmob_grob (get_property ("currentMusicalColumn")));
 169
 170   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 171     current_spanner_->set_bound (LEFT,
 172                                  unsmob_grob (get_property ("currentMusicalColumn")));
 173   script_ = 0;
 174   script_event_ = 0;
 175   accepted_spanevents_drul_.set (0, 0);
 176   finished_spanner_ = 0;
 177 }
 178
 179 void
 180 New_dynamic_engraver::finalize ()
 181 {
 182   if (current_spanner_
 183       && !current_spanner_->is_live ())
 184     current_spanner_ = 0;
 185   if (current_spanner_)
 186     {
 187       current_span_event_
 188         ->origin ()->warning (_f ("unterminated %s",
 189                                   get_spanner_type (current_span_event_)
 190                                   .c_str ()));
 191       current_spanner_->suicide ();
 192       current_spanner_ = 0;
 193     }
 194 }
 195
 196 string
 197 New_dynamic_engraver::get_spanner_type (Stream_event *ev)
 198 {
 199   string type;
 200   SCM start_sym = ev->get_property ("class");
 201
 202   if (start_sym == ly_symbol2scm ("decrescendo-event"))
 203     type = "decrescendo";
 204   else if (start_sym == ly_symbol2scm ("crescendo-event"))
 205     type = "crescendo";
 206   else
 207     programming_error ("unknown dynamic spanner type");
 208   return type;
 209 }
 210
 211 void
 212 New_dynamic_engraver::acknowledge_note_column (Grob_info info)
 213 {
 214   if (script_ && !script_->get_parent (X_AXIS))
 215     {
 216       extract_grob_set (info.grob (), "note-heads", heads);
 217       if (heads.size ())
 218         {
 219           Grob *head = heads[0];
 220           script_->set_parent (head, X_AXIS);
 221           Self_alignment_interface::set_center_parent (script_, X_AXIS);
 222         }
 223     }
 224
 225   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 226     current_spanner_->set_bound (LEFT, info.grob ());
 227   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 228     finished_spanner_->set_bound (RIGHT, info.grob ());
 229 }
 230
 231 ADD_ACKNOWLEDGER (New_dynamic_engraver, note_column);
 232 ADD_TRANSLATOR (New_dynamic_engraver,
 233                 /* doc */
 234                 "Create hairpins, dynamic texts, and their vertical"
 235                 " alignments.  The symbols are collected onto a"
 236                 " @code{DynamicLineSpanner} grob which takes care of vertical"
 237                 " positioning.",
 238
 239                 /* create */
 240                 "DynamicTextSpanner "
 241                 "DynamicText "
 242                 "Hairpin ",
 243
 244                 /* read */
 245                 "crescendoSpanner "
 246                 "crescendoText "
 247                 "currentMusicalColumn "
 248                 "decrescendoSpanner "
 249                 "decrescendoText ",
 250
 251                 /* write */
 252                 ""
 253                 );