/*
- volta-engraver.cc -- implement Volta_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2000--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2000--2005 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.
+
+ 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 "engraver.hh"
+
+#include "axis-group-interface.hh"
#include "context.hh"
-#include "volta-bracket.hh"
+#include "grob-array.hh"
+#include "international.hh"
#include "note-column.hh"
-#include "bar-line.hh"
+#include "item.hh"
#include "side-position-interface.hh"
-#include "warn.hh"
#include "staff-symbol.hh"
+#include "text-interface.hh"
+#include "volta-bracket.hh"
+#include "warn.hh"
+
+#include "translator.icc"
/*
Create Volta spanners, by reading repeatCommands property, usually
- set by Unfolded_repeat_iterator.
+ set by Volta_repeat_iterator.
*/
class Volta_engraver : public Engraver
{
TRANSLATOR_DECLARATIONS (Volta_engraver);
protected:
- virtual void acknowledge_grob (Grob_info);
- virtual void finalize ();
- virtual void stop_translation_timestep ();
- virtual void process_music ();
+ void acknowledge_bar_line (Grob_info);
+
+ virtual void derived_mark () const;
+ void stop_translation_timestep ();
+ void process_music ();
Moment started_mom_;
- Spanner *volta_span_;
- Spanner *end_volta_span_;
- SCM staff_;
+ Spanner *volta_bracket_;
+ Spanner *end_volta_bracket_;
+ Spanner *volta_spanner_;
SCM start_string_;
-
- bool staff_eligible ();
-
};
-Volta_engraver::Volta_engraver ()
+void
+Volta_engraver::derived_mark () const
{
- staff_ = SCM_EOL;
- volta_span_ = 0;
- end_volta_span_ = 0;
+ scm_gc_mark (start_string_);
}
-/*
- TODO: this logic should be rewritten, it is buggy.
-
- One of the problems is that we can't determine wether or not to
- print the volta bracket during the first step, since that requires
- acknowledging the staff.
-*/
-bool
-Volta_engraver::staff_eligible ()
+Volta_engraver::Volta_engraver (Context *c)
+ : Engraver (c)
{
- SCM doit = get_property ("voltaOnThisStaff");
- if (scm_is_bool (doit))
- {
- return to_boolean (doit);
- }
-
- if (!unsmob_grob (staff_))
- return false;
-
- /*
- TODO: this does weird things when you open a piece with a
- volta spanner.
- */
- SCM staffs = get_property ("stavesFound");
-
- /*
- only put a volta on the top staff.
-
- May be this is a bit convoluted, and we should have a single
- volta engraver in score context or somesuch.
-
- */
- if (!scm_is_pair (staffs))
- {
- programming_error ("Huh? Volta engraver can't find staffs?");
- return false;
- }
- else if (scm_car (scm_last_pair (staffs)) != staff_)
- {
- return false;
- }
- return true;
+ start_string_ = SCM_EOL;
+ volta_bracket_ = 0;
+ end_volta_bracket_ = 0;
+ volta_spanner_ = 0;
}
void
{
SCM cs = get_property ("repeatCommands");
- if (!staff_eligible ())
- return;
-
bool end = false;
start_string_ = SCM_EOL;
while (scm_is_pair (cs))
SCM c = scm_car (cs);
if (scm_is_pair (c)
- && scm_car (c) == ly_symbol2scm ("volta")
- && scm_is_pair (scm_cdr (c)))
- {
- if (scm_cadr (c) == SCM_BOOL_F)
- end = true;
- else
- start_string_ = scm_cadr (c);
- }
+ && scm_is_eq (scm_car (c), ly_symbol2scm ("volta"))
+ && scm_is_pair (scm_cdr (c)))
+ {
+ if (scm_is_false (scm_cadr (c)))
+ end = true;
+ else
+ start_string_ = scm_cadr (c);
+ }
cs = scm_cdr (cs);
}
- if (volta_span_)
+ if (volta_bracket_)
{
SCM l (get_property ("voltaSpannerDuration"));
Moment now = now_mom ();
- bool early_stop = unsmob_moment (l)
- && *unsmob_moment (l) <= now - started_mom_;
+ bool early_stop = unsmob<Moment> (l)
+ && *unsmob<Moment> (l) <= now - started_mom_;
end = end || early_stop;
}
- if (end && !volta_span_)
- {
- warning (_ ("No volta spanner to end")); // fixme: be more verbose.
- }
+ if (end && !volta_bracket_)
+ /* fixme: be more verbose. */
+ warning (_ ("cannot end volta spanner"));
else if (end)
{
- end_volta_span_ = volta_span_;
- volta_span_ = 0;
+ end_volta_bracket_ = volta_bracket_;
+ volta_bracket_ = 0;
}
- if (volta_span_
+ if (volta_bracket_
&& (scm_is_string (start_string_) || scm_is_pair (start_string_)))
{
- warning (_ ("Already have a volta spanner. Stopping that one prematurely."));
+ warning (_ ("already have a volta spanner, ending that one prematurely"));
- if (end_volta_span_)
- {
- warning (_ ("Also have a stopped spanner. Giving up."));
- return;
- }
+ if (end_volta_bracket_)
+ {
+ warning (_ ("also already have an ended spanner"));
+ warning (_ ("giving up"));
+ return;
+ }
- end_volta_span_ = volta_span_;
- volta_span_ = 0;
+ end_volta_bracket_ = volta_bracket_;
+ volta_bracket_ = 0;
}
- if (!volta_span_
- && (scm_is_string (start_string_) || scm_is_pair (start_string_)))
+ if (!volta_bracket_
+ && Text_interface::is_markup (start_string_))
{
started_mom_ = now_mom ();
- volta_span_ = make_spanner ("VoltaBracket", SCM_EOL);
+ volta_bracket_ = make_spanner ("VoltaBracket", SCM_EOL);
- volta_span_->set_property ("text", start_string_);
- }
-}
+ volta_bracket_->set_property ("text", start_string_);
-void
-Volta_engraver::acknowledge_grob (Grob_info i)
-{
- if (Item *item = dynamic_cast<Item *> (i.grob_))
- {
- if (Note_column::has_interface (item))
- {
- if (volta_span_)
- Volta_bracket_interface::add_column (volta_span_, item);
- }
- if (Bar_line::has_interface (item))
- {
- if (volta_span_)
- Volta_bracket_interface::add_bar (volta_span_, item);
- if (end_volta_span_)
- Volta_bracket_interface::add_bar (end_volta_span_, item);
- }
- }
- else if (Staff_symbol::has_interface (i.grob_))
- {
- /*
- We only want to know about a single staff: then we add to the
- support. */
- if (staff_ != SCM_EOL)
- staff_ = SCM_UNDEFINED;
-
- if (staff_ != SCM_UNDEFINED)
- staff_ = i.grob_->self_scm ();
+ if (!volta_spanner_)
+ volta_spanner_ = make_spanner ("VoltaBracketSpanner", SCM_EOL);
+
+ Axis_group_interface::add_element (volta_spanner_, volta_bracket_);
}
}
void
-Volta_engraver::finalize ()
+Volta_engraver::acknowledge_bar_line (Grob_info i)
{
+ if (volta_bracket_)
+ Volta_bracket_interface::add_bar (volta_bracket_, i.item ());
+ if (end_volta_bracket_)
+ Volta_bracket_interface::add_bar (end_volta_bracket_, i.item ());
+
+ if (volta_spanner_)
+ Side_position_interface::add_support (volta_spanner_, i.grob ());
}
void
Volta_engraver::stop_translation_timestep ()
{
- if (volta_span_ && !staff_eligible ())
- {
- /*
- THIS IS A KLUDGE.
+ Grob *cc = unsmob<Grob> (get_property ("currentCommandColumn"));
+ Item *ci = dynamic_cast<Item *> (cc);
- we need to do this here, because STAFF_ is not initialized yet
- in the 1st call of process_music ()
- */
+ if (end_volta_bracket_ && !end_volta_bracket_->get_bound (RIGHT))
+ end_volta_bracket_->set_bound (RIGHT, ci);
- volta_span_->suicide ();
- volta_span_ = 0;
- }
+ if (volta_spanner_ && end_volta_bracket_)
+ volta_spanner_->set_bound (RIGHT, end_volta_bracket_->get_bound (RIGHT));
- if (end_volta_span_ && !end_volta_span_->get_bound (RIGHT))
+ if (end_volta_bracket_ && !volta_bracket_)
{
- Grob *cc = unsmob_grob (get_property ("currentCommandColumn"));
- Item *ci = dynamic_cast<Item *> (cc);
- end_volta_span_->set_bound (RIGHT, ci);
+ for (SCM s = get_property ("stavesFound"); scm_is_pair (s); s = scm_cdr (s))
+ Side_position_interface::add_support (volta_spanner_, unsmob<Grob> (scm_car (s)));
+ volta_spanner_ = 0;
}
- end_volta_span_ = 0;
+ end_volta_bracket_ = 0;
- if (volta_span_ && !volta_span_->get_bound (LEFT))
- {
- Grob *cc = unsmob_grob (get_property ("currentCommandColumn"));
- Item *ci = dynamic_cast<Item *> (cc);
- volta_span_->set_bound (LEFT, ci);
- }
+ if (volta_bracket_ && !volta_bracket_->get_bound (LEFT))
+ volta_bracket_->set_bound (LEFT, ci);
+ if (volta_spanner_ && volta_bracket_ && !volta_spanner_->get_bound (LEFT))
+ volta_spanner_->set_bound (LEFT, volta_bracket_->get_bound (LEFT));
}
/*
TODO: should attach volta to paper-column if no bar is found.
*/
+void
+Volta_engraver::boot ()
+{
+ ADD_ACKNOWLEDGER (Volta_engraver, bar_line);
+}
ADD_TRANSLATOR (Volta_engraver,
- /* descr */ "Make volta brackets.",
- /* creats*/ "VoltaBracket",
- /* accepts */ "",
- /* acks */ "bar-line-interface staff-symbol-interface note-column-interface",
- /* reads */ "repeatCommands voltaSpannerDuration stavesFound",
- /* write */ "");
+ /* doc */
+ "Make volta brackets.",
+
+ /* create */
+ "VoltaBracket "
+ "VoltaBracketSpanner ",
+
+ /* read */
+ "repeatCommands "
+ "voltaSpannerDuration "
+ "stavesFound ",
+
+ /* write */
+ ""
+ );