lily/score-engraver.cc

   1 /*
   2   score-grav.cc -- implement Score_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8 #include "debug.hh"
   9 #include "dimension-cache.hh"
  10 #include "line-of-score.hh"
  11 #include "item.hh"
  12 #include "score-engraver.hh"
  13 #include "paper-score.hh"
  14 #include "musical-request.hh"
  15 #include "paper-column.hh"
  16 #include "command-request.hh"
  17 #include "paper-def.hh"
  18
  19 Score_engraver::Score_engraver()
  20 {
  21   scoreline_l_ =0;
  22   command_column_l_ =0;
  23   musical_column_l_ =0;
  24   breaks_i_ =0;
  25   pscore_p_ = 0;
  26 }
  27
  28 void
  29 Score_engraver::prepare (Moment w)
  30 {
  31   Global_translator::prepare (w);
  32   set_columns (new Paper_column (w),  new Paper_column (w));
  33
  34   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  35   post_move_processing();
  36 }
  37
  38 void
  39 Score_engraver::finish()
  40 {
  41   if ((breaks_i_%8))
  42     progress_indication ("[" + to_str ( breaks_i_) + "]");
  43
  44   check_removal();
  45   removal_processing();
  46 }
  47
  48 /*
  49   use start/finish?
  50  */
  51 void
  52 Score_engraver::do_creation_processing ()
  53 {
  54   scoreline_l_ = pscore_p_->line_l_;
  55
  56   scoreline_l_->set_bounds(LEFT, command_column_l_);
  57
  58   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  59
  60   Engraver_group_engraver::do_creation_processing();
  61 }
  62
  63
  64 void
  65 Score_engraver::do_removal_processing()
  66 {
  67   Engraver_group_engraver::do_removal_processing();
  68   scoreline_l_->set_bounds(RIGHT,command_column_l_);
  69   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  70
  71   typeset_all ();
  72   set_columns (0,0);
  73 }
  74
  75 void
  76 Score_engraver::process()
  77 {
  78   process_requests();
  79   do_announces();
  80   pre_move_processing();
  81   check_removal();
  82 }
  83
  84 void
  85 Score_engraver::announce_element (Score_element_info info)
  86 {
  87   announce_info_arr_.push (info);
  88   info.origin_trans_l_arr_.push (this);
  89   pscore_p_->typeset_element (info.elem_l_);
  90 }
  91
  92 /* All elements are propagated to the top upon announcement. If
  93    something was created during one run of
  94    Engraver_group_engraver::do_announces, then
  95    announce_info_arr_.size() will be nonzero again
  96 */
  97 /* junkme? Done by Engraver_group_engraver::do_announces ()?
  98  */
  99
 100 void
 101 Score_engraver::do_announces()
 102 {
 103   while (announce_info_arr_.size())
 104     Engraver_group_engraver::do_announces();
 105 }
 106
 107
 108 void
 109 Score_engraver::typeset_element (Score_element *elem_p)
 110 {
 111   elem_p_arr_.push (elem_p);
 112 }
 113
 114
 115 void
 116 Score_engraver::typeset_all()
 117 {
 118   for  (int i =0; i < elem_p_arr_.size(); i++)
 119     {
 120       Score_element * elem_p = elem_p_arr_[i];
 121       elem_p->add_processing ();
 122
 123
 124       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 125         {
 126             /*
 127             do something sensible if spanner not
 128             spanned on 2 items.
 129            */
 130           Direction d = LEFT;
 131           do {
 132             if (!s->spanned_drul_[d])
 133               {
 134                 s->set_bounds(d, command_column_l_);
 135                 ::warning (_f ("unbound spanner `%s'", classname(s)));
 136               }
 137           } while (flip(&d) != LEFT);
 138         }
 139       else
 140         {
 141           Item *item_p = dynamic_cast <Item *> (elem_p);
 142
 143           if (!item_p->parent_l (X_AXIS))
 144             {
 145               bool br = to_boolean (item_p->remove_elt_property ("breakable"));
 146               if (br)
 147                 command_column_l_->add_element(item_p);
 148               else
 149                 musical_column_l_->add_element(item_p);
 150             }
 151         }
 152       if (!elem_p->parent_l(Y_AXIS))
 153         scoreline_l_->add_element (elem_p);
 154     }
 155   elem_p_arr_.clear();
 156 }
 157
 158 void
 159 Score_engraver::do_pre_move_processing()
 160 {
 161   if (to_boolean (command_column_l_->get_elt_property ("breakable")))
 162     {
 163       breaks_i_ ++;
 164       if (! (breaks_i_%8))
 165         progress_indication ("[" + to_str ( breaks_i_) + "]");
 166     }
 167   // this generates all items.
 168   Engraver_group_engraver::do_pre_move_processing();
 169
 170   typeset_all();
 171 }
 172
 173 void
 174 Score_engraver::set_columns (Paper_column *new_command_l,
 175                              Paper_column *new_musical_l)
 176 {
 177   if (command_column_l_ && command_column_l_->linked_b())
 178     {
 179       pscore_p_->add_column (command_column_l_);
 180       scoreline_l_->add_column (command_column_l_);
 181     }
 182   else
 183     command_column_l_ =0;
 184
 185   if (new_command_l)
 186     command_column_l_ = new_command_l;
 187
 188   if (musical_column_l_ && musical_column_l_->linked_b())
 189     {
 190       pscore_p_->add_column (musical_column_l_);
 191       scoreline_l_->add_column (musical_column_l_);
 192     }
 193   else
 194     musical_column_l_ = 0;
 195
 196   if (new_musical_l)
 197     {
 198       musical_column_l_ = new_musical_l;
 199     }
 200 }
 201
 202 Staff_info
 203 Score_engraver::get_staff_info() const
 204 {
 205   Staff_info inf = Engraver_group_engraver::get_staff_info();
 206
 207   inf.command_l_ = command_column_l_;
 208   inf.musical_l_ = musical_column_l_;
 209
 210   return inf;
 211 }
 212
 213 Music_output*
 214 Score_engraver::get_output_p ()
 215 {
 216   Music_output * o = pscore_p_;
 217   pscore_p_=0;
 218   return o;
 219 }
 220
 221 bool
 222 Score_engraver::do_try_music (Music*r)
 223 {
 224   bool gotcha = Engraver_group_engraver::do_try_music (r);
 225
 226   if (!gotcha)
 227     {
 228       if (Break_req* b = dynamic_cast<Break_req *> (r))
 229         {
 230           gotcha = true;
 231
 232
 233           SCM pen = command_column_l_->get_elt_property  ("penalty");
 234           Real total_penalty = gh_number_p (pen)
 235             ? gh_scm2double(pen)
 236             : 0.0;
 237
 238           total_penalty += b->penalty_f_;
 239           if (b->penalty_f_ > 10000.0) //  ugh. arbitrary.
 240             forbid_breaks ();
 241
 242           command_column_l_->set_elt_property ("penalty",
 243                                                gh_double2scm (total_penalty));
 244         }
 245     }
 246    return gotcha;
 247 }
 248
 249 void
 250 Score_engraver::forbid_breaks ()
 251 {
 252   /*
 253     result is junked.
 254    */
 255   command_column_l_->remove_elt_property ("breakable");
 256 }
 257
 258 ADD_THIS_TRANSLATOR(Score_engraver);
 259
 260 void
 261 Score_engraver::do_add_processing ()
 262 {
 263   Translator_group::do_add_processing ();
 264   assert (dynamic_cast<Paper_def *> (output_def_l_));
 265   assert (!daddy_trans_l_);
 266   pscore_p_ = new Paper_score;
 267   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 268 }
 269