lily/horizontal-bracket-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2002--2011 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 "engraver.hh"
  21 #include "international.hh"
  22 #include "note-column.hh"
  23 #include "pointer-group-interface.hh"
  24 #include "side-position-interface.hh"
  25 #include "stream-event.hh"
  26 #include "spanner.hh"
  27 #include "item.hh"
  28
  29 #include "translator.icc"
  30
  31 class Horizontal_bracket_engraver : public Engraver
  32 {
  33 public:
  34   TRANSLATOR_DECLARATIONS (Horizontal_bracket_engraver);
  35   vector<Spanner*> bracket_stack_;
  36   vector<Stream_event*> events_;
  37   vsize pop_count_;
  38   vsize push_count_;
  39
  40   void stop_translation_timestep ();
  41   void process_music ();
  42   DECLARE_ACKNOWLEDGER (note_column);
  43   DECLARE_TRANSLATOR_LISTENER (note_grouping);
  44 };
  45
  46 ADD_ACKNOWLEDGER (Horizontal_bracket_engraver, note_column);
  47 ADD_TRANSLATOR (Horizontal_bracket_engraver,
  48                 /* doc */
  49                 "Create horizontal brackets over notes for musical analysis"
  50                 " purposes.",
  51
  52                 /* create */
  53                 "HorizontalBracket ",
  54
  55                 /* read */
  56                 "",
  57
  58                 /* write */
  59                 ""
  60                 );
  61
  62 Horizontal_bracket_engraver::Horizontal_bracket_engraver ()
  63 {
  64   pop_count_ = 0;
  65   push_count_ = 0;
  66 }
  67
  68 IMPLEMENT_TRANSLATOR_LISTENER (Horizontal_bracket_engraver, note_grouping);
  69 void
  70 Horizontal_bracket_engraver::listen_note_grouping (Stream_event *ev)
  71 {
  72   Direction d = to_dir (ev->get_property ("span-direction"));
  73
  74   if (d == STOP)
  75     {
  76       pop_count_++;
  77       if (pop_count_ > bracket_stack_.size ())
  78         ev->origin ()->warning (_ ("do not have that many brackets"));
  79     }
  80   else
  81     {
  82       push_count_++;
  83       events_.push_back (ev);
  84     }
  85
  86   if (pop_count_ && push_count_)
  87     ev->origin ()->warning (_ ("conflicting note group events"));
  88 }
  89
  90 void
  91 Horizontal_bracket_engraver::acknowledge_note_column (Grob_info gi)
  92 {
  93   for (vsize i = 0; i < bracket_stack_.size (); i++)
  94     {
  95       Side_position_interface::add_support (bracket_stack_[i], gi.grob ());
  96       Pointer_group_interface::add_grob (bracket_stack_[i],
  97                                          ly_symbol2scm ("columns"), gi.grob ());
  98       add_bound_item (bracket_stack_[i],
  99                       gi.grob ());
 100     }
 101 }
 102
 103 void
 104 Horizontal_bracket_engraver::process_music ()
 105 {
 106   for (vsize k = 0; k < push_count_; k++)
 107     {
 108       Spanner *sp = make_spanner ("HorizontalBracket", events_[k]->self_scm ());
 109
 110       for (vsize i = 0; i < bracket_stack_.size (); i++)
 111         /* sp is the smallest, it should be added to the bigger brackets.  */
 112         Side_position_interface::add_support (bracket_stack_[i], sp);
 113       bracket_stack_.push_back (sp);
 114     }
 115 }
 116
 117 void
 118 Horizontal_bracket_engraver::stop_translation_timestep ()
 119 {
 120   for (int i = pop_count_; i--;)
 121     if (bracket_stack_.size ())
 122       bracket_stack_.pop_back ();
 123   pop_count_ = 0;
 124   push_count_ = 0;
 125 }
 126