2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2002--2015 Juergen Reuter <reuter@ipd.uka.de>
6 Han-Wen Nienhuys <hanwen@xs4all.nl
8 LilyPond is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 LilyPond is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
22 #include "engraver.hh"
24 #include "accidental-placement.hh"
25 #include "axis-group-interface.hh"
27 #include "note-head.hh"
28 #include "pitch-interval.hh"
29 #include "pointer-group-interface.hh"
30 #include "protected-scm.hh"
31 #include "side-position-interface.hh"
32 #include "separation-item.hh"
33 #include "staff-symbol-referencer.hh"
34 #include "stream-event.hh"
36 #include "translator.icc"
38 class Ambitus_engraver : public Engraver
41 TRANSLATOR_DECLARATIONS (Ambitus_engraver);
43 DECLARE_ACKNOWLEDGER (note_head);
45 void process_music ();
46 void stop_translation_timestep ();
47 virtual void finalize ();
48 virtual void derived_mark () const;
51 void create_ambitus ();
54 Drul_array<Item *> heads_;
55 Drul_array<Item *> accidentals_;
56 Drul_array<Stream_event *> causes_;
57 Pitch_interval pitch_interval_;
64 Ambitus_engraver::derived_mark () const
66 scm_gc_mark (start_key_sig_);
70 Ambitus_engraver::create_ambitus ()
72 ambitus_ = make_item ("AmbitusLine", SCM_EOL);
73 group_ = make_item ("Ambitus", SCM_EOL);
76 heads_[d] = make_item ("AmbitusNoteHead", SCM_EOL);
77 accidentals_[d] = make_item ("AmbitusAccidental", SCM_EOL);
78 accidentals_[d]->set_parent (heads_[d], Y_AXIS);
79 heads_[d]->set_object ("accidental-grob",
80 accidentals_[d]->self_scm ());
81 Axis_group_interface::add_element (group_, heads_[d]);
82 Axis_group_interface::add_element (group_, accidentals_[d]);
85 ambitus_->set_parent (heads_[DOWN], X_AXIS);
86 Axis_group_interface::add_element (group_, ambitus_);
91 Ambitus_engraver::Ambitus_engraver ()
95 accidentals_.set (0, 0);
98 start_key_sig_ = SCM_EOL;
102 Ambitus_engraver::process_music ()
105 * Ensure that ambitus is created in the very first timestep
112 Ambitus_engraver::stop_translation_timestep ()
114 if (ambitus_ && !is_typeset_)
117 * Evaluate middleCPosition not until now, since otherwise we
118 * may then oversee a clef that is defined in a staff context if
119 * we are in a voice context; middleCPosition would then be
122 * Don't use middleCPosition as this may be thwarted by a cue
123 * starting here. middleCOffset is not affected by cue clefs.
125 int clef_pos = robust_scm2int (get_property ("middleCClefPosition"), 0);
126 int offset = robust_scm2int (get_property ("middleCOffset"), 0);
128 start_c0_ = clef_pos + offset;
129 start_key_sig_ = get_property ("keyAlterations");
136 Ambitus_engraver::acknowledge_note_head (Grob_info info)
138 Stream_event *nr = info.event_cause ();
139 if (nr && nr->in_event_class ("note-event")
140 && !to_boolean (info.grob ()->get_property ("ignore-ambitus")))
142 SCM p = nr->get_property ("pitch");
144 If the engraver is added to a percussion context,
145 filter out unpitched note heads.
147 if (!unsmob<Pitch> (p))
149 Pitch pitch = *unsmob<Pitch> (p);
150 Drul_array<bool> expands = pitch_interval_.add_point (pitch);
159 Ambitus_engraver::finalize ()
161 if (ambitus_ && !pitch_interval_.is_empty ())
163 Grob *accidental_placement
164 = make_item ("AccidentalPlacement", accidentals_[DOWN]->self_scm ());
166 for (DOWN_and_UP (d))
168 Pitch p = pitch_interval_[d];
169 heads_[d]->set_property ("cause", causes_[d]->self_scm ());
170 heads_[d]->set_property ("staff-position",
171 scm_from_int (start_c0_ + p.steps ()));
173 SCM handle = scm_assoc (scm_cons (scm_from_int (p.get_octave ()),
174 scm_from_int (p.get_notename ())),
177 if (scm_is_false (handle))
178 handle = scm_assoc (scm_from_int (p.get_notename ()),
181 Rational sig_alter = (scm_is_true (handle))
182 ? robust_scm2rational (scm_cdr (handle), Rational (0))
185 const Pitch other = pitch_interval_[-d];
187 if (sig_alter == p.get_alteration ()
188 && !((p.steps () == other.steps ())
189 && (p.get_alteration () != other.get_alteration ())))
191 accidentals_[d]->suicide ();
192 heads_[d]->set_object ("accidental-grob", SCM_EOL);
196 set_property ("alteration",
197 ly_rational2scm (p.get_alteration ()));
198 Separation_item::add_conditional_item (heads_[d],
199 accidental_placement);
200 Accidental_placement::add_accidental (accidental_placement,
201 accidentals_[d], false, 0);
202 Pointer_group_interface::add_grob (ambitus_,
203 ly_symbol2scm ("note-heads"),
207 Axis_group_interface::add_element (group_, accidental_placement);
211 for (DOWN_and_UP (d))
213 accidentals_[d]->suicide ();
214 heads_[d]->suicide ();
217 ambitus_->suicide ();
221 ADD_ACKNOWLEDGER (Ambitus_engraver, note_head);
222 ADD_TRANSLATOR (Ambitus_engraver,
224 "Create an ambitus.",
227 "AccidentalPlacement "
235 "middleCClefPosition "