lily/vertical-align-engraver.cc

   1 /*
   2   vertical-align-engraver.cc -- implement Vertical_align_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "context.hh"
  10 #include "paper-column.hh"
  11 #include "align-interface.hh"
  12 #include "span-bar.hh"
  13 #include "axis-group-interface.hh"
  14 #include "engraver.hh"
  15 #include "spanner.hh"
  16 #include "pointer-group-interface.hh"
  17 #include "grob-array.hh"
  18
  19 #include "translator.icc"
  20
  21 class Vertical_align_engraver : public Engraver
  22 {
  23   Spanner *valign_;
  24   bool qualifies (Grob_info) const;
  25   SCM id_to_group_hashtab_;
  26
  27 public:
  28   TRANSLATOR_DECLARATIONS (Vertical_align_engraver);
  29   DECLARE_ACKNOWLEDGER (axis_group);
  30
  31 protected:
  32   virtual void derived_mark () const;
  33   void process_music ();
  34   virtual void finalize ();
  35   virtual void initialize ();
  36 };
  37
  38 ADD_ACKNOWLEDGER (Vertical_align_engraver, axis_group);
  39 ADD_TRANSLATOR (Vertical_align_engraver,
  40                 "Catch groups (staves, lyrics lines, etc.) and stack "
  41                 "them vertically.",
  42                 /* create */ "VerticalAlignment",
  43                 /* read */
  44                 "alignAboveContext "
  45                 "alignBelowContext ",
  46
  47                 /* write */ "");
  48
  49 Vertical_align_engraver::Vertical_align_engraver ()
  50 {
  51   valign_ = 0;
  52   id_to_group_hashtab_ = SCM_EOL;
  53 }
  54
  55 void
  56 Vertical_align_engraver::derived_mark () const
  57 {
  58   scm_gc_mark (id_to_group_hashtab_);
  59 }
  60
  61 void
  62 Vertical_align_engraver::initialize ()
  63 {
  64   id_to_group_hashtab_ = scm_c_make_hash_table (11);
  65 }
  66
  67 void
  68 Vertical_align_engraver::process_music ()
  69 {
  70   if (!valign_)
  71     {
  72       valign_ = make_spanner ("VerticalAlignment", SCM_EOL);
  73       valign_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
  74       Align_interface::set_ordered (valign_);
  75     }
  76 }
  77
  78 void
  79 Vertical_align_engraver::finalize ()
  80 {
  81   if (valign_)
  82     {
  83       valign_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
  84       valign_ = 0;
  85     }
  86 }
  87
  88 bool
  89 Vertical_align_engraver::qualifies (Grob_info i) const
  90 {
  91   int sz = i.origin_contexts ((Translator *)this).size ();
  92
  93   return sz > 0 && Axis_group_interface::has_interface (i.grob ())
  94     && !i.grob ()->get_parent (Y_AXIS)
  95     && !to_boolean (i.grob ()->get_property ("no-alignment"))
  96     && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
  97 }
  98
  99 void
 100 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
 101 {
 102   if (qualifies (i))
 103     {
 104       string id = i.context ()->id_string ();
 105
 106       scm_hash_set_x (id_to_group_hashtab_, ly_string2scm (id),
 107                       i.grob ()->self_scm ());
 108
 109       SCM before_id = i.context ()->get_property ("alignAboveContext");
 110       SCM after_id = i.context ()->get_property ("alignBelowContext");
 111
 112       SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
 113       SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
 114
 115       Grob *before_grob = unsmob_grob (before);
 116       Grob *after_grob = unsmob_grob (after);
 117
 118       Align_interface::add_element (valign_, i.grob ());
 119
 120       if (before_grob || after_grob)
 121         {
 122           Grob_array *ga = unsmob_grob_array (valign_->get_object ("elements"));
 123           vector<Grob*> &arr = ga->array_reference ();
 124
 125           Grob *added = arr.back ();
 126           arr.pop_back ();
 127           for (vsize i = 0; i < arr.size (); i++)
 128             {
 129               if (arr[i] == before_grob)
 130                 {
 131                   arr.insert (arr.begin () + i, added);
 132                   break;
 133                 }
 134               else if (arr[i] == after_grob)
 135                 {
 136                   arr.insert (arr.begin () + i + 1, added);
 137                   break;
 138                 }
 139             }
 140         }
 141     }
 142 }