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 class Break_align_engraver : public Engraver
  17 {
  18   Item *align_;
  19   SCM column_alist_;
  20   Item *left_edge_;
  21
  22   void add_to_group (SCM, Item *);
  23 protected:
  24   virtual void acknowledge_grob (Grob_info i);
  25   virtual void stop_translation_timestep ();
  26   virtual void derived_mark () const;
  27   void add_column (SCM);
  28
  29 public:
  30   TRANSLATOR_DECLARATIONS (Break_align_engraver);
  31 };
  32
  33 void
  34 Break_align_engraver::add_column (SCM smob)
  35 {
  36   Grob *e = unsmob_grob (smob);
  37   Break_align_interface::add_element (align_, e);
  38 }
  39
  40 void
  41 Break_align_engraver::stop_translation_timestep ()
  42 {
  43   for (SCM p = column_alist_; scm_is_pair (p); p = scm_cdr (p))
  44     {
  45       SCM pair = scm_car (p);
  46       add_column (scm_cdr (pair));
  47     }
  48   column_alist_ = SCM_EOL;
  49
  50   align_ = 0;
  51   left_edge_ = 0;
  52 }
  53
  54 Break_align_engraver::Break_align_engraver ()
  55 {
  56   column_alist_ = SCM_EOL;
  57   left_edge_ = 0;
  58   align_ = 0;
  59 }
  60
  61 void
  62 Break_align_engraver::derived_mark () const
  63 {
  64   scm_gc_mark (column_alist_);
  65 }
  66
  67 void
  68 Break_align_engraver::acknowledge_grob (Grob_info inf)
  69 {
  70   if (Item *item = dynamic_cast<Item *> (inf.grob ()))
  71     {
  72       /*
  73         Removed check for item->empty (X_AXIS). --hwn 20/1/04
  74       */
  75       if (item->get_parent (X_AXIS))
  76         return;
  77
  78       SCM bp = item->get_property ("breakable");
  79       bool breakable = (to_boolean (bp));
  80       if (!breakable)
  81         return;
  82
  83       SCM align_name = item->get_property ("break-align-symbol");
  84       if (!scm_is_symbol (align_name))
  85         return;
  86
  87       if (!align_)
  88         {
  89           align_ = make_item ("BreakAlignment", SCM_EOL);
  90
  91           Context *origin = inf.origin_contexts (this)[0];
  92           left_edge_ = make_item_from_properties (dynamic_cast<Engraver *>
  93                                                   (origin->implementation ()),
  94                                                   ly_symbol2scm ("LeftEdge"),
  95                                                   SCM_EOL,
  96                                                   "LeftEdge");
  97           add_to_group (left_edge_->get_property ("break-align-symbol"),
  98                         left_edge_);
  99         }
 100
 101       add_to_group (align_name, item);
 102     }
 103 }
 104
 105 void
 106 Break_align_engraver::add_to_group (SCM align_name, Item *item)
 107 {
 108   SCM s = scm_assoc (align_name, column_alist_);
 109   Item *group = 0;
 110
 111   if (s != SCM_BOOL_F)
 112     {
 113       Grob *e = unsmob_grob (scm_cdr (s));
 114       group = dynamic_cast<Item *> (e);
 115     }
 116   else
 117     {
 118       group = make_item ("BreakAlignGroup", item->self_scm ());
 119
 120       group->set_property ("break-align-symbol", align_name);
 121       group->set_parent (align_, Y_AXIS);
 122
 123       column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
 124     }
 125   Axis_group_interface::add_element (group, item);
 126 }
 127
 128 ADD_TRANSLATOR (Break_align_engraver,
 129                 "Align grobs with corresponding @code{break-align-symbols} into "
 130                 "groups, and order the groups according to @code{breakAlignOrder}. "
 131                 "The left edge of the alignment gets a separate group, with a symbol @code{left-edge}. ",
 132                 /* creats*/ "BreakAlignment BreakAlignGroup LeftEdge",
 133                 /* accepts */ "",
 134                 /* acks  */ "break-aligned-interface",
 135                 /* reads */ "",
 136                 /* write */ "");