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