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