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--2009 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 "system.hh"
  24 #include "warn.hh"
  25
  26 Score_engraver::Score_engraver ()
  27 {
  28   system_ = 0;
  29   pscore_ = 0;
  30 }
  31
  32 void
  33 Score_engraver::derived_mark () const
  34 {
  35   if (pscore_)
  36     scm_gc_mark (pscore_->self_scm ());
  37   Engraver_group::derived_mark ();
  38 }
  39
  40 IMPLEMENT_LISTENER (Score_engraver, prepare);
  41 void
  42 Score_engraver::prepare (SCM)
  43 {
  44   precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
  45 }
  46
  47 IMPLEMENT_LISTENER (Score_engraver, finish);
  48 void
  49 Score_engraver::finish (SCM)
  50 {
  51   recurse_over_translators (context (), &Translator::finalize,
  52                             &Translator_group::finalize,
  53                             UP);
  54 }
  55
  56 #define MUSIC_FONT "emmentaler-20"
  57
  58 /*
  59   use start/finish?
  60 */
  61 void
  62 Score_engraver::initialize ()
  63 {
  64   Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
  65   if (!fm)
  66     {
  67       error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
  68              + "\n"
  69              + _ ("Music font has not been installed properly.")
  70              + "\n"
  71              + _f ("Search path `%s'", global_path.to_string ().c_str ())
  72              + "\n"
  73              + _ ("Aborting"));
  74     }
  75
  76   pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
  77   pscore_->unprotect ();
  78   context ()->set_property ("output", pscore_->self_scm ());
  79
  80   SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
  81
  82   pscore_->typeset_system (new System (props));
  83
  84   system_ = pscore_->root_system ();
  85   context ()->set_property ("rootSystem", system_->self_scm ());
  86
  87   Engraver_group::initialize ();
  88 }
  89
  90 void
  91 Score_engraver::connect_to_context (Context *c)
  92 {
  93   Engraver_group::connect_to_context (c);
  94
  95   Dispatcher *d = c->get_global_context ()->event_source ();
  96   d->add_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
  97   d->add_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
  98   d->add_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
  99 }
 100
 101 /*
 102   uncovered:
 103
 104   check_removal always returns false for Score contexts, it has been that way
 105 since I joined the project. There is a reason for this: The typeset score is
 106 stored in the Score_engraver, which in turn is accessed through the
 107 Global_context returned by ly:run-translator. So the score-translator must be
 108 connected to the score-context after run-translator finishes.
 109
 110 I plan to change this: we should junk run-translator, and instead keep track
 111 of both context and translator in the SCM code, and access the typeset score
 112 directly via the created global-translator. Then it would be possible to
 113 disconnect score-translators at iteration time. -es
 114  */
 115 void
 116 Score_engraver::disconnect_from_context ()
 117 {
 118   Dispatcher *d = context ()->get_global_context ()->event_source ();
 119   d->remove_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
 120   d->remove_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
 121   d->remove_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 122
 123   Engraver_group::disconnect_from_context ();
 124 }
 125
 126 void
 127 Score_engraver::finalize ()
 128 {
 129   Engraver_group::finalize ();
 130
 131   typeset_all ();
 132 }
 133
 134 IMPLEMENT_LISTENER (Score_engraver, one_time_step);
 135 void
 136 Score_engraver::one_time_step (SCM)
 137 {
 138   if (!to_boolean (context ()->get_property ("skipTypesetting")))
 139     {
 140       precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
 141       Engraver_group::do_announces ();
 142     }
 143
 144   precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
 145   typeset_all ();
 146 }
 147
 148 void
 149 Score_engraver::announce_grob (Grob_info info)
 150 {
 151   Engraver_group::announce_grob (info);
 152   if (info.start_end () == START)
 153     {
 154       pscore_->root_system ()->typeset_grob (info.grob ());
 155       elems_.push_back (info.grob ());
 156     }
 157 }
 158
 159 void
 160 Score_engraver::typeset_all ()
 161 {
 162   for (vsize i = 0; i < elems_.size (); i++)
 163     {
 164       Grob *elem = elems_[i];
 165
 166       if (!elem->get_parent (Y_AXIS))
 167         Axis_group_interface::add_element (system_, elem);
 168     }
 169   elems_.clear ();
 170 }
 171
 172 ADD_TRANSLATOR_GROUP (Score_engraver,
 173                       /* doc */
 174                       "The top-level engraver.  Takes care of generating"
 175                       " columns and the complete system (i.e.,"
 176                       " @code{System}).\n"
 177                       "\n"
 178                       "This engraver decides whether a column is breakable."
 179                       "  The default is that a column is always breakable."
 180                       "  However, every @code{Bar_engraver} that does not have"
 181                       " a bar line at a certain point sets @code{forbidBreaks}"
 182                       " to stop line breaks.  In practice, this means that you"
 183                       " can make a break point by creating a bar line"
 184                       " (assuming that there are no beams or notes that"
 185                       " prevent a break point).",
 186
 187                       /* create */
 188                       "System ",
 189
 190                       /* read */
 191                       "currentMusicalColumn "
 192                       "currentCommandColumn "
 193                       "verticallySpacedContexts ",
 194
 195                       /* write */
 196                       ""
 197                       );