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 (Context *c)
  75   : Engraver (c)
  76 {
  77   valign_ = 0;
  78   id_to_group_hashtab_ = SCM_EOL;
  79   top_level_ = false;
  80 }
  81
  82 void
  83 Vertical_align_engraver::derived_mark () const
  84 {
  85   scm_gc_mark (id_to_group_hashtab_);
  86 }
  87
  88 void
  89 Vertical_align_engraver::initialize ()
  90 {
  91   id_to_group_hashtab_ = scm_c_make_hash_table (11);
  92 }
  93
  94 void
  95 Vertical_align_engraver::process_music ()
  96 {
  97   if (!valign_ && !scm_is_null (id_to_group_hashtab_))
  98     {
  99       if (to_boolean (get_property ("hasAxisGroup")))
 100         {
 101           warning (_ ("Ignoring Vertical_align_engraver in VerticalAxisGroup"));
 102           id_to_group_hashtab_ = SCM_EOL;
 103           return;
 104         }
 105
 106       top_level_ = to_boolean (get_property ("topLevelAlignment"));
 107
 108       valign_ = make_spanner (top_level_ ? "VerticalAlignment" : "StaffGrouper", SCM_EOL);
 109       valign_->set_bound (LEFT, unsmob<Grob> (get_property ("currentCommandColumn")));
 110       Align_interface::set_ordered (valign_);
 111     }
 112 }
 113
 114 void
 115 Vertical_align_engraver::finalize ()
 116 {
 117   if (valign_)
 118     {
 119       valign_->set_bound (RIGHT, unsmob<Grob> (get_property ("currentCommandColumn")));
 120       valign_ = 0;
 121     }
 122 }
 123
 124 bool
 125 Vertical_align_engraver::qualifies (Grob_info i) const
 126 {
 127   int sz = i.origin_contexts ((Translator *)this).size ();
 128
 129   return sz > 0 && has_interface<Axis_group_interface> (i.grob ())
 130          && !i.grob ()->get_parent (Y_AXIS)
 131          && !to_boolean (i.grob ()->get_property ("no-alignment"))
 132          && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
 133 }
 134
 135 void
 136 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
 137 {
 138   if (scm_is_null (id_to_group_hashtab_))
 139     return;
 140
 141   if (top_level_ && qualifies (i))
 142     {
 143       string id = i.context ()->id_string ();
 144
 145       scm_hash_set_x (id_to_group_hashtab_, ly_string2scm (id),
 146                       i.grob ()->self_scm ());
 147
 148       SCM before_id = i.context ()->get_property ("alignAboveContext");
 149       SCM after_id = i.context ()->get_property ("alignBelowContext");
 150
 151       SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
 152       SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
 153
 154       Grob *before_grob = unsmob<Grob> (before);
 155       Grob *after_grob = unsmob<Grob> (after);
 156
 157       Align_interface::add_element (valign_, i.grob ());
 158
 159       if (before_grob || after_grob)
 160         {
 161           Grob_array *ga = unsmob<Grob_array> (valign_->get_object ("elements"));
 162           vector<Grob *> &arr = ga->array_reference ();
 163
 164           Grob *added = arr.back ();
 165           arr.pop_back ();
 166           for (vsize i = 0; i < arr.size (); i++)
 167             {
 168               if (arr[i] == before_grob)
 169                 {
 170                   arr.insert (arr.begin () + i, added);
 171
 172                   /* Only set staff affinity if it already has one.  That way we won't
 173                      set staff-affinity on things that don't want it (like staves). */
 174                   if (scm_is_number (added->get_property ("staff-affinity")))
 175                     added->set_property ("staff-affinity", scm_from_int (DOWN));
 176                   break;
 177                 }
 178               else if (arr[i] == after_grob)
 179                 {
 180                   arr.insert (arr.begin () + i + 1, added);
 181                   if (scm_is_number (added->get_property ("staff-affinity")))
 182                     added->set_property ("staff-affinity", scm_from_int (UP));
 183                   break;
 184                 }
 185             }
 186         }
 187     }
 188   else if (qualifies (i))
 189     {
 190       Pointer_group_interface::add_grob (valign_, ly_symbol2scm ("elements"), i.grob ());
 191       if (!unsmob<Grob> (i.grob ()->get_object ("staff-grouper")))
 192         i.grob ()->set_object ("staff-grouper", valign_->self_scm ());
 193     }
 194 }