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--2005 Han-Wen Nienhuys <hanwen@cs.uu.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     }
  73 }
  74
  75 void
  76 Vertical_align_engraver::finalize ()
  77 {
  78   if (valign_)
  79     {
  80       valign_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
  81       valign_ = 0;
  82     }
  83 }
  84
  85 bool
  86 Vertical_align_engraver::qualifies (Grob_info i) const
  87 {
  88   int sz = i.origin_contexts ((Translator *)this).size ();
  89
  90   return sz > 0 && Axis_group_interface::has_interface (i.grob ())
  91     && !i.grob ()->get_parent (Y_AXIS) && Axis_group_interface::has_axis (i.grob (), Y_AXIS);
  92 }
  93
  94 void
  95 Vertical_align_engraver::acknowledge_axis_group (Grob_info i)
  96 {
  97   if (qualifies (i))
  98     {
  99       String id = i.context ()->id_string ();
 100
 101       scm_hash_set_x (id_to_group_hashtab_, scm_makfrom0str (id.to_str0 ()),
 102                       i.grob ()->self_scm ());
 103
 104       SCM before_id = i.context ()->get_property ("alignAboveContext");
 105       SCM after_id = i.context ()->get_property ("alignBelowContext");
 106
 107       SCM before = scm_hash_ref (id_to_group_hashtab_, before_id, SCM_BOOL_F);
 108       SCM after = scm_hash_ref (id_to_group_hashtab_, after_id, SCM_BOOL_F);
 109
 110       Grob *before_grob = unsmob_grob (before);
 111       Grob *after_grob = unsmob_grob (after);
 112
 113       Align_interface::add_element (valign_, i.grob (),
 114                                     get_property ("verticalAlignmentChildCallback"));
 115
 116       if (before_grob || after_grob)
 117         {
 118           Grob_array *ga = unsmob_grob_array (valign_->get_object ("elements"));
 119           Link_array<Grob> &arr = ga->array_reference ();
 120
 121           Grob *added = arr.pop ();
 122           for (int i = 0; i < arr.size (); i++)
 123             {
 124               if (arr[i] == before_grob)
 125                 {
 126                   arr.insert (added, i);
 127                   break;
 128                 }
 129               else if (arr[i] == after_grob)
 130                 {
 131                   arr.insert (added, i + 1);
 132                   break;
 133                 }
 134             }
 135         }
 136     }
 137 }