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 "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   Object_key const *sys_key = context ()->get_grob_key ("System");
  83   pscore_->typeset_system (new System (props, sys_key));
  84
  85   system_ = pscore_->root_system ();
  86   context ()->set_property ("rootSystem", system_->self_scm ());
  87
  88   Engraver_group::initialize ();
  89 }
  90
  91 void
  92 Score_engraver::connect_to_context (Context *c)
  93 {
  94   Engraver_group::connect_to_context (c);
  95
  96   Dispatcher *d = c->get_global_context ()->event_source ();
  97   d->add_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
  98   d->add_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
  99   d->add_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 100 }
 101
 102 void
 103 Score_engraver::disconnect_from_context ()
 104 {
 105   Dispatcher *d = context ()->get_global_context ()->event_source ();
 106   d->remove_listener (GET_LISTENER (one_time_step), ly_symbol2scm ("OneTimeStep"));
 107   d->remove_listener (GET_LISTENER (prepare), ly_symbol2scm ("Prepare"));
 108   d->remove_listener (GET_LISTENER (finish), ly_symbol2scm ("Finish"));
 109
 110   Engraver_group::disconnect_from_context ();
 111 }
 112
 113 void
 114 Score_engraver::finalize ()
 115 {
 116   Engraver_group::finalize ();
 117
 118   typeset_all ();
 119 }
 120
 121 IMPLEMENT_LISTENER(Score_engraver, one_time_step);
 122 void
 123 Score_engraver::one_time_step (SCM)
 124 {
 125   if (!to_boolean (context ()->get_property ("skipTypesetting")))
 126     {
 127       precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
 128       Engraver_group::do_announces ();
 129     }
 130
 131   precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
 132   typeset_all ();
 133 }
 134
 135 void
 136 Score_engraver::announce_grob (Grob_info info)
 137 {
 138   Engraver_group::announce_grob (info);
 139   if (info.start_end () == START)
 140     {
 141       pscore_->root_system ()->typeset_grob (info.grob ());
 142       elems_.push_back (info.grob ());
 143     }
 144 }
 145
 146 void
 147 Score_engraver::typeset_all ()
 148 {
 149   for (vsize i = 0; i < elems_.size (); i++)
 150     {
 151       Grob *elem = elems_[i];
 152
 153       if (!elem->get_parent (Y_AXIS))
 154         Axis_group_interface::add_element (system_, elem);
 155     }
 156   elems_.clear ();
 157 }
 158
 159 ADD_TRANSLATOR_GROUP (Score_engraver,
 160                       /* doc */ "Top level engraver. Takes care of generating columns and the complete  system (ie. System) "
 161                       "\n\n "
 162                       "This engraver decides whether a column is breakable. The default is "
 163                       "that a column is always breakable. However, every Bar_engraver "
 164                       "that does not have a barline at a certain point will set "
 165                       "forbidBreaks to stop linebreaks.  In practice, this "
 166                       "means that you can make a breakpoint by creating a barline (assuming "
 167                       "that there are no beams or notes that prevent a breakpoint.) ",
 168                       /* create */
 169                       "System ",
 170
 171                       /* read */
 172                       "currentMusicalColumn "
 173                       "currentCommandColumn "
 174                       "verticallySpacedContexts",
 175
 176                       /* write */
 177                       "");