lily/system-start-delimiter-engraver.cc

   1 /*
   2   System-start-delimiter-engraver.cc -- implement
   3   System_start_delimiter_engraver
   4
   5   source file of the GNU LilyPond music typesetter
   6
   7   (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   8
   9 */
  10
  11 #include "engraver.hh"
  12
  13 #include "side-position-interface.hh"
  14 #include "system-start-delimiter.hh"
  15 #include "staff-symbol.hh"
  16 #include "pointer-group-interface.hh"
  17 #include "paper-column.hh"
  18 #include "output-def.hh"
  19 #include "spanner.hh"
  20
  21 struct Bracket_nesting_node
  22 {
  23 public:
  24   virtual ~Bracket_nesting_node(){}
  25   virtual bool add_staff (Grob *) { return false; }
  26   virtual void add_support (Grob *) { }
  27   virtual void set_bound (Direction, Grob *){}
  28   virtual void set_nesting_support (Grob*) {}
  29   virtual void create_grobs (Engraver*, SCM) {}
  30 };
  31
  32 struct Bracket_nesting_group : public Bracket_nesting_node
  33 {
  34   Spanner *delimiter_;
  35   vector<Bracket_nesting_node*> children_;
  36   SCM symbol_;
  37
  38   void from_list (SCM );
  39   virtual void add_support (Grob *grob);
  40   virtual bool add_staff (Grob *grob);
  41   virtual void set_nesting_support (Grob*);
  42   virtual void set_bound (Direction, Grob *grob);
  43   virtual void create_grobs (Engraver*, SCM);
  44   ~Bracket_nesting_group ();
  45   Bracket_nesting_group ();
  46 };
  47
  48
  49 struct Bracket_nesting_staff : public Bracket_nesting_node
  50 {
  51   Grob *staff_;
  52
  53   Bracket_nesting_staff (Grob *s) { staff_ = s; }
  54   virtual bool add_staff (Grob *);
  55 };
  56
  57
  58 Bracket_nesting_group::Bracket_nesting_group ()
  59 {
  60   symbol_ = SCM_EOL;
  61   delimiter_ = 0;
  62 }
  63
  64 bool
  65 Bracket_nesting_staff::add_staff (Grob *g)
  66 {
  67   if (!staff_)
  68     {
  69       staff_ = g;
  70       return true;
  71     }
  72   return false;
  73 }
  74
  75 void
  76 Bracket_nesting_group::create_grobs (Engraver *engraver, SCM default_type)
  77 {
  78   SCM type = scm_is_symbol (symbol_) ? symbol_ : default_type;
  79   delimiter_ = engraver->make_spanner (ly_symbol2string (type).c_str (), SCM_EOL);
  80
  81   for (vsize i = 0 ; i < children_.size (); i++)
  82     {
  83       children_[i]->create_grobs (engraver, default_type);
  84     }
  85 }
  86
  87 void
  88 Bracket_nesting_group::add_support (Grob *g)
  89 {
  90   Side_position_interface::add_support (g, delimiter_);
  91   for (vsize i = 0 ; i < children_.size (); i++)
  92     {
  93       children_[i]->add_support (g);
  94     }
  95 }
  96
  97 Bracket_nesting_group::~Bracket_nesting_group ()
  98 {
  99   for (vsize i = 0 ; i < children_.size (); i++)
 100     delete children_[i];
 101 }
 102
 103 void
 104 Bracket_nesting_group::set_bound (Direction d, Grob *g)
 105 {
 106   delimiter_->set_bound (d, g);
 107   for (vsize i = 0 ; i < children_.size (); i++)
 108     {
 109       children_[i]->set_bound (d, g);
 110     }
 111 }
 112
 113 void
 114 Bracket_nesting_group::set_nesting_support (Grob *parent)
 115 {
 116   if (parent)
 117     Side_position_interface::add_support (delimiter_, parent);
 118
 119   for (vsize i = 0 ; i < children_.size (); i++)
 120     {
 121       children_[i]->set_nesting_support (delimiter_);
 122     }
 123 }
 124
 125
 126 void
 127 Bracket_nesting_group::from_list (SCM x)
 128 {
 129   for (SCM s = x; scm_is_pair (s); s = scm_cdr (s))
 130     {
 131       SCM entry = scm_car (s);
 132       if (scm_is_pair (entry))
 133         {
 134           Bracket_nesting_group *node = new Bracket_nesting_group;
 135           node->from_list (entry);
 136           children_.push_back (node);
 137         }
 138       else if (entry == ly_symbol2scm ("SystemStartBrace")
 139                || entry == ly_symbol2scm ("SystemStartBracket")
 140                || entry == ly_symbol2scm ("SystemStartBar")
 141                || entry == ly_symbol2scm ("SystemStartSquare")
 142                )
 143         symbol_ = entry;
 144       else
 145         {
 146           children_.push_back (new Bracket_nesting_staff (0));
 147         }
 148     }
 149 }
 150
 151 bool
 152 Bracket_nesting_group::add_staff (Grob *grob)
 153 {
 154   for (vsize i = 0; i < children_.size (); i++)
 155     {
 156       if (children_[i]->add_staff (grob))
 157         {
 158           Pointer_group_interface::add_grob (delimiter_, ly_symbol2scm ("elements"), grob);
 159           return true;
 160         }
 161     }
 162
 163   return false;
 164 }
 165
 166
 167
 168
 169 /****************/
 170
 171 class System_start_delimiter_engraver : public Engraver
 172 {
 173 public:
 174   TRANSLATOR_DECLARATIONS (System_start_delimiter_engraver);
 175
 176 protected:
 177   Bracket_nesting_group *nesting_;
 178
 179   DECLARE_ACKNOWLEDGER (system_start_delimiter);
 180   DECLARE_ACKNOWLEDGER (system_start_text);
 181   DECLARE_ACKNOWLEDGER (staff_symbol);
 182
 183   void process_music ();
 184   virtual void finalize ();
 185 };
 186
 187 System_start_delimiter_engraver::System_start_delimiter_engraver ()
 188 {
 189   nesting_ = 0;
 190 }
 191
 192 void
 193 System_start_delimiter_engraver::process_music ()
 194 {
 195   if (!nesting_)
 196     {
 197       nesting_ = new Bracket_nesting_group ();
 198       SCM hierarchy = get_property ("systemStartDelimiterHierarchy");
 199       SCM delimiter_name = get_property ("systemStartDelimiter");
 200
 201       nesting_->from_list (hierarchy);
 202       nesting_->create_grobs (this, delimiter_name);
 203       nesting_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
 204     }
 205 }
 206
 207 void
 208 System_start_delimiter_engraver::finalize ()
 209 {
 210   if (nesting_)
 211     {
 212       nesting_->set_bound (RIGHT,
 213                            unsmob_grob (get_property ("currentCommandColumn")));
 214       nesting_->set_nesting_support (0);
 215     }
 216 }
 217
 218 void
 219 System_start_delimiter_engraver::acknowledge_staff_symbol (Grob_info inf)
 220 {
 221   Grob *staff = inf.grob();
 222   bool succ = nesting_->add_staff (staff);
 223
 224   if (!succ)
 225     {
 226       nesting_->children_.push_back (new Bracket_nesting_staff (0));
 227       nesting_->add_staff (staff);
 228     }
 229 }
 230
 231
 232
 233 void
 234 System_start_delimiter_engraver::acknowledge_system_start_text (Grob_info inf)
 235 {
 236   nesting_->add_support (inf.grob ());
 237 }
 238
 239 void
 240 System_start_delimiter_engraver::acknowledge_system_start_delimiter (Grob_info inf)
 241 {
 242   nesting_->add_support (inf.grob ());
 243 }
 244
 245 #include "translator.icc"
 246
 247 ADD_ACKNOWLEDGER (System_start_delimiter_engraver, staff_symbol);
 248 ADD_ACKNOWLEDGER (System_start_delimiter_engraver, system_start_delimiter);
 249 ADD_ACKNOWLEDGER (System_start_delimiter_engraver, system_start_text);
 250
 251 ADD_TRANSLATOR (System_start_delimiter_engraver,
 252                 /* doc */ "Creates a system start delimiter (ie. SystemStart@{Bar, Brace, Bracket@} spanner",
 253                 /* create */ "SystemStartSquare "
 254                 "SystemStartBrace "
 255                 "SystemStartBracket "
 256                 "SystemStartBar",
 257                 /* accept */ "",
 258                 /* read */
 259                 "systemStartDelimiter "
 260                 "systemStartDelimiterHierarchy "
 261                 "currentCommandColumn",
 262
 263                 /* write */ "");