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   SCM get_property_setting (Stream_event *evt, char const *evprop, char const *ctxprop);
  39   string get_spanner_type (Stream_event *ev);
  40
  41   Drul_array<Stream_event *> accepted_spanevents_drul_;
  42   Spanner *current_spanner_;
  43   Spanner *finished_spanner_;
  44
  45   Item *script_;
  46   Stream_event *script_event_;
  47   Stream_event *current_span_event_;
  48 };
  49
  50 New_dynamic_engraver::New_dynamic_engraver ()
  51 {
  52   script_event_ = 0;
  53   current_span_event_ = 0;
  54   script_ = 0;
  55   finished_spanner_ = 0;
  56   current_spanner_ = 0;
  57   accepted_spanevents_drul_.set (0, 0);
  58 }
  59
  60 IMPLEMENT_TRANSLATOR_LISTENER (New_dynamic_engraver, absolute_dynamic);
  61 void
  62 New_dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
  63 {
  64   ASSIGN_EVENT_ONCE (script_event_, ev);
  65 }
  66
  67 IMPLEMENT_TRANSLATOR_LISTENER (New_dynamic_engraver, span_dynamic);
  68 void
  69 New_dynamic_engraver::listen_span_dynamic (Stream_event *ev)
  70 {
  71   Direction d = to_dir (ev->get_property ("span-direction"));
  72
  73   ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[d], ev);
  74 }
  75
  76 SCM
  77 New_dynamic_engraver::get_property_setting (Stream_event *evt, char const *evprop, char const *ctxprop)
  78 {
  79   SCM spanner_type = evt->get_property (evprop);
  80   if (spanner_type == SCM_EOL)
  81     spanner_type = get_property (ctxprop);
  82   return spanner_type;
  83 }
  84
  85 void
  86 New_dynamic_engraver::process_music ()
  87 {
  88   if (current_spanner_
  89       && (accepted_spanevents_drul_[STOP] || script_event_ || accepted_spanevents_drul_[START]))
  90     {
  91       Stream_event *ender = accepted_spanevents_drul_[STOP];
  92       if (!ender)
  93         ender = script_event_;
  94
  95       if (!ender)
  96         ender = accepted_spanevents_drul_[START];
  97
  98       finished_spanner_ = current_spanner_;
  99       announce_end_grob (finished_spanner_, ender->self_scm ());
 100       current_spanner_ = 0;
 101       current_span_event_ = 0;
 102     }
 103
 104   if (accepted_spanevents_drul_[START])
 105     {
 106       current_span_event_ = accepted_spanevents_drul_[START];
 107
 108       string start_type = get_spanner_type (current_span_event_);
 109       SCM cresc_type = get_property_setting (current_span_event_, "span-type",
 110                                        (start_type + "Spanner").c_str ());
 111
 112       if (cresc_type == ly_symbol2scm ("text"))
 113         {
 114           current_spanner_
 115             = make_spanner ("DynamicTextSpanner",
 116                             accepted_spanevents_drul_[START]->self_scm ());
 117
 118           SCM text = get_property_setting (current_span_event_, "span-text",
 119                                        (start_type + "Text").c_str ());
 120           if (Text_interface::is_markup (text))
 121             {
 122               current_spanner_->set_property ("text", text);
 123             }
 124         }
 125       else
 126         {
 127           if (cresc_type != ly_symbol2scm ("hairpin"))
 128             {
 129               string as_string = ly_scm_write_string (cresc_type);
 130               current_span_event_
 131                 ->origin()->warning (_f ("unknown crescendo style: %s\ndefaulting to hairpin.", as_string.c_str()));
 132             }
 133           current_spanner_ = make_spanner ("Hairpin",
 134                                            current_span_event_->self_scm ());
 135           if (finished_spanner_)
 136             {
 137               Pointer_group_interface::add_grob (finished_spanner_,
 138                                                  ly_symbol2scm ("adjacent-hairpins"),
 139                                                  current_spanner_);
 140
 141               Pointer_group_interface::add_grob (current_spanner_,
 142                                                  ly_symbol2scm ("adjacent-hairpins"),
 143                                                  finished_spanner_);
 144             }
 145         }
 146     }
 147
 148   if (script_event_)
 149     {
 150       script_ = make_item ("DynamicText", script_event_->self_scm ());
 151       script_->set_property ("text",
 152                              script_event_->get_property ("text"));
 153
 154       if (finished_spanner_)
 155         finished_spanner_->set_bound (RIGHT, script_);
 156       if (current_spanner_)
 157         {
 158           current_spanner_->set_bound (LEFT, script_);
 159
 160           if (!Hairpin::has_interface (current_spanner_))
 161             set_nested_property (current_spanner_,
 162                                  scm_list_3 (ly_symbol2scm ("bound-details"),
 163                                              ly_symbol2scm ("left"),
 164                                              ly_symbol2scm ("attach-dir")
 165                                              ),
 166                                  scm_from_int (RIGHT));
 167
 168         }
 169     }
 170 }
 171
 172
 173
 174 void
 175 New_dynamic_engraver::stop_translation_timestep ()
 176 {
 177   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 178     finished_spanner_->set_bound (RIGHT,
 179                                   unsmob_grob (get_property ("currentMusicalColumn")));
 180
 181   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 182     current_spanner_->set_bound (LEFT,
 183                                  unsmob_grob (get_property ("currentMusicalColumn")));
 184   script_ = 0;
 185   script_event_ = 0;
 186   accepted_spanevents_drul_.set (0, 0);
 187   finished_spanner_ = 0;
 188 }
 189
 190 void
 191 New_dynamic_engraver::finalize ()
 192 {
 193   if (current_spanner_
 194       && !current_spanner_->is_live ())
 195     current_spanner_ = 0;
 196   if (current_spanner_)
 197     {
 198       current_span_event_
 199         ->origin ()->warning (_f ("unterminated %s",
 200                                   get_spanner_type (current_span_event_)
 201                                   .c_str ()));
 202       current_spanner_->suicide ();
 203       current_spanner_ = 0;
 204     }
 205 }
 206
 207 string
 208 New_dynamic_engraver::get_spanner_type (Stream_event *ev)
 209 {
 210   string type;
 211   SCM start_sym = ev->get_property ("class");
 212
 213   if (start_sym == ly_symbol2scm ("decrescendo-event"))
 214     type = "decrescendo";
 215   else if (start_sym == ly_symbol2scm ("crescendo-event"))
 216     type = "crescendo";
 217   else
 218     programming_error ("unknown dynamic spanner type");
 219   return type;
 220 }
 221
 222 void
 223 New_dynamic_engraver::acknowledge_note_column (Grob_info info)
 224 {
 225   if (script_ && !script_->get_parent (X_AXIS))
 226     {
 227       extract_grob_set (info.grob (), "note-heads", heads);
 228       if (heads.size ())
 229         {
 230           Grob *head = heads[0];
 231           script_->set_parent (head, X_AXIS);
 232           Self_alignment_interface::set_center_parent (script_, X_AXIS);
 233         }
 234     }
 235
 236   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 237     current_spanner_->set_bound (LEFT, info.grob ());
 238   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 239     finished_spanner_->set_bound (RIGHT, info.grob ());
 240 }
 241
 242 ADD_ACKNOWLEDGER (New_dynamic_engraver, note_column);
 243 ADD_TRANSLATOR (New_dynamic_engraver,
 244                 /* doc */
 245                 "Create hairpins, dynamic texts, and their vertical"
 246                 " alignments.  The symbols are collected onto a"
 247                 " @code{DynamicLineSpanner} grob which takes care of vertical"
 248                 " positioning.",
 249
 250                 /* create */
 251                 "DynamicTextSpanner "
 252                 "DynamicText "
 253                 "Hairpin ",
 254
 255                 /* read */
 256                 "crescendoSpanner "
 257                 "crescendoText "
 258                 "currentMusicalColumn "
 259                 "decrescendoSpanner "
 260                 "decrescendoText ",
 261
 262                 /* write */
 263                 ""
 264                 );