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   break_penalty_i_ = 0;
  24   scoreline_l_ =0;
  25   command_column_l_ =0;
  26   musical_column_l_ =0;
  27   breaks_i_ =0;
  28   pscore_p_ = 0;
  29 }
  30
  31 void
  32 Score_engraver::prepare (Moment w)
  33 {
  34   Global_translator::prepare (w);
  35   set_columns (new Score_column (w),  new Score_column (w));
  36
  37   break_penalty_i_ = 0;
  38   post_move_processing();
  39 }
  40
  41 void
  42 Score_engraver::finish()
  43 {
  44   if ((breaks_i_%8))
  45     *mlog << "[" << breaks_i_ << "]" << flush;
  46
  47   check_removal();
  48   removal_processing();
  49 }
  50
  51 /*
  52   use start/finish?
  53  */
  54 void
  55 Score_engraver::do_creation_processing ()
  56 {
  57   scoreline_l_ = pscore_p_->line_l_;
  58
  59   scoreline_l_->set_bounds(LEFT, command_column_l_);
  60
  61   command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
  62
  63   Engraver_group_engraver::do_creation_processing();
  64 }
  65
  66
  67 void
  68 Score_engraver::do_removal_processing()
  69 {
  70   Engraver_group_engraver::do_removal_processing();
  71   scoreline_l_->set_bounds(RIGHT,command_column_l_);
  72   command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
  73
  74   typeset_all ();
  75   set_columns (0,0);
  76 }
  77
  78 void
  79 Score_engraver::process()
  80 {
  81   process_requests();
  82   do_announces();
  83   pre_move_processing();
  84   check_removal();
  85 }
  86
  87 void
  88 Score_engraver::announce_element (Score_element_info info)
  89 {
  90   announce_info_arr_.push (info);
  91   info.origin_trans_l_arr_.push (this);
  92
  93   if (Spanner *s = dynamic_cast <Spanner *> (info.elem_l_))
  94     pscore_p_->typeset_unbroken_spanner (s);
  95   else if (Item *i = dynamic_cast<Item*> (info.elem_l_))
  96     pscore_p_->typeset_element (i);
  97 }
  98
  99 /* All elements are propagated to the top upon announcement. If
 100    something was created during one run of
 101    Engraver_group_engraver::do_announces, then
 102    announce_info_arr_.size() will be nonzero again
 103 */
 104 /* junkme? Done by Engraver_group_engraver::do_announces ()?
 105  */
 106
 107 void
 108 Score_engraver::do_announces()
 109 {
 110   while (announce_info_arr_.size())
 111     Engraver_group_engraver::do_announces();
 112 }
 113
 114
 115 void
 116 Score_engraver::typeset_element (Score_element *elem_p)
 117 {
 118   elem_p_arr_.push (elem_p);
 119 }
 120
 121
 122 void
 123 Score_engraver::typeset_all()
 124 {
 125   for  (int i =0; i < elem_p_arr_.size(); i++)
 126     {
 127       Score_element * elem_p = elem_p_arr_[i];
 128       elem_p->add_processing ();
 129
 130 #if 0                           // TODO!
 131       /*
 132         elem_p wants to be connected to the rest of the
 133         dependency graph.
 134        */
 135
 136       if (elem_p->get_elt_property (dangling_scm_sym) != SCM_BOOL_F)
 137         scoreline_l_->add_dependency (elem_p);
 138 #endif
 139
 140       if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
 141         {
 142             /*
 143             do something sensible if spanner not
 144             spanned on 2 items.
 145            */
 146           Direction d = LEFT;
 147           do {
 148             if (!s->spanned_drul_[d])
 149               {
 150                 s->set_bounds(d, command_column_l_);
 151                 ::warning (_f ("unbound spanner `%s'", classname(s)));
 152               }
 153           } while (flip(&d) != LEFT);
 154         }
 155       else
 156         {
 157           Item *item_p = dynamic_cast <Item *> (elem_p);
 158
 159           if (!item_p->parent_l (X_AXIS))
 160             {
 161               bool br = (item_p->remove_elt_property (breakable_scm_sym) != SCM_BOOL_F);
 162               if (br)
 163                 command_column_l_->add_element(item_p);
 164               else
 165                 musical_column_l_->add_element(item_p);
 166             }
 167         }
 168       if (!elem_p->parent_l(Y_AXIS))
 169         scoreline_l_->add_element (elem_p);
 170     }
 171   elem_p_arr_.clear();
 172 }
 173
 174 void
 175 Score_engraver::do_pre_move_processing()
 176 {
 177   if (break_penalty_i_ > Break_req::DISALLOW)
 178     {
 179       command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
 180       breaks_i_ ++;
 181       if (! (breaks_i_%8))
 182         *mlog << "[" << breaks_i_ << "]" << flush;
 183     }
 184   // this generates all items.
 185   Engraver_group_engraver::do_pre_move_processing();
 186
 187   typeset_all();
 188 }
 189
 190 void
 191 Score_engraver::set_columns (Score_column *new_command_l,
 192                              Score_column *new_musical_l)
 193 {
 194   if (command_column_l_ && command_column_l_->linked_b())
 195     {
 196       pscore_p_->add_column (command_column_l_);
 197       scoreline_l_->add_column (command_column_l_);
 198     }
 199   else
 200     {
 201       delete command_column_l_ ;
 202       command_column_l_ =0;
 203     }
 204   if (new_command_l)
 205     command_column_l_ = new_command_l;
 206
 207   if (musical_column_l_ && musical_column_l_->linked_b())
 208     {
 209       pscore_p_->add_column (musical_column_l_);
 210       scoreline_l_->add_column (musical_column_l_);
 211     }
 212   else
 213     {
 214       delete musical_column_l_;
 215       musical_column_l_ = 0;
 216     }
 217
 218   if (new_musical_l)
 219     {
 220       musical_column_l_ = new_musical_l;
 221     }
 222 }
 223
 224
 225 Staff_info
 226 Score_engraver::get_staff_info() const
 227 {
 228   Staff_info inf = Engraver_group_engraver::get_staff_info();
 229
 230   inf.command_l_ = command_column_l_;
 231   inf.musical_l_ = musical_column_l_;
 232
 233   return inf;
 234 }
 235
 236
 237 Music_output*
 238 Score_engraver::get_output_p ()
 239 {
 240   Music_output * o = pscore_p_;
 241   pscore_p_=0;
 242   return o;
 243 }
 244
 245 bool
 246 Score_engraver::do_try_music (Music*r)
 247 {
 248   bool gotcha = Engraver_group_engraver::do_try_music (r);
 249
 250   if (!gotcha)
 251     {
 252       /*
 253         UGH! THIS IS NOT SYMMETRIC. CLEAN ME UP!
 254        */
 255       if (Break_req* b = dynamic_cast<Break_req *> (r))
 256         {
 257           gotcha = true;
 258           if (b->penalty_i_ <= Break_req::DISALLOW)
 259             break_penalty_i_ = b->penalty_i_;
 260           else if (b->penalty_i_ >= Break_req::FORCE)
 261             command_column_l_->break_penalty_i_ = b->penalty_i_;
 262         }
 263     }
 264    return gotcha;
 265 }
 266
 267 void
 268 Score_engraver::forbid_breaks ()
 269 {
 270   break_penalty_i_ = Break_req::DISALLOW;
 271 }
 272
 273 ADD_THIS_TRANSLATOR(Score_engraver);
 274
 275 void
 276 Score_engraver::do_add_processing ()
 277 {
 278   Translator_group::do_add_processing ();
 279   assert (dynamic_cast<Paper_def *> (output_def_l_));
 280   assert (!daddy_trans_l_);
 281   pscore_p_ = new Paper_score;
 282   pscore_p_->paper_l_ = dynamic_cast<Paper_def*>(output_def_l_);
 283 }