lily/ottava-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2015 Han-Wen Nienhuys
   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 #include "item.hh"
  22 #include "note-column.hh"
  23 #include "protected-scm.hh"
  24 #include "side-position-interface.hh"
  25 #include "spanner.hh"
  26 #include "text-interface.hh"
  27
  28 class Ottava_spanner_engraver : public Engraver
  29 {
  30 public:
  31   TRANSLATOR_DECLARATIONS (Ottava_spanner_engraver);
  32 protected:
  33   virtual void finalize ();
  34
  35   void acknowledge_note_column (Grob_info);
  36
  37   void process_music ();
  38   void stop_translation_timestep ();
  39   virtual void derived_mark () const;
  40 private:
  41   Spanner *span_;
  42   Spanner *finished_;
  43
  44   SCM last_ottavation_;
  45
  46   void typeset_all ();
  47 };
  48
  49 void
  50 Ottava_spanner_engraver::derived_mark () const
  51 {
  52   scm_gc_mark (last_ottavation_);
  53 }
  54
  55 Ottava_spanner_engraver::Ottava_spanner_engraver (Context *c)
  56   : Engraver (c)
  57 {
  58   finished_ = 0;
  59   span_ = 0;
  60   last_ottavation_ = SCM_EOL;
  61 }
  62
  63 void
  64 Ottava_spanner_engraver::process_music ()
  65 {
  66   SCM ott = get_property ("ottavation");
  67   if (!scm_is_eq (ott, last_ottavation_))
  68     {
  69       finished_ = span_;
  70       span_ = 0;
  71       if (Text_interface::is_markup (ott))
  72         {
  73           span_ = make_spanner ("OttavaBracket", SCM_EOL);
  74           span_->set_property ("text", ott);
  75
  76           SCM offset (get_property ("middleCOffset"));
  77           if (robust_scm2double (offset, 0) > 0)
  78             span_->set_property ("direction", scm_from_int (DOWN));
  79         }
  80     }
  81   last_ottavation_ = ott;
  82 }
  83
  84 void
  85 Ottava_spanner_engraver::acknowledge_note_column (Grob_info info)
  86 {
  87   Item *it = info.item ();
  88   if (span_ && it)
  89     {
  90       Side_position_interface::add_support (span_, it);
  91
  92       if (!span_->get_bound (LEFT))
  93         span_->set_bound (LEFT, it);
  94       span_->set_bound (RIGHT, it);
  95     }
  96 }
  97
  98 void
  99 Ottava_spanner_engraver::typeset_all ()
 100 {
 101   if (finished_)
 102     {
 103       for (LEFT_and_RIGHT (d))
 104         {
 105           if (!finished_->get_bound (RIGHT))
 106             {
 107               Grob *e = unsmob<Grob> (get_property ("currentMusicalColumn"));
 108               finished_->set_bound (d, e);
 109             }
 110         }
 111
 112       finished_ = 0;
 113     }
 114 }
 115
 116 void
 117 Ottava_spanner_engraver::stop_translation_timestep ()
 118 {
 119   if (span_ && !span_->get_bound (LEFT))
 120     {
 121       Grob *e = unsmob<Grob> (get_property ("currentMusicalColumn"));
 122       span_->set_bound (LEFT, e);
 123     }
 124
 125   typeset_all ();
 126 }
 127
 128 void
 129 Ottava_spanner_engraver::finalize ()
 130 {
 131   typeset_all ();
 132   if (span_)
 133     finished_ = span_;
 134   typeset_all ();
 135   last_ottavation_ = SCM_EOL;
 136 }
 137
 138 #include "translator.icc"
 139
 140
 141 void
 142 Ottava_spanner_engraver::boot ()
 143 {
 144   ADD_ACKNOWLEDGER (Ottava_spanner_engraver, note_column);
 145 }
 146
 147 ADD_TRANSLATOR (Ottava_spanner_engraver,
 148                 /* doc */
 149                 "Create a text spanner when the ottavation property changes.",
 150
 151                 /* create */
 152                 "OttavaBracket ",
 153
 154                 /* read */
 155                 "middleCOffset "
 156                 "ottavation "
 157                 "currentMusicalColumn ",
 158
 159                 /* write */
 160                 ""
 161                );