lily/dynamic-engraver.cc

   1 /*
   2   dynamic-engraver.cc -- implement Dynamic_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8 #include "debug.hh"
   9 #include "dimensions.hh"
  10 #include "crescendo.hh"
  11 #include "musical-request.hh"
  12 #include "paper-column.hh"
  13 #include "note-column.hh"
  14 #include "item.hh"
  15 #include "side-position-interface.hh"
  16 #include "engraver.hh"
  17 #include "group-interface.hh"
  18 #include "directional-element-interface.hh"
  19 #include "translator-group.hh"
  20 #include "axis-group-interface.hh"
  21
  22
  23 /*
  24   TODO:
  25
  26   * direction of text-dynamic-request if not equal to direction of
  27   line-spanner
  28 */
  29
  30 /**
  31    print text & hairpin dynamics.
  32  */
  33 class Dynamic_engraver : public Engraver
  34 {
  35   Item * script_p_;
  36   Spanner * finished_cresc_p_;
  37   Spanner * cresc_p_;
  38
  39   Dynamic_script_req* script_req_l_;
  40
  41   Span_req * current_cresc_req_;
  42   Drul_array<Span_req*> accepted_spanreqs_drul_;
  43
  44   Spanner* line_spanner_;
  45   Spanner* finished_line_spanner_;
  46
  47   Link_array<Note_column> pending_column_arr_;
  48   Link_array<Score_element> pending_element_arr_;
  49
  50   void typeset_all ();
  51
  52 public:
  53   VIRTUAL_COPY_CONS(Translator);
  54   Dynamic_engraver ();
  55
  56 protected:
  57   virtual void do_removal_processing ();
  58   virtual void acknowledge_element (Score_element_info);
  59   virtual bool do_try_music (Music *req_l);
  60   virtual void do_process_music ();
  61   virtual void do_pre_move_processing ();
  62   virtual void do_post_move_processing ();
  63 };
  64
  65 ADD_THIS_TRANSLATOR (Dynamic_engraver);
  66
  67
  68 Dynamic_engraver::Dynamic_engraver ()
  69 {
  70   script_p_ = 0;
  71   finished_cresc_p_ = 0;
  72   line_spanner_ = 0;
  73   finished_line_spanner_ = 0;
  74   current_cresc_req_ = 0;
  75   cresc_p_ =0;
  76
  77   script_req_l_ = 0;
  78   accepted_spanreqs_drul_[START] = 0;
  79   accepted_spanreqs_drul_[STOP] = 0;
  80 }
  81
  82 void
  83 Dynamic_engraver::do_post_move_processing ()
  84 {
  85   script_req_l_ = 0;
  86   accepted_spanreqs_drul_[START] = 0;
  87   accepted_spanreqs_drul_[STOP] = 0;
  88 }
  89
  90 bool
  91 Dynamic_engraver::do_try_music (Music * m)
  92 {
  93   if (Dynamic_script_req* d = dynamic_cast <Dynamic_script_req*> (m))
  94     {
  95       script_req_l_ = d;
  96       return true;
  97     }
  98   else if (Span_req* s =  dynamic_cast <Span_req*> (m))
  99     {
 100       if (s->span_type_str_ == "abort")
 101         {
 102           accepted_spanreqs_drul_[LEFT] = 0;
 103           accepted_spanreqs_drul_[RIGHT] = 0;
 104           if (line_spanner_)
 105             line_spanner_->suicide ();
 106           line_spanner_ = 0;
 107           if (cresc_p_)
 108             cresc_p_->suicide ();
 109           cresc_p_ = 0;
 110         }
 111       else if ((s->span_type_str_ == "crescendo"
 112            || s->span_type_str_ == "decrescendo"))
 113         {
 114           accepted_spanreqs_drul_[s->span_dir_] = s;
 115           return true;
 116         }
 117     }
 118   return false;
 119 }
 120
 121 void
 122 Dynamic_engraver::do_process_music ()
 123 {
 124   if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_)
 125
 126     {
 127       if (!line_spanner_)
 128         {
 129           line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
 130
 131           Side_position::set_axis (line_spanner_, Y_AXIS);
 132           Axis_group_interface::set_interface (line_spanner_);
 133           Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
 134
 135           Request * rq = accepted_spanreqs_drul_[START];
 136           if (script_req_l_) rq =  script_req_l_ ;
 137           announce_element (line_spanner_, rq);
 138
 139
 140         }
 141     }
 142
 143   /*
 144     finish side position alignment if the (de)cresc ends here, and
 145     there are no new dynamics.
 146
 147    */
 148   else if (accepted_spanreqs_drul_[STOP]
 149            && !accepted_spanreqs_drul_[START] && !script_req_l_)
 150     {
 151       finished_line_spanner_ = line_spanner_;
 152       line_spanner_ = 0;
 153     }
 154
 155         /*
 156         todo: resurrect  dynamic{direction, padding,minimumspace}
 157         */
 158         /*
 159         During a (de)crescendo, pending request will not be cleared,
 160         and a line-spanner will always be created, as \< \! are already
 161         two requests.
 162
 163         Maybe always creating a line-spanner for a (de)crescendo (see
 164         below) is not a good idea:
 165
 166             a\< b\p \!c
 167
 168         the \p will be centred on the line-spanner, and thus clash
 169         with the hairpin.  When axis-group code is in place, the \p
 170         should move below the hairpin, which is probably better?
 171
 172         Urg, but line-spanner must always have at least same duration
 173         as (de)crecsendo, b.o. line-breaking.
 174         */
 175
 176
 177
 178   /*
 179     maybe we should leave dynamic texts to the text-engraver and
 180     simply acknowledge them?
 181   */
 182   if (script_req_l_)
 183     {
 184       script_p_ = new Item (get_property ("DynamicText"));
 185       script_p_->set_elt_property ("text", script_req_l_->text_);
 186       if (Direction d = script_req_l_->get_direction ())
 187         Directional_element_interface::set (line_spanner_, d);
 188
 189       Axis_group_interface::add_element (line_spanner_, script_p_);
 190
 191       announce_element (script_p_, script_req_l_);
 192     }
 193
 194   if (accepted_spanreqs_drul_[STOP])
 195     {
 196       if (!cresc_p_)
 197         {
 198           accepted_spanreqs_drul_[STOP]->origin ()->warning
 199             (_ ("can't find start of (de)crescendo"));
 200         }
 201       else
 202         {
 203           assert (!finished_cresc_p_);
 204           Score_element* cc = unsmob_element (get_property ("currentMusicalColumn"));
 205
 206           cresc_p_->set_bound (RIGHT, cc);
 207
 208           finished_cresc_p_ = cresc_p_;
 209           cresc_p_ = 0;
 210           current_cresc_req_ = 0;
 211         }
 212     }
 213
 214   if (accepted_spanreqs_drul_[START])
 215     {
 216       if (current_cresc_req_)
 217         {
 218           accepted_spanreqs_drul_[START]->origin ()->warning
 219             (current_cresc_req_->span_dir_ == 1
 220              ? _ ("already have a crescendo")
 221              : _ ("already have a decrescendo"));
 222         }
 223       else
 224         {
 225           current_cresc_req_ = accepted_spanreqs_drul_[START];
 226
 227           /*
 228             TODO: Use symbols.
 229            */
 230           SCM s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Spanner").ch_C());
 231
 232           if (!gh_string_p (s) || ly_scm2string (s) == "hairpin")
 233             {
 234               cresc_p_  = new Spanner (get_property ("Crescendo"));
 235               cresc_p_->set_elt_property ("grow-direction",
 236                                           gh_int2scm ((accepted_spanreqs_drul_[START]->span_type_str_ == "crescendo")
 237                                                       ? BIGGER : SMALLER));
 238
 239             }
 240           /*
 241             This is a convenient (and legacy) interface to TextSpanners
 242             for use in (de)crescendi.
 243             Hmm.
 244            */
 245           else
 246             {
 247               cresc_p_  = new Spanner (get_property ("TextSpanner"));
 248               cresc_p_->set_elt_property ("type", s);
 249               daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
 250                                             + "Spanner", SCM_UNDEFINED);
 251               s = get_property ((accepted_spanreqs_drul_[START]->span_type_str_ + "Text").ch_C());
 252               if (gh_string_p (s))
 253                 {
 254                   cresc_p_->set_elt_property ("edge-text",
 255                                               gh_cons (s, ly_str02scm ("")));
 256                   daddy_trans_l_->set_property (accepted_spanreqs_drul_[START]->span_type_str_
 257                                                 + "Text", SCM_UNDEFINED);
 258                 }
 259             }
 260
 261           Score_element *cc = unsmob_element (get_property ("currentMusicalColumn"));
 262           cresc_p_->set_bound (LEFT, cc);
 263
 264           if (script_p_)
 265             {
 266               Side_position::set_direction (script_p_, LEFT);
 267               Side_position::set_axis (script_p_, X_AXIS);
 268               Side_position::add_support (script_p_, cresc_p_);
 269             }
 270
 271           Axis_group_interface::add_element (line_spanner_, cresc_p_);
 272           announce_element (cresc_p_, accepted_spanreqs_drul_[START]);
 273         }
 274     }
 275 }
 276
 277 void
 278 Dynamic_engraver::do_pre_move_processing ()
 279 {
 280   typeset_all ();
 281 }
 282
 283 void
 284 Dynamic_engraver::do_removal_processing ()
 285 {
 286   typeset_all ();
 287   if (line_spanner_)
 288     {
 289       finished_line_spanner_ = line_spanner_;
 290       typeset_all ();
 291     }
 292
 293   if (cresc_p_)
 294     {
 295       current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
 296       cresc_p_->suicide ();
 297       cresc_p_ = 0;
 298     }
 299 }
 300
 301 void
 302 Dynamic_engraver::typeset_all ()
 303 {
 304   if (finished_cresc_p_)
 305     {
 306       typeset_element (finished_cresc_p_);
 307       finished_cresc_p_ =0;
 308     }
 309
 310   if (script_p_)
 311     {
 312       typeset_element (script_p_);
 313       script_p_ = 0;
 314     }
 315   if (finished_line_spanner_)
 316     {
 317       Side_position::add_staff_support (finished_line_spanner_);
 318       extend_spanner_over_elements (finished_line_spanner_);
 319       typeset_element (finished_line_spanner_);
 320       finished_line_spanner_ = 0;
 321     }
 322 }
 323
 324 void
 325 Dynamic_engraver::acknowledge_element (Score_element_info i)
 326 {
 327   if (Note_column::has_interface (i.elem_l_))
 328     {
 329       if (line_spanner_)
 330         {
 331           Side_position::add_support (line_spanner_,i.elem_l_);
 332           add_bound_item (line_spanner_,dynamic_cast<Item*>(i.elem_l_));
 333         }
 334     }
 335 }