2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2003--2015 Juergen Reuter <reuter@ipd.uka.de>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "gregorian-ligature-engraver.hh"
22 #include "gregorian-ligature.hh"
23 #include "international.hh"
24 #include "paper-column.hh"
27 #include "staff-symbol-referencer.hh"
28 #include "stream-event.hh"
31 /* ASSIGN_EVENT_ONCE */
32 #include "translator.icc"
35 * This abstract class is the common superclass for all ligature
36 * engravers for Gregorian chant notation. It cares for the musical
37 * handling of the neumes, such as checking for valid combinations of
38 * neumes and providing context information. Notational aspects such
39 * as the glyphs to use or calculating the total width of a ligature,
40 * are left to the concrete subclass. Currently, there is only a
41 * single subclass, Vaticana_ligature_engraver. Other ligature
42 * engravers for Gregorian chant will be added in the future, such as
43 * Medicaea_ligature_engraver or Hufnagel_ligature_engraver.
45 Gregorian_ligature_engraver::Gregorian_ligature_engraver (Context *c)
46 : Coherent_ligature_engraver (c)
48 pes_or_flexa_req_ = 0;
52 Gregorian_ligature_engraver::listen_pes_or_flexa (Stream_event *ev)
54 ASSIGN_EVENT_ONCE (pes_or_flexa_req_, ev);
57 void fix_prefix (char const *name, int mask,
58 int *current_set, int min_set, int max_set,
61 bool current = *current_set & mask;
62 bool min = min_set & mask;
63 bool max = max_set & mask;
66 programming_error ("min_set > max_set");
71 primitive->warning (_f ("\\%s ignored", name));
72 *current_set &= ~mask;
76 primitive->warning (_f ("implied \\%s added", name));
81 void fix_prefix_set (int *current_set, int min_set, int max_set, Grob *primitive)
83 fix_prefix ("virga", VIRGA, current_set, min_set, max_set, primitive);
84 fix_prefix ("stropha", STROPHA, current_set, min_set, max_set, primitive);
85 fix_prefix ("inclinatum", INCLINATUM, current_set, min_set, max_set, primitive);
86 fix_prefix ("auctum", AUCTUM, current_set, min_set, max_set, primitive);
87 fix_prefix ("descendens", DESCENDENS, current_set, min_set, max_set, primitive);
88 fix_prefix ("ascendens", ASCENDENS, current_set, min_set, max_set, primitive);
89 fix_prefix ("oriscus", ORISCUS, current_set, min_set, max_set, primitive);
90 fix_prefix ("quilisma", QUILISMA, current_set, min_set, max_set, primitive);
91 fix_prefix ("deminutum", DEMINUTUM, current_set, min_set, max_set, primitive);
92 fix_prefix ("cavum", CAVUM, current_set, min_set, max_set, primitive);
93 fix_prefix ("linea", LINEA, current_set, min_set, max_set, primitive);
94 fix_prefix ("pes_or_flexa", LINEA, current_set, min_set, max_set, primitive);
97 void check_and_fix_all_prefixes (vector<Grob_info> const &primitives)
99 /* Check for invalid head modifier combinations */
100 for (vsize i = 0; i < primitives.size (); i++)
102 Grob *primitive = primitives[i].grob ();
104 /* compute head prefix set by inspecting primitive grob properties */
106 = (VIRGA * to_boolean (primitive->get_property ("virga")))
107 | (STROPHA * to_boolean (primitive->get_property ("stropha")))
108 | (INCLINATUM * to_boolean (primitive->get_property ("inclinatum")))
109 | (AUCTUM * to_boolean (primitive->get_property ("auctum")))
110 | (DESCENDENS * to_boolean (primitive->get_property ("descendens")))
111 | (ASCENDENS * to_boolean (primitive->get_property ("ascendens")))
112 | (ORISCUS * to_boolean (primitive->get_property ("oriscus")))
113 | (QUILISMA * to_boolean (primitive->get_property ("quilisma")))
114 | (DEMINUTUM * to_boolean (primitive->get_property ("deminutum")))
115 | (CAVUM * to_boolean (primitive->get_property ("cavum")))
116 | (LINEA * to_boolean (primitive->get_property ("linea")))
117 | (PES_OR_FLEXA * to_boolean (primitive->get_property ("pes-or-flexa")));
119 /* check: ascendens and descendens exclude each other; same with
120 auctum and deminutum */
121 if (prefix_set & DESCENDENS)
123 fix_prefix_set (&prefix_set,
124 prefix_set & ~ASCENDENS,
125 prefix_set & ~ASCENDENS,
128 if (prefix_set & AUCTUM)
130 fix_prefix_set (&prefix_set,
131 prefix_set & ~DEMINUTUM,
132 prefix_set & ~DEMINUTUM,
136 /* check: virga, quilisma and oriscus cannot be combined with any
137 other prefix, but may be part of a pes or flexa */
138 if (prefix_set & VIRGA)
140 fix_prefix_set (&prefix_set,
142 VIRGA | PES_OR_FLEXA,
145 if (prefix_set & QUILISMA)
147 fix_prefix_set (&prefix_set,
149 QUILISMA | PES_OR_FLEXA,
152 if (prefix_set & ORISCUS)
154 fix_prefix_set (&prefix_set,
156 ORISCUS | PES_OR_FLEXA,
160 /* check: auctum is the only valid optional prefix for stropha */
161 if (prefix_set & STROPHA)
163 fix_prefix_set (&prefix_set,
169 /* check: inclinatum may be prefixed with auctum or deminutum only */
170 if (prefix_set & INCLINATUM)
172 fix_prefix_set (&prefix_set,
174 INCLINATUM | AUCTUM | DEMINUTUM,
177 /* check: semivocalis (deminutum but not inclinatum) must occur in
178 combination with and only with pes or flexa */
179 else if (prefix_set & DEMINUTUM)
181 fix_prefix_set (&prefix_set,
182 DEMINUTUM | PES_OR_FLEXA,
183 DEMINUTUM | PES_OR_FLEXA,
187 /* check: cavum and linea (either or both) may be applied only
189 if (prefix_set & (CAVUM | LINEA))
191 fix_prefix_set (&prefix_set,
197 /* all other combinations should be valid (unless I made a
200 primitive->set_property ("prefix-set", scm_from_int (prefix_set));
205 * Marks those heads that participate in a pes or flexa.
208 provide_context_info (vector<Grob_info> const &primitives)
210 Grob *prev_primitive = 0;
211 int prev_prefix_set = 0;
212 int prev_context_info = 0;
214 for (vsize i = 0; i < primitives.size (); i++)
216 Grob *primitive = primitives[i].grob ();
217 Stream_event *event_cause = primitives[i].event_cause ();
218 int context_info = 0;
219 int pitch = unsmob<Pitch> (event_cause->get_property ("pitch"))->steps ();
220 int prefix_set = scm_to_int (primitive->get_property ("prefix-set"));
222 if (prefix_set & PES_OR_FLEXA)
224 if (!i) // ligature may not start with 2nd head of pes or flexa
225 primitive->warning (_ ("cannot apply `\\~' on first head of ligature"));
226 else if (pitch > prev_pitch) // pes
228 prev_context_info |= PES_LOWER;
229 context_info |= PES_UPPER;
231 else if (pitch < prev_pitch) // flexa
233 prev_context_info |= FLEXA_LEFT;
234 context_info |= FLEXA_RIGHT;
236 else // (pitch == prev_pitch)
237 primitive->warning (_ ("cannot apply `\\~' on heads with identical pitch"));
239 if (prev_prefix_set & DEMINUTUM)
240 context_info |= AFTER_DEMINUTUM;
243 prev_primitive->set_property ("context-info",
244 scm_from_int (prev_context_info));
245 prev_primitive = primitive;
246 prev_prefix_set = prefix_set;
247 prev_context_info = context_info;
251 prev_primitive->set_property ("context-info",
252 scm_from_int (prev_context_info));
256 Gregorian_ligature_engraver::build_ligature (Spanner *ligature,
257 vector<Grob_info> const &primitives)
259 // apply style-independent checking and transformation
260 check_and_fix_all_prefixes (primitives);
261 provide_context_info (primitives);
263 // apply style-specific transformation (including line-up); to be
264 // implemented by subclass
265 transform_heads (ligature, primitives);
269 Gregorian_ligature_engraver::stop_translation_timestep ()
271 Ligature_engraver::stop_translation_timestep ();
272 pes_or_flexa_req_ = 0;
275 // no ADD_ACKNOWLEDGER / ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
276 // since this class is abstract