2 gregorian-ligature-engraver.cc -- implement Gregorian_ligature_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2003--2005 Juergen Reuter <reuter@ipd.uka.de>
9 #include "gregorian-ligature-engraver.hh"
11 #include "gregorian-ligature.hh"
13 #include "staff-symbol-referencer.hh"
15 #include "paper-column.hh"
19 * This abstract class is the common superclass for all ligature
20 * engravers for Gregorian chant notation. It cares for the musical
21 * handling of the neumes, such as checking for valid combinations of
22 * neumes and providing context information. Notational aspects such
23 * as the glyphs to use or calculating the total width of a ligature,
24 * are left to the concrete subclass. Currently, there is only a
25 * single subclass, Vaticana_ligature_engraver. Other ligature
26 * engravers for Gregorian chant will be added in the future, such as
27 * Medicaea_ligature_engraver or Hufnagel_ligature_engraver.
29 Gregorian_ligature_engraver::Gregorian_ligature_engraver ()
31 pes_or_flexa_req_ = 0;
35 Gregorian_ligature_engraver::try_music (Music *m)
37 if (m->is_mus_type ("pes-or-flexa-event"))
39 pes_or_flexa_req_ = m;
43 return Ligature_engraver::try_music (m);
46 void fix_prefix (char *name, int mask,
47 int *current_set, int min_set, int max_set,
50 bool current = *current_set & mask;
51 bool min = min_set & mask;
52 bool max = max_set & mask;
55 programming_error ("min_set > max_set");
60 primitive->warning (_f ("\\%s ignored", name));
61 *current_set &= ~mask;
65 primitive->warning (_f ("implied \\%s added", name));
70 void fix_prefix_set (int *current_set, int min_set, int max_set, Grob *primitive)
72 fix_prefix ("virga", VIRGA, current_set, min_set, max_set, primitive);
73 fix_prefix ("stropha", STROPHA, current_set, min_set, max_set, primitive);
74 fix_prefix ("inclinatum", INCLINATUM, current_set, min_set, max_set, primitive);
75 fix_prefix ("auctum", AUCTUM, current_set, min_set, max_set, primitive);
76 fix_prefix ("descendens", DESCENDENS, current_set, min_set, max_set, primitive);
77 fix_prefix ("ascendens", ASCENDENS, current_set, min_set, max_set, primitive);
78 fix_prefix ("oriscus", ORISCUS, current_set, min_set, max_set, primitive);
79 fix_prefix ("quilisma", QUILISMA, current_set, min_set, max_set, primitive);
80 fix_prefix ("deminutum", DEMINUTUM, current_set, min_set, max_set, primitive);
81 fix_prefix ("cavum", CAVUM, current_set, min_set, max_set, primitive);
82 fix_prefix ("linea", LINEA, current_set, min_set, max_set, primitive);
83 fix_prefix ("pes_or_flexa", LINEA, current_set, min_set, max_set, primitive);
86 void check_and_fix_all_prefixes (Array<Grob_info> primitives)
88 /* Check for illegal head modifier combinations */
89 for (int i = 0; i < primitives.size (); i++)
91 Grob *primitive = primitives[i].grob ();
93 /* compute head prefix set by inspecting primitive grob properties */
95 = (VIRGA *to_boolean (primitive->get_property ("virga")))
96 | (STROPHA *to_boolean (primitive->get_property ("stropha")))
97 | (INCLINATUM *to_boolean (primitive->get_property ("inclinatum")))
98 | (AUCTUM *to_boolean (primitive->get_property ("auctum")))
99 | (DESCENDENS *to_boolean (primitive->get_property ("descendens")))
100 | (ASCENDENS *to_boolean (primitive->get_property ("ascendens")))
101 | (ORISCUS *to_boolean (primitive->get_property ("oriscus")))
102 | (QUILISMA *to_boolean (primitive->get_property ("quilisma")))
103 | (DEMINUTUM *to_boolean (primitive->get_property ("deminutum")))
104 | (CAVUM *to_boolean (primitive->get_property ("cavum")))
105 | (LINEA *to_boolean (primitive->get_property ("linea")))
106 | (PES_OR_FLEXA *to_boolean (primitive->get_property ("pes-or-flexa")));
108 /* check: ascendens and descendens exclude each other; same with
109 auctum and deminutum */
110 if (prefix_set & DESCENDENS)
112 fix_prefix_set (&prefix_set,
113 prefix_set & ~ASCENDENS,
114 prefix_set & ~ASCENDENS,
117 if (prefix_set & AUCTUM)
119 fix_prefix_set (&prefix_set,
120 prefix_set & ~DEMINUTUM,
121 prefix_set & ~DEMINUTUM,
125 /* check: virga, quilisma and oriscus cannot be combined with any
126 other prefix, but may be part of a pes or flexa */
127 if (prefix_set & VIRGA)
129 fix_prefix_set (&prefix_set,
131 VIRGA | PES_OR_FLEXA,
134 if (prefix_set & QUILISMA)
136 fix_prefix_set (&prefix_set,
138 QUILISMA | PES_OR_FLEXA,
141 if (prefix_set & ORISCUS)
143 fix_prefix_set (&prefix_set,
145 ORISCUS | PES_OR_FLEXA,
149 /* check: auctum is the only valid optional prefix for stropha */
150 if (prefix_set & STROPHA)
152 fix_prefix_set (&prefix_set,
158 /* check: inclinatum may be prefixed with auctum or deminutum only */
159 if (prefix_set & INCLINATUM)
161 fix_prefix_set (&prefix_set,
163 INCLINATUM | AUCTUM | DEMINUTUM,
166 /* check: semivocalis (deminutum but not inclinatum) must occur in
167 combination with and only with pes or flexa */
168 else if (prefix_set & DEMINUTUM)
170 fix_prefix_set (&prefix_set,
171 DEMINUTUM | PES_OR_FLEXA,
172 DEMINUTUM | PES_OR_FLEXA,
176 /* check: cavum and linea (either or both) may be applied only
178 if (prefix_set & (CAVUM | LINEA))
180 fix_prefix_set (&prefix_set,
186 /* all other combinations should be valid (unless I made a
189 primitive->set_property ("prefix-set", scm_from_int (prefix_set));
194 * Marks those heads that participate in a pes or flexa.
197 provide_context_info (Array<Grob_info> primitives)
199 Grob *prev_primitive = 0;
200 int prev_prefix_set = 0;
201 int prev_context_info = 0;
203 for (int i = 0; i < primitives.size (); i++)
205 Grob *primitive = primitives[i].grob ();
206 Music *music_cause = primitives[i].music_cause ();
207 int context_info = 0;
208 int pitch = unsmob_pitch (music_cause->get_property ("pitch"))->steps ();
209 int prefix_set = scm_to_int (primitive->get_property ("prefix-set"));
211 if (prefix_set & PES_OR_FLEXA)
212 if (!i) // ligature may not start with 2nd head of pes or flexa
213 primitive->warning (_ ("can't apply `\\~' on first head of ligature"));
214 else if (pitch > prev_pitch) // pes
216 prev_context_info |= PES_LOWER;
217 context_info |= PES_UPPER;
219 else if (pitch < prev_pitch) // flexa
221 prev_context_info |= FLEXA_LEFT;
222 context_info |= FLEXA_RIGHT;
224 else // (pitch == prev_pitch)
225 primitive->warning (_ ("can't apply `\\~' on heads with identical pitch"));
226 if (prev_prefix_set & DEMINUTUM)
227 context_info |= AFTER_DEMINUTUM;
230 prev_primitive->set_property ("context-info",
231 scm_from_int (prev_context_info));
232 prev_primitive = primitive;
233 prev_prefix_set = prefix_set;
234 prev_context_info = context_info;
238 prev_primitive->set_property ("context-info",
239 scm_from_int (prev_context_info));
243 Gregorian_ligature_engraver::build_ligature (Spanner *ligature,
244 Array<Grob_info> primitives)
246 // apply style-independent checking and transformation
247 check_and_fix_all_prefixes (primitives);
248 provide_context_info (primitives);
250 // apply style-specific transformation (including line-up); to be
251 // implemented by subclass
252 transform_heads (ligature, primitives);
256 Gregorian_ligature_engraver::stop_translation_timestep ()
258 Ligature_engraver::stop_translation_timestep ();
259 pes_or_flexa_req_ = 0;
262 // no ADD_ACKNOWLEDGER / ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
263 // since this class is abstract