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