lily/separating-line-group-engraver.cc

   1 /*
   2   separating-line-group-engraver.cc -- implement Separating_line_group_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "engraver.hh"
  10
  11 #include "separating-group-spanner.hh"
  12 #include "separation-item.hh"
  13 #include "paper-column.hh"
  14 #include "output-def.hh"
  15 #include "axis-group-interface.hh"
  16 #include "note-spacing.hh"
  17 #include "accidental-placement.hh"
  18 #include "context.hh"
  19 #include "spanner.hh"
  20 #include "grob-array.hh"
  21 #include "pointer-group-interface.hh"
  22
  23 #include "translator.icc"
  24
  25 struct Spacings
  26 {
  27   Item *staff_spacing_;
  28   vector<Item*> note_spacings_;
  29
  30   Spacings ()
  31   {
  32     staff_spacing_ = 0;
  33   }
  34
  35   bool is_empty () const
  36   {
  37     return !staff_spacing_ && !note_spacings_.size ();
  38   }
  39   void clear ()
  40   {
  41     staff_spacing_ = 0;
  42     note_spacings_.clear ();
  43   }
  44 };
  45
  46 class Separating_line_group_engraver : public Engraver
  47 {
  48 protected:
  49   Item *break_item_;
  50   Item *musical_item_;
  51   Item *last_musical_item_;
  52
  53   Spacings current_spacings_;
  54   Spacings last_spacings_;
  55
  56   Spanner *sep_span_;
  57
  58   DECLARE_ACKNOWLEDGER (item);
  59   void process_music ();
  60   virtual void finalize ();
  61   void stop_translation_timestep ();
  62   void start_translation_timestep ();
  63 public:
  64   TRANSLATOR_DECLARATIONS (Separating_line_group_engraver);
  65 };
  66
  67 Separating_line_group_engraver::Separating_line_group_engraver ()
  68 {
  69   sep_span_ = 0;
  70   break_item_ = 0;
  71   musical_item_ = 0;
  72 }
  73
  74 void
  75 Separating_line_group_engraver::process_music ()
  76 {
  77   if (!sep_span_)
  78     {
  79       sep_span_ = make_spanner ("SeparatingGroupSpanner", SCM_EOL);
  80
  81       sep_span_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
  82     }
  83 }
  84 void
  85 Separating_line_group_engraver::finalize ()
  86 {
  87   if (!sep_span_)
  88     return;
  89
  90   SCM ccol = get_property ("currentCommandColumn");
  91   Grob *column = unsmob_grob (ccol);
  92
  93   sep_span_->set_bound (RIGHT, unsmob_grob (ccol));
  94   sep_span_ = 0;
  95
  96   for (vsize i = 0; i < last_spacings_.note_spacings_.size (); i++)
  97     {
  98       Pointer_group_interface::add_grob (last_spacings_.note_spacings_[i],
  99                                          ly_symbol2scm ("right-items"),
 100                                          column);
 101     }
 102
 103   if (last_spacings_.staff_spacing_
 104       && last_spacings_.staff_spacing_->get_column () == column)
 105     last_spacings_.staff_spacing_->suicide ();
 106 }
 107
 108 void
 109 Separating_line_group_engraver::acknowledge_item (Grob_info i)
 110 {
 111   Item *it = i.item ();
 112   if (it->get_parent (X_AXIS)
 113       && it->get_parent (X_AXIS) == it->get_parent (Y_AXIS)
 114       && Axis_group_interface::has_axis (it->get_parent (X_AXIS), X_AXIS)
 115       && Axis_group_interface::has_axis (it->get_parent (Y_AXIS), Y_AXIS))
 116     return;
 117
 118   if (to_boolean (it->get_property ("no-spacing-rods")))
 119     return;
 120
 121   if (Note_spacing::has_interface (it))
 122     {
 123       current_spacings_.note_spacings_.push_back (it);
 124       return;
 125     }
 126
 127   bool ib = Item::is_non_musical (it);
 128   Item *&p_ref_ (ib ? break_item_
 129                  : musical_item_);
 130
 131   if (!p_ref_)
 132     {
 133       p_ref_ = make_item ("SeparationItem", SCM_EOL);
 134
 135       if (ib)
 136         {
 137           p_ref_->set_property ("non-musical", SCM_BOOL_T);
 138           context ()->set_property ("breakableSeparationItem", p_ref_->self_scm ());
 139         }
 140
 141       if (to_boolean (get_property ("createSpacing"))
 142           && p_ref_ == break_item_)
 143         {
 144           Item *it = make_item ("StaffSpacing", SCM_EOL);
 145           current_spacings_.staff_spacing_ = it;
 146           Pointer_group_interface::add_grob (it, ly_symbol2scm ("left-items"),
 147                                              break_item_);
 148
 149           if (int i = last_spacings_.note_spacings_.size ())
 150             {
 151               for (; i--;)
 152                 Pointer_group_interface::add_grob (last_spacings_.note_spacings_[i],
 153                                                    ly_symbol2scm ("right-items"),
 154                                                    break_item_);
 155             }
 156           else if (last_spacings_.staff_spacing_)
 157             {
 158               SCM ri = last_spacings_.staff_spacing_->get_object ("right-items");
 159               Grob_array *ga = unsmob_grob_array (ri);
 160               if (!ga)
 161                 {
 162                   SCM ga_scm = Grob_array::make_array ();
 163                   last_spacings_.staff_spacing_->set_object ("right-items", ga_scm);
 164                   ga = unsmob_grob_array (ga_scm);
 165                 }
 166
 167               ga->clear ();
 168               ga->add (break_item_);
 169             }
 170         }
 171     }
 172
 173   if (Accidental_placement::has_interface (it))
 174     Separation_item::add_conditional_item (p_ref_, it);
 175   else
 176     Separation_item::add_item (p_ref_, it);
 177 }
 178
 179 void
 180 Separating_line_group_engraver::start_translation_timestep ()
 181 {
 182   if (break_item_)
 183     {
 184       context ()->unset_property (ly_symbol2scm ("breakableSeparationItem"));
 185       break_item_ = 0;
 186     }
 187 }
 188
 189 void
 190 Separating_line_group_engraver::stop_translation_timestep ()
 191 {
 192   if (break_item_)
 193     Separating_group_spanner::add_spacing_unit (sep_span_, break_item_);
 194
 195   if (Item *sp = current_spacings_.staff_spacing_)
 196     {
 197       /*
 198         TODO: should really look at the left-items of following
 199         note-spacing grobs.
 200       */
 201       if (musical_item_)
 202         Pointer_group_interface::add_grob (sp, ly_symbol2scm ("right-items"),
 203                                            musical_item_);
 204     }
 205
 206   if (!current_spacings_.is_empty ())
 207     last_spacings_ = current_spacings_;
 208
 209   current_spacings_.clear ();
 210
 211   if (musical_item_)
 212     Separating_group_spanner::add_spacing_unit (sep_span_, musical_item_);
 213
 214   musical_item_ = 0;
 215 }
 216
 217 ADD_ACKNOWLEDGER (Separating_line_group_engraver, item);
 218 ADD_TRANSLATOR (Separating_line_group_engraver,
 219                 /* doc */ "Generates objects for computing spacing parameters.",
 220
 221                 /* create */
 222                 "SeparationItem "
 223                 "SeparatingGroupSpanner "
 224                 "StaffSpacing",
 225                 /* read */ "createSpacing",
 226                 /* write */ "breakableSeparationItem");