lily/vertical-align-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2012 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 "context.hh"
  21 #include "paper-column.hh"
  22 #include "align-interface.hh"
  23 #include "axis-group-interface.hh"
  24 #include "engraver.hh"
  25 #include "spanner.hh"
  26 #include "pointer-group-interface.hh"
  27 #include "grob-array.hh"
  28
  29 #include "translator.icc"
  30
  31 class Vertical_align_engraver : public Engraver
  32 {
  33   Spanner *valign_;
  34   bool qualifies (Grob_info) const;
  35   SCM id_to_group_hashtab_;
  36
  37 public:
  38   TRANSLATOR_DECLARATIONS (Vertical_align_engraver);
  39   DECLARE_ACKNOWLEDGER (axis_group);
  40
  41 protected:
  42   virtual void derived_mark () const;
  43   void process_music ();
  44   virtual void finalize ();
  45   virtual void initialize ();
  46
  47   bool top_level_;
  48 };
  49
  50 ADD_ACKNOWLEDGER (Vertical_align_engraver, axis_group);
  51 ADD_TRANSLATOR (Vertical_align_engraver,
  52                 /* doc */
  53                 "Catch groups (staves, lyrics lines, etc.) and stack them"
  54                 " vertically.",
  55
  56                 /* create */
  57                 "VerticalAlignment ",
  58
  59                 /* read */
  60                 "alignAboveContext "
  61                 "alignBelowContext ",
  62
  63                 /* write */
  64                 ""
  65                );
  66
  67 Vertical_align_engraver::Vertical_align_engraver ()
  68 {
  69   valign_ = 0;
  70   id_to_group_hashtab_ = SCM_EOL;
  71   top_level_ = false;
  72 }
  73
  74 void
  75 Vertical_align_engraver::derived_mark () const
  76 {
  77   scm_gc_mark (id_to_group_hashtab_);
  78 }
  79
  80 void
  81 Vertical_align_engraver::initialize ()
  82 {
  83   id_to_group_hashtab_ = scm_c_make_hash_table (11);
  84 }
  85
  86 void
  87 Vertical_align_engraver::process_music ()
  88 {
  89   if (!valign_)
  90     {
  91       top_level_ = to_boolean (get_property ("topLevelAlignment"));
  92
  93       valign_ = make_spanner (top_level_ ? "VerticalAlignment" : "StaffGrouper", SCM_EOL);
  94       valign_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
  95       Align_interface::set_ordered (valign_);
  96     }
  97 }
  98
  99 void
 100 Vertical_align_engraver::finalize ()
 101 {
 102   if (valign_)
 103     {
 104       valign_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
 105       valign_ = 0;
 106     }
 107 }
 108
 109 bool
 110 Vertical_align_engraver::qualifies (Grob_info i) const
 111 {
 112   int sz = i.origin_contexts ((Translator *)this).size ();
 113
 114   return sz > 0 && Axis_group_interface::has_interface (i.grob ())
 115          && !i.grob ()->get_parent (Y_AXIS)
 116          && !to_boolean (i.grob ()->get_property ("no-alignment"))
 117          && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
 118 }
 119
 120 void
 121 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
 122 {
 123   if (top_level_ && qualifies (i))
 124     {
 125       string id = i.context ()->id_string ();
 126
 127       scm_hash_set_x (id_to_group_hashtab_, ly_string2scm (id),
 128                       i.grob ()->self_scm ());
 129
 130       SCM before_id = i.context ()->get_property ("alignAboveContext");
 131       SCM after_id = i.context ()->get_property ("alignBelowContext");
 132
 133       SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
 134       SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
 135
 136       Grob *before_grob = unsmob_grob (before);
 137       Grob *after_grob = unsmob_grob (after);
 138
 139       Align_interface::add_element (valign_, i.grob ());
 140
 141       if (before_grob || after_grob)
 142         {
 143           Grob_array *ga = unsmob_grob_array (valign_->get_object ("elements"));
 144           vector<Grob *> &arr = ga->array_reference ();
 145
 146           Grob *added = arr.back ();
 147           arr.pop_back ();
 148           for (vsize i = 0; i < arr.size (); i++)
 149             {
 150               if (arr[i] == before_grob)
 151                 {
 152                   arr.insert (arr.begin () + i, added);
 153
 154                   /* Only set staff affinity if it already has one.  That way we won't
 155                      set staff-affinity on things that don't want it (like staves). */
 156                   if (scm_is_number (added->get_property ("staff-affinity")))
 157                     added->set_property ("staff-affinity", scm_from_int (DOWN));
 158                   break;
 159                 }
 160               else if (arr[i] == after_grob)
 161                 {
 162                   arr.insert (arr.begin () + i + 1, added);
 163                   if (scm_is_number (added->get_property ("staff-affinity")))
 164                     added->set_property ("staff-affinity", scm_from_int (UP));
 165                   break;
 166                 }
 167             }
 168         }
 169     }
 170   else if (qualifies (i))
 171     {
 172       Pointer_group_interface::add_grob (valign_, ly_symbol2scm ("elements"), i.grob ());
 173       if (!unsmob_grob (i.grob ()->get_object ("staff-grouper")))
 174         i.grob ()->set_object ("staff-grouper", valign_->self_scm ());
 175     }
 176 }