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   SCM column_alist_;
  22   Item *left_edge_;
  23
  24   void add_to_group (SCM,Item*);
  25 protected:
  26   virtual void acknowledge_grob (Grob_info i);
  27   virtual void stop_translation_timestep ();
  28   virtual void derived_mark () const;
  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::stop_translation_timestep ()
  45 {
  46   for (SCM p = column_alist_; scm_is_pair (p); p = scm_cdr (p))
  47     {
  48       SCM pair = scm_car (p);
  49       add_column (scm_cdr (pair));
  50     }
  51   column_alist_ = SCM_EOL;
  52
  53   align_ = 0;
  54   left_edge_ = 0;
  55 }
  56
  57
  58 Break_align_engraver::Break_align_engraver ()
  59 {
  60   column_alist_ = SCM_EOL;
  61   left_edge_ = 0;
  62   align_ = 0;
  63 }
  64
  65 void
  66 Break_align_engraver::derived_mark () const
  67 {
  68   scm_gc_mark (column_alist_);
  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 (!scm_is_symbol (align_name))
  89         return ;
  90
  91       if (!align_)
  92         {
  93           align_ = make_item ("BreakAlignment", SCM_EOL);
  94
  95           Context*origin = inf.origin_contexts (this)[0];
  96           left_edge_ = make_item_from_properties (dynamic_cast<Engraver*> (origin->implementation ()),
  97                                                   ly_symbol2scm ("LeftEdge"),
  98                                                   SCM_EOL,
  99                                                   "LeftEdge");
 100           add_to_group (left_edge_->get_property ("break-align-symbol"),
 101                         left_edge_);
 102         }
 103
 104       add_to_group (align_name, item);
 105     }
 106 }
 107
 108 void
 109 Break_align_engraver::add_to_group (SCM align_name, Item*item)
 110 {
 111   SCM s = scm_assoc (align_name, column_alist_);
 112   Item * group = 0;
 113
 114   if (s != SCM_BOOL_F)
 115     {
 116       Grob *e =  unsmob_grob (scm_cdr (s));
 117       group = dynamic_cast<Item*> (e);
 118     }
 119   else
 120     {
 121       group = make_item ("BreakAlignGroup", item->self_scm () );
 122
 123       group->set_property ("break-align-symbol", align_name);
 124       group->set_parent (align_, Y_AXIS);
 125
 126       column_alist_ = scm_assoc_set_x (column_alist_, align_name, group->self_scm ());
 127
 128     }
 129   Axis_group_interface::add_element (group, item);
 130 }
 131
 132 ENTER_DESCRIPTION (Break_align_engraver,
 133                    "Align grobs with corresponding @code{break-align-symbols} into "
 134                    "groups, and order the groups according to @code{breakAlignOrder}. "
 135                    "The left edge of the alignment gets a separate group, with a symbol @code{left-edge}. "
 136                    ,
 137                    /* creats*/       "BreakAlignment BreakAlignGroup LeftEdge",
 138                    /* accepts */     "",
 139                    /* acks  */       "break-aligned-interface",
 140                    /* reads */       "",
 141                    /* write */       "");