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--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "score-engraver.hh"
  10
  11 #include "all-font-metrics.hh"
  12 #include "axis-group-interface.hh"
  13 #include "context-def.hh"
  14 #include "dispatcher.hh"
  15 #include "global-context.hh"
  16 #include "international.hh"
  17 #include "main.hh"
  18 #include "open-type-font.hh"
  19 #include "output-def.hh"
  20 #include "paper-column-engraver.hh"
  21 #include "paper-column.hh"
  22 #include "paper-score.hh"
  23 #include "stream-event.hh"
  24 #include "system.hh"
  25 #include "warn.hh"
  26
  27 Score_engraver::Score_engraver ()
  28 {
  29   system_ = 0;
  30   pscore_ = 0;
  31 }
  32
  33 void
  34 Score_engraver::derived_mark () const
  35 {
  36   if (pscore_)
  37     scm_gc_mark (pscore_->self_scm ());
  38   Engraver_group::derived_mark ();
  39 }
  40
  41 IMPLEMENT_LISTENER (Score_engraver, prepare);
  42 void
  43 Score_engraver::prepare (SCM)
  44 {
  45   precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
  46 }
  47
  48 IMPLEMENT_LISTENER (Score_engraver, finish);
  49 void
  50 Score_engraver::finish (SCM)
  51 {
  52   recurse_over_translators (context (), &Translator::finalize,
  53                             &Translator_group::finalize,
  54                             UP);
  55 }
  56
  57 #define MUSIC_FONT "emmentaler-20"
  58
  59 /*
  60   use start/finish?
  61 */
  62 void
  63 Score_engraver::initialize ()
  64 {
  65   Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
  66   if (!fm)
  67     {
  68       error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
  69              + "\n"
  70              + _ ("Music font has not been installed properly.")
  71              + "\n"
  72              + _f ("Search path `%s'", global_path.to_string ().c_str ())
  73              + "\n"
  74              + _ ("Aborting"));
  75     }
  76
  77   pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
  78   pscore_->unprotect ();
  79   context ()->set_property ("output", pscore_->self_scm ());
  80
  81   SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
  82
  83   Object_key const *sys_key = context ()->get_grob_key ("System");
  84   pscore_->typeset_system (new System (props, sys_key));
  85
  86   system_ = pscore_->root_system ();
  87   context ()->set_property ("rootSystem", system_->self_scm ());
  88
  89   Engraver_group::initialize ();
  90 }
  91
  92 void
  93 Score_engraver::connect_to_context (Context *c)
  94 {
  95   Engraver_group::connect_to_context (c);
  96
  97   Dispatcher *d = c->get_global_context ()->event_source ();
  98   d->add_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
  99   d->add_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
 100   d->add_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 101 }
 102
 103 void
 104 Score_engraver::disconnect_from_context ()
 105 {
 106   Dispatcher *d = context ()->get_global_context ()->event_source ();
 107   d->remove_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
 108   d->remove_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
 109   d->remove_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 110
 111   Engraver_group::disconnect_from_context ();
 112 }
 113
 114 void
 115 Score_engraver::finalize ()
 116 {
 117   Engraver_group::finalize ();
 118
 119   typeset_all ();
 120 }
 121
 122 IMPLEMENT_LISTENER(Score_engraver, one_time_step);
 123 void
 124 Score_engraver::one_time_step (SCM)
 125 {
 126   if (!to_boolean (context ()->get_property ("skipTypesetting")))
 127     {
 128       precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
 129       Engraver_group::do_announces ();
 130     }
 131
 132   precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
 133   typeset_all ();
 134 }
 135
 136 void
 137 Score_engraver::announce_grob (Grob_info info)
 138 {
 139   Engraver_group::announce_grob (info);
 140   if (info.start_end () == START)
 141     {
 142       pscore_->root_system ()->typeset_grob (info.grob ());
 143       elems_.push_back (info.grob ());
 144     }
 145 }
 146
 147 void
 148 Score_engraver::typeset_all ()
 149 {
 150   for (vsize i = 0; i < elems_.size (); i++)
 151     {
 152       Grob *elem = elems_[i];
 153
 154       if (!elem->get_parent (Y_AXIS))
 155         Axis_group_interface::add_element (system_, elem);
 156     }
 157   elems_.clear ();
 158 }
 159
 160 ADD_TRANSLATOR_GROUP (Score_engraver,
 161                       /* doc */ "Top level engraver. Takes care of generating columns and the complete  system (ie. System) "
 162                       "\n\n "
 163                       "This engraver decides whether a column is breakable. The default is "
 164                       "that a column is always breakable. However, every Bar_engraver "
 165                       "that does not have a barline at a certain point will set "
 166                       "forbidBreaks to stop linebreaks.  In practice, this "
 167                       "means that you can make a breakpoint by creating a barline (assuming "
 168                       "that there are no beams or notes that prevent a breakpoint.) ",
 169                       /* create */
 170                       "System ",
 171
 172                       /* read */
 173                       "currentMusicalColumn "
 174                       "currentCommandColumn "
 175                       "verticallySpacedContexts",
 176
 177                       /* write */
 178                       "");