/*
- score-engraver.cc -- implement Score_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
-#include "debug.hh"
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
-#include "system.hh"
-#include "item.hh"
#include "score-engraver.hh"
-#include "paper-score.hh"
-#include "paper-column.hh"
-#include "command-request.hh"
-#include "paper-def.hh"
-#include "axis-group-interface.hh"
-#include "translator-def.hh"
-#include "staff-spacing.hh"
-#include "note-spacing.hh"
+#include "all-font-metrics.hh"
+#include "axis-group-interface.hh"
+#include "context-def.hh"
+#include "dispatcher.hh"
+#include "global-context.hh"
+#include "grob-properties.hh"
+#include "international.hh"
+#include "main.hh"
+#include "open-type-font.hh"
+#include "output-def.hh"
+#include "paper-column-engraver.hh"
+#include "paper-column.hh"
+#include "paper-score.hh"
+#include "system.hh"
+#include "warn.hh"
-/*
- TODO: the column creation logic is rather hairy. Revise it.
- */
Score_engraver::Score_engraver ()
{
- scoreline_l_ =0;
- command_column_l_ =0;
- musical_column_l_ =0;
- breaks_i_ =0;
- pscore_p_ = 0;
+ system_ = 0;
+ pscore_ = 0;
}
void
-Score_engraver::make_columns ()
+Score_engraver::derived_mark () const
{
- /*
- ugh.
- */
- if (!command_column_l_)
- {
- set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
- new Paper_column (get_property ("PaperColumn")));
-
- command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
-
- Grob_info i1 (command_column_l_);
- i1.origin_trans_l_ = this;
-
- Grob_info i2 (musical_column_l_);
- i2.origin_trans_l_ = this;
-
- announce_grob (i1);
- announce_grob (i2);
- }
+ if (pscore_)
+ scm_gc_mark (pscore_->self_scm ());
+ Engraver_group::derived_mark ();
}
void
-Score_engraver::prepare (Moment w)
+Score_engraver::prepare (SCM)
{
- Global_translator::prepare (w);
-
- make_columns ();
-
- command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
- musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
-
- start_translation_timestep ();
+ precomputed_recurse_over_translators (context (), START_TRANSLATION_TIMESTEP, DOWN);
}
void
-Score_engraver::finish ()
+Score_engraver::finish (SCM)
{
- if ((breaks_i_%8))
- progress_indication ("[" + to_str (breaks_i_) + "]");
-
- check_removal ();
- removal_processing ();
-
+ recurse_over_translators
+ (context (),
+ Callback0_wrapper::make_smob<Translator, &Translator::finalize> (),
+ Callback0_wrapper::make_smob<Translator_group, &Translator_group::finalize> (),
+ UP);
}
+#define MUSIC_FONT "emmentaler-20"
+
/*
use start/finish?
- */
+*/
void
Score_engraver::initialize ()
{
- unsmob_translator_def (definition_)->apply_property_operations (this);
+ Font_metric *fm = all_fonts_global->find_otf (MUSIC_FONT);
+ if (!fm)
+ {
+ error (_f ("cannot find `%s'", MUSIC_FONT ".otf")
+ + "\n"
+ + _ ("Music font has not been installed properly.")
+ + "\n"
+ + _f ("Search path `%s'", global_path.to_string ().c_str ())
+ + "\n"
+ + _ ("Aborting"));
+ }
- assert (dynamic_cast<Paper_def *> (output_def_l_));
- assert (!daddy_trans_l_);
- pscore_p_ = new Paper_score;
- pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
+ pscore_ = new Paper_score (dynamic_cast<Output_def *> (context ()->get_output_def ()));
+ pscore_->unprotect ();
+ context ()->set_property ("output", pscore_->self_scm ());
- SCM props = get_property ("System");
+ SCM props = Grob_property_info (context (), ly_symbol2scm ("System")).updated ();
- pscore_p_->typeset_line (new System (props));
-
- make_columns ();
- scoreline_l_ = pscore_p_->line_l_;
- scoreline_l_->set_bound (LEFT, command_column_l_);
- command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
+ pscore_->typeset_system (new System (props));
- Engraver_group_engraver::initialize ();
-}
+ system_ = pscore_->root_system ();
+ context ()->set_property ("rootSystem", system_->self_scm ());
-
-void
-Score_engraver::finalize ()
-{
- Engraver_group_engraver::finalize ();
-
- Grob * cc
- = unsmob_grob (get_property ("currentCommandColumn"));
- scoreline_l_->set_bound (RIGHT, cc);
- cc->set_grob_property ("breakable", SCM_BOOL_T);
-
- typeset_all ();
+ Engraver_group::initialize ();
}
void
-Score_engraver::one_time_step ()
+Score_engraver::connect_to_context (Context *c)
{
- if (!to_boolean (get_property ("skipTypesetting")))
- {
- process_music ();
- announces ();
- }
-
- stop_translation_timestep ();
- check_removal ();
-}
+ Engraver_group::connect_to_context (c);
-void
-Score_engraver::announce_grob (Grob_info info)
-{
- announce_info_arr_.push (info);
- pscore_p_->line_l_->typeset_grob (info.grob_l_);
+ Dispatcher *d = c->get_global_context ()->event_source ();
+ d->add_listener (GET_LISTENER (Score_engraver, one_time_step), ly_symbol2scm ("OneTimeStep"));
+ d->add_listener (GET_LISTENER (Score_engraver, prepare), ly_symbol2scm ("Prepare"));
+ d->add_listener (GET_LISTENER (Score_engraver, finish), ly_symbol2scm ("Finish"));
}
+/*
+ uncovered:
+
+ check_removal always returns false for Score contexts, it has been that way
+since I joined the project. There is a reason for this: The typeset score is
+stored in the Score_engraver, which in turn is accessed through the
+Global_context returned by ly:run-translator. So the score-translator must be
+connected to the score-context after run-translator finishes.
+
+I plan to change this: we should junk run-translator, and instead keep track
+of both context and translator in the SCM code, and access the typeset score
+directly via the created global-translator. Then it would be possible to
+disconnect score-translators at iteration time. -es
+ */
void
-Score_engraver::typeset_grob (Grob *elem_p)
+Score_engraver::disconnect_from_context ()
{
- if (!elem_p)
- programming_error ("Score_engraver: empty elt\n");
- else
+ Dispatcher *d = context ()->get_global_context ()->event_source ();
+ d->remove_listener (GET_LISTENER (Score_engraver, one_time_step), ly_symbol2scm ("OneTimeStep"));
+ d->remove_listener (GET_LISTENER (Score_engraver, prepare), ly_symbol2scm ("Prepare"));
+ d->remove_listener (GET_LISTENER (Score_engraver, finish), ly_symbol2scm ("Finish"));
- elem_p_arr_.push (elem_p);
+ Engraver_group::disconnect_from_context ();
}
void
-Score_engraver::typeset_all ()
+Score_engraver::finalize ()
{
- for (int i =0; i < elem_p_arr_.size (); i++)
- {
- Grob * elem_p = elem_p_arr_[i];
-
- if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
- {
- /*
- do something sensible if spanner not
- spanned on 2 items.
- */
- Direction d = LEFT;
- do {
- if (!s->get_bound (d))
- {
- s->set_bound (d, command_column_l_);
- /* don't warn for empty/suicided spanners,
- it makes real warningsinvisible.
- maybe should be junked earlier? */
- if (!elem_p->live())
- ; // gdb hook
- else
- elem_p->warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
- }
- }
- while (flip (&d) != LEFT);
-
- if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
- programming_error ("Spanner Y-parent is an item.");
- }
- else
- {
- if (!elem_p->get_parent (X_AXIS))
- {
- bool br = to_boolean (elem_p->get_grob_property ("breakable"));
- Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
-
- }
- }
- if (!elem_p->get_parent (Y_AXIS))
- Axis_group_interface::add_element (scoreline_l_, elem_p);
- }
- elem_p_arr_.clear ();
-}
+ Engraver_group::finalize ();
-void
-Score_engraver::stop_translation_timestep ()
-{
- // this generates all items.
- Engraver_group_engraver::stop_translation_timestep ();
-
typeset_all ();
- if (to_boolean (command_column_l_->get_grob_property ("breakable")))
- {
- breaks_i_ ++;
- if (! (breaks_i_%8))
- progress_indication ("[" + to_str (breaks_i_) + "]");
- }
-
-
- scoreline_l_->add_column (command_column_l_);
- scoreline_l_->add_column (musical_column_l_);
-
- command_column_l_ = 0;
- musical_column_l_ = 0;
}
void
-Score_engraver::set_columns (Paper_column *new_command_l,
- Paper_column *new_musical_l)
+Score_engraver::one_time_step (SCM)
{
- assert (!command_column_l_ && !musical_column_l_);
-
- command_column_l_ = new_command_l;
- musical_column_l_ = new_musical_l;
- if (new_command_l)
+ if (!to_boolean (context ()->get_property ("skipTypesetting")))
{
- set_property ("currentCommandColumn", new_command_l->self_scm ());
+ precomputed_recurse_over_translators (context (), PROCESS_MUSIC, UP);
+ Engraver_group::do_announces ();
}
-
- if (new_musical_l)
- {
- set_property ("currentMusicalColumn", new_musical_l->self_scm ());
- }
-}
-Music_output*
-Score_engraver::get_output_p ()
-{
- Music_output * o = pscore_p_;
- pscore_p_=0;
- return o;
+ precomputed_recurse_over_translators (context (), STOP_TRANSLATION_TIMESTEP, UP);
+ typeset_all ();
}
-bool
-Score_engraver::try_music (Music*r)
+void
+Score_engraver::announce_grob (Grob_info info, Direction start_end, Context *reroute_context)
{
- bool gotcha = Engraver_group_engraver::try_music (r);
-
- if (!gotcha)
+ Engraver_group::announce_grob (info, start_end, reroute_context);
+ if (start_end == START)
{
- if (Break_req* b = dynamic_cast<Break_req *> (r))
- {
- gotcha = true;
-
-
- SCM pen = command_column_l_->get_grob_property ("penalty");
- Real total_penalty = gh_number_p (pen)
- ? gh_scm2double (pen)
- : 0.0;
-
- SCM rpen = b->get_mus_property ("penalty");
- if (gh_number_p (rpen))
- total_penalty += gh_scm2double (rpen);
-
- if (total_penalty > 10000.0) // ugh. arbitrary.
- forbid_breaks ();
-
- command_column_l_->set_grob_property ("penalty",
- gh_double2scm (total_penalty));
- }
+ pscore_->root_system ()->typeset_grob (info.grob ());
+ elems_.push_back (info.grob ());
}
- return gotcha;
}
-/*
- TODO: use property Score.breakForbidden = #t
- */
-void
-Score_engraver::forbid_breaks ()
-{
- /*
- result is junked.
- */
- command_column_l_->remove_grob_property ("breakable");
-}
-
void
-Score_engraver::acknowledge_grob (Grob_info gi)
+Score_engraver::typeset_all ()
{
- if (Staff_spacing::has_interface (gi.grob_l_))
- {
- Pointer_group_interface::add_grob (command_column_l_,
- ly_symbol2scm ("spacing-wishes"),
- gi.grob_l_);
- }
- if (Note_spacing::has_interface (gi.grob_l_))
+ for (vsize i = 0; i < elems_.size (); i++)
{
- Pointer_group_interface::add_grob (musical_column_l_,
- ly_symbol2scm ("spacing-wishes"),
- gi.grob_l_);
- }
-}
-
-
-
-ENTER_DESCRIPTION(Score_engraver,
-/* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System)
+ Grob *elem = elems_[i];
-
-This engraver decides whether a column is breakable. The default is
-that a column is always breakable. However, when every Bar_engraver
-that does not have a barline at a certain point will call
-Score_engraver::forbid_breaks to stop linebreaks. In practice, this
-means that you can make a breakpoint by creating a barline (assuming
-that there are no beams or notes that prevent a breakpoint.)
-
-
-",
-/* creats*/ "System PaperColumn NonMusicalPaperColumn",
-/* acks */ "note-spacing-interface staff-spacing-interface",
-/* reads */ "currentMusicalColumn currentCommandColumn",
-/* write */ "");
+ if (!elem->get_parent (Y_AXIS))
+ Axis_group_interface::add_element (system_, elem);
+ }
+ elems_.clear ();
+}
+
+ADD_TRANSLATOR_GROUP (Score_engraver,
+ /* doc */
+ "The top-level engraver. Takes care of generating"
+ " columns and the complete system (i.e.,"
+ " @code{System}).\n"
+ "\n"
+ "This engraver decides whether a column is breakable."
+ " The default is that a column is always breakable."
+ " However, every @code{Bar_engraver} that does not have"
+ " a bar line at a certain point sets @code{forbidBreaks}"
+ " to stop line breaks. In practice, this means that you"
+ " can make a break point by creating a bar line"
+ " (assuming that there are no beams or notes that"
+ " prevent a break point).",
+
+ /* create */
+ "System ",
+
+ /* read */
+ "currentMusicalColumn "
+ "currentCommandColumn ",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff