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