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
  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
  35
  36   /*
  37     ugh.
  38    */
  39   if (!command_column_l_
  40       || *unsmob_moment (command_column_l_->get_elt_property ("when")) != w)
  41     {
  42       set_columns (new Paper_column (get_property (ly_symbol2scm ("NonMusicalPaperColumn"))),
  43                    new Paper_column (get_property (ly_symbol2scm ("PaperColumn"))));
  44
  45       command_column_l_->set_elt_property ("when", w.smobbed_copy());
  46       musical_column_l_->set_elt_property ("when", w.smobbed_copy());
  47       command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  48
  49       Score_element_info i1(command_column_l_, 0), i2 (musical_column_l_,0);
  50
  51       i1.origin_trans_l_ = this;
  52       i2.origin_trans_l_ = this;
  53       announce_element (i1);
  54       announce_element (i2);
  55     }
  56   post_move_processing();
  57 }
  58
  59 void
  60 Score_engraver::finish()
  61 {
  62   if ((breaks_i_%8))
  63     progress_indication ("[" + to_str ( breaks_i_) + "]");
  64
  65   check_removal();
  66   removal_processing();
  67 }
  68
  69 /*
  70   use start/finish?
  71  */
  72 void
  73 Score_engraver::do_creation_processing ()
  74 {
  75   prepare (Moment (0));
  76   scoreline_l_ = pscore_p_->line_l_;
  77
  78   scoreline_l_->set_bound(LEFT, command_column_l_);
  79
  80   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  81
  82   Engraver_group_engraver::do_creation_processing();
  83 }
  84
  85
  86 void
  87 Score_engraver::do_removal_processing()
  88 {
  89   Engraver_group_engraver::do_removal_processing();
  90   scoreline_l_->set_bound(RIGHT,command_column_l_);
  91   command_column_l_->set_elt_property ("breakable", SCM_BOOL_T);
  92
  93   typeset_all ();
  94
  95   set_columns (0,0);
  96 }
  97
  98 void
  99 Score_engraver::process()
 100 {
 101   //process_music();
 102   announces();
 103   pre_move_processing();
 104   check_removal();
 105 }
 106
 107 void
 108 Score_engraver::announce_element (Score_element_info info)
 109 {
 110   announce_info_arr_.push (info);
 111   pscore_p_->line_l_->typeset_element (info.elem_l_);
 112 }
 113
 114 /* All elements are propagated to the top upon announcement. If
 115    something was created during one run of
 116    Engraver_group_engraver::do_announces, then
 117    announce_info_arr_.size() will be nonzero again
 118 */
 119 /* junkme? Done by Engraver_group_engraver::do_announces ()?
 120  */
 121
 122 void
 123 Score_engraver::do_announces()
 124 {
 125   //////  do
 126     Engraver_group_engraver::do_announces();
 127     //////while (announce_info_arr_.size());
 128 }
 129
 130
 131 void
 132 Score_engraver::typeset_element (Score_element *elem_p)
 133 {
 134   if (!elem_p)
 135     programming_error ("Score_engraver: empty elt\n");
 136   else
 137
 138     elem_p_arr_.push (elem_p);
 139 }
 140
 141
 142 void
 143 Score_engraver::typeset_all()
 144 {
 145   for  (int i =0; i < elem_p_arr_.size(); i++)
 146     {
 147       Score_element * elem_p = elem_p_arr_[i];
 148
 149       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 150         {
 151             /*
 152             do something sensible if spanner not
 153             spanned on 2 items.
 154            */
 155           Direction d = LEFT;
 156           do {
 157             if (!s->get_bound (d))
 158               {
 159                 s->set_bound(d, command_column_l_);
 160                 ::warning (_f ("unbound spanner `%s'", s->name().ch_C()));
 161               }
 162           } while (flip(&d) != LEFT);
 163         }
 164       else
 165         {
 166           if (!elem_p->parent_l (X_AXIS))
 167             {
 168               bool br = to_boolean (elem_p->get_elt_property ("breakable"));
 169               Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
 170
 171             }
 172         }
 173       if (!elem_p->parent_l(Y_AXIS))
 174         Axis_group_interface::add_element (scoreline_l_, elem_p);
 175     }
 176   elem_p_arr_.clear();
 177 }
 178
 179 void
 180 Score_engraver::do_pre_move_processing()
 181 {
 182   // this generates all items.
 183   Engraver_group_engraver::do_pre_move_processing();
 184
 185   typeset_all();
 186   if (to_boolean (command_column_l_->get_elt_property ("breakable")))
 187     {
 188       breaks_i_ ++;
 189       if (! (breaks_i_%8))
 190         progress_indication ("[" + to_str ( breaks_i_) + "]");
 191     }
 192 }
 193
 194 void
 195 Score_engraver::set_columns (Paper_column *new_command_l,
 196                              Paper_column *new_musical_l)
 197 {
 198   Paper_column * news[] = {new_command_l, new_musical_l};
 199   Paper_column **current[] = {&command_column_l_, &musical_column_l_};
 200
 201   for (int i=00; i< 2; i++)
 202     {
 203       if (*current[i])
 204         {
 205           scoreline_l_->add_column ((*current[i]));
 206 #if 0
 207           /*
 208             TODO: delay this decision.
 209            */
 210           if (!Paper_column::used_b (*current[i]))
 211             {
 212               (*current[i])->suicide ();
 213               *current[i]  =0;
 214             }
 215 #endif
 216         }
 217       if (news[i])
 218         *current[i] = news[i];
 219     }
 220
 221   if (new_musical_l)
 222     set_property ("currentMusicalColumn", new_musical_l->self_scm ());
 223   if (new_command_l)
 224     set_property ("currentCommandColumn", new_command_l->self_scm ());
 225 }
 226
 227 Music_output*
 228 Score_engraver::get_output_p ()
 229 {
 230   Music_output * o = pscore_p_;
 231   pscore_p_=0;
 232   return o;
 233 }
 234
 235 bool
 236 Score_engraver::do_try_music (Music*r)
 237 {
 238   bool gotcha = Engraver_group_engraver::do_try_music (r);
 239
 240   if (!gotcha)
 241     {
 242       if (Break_req* b = dynamic_cast<Break_req *> (r))
 243         {
 244           gotcha = true;
 245
 246
 247           SCM pen = command_column_l_->get_elt_property  ("penalty");
 248           Real total_penalty = gh_number_p (pen)
 249             ? gh_scm2double(pen)
 250             : 0.0;
 251
 252           SCM rpen = b->get_mus_property ("penalty");
 253           if (gh_number_p (rpen))
 254             total_penalty +=  gh_scm2double (rpen);
 255
 256           if (total_penalty > 10000.0) //  ugh. arbitrary.
 257             forbid_breaks ();
 258
 259           command_column_l_->set_elt_property ("penalty",
 260                                                gh_double2scm (total_penalty));
 261         }
 262     }
 263    return gotcha;
 264 }
 265
 266 void
 267 Score_engraver::forbid_breaks ()
 268 {
 269   /*
 270     result is junked.
 271    */
 272   command_column_l_->remove_elt_property ("breakable");
 273 }
 274
 275 ADD_THIS_TRANSLATOR(Score_engraver);
 276
 277 void
 278 Score_engraver::do_add_processing ()
 279 {
 280   Translator_group::do_add_processing ();
 281   assert (dynamic_cast<Paper_def *> (output_def_l_));
 282   assert (!daddy_trans_l_);
 283   pscore_p_ = new Paper_score;
 284   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 285
 286   SCM props = get_property (ly_symbol2scm ("LineOfScore"));
 287
 288   pscore_p_->typeset_line (new Line_of_score (props));
 289 }
 290