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