source file of the GNU LilyPond music typesetter
- (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
*/
#include "accidental-placement.hh"
#include "arpeggio.hh"
#include "context.hh"
-#include "engraver-group-engraver.hh"
#include "engraver.hh"
-#include "event.hh"
-#include "item.hh"
+#include "international.hh"
+#include "music.hh"
+#include "pitch.hh"
#include "protected-scm.hh"
#include "rhythmic-head.hh"
#include "side-position-interface.hh"
-#include "spanner.hh"
#include "tie.hh"
#include "warn.hh"
+#include "translator.icc"
class Accidental_entry
{
Music *melodic_;
Grob *accidental_;
Context *origin_;
+ Engraver *origin_engraver_;
Grob *head_;
bool tied_;
class Accidental_engraver : public Engraver
{
-public:
int get_bar_number ();
void update_local_key_signature ();
+ void create_accidental (Accidental_entry *entry, bool, bool);
+ Grob *make_standard_accidental (Music *note, Grob *note_head, Engraver *trans);
+ Grob *make_suggested_accidental (Music *note, Grob *note_head, Engraver *trans);
protected:
TRANSLATOR_DECLARATIONS (Accidental_engraver);
- virtual void process_music ();
- virtual void acknowledge_grob (Grob_info);
- virtual void stop_translation_timestep ();
+ void process_music ();
+
+ void acknowledge_tie (Grob_info);
+ void acknowledge_arpeggio (Grob_info);
+ void acknowledge_rhythmic_head (Grob_info);
+ void acknowledge_finger (Grob_info);
+
+ void stop_translation_timestep ();
virtual void initialize ();
- virtual void process_acknowledged_grobs ();
+ void process_acknowledged ();
virtual void finalize ();
+ virtual void derived_mark () const;
public:
- Protected_scm last_keysig_; // ugh.
-
- /* Urgh. Since the accidentals depend on lots of variables, we have
+ SCM last_keysig_; // ugh.
+
+ /*
+ Urgh. Since the accidentals depend on lots of variables, we have
to store all information before we can really create the
- accidentals. */
- Link_array<Grob> left_objects_;
- Link_array<Grob> right_objects_;
+ accidentals.
+ */
+ vector<Grob*> left_objects_;
+ vector<Grob*> right_objects_;
Grob *accidental_placement_;
-
Array<Accidental_entry> accidentals_;
- Link_array<Spanner> ties_;
+
vector<Accidental_entry> accidentals_;
+ vector<Spanner*> ties_;
};
-
/*
TODO:
aren't. eg. localKeySignature is changed at runtime, which means
that references in grobs should always store ly_deep_copy ()s of
those.
- */
+*/
-static void
-set_property_on_children (Context *trans, char const *sym, SCM val)
-{
- trans->set_property (sym, ly_deep_copy (val));
- for (SCM p = trans->children_contexts (); ly_c_pair_p (p); p = ly_cdr (p))
- {
- Context *trg = unsmob_context (ly_car (p));
- set_property_on_children (trg, sym, ly_deep_copy (val));
- }
-}
Accidental_engraver::Accidental_engraver ()
{
last_keysig_ = SCM_EOL;
}
+void
+Accidental_engraver::derived_mark () const
+{
+ scm_gc_mark (last_keysig_);
+}
+
void
Accidental_engraver::update_local_key_signature ()
{
last_keysig_ = get_property ("keySignature");
- set_property_on_children (context (), "localKeySignature", last_keysig_);
+ set_context_property_on_children (context (),
+ ly_symbol2scm ("localKeySignature"),
+ last_keysig_);
Context *trans = context ()->get_parent_context ();
/* Huh. Don't understand what this is good for. --hwn. */
- while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature")))
+
+ SCM val;
+ while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val))
{
trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_));
trans = trans->get_parent_context ();
void
Accidental_engraver::initialize ()
{
- update_local_key_signature ();
+ update_local_key_signature ();
}
-
/** Calculate the number of accidentals on basis of the current local key
sig (passed as argument)
-
+
* First check step+octave (taking into account barnumbers if necessary).
-
+
* Then check the global signature (only step).
-
+
Return number of accidentals (0, 1 or 2). */
+
+static bool
+recent_enough (int bar_number, SCM alteration_def, SCM laziness)
+{
+ if (scm_is_number (alteration_def)
+ || laziness == SCM_BOOL_T)
+ return true;
+
+ return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
+}
+
+static int
+extract_alteration (SCM alteration_def)
+{
+ if (scm_is_number (alteration_def))
+ return scm_to_int (alteration_def);
+ else if (scm_is_pair (alteration_def))
+ return scm_to_int (scm_car (alteration_def));
+ else if (alteration_def == SCM_BOOL_F)
+ return 0;
+ else
+ assert (0);
+ return 0;
+}
+
+bool
+is_tied (SCM alteration_def)
+{
+ return (alteration_def == SCM_BOOL_T)
+ || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T);
+}
+
static int
number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
- int curbarnum, SCM laziness, bool ignore_octave)
+ int bar_number, SCM laziness, bool ignore_octave)
{
int n = pitch->get_notename ();
int o = pitch->get_octave ();
- int a = pitch->get_alteration ();
- SCM prev_alt = SCM_BOOL_F;
+ SCM previous_alteration = SCM_BOOL_F;
- if (!ignore_octave)
+ SCM from_same_octave = ly_assoc_get (scm_cons (scm_from_int (o),
+ scm_from_int (n)), sig, SCM_BOOL_F);
+ SCM from_key_signature = ly_assoc_get (scm_from_int (n), sig, SCM_BOOL_F);
+ SCM from_other_octaves = SCM_BOOL_F;
+ for (SCM s = sig; scm_is_pair (s); s = scm_cdr (s))
{
- SCM prev_local
- = scm_assoc (scm_cons (scm_int2num (o), scm_int2num (n)), sig);
-
- if (ly_c_pair_p (prev_local))
- {
- if (ly_c_pair_p (ly_cdr (prev_local))
- && ly_c_number_p (laziness))
- {
- int barnum = ly_scm2int (ly_cddr (prev_local));
-
- prev_local = scm_cons (ly_car (prev_local), ly_cadr (prev_local));
- if (curbarnum <= barnum + ly_scm2int (laziness))
- prev_alt = prev_local;
- }
- }
+ SCM entry = scm_car (s);
+ if (scm_is_pair (scm_car (entry))
+ && scm_cdar (entry) == scm_from_int (n))
+ from_other_octaves = scm_cdr (entry);
}
- if (prev_alt == SCM_BOOL_F)
- prev_alt = scm_assoc (scm_int2num (n), sig);
-
- prev_alt = (prev_alt == SCM_BOOL_F) ? scm_int2num (0) : ly_cdr (prev_alt);
-
- /* UGH. prev_acc can be #t in case of ties. What is this for? */
- int p = ly_c_number_p (prev_alt) ? ly_scm2int (prev_alt) : 0;
-
- int num;
- if (a == p && ly_c_number_p (prev_alt))
- num = 0;
- else if ( (abs (a)<abs (p) || p*a<0) && a != 0 )
- num = 2;
+ if (from_same_octave != SCM_BOOL_F
+ && recent_enough (bar_number, from_same_octave, laziness))
+ previous_alteration = from_same_octave;
+ else if (ignore_octave
+ && from_other_octaves != SCM_BOOL_F
+ && recent_enough (bar_number, from_other_octaves, laziness))
+ previous_alteration = from_other_octaves;
+ else if (from_key_signature != SCM_BOOL_F)
+ previous_alteration = from_key_signature;
+
+ int num = 1;
+ if (is_tied (previous_alteration))
+ {
+ num = 1;
+ *different = true;
+ }
else
- num = 1;
-
- *different = (a != p);
+ {
+ int prev = extract_alteration (previous_alteration);
+ int alter = pitch->get_alteration ();
+
+ if (alter == prev)
+ num = 0;
+ else if ((abs (alter) < abs (prev)
+ || prev * alter < 0) && alter != 0)
+ num = 2;
+ *different = (alter != prev);
+ }
return num;
}
static int
number_accidentals (bool *different,
Pitch *pitch, Context *origin,
- SCM accidentals, int curbarnum)
+ SCM accidentals, int bar_number)
{
int number = 0;
*different = false;
- if (ly_c_pair_p (accidentals) && !ly_c_symbol_p (ly_car (accidentals)))
- warning (_f ("Accidental typesetting list must begin with context-name: %s",
- ly_scm2string (ly_car (accidentals)).to_str0 ()));
-
- for (; ly_c_pair_p (accidentals) && origin;
- accidentals = ly_cdr (accidentals))
+ if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals)))
+ warning (_f ("accidental typesetting list must begin with context-name: %s",
+ ly_scm2string (scm_car (accidentals)).c_str ()));
+
+ for (; scm_is_pair (accidentals) && origin;
+ accidentals = scm_cdr (accidentals))
{
// If pair then it is a new accidentals typesetting rule to be checked
- SCM rule = ly_car (accidentals);
- if (ly_c_pair_p (rule))
+ SCM rule = scm_car (accidentals);
+ if (scm_is_pair (rule))
{
- SCM type = ly_car (rule);
- SCM laziness = ly_cdr (rule);
+ SCM type = scm_car (rule);
+ SCM laziness = scm_cdr (rule);
SCM localsig = origin->get_property ("localKeySignature");
-
- bool same_octave_b =
- ly_c_eq_p (ly_symbol2scm ("same-octave"), type);
- bool any_octave_b =
- ly_c_eq_p (ly_symbol2scm ("any-octave"), type);
+
+ bool same_octave_b
+ = scm_is_eq (ly_symbol2scm ("same-octave"), type);
+ bool any_octave_b
+ = scm_is_eq (ly_symbol2scm ("any-octave"), type);
if (same_octave_b || any_octave_b)
{
bool d = false;
int n = number_accidentals_from_sig
- (&d, localsig, pitch, curbarnum, laziness, any_octave_b);
+ (&d, localsig, pitch, bar_number, laziness, any_octave_b);
*different = *different || d;
- number = max (number, n);
+ number = max (number, n);
}
else
- warning (_f ("ignoring unknown accidental: %s",
- ly_symbol2string (type).to_str0 ()));
+ warning (_f ("ignoring unknown accidental: %s",
+ ly_symbol2string (type).c_str ()));
}
-
- /*
- if symbol then it is a context name. Scan parent contexts to find it.
- */
- else if (ly_c_symbol_p (rule))
+ /* if symbol then it is a context name. Scan parent contexts to
+ find it. */
+ else if (scm_is_symbol (rule))
{
Context *dad = origin;
while (dad && !dad->is_alias (rule))
dad = dad->get_parent_context ();
-
+
if (dad)
origin = dad;
}
- else warning (_f ("Accidental rule must be pair or context-name; Found %s",
- ly_scm2string (rule).to_str0 ()));
+ else
+ warning (_f ("pair or context-name expected for accidental rule, found %s",
+ ly_scm2string (rule).c_str ()));
}
return number;
SCM smp = get_property ("measurePosition");
int bn = robust_scm2int (barnum, 0);
-
- Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
+
+ Moment mp = robust_scm2moment (smp, Moment (0));
if (mp.main_part_ < Rational (0))
bn--;
-
+
return bn;
}
void
-Accidental_engraver::process_acknowledged_grobs ()
+Accidental_engraver::process_acknowledged ()
{
- if (accidentals_.size () && !accidentals_.top ().done_)
+ if (accidentals_.size () && !accidentals_.back ().done_)
{
- SCM accidentals = get_property ("autoAccidentals");
- SCM cautionaries = get_property ("autoCautionaries");
+ SCM accidentals = get_property ("autoAccidentals");
+ SCM cautionaries = get_property ("autoCautionaries");
int barnum = get_bar_number ();
-
- bool extra_natural_b = get_property ("extraNatural") == SCM_BOOL_T;
- for (int i = 0; i < accidentals_.size (); i++)
+
+ for (vsize i = 0; i < accidentals_.size (); i++)
{
- if (accidentals_[i].done_ )
+ if (accidentals_[i].done_)
continue;
- accidentals_[i].done_ = true;
- Grob *support = accidentals_[i].head_;
+ accidentals_[i].done_ = true;
+
Music *note = accidentals_[i].melodic_;
Context *origin = accidentals_[i].origin_;
bool different = false;
bool different_caut = false;
-
+
int num = number_accidentals (&different,
pitch, origin,
accidentals, barnum);
cautionaries, barnum);
bool cautionary = to_boolean (note->get_property ("cautionary"));
-
+
if (num_caut > num)
{
num = num_caut;
if (num == 0 && to_boolean (note->get_property ("force-accidental")))
num = 1;
-
- /*
- Can not look for ties: it's not guaranteed that they reach
- us before the notes
- */
-
+ /* Cannot look for ties: it's not guaranteed that they reach
+ us before the notes. */
if (num)
- {
- /*
- We construct the accidentals at the originating Voice
- level, so that we get the property settings for
- Accidental from the respective Voice.
- */
- Grob *a
- = make_item_from_properties (origin->implementation (),
- ly_symbol2scm ("Accidental"),
- note->self_scm ());
- a->set_parent (support, Y_AXIS);
-
- if (!accidental_placement_)
- accidental_placement_ = make_item ("AccidentalPlacement",
- a->self_scm ());
- Accidental_placement::add_accidental (accidental_placement_, a);
- SCM accs = scm_cons (scm_int2num (pitch->get_alteration ()),
- SCM_EOL);
- if (num == 2 && extra_natural_b)
- accs = scm_cons (scm_int2num (0), accs);
-
- /* TODO: add cautionary option in accidental. */
-
- if (cautionary)
- a->set_property ("cautionary", SCM_BOOL_T);
-
- support->set_property ("accidental-grob", a->self_scm ());
-
- a->set_property ("accidentals", accs);
- accidentals_[i].accidental_ = a;
-
- /*
- We add the accidentals to the support of the arpeggio,
- so it is put left of the accidentals.
- */
- for (int i = 0; i < left_objects_.size (); i++)
- Side_position_interface::add_support (left_objects_[i], a);
- for (int i = 0; i < right_objects_.size (); i++)
- Side_position_interface::add_support (a, right_objects_[i]);
- }
+ create_accidental (&accidentals_[i], num > 1, cautionary);
}
}
}
+void
+Accidental_engraver::create_accidental (Accidental_entry *entry,
+ bool restore_natural,
+ bool cautionary)
+{
+ Music *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_);
+
+ SCM accs = scm_cons (scm_from_int (pitch->get_alteration ()),
+ SCM_EOL);
+ if (restore_natural)
+ {
+ if (to_boolean (get_property ("extraNatural")))
+ accs = scm_cons (scm_from_int (0), accs);
+ }
+
+ /* TODO: add cautionary option in accidental. */
+ if (cautionary)
+ a->set_property ("cautionary", SCM_BOOL_T);
+
+ a->set_property ("accidentals", accs);
+ entry->accidental_ = a;
+}
+
+Grob *
+Accidental_engraver::make_standard_accidental (Music *note,
+ Grob *note_head,
+ Engraver *trans)
+{
+
+ (void)note;
+ /*
+ We construct the accidentals at the originating Voice
+ level, so that we get the property settings for
+ Accidental from the respective Voice.
+ */
+ Grob *a
+ = make_grob_from_properties (trans,
+ ly_symbol2scm ("Accidental"),
+ note_head->self_scm (),
+ "Accidental");
+
+ /*
+ We add the accidentals to the support of the arpeggio,
+ so it is put left of the accidentals.
+ */
+ for (vsize i = 0; i < left_objects_.size (); i++)
+ {
+ if (left_objects_[i]->get_property ("side-axis") == scm_from_int (X_AXIS))
+ Side_position_interface::add_support (left_objects_[i], a);
+ }
+
+ /*
+ Hmm. Junkme?
+ */
+ for (vsize i = 0; i < right_objects_.size (); i++)
+ Side_position_interface::add_support (a, right_objects_[i]);
+
+ a->set_parent (note_head, Y_AXIS);
+
+ if (!accidental_placement_)
+ accidental_placement_ = make_item ("AccidentalPlacement",
+ a->self_scm ());
+ Accidental_placement::add_accidental (accidental_placement_, a);
+
+ note_head->set_object ("accidental-grob", a->self_scm ());
+
+ return a;
+}
+
+Grob *
+Accidental_engraver::make_suggested_accidental (Music *note,
+ Grob *note_head,
+ Engraver *trans)
+{
+ (void) note;
+ Grob *a
+ = make_grob_from_properties (trans,
+ ly_symbol2scm ("AccidentalSuggestion"),
+ note_head->self_scm (),
+ "AccidentalSuggestion");
+
+ Side_position_interface::add_support (a, note_head);
+ if (Grob *stem = unsmob_grob (a->get_object ("stem")))
+ Side_position_interface::add_support (a, stem);
+
+ a->set_parent (note_head, X_AXIS);
+ return a;
+}
+
void
Accidental_engraver::finalize ()
{
void
Accidental_engraver::stop_translation_timestep ()
{
- for (int j = ties_.size (); j--;)
+ for (vsize j = ties_.size (); j--;)
{
Grob *r = Tie::head (ties_[j], RIGHT);
- for (int i = accidentals_.size (); i--;)
+ for (vsize i = accidentals_.size (); i--;)
if (accidentals_[i].head_ == r)
{
if (Grob *g = accidentals_[i].accidental_)
{
- g->set_property ("tie", ties_[j]->self_scm ());
+ g->set_object ("tie", ties_[j]->self_scm ());
accidentals_[i].tied_ = true;
}
- ties_.del (j);
+ ties_.erase (ties_.begin () + j);
break;
}
}
- for (int i = accidentals_.size (); i--;)
+ for (vsize i = accidentals_.size (); i--;)
{
int barnum = get_bar_number ();
Music *note = accidentals_[i].melodic_;
- Context * origin = accidentals_[i].origin_;
+ Context *origin = accidentals_[i].origin_;
Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
if (!pitch)
int n = pitch->get_notename ();
int o = pitch->get_octave ();
int a = pitch->get_alteration ();
- SCM key = scm_cons (scm_int2num (o), scm_int2num (n));
+ SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
+ SCM localsig = SCM_EOL;
while (origin
- && origin->where_defined (ly_symbol2scm ("localKeySignature")))
+ && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig))
{
- /*
- huh? we set props all the way to the top?
- */
- SCM localsig = origin->get_property ("localKeySignature");
bool change = false;
if (accidentals_[i].tied_)
{
that of the tied note and of the key signature.
*/
localsig = ly_assoc_front_x
- (localsig, key, scm_cons (SCM_BOOL_T, scm_int2num (barnum)));
+ (localsig, key, scm_cons (SCM_BOOL_T, scm_from_int (barnum)));
change = true;
}
noteheads with the same notename.
*/
localsig = ly_assoc_front_x (localsig, key,
- scm_cons (scm_int2num (a),
- scm_int2num (barnum)));
+ scm_cons (scm_from_int (a),
+ scm_from_int (barnum)));
change = true;
}
}
void
-Accidental_engraver::acknowledge_grob (Grob_info info)
+Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
{
Music *note = info.music_cause ();
-
if (note
- && note->is_mus_type ("note-event")
- && Rhythmic_head::has_interface (info.grob_))
+ && (note->is_mus_type ("note-event")
+ || note->is_mus_type ("trill-span-event")))
{
- if (to_boolean ( get_property ("harmonicAccidentals"))
- || !ly_c_equal_p (info.grob_->get_property ("style"),
- ly_symbol2scm ("harmonic")))
+ /*
+ string harmonics usually don't have accidentals.
+ */
+ if (to_boolean (get_property ("harmonicAccidentals"))
+ || !ly_is_equal (info.grob ()->get_property ("style"),
+ ly_symbol2scm ("harmonic")))
{
-
- Accidental_entry entry ;
- entry.head_ = info.grob_;
- entry.origin_ = info.origin_trans_->context ();
+ Accidental_entry entry;
+ entry.head_ = info.grob ();
+ entry.origin_engraver_ = dynamic_cast<Engraver *> (info.origin_translator ());
+ entry.origin_ = entry.origin_engraver_->context ();
entry.melodic_ = note;
- accidentals_.push (entry);
+ accidentals_.push_back (entry);
}
}
- else if (Tie::has_interface (info.grob_))
- ties_.push (dynamic_cast<Spanner*> (info.grob_));
- else if (Arpeggio::has_interface (info.grob_))
- left_objects_.push (info.grob_);
- else if (info.grob_
- ->internal_has_interface (ly_symbol2scm ("finger-interface")))
- left_objects_.push (info.grob_);
+}
+
+void
+Accidental_engraver::acknowledge_tie (Grob_info info)
+{
+ ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
+}
+
+void
+Accidental_engraver::acknowledge_arpeggio (Grob_info info)
+{
+ left_objects_.push_back (info.grob ());
+}
+
+void
+Accidental_engraver::acknowledge_finger (Grob_info info)
+{
+ left_objects_.push_back (info.grob ());
}
void
update_local_key_signature ();
}
-ENTER_DESCRIPTION (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"
- ,
- ""
- ,
- "arpeggio-interface "
- "finger-interface "
- "rhythmic-head-interface "
- "tie-interface "
- ,
- "autoAccidentals "
- "autoCautionaries "
- "extraNatural "
- "harmonicAccidentals "
- "localKeySignature"
- ,
- "localKeySignature"
- );
+ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
+ADD_ACKNOWLEDGER (Accidental_engraver, finger);
+ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
+ADD_ACKNOWLEDGER (Accidental_engraver, tie);
+
+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",
+
+ "",
+
+ "autoAccidentals "
+ "autoCautionaries "
+ "extraNatural "
+ "harmonicAccidentals "
+ "localKeySignature",
+ "localKeySignature");
projects / lilypond.git / blobdiff