lily/vertical-align-engraver.cc

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