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