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   typeset_grob (e);
  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   if (align_)
  60     {
  61       typeset_grob (align_);
  62       align_ = 0;
  63     }
  64   if (left_edge_)
  65     {
  66       typeset_grob (left_edge_);
  67       left_edge_ = 0;
  68     }
  69 }
  70
  71
  72 Break_align_engraver::Break_align_engraver ()
  73 {
  74   column_alist_ = SCM_EOL;
  75   left_edge_ = 0;
  76   align_ = 0;
  77 }
  78
  79 void
  80 Break_align_engraver::acknowledge_grob (Grob_info inf)
  81 {
  82   if (Item * item = dynamic_cast <Item *> (inf.grob_))
  83     {
  84       /*
  85         Removed check for item->empty (X_AXIS). --hwn 20/1/04
  86        */
  87       if (item->get_parent (X_AXIS))
  88         return;
  89
  90       SCM bp=item->get_property ("breakable");
  91       bool breakable = (to_boolean (bp));
  92       if (!breakable)
  93         return ;
  94
  95       SCM align_name = item->get_property ("break-align-symbol");
  96       if (!ly_c_symbol_p (align_name))
  97         return ;
  98
  99       if (!align_)
 100         {
 101           align_ = make_item ("BreakAlignment", SCM_EOL);
 102
 103
 104
 105           Context*origin = inf.origin_contexts (this)[0];
 106           left_edge_ =  make_item_from_properties (origin->implementation (),
 107                                                    ly_symbol2scm ("LeftEdge"),
 108                                                    SCM_EOL
 109                                                    );
 110           add_to_group (left_edge_->get_property ("break-align-symbol"),
 111                         left_edge_);
 112         }
 113
 114       add_to_group (align_name, item);
 115     }
 116 }
 117
 118 void
 119 Break_align_engraver::add_to_group (SCM align_name, Item*item)
 120 {
 121   SCM s = scm_assoc (align_name, column_alist_);
 122   Item * group = 0;
 123
 124   if (s != SCM_BOOL_F)
 125     {
 126       Grob *e =  unsmob_grob (ly_cdr (s));
 127       group = dynamic_cast<Item*> (e);
 128     }
 129   else
 130     {
 131       group = make_item ("BreakAlignGroup", item->self_scm () );
 132
 133       group->set_property ("break-align-symbol", align_name);
 134       group->set_parent (align_, Y_AXIS);
 135
 136       column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
 137
 138     }
 139   Axis_group_interface::add_element (group, item);
 140 }
 141
 142 ENTER_DESCRIPTION (Break_align_engraver,
 143                    "Align grobs with corresponding @code{break-align-symbols} into "
 144                    "groups, and order the groups according to @code{breakAlignOrder}. "
 145                    "The left edge of the alignment gets a separate group, with a symbol @code{left-edge}. "
 146                    ,
 147                    /* creats*/       "BreakAlignment BreakAlignGroup LeftEdge",
 148                    /* accepts */     "",
 149                    /* acks  */       "break-aligned-interface",
 150                    /* reads */       "",
 151                    /* write */       "");