lily/span-arpeggio-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   5
   6   Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8   LilyPond is free software: you can redistribute it and/or modify
   9   it under the terms of the GNU General Public License as published by
  10   the Free Software Foundation, either version 3 of the License, or
  11   (at your option) any later version.
  12
  13   LilyPond is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "engraver.hh"
  23 #include "arpeggio.hh"
  24 #include "item.hh"
  25 #include "pointer-group-interface.hh"
  26 #include "separation-item.hh"
  27 #include "side-position-interface.hh"
  28 #include "staff-symbol-referencer.hh"
  29
  30 #include "translator.icc"
  31
  32 using std::vector;
  33
  34 /**
  35    Make arpeggios that span multiple staves.  Catch arpeggios, and span a
  36    Span_arpeggio over them if we find more than two arpeggios.
  37 */
  38 class Span_arpeggio_engraver : public Engraver
  39 {
  40 public:
  41   TRANSLATOR_DECLARATIONS (Span_arpeggio_engraver);
  42   DECLARE_ACKNOWLEDGER (arpeggio);
  43   DECLARE_ACKNOWLEDGER (note_column);
  44
  45 protected:
  46   void process_acknowledged ();
  47   void stop_translation_timestep ();
  48
  49 private:
  50   Item *span_arpeggio_;
  51   vector<Grob *> arpeggios_;
  52   vector<Grob *> note_columns_;
  53 };
  54
  55 Span_arpeggio_engraver::Span_arpeggio_engraver ()
  56 {
  57   span_arpeggio_ = 0;
  58 }
  59
  60 void
  61 Span_arpeggio_engraver::acknowledge_arpeggio (Grob_info info)
  62 {
  63   if (info.origin_contexts (this).size ()) // huh? what's this test for?
  64     arpeggios_.push_back (info.grob ());
  65 }
  66
  67 void
  68 Span_arpeggio_engraver::acknowledge_note_column (Grob_info info)
  69 {
  70   note_columns_.push_back (info.grob ());
  71 }
  72
  73 void
  74 Span_arpeggio_engraver::process_acknowledged ()
  75 {
  76   /*
  77     connectArpeggios is slightly brusque; we should really read a grob
  78     property of the caught non-span arpeggios. That way, we can have
  79
  80     both non-connected and connected arps in one pianostaff.
  81
  82   */
  83   if (!span_arpeggio_ && arpeggios_.size () > 1
  84       && to_boolean (get_property ("connectArpeggios")))
  85     span_arpeggio_ = make_item ("Arpeggio", SCM_EOL);
  86
  87   if (span_arpeggio_)
  88     {
  89       for (vsize i = 0; i < note_columns_.size (); i++)
  90         Separation_item::add_conditional_item (note_columns_[i], span_arpeggio_);
  91       note_columns_.clear ();
  92     }
  93 }
  94
  95 void
  96 Span_arpeggio_engraver::stop_translation_timestep ()
  97 {
  98   if (span_arpeggio_)
  99     {
 100       /*
 101         we do this very late, to make sure we also catch `extra'
 102         side-pos support like accidentals.
 103       */
 104       for (vsize j = 0; j < arpeggios_.size (); j++)
 105         {
 106           extract_grob_set (arpeggios_[j], "stems", stems);
 107           for (vsize i = 0; i < stems.size (); i++)
 108             Pointer_group_interface::add_grob (span_arpeggio_, ly_symbol2scm ("stems"),
 109                                                stems[i]);
 110
 111           extract_grob_set (arpeggios_[j], "side-support-elements", sses);
 112           for (vsize i = 0; i < sses.size (); i++)
 113             Pointer_group_interface::add_grob (span_arpeggio_, ly_symbol2scm ("side-support-elements"),
 114                                                sses[i]);
 115
 116           /*
 117             we can't kill the children, since we don't want to the
 118             previous note to bump into the span arpeggio; so we make
 119             it transparent.  */
 120           arpeggios_[j]->set_property ("transparent", SCM_BOOL_T);
 121         }
 122
 123       span_arpeggio_->set_parent (arpeggios_[0]->get_parent (Y_AXIS), Y_AXIS);
 124       span_arpeggio_ = 0;
 125     }
 126   arpeggios_.clear ();
 127   note_columns_.clear ();
 128 }
 129
 130 ADD_ACKNOWLEDGER (Span_arpeggio_engraver, arpeggio);
 131 ADD_ACKNOWLEDGER (Span_arpeggio_engraver, note_column);
 132 ADD_TRANSLATOR (Span_arpeggio_engraver,
 133                 /* doc */
 134                 "Make arpeggios that span multiple staves.",
 135
 136                 /* create */
 137                 "Arpeggio ",
 138
 139                 /* read */
 140                 "connectArpeggios ",
 141
 142                 /* write */
 143                 ""
 144                );