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_sym, 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_sym, 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_sym, 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 #if 0                           // TODO!
 126       /*
 127         elem_p wants to be connected to the rest of the
 128         dependency graph.
 129        */
 130
 131       if (elem_p->get_elt_property (dangling_scm_sym) != SCM_BOOL_F)
 132         scoreline_l_->add_dependency (elem_p);
 133 #endif
 134
 135       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 136         {
 137             /*
 138             do something sensible if spanner not
 139             spanned on 2 items.
 140            */
 141           Direction d = LEFT;
 142           do {
 143             if (!s->spanned_drul_[d])
 144               {
 145                 s->set_bounds(d, command_column_l_);
 146                 ::warning (_f ("unbound spanner `%s'", classname(s)));
 147               }
 148           } while (flip(&d) != LEFT);
 149         }
 150       else
 151         {
 152           Item *item_p = dynamic_cast <Item *> (elem_p);
 153
 154           if (!item_p->parent_l (X_AXIS))
 155             {
 156               bool br = (item_p->remove_elt_property (breakable_scm_sym) != SCM_BOOL_F);
 157               if (br)
 158                 command_column_l_->add_element(item_p);
 159               else
 160                 musical_column_l_->add_element(item_p);
 161             }
 162         }
 163       if (!elem_p->parent_l(Y_AXIS))
 164         scoreline_l_->add_element (elem_p);
 165     }
 166   elem_p_arr_.clear();
 167 }
 168
 169 void
 170 Score_engraver::do_pre_move_processing()
 171 {
 172   if (command_column_l_->get_elt_property (breakable_scm_sym) !=  SCM_BOOL_F)
 173     {
 174       breaks_i_ ++;
 175       if (! (breaks_i_%8))
 176         *mlog << "[" << breaks_i_ << "]" << flush;
 177     }
 178   // this generates all items.
 179   Engraver_group_engraver::do_pre_move_processing();
 180
 181   typeset_all();
 182 }
 183
 184 void
 185 Score_engraver::set_columns (Score_column *new_command_l,
 186                              Score_column *new_musical_l)
 187 {
 188   if (command_column_l_ && command_column_l_->linked_b())
 189     {
 190       pscore_p_->add_column (command_column_l_);
 191       scoreline_l_->add_column (command_column_l_);
 192     }
 193   else
 194     command_column_l_ =0;
 195
 196   if (new_command_l)
 197     command_column_l_ = new_command_l;
 198
 199   if (musical_column_l_ && musical_column_l_->linked_b())
 200     {
 201       pscore_p_->add_column (musical_column_l_);
 202       scoreline_l_->add_column (musical_column_l_);
 203     }
 204   else
 205     musical_column_l_ = 0;
 206
 207   if (new_musical_l)
 208     {
 209       musical_column_l_ = new_musical_l;
 210     }
 211 }
 212
 213
 214 Staff_info
 215 Score_engraver::get_staff_info() const
 216 {
 217   Staff_info inf = Engraver_group_engraver::get_staff_info();
 218
 219   inf.command_l_ = command_column_l_;
 220   inf.musical_l_ = musical_column_l_;
 221
 222   return inf;
 223 }
 224
 225
 226 Music_output*
 227 Score_engraver::get_output_p ()
 228 {
 229   Music_output * o = pscore_p_;
 230   pscore_p_=0;
 231   return o;
 232 }
 233
 234 bool
 235 Score_engraver::do_try_music (Music*r)
 236 {
 237   bool gotcha = Engraver_group_engraver::do_try_music (r);
 238
 239   if (!gotcha)
 240     {
 241       if (Break_req* b = dynamic_cast<Break_req *> (r))
 242         {
 243           gotcha = true;
 244
 245
 246           SCM pen = command_column_l_->get_elt_property  (penalty_scm_sym);
 247           Real total_penalty = (pen == SCM_BOOL_F)
 248             ? 0.0
 249             : gh_scm2double (SCM_CDR(pen)); // ugh. Should typecheck.
 250
 251           total_penalty += b->penalty_f_;
 252           if (b->penalty_f_ > 10000.0) //  ugh. arbitrary.
 253             forbid_breaks ();
 254
 255           command_column_l_->set_elt_property (penalty_scm_sym,
 256                                                gh_double2scm (total_penalty));
 257         }
 258     }
 259    return gotcha;
 260 }
 261
 262 void
 263 Score_engraver::forbid_breaks ()
 264 {
 265   SCM junk = command_column_l_->remove_elt_property (breakable_scm_sym);
 266 }
 267
 268 ADD_THIS_TRANSLATOR(Score_engraver);
 269
 270 void
 271 Score_engraver::do_add_processing ()
 272 {
 273   Translator_group::do_add_processing ();
 274   assert (dynamic_cast<Paper_def *> (output_def_l_));
 275   assert (!daddy_trans_l_);
 276   pscore_p_ = new Paper_score;
 277   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 278 }