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   Link_array<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_ = make_spanner_from_properties (engraver, type,
  80                                              SCM_EOL, ly_symbol2string (type).to_str0 ());
  81
  82   for (int i = 0 ; i < children_.size (); i++)
  83     {
  84       children_[i]->create_grobs (engraver, default_type);
  85     }
  86 }
  87
  88 void
  89 Bracket_nesting_group::add_support (Grob *g)
  90 {
  91   Side_position_interface::add_support (g, delimiter_);
  92   for (int i = 0 ; i < children_.size (); i++)
  93     {
  94       children_[i]->add_support (g);
  95     }
  96 }
  97
  98 Bracket_nesting_group::~Bracket_nesting_group ()
  99 {
 100   for (int i = 0 ; i < children_.size (); i++)
 101     delete children_[i];
 102 }
 103
 104 void
 105 Bracket_nesting_group::set_bound (Direction d, Grob *g)
 106 {
 107   delimiter_->set_bound (d, g);
 108   for (int i = 0 ; i < children_.size (); i++)
 109     {
 110       children_[i]->set_bound (d, g);
 111     }
 112 }
 113
 114 void
 115 Bracket_nesting_group::set_nesting_support (Grob *parent)
 116 {
 117   if (parent)
 118     Side_position_interface::add_support (delimiter_, parent);
 119
 120   for (int i = 0 ; i < children_.size (); i++)
 121     {
 122       children_[i]->set_nesting_support (delimiter_);
 123     }
 124 }
 125
 126
 127 void
 128 Bracket_nesting_group::from_list (SCM x)
 129 {
 130   for (SCM s = x; scm_is_pair (s); s = scm_cdr (s))
 131     {
 132       SCM entry = scm_car (s);
 133       if (scm_is_pair (entry))
 134         {
 135           Bracket_nesting_group *node = new Bracket_nesting_group;
 136           node->from_list (entry);
 137           children_.push (node);
 138         }
 139       else if (entry == ly_symbol2scm ("SystemStartBrace")
 140                || entry == ly_symbol2scm ("SystemStartBracket")
 141                || entry == ly_symbol2scm ("SystemStartBar")
 142                || entry == ly_symbol2scm ("SystemStartSquare")
 143                )
 144         symbol_ = entry;
 145       else
 146         {
 147           children_.push (new Bracket_nesting_staff (0));
 148         }
 149     }
 150 }
 151
 152 bool
 153 Bracket_nesting_group::add_staff (Grob *grob)
 154 {
 155   for (int i = 0; i < children_.size (); i++)
 156     {
 157       if (children_[i]->add_staff (grob))
 158         {
 159           Pointer_group_interface::add_grob (delimiter_, ly_symbol2scm ("elements"), grob);
 160           return true;
 161         }
 162     }
 163
 164   return false;
 165 }
 166
 167
 168
 169
 170 /****************/
 171
 172 class System_start_delimiter_engraver : public Engraver
 173 {
 174 public:
 175   TRANSLATOR_DECLARATIONS (System_start_delimiter_engraver);
 176
 177 protected:
 178   Bracket_nesting_group *nesting_;
 179
 180   DECLARE_ACKNOWLEDGER (system_start_delimiter);
 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
 193
 194 void
 195 System_start_delimiter_engraver::process_music ()
 196 {
 197   if (!nesting_)
 198     {
 199       nesting_ = new Bracket_nesting_group ();
 200       SCM hierarchy = get_property ("systemStartDelimiterHierarchy");
 201       SCM delimiter_name = get_property ("systemStartDelimiter");
 202
 203       nesting_->from_list (hierarchy);
 204       nesting_->create_grobs (this, delimiter_name);
 205       nesting_->set_bound (LEFT, unsmob_grob (get_property ("currentCommandColumn")));
 206     }
 207 }
 208
 209 void
 210 System_start_delimiter_engraver::finalize ()
 211 {
 212   if (nesting_)
 213     {
 214       nesting_->set_bound (RIGHT,
 215                            unsmob_grob (get_property ("currentCommandColumn")));
 216       nesting_->set_nesting_support (0);
 217     }
 218 }
 219
 220 void
 221 System_start_delimiter_engraver::acknowledge_staff_symbol (Grob_info inf)
 222 {
 223   Grob *staff = inf.grob();
 224   bool succ = nesting_->add_staff (staff);
 225
 226   if (!succ)
 227     {
 228       nesting_->children_.push  (new Bracket_nesting_staff (0));
 229       nesting_->add_staff (staff);
 230     }
 231 }
 232
 233
 234 void
 235 System_start_delimiter_engraver::acknowledge_system_start_delimiter (Grob_info inf)
 236 {
 237   nesting_->add_support (inf.grob ());
 238 }
 239
 240 #include "translator.icc"
 241
 242 ADD_ACKNOWLEDGER (System_start_delimiter_engraver, staff_symbol);
 243 ADD_ACKNOWLEDGER (System_start_delimiter_engraver, system_start_delimiter);
 244
 245 ADD_TRANSLATOR (System_start_delimiter_engraver,
 246                 /* doc */ "Creates a system start delimiter (ie. SystemStart@{Bar, Brace, Bracket@} spanner",
 247                 /* create */ "SystemStartSquare SystemStartBrace SystemStartBracket SystemStartBar",
 248                 /* accept */ "",
 249                 /* read */ "systemStartDelimiter systemStartDelimiterHierarchy currentCommandColumn",
 250                 /* write */ "");