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