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--2000 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 "musical-request.hh"
  16 #include "paper-column.hh"
  17 #include "command-request.hh"
  18 #include "paper-def.hh"
  19 #include "axis-group-interface.hh"
  20
  21
  22 Score_engraver::Score_engraver()
  23 {
  24   scoreline_l_ =0;
  25   command_column_l_ =0;
  26   musical_column_l_ =0;
  27   breaks_i_ =0;
  28   pscore_p_ = 0;
  29 }
  30
  31 void
  32 Score_engraver::make_columns (Moment w)
  33 {
  34   /*
  35     ugh.
  36    */
  37   if (!command_column_l_
  38       || *unsmob_moment (command_column_l_->get_grob_property ("when")) != w)
  39     {
  40       set_columns (new Paper_column (get_property (ly_symbol2scm ("NonMusicalPaperColumn"))),
  41                    new Paper_column (get_property (ly_symbol2scm ("PaperColumn"))));
  42
  43       command_column_l_->set_grob_property ("when", w.smobbed_copy());
  44       musical_column_l_->set_grob_property ("when", w.smobbed_copy());
  45       command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
  46
  47       Grob_info i1(command_column_l_, 0), i2 (musical_column_l_,0);
  48
  49       i1.origin_trans_l_ = this;
  50       i2.origin_trans_l_ = this;
  51       announce_grob (i1);
  52       announce_grob (i2);
  53     }
  54 }
  55
  56 void
  57 Score_engraver::prepare (Moment w)
  58 {
  59   Global_translator::prepare (w);
  60   make_columns (w);
  61
  62   post_move_processing();
  63 }
  64
  65 void
  66 Score_engraver::finish()
  67 {
  68   if ((breaks_i_%8))
  69     progress_indication ("[" + to_str ( breaks_i_) + "]");
  70
  71   check_removal();
  72   removal_processing();
  73 }
  74
  75 /*
  76   use start/finish?
  77  */
  78 void
  79 Score_engraver::do_creation_processing ()
  80 {
  81   make_columns (Moment (0));
  82   scoreline_l_ = pscore_p_->line_l_;
  83
  84   scoreline_l_->set_bound(LEFT, command_column_l_);
  85
  86   command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
  87
  88   Engraver_group_engraver::do_creation_processing();
  89 }
  90
  91
  92 void
  93 Score_engraver::do_removal_processing()
  94 {
  95   Engraver_group_engraver::do_removal_processing();
  96   scoreline_l_->set_bound(RIGHT,command_column_l_);
  97   command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
  98
  99   typeset_all ();
 100
 101   set_columns (0,0);
 102 }
 103
 104 void
 105 Score_engraver::process()
 106 {
 107   process_music();
 108
 109   announces();
 110   pre_move_processing();
 111   check_removal();
 112 }
 113
 114 void
 115 Score_engraver::announce_grob (Grob_info info)
 116 {
 117   announce_info_arr_.push (info);
 118   pscore_p_->line_l_->typeset_grob (info.elem_l_);
 119 }
 120
 121 /* All elements are propagated to the top upon announcement. If
 122    something was created during one run of
 123    Engraver_group_engraver::do_announces, then
 124    announce_info_arr_.size() will be nonzero again
 125 */
 126 /* junkme? Done by Engraver_group_engraver::do_announces ()?
 127  */
 128
 129 void
 130 Score_engraver::do_announces()
 131 {
 132   //////  do
 133     Engraver_group_engraver::do_announces();
 134     //////while (announce_info_arr_.size());
 135 }
 136
 137
 138 void
 139 Score_engraver::typeset_grob (Grob *elem_p)
 140 {
 141   if (!elem_p)
 142     programming_error ("Score_engraver: empty elt\n");
 143   else
 144
 145     elem_p_arr_.push (elem_p);
 146 }
 147
 148
 149 void
 150 Score_engraver::typeset_all()
 151 {
 152   for  (int i =0; i < elem_p_arr_.size(); i++)
 153     {
 154       Grob * elem_p = elem_p_arr_[i];
 155
 156       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 157         {
 158             /*
 159             do something sensible if spanner not
 160             spanned on 2 items.
 161            */
 162           Direction d = LEFT;
 163           do {
 164             if (!s->get_bound (d))
 165               {
 166                 s->set_bound(d, command_column_l_);
 167                 ::warning (_f ("unbound spanner `%s'", s->name().ch_C()));
 168               }
 169           } while (flip(&d) != LEFT);
 170         }
 171       else
 172         {
 173           if (!elem_p->parent_l (X_AXIS))
 174             {
 175               bool br = to_boolean (elem_p->get_grob_property ("breakable"));
 176               Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
 177
 178             }
 179         }
 180       if (!elem_p->parent_l(Y_AXIS))
 181         Axis_group_interface::add_element (scoreline_l_, elem_p);
 182     }
 183   elem_p_arr_.clear();
 184 }
 185
 186 void
 187 Score_engraver::stop_translation_timestep()
 188 {
 189   // this generates all items.
 190   Engraver_group_engraver::stop_translation_timestep();
 191
 192   typeset_all();
 193   if (to_boolean (command_column_l_->get_grob_property ("breakable")))
 194     {
 195       breaks_i_ ++;
 196       if (! (breaks_i_%8))
 197         progress_indication ("[" + to_str ( breaks_i_) + "]");
 198     }
 199 }
 200
 201 void
 202 Score_engraver::set_columns (Paper_column *new_command_l,
 203                              Paper_column *new_musical_l)
 204 {
 205   Paper_column * news[] = {new_command_l, new_musical_l};
 206   Paper_column **current[] = {&command_column_l_, &musical_column_l_};
 207
 208   for (int i=00; i< 2; i++)
 209     {
 210       if (*current[i])
 211         {
 212           scoreline_l_->add_column ((*current[i]));
 213 #if 0
 214           /*
 215             TODO: delay this decision.
 216            */
 217           if (!Paper_column::used_b (*current[i]))
 218             {
 219               (*current[i])->suicide ();
 220               *current[i]  =0;
 221             }
 222 #endif
 223         }
 224       if (news[i])
 225         *current[i] = news[i];
 226     }
 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
 277 void
 278 Score_engraver::forbid_breaks ()
 279 {
 280   /*
 281     result is junked.
 282    */
 283   command_column_l_->remove_grob_property ("breakable");
 284 }
 285
 286 ADD_THIS_TRANSLATOR(Score_engraver);
 287
 288 void
 289 Score_engraver::do_add_processing ()
 290 {
 291   Translator_group::do_add_processing ();
 292   assert (dynamic_cast<Paper_def *> (output_def_l_));
 293   assert (!daddy_trans_l_);
 294   pscore_p_ = new Paper_score;
 295   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 296
 297   SCM props = get_property (ly_symbol2scm ("LineOfScore"));
 298
 299   pscore_p_->typeset_line (new Line_of_score (props));
 300 }
 301