-/*
- volta-engraver.cc -- implement Volta_engraver
-
+/*
+ volta-engraver.cc -- implement Volta_engraver
+
source file of the GNU LilyPond music typesetter
-
- (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+
+ (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "engraver.hh"
-#include "translator-group.hh"
-#include "volta-spanner.hh"
-#include "item.hh"
+
+#include "bar-line.hh"
+#include "context.hh"
+#include "international.hh"
#include "note-column.hh"
-#include "bar.hh"
#include "side-position-interface.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
{
public:
- Volta_engraver();
- VIRTUAL_COPY_CONS(Translator);
+ TRANSLATOR_DECLARATIONS (Volta_engraver);
protected:
- virtual void acknowledge_grob (Grob_info);
+ DECLARE_ACKNOWLEDGER (staff_symbol);
+ DECLARE_ACKNOWLEDGER (note_column);
+ DECLARE_ACKNOWLEDGER (bar_line);
+
virtual void finalize ();
- virtual void stop_translation_timestep ();
- virtual void process_music ();
- virtual void create_grobs ();
-
+ virtual void derived_mark () const;
+ void stop_translation_timestep ();
+ void process_music ();
+
Moment started_mom_;
- Spanner *volta_span_p_;
- Spanner *end_volta_span_p_;
+ Spanner *volta_span_;
+ Spanner *end_volta_span_;
+ SCM staff_;
+ SCM start_string_;
- SCM start_str_;
+ bool staff_eligible ();
};
-ADD_THIS_TRANSLATOR(Volta_engraver);
+void
+Volta_engraver::derived_mark () const
+{
+ scm_gc_mark (staff_);
+ scm_gc_mark (start_string_);
+}
Volta_engraver::Volta_engraver ()
{
- volta_span_p_ = 0;
- end_volta_span_p_ = 0;
+ staff_ = SCM_EOL;
+ start_string_ = SCM_EOL;
+ volta_span_ = 0;
+ end_volta_span_ = 0;
}
+/*
+ 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 ()
+{
+ 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.
+ Maybe 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 ("volta engraver can't find staffs");
+ return false;
+ }
+ else if (scm_car (scm_last_pair (staffs)) != staff_)
+ return false;
+ return true;
+}
void
Volta_engraver::process_music ()
{
SCM cs = get_property ("repeatCommands");
- bool end = false;
- start_str_ = SCM_EOL;
- while (gh_pair_p (cs))
+ if (!staff_eligible ())
+ return;
+
+ bool end = false;
+ start_string_ = SCM_EOL;
+ while (scm_is_pair (cs))
{
- SCM c = gh_car (cs);
+ SCM c = scm_car (cs);
- if (gh_pair_p (c) && gh_car (c) == ly_symbol2scm ("volta"))
+ if (scm_is_pair (c)
+ && scm_car (c) == ly_symbol2scm ("volta")
+ && scm_is_pair (scm_cdr (c)))
{
- if (gh_cadr (c) == SCM_BOOL_F)
+ if (scm_cadr (c) == SCM_BOOL_F)
end = true;
else
- start_str_ = gh_cadr (c);
+ start_string_ = scm_cadr (c);
}
-
- cs = gh_cdr (cs);
+
+ cs = scm_cdr (cs);
}
- if (volta_span_p_)
+ if (volta_span_)
{
SCM l (get_property ("voltaSpannerDuration"));
Moment now = now_mom ();
-
+
bool early_stop = unsmob_moment (l)
&& *unsmob_moment (l) <= now - started_mom_;
-
+
end = end || early_stop;
}
-
- if (end && !volta_span_p_)
+ if (end && !volta_span_)
+ /* fixme: be more verbose. */
+ warning (_ ("can't end volta spanner"));
+ else if (end)
{
- warning (_("No volta spanner to end")); // fixme: be more verbose.
+ end_volta_span_ = volta_span_;
+ volta_span_ = 0;
}
- else if (end)
+
+ if (volta_span_
+ && (scm_is_string (start_string_) || scm_is_pair (start_string_)))
{
- end_volta_span_p_ = volta_span_p_;
- volta_span_p_ =0;
+ warning (_ ("already have a volta spanner, ending that one prematurely"));
- /*
- maybe do typeset_grob () directly?
- */
+ if (end_volta_span_)
+ {
+ warning (_ ("also already have an ended spanner"));
+ warning (_ ("giving up"));
+ return;
+ }
- if (!gh_string_p (start_str_))
- end_volta_span_p_->set_grob_property ("last-volta", SCM_BOOL_T);
+ end_volta_span_ = volta_span_;
+ volta_span_ = 0;
}
- if (gh_string_p (start_str_) && volta_span_p_)
+ if (!volta_span_
+ && Text_interface::is_markup (start_string_))
{
- warning (_ ("Already have a volta spanner. Stopping that one prematurely."));
-
- if (end_volta_span_p_)
- {
- warning (_("Also have a stopped spanner. Giving up."));
- return ;
- }
+ started_mom_ = now_mom ();
- end_volta_span_p_ = volta_span_p_;
- volta_span_p_ = 0;
+ volta_span_ = make_spanner ("VoltaBracket", SCM_EOL);
+
+ volta_span_->set_property ("text", start_string_);
}
}
-/*
- this could just as well be done in process_music (), but what the hack.
- */
void
-Volta_engraver::create_grobs ()
+Volta_engraver::acknowledge_note_column (Grob_info i)
{
- if (!volta_span_p_ && gh_string_p (start_str_))
- {
- started_mom_ = now_mom () ;
+ if (volta_span_)
+ Volta_bracket_interface::add_column (volta_span_, i.grob ());
+}
- volta_span_p_ = new Spanner (get_property ("VoltaBracket"));
- Volta_spanner::set_interface (volta_span_p_);
- announce_grob (volta_span_p_,0);
- volta_span_p_->set_grob_property ("text", start_str_);
- }
+void
+Volta_engraver::acknowledge_bar_line (Grob_info i)
+{
+ if (volta_span_)
+ Volta_bracket_interface::add_bar (volta_span_, i.item ());
+ if (end_volta_span_)
+ Volta_bracket_interface::add_bar (end_volta_span_, i.item ());
}
void
-Volta_engraver::acknowledge_grob (Grob_info i)
+Volta_engraver::acknowledge_staff_symbol (Grob_info i)
{
- if (Item* item = dynamic_cast<Item*> (i.elem_l_))
- {
- if (Note_column::has_interface (item))
- {
- if (volta_span_p_)
- Volta_spanner::add_column (volta_span_p_,item);
- if (end_volta_span_p_)
- Volta_spanner::add_column (end_volta_span_p_,item);
- }
- if (Bar::has_interface (item))
- {
- if (volta_span_p_)
- Volta_spanner::add_bar (volta_span_p_, item);
- if (end_volta_span_p_)
- Volta_spanner::add_bar(end_volta_span_p_ , item);
- }
- }
+ /*
+ 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 ();
}
void
Volta_engraver::finalize ()
{
- if (volta_span_p_)
+}
+
+void
+Volta_engraver::stop_translation_timestep ()
+{
+ if (volta_span_ && !staff_eligible ())
{
- typeset_grob(volta_span_p_);
+ /*
+ THIS IS A KLUDGE.
+
+ we need to do this here, because STAFF_ is not initialized yet
+ in the 1st call of process_music ()
+ */
+
+ volta_span_->suicide ();
+ volta_span_ = 0;
}
- if (end_volta_span_p_)
+
+ if (end_volta_span_ && !end_volta_span_->get_bound (RIGHT))
{
- typeset_grob (end_volta_span_p_);
+ Grob *cc = unsmob_grob (get_property ("currentCommandColumn"));
+ Item *ci = dynamic_cast<Item *> (cc);
+ end_volta_span_->set_bound (RIGHT, ci);
}
-}
+ end_volta_span_ = 0;
-
-void
-Volta_engraver::stop_translation_timestep ()
-{
- if (end_volta_span_p_)
+ if (volta_span_ && !volta_span_->get_bound (LEFT))
{
- Side_position::add_staff_support (end_volta_span_p_);
-
- typeset_grob (end_volta_span_p_ );
- end_volta_span_p_ =0;
+ Grob *cc = unsmob_grob (get_property ("currentCommandColumn"));
+ Item *ci = dynamic_cast<Item *> (cc);
+ volta_span_->set_bound (LEFT, ci);
}
}
/*
TODO: should attach volta to paper-column if no bar is found.
- */
+*/
+ADD_ACKNOWLEDGER (Volta_engraver, staff_symbol);
+ADD_ACKNOWLEDGER (Volta_engraver, note_column);
+ADD_ACKNOWLEDGER (Volta_engraver, bar_line);
+ADD_TRANSLATOR (Volta_engraver,
+ /* doc */ "Make volta brackets.",
+ /* create */ "VoltaBracket",
+ /* accept */ "",
+ /* read */ "repeatCommands voltaSpannerDuration stavesFound",
+ /* write */ "");
projects / lilypond.git / blobdiff