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--2001 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
  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   start_translation_timestep ();
  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::initialize ()
  80 {
  81   unsmob_translator_def (definition_)->apply_property_operations (this);
  82
  83   assert (dynamic_cast<Paper_def *> (output_def_l_));
  84   assert (!daddy_trans_l_);
  85   pscore_p_ = new Paper_score;
  86   pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
  87
  88   SCM props = get_property (ly_symbol2scm ("LineOfScore"));
  89
  90   pscore_p_->typeset_line (new Line_of_score (props));
  91
  92   make_columns (Moment (0));
  93   scoreline_l_ = pscore_p_->line_l_;
  94
  95   scoreline_l_->set_bound (LEFT, command_column_l_);
  96
  97   command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
  98
  99   Engraver_group_engraver::initialize ();
 100 }
 101
 102
 103 void
 104 Score_engraver::finalize ()
 105 {
 106   Engraver_group_engraver::finalize ();
 107   scoreline_l_->set_bound (RIGHT,command_column_l_);
 108   command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
 109
 110   typeset_all ();
 111
 112   set_columns (0,0);
 113 }
 114
 115 void
 116 Score_engraver::one_time_step ()
 117 {
 118   if (!to_boolean (get_property (ly_symbol2scm("skipTypesetting"))))
 119     {
 120       process_music ();
 121       announces ();
 122     }
 123
 124
 125   stop_translation_timestep ();
 126   check_removal ();
 127 }
 128
 129 void
 130 Score_engraver::announce_grob (Grob_info info)
 131 {
 132   announce_info_arr_.push (info);
 133   pscore_p_->line_l_->typeset_grob (info.elem_l_);
 134 }
 135
 136 /* All elements are propagated to the top upon announcement. If
 137    something was created during one run of
 138    Engraver_group_engraver::do_announces, then
 139    announce_info_arr_.size () will be nonzero again
 140 */
 141 /* junkme? Done by Engraver_group_engraver::do_announces ()?
 142  */
 143
 144 void
 145 Score_engraver::do_announces ()
 146 {
 147   //////  do
 148     Engraver_group_engraver::do_announces ();
 149     //////while (announce_info_arr_.size ());
 150 }
 151
 152
 153 void
 154 Score_engraver::typeset_grob (Grob *elem_p)
 155 {
 156   if (!elem_p)
 157     programming_error ("Score_engraver: empty elt\n");
 158   else
 159
 160     elem_p_arr_.push (elem_p);
 161 }
 162
 163
 164 void
 165 Score_engraver::typeset_all ()
 166 {
 167   for (int i =0; i < elem_p_arr_.size (); i++)
 168     {
 169       Grob * elem_p = elem_p_arr_[i];
 170
 171       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 172         {
 173             /*
 174             do something sensible if spanner not
 175             spanned on 2 items.
 176            */
 177           Direction d = LEFT;
 178           do {
 179             if (!s->get_bound (d))
 180               {
 181                 s->set_bound (d, command_column_l_);
 182                 /* don't warn for empty/suicided spanners,
 183                    it makes real warningsinvisible.
 184                    maybe should be junked earlier? */
 185                 if (elem_p->immutable_property_alist_ == SCM_EOL)
 186                   ; // gdb hook
 187                 else
 188                   ::warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
 189               }
 190           } while (flip (&d) != LEFT);
 191         }
 192       else
 193         {
 194           if (!elem_p->parent_l (X_AXIS))
 195             {
 196               bool br = to_boolean (elem_p->get_grob_property ("breakable"));
 197               Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
 198
 199             }
 200         }
 201       if (!elem_p->parent_l (Y_AXIS))
 202         Axis_group_interface::add_element (scoreline_l_, elem_p);
 203     }
 204   elem_p_arr_.clear ();
 205 }
 206
 207 void
 208 Score_engraver::stop_translation_timestep ()
 209 {
 210   // this generates all items.
 211   Engraver_group_engraver::stop_translation_timestep ();
 212
 213   typeset_all ();
 214   if (to_boolean (command_column_l_->get_grob_property ("breakable")))
 215     {
 216       breaks_i_ ++;
 217       if (! (breaks_i_%8))
 218         progress_indication ("[" + to_str (breaks_i_) + "]");
 219     }
 220 }
 221
 222 void
 223 Score_engraver::set_columns (Paper_column *new_command_l,
 224                              Paper_column *new_musical_l)
 225 {
 226   Paper_column * news[] = {new_command_l, new_musical_l};
 227   Paper_column **current[] = {&command_column_l_, &musical_column_l_};
 228
 229   for (int i=00; i< 2; i++)
 230     {
 231       if (*current[i])
 232         {
 233           scoreline_l_->add_column ((*current[i]));
 234         }
 235       if (news[i])
 236         *current[i] = news[i];
 237     }
 238
 239   if (new_musical_l)
 240     set_property ("currentMusicalColumn", new_musical_l->self_scm ());
 241   if (new_command_l)
 242     set_property ("currentCommandColumn", new_command_l->self_scm ());
 243 }
 244
 245 Music_output*
 246 Score_engraver::get_output_p ()
 247 {
 248   Music_output * o = pscore_p_;
 249   pscore_p_=0;
 250   return o;
 251 }
 252
 253 bool
 254 Score_engraver::try_music (Music*r)
 255 {
 256   bool gotcha = Engraver_group_engraver::try_music (r);
 257
 258   if (!gotcha)
 259     {
 260       if (Break_req* b = dynamic_cast<Break_req *> (r))
 261         {
 262           gotcha = true;
 263
 264
 265           SCM pen = command_column_l_->get_grob_property ("penalty");
 266           Real total_penalty = gh_number_p (pen)
 267             ? gh_scm2double (pen)
 268             : 0.0;
 269
 270           SCM rpen = b->get_mus_property ("penalty");
 271           if (gh_number_p (rpen))
 272             total_penalty +=  gh_scm2double (rpen);
 273
 274           if (total_penalty > 10000.0) //  ugh. arbitrary.
 275             forbid_breaks ();
 276
 277           command_column_l_->set_grob_property ("penalty",
 278                                                gh_double2scm (total_penalty));
 279         }
 280     }
 281    return gotcha;
 282 }
 283
 284 /*
 285   TODO:  use property Score.breakForbidden = #t
 286  */
 287
 288 void
 289 Score_engraver::forbid_breaks ()
 290 {
 291   /*
 292     result is junked.
 293    */
 294   command_column_l_->remove_grob_property ("breakable");
 295 }
 296
 297 ADD_THIS_TRANSLATOR (Score_engraver);
 298
 299