/*
- score-grav.cc -- implement Score_engraver
+ score-engraver.cc -- implement Score_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
-#include "super-element.hh"
-#include "line-of-score.hh"
-#include "debug.hh"
+#include "all-font-metrics.hh"
+#include "afm.hh"
+#include "warn.hh"
+#include "main.hh"
+#include "system.hh"
#include "item.hh"
#include "score-engraver.hh"
-#include "p-score.hh"
-#include "musical-request.hh"
-#include "score-column.hh"
-#include "command-request.hh"
-#include "paper-def.hh"
+#include "paper-score.hh"
+#include "paper-column.hh"
+#include "output-def.hh"
+#include "axis-group-interface.hh"
+#include "context-def.hh"
+#include "staff-spacing.hh"
+#include "note-spacing.hh"
+#include "context.hh"
+#include "global-context.hh"
-Score_engraver::Score_engraver()
+
+/*
+ TODO: the column creation logic is rather hairy. Revise it.
+ */
+Score_engraver::Score_engraver ()
{
- break_penalty_i_ = 0;
- scoreline_l_ =0;
- command_column_l_ =0;
- musical_column_l_ =0;
- breaks_i_ =0;
- pscore_p_ = 0;
+ system_ =0;
+ command_column_ =0;
+ musical_column_ =0;
+ breaks_ =0;
+ pscore_ = 0;
}
-
+
void
-Score_engraver::prepare (Moment w)
+Score_engraver::make_columns ()
{
- Global_translator::prepare (w);
- set_columns (new Score_column (w), new Score_column (w));
+ /*
+ ugh.
+ */
+ if (!command_column_)
+ {
+ SCM nmp
+ = updated_grob_properties (context (),
+ ly_symbol2scm ("NonMusicalPaperColumn"));
+
+ Object_key const *key1 = context()->get_grob_key ("NonMusicalPaperColumn");
+
+ SCM pc = updated_grob_properties (context (),
+ ly_symbol2scm ("PaperColumn"));
+ Object_key const *key2 = context()->get_grob_key ("PaperColumn");
+ set_columns (new Paper_column (nmp, key1), new Paper_column (pc, key2));
+
+
+ scm_gc_unprotect_object (key1->self_scm());
+ scm_gc_unprotect_object (key2->self_scm());
+
+ Grob_info i1;
+ i1.grob_ = command_column_;
+ i1.origin_trans_ = this;
- break_penalty_i_ = 0;
- post_move_processing();
-}
+ announce_grob (i1);
-void
-Score_engraver::finish()
-{
- if ((breaks_i_%8))
- *mlog << "[" << breaks_i_ << "]" << flush;
-
- check_removal();
- removal_processing();
+ Grob_info i2;
+ i2.grob_ = musical_column_;
+ i2.origin_trans_ = this;
+
+ announce_grob (i2);
+ }
}
void
-Score_engraver::do_creation_processing()
+Score_engraver::prepare (Moment m)
{
- scoreline_l_ = pscore_p_->line_l_;
- scoreline_l_->set_bounds(LEFT,command_column_l_);
- command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
- Engraver_group_engraver::do_creation_processing();
+ /*
+ TODO: don't make columns when skipTypesetting is true.
+ */
+ make_columns ();
+
+ SCM w = m.smobbed_copy ();
+ command_column_->set_property ("when", w);
+ musical_column_->set_property ("when", w);
+
+ recurse_over_translators (context (), &Translator::start_translation_timestep, DOWN);
}
void
-Score_engraver::do_removal_processing()
+Score_engraver::finish ()
{
- Engraver_group_engraver::do_removal_processing();
- scoreline_l_->set_bounds(RIGHT,command_column_l_);
- command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
+ if ((breaks_%8))
+ progress_indication ("[" + to_string (breaks_) + "]");
- typeset_all ();
- set_columns (0,0);
+ recurse_over_translators (context (), &Translator::finalize, UP);
}
+/*
+ use start/finish?
+ */
void
-Score_engraver::process()
+Score_engraver::initialize ()
{
- process_requests();
- do_announces();
- pre_move_processing();
- check_removal();
+ Font_metric *fm = all_fonts_global->find_afm ("feta20");
+ if (!fm)
+ error (_f ("can't find `%s'", "feta20.afm")
+ + "\n" +_ ("Music font has not been installed properly. Aborting"));
+
+ SCM pfa_path = ly_kpathsea_expand_path (scm_makfrom0str ("ecrm10.pfa"));
+ if (!scm_is_string (pfa_path))
+ error (_f ("can't find `%s'", "ecrm10.pfa")
+ + "\n" +_f ("Install the ec-mftraced package from %s. Aborting",
+ "http://lilypond.org/download/fonts/"));
+
+
+ pscore_ = new Paper_score;
+ pscore_->layout_ = dynamic_cast<Output_def*> (get_output_def ());
+
+ SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
+
+ Object_key const *sys_key = context()->get_grob_key ("System");
+ pscore_->typeset_line (new System (props, sys_key));
+ scm_gc_unprotect_object (sys_key->self_scm ());
+
+ make_columns ();
+ system_ = pscore_->system_;
+ system_->set_bound (LEFT, command_column_);
+ command_column_->set_property ("breakable", SCM_BOOL_T);
+
+ Engraver_group_engraver::initialize ();
}
+
void
-Score_engraver::announce_element (Score_element_info info)
+Score_engraver::finalize ()
{
- announce_info_arr_.push (info);
- info.origin_grav_l_arr_.push (this);
+ Score_translator::finalize ();
+
+ Grob * cc
+ = unsmob_grob (get_property ("currentCommandColumn"));
+ system_->set_bound (RIGHT, cc);
+ cc->set_property ("breakable", SCM_BOOL_T);
+
+ typeset_all ();
}
+
void
-Score_engraver::do_announces()
+Score_engraver::one_time_step ()
{
- /* All elements are propagated to the top upon announcement. If
- something was created during one run of
- Engraver_group_engraver::do_announces, then
- announce_info_arr_.size() will be nonzero again
-
- */
- while (announce_info_arr_.size())
+ if (!to_boolean (get_property ("skipTypesetting")))
{
- for (int i=0; i < announce_info_arr_.size(); i++)
- /*
- TODO
-
- More subtle spacing
- */
- if (announce_info_arr_[i].req_l_)
- {
- if (Rhythmic_req *rq = dynamic_cast <Rhythmic_req *> (announce_info_arr_[i].req_l_))
- {
- musical_column_l_->add_duration (rq->length_mom ());
- }
- }
+ recurse_over_translators (context (), &Engraver::process_music, UP);
Engraver_group_engraver::do_announces();
}
+
+ recurse_over_translators (context (), &Translator::stop_translation_timestep, UP);
}
-
void
-Score_engraver::typeset_element (Score_element *elem_p)
+Score_engraver::announce_grob (Grob_info info)
{
- elem_p_arr_.push (elem_p);
+ announce_infos_.push (info);
+ pscore_->system_->typeset_grob (info.grob_);
+ elems_.push (info.grob_);
}
void
-Score_engraver::typeset_all()
+Score_engraver::typeset_all ()
{
- for (int i =0; i < elem_p_arr_.size(); i++)
+ for (int i =0; i < elems_.size (); i++)
{
- Score_element * elem_p = elem_p_arr_[i];
- if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
- {
- pscore_p_->typeset_unbroken_spanner (s);
-
- /*
- do something sensible if spanner not
- spanned on 2 items.
- */
- Direction d = LEFT;
- do {
- if (!s->spanned_drul_[d])
- {
- s->set_bounds(d, command_column_l_);
- ::warning (_f ("Unbound spanner `%s\'", classname(s)));
- }
- } while (flip(&d) != LEFT);
- }
- else
+ Grob * elem = elems_[i];
+
+
+ if (dynamic_cast<Item*> (elem))
{
- Item *item_p = dynamic_cast <Item *> (elem_p);
- pscore_p_->typeset_element (item_p);
- if (!item_p->parent_l (X_AXIS))
+ if (!elem->get_parent (X_AXIS)
+ && elem != command_column_
+ && elem != musical_column_
+ )
{
- bool br = (item_p->remove_elt_property (breakable_scm_sym) != SCM_BOOL_F);
- if (br)
- command_column_l_->add_element(item_p);
- else
- musical_column_l_->add_element(item_p);
+ bool br = to_boolean (elem->get_property ("breakable"));
+ Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
+
}
}
- if (!elem_p->dim_cache_[Y_AXIS].parent_l_)
- scoreline_l_->add_element (elem_p);
+ if (!elem->get_parent (Y_AXIS))
+ Axis_group_interface::add_element (system_, elem);
}
- elem_p_arr_.clear();
+ elems_.clear ();
}
void
-Score_engraver::do_pre_move_processing()
+Score_engraver::stop_translation_timestep ()
{
- if (break_penalty_i_ > Break_req::DISALLOW)
+ // this generates all items.
+ Engraver_group_engraver::stop_translation_timestep ();
+
+ typeset_all ();
+ if (to_boolean (command_column_->get_property ("breakable")))
{
- command_column_l_->set_elt_property (breakable_scm_sym, SCM_BOOL_T);
- breaks_i_ ++;
- if (! (breaks_i_%8))
- *mlog << "[" << breaks_i_ << "]" << flush;
+ breaks_ ++;
+ if (! (breaks_%8))
+ progress_indication ("[" + to_string (breaks_) + "]");
}
- // this generates all items.
- Engraver_group_engraver::do_pre_move_processing();
+
+
+ system_->add_column (command_column_);
+ system_->add_column (musical_column_);
- typeset_all();
+ command_column_ = 0;
+ musical_column_ = 0;
}
void
-Score_engraver::set_columns (Score_column *new_command_l,
- Score_column *new_musical_l)
+Score_engraver::set_columns (Paper_column *new_command,
+ Paper_column *new_musical)
{
- if (command_column_l_ && command_column_l_->linked_b())
- {
- pscore_p_->add_column (command_column_l_);
- scoreline_l_->add_column (command_column_l_);
- }
- else
- {
- delete command_column_l_ ;
- command_column_l_ =0;
- }
- if (new_command_l)
- {
- command_column_l_ = new_command_l;
- command_column_l_->musical_b_ = false;
- }
- if (musical_column_l_ && musical_column_l_->linked_b())
- {
- pscore_p_->add_column (musical_column_l_);
- scoreline_l_->add_column (musical_column_l_);
- }
- else
+ assert (!command_column_ && !musical_column_);
+
+ command_column_ = new_command;
+ musical_column_ = new_musical;
+ if (new_command)
{
- delete musical_column_l_;
- musical_column_l_ = 0;
+ context ()->set_property ("currentCommandColumn", new_command->self_scm ());
}
- if (new_musical_l)
+ if (new_musical)
{
- musical_column_l_ = new_musical_l;
- musical_column_l_->musical_b_ = true;
+ context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
}
}
+Music_output*
+Score_engraver::get_output ()
+{
+ Music_output *o = pscore_;
+ ///FIXME WTF? pscore_ = 0;
+ return o;
+}
-Staff_info
-Score_engraver::get_staff_info() const
+bool
+Score_engraver::try_music (Music *m)
{
- Staff_info inf = Engraver_group_engraver::get_staff_info();
+ if (Engraver_group_engraver::try_music (m))
+ return true;
- inf.command_l_ = command_column_l_;
- inf.musical_l_ = musical_column_l_;
-
- return inf;
+ if (m->is_mus_type ("break-event"))
+ {
+ SCM pen = command_column_->get_property ("penalty");
+ Real total_penalty = scm_is_number (pen) ? scm_to_double (pen) : 0.0;
+
+ SCM mpen = m->get_property ("penalty");
+ if (scm_is_number (mpen))
+ total_penalty += scm_to_double (mpen);
+
+ command_column_->set_property ("penalty", scm_make_real (total_penalty));
+
+ /* ugh. arbitrary, hardcoded */
+ if (total_penalty > 10000.0)
+ forbid_breaks ();
+
+ SCM page_pen = command_column_->get_property ("page-penalty");
+ Real total_pp = scm_is_number (page_pen) ? scm_to_double (page_pen) : 0.0;
+ SCM mpage_pen = m->get_property ("page-penalty");
+ if (scm_is_number (mpage_pen))
+ total_pp += scm_to_double (mpage_pen);
+
+ command_column_->set_property ("page-penalty", scm_make_real (total_pp));
+ return true;
+ }
+ return false;
}
-
-Music_output*
-Score_engraver::get_output_p ()
+void
+Score_engraver::forbid_breaks ()
{
- Music_output * o = pscore_p_;
- pscore_p_=0;
- return o;
+ if (command_column_)
+ command_column_->set_property ("breakable", SCM_EOL);
}
-
-bool
-Score_engraver::do_try_music (Music*r)
+
+void
+Score_engraver::acknowledge_grob (Grob_info gi)
{
- bool gotcha = Engraver_group_engraver::do_try_music (r);
+ if (Staff_spacing::has_interface (gi.grob_))
+ {
+ Pointer_group_interface::add_grob (command_column_,
+ ly_symbol2scm ("spacing-wishes"),
+ gi.grob_);
+ }
+ if (Note_spacing::has_interface (gi.grob_))
+ {
+ Pointer_group_interface::add_grob (musical_column_,
+ ly_symbol2scm ("spacing-wishes"),
+ gi.grob_);
+ }
- if (!gotcha)
+ if (Axis_group_interface::has_interface (gi.grob_)
+ && gi.grob_->internal_has_interface (ly_symbol2scm ("vertically-spaceable-interface")))
{
- if (Break_req* b = dynamic_cast<Break_req *> (r))
+ SCM spaceable = get_property ("verticallySpacedContexts");
+ Context *orig = gi.origin_contexts (this)[0];
+
+ if (scm_memq (ly_symbol2scm (orig->context_name ().to_str0()),
+ spaceable) != SCM_BOOL_F)
{
- if (b->penalty_i_ <= Break_req::DISALLOW)
- break_penalty_i_ = b->penalty_i_;
- else if (b->penalty_i_ >= Break_req::FORCE)
- {
- command_column_l_->break_penalty_i_ = b->penalty_i_;
- gotcha = true;
- }
+ Pointer_group_interface::add_grob (system_,
+ ly_symbol2scm ("spaceable-staves"),
+ gi.grob_);
}
}
- return gotcha;
-
+
}
-ADD_THIS_TRANSLATOR(Score_engraver);
-void
-Score_engraver::do_add_processing ()
-{
- Translator_group::do_add_processing ();
- 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_);
-}
+ENTER_DESCRIPTION (Score_engraver,
+/* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System) "
+"\n\n "
+"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",
+/* accepts */ "break-event",
+/* acks */ "note-spacing-interface staff-spacing-interface axis-group-interface",
+/* reads */ "currentMusicalColumn currentCommandColumn verticallySpacedContexts",
+/* write */ "");
projects / lilypond.git / blobdiff