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