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--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8 #include "engraver.hh"
   9 #include "protected-scm.hh"
  10 #include "break-align-interface.hh"
  11 #include "align-interface.hh"
  12 #include "axis-group-interface.hh"
  13 #include "context.hh"
  14 #include "translator-group.hh"
  15
  16 #include "translator.icc"
  17
  18 class Break_align_engraver : public Engraver
  19 {
  20   Item *align_;
  21   SCM column_alist_;
  22   Item *left_edge_;
  23
  24   void add_to_group (SCM, Item *);
  25 protected:
  26   void stop_translation_timestep ();
  27   virtual void derived_mark () const;
  28 public:
  29   TRANSLATOR_DECLARATIONS (Break_align_engraver);
  30   DECLARE_ACKNOWLEDGER (break_aligned);
  31 };
  32
  33 void
  34 Break_align_engraver::stop_translation_timestep ()
  35 {
  36   column_alist_ = SCM_EOL;
  37
  38   align_ = 0;
  39   left_edge_ = 0;
  40 }
  41
  42 Break_align_engraver::Break_align_engraver ()
  43 {
  44   column_alist_ = SCM_EOL;
  45   left_edge_ = 0;
  46   align_ = 0;
  47 }
  48
  49 void
  50 Break_align_engraver::derived_mark () const
  51 {
  52   scm_gc_mark (column_alist_);
  53 }
  54
  55 void
  56 Break_align_engraver::acknowledge_break_aligned (Grob_info inf)
  57 {
  58   if (Item *item = dynamic_cast<Item *> (inf.grob ()))
  59     {
  60       /*
  61         Removed check for item->empty (X_AXIS). --hwn 20/1/04
  62       */
  63       if (item->get_parent (X_AXIS))
  64         return;
  65
  66       SCM bp = item->get_property ("breakable");
  67       bool breakable = (to_boolean (bp));
  68       if (!breakable)
  69         return;
  70
  71       SCM align_name = item->get_property ("break-align-symbol");
  72       if (!scm_is_symbol (align_name))
  73         return;
  74
  75       if (!align_)
  76         {
  77           align_ = make_item ("BreakAlignment", SCM_EOL);
  78
  79           Context *origin = inf.origin_contexts (this)[0];
  80
  81           Translator_group *tg = origin->implementation ();
  82           Engraver *random_source = dynamic_cast<Engraver *> (unsmob_translator (scm_car (tg->get_simple_trans_list ())));
  83
  84           /*
  85             Make left edge appear to come from same context as clef/bar-line etc.
  86           */
  87           left_edge_ = make_item_from_properties (random_source,
  88                                                   ly_symbol2scm ("LeftEdge"),
  89                                                   SCM_EOL,
  90                                                   "LeftEdge");
  91           add_to_group (left_edge_->get_property ("break-align-symbol"),
  92                         left_edge_);
  93         }
  94
  95       add_to_group (align_name, item);
  96     }
  97 }
  98
  99 void
 100 Break_align_engraver::add_to_group (SCM align_name, Item *item)
 101 {
 102   SCM s = scm_assoc (align_name, column_alist_);
 103   Item *group = 0;
 104
 105   if (s != SCM_BOOL_F)
 106     {
 107       Grob *e = unsmob_grob (scm_cdr (s));
 108       group = dynamic_cast<Item *> (e);
 109     }
 110   else
 111     {
 112       group = make_item ("BreakAlignGroup", item->self_scm ());
 113
 114       group->set_property ("break-align-symbol", align_name);
 115       group->set_parent (align_, Y_AXIS);
 116
 117       column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
 118
 119       Break_align_interface::add_element (align_, group);
 120     }
 121   Axis_group_interface::add_element (group, item);
 122 }
 123 ADD_ACKNOWLEDGER (Break_align_engraver, break_aligned);
 124 ADD_TRANSLATOR (Break_align_engraver,
 125                 "Align grobs with corresponding @code{break-align-symbols} into "
 126                 "groups, and order the groups according to @code{breakAlignOrder}. "
 127                 "The left edge of the alignment gets a separate group, with a symbol @code{left-edge}. ",
 128                 /* create */ "BreakAlignment BreakAlignGroup LeftEdge",
 129                 /* accept */ "",
 130                 /* read */ "",
 131                 /* write */ "");