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--2000 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   pscore_p_->typeset_element (info.elem_l_);
  89 }
  90
  91 /* All elements are propagated to the top upon announcement. If
  92    something was created during one run of
  93    Engraver_group_engraver::do_announces, then
  94    announce_info_arr_.size() will be nonzero again
  95 */
  96 /* junkme? Done by Engraver_group_engraver::do_announces ()?
  97  */
  98
  99 void
 100 Score_engraver::do_announces()
 101 {
 102   while (announce_info_arr_.size())
 103     Engraver_group_engraver::do_announces();
 104 }
 105
 106
 107 void
 108 Score_engraver::typeset_element (Score_element *elem_p)
 109 {
 110   elem_p_arr_.push (elem_p);
 111 }
 112
 113
 114 void
 115 Score_engraver::typeset_all()
 116 {
 117   for  (int i =0; i < elem_p_arr_.size(); i++)
 118     {
 119       Score_element * elem_p = elem_p_arr_[i];
 120       elem_p->add_processing ();
 121
 122
 123       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 124         {
 125             /*
 126             do something sensible if spanner not
 127             spanned on 2 items.
 128            */
 129           Direction d = LEFT;
 130           do {
 131             if (!s->spanned_drul_[d])
 132               {
 133                 s->set_bounds(d, command_column_l_);
 134                 ::warning (_f ("unbound spanner `%s'", classname(s)));
 135               }
 136           } while (flip(&d) != LEFT);
 137         }
 138       else
 139         {
 140           if (!elem_p->parent_l (X_AXIS))
 141             {
 142               bool br = to_boolean (elem_p->remove_elt_property ("breakable"));
 143               if (br)
 144                 command_column_l_->add_element(elem_p);
 145               else
 146                 musical_column_l_->add_element(elem_p);
 147             }
 148         }
 149       if (!elem_p->parent_l(Y_AXIS))
 150         scoreline_l_->add_element (elem_p);
 151     }
 152   elem_p_arr_.clear();
 153 }
 154
 155 void
 156 Score_engraver::do_pre_move_processing()
 157 {
 158   if (to_boolean (command_column_l_->get_elt_property ("breakable")))
 159     {
 160       breaks_i_ ++;
 161       if (! (breaks_i_%8))
 162         progress_indication ("[" + to_str ( breaks_i_) + "]");
 163     }
 164   // this generates all items.
 165   Engraver_group_engraver::do_pre_move_processing();
 166
 167   typeset_all();
 168 }
 169
 170 void
 171 Score_engraver::set_columns (Paper_column *new_command_l,
 172                              Paper_column *new_musical_l)
 173 {
 174   if (command_column_l_ && command_column_l_->linked_b())
 175     {
 176       pscore_p_->add_column (command_column_l_);
 177       scoreline_l_->add_column (command_column_l_);
 178     }
 179   else
 180     command_column_l_ =0;
 181
 182   if (new_command_l)
 183     command_column_l_ = new_command_l;
 184
 185   if (musical_column_l_ && musical_column_l_->linked_b())
 186     {
 187       pscore_p_->add_column (musical_column_l_);
 188       scoreline_l_->add_column (musical_column_l_);
 189     }
 190   else
 191     musical_column_l_ = 0;
 192
 193   if (new_musical_l)
 194     {
 195       musical_column_l_ = new_musical_l;
 196     }
 197 }
 198
 199 Staff_info
 200 Score_engraver::get_staff_info() const
 201 {
 202   Staff_info inf = Engraver_group_engraver::get_staff_info();
 203
 204   inf.command_l_ = command_column_l_;
 205   inf.musical_l_ = musical_column_l_;
 206
 207   return inf;
 208 }
 209
 210 Music_output*
 211 Score_engraver::get_output_p ()
 212 {
 213   Music_output * o = pscore_p_;
 214   pscore_p_=0;
 215   return o;
 216 }
 217
 218 bool
 219 Score_engraver::do_try_music (Music*r)
 220 {
 221   bool gotcha = Engraver_group_engraver::do_try_music (r);
 222
 223   if (!gotcha)
 224     {
 225       if (Break_req* b = dynamic_cast<Break_req *> (r))
 226         {
 227           gotcha = true;
 228
 229
 230           SCM pen = command_column_l_->get_elt_property  ("penalty");
 231           Real total_penalty = gh_number_p (pen)
 232             ? gh_scm2double(pen)
 233             : 0.0;
 234
 235           total_penalty += b->penalty_f_;
 236           if (b->penalty_f_ > 10000.0) //  ugh. arbitrary.
 237             forbid_breaks ();
 238
 239           command_column_l_->set_elt_property ("penalty",
 240                                                gh_double2scm (total_penalty));
 241         }
 242     }
 243    return gotcha;
 244 }
 245
 246 void
 247 Score_engraver::forbid_breaks ()
 248 {
 249   /*
 250     result is junked.
 251    */
 252   command_column_l_->remove_elt_property ("breakable");
 253 }
 254
 255 ADD_THIS_TRANSLATOR(Score_engraver);
 256
 257 void
 258 Score_engraver::do_add_processing ()
 259 {
 260   Translator_group::do_add_processing ();
 261   assert (dynamic_cast<Paper_def *> (output_def_l_));
 262   assert (!daddy_trans_l_);
 263   pscore_p_ = new Paper_score;
 264   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 265 }
 266