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--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "debug.hh"
  10 #include "dimension-cache.hh"
  11 #include "line-of-score.hh"
  12 #include "item.hh"
  13 #include "score-engraver.hh"
  14 #include "paper-score.hh"
  15 #include "musical-request.hh"
  16 #include "paper-column.hh"
  17 #include "command-request.hh"
  18 #include "paper-def.hh"
  19 #include "axis-group-interface.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 Paper_column (w),  new Paper_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     progress_indication ("[" + to_str ( breaks_i_) + "]");
  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_bound(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_bound(RIGHT,command_column_l_);
  71   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  72
  73
  74   typeset_all ();
  75
  76
  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_->line_l_->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->get_elt_property ("breakable"));
 148               Axis_group_interface gi ((br) ? command_column_l_ : musical_column_l_) ;
 149               gi.add_element(elem_p);
 150             }
 151         }
 152       if (!elem_p->parent_l(Y_AXIS))
 153         Axis_group_interface (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   Paper_column * news[] = {new_command_l, new_musical_l};
 178   Paper_column **current[] = {&command_column_l_, &musical_column_l_};
 179
 180   for (int i=00; i< 2; i++)
 181     {
 182       if (*current[i])
 183         {
 184               scoreline_l_->add_column ((*current[i]));
 185           if (!(*current[i])->used_b())
 186             {
 187               /*
 188                 We're forgetting about this column. Dump it, and make SCM
 189                 forget it.
 190
 191                 FIXME: we should have another way of not putting this
 192                 column into the spacing problem. Maybe we shouldn't
 193                 even prevent this.
 194
 195               */
 196                 (*current[i])->suicide ();
 197               *current[i]  =0;
 198             }
 199         }
 200       if (news[i])
 201         *current[i] = news[i];
 202     }
 203
 204   if (new_musical_l)
 205     set_property ("currentMusicalColumn", new_musical_l->self_scm_);
 206   if (new_command_l)
 207     set_property ("currentCommandColumn", new_command_l->self_scm_);
 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