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