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                 /* creats*/ "VerticalAlignment",
  43                 /* accepts */ "",
  44                 /* reads */ "",
  45                 /* write */ "");
  46
  47
  48 Vertical_align_engraver::Vertical_align_engraver ()
  49 {
  50   valign_ = 0;
  51   id_to_group_hashtab_ = SCM_EOL;
  52 }
  53
  54 void
  55 Vertical_align_engraver::derived_mark () const
  56 {
  57   scm_gc_mark (id_to_group_hashtab_);
  58 }
  59
  60 void
  61 Vertical_align_engraver::initialize ()
  62 {
  63   id_to_group_hashtab_ = scm_c_make_hash_table (11);
  64 }
  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     }
  75 }
  76
  77 void
  78 Vertical_align_engraver::finalize ()
  79 {
  80   if (valign_)
  81     {
  82       valign_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
  83       valign_ = 0;
  84     }
  85 }
  86
  87 bool
  88 Vertical_align_engraver::qualifies (Grob_info i) const
  89 {
  90   int sz = i.origin_contexts ((Translator *)this).size ();
  91
  92   return sz > 0 && Axis_group_interface::has_interface (i.grob ())
  93     && !i.grob ()->get_parent (Y_AXIS) && 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.to_str0 ()),
 104                       i.grob ()->self_scm ());
 105
 106
 107       SCM before_id = i.context ()->get_property ("alignAboveContext");
 108       SCM after_id = i.context ()->get_property ("alignBelowContext");
 109
 110       SCM before = scm_hash_ref (id_to_group_hashtab_,  before_id, SCM_BOOL_F);
 111       SCM after = scm_hash_ref (id_to_group_hashtab_,  after_id, SCM_BOOL_F);
 112
 113       Grob * before_grob = unsmob_grob (before);
 114       Grob * after_grob = unsmob_grob (after);
 115
 116       Align_interface::add_element (valign_, i.grob (),
 117                                     get_property ("verticalAlignmentChildCallback"));
 118
 119       if (before_grob || after_grob)
 120         {
 121           Grob_array * ga = unsmob_grob_array (valign_->get_object ("elements"));
 122           Link_array<Grob> &arr = ga->array_reference ();
 123
 124           Grob *added = arr.pop();
 125           for (int i = 0 ; i < arr.size (); i++)
 126             {
 127               if (arr[i] == before_grob)
 128                 {
 129                   arr.insert (added, i);
 130                   break ;
 131                 }
 132               else if (arr[i] == after_grob)
 133                 {
 134                   arr.insert (added, i + 1);
 135                   break ;
 136                 }
 137             }
 138         }
 139     }
 140 }