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--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "all-font-metrics.hh"
  10 #include "afm.hh"
  11 #include "warn.hh"
  12 #include "main.hh"
  13 #include "system.hh"
  14 #include "score-engraver.hh"
  15 #include "paper-score.hh"
  16 #include "paper-column.hh"
  17 #include "output-def.hh"
  18 #include "axis-group-interface.hh"
  19 #include "context-def.hh"
  20 #include "staff-spacing.hh"
  21 #include "note-spacing.hh"
  22 #include "global-context.hh"
  23 #include "open-type-font.hh"
  24
  25 /*
  26   TODO: the column creation logic is rather hairy. Revise it.
  27 */
  28 Score_engraver::Score_engraver ()
  29 {
  30   system_ = 0;
  31   command_column_ = 0;
  32   musical_column_ = 0;
  33   breaks_ = 0;
  34   pscore_ = 0;
  35 }
  36
  37 void
  38 Score_engraver::make_columns ()
  39 {
  40   /*
  41     ugh.
  42   */
  43   if (!command_column_)
  44     {
  45       SCM nmp
  46         = updated_grob_properties (context (),
  47                                    ly_symbol2scm ("NonMusicalPaperColumn"));
  48
  49       Object_key const *key1 = context ()->get_grob_key ("NonMusicalPaperColumn");
  50
  51       SCM pc = updated_grob_properties (context (),
  52                                         ly_symbol2scm ("PaperColumn"));
  53       Object_key const *key2 = context ()->get_grob_key ("PaperColumn");
  54       set_columns (new Paper_column (nmp, key1), new Paper_column (pc, key2));
  55
  56       Grob_info i1;
  57       i1.grob_ = command_column_;
  58       i1.origin_trans_ = this;
  59
  60       announce_grob (i1);
  61
  62       Grob_info i2;
  63       i2.grob_ = musical_column_;
  64       i2.origin_trans_ = this;
  65
  66       announce_grob (i2);
  67     }
  68 }
  69
  70 void
  71 Score_engraver::prepare (Moment m)
  72 {
  73   /*
  74     TODO: don't make columns when skipTypesetting is true.
  75   */
  76   make_columns ();
  77
  78   SCM w = m.smobbed_copy ();
  79   command_column_->set_property ("when", w);
  80   musical_column_->set_property ("when", w);
  81
  82   recurse_over_translators (context (), &Translator::start_translation_timestep, DOWN);
  83 }
  84
  85 void
  86 Score_engraver::finish ()
  87 {
  88   if ((breaks_ % 8))
  89     progress_indication ("[" + to_string (breaks_) + "]");
  90
  91   recurse_over_translators (context (), &Translator::finalize, UP);
  92 }
  93
  94 #define MUSIC_FONT "emmentaler-20"
  95
  96 /*
  97   use start/finish?
  98 */
  99 void
 100 Score_engraver::initialize ()
 101 {
 102   Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
 103   if (!fm)
 104     {
 105       error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
 106              + "\n"
 107              + _ ("Music font has not been installed properly.")
 108              + "\n"
 109              + _f ("Search path `%s'", global_path.to_string ().to_str0 ())
 110              + "\n"
 111              + _ ("Aborting"));
 112     }
 113
 114   pscore_ = new Paper_score;
 115   pscore_->layout_ = dynamic_cast<Output_def *> (get_output_def ());
 116
 117   SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
 118
 119   Object_key const *sys_key = context ()->get_grob_key ("System");
 120   pscore_->typeset_line (new System (props, sys_key));
 121
 122   system_ = pscore_->system_;
 123   make_columns ();
 124   system_->set_bound (LEFT, command_column_);
 125   command_column_->set_property ("breakable", SCM_BOOL_T);
 126
 127   Engraver_group_engraver::initialize ();
 128 }
 129
 130 void
 131 Score_engraver::finalize ()
 132 {
 133   Score_translator::finalize ();
 134
 135   Grob *cc
 136     = unsmob_grob (get_property ("currentCommandColumn"));
 137   system_->set_bound (RIGHT, cc);
 138   cc->set_property ("breakable", SCM_BOOL_T);
 139
 140   typeset_all ();
 141 }
 142
 143 void
 144 Score_engraver::one_time_step ()
 145 {
 146   if (!to_boolean (get_property ("skipTypesetting")))
 147     {
 148       recurse_over_translators (context (), &Engraver::process_music, UP);
 149       Engraver_group_engraver::do_announces ();
 150     }
 151
 152   recurse_over_translators (context (), &Translator::stop_translation_timestep, UP);
 153 }
 154
 155 void
 156 Score_engraver::announce_grob (Grob_info info)
 157 {
 158   announce_infos_.push (info);
 159   pscore_->system_->typeset_grob (info.grob_);
 160   elems_.push (info.grob_);
 161 }
 162
 163 void
 164 Score_engraver::typeset_all ()
 165 {
 166   for (int i = 0; i < elems_.size (); i++)
 167     {
 168       Grob *elem = elems_[i];
 169
 170       if (dynamic_cast<Item *> (elem))
 171         {
 172           if ((!elem->get_parent (X_AXIS)
 173                || !unsmob_grob (elem->get_property ("axis-group-parent-X")))
 174               && elem != command_column_
 175               && elem != musical_column_)
 176             {
 177               bool br = to_boolean (elem->get_property ("breakable"));
 178               Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
 179
 180             }
 181         }
 182       if (!elem->get_parent (Y_AXIS))
 183         Axis_group_interface::add_element (system_, elem);
 184     }
 185   elems_.clear ();
 186 }
 187
 188 void
 189 Score_engraver::stop_translation_timestep ()
 190 {
 191   // this generates all items.
 192   Engraver_group_engraver::stop_translation_timestep ();
 193
 194   typeset_all ();
 195   if (to_boolean (command_column_->get_property ("breakable")))
 196     {
 197       breaks_++;
 198       if (! (breaks_%8))
 199         progress_indication ("[" + to_string (breaks_) + "]");
 200     }
 201
 202   command_column_ = 0;
 203   musical_column_ = 0;
 204 }
 205
 206 void
 207 Score_engraver::set_columns (Paper_column *new_command,
 208                              Paper_column *new_musical)
 209 {
 210   assert (!command_column_ && !musical_column_);
 211
 212   command_column_ = new_command;
 213   musical_column_ = new_musical;
 214   if (new_command)
 215     {
 216       context ()->set_property ("currentCommandColumn", new_command->self_scm ());
 217     }
 218
 219   if (new_musical)
 220     {
 221       context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
 222     }
 223
 224   system_->add_column (command_column_);
 225   system_->add_column (musical_column_);
 226 }
 227
 228 Music_output *
 229 Score_engraver::get_output ()
 230 {
 231   Music_output *o = pscore_;
 232   ///FIXME WTF? pscore_ = 0;
 233   return o;
 234 }
 235
 236 bool
 237 Score_engraver::try_music (Music *m)
 238 {
 239   if (Engraver_group_engraver::try_music (m))
 240     return true;
 241
 242   if (m->is_mus_type ("break-event"))
 243     {
 244       SCM pen = command_column_->get_property ("penalty");
 245       Real total_penalty = scm_is_number (pen) ? scm_to_double (pen) : 0.0;
 246
 247       SCM mpen = m->get_property ("penalty");
 248       if (scm_is_number (mpen))
 249         total_penalty += scm_to_double (mpen);
 250
 251       command_column_->set_property ("penalty", scm_make_real (total_penalty));
 252
 253       /* ugh.  arbitrary, hardcoded */
 254       if (total_penalty > 10000.0)
 255         forbid_breaks ();
 256
 257       SCM page_pen = command_column_->get_property ("page-penalty");
 258       Real total_pp = scm_is_number (page_pen) ? scm_to_double (page_pen) : 0.0;
 259       SCM mpage_pen = m->get_property ("page-penalty");
 260       if (scm_is_number (mpage_pen))
 261         total_pp += scm_to_double (mpage_pen);
 262
 263       command_column_->set_property ("page-penalty", scm_make_real (total_pp));
 264       return true;
 265     }
 266   return false;
 267 }
 268
 269 void
 270 Score_engraver::forbid_breaks ()
 271 {
 272   if (command_column_)
 273     command_column_->set_property ("breakable", SCM_EOL);
 274 }
 275
 276 void
 277 Score_engraver::acknowledge_grob (Grob_info gi)
 278 {
 279   if (Staff_spacing::has_interface (gi.grob_))
 280     {
 281       Pointer_group_interface::add_grob (command_column_,
 282                                          ly_symbol2scm ("spacing-wishes"),
 283                                          gi.grob_);
 284     }
 285   if (Note_spacing::has_interface (gi.grob_))
 286     {
 287       Pointer_group_interface::add_grob (musical_column_,
 288                                          ly_symbol2scm ("spacing-wishes"),
 289                                          gi.grob_);
 290     }
 291
 292   if (Axis_group_interface::has_interface (gi.grob_)
 293       && gi.grob_->internal_has_interface (ly_symbol2scm ("vertically-spaceable-interface")))
 294     {
 295       SCM spaceable = get_property ("verticallySpacedContexts");
 296       Context *orig = gi.origin_contexts (this)[0];
 297
 298       if (scm_memq (ly_symbol2scm (orig->context_name ().to_str0 ()),
 299                     spaceable) != SCM_BOOL_F)
 300         {
 301           Pointer_group_interface::add_grob (system_,
 302                                              ly_symbol2scm ("spaceable-staves"),
 303                                              gi.grob_);
 304         }
 305     }
 306
 307 }
 308
 309 ADD_TRANSLATOR (Score_engraver,
 310                 /* descr */ "Top level engraver. Takes care of generating columns and the complete  system (ie. System) "
 311                 "\n\n "
 312                 "This engraver decides whether a column is breakable. The default is "
 313                 "that a column is always breakable. However, when every Bar_engraver "
 314                 "that does not have a barline at a certain point will call "
 315                 "Score_engraver::forbid_breaks to stop linebreaks.  In practice, this "
 316                 "means that you can make a breakpoint by creating a barline (assuming "
 317                 "that there are no beams or notes that prevent a breakpoint.) ",
 318                 /* creats*/ "System PaperColumn NonMusicalPaperColumn",
 319                 /* accepts */ "break-event",
 320                 /* acks  */ "note-spacing-interface staff-spacing-interface axis-group-interface",
 321                 /* reads */ "currentMusicalColumn currentCommandColumn verticallySpacedContexts",
 322                 /* write */ "");