/*
- accidental-engraver.cc -- implement accidental_engraver
+ accidental-engraver.cc -- implement Accidental_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
*/
#include "accidental-placement.hh"
#include "arpeggio.hh"
-#include "spanner.hh"
#include "context.hh"
-#include "item.hh"
+#include "duration.hh"
#include "engraver.hh"
#include "international.hh"
+#include "item.hh"
#include "pitch.hh"
#include "protected-scm.hh"
#include "rhythmic-head.hh"
+#include "separation-item.hh"
#include "side-position-interface.hh"
+#include "spanner.hh"
#include "stream-event.hh"
#include "tie.hh"
#include "warn.hh"
class Accidental_engraver : public Engraver
{
- int get_bar_number ();
void update_local_key_signature (SCM new_signature);
void create_accidental (Accidental_entry *entry, bool, bool);
- Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
+ Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans, bool);
Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
protected:
void acknowledge_arpeggio (Grob_info);
void acknowledge_rhythmic_head (Grob_info);
void acknowledge_finger (Grob_info);
+ void acknowledge_note_column (Grob_info);
void stop_translation_timestep ();
void process_acknowledged ();
vector<Accidental_entry> accidentals_;
vector<Spanner*> ties_;
+ vector<Grob*> note_columns_;
};
/*
|| laziness == SCM_BOOL_T)
return true;
- return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
+ return (bar_number <= scm_to_int (scm_cadr (alteration_def)) + scm_to_int (laziness));
}
static Rational
bool need_acc;
bool need_restore;
- Accidental_result () {
+ Accidental_result ()
+ {
need_restore = need_acc = false;
}
- int score () const {
+ Accidental_result (bool restore, bool acc)
+ {
+ need_restore = restore;
+ need_acc = acc;
+ }
+
+ Accidental_result (SCM scm)
+ {
+ need_restore = to_boolean (scm_car (scm));
+ need_acc = to_boolean (scm_cdr (scm));
+ }
+
+ int score () const
+ {
return need_acc ? 1 : 0
+ need_restore ? 1 : 0;
}
return result;
}
+// TODO: consider moving check_pitch_against_signature to SCM (in which case
+// we can delete this function).
+LY_DEFINE (ly_find_accidentals_simple, "ly:find-accidentals-simple", 5, 0, 0,
+ (SCM keysig, SCM pitch_scm, SCM barnum, SCM laziness, SCM octaveness ),
+ "Checks the need for an accidental and a @q{restore} accidental against a"
+ " key signature. The @var{laziness} is the number of bars for which reminder"
+ " accidentals are used (ie. if @var{laziness} is zero, we only cancel accidentals"
+ " in the same bar; if @var{laziness} is three, we cancel accidentals up to three"
+ " bars after they first appear. @var{octaveness} is either"
+ " @code{'same-octave} or @code{'any-octave} and it specifies whether"
+ " accidentals should be canceled in different octaves.")
+{
+ LY_ASSERT_TYPE (unsmob_pitch, pitch_scm, 2);
+ LY_ASSERT_TYPE (scm_is_integer, barnum, 3);
+ LY_ASSERT_TYPE (ly_is_symbol, octaveness, 5);
+
+ bool symbol_ok = octaveness == ly_symbol2scm ("any-octave") ||
+ octaveness == ly_symbol2scm ("same-octave");
+
+ SCM_ASSERT_TYPE (symbol_ok, octaveness, SCM_ARG5, __FUNCTION__, "'any-octave or 'same-octave");
+
+ Pitch *pitch = unsmob_pitch (pitch_scm);
+
+ int bar_number = scm_to_int (barnum);
+ bool ignore_octave = ly_symbol2scm ("any-octave") == octaveness;
+ Accidental_result result = check_pitch_against_signature (keysig, *pitch, bar_number,
+ laziness, ignore_octave);
+
+ return scm_cons (scm_from_bool (result.need_restore), scm_from_bool (result.need_acc));
+}
+
static
Accidental_result
check_pitch_against_rules (Pitch const &pitch, Context *origin,
- SCM rules, int bar_number)
+ SCM rules, int bar_number, SCM measurepos)
{
Accidental_result result;
+ SCM pitch_scm = pitch.smobbed_copy ();
+ SCM barnum_scm = scm_from_int (bar_number);
+
if (scm_is_pair (rules) && !scm_is_symbol (scm_car (rules)))
warning (_f ("accidental typesetting list must begin with context-name: %s",
ly_scm2string (scm_car (rules)).c_str ()));
rules = scm_cdr (rules))
{
SCM rule = scm_car (rules);
- if (scm_is_pair (rule))
+ if (ly_is_procedure (rule))
{
- SCM type = scm_car (rule);
- SCM laziness = scm_cdr (rule);
- SCM localsig = origin->get_property ("localKeySignature");
-
- bool same_octave
- = (ly_symbol2scm ("same-octave") == type);
- bool any_octave
- = (ly_symbol2scm ("any-octave") == type);
+ SCM rule_result_scm = scm_call_4 (rule, origin->self_scm (),
+ pitch_scm, barnum_scm, measurepos);
- if (same_octave || any_octave)
- {
- Accidental_result rule_result = check_pitch_against_signature
- (localsig, pitch, bar_number, laziness, any_octave);
+ Accidental_result rule_result (rule_result_scm);
- result.need_acc |= rule_result.need_acc;
- result.need_restore |= rule_result.need_restore;
- }
- else
- warning (_f ("ignoring unknown accidental rule: %s",
- ly_symbol2string (type).c_str ()));
+ result.need_acc |= rule_result.need_acc;
+ result.need_restore |= rule_result.need_restore;
}
/* if symbol then it is a context name. Scan parent contexts to
origin = dad;
}
else
- warning (_f ("pair or context-name expected for accidental rule, found %s",
- ly_scm2string (rule).c_str ()));
+ warning (_f ("procedure or context-name expected for accidental rule, found %s",
+ print_scm_val (rule).c_str ()));
}
return result;
}
-int
-Accidental_engraver::get_bar_number ()
-{
- SCM barnum = get_property ("internalBarNumber");
- SCM smp = get_property ("measurePosition");
-
- int bn = robust_scm2int (barnum, 0);
-
- Moment mp = robust_scm2moment (smp, Moment (0));
- if (mp.main_part_ < Rational (0))
- bn--;
-
- return bn;
-}
-
void
Accidental_engraver::process_acknowledged ()
{
{
SCM accidental_rules = get_property ("autoAccidentals");
SCM cautionary_rules = get_property ("autoCautionaries");
- int barnum = get_bar_number ();
+ SCM measure_position = get_property ("measurePosition");
+ int barnum = measure_number (context());
for (vsize i = 0; i < accidentals_.size (); i++)
{
if (!pitch)
continue;
- Accidental_result acc = check_pitch_against_rules (*pitch, origin,
- accidental_rules, barnum);
- Accidental_result caut = check_pitch_against_rules (*pitch, origin,
- cautionary_rules, barnum);
+ Accidental_result acc = check_pitch_against_rules (*pitch, origin, accidental_rules,
+ barnum, measure_position);
+ Accidental_result caut = check_pitch_against_rules (*pitch, origin, cautionary_rules,
+ barnum, measure_position);
bool cautionary = to_boolean (note->get_property ("cautionary"));
if (caut.score () > acc.score ())
/* Cannot look for ties: it's not guaranteed that they reach
us before the notes. */
- if (acc.need_acc
- && !note->in_event_class ("trill-span-event"))
- create_accidental (&accidentals_[i], acc.need_restore, cautionary);
+ if (!note->in_event_class ("trill-span-event"))
+ {
+ if (acc.need_acc)
+ create_accidental (&accidentals_[i], acc.need_restore, cautionary);
- if (forced || cautionary)
- accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
+ if (forced || cautionary)
+ accidentals_[i].accidental_->set_property ("forced", SCM_BOOL_T);
+ }
}
}
}
{
Stream_event *note = entry->melodic_;
Grob *support = entry->head_;
- Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
-
bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals"));
Grob *a = 0;
if (as_suggestion)
a = make_suggested_accidental (note, support, entry->origin_engraver_);
else
- a = make_standard_accidental (note, support, entry->origin_engraver_);
+ a = make_standard_accidental (note, support, entry->origin_engraver_, cautionary);
- SCM accs = scm_cons (scm_from_int (pitch->get_alteration () * Rational (4)),
- SCM_EOL);
if (restore_natural)
{
if (to_boolean (get_property ("extraNatural")))
- accs = scm_cons (scm_from_int (0), accs);
+ a->set_property ("restore-first", SCM_BOOL_T);
}
-
- if (cautionary)
- a->set_property ("cautionary", SCM_BOOL_T);
- a->set_property ("accidentals", accs);
entry->accidental_ = a;
}
Grob *
Accidental_engraver::make_standard_accidental (Stream_event *note,
Grob *note_head,
- Engraver *trans)
+ Engraver *trans,
+ bool cautionary)
{
(void)note;
level, so that we get the property settings for
Accidental from the respective Voice.
*/
- Grob *a = trans->make_item ("Accidental", note_head->self_scm ());
+ Grob *a = 0;
+ if (cautionary)
+ a = trans->make_item ("AccidentalCautionary", note_head->self_scm ());
+ else
+ a = trans->make_item ("Accidental", note_head->self_scm ());
/*
We add the accidentals to the support of the arpeggio,
Accidental_placement::add_accidental (accidental_placement_, a);
note_head->set_object ("accidental-grob", a->self_scm ());
-
+
return a;
}
}
for (vsize i = accidentals_.size (); i--;)
- {
- int barnum = get_bar_number ();
-
+ {
Stream_event *note = accidentals_[i].melodic_;
Context *origin = accidentals_[i].origin_;
+ int barnum = measure_number (origin);
+
Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
if (!pitch)
continue;
Rational a = pitch->get_alteration ();
SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
+ Moment end_mp = measure_position (context (),
+ unsmob_duration (note->get_property ("duration")));
+ SCM position = scm_cons (scm_from_int (barnum), end_mp.smobbed_copy ());
+
SCM localsig = SCM_EOL;
while (origin
&& origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig))
{
bool change = false;
- if (accidentals_[i].tied_)
+ if (accidentals_[i].tied_
+ && !(to_boolean (accidentals_[i].accidental_->get_property ("forced"))))
{
/*
Remember an alteration that is different both from
that of the tied note and of the key signature.
*/
- localsig = ly_assoc_prepend_x (localsig, key, scm_cons (ly_symbol2scm ("tied"),
- scm_from_int (barnum)));
+ localsig = ly_assoc_prepend_x (localsig, key,scm_cons (ly_symbol2scm ("tied"),
+ position));
change = true;
}
noteheads with the same notename.
*/
localsig = ly_assoc_prepend_x (localsig, key,
- scm_cons (ly_rational2scm (a),
- scm_from_int (barnum)));
+ scm_cons (ly_rational2scm (a),
+ position));
change = true;
}
}
}
+ if (accidental_placement_)
+ for (vsize i = 0; i < note_columns_.size (); i++)
+ Separation_item::add_conditional_item (note_columns_[i], accidental_placement_);
+
accidental_placement_ = 0;
accidentals_.clear ();
left_objects_.clear ();
ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
}
+void
+Accidental_engraver::acknowledge_note_column (Grob_info info)
+{
+ note_columns_.push_back (info.grob ());
+}
+
void
Accidental_engraver::acknowledge_arpeggio (Grob_info info)
{
ADD_ACKNOWLEDGER (Accidental_engraver, finger);
ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
ADD_ACKNOWLEDGER (Accidental_engraver, tie);
+ADD_ACKNOWLEDGER (Accidental_engraver, note_column);
ADD_TRANSLATOR (Accidental_engraver,
-
- "Make accidentals. "
- "Catch note heads, ties and notices key-change events. "
- "This engraver usually lives at Staff level, but "
- "reads the settings for Accidental at @code{Voice} level, "
- "so you can @code{\\override} them at @code{Voice}. ",
- "Accidental AccidentalSuggestion",
-
+ /* doc */
+ "Make accidentals."
+ " Catch note heads, ties and notices key-change events."
+ " This engraver usually lives at Staff level, but"
+ " reads the settings for Accidental at @code{Voice} level,"
+ " so you can @code{\\override} them at @code{Voice}.",
+
+ /* create */
+ "Accidental "
+ "AccidentalCautionary "
+ "AccidentalPlacement "
+ "AccidentalSuggestion ",
+
+ /* read */
"autoAccidentals "
"autoCautionaries "
"internalBarNumber "
"extraNatural "
"harmonicAccidentals "
+ "keySignature "
"localKeySignature ",
+
+ /* write */
"localKeySignature "
);
projects / lilypond.git / blobdiff