/*
- vertical-align-grav.cc -- implement Vertical_align_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "translator-group.hh"
-#include "axis-group-engraver.hh"
-#include "p-col.hh"
-#include "vertical-align-engraver.hh"
-#include "axis-align-spanner.hh"
-#include "axis-group-spanner.hh"
-
-Vertical_align_engraver::Vertical_align_engraver()
+
+#include "context.hh"
+#include "paper-column.hh"
+#include "align-interface.hh"
+#include "axis-group-interface.hh"
+#include "engraver.hh"
+#include "international.hh"
+#include "spanner.hh"
+#include "pointer-group-interface.hh"
+#include "grob-array.hh"
+
+#include "translator.icc"
+
+class Vertical_align_engraver : public Engraver
+{
+ Spanner *valign_;
+ bool qualifies (Grob_info) const;
+ SCM id_to_group_hashtab_;
+
+public:
+ TRANSLATOR_DECLARATIONS (Vertical_align_engraver);
+ void acknowledge_axis_group (Grob_info);
+
+protected:
+ virtual void derived_mark () const;
+ void process_music ();
+ virtual void finalize ();
+ virtual void initialize ();
+
+ bool top_level_;
+};
+
+void
+Vertical_align_engraver::boot ()
+{
+ ADD_ACKNOWLEDGER (Vertical_align_engraver, axis_group);
+}
+
+ADD_TRANSLATOR (Vertical_align_engraver,
+ /* doc */
+ "Catch groups (staves, lyrics lines, etc.) and stack them"
+ " vertically.",
+
+ /* create */
+ "VerticalAlignment ",
+
+ /* read */
+ "alignAboveContext "
+ "alignBelowContext "
+ "hasAxisGroup ",
+
+ /* write */
+ ""
+ );
+
+Vertical_align_engraver::Vertical_align_engraver (Context *c)
+ : Engraver (c)
{
- valign_p_ =0;
+ valign_ = 0;
+ id_to_group_hashtab_ = SCM_EOL;
+ top_level_ = false;
}
void
-Vertical_align_engraver::do_creation_processing()
+Vertical_align_engraver::derived_mark () const
{
- valign_p_ =new Axis_align_spanner;
- valign_p_->set_axis (Y_AXIS);
- valign_p_->stacking_dir_ = DOWN;
-
- valign_p_->set_bounds(LEFT,get_staff_info().command_pcol_l ());
- announce_element (Score_element_info (valign_p_ , 0));
+ scm_gc_mark (id_to_group_hashtab_);
}
void
-Vertical_align_engraver::do_removal_processing()
+Vertical_align_engraver::initialize ()
{
- Scalar dist (get_property ("maxVerticalAlign", 0));
- if (dist.length_i () && dist.isnum_b ())
- {
- valign_p_->threshold_interval_[BIGGER] = Real (dist);
- }
+ id_to_group_hashtab_ = scm_c_make_hash_table (11);
+}
- dist = get_property ("minVerticalAlign", 0);
- if (dist.length_i () && dist.isnum_b ())
+void
+Vertical_align_engraver::process_music ()
+{
+ if (!valign_ && !scm_is_null (id_to_group_hashtab_))
{
- valign_p_->threshold_interval_[SMALLER] = Real (dist);
+ if (to_boolean (get_property ("hasAxisGroup")))
+ {
+ warning (_ ("Ignoring Vertical_align_engraver in VerticalAxisGroup"));
+ id_to_group_hashtab_ = SCM_EOL;
+ return;
+ }
+
+ top_level_ = to_boolean (get_property ("topLevelAlignment"));
+
+ valign_ = make_spanner (top_level_ ? "VerticalAlignment" : "StaffGrouper", SCM_EOL);
+ valign_->set_bound (LEFT, unsmob<Grob> (get_property ("currentCommandColumn")));
+ Align_interface::set_ordered (valign_);
}
+}
- dist = get_property ("alignmentReference",0);
- if (dist.length_i () && dist.isnum_b ())
+void
+Vertical_align_engraver::finalize ()
+{
+ if (valign_)
{
- valign_p_->align_dir_ = int (dist);
+ valign_->set_bound (RIGHT, unsmob<Grob> (get_property ("currentCommandColumn")));
+ valign_ = 0;
}
- valign_p_->set_bounds(RIGHT,get_staff_info().command_pcol_l ());
- typeset_element (valign_p_);
- valign_p_ =0;
}
-
bool
-Vertical_align_engraver::qualifies_b (Score_element_info i) const
+Vertical_align_engraver::qualifies (Grob_info i) const
{
- Translator * t = i.origin_grav_l_arr_[0];
- int sz = i.origin_grav_l_arr_.size() ;
+ int sz = i.origin_contexts ((Translator *)this).size ();
- return (sz == 1 && dynamic_cast<Translator_group*> (t))
- || (sz == 2 && dynamic_cast<Axis_group_engraver*> (t));
+ return sz > 0 && has_interface<Axis_group_interface> (i.grob ())
+ && !i.grob ()->get_parent (Y_AXIS)
+ && !to_boolean (i.grob ()->get_property ("no-alignment"))
+ && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
}
void
-Vertical_align_engraver::acknowledge_element (Score_element_info i)
+Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
{
- if (qualifies_b (i))
+ if (scm_is_null (id_to_group_hashtab_))
+ return;
+
+ if (top_level_ && qualifies (i))
{
- valign_p_->add_element (i.elem_l_);
- }
-}
+ string id = i.context ()->id_string ();
+
+ scm_hash_set_x (id_to_group_hashtab_, ly_string2scm (id),
+ i.grob ()->self_scm ());
+
+ SCM before_id = i.context ()->get_property ("alignAboveContext");
+ SCM after_id = i.context ()->get_property ("alignBelowContext");
+
+ SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
+ SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
+
+ Grob *before_grob = unsmob<Grob> (before);
+ Grob *after_grob = unsmob<Grob> (after);
+ Align_interface::add_element (valign_, i.grob ());
+ if (before_grob || after_grob)
+ {
+ Grob_array *ga = unsmob<Grob_array> (valign_->get_object ("elements"));
+ vector<Grob *> &arr = ga->array_reference ();
-ADD_THIS_TRANSLATOR(Vertical_align_engraver);
+ Grob *added = arr.back ();
+ arr.pop_back ();
+ for (vsize i = 0; i < arr.size (); i++)
+ {
+ if (arr[i] == before_grob)
+ {
+ arr.insert (arr.begin () + i, added);
+
+ /* Only set staff affinity if it already has one. That way we won't
+ set staff-affinity on things that don't want it (like staves). */
+ if (scm_is_number (added->get_property ("staff-affinity")))
+ added->set_property ("staff-affinity", scm_from_int (DOWN));
+ break;
+ }
+ else if (arr[i] == after_grob)
+ {
+ arr.insert (arr.begin () + i + 1, added);
+ if (scm_is_number (added->get_property ("staff-affinity")))
+ added->set_property ("staff-affinity", scm_from_int (UP));
+ break;
+ }
+ }
+ }
+ }
+ else if (qualifies (i))
+ {
+ Pointer_group_interface::add_grob (valign_, ly_symbol2scm ("elements"), i.grob ());
+ if (!unsmob<Grob> (i.grob ()->get_object ("staff-grouper")))
+ i.grob ()->set_object ("staff-grouper", valign_->self_scm ());
+ }
+}