2 gregorian-ligature-engraver.cc -- implement Gregorian_ligature_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2003--2006 Juergen Reuter <reuter@ipd.uka.de>
9 #include "gregorian-ligature-engraver.hh"
11 #include "gregorian-ligature.hh"
12 #include "international.hh"
13 #include "paper-column.hh"
16 #include "staff-symbol-referencer.hh"
17 #include "stream-event.hh"
21 * This abstract class is the common superclass for all ligature
22 * engravers for Gregorian chant notation. It cares for the musical
23 * handling of the neumes, such as checking for valid combinations of
24 * neumes and providing context information. Notational aspects such
25 * as the glyphs to use or calculating the total width of a ligature,
26 * are left to the concrete subclass. Currently, there is only a
27 * single subclass, Vaticana_ligature_engraver. Other ligature
28 * engravers for Gregorian chant will be added in the future, such as
29 * Medicaea_ligature_engraver or Hufnagel_ligature_engraver.
31 Gregorian_ligature_engraver::Gregorian_ligature_engraver ()
33 pes_or_flexa_req_ = 0;
37 Gregorian_ligature_engraver::listen_pes_or_flexa (Stream_event *ev)
39 pes_or_flexa_req_ = ev;
42 void fix_prefix (char *name, int mask,
43 int *current_set, int min_set, int max_set,
46 bool current = *current_set & mask;
47 bool min = min_set & mask;
48 bool max = max_set & mask;
51 programming_error ("min_set > max_set");
56 primitive->warning (_f ("\\%s ignored", name));
57 *current_set &= ~mask;
61 primitive->warning (_f ("implied \\%s added", name));
66 void fix_prefix_set (int *current_set, int min_set, int max_set, Grob *primitive)
68 fix_prefix ("virga", VIRGA, current_set, min_set, max_set, primitive);
69 fix_prefix ("stropha", STROPHA, current_set, min_set, max_set, primitive);
70 fix_prefix ("inclinatum", INCLINATUM, current_set, min_set, max_set, primitive);
71 fix_prefix ("auctum", AUCTUM, current_set, min_set, max_set, primitive);
72 fix_prefix ("descendens", DESCENDENS, current_set, min_set, max_set, primitive);
73 fix_prefix ("ascendens", ASCENDENS, current_set, min_set, max_set, primitive);
74 fix_prefix ("oriscus", ORISCUS, current_set, min_set, max_set, primitive);
75 fix_prefix ("quilisma", QUILISMA, current_set, min_set, max_set, primitive);
76 fix_prefix ("deminutum", DEMINUTUM, current_set, min_set, max_set, primitive);
77 fix_prefix ("cavum", CAVUM, current_set, min_set, max_set, primitive);
78 fix_prefix ("linea", LINEA, current_set, min_set, max_set, primitive);
79 fix_prefix ("pes_or_flexa", LINEA, current_set, min_set, max_set, primitive);
82 void check_and_fix_all_prefixes (vector<Grob_info> primitives)
84 /* Check for illegal head modifier combinations */
85 for (vsize i = 0; i < primitives.size (); i++)
87 Grob *primitive = primitives[i].grob ();
89 /* compute head prefix set by inspecting primitive grob properties */
91 = (VIRGA *to_boolean (primitive->get_property ("virga")))
92 | (STROPHA *to_boolean (primitive->get_property ("stropha")))
93 | (INCLINATUM *to_boolean (primitive->get_property ("inclinatum")))
94 | (AUCTUM *to_boolean (primitive->get_property ("auctum")))
95 | (DESCENDENS *to_boolean (primitive->get_property ("descendens")))
96 | (ASCENDENS *to_boolean (primitive->get_property ("ascendens")))
97 | (ORISCUS *to_boolean (primitive->get_property ("oriscus")))
98 | (QUILISMA *to_boolean (primitive->get_property ("quilisma")))
99 | (DEMINUTUM *to_boolean (primitive->get_property ("deminutum")))
100 | (CAVUM *to_boolean (primitive->get_property ("cavum")))
101 | (LINEA *to_boolean (primitive->get_property ("linea")))
102 | (PES_OR_FLEXA *to_boolean (primitive->get_property ("pes-or-flexa")));
104 /* check: ascendens and descendens exclude each other; same with
105 auctum and deminutum */
106 if (prefix_set & DESCENDENS)
108 fix_prefix_set (&prefix_set,
109 prefix_set & ~ASCENDENS,
110 prefix_set & ~ASCENDENS,
113 if (prefix_set & AUCTUM)
115 fix_prefix_set (&prefix_set,
116 prefix_set & ~DEMINUTUM,
117 prefix_set & ~DEMINUTUM,
121 /* check: virga, quilisma and oriscus cannot be combined with any
122 other prefix, but may be part of a pes or flexa */
123 if (prefix_set & VIRGA)
125 fix_prefix_set (&prefix_set,
127 VIRGA | PES_OR_FLEXA,
130 if (prefix_set & QUILISMA)
132 fix_prefix_set (&prefix_set,
134 QUILISMA | PES_OR_FLEXA,
137 if (prefix_set & ORISCUS)
139 fix_prefix_set (&prefix_set,
141 ORISCUS | PES_OR_FLEXA,
145 /* check: auctum is the only valid optional prefix for stropha */
146 if (prefix_set & STROPHA)
148 fix_prefix_set (&prefix_set,
154 /* check: inclinatum may be prefixed with auctum or deminutum only */
155 if (prefix_set & INCLINATUM)
157 fix_prefix_set (&prefix_set,
159 INCLINATUM | AUCTUM | DEMINUTUM,
162 /* check: semivocalis (deminutum but not inclinatum) must occur in
163 combination with and only with pes or flexa */
164 else if (prefix_set & DEMINUTUM)
166 fix_prefix_set (&prefix_set,
167 DEMINUTUM | PES_OR_FLEXA,
168 DEMINUTUM | PES_OR_FLEXA,
172 /* check: cavum and linea (either or both) may be applied only
174 if (prefix_set & (CAVUM | LINEA))
176 fix_prefix_set (&prefix_set,
182 /* all other combinations should be valid (unless I made a
185 primitive->set_property ("prefix-set", scm_from_int (prefix_set));
190 * Marks those heads that participate in a pes or flexa.
193 provide_context_info (vector<Grob_info> primitives)
195 Grob *prev_primitive = 0;
196 int prev_prefix_set = 0;
197 int prev_context_info = 0;
199 for (vsize i = 0; i < primitives.size (); i++)
201 Grob *primitive = primitives[i].grob ();
202 Stream_event *event_cause = primitives[i].event_cause ();
203 int context_info = 0;
204 int pitch = unsmob_pitch (event_cause->get_property ("pitch"))->steps ();
205 int prefix_set = scm_to_int (primitive->get_property ("prefix-set"));
207 if (prefix_set & PES_OR_FLEXA)
208 if (!i) // ligature may not start with 2nd head of pes or flexa
209 primitive->warning (_ ("can't apply `\\~' on first head of ligature"));
210 else if (pitch > prev_pitch) // pes
212 prev_context_info |= PES_LOWER;
213 context_info |= PES_UPPER;
215 else if (pitch < prev_pitch) // flexa
217 prev_context_info |= FLEXA_LEFT;
218 context_info |= FLEXA_RIGHT;
220 else // (pitch == prev_pitch)
221 primitive->warning (_ ("can't apply `\\~' on heads with identical pitch"));
222 if (prev_prefix_set & DEMINUTUM)
223 context_info |= AFTER_DEMINUTUM;
226 prev_primitive->set_property ("context-info",
227 scm_from_int (prev_context_info));
228 prev_primitive = primitive;
229 prev_prefix_set = prefix_set;
230 prev_context_info = context_info;
234 prev_primitive->set_property ("context-info",
235 scm_from_int (prev_context_info));
239 Gregorian_ligature_engraver::build_ligature (Spanner *ligature,
240 vector<Grob_info> primitives)
242 // apply style-independent checking and transformation
243 check_and_fix_all_prefixes (primitives);
244 provide_context_info (primitives);
246 // apply style-specific transformation (including line-up); to be
247 // implemented by subclass
248 transform_heads (ligature, primitives);
252 Gregorian_ligature_engraver::stop_translation_timestep ()
254 Ligature_engraver::stop_translation_timestep ();
255 pes_or_flexa_req_ = 0;
258 // no ADD_ACKNOWLEDGER / ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
259 // since this class is abstract