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