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