lily/span-arpeggio-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2012 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 /**
  31    Make arpeggios that span multiple staves.  Catch arpeggios, and span a
  32    Span_arpeggio over them if we find more than two arpeggios.
  33 */
  34 class Span_arpeggio_engraver : public Engraver
  35 {
  36 public:
  37   TRANSLATOR_DECLARATIONS (Span_arpeggio_engraver);
  38   DECLARE_ACKNOWLEDGER (arpeggio);
  39   DECLARE_ACKNOWLEDGER (note_column);
  40
  41 protected:
  42   void process_acknowledged ();
  43   void stop_translation_timestep ();
  44
  45 private:
  46   Item *span_arpeggio_;
  47   vector<Grob *> arpeggios_;
  48   vector<Grob *> note_columns_;
  49 };
  50
  51 Span_arpeggio_engraver::Span_arpeggio_engraver ()
  52 {
  53   span_arpeggio_ = 0;
  54 }
  55
  56 void
  57 Span_arpeggio_engraver::acknowledge_arpeggio (Grob_info info)
  58 {
  59   if (info.origin_contexts (this).size ()) // huh? what's this test for?
  60     arpeggios_.push_back (info.grob ());
  61 }
  62
  63 void
  64 Span_arpeggio_engraver::acknowledge_note_column (Grob_info info)
  65 {
  66   note_columns_.push_back (info.grob ());
  67 }
  68
  69 void
  70 Span_arpeggio_engraver::process_acknowledged ()
  71 {
  72   /*
  73     connectArpeggios is slightly brusque; we should really read a grob
  74     property of the caught non-span arpeggios. That way, we can have
  75
  76     both non-connected and connected arps in one pianostaff.
  77
  78   */
  79   if (!span_arpeggio_ && arpeggios_.size () > 1
  80       && to_boolean (get_property ("connectArpeggios")))
  81     {
  82       span_arpeggio_ = make_item ("Arpeggio", SCM_EOL);
  83       span_arpeggio_->set_property ("cross-staff", SCM_BOOL_T);
  84     }
  85   if (span_arpeggio_)
  86     {
  87       for (vsize i = 0; i < note_columns_.size (); i++)
  88         Separation_item::add_conditional_item (note_columns_[i], span_arpeggio_);
  89       note_columns_.clear ();
  90     }
  91 }
  92
  93 void
  94 Span_arpeggio_engraver::stop_translation_timestep ()
  95 {
  96   if (span_arpeggio_)
  97     {
  98       /*
  99         we do this very late, to make sure we also catch `extra'
 100         side-pos support like accidentals.
 101       */
 102       for (vsize j = 0; j < arpeggios_.size (); j++)
 103         {
 104           extract_grob_set (arpeggios_[j], "stems", stems);
 105           for (vsize i = 0; i < stems.size (); i++)
 106             Pointer_group_interface::add_grob (span_arpeggio_, ly_symbol2scm ("stems"),
 107                                                stems[i]);
 108
 109           extract_grob_set (arpeggios_[j], "side-support-elements", sses);
 110           for (vsize i = 0; i < sses.size (); i++)
 111             Pointer_group_interface::add_grob (span_arpeggio_, ly_symbol2scm ("side-support-elements"),
 112                                                sses[i]);
 113
 114           /*
 115             we can't kill the children, since we don't want to the
 116             previous note to bump into the span arpeggio; so we make
 117             it transparent.  */
 118           arpeggios_[j]->set_property ("transparent", SCM_BOOL_T);
 119         }
 120
 121       span_arpeggio_->set_parent (arpeggios_[0]->get_parent (Y_AXIS), Y_AXIS);
 122       span_arpeggio_ = 0;
 123     }
 124   arpeggios_.clear ();
 125   note_columns_.clear ();
 126 }
 127
 128 #include "translator.icc"
 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                );