lily/score-engraver.cc

   1 /*
   2   score-engraver.cc -- implement Score_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "debug.hh"
  10
  11 #include "line-of-score.hh"
  12 #include "item.hh"
  13 #include "score-engraver.hh"
  14 #include "paper-score.hh"
  15 #include "paper-column.hh"
  16 #include "command-request.hh"
  17 #include "paper-def.hh"
  18 #include "axis-group-interface.hh"
  19 #include "translator-def.hh"
  20
  21 #include "staff-spacing.hh"
  22 #include "note-spacing.hh"
  23
  24 /*
  25   TODO: the column creation logic is rather hairy. Revise it.
  26  */
  27 Score_engraver::Score_engraver ()
  28 {
  29   scoreline_l_ =0;
  30   command_column_l_ =0;
  31   musical_column_l_ =0;
  32   breaks_i_ =0;
  33   pscore_p_ = 0;
  34 }
  35
  36 void
  37 Score_engraver::make_columns ()
  38 {
  39   /*
  40     ugh.
  41    */
  42   if (!command_column_l_)
  43     {
  44       set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
  45                    new Paper_column (get_property ("PaperColumn")));
  46
  47       command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
  48
  49       Grob_info i1 (command_column_l_);
  50       i1.origin_trans_l_ = this;
  51
  52       Grob_info i2 (musical_column_l_);
  53       i2.origin_trans_l_ = this;
  54
  55       announce_grob (i1);
  56       announce_grob (i2);
  57     }
  58 }
  59
  60 void
  61 Score_engraver::prepare (Moment w)
  62 {
  63   Global_translator::prepare (w);
  64
  65   make_columns ();
  66   start_translation_timestep ();
  67 }
  68
  69 void
  70 Score_engraver::finish ()
  71 {
  72   if ((breaks_i_%8))
  73     progress_indication ("[" + to_str (breaks_i_) + "]");
  74
  75   check_removal ();
  76   removal_processing ();
  77
  78 }
  79
  80 /*
  81   use start/finish?
  82  */
  83 void
  84 Score_engraver::initialize ()
  85 {
  86   unsmob_translator_def (definition_)->apply_property_operations (this);
  87
  88   assert (dynamic_cast<Paper_def *> (output_def_l_));
  89   assert (!daddy_trans_l_);
  90   pscore_p_ = new Paper_score;
  91   pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
  92
  93   SCM props = get_property ("System");
  94
  95   pscore_p_->typeset_line (new System (props));
  96
  97   make_columns ();
  98   scoreline_l_ = pscore_p_->line_l_;
  99   scoreline_l_->set_bound (LEFT, command_column_l_);
 100   command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
 101
 102   Engraver_group_engraver::initialize ();
 103 }
 104
 105
 106 void
 107 Score_engraver::finalize ()
 108 {
 109   Engraver_group_engraver::finalize ();
 110
 111   Grob * cc
 112     = unsmob_grob (get_property ("currentCommandColumn"));
 113   scoreline_l_->set_bound (RIGHT, cc);
 114   cc->set_grob_property ("breakable", SCM_BOOL_T);
 115
 116   typeset_all ();
 117 }
 118
 119 void
 120 Score_engraver::one_time_step ()
 121 {
 122   if (!to_boolean (get_property ("skipTypesetting")))
 123     {
 124       process_music ();
 125       announces ();
 126     }
 127
 128   stop_translation_timestep ();
 129   check_removal ();
 130 }
 131
 132 void
 133 Score_engraver::announce_grob (Grob_info info)
 134 {
 135   announce_info_arr_.push (info);
 136   pscore_p_->line_l_->typeset_grob (info.grob_l_);
 137
 138
 139 }
 140
 141
 142 void
 143 Score_engraver::typeset_grob (Grob *elem_p)
 144 {
 145   if (!elem_p)
 146     programming_error ("Score_engraver: empty elt\n");
 147   else
 148
 149     elem_p_arr_.push (elem_p);
 150 }
 151
 152
 153 void
 154 Score_engraver::typeset_all ()
 155 {
 156   for (int i =0; i < elem_p_arr_.size (); i++)
 157     {
 158       Grob * elem_p = elem_p_arr_[i];
 159
 160       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 161         {
 162             /*
 163             do something sensible if spanner not
 164             spanned on 2 items.
 165            */
 166           Direction d = LEFT;
 167           do {
 168             if (!s->get_bound (d))
 169               {
 170                 s->set_bound (d, command_column_l_);
 171                 /* don't warn for empty/suicided spanners,
 172                    it makes real warningsinvisible.
 173                    maybe should be junked earlier? */
 174                 if (elem_p->immutable_property_alist_ == SCM_EOL)
 175                   ; // gdb hook
 176                 else
 177                   elem_p->warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
 178               }
 179           } while (flip (&d) != LEFT);
 180         }
 181       else
 182         {
 183           if (!elem_p->get_parent (X_AXIS))
 184             {
 185               bool br = to_boolean (elem_p->get_grob_property ("breakable"));
 186               Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
 187
 188             }
 189         }
 190       if (!elem_p->get_parent (Y_AXIS))
 191         Axis_group_interface::add_element (scoreline_l_, elem_p);
 192     }
 193   elem_p_arr_.clear ();
 194 }
 195
 196 void
 197 Score_engraver::stop_translation_timestep ()
 198 {
 199   // this generates all items.
 200   Engraver_group_engraver::stop_translation_timestep ();
 201
 202   typeset_all ();
 203   if (to_boolean (command_column_l_->get_grob_property ("breakable")))
 204     {
 205       breaks_i_ ++;
 206       if (! (breaks_i_%8))
 207         progress_indication ("[" + to_str (breaks_i_) + "]");
 208     }
 209
 210   command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
 211   musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
 212
 213   scoreline_l_->add_column (command_column_l_);
 214   scoreline_l_->add_column (musical_column_l_);
 215
 216   command_column_l_ = 0;
 217   musical_column_l_ = 0;
 218 }
 219
 220 void
 221 Score_engraver::set_columns (Paper_column *new_command_l,
 222                              Paper_column *new_musical_l)
 223 {
 224   assert (!command_column_l_ && !musical_column_l_);
 225   command_column_l_ = new_command_l;
 226   musical_column_l_ = new_musical_l;
 227
 228   if (new_musical_l)
 229     set_property ("currentMusicalColumn", new_musical_l->self_scm ());
 230   if (new_command_l)
 231     set_property ("currentCommandColumn", new_command_l->self_scm ());
 232 }
 233
 234 Music_output*
 235 Score_engraver::get_output_p ()
 236 {
 237   Music_output * o = pscore_p_;
 238   pscore_p_=0;
 239   return o;
 240 }
 241
 242 bool
 243 Score_engraver::try_music (Music*r)
 244 {
 245   bool gotcha = Engraver_group_engraver::try_music (r);
 246
 247   if (!gotcha)
 248     {
 249       if (Break_req* b = dynamic_cast<Break_req *> (r))
 250         {
 251           gotcha = true;
 252
 253
 254           SCM pen = command_column_l_->get_grob_property ("penalty");
 255           Real total_penalty = gh_number_p (pen)
 256             ? gh_scm2double (pen)
 257             : 0.0;
 258
 259           SCM rpen = b->get_mus_property ("penalty");
 260           if (gh_number_p (rpen))
 261             total_penalty +=  gh_scm2double (rpen);
 262
 263           if (total_penalty > 10000.0) //  ugh. arbitrary.
 264             forbid_breaks ();
 265
 266           command_column_l_->set_grob_property ("penalty",
 267                                                gh_double2scm (total_penalty));
 268         }
 269     }
 270    return gotcha;
 271 }
 272
 273 /*
 274   TODO:  use property Score.breakForbidden = #t
 275  */
 276 void
 277 Score_engraver::forbid_breaks ()
 278 {
 279   /*
 280     result is junked.
 281    */
 282   command_column_l_->remove_grob_property ("breakable");
 283 }
 284
 285 void
 286 Score_engraver::acknowledge_grob (Grob_info gi)
 287 {
 288   if (Staff_spacing::has_interface (gi.grob_l_))
 289     {
 290       Pointer_group_interface::add_grob (command_column_l_,
 291                                             ly_symbol2scm ("spacing-wishes"),
 292                                             gi.grob_l_);
 293     }
 294   if (Note_spacing::has_interface (gi.grob_l_))
 295     {
 296       Pointer_group_interface::add_grob (musical_column_l_,
 297                                          ly_symbol2scm ("spacing-wishes"),
 298                                          gi.grob_l_);
 299     }
 300 }
 301
 302
 303
 304 ENTER_DESCRIPTION(Score_engraver,
 305 /* descr */       "Top level engraver. Takes care of generating columns and the complete  system (ie. System)
 306
 307
 308 This engraver decides whether a column is breakable. The default is
 309 that a column is always breakable. However, when every Bar_engraver
 310 that does not have a barline at a certain point will call
 311 Score_engraver::forbid_breaks to stop linebreaks.  In practice, this
 312 means that you can make a breakpoint by creating a barline (assuming
 313 that there are no beams or notes that prevent a breakpoint.)
 314
 315
 316 ",
 317 /* creats*/       "System PaperColumn NonMusicalPaperColumn",
 318 /* acks  */       "note-spacing-interface staff-spacing-interface",
 319 /* reads */       "currentMusicalColumn currentCommandColumn",
 320 /* write */       "");