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