2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "score-engraver.hh"
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"
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"
38 Score_engraver::Score_engraver ()
45 Score_engraver::derived_mark () const
48 scm_gc_mark (pscore_->self_scm ());
49 Engraver_group::derived_mark ();
53 Score_engraver::prepare (SCM)
55 precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
59 Score_engraver::finish (SCM)
61 recurse_over_translators
63 Callback0_wrapper::make_smob<Translator, &Translator::finalize> (),
64 Callback0_wrapper::make_smob<Translator_group, &Translator_group::finalize> (),
68 #define MUSIC_FONT "emmentaler-20"
74 Score_engraver::initialize ()
76 Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
79 error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
81 + _ ("Music font has not been installed properly.")
83 + _f ("Search path `%s'", global_path.to_string ().c_str ())
88 pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
89 pscore_->unprotect ();
90 context ()->set_property ("output", pscore_->self_scm ());
92 SCM props = Grob_property_info (context (), ly_symbol2scm ("System")).updated ();
94 pscore_->typeset_system (new System (props));
96 system_ = pscore_->root_system ();
97 context ()->set_property ("rootSystem", system_->self_scm ());
99 Engraver_group::initialize ();
103 Score_engraver::connect_to_context (Context *c)
105 Engraver_group::connect_to_context (c);
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"));
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.
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
128 Score_engraver::disconnect_from_context ()
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"));
135 Engraver_group::disconnect_from_context ();
139 Score_engraver::finalize ()
141 Engraver_group::finalize ();
147 Score_engraver::one_time_step (SCM)
149 if (!to_boolean (context ()->get_property ("skipTypesetting")))
151 precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
152 Engraver_group::do_announces ();
155 precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
160 Score_engraver::announce_grob (Grob_info info, Direction start_end, Context *reroute_context)
162 Engraver_group::announce_grob (info, start_end, reroute_context);
163 if (start_end == START)
165 pscore_->root_system ()->typeset_grob (info.grob ());
166 elems_.push_back (info.grob ());
171 Score_engraver::typeset_all ()
173 for (vsize i = 0; i < elems_.size (); i++)
175 Grob *elem = elems_[i];
177 if (!elem->get_parent (Y_AXIS))
178 Axis_group_interface::add_element (system_, elem);
183 ADD_TRANSLATOR_GROUP (Score_engraver,
185 "The top-level engraver. Takes care of generating"
186 " columns and the complete system (i.e.,"
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).",
202 "currentMusicalColumn "
203 "currentCommandColumn ",