lily/ledger-line-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "pointer-group-interface.hh"
  21 #include "spanner.hh"
  22 #include "engraver.hh"
  23 #include "staff-symbol.hh"
  24
  25 #include "translator.icc"
  26
  27 class Ledger_line_engraver : public Engraver
  28 {
  29   Spanner *span_;
  30   vector<Grob *> ledgered_grobs_;
  31
  32 public:
  33   TRANSLATOR_DECLARATIONS (Ledger_line_engraver);
  34
  35 protected:
  36   virtual void finalize ();
  37   void process_music ();
  38
  39   void acknowledge_ledgered (Grob_info);
  40   void acknowledge_staff_symbol (Grob_info);
  41
  42   void start_spanner ();
  43   void stop_spanner ();
  44   void stop_translation_timestep ();
  45 };
  46
  47 Ledger_line_engraver::Ledger_line_engraver ()
  48 {
  49   span_ = 0;
  50 }
  51
  52 void
  53 Ledger_line_engraver::start_spanner ()
  54 {
  55   assert (!span_);
  56
  57   span_ = make_spanner ("LedgerLineSpanner", SCM_EOL);
  58   span_->set_bound (LEFT, unsmob<Grob> (get_property ("currentCommandColumn")));
  59 }
  60
  61 void
  62 Ledger_line_engraver::stop_translation_timestep ()
  63 {
  64   if (span_)
  65     {
  66       for (vsize i = 0; i < ledgered_grobs_.size (); i++)
  67         {
  68           if (!to_boolean (ledgered_grobs_[i]->get_property ("no-ledgers")))
  69             Pointer_group_interface::add_grob (span_,
  70                                                ly_symbol2scm ("note-heads"),
  71                                                ledgered_grobs_[i]);
  72         }
  73     }
  74
  75   ledgered_grobs_.clear ();
  76 }
  77
  78 void
  79 Ledger_line_engraver::process_music ()
  80 {
  81   /*
  82     Need to do this, otherwise the first note might miss ledgers.
  83   */
  84   if (!span_)
  85     start_spanner ();
  86 }
  87
  88 void
  89 Ledger_line_engraver::finalize ()
  90 {
  91   stop_spanner ();
  92 }
  93
  94 void
  95 Ledger_line_engraver::stop_spanner ()
  96 {
  97   if (span_)
  98     {
  99       span_->set_bound (RIGHT, unsmob<Grob> (get_property ("currentCommandColumn")));
 100       span_ = 0;
 101     }
 102 }
 103
 104 void
 105 Ledger_line_engraver::acknowledge_staff_symbol (Grob_info s)
 106 {
 107   Spanner *sym = dynamic_cast<Spanner *> (s.grob ());
 108
 109   if (!span_
 110       || (span_->get_bound (LEFT) != sym->get_bound (LEFT)))
 111     {
 112       stop_spanner ();
 113       start_spanner ();
 114     }
 115 }
 116
 117 void
 118 Ledger_line_engraver::acknowledge_ledgered (Grob_info s)
 119 {
 120   ledgered_grobs_.push_back (s.grob ());
 121 }
 122
 123 void
 124 Ledger_line_engraver::boot ()
 125 {
 126   ADD_ACKNOWLEDGER (Ledger_line_engraver, ledgered);
 127   ADD_ACKNOWLEDGER (Ledger_line_engraver, staff_symbol);
 128 }
 129
 130 ADD_TRANSLATOR (Ledger_line_engraver,
 131                 /* doc */
 132                 "Create the spanner to draw ledger lines, and notices"
 133                 " objects that need ledger lines.",
 134
 135                 /* create */
 136                 "LedgerLineSpanner ",
 137
 138                 /* read */
 139                 "",
 140
 141                 /* write */
 142                 ""
 143                );