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