lily/dynamic-align-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2008--2015 Han-Wen Nienhuys <hanwen@lilypond.org>
   5
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include <set>
  22
  23 #include "engraver.hh"
  24
  25 #include "axis-group-interface.hh"
  26 #include "directional-element-interface.hh"
  27 #include "item.hh"
  28 #include "side-position-interface.hh"
  29 #include "spanner.hh"
  30 #include "stream-event.hh"
  31
  32 #include "translator.icc"
  33
  34 class Dynamic_align_engraver : public Engraver
  35 {
  36   TRANSLATOR_DECLARATIONS (Dynamic_align_engraver);
  37   void acknowledge_rhythmic_head (Grob_info);
  38   void acknowledge_stem (Grob_info);
  39   void acknowledge_dynamic (Grob_info);
  40   void acknowledge_footnote_spanner (Grob_info);
  41   void acknowledge_end_dynamic (Grob_info);
  42
  43 protected:
  44   virtual void stop_translation_timestep ();
  45
  46 private:
  47   void create_line_spanner (Grob *cause);
  48   void set_spanner_bounds (Spanner *line, bool end);
  49   Spanner *line_;
  50   Spanner *ended_line_; // Spanner manually broken, don't use it for new grobs
  51   Spanner *current_dynamic_spanner_;
  52   vector<Spanner *> ended_;
  53   vector<Spanner *> started_;
  54   vector<Grob *> scripts_;
  55   vector<Grob *> support_;
  56
  57   set<Spanner *> running_;
  58 };
  59
  60 Dynamic_align_engraver::Dynamic_align_engraver ()
  61 {
  62   line_ = 0;
  63   ended_line_ = 0;
  64   current_dynamic_spanner_ = 0;
  65 }
  66
  67
  68 void
  69 Dynamic_align_engraver::create_line_spanner (Grob *cause)
  70 {
  71   if (!line_)
  72     line_ = make_spanner ("DynamicLineSpanner", cause->self_scm ());
  73 }
  74
  75 void
  76 Dynamic_align_engraver::acknowledge_end_dynamic (Grob_info info)
  77 {
  78   if (has_interface<Spanner> (info.grob ()))
  79     ended_.push_back (info.spanner ());
  80
  81   /* If the break flag is set, store the current spanner and let new dynamics
  82    * create a new spanner
  83    */
  84   bool spanner_broken = current_dynamic_spanner_ == info.spanner ()
  85                         && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
  86   if (spanner_broken && line_)
  87     {
  88       if (ended_line_)
  89         programming_error ("already have a force-ended DynamicLineSpanner.");
  90       ended_line_ = line_;
  91       line_ = 0;
  92       current_dynamic_spanner_ = 0;
  93     }
  94 }
  95
  96 void
  97 Dynamic_align_engraver::acknowledge_footnote_spanner (Grob_info info)
  98 {
  99   Grob *parent = info.grob ()->get_parent (Y_AXIS);
 100   if (line_ && parent
 101       && parent->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
 102     Axis_group_interface::add_element (line_, info.grob ());
 103 }
 104
 105 void
 106 Dynamic_align_engraver::acknowledge_rhythmic_head (Grob_info info)
 107 {
 108   support_.push_back (info.grob ());
 109 }
 110
 111 void
 112 Dynamic_align_engraver::acknowledge_stem (Grob_info info)
 113 {
 114   support_.push_back (info.grob ());
 115 }
 116
 117 void
 118 Dynamic_align_engraver::acknowledge_dynamic (Grob_info info)
 119 {
 120   Stream_event *cause = info.event_cause ();
 121   // Check whether an existing line spanner has the same direction
 122   if (line_ && cause)
 123     {
 124       Direction line_dir = get_grob_direction (line_);
 125       Direction grob_dir = to_dir (cause->get_property ("direction"));
 126
 127       // If we have an explicit direction for the new dynamic grob
 128       // that differs from the current line spanner, break the spanner
 129       if (grob_dir && (line_dir != grob_dir))
 130         {
 131           if (!ended_line_)
 132             ended_line_ = line_;
 133           line_ = 0;
 134           current_dynamic_spanner_ = 0;
 135         }
 136     }
 137
 138   create_line_spanner (info.grob ());
 139   if (has_interface<Spanner> (info.grob ()))
 140     {
 141       started_.push_back (info.spanner ());
 142       current_dynamic_spanner_ = info.spanner ();
 143     }
 144   else if (info.item ())
 145     scripts_.push_back (info.item ());
 146   else
 147     info.grob ()->programming_error ("unknown dynamic grob");
 148
 149   Axis_group_interface::add_element (line_, info.grob ());
 150
 151   if (cause)
 152     {
 153       if (Direction d = to_dir (cause->get_property ("direction")))
 154         set_grob_direction (line_, d);
 155     }
 156 }
 157
 158 void
 159 Dynamic_align_engraver::set_spanner_bounds (Spanner *line, bool end)
 160 {
 161   if (!line)
 162     return;
 163
 164   for (LEFT_and_RIGHT (d))
 165     {
 166       if ((d == LEFT && !line->get_bound (LEFT))
 167           || (end && d == RIGHT && !line->get_bound (RIGHT)))
 168         {
 169           vector<Spanner *> const &spanners
 170             = (d == LEFT) ? started_ : ended_;
 171
 172           Grob *bound = 0;
 173           if (scripts_.size ())
 174             bound = scripts_[0];
 175           else if (spanners.size ())
 176             bound = spanners[0]->get_bound (d);
 177           else
 178             {
 179               bound = unsmob<Grob> (get_property ("currentMusicalColumn"));
 180               programming_error ("started DynamicLineSpanner but have no left bound");
 181             }
 182
 183           line->set_bound (d, bound);
 184         }
 185     }
 186 }
 187
 188 void
 189 Dynamic_align_engraver::stop_translation_timestep ()
 190 {
 191   for (vsize i = 0; i < started_.size (); i++)
 192     running_.insert (started_[i]);
 193   for (vsize i = 0; i < ended_.size (); i++)
 194     {
 195       Spanner *sp = ended_[i];
 196
 197       set<Spanner *>::iterator it = running_.find (sp);
 198       if (it != running_.end ())
 199         running_.erase (it);
 200       else
 201         started_[i]->programming_error ("lost track of this dynamic spanner");
 202     }
 203
 204   bool end = line_ && running_.empty ();
 205
 206   // Set the proper bounds for the current spanner and for a spanner that
 207   // is ended now
 208   set_spanner_bounds (ended_line_, true);
 209   set_spanner_bounds (line_, end);
 210   // If the flag is set to break the spanner after the current child, don't
 211   // add any more support points (needed e.g. for style=none, where the
 212   // invisible spanner should NOT be shifted since we don't have a line).
 213   bool spanner_broken = current_dynamic_spanner_
 214                         && to_boolean (current_dynamic_spanner_->get_property ("spanner-broken"));
 215   for (vsize i = 0; line_ && !spanner_broken && i < support_.size (); i++)
 216     Side_position_interface::add_support (line_, support_[i]);
 217
 218   if (end)
 219     {
 220       line_ = 0;
 221     }
 222
 223   ended_line_ = 0;
 224   ended_.clear ();
 225   started_.clear ();
 226   scripts_.clear ();
 227   support_.clear ();
 228 }
 229
 230 void
 231 Dynamic_align_engraver::boot ()
 232 {
 233   ADD_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
 234   ADD_ACKNOWLEDGER (Dynamic_align_engraver, rhythmic_head);
 235   ADD_ACKNOWLEDGER (Dynamic_align_engraver, stem);
 236   ADD_ACKNOWLEDGER (Dynamic_align_engraver, footnote_spanner);
 237   ADD_END_ACKNOWLEDGER (Dynamic_align_engraver, dynamic);
 238 }
 239
 240 ADD_TRANSLATOR (Dynamic_align_engraver,
 241                 /* doc */
 242                 "Align hairpins and dynamic texts on a horizontal line.",
 243
 244                 /* create */
 245                 "DynamicLineSpanner ",
 246
 247                 /* read */
 248                 "currentMusicalColumn ",
 249
 250                 /* write */
 251                 ""
 252                );