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--2006 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 (staffs, lyrics lines, etc.) and stack "
  41                 "them vertically.",
  42                 /* create */ "VerticalAlignment",
  43                 /* accept */ "",
  44                 /* read */ "",
  45                 /* write */ "");
  46
  47 Vertical_align_engraver::Vertical_align_engraver ()
  48 {
  49   valign_ = 0;
  50   id_to_group_hashtab_ = SCM_EOL;
  51 }
  52
  53 void
  54 Vertical_align_engraver::derived_mark () const
  55 {
  56   scm_gc_mark (id_to_group_hashtab_);
  57 }
  58
  59 void
  60 Vertical_align_engraver::initialize ()
  61 {
  62   id_to_group_hashtab_ = scm_c_make_hash_table (11);
  63 }
  64
  65 void
  66 Vertical_align_engraver::process_music ()
  67 {
  68   if (!valign_)
  69     {
  70       valign_ = make_spanner ("VerticalAlignment", SCM_EOL);
  71       valign_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
  72       Align_interface::set_ordered (valign_);
  73     }
  74 }
  75
  76 void
  77 Vertical_align_engraver::finalize ()
  78 {
  79   if (valign_)
  80     {
  81       valign_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
  82       valign_ = 0;
  83     }
  84 }
  85
  86 bool
  87 Vertical_align_engraver::qualifies (Grob_info i) const
  88 {
  89   int sz = i.origin_contexts ((Translator *)this).size ();
  90
  91   return sz > 0 && Axis_group_interface::has_interface (i.grob ())
  92     && !i.grob ()->get_parent (Y_AXIS)
  93     && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
  94 }
  95
  96 void
  97 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
  98 {
  99   if (qualifies (i))
 100     {
 101       string id = i.context ()->id_string ();
 102
 103       scm_hash_set_x (id_to_group_hashtab_, scm_makfrom0str (id.c_str ()),
 104                       i.grob ()->self_scm ());
 105
 106       SCM before_id = i.context ()->get_property ("alignAboveContext");
 107       SCM after_id = i.context ()->get_property ("alignBelowContext");
 108
 109       SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
 110       SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
 111
 112       Grob *before_grob = unsmob_grob (before);
 113       Grob *after_grob = unsmob_grob (after);
 114
 115       Align_interface::add_element (valign_, i.grob ());
 116
 117       if (before_grob || after_grob)
 118         {
 119           Grob_array *ga = unsmob_grob_array (valign_->get_object ("elements"));
 120           vector<Grob*> &arr = ga->array_reference ();
 121
 122           Grob *added = arr.back ();
 123           arr.pop_back ();
 124           for (vsize i = 0; i < arr.size (); i++)
 125             {
 126               if (arr[i] == before_grob)
 127                 {
 128                   arr.insert (arr.begin () + i, added);
 129                   break;
 130                 }
 131               else if (arr[i] == after_grob)
 132                 {
 133                   arr.insert (arr.begin () + i + 1, added);
 134                   break;
 135                 }
 136             }
 137         }
 138     }
 139 }