lily/break-align-engraver.cc

   1 /*
   2   break-align-engraver.cc --  implement Break_align_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9 #include "engraver.hh"
  10 #include "protected-scm.hh"
  11 #include "break-align-item.hh"
  12 #include "item.hh"
  13 #include "align-interface.hh"
  14 #include "axis-group-interface.hh"
  15
  16
  17 class Break_align_engraver : public Engraver
  18 {
  19   Item *align_l_;
  20   Protected_scm column_alist_;
  21 protected:
  22   virtual void finalize ();
  23   virtual void acknowledge_grob (Grob_info i);
  24   virtual void stop_translation_timestep ();
  25   void add_column (SCM);
  26
  27 public:
  28   TRANSLATOR_DECLARATIONS(Break_align_engraver);
  29 };
  30
  31
  32
  33
  34
  35 void
  36 Break_align_engraver::add_column (SCM smob)
  37 {
  38   Grob * e = unsmob_grob (smob);
  39   Break_align_interface::add_element (align_l_,e);
  40   typeset_grob (e);
  41 }
  42
  43 void
  44 Break_align_engraver::finalize ()
  45 {
  46   column_alist_ = SCM_EOL;
  47 }
  48
  49 void
  50 Break_align_engraver::stop_translation_timestep ()
  51 {
  52   SCM order = get_property ("breakAlignOrder");
  53   for (; gh_pair_p (order); order = ly_cdr (order))
  54     {
  55       SCM p = scm_assoc (ly_car (order), column_alist_);
  56       if (gh_pair_p (p))
  57         {
  58           add_column (ly_cdr (p));
  59           column_alist_ = scm_assoc_remove_x (column_alist_, ly_car (order));
  60         }
  61     }
  62
  63   for (SCM p = column_alist_; gh_pair_p (p); p = ly_cdr (p))
  64     {
  65       SCM pair = ly_car (p);
  66       add_column (ly_cdr (pair));
  67     }
  68
  69
  70   column_alist_ = SCM_EOL;
  71
  72   if (align_l_)
  73     {
  74       typeset_grob (align_l_);
  75       align_l_ = 0;
  76     }
  77 }
  78
  79
  80 Break_align_engraver::Break_align_engraver ()
  81 {
  82   column_alist_ = SCM_EOL;
  83   align_l_ =0;
  84 }
  85
  86 void
  87 Break_align_engraver::acknowledge_grob (Grob_info inf)
  88 {
  89   if (Item * item_l = dynamic_cast <Item *> (inf.grob_l_))
  90     {
  91       if (item_l->empty_b (X_AXIS) || item_l->parent_l (X_AXIS))
  92         return;
  93
  94       SCM bp=item_l->get_grob_property ("breakable");
  95       bool breakable = (to_boolean (bp));
  96       if (!breakable)
  97         return ;
  98
  99       SCM align_name = item_l->get_grob_property ("break-align-symbol");
 100       if (!gh_symbol_p (align_name))
 101         return ;
 102
 103       if (!align_l_)
 104         {
 105           align_l_ = new Item (get_property ("BreakAlignment"));
 106           Break_align_interface::set_interface (align_l_);
 107           announce_grob (align_l_,0);
 108
 109           SCM edge_sym = ly_symbol2scm ("Left_edge_item");
 110           Item * edge = new Item (get_property ("LeftEdge"));
 111
 112
 113
 114           /*
 115             If the element is empty, it will be ignored in the break
 116             alignment stuff.
 117
 118             TODO: switch off ignoring empty stuff?
 119           */
 120           edge->set_extent_callback (Grob::point_dimension_callback_proc, X_AXIS);
 121
 122           /*
 123             We must have left-edge in the middle.  Instrument-names
 124             are left to left-edge, so they don't enter the staff.
 125           */
 126           align_l_->set_grob_property ("self-alignment-X", edge->self_scm ());
 127
 128           announce_grob (edge, 0);
 129           column_alist_ = scm_assoc_set_x (column_alist_, edge_sym, edge->self_scm ());
 130         }
 131
 132       SCM s = scm_assoc (align_name, column_alist_);
 133
 134       Item * group = 0;
 135
 136       if (s != SCM_BOOL_F)
 137         {
 138           Grob *e =  unsmob_grob (ly_cdr (s));
 139           group = dynamic_cast<Item*> (e);
 140         }
 141       else
 142         {
 143           group = new Item (get_property ("BreakAlignGroup"));
 144
 145           Axis_group_interface::set_interface (group);
 146           Axis_group_interface::set_axes (group, X_AXIS,X_AXIS);
 147
 148           group->set_grob_property ("break-align-symbol", align_name);
 149           group->set_parent (align_l_, Y_AXIS);
 150           announce_grob (group, 0);
 151           column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
 152
 153         }
 154       Axis_group_interface::add_element (group, item_l);
 155     }
 156 }
 157 ENTER_DESCRIPTION(Break_align_engraver,
 158 /* descr */       "Align grobs with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder",
 159 /* creats*/       "BreakAlignment BreakAlignGroup LeftEdge",
 160 /* acks  */       "grob-interface", // break-aligned-interface ?
 161 /* reads */       "breakAlignOrder",
 162 /* write */       "");