lily/score-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "score-engraver.hh"
  21
  22 #include "all-font-metrics.hh"
  23 #include "axis-group-interface.hh"
  24 #include "context-def.hh"
  25 #include "dispatcher.hh"
  26 #include "global-context.hh"
  27 #include "grob-properties.hh"
  28 #include "international.hh"
  29 #include "main.hh"
  30 #include "open-type-font.hh"
  31 #include "output-def.hh"
  32 #include "paper-column-engraver.hh"
  33 #include "paper-column.hh"
  34 #include "paper-score.hh"
  35 #include "system.hh"
  36 #include "warn.hh"
  37
  38 Score_engraver::Score_engraver ()
  39 {
  40   system_ = 0;
  41   pscore_ = 0;
  42 }
  43
  44 void
  45 Score_engraver::derived_mark () const
  46 {
  47   if (pscore_)
  48     scm_gc_mark (pscore_->self_scm ());
  49   Engraver_group::derived_mark ();
  50 }
  51
  52 void
  53 Score_engraver::prepare (SCM)
  54 {
  55   precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
  56 }
  57
  58 void
  59 Score_engraver::finish (SCM)
  60 {
  61   recurse_over_translators
  62     (context (),
  63      Callback0_wrapper::make_smob<Translator, &Translator::finalize> (),
  64      Callback0_wrapper::make_smob<Translator_group, &Translator_group::finalize> (),
  65      UP);
  66 }
  67
  68 #define MUSIC_FONT "emmentaler-20"
  69
  70 /*
  71   use start/finish?
  72 */
  73 void
  74 Score_engraver::initialize ()
  75 {
  76   Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
  77   if (!fm)
  78     {
  79       error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
  80              + "\n"
  81              + _ ("Music font has not been installed properly.")
  82              + "\n"
  83              + _f ("Search path `%s'", global_path.to_string ().c_str ())
  84              + "\n"
  85              + _ ("Aborting"));
  86     }
  87
  88   pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
  89   pscore_->unprotect ();
  90   context ()->set_property ("output", pscore_->self_scm ());
  91
  92   SCM props = Grob_property_info (context (), ly_symbol2scm ("System")).updated ();
  93
  94   pscore_->typeset_system (new System (props));
  95
  96   system_ = pscore_->root_system ();
  97   context ()->set_property ("rootSystem", system_->self_scm ());
  98
  99   Engraver_group::initialize ();
 100 }
 101
 102 void
 103 Score_engraver::connect_to_context (Context *c)
 104 {
 105   Engraver_group::connect_to_context (c);
 106
 107   Dispatcher *d = c->get_global_context ()->event_source ();
 108   d->add_listener (GET_LISTENER (Score_engraver, one_time_step), ly_symbol2scm ("OneTimeStep"));
 109   d->add_listener (GET_LISTENER (Score_engraver, prepare), ly_symbol2scm ("Prepare"));
 110   d->add_listener (GET_LISTENER (Score_engraver, finish), ly_symbol2scm ("Finish"));
 111 }
 112
 113 /*
 114   uncovered:
 115
 116   check_removal always returns false for Score contexts, it has been that way
 117 since I joined the project. There is a reason for this: The typeset score is
 118 stored in the Score_engraver, which in turn is accessed through the
 119 Global_context returned by ly:run-translator. So the score-translator must be
 120 connected to the score-context after run-translator finishes.
 121
 122 I plan to change this: we should junk run-translator, and instead keep track
 123 of both context and translator in the SCM code, and access the typeset score
 124 directly via the created global-translator. Then it would be possible to
 125 disconnect score-translators at iteration time. -es
 126  */
 127 void
 128 Score_engraver::disconnect_from_context ()
 129 {
 130   Dispatcher *d = context ()->get_global_context ()->event_source ();
 131   d->remove_listener (GET_LISTENER (Score_engraver, one_time_step), ly_symbol2scm ("OneTimeStep"));
 132   d->remove_listener (GET_LISTENER (Score_engraver, prepare), ly_symbol2scm ("Prepare"));
 133   d->remove_listener (GET_LISTENER (Score_engraver, finish), ly_symbol2scm ("Finish"));
 134
 135   Engraver_group::disconnect_from_context ();
 136 }
 137
 138 void
 139 Score_engraver::finalize ()
 140 {
 141   Engraver_group::finalize ();
 142
 143   typeset_all ();
 144 }
 145
 146 void
 147 Score_engraver::one_time_step (SCM)
 148 {
 149   if (!to_boolean (context ()->get_property ("skipTypesetting")))
 150     {
 151       precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
 152       Engraver_group::do_announces ();
 153     }
 154
 155   precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
 156   typeset_all ();
 157 }
 158
 159 void
 160 Score_engraver::announce_grob (Grob_info info, Direction start_end, Context *reroute_context)
 161 {
 162   Engraver_group::announce_grob (info, start_end, reroute_context);
 163   if (start_end == START)
 164     {
 165       pscore_->root_system ()->typeset_grob (info.grob ());
 166       elems_.push_back (info.grob ());
 167     }
 168 }
 169
 170 void
 171 Score_engraver::typeset_all ()
 172 {
 173   for (vsize i = 0; i < elems_.size (); i++)
 174     {
 175       Grob *elem = elems_[i];
 176
 177       if (!elem->get_parent (Y_AXIS))
 178         Axis_group_interface::add_element (system_, elem);
 179     }
 180   elems_.clear ();
 181 }
 182
 183 ADD_TRANSLATOR_GROUP (Score_engraver,
 184                       /* doc */
 185                       "The top-level engraver.  Takes care of generating"
 186                       " columns and the complete system (i.e.,"
 187                       " @code{System}).\n"
 188                       "\n"
 189                       "This engraver decides whether a column is breakable."
 190                       "  The default is that a column is always breakable."
 191                       "  However, every @code{Bar_engraver} that does not have"
 192                       " a bar line at a certain point sets @code{forbidBreaks}"
 193                       " to stop line breaks.  In practice, this means that you"
 194                       " can make a break point by creating a bar line"
 195                       " (assuming that there are no beams or notes that"
 196                       " prevent a break point).",
 197
 198                       /* create */
 199                       "System ",
 200
 201                       /* read */
 202                       "currentMusicalColumn "
 203                       "currentCommandColumn ",
 204
 205                       /* write */
 206                       ""
 207                      );