2 vaticana-ligature-engraver.cc -- implement Vaticana_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"
10 #include "gregorian-ligature.hh"
11 #include "vaticana-ligature.hh"
13 #include "staff-symbol-referencer.hh"
14 #include "font-interface.hh"
16 #include "output-def.hh"
17 #include "paper-column.hh"
20 * This class implements the notation specific aspects of Vaticana
21 * style ligatures for Gregorian chant notation.
24 class Vaticana_ligature_engraver : public Gregorian_ligature_engraver
29 need_extra_horizontal_space (int prev_prefix_set, int prefix_set,
30 int context_info, int delta_pitch);
31 bool is_stacked_head (int prefix_set,
33 Real align_heads (Array<Grob_info> primitives,
38 TRANSLATOR_DECLARATIONS (Vaticana_ligature_engraver);
41 virtual Spanner *create_ligature_spanner ();
42 virtual void transform_heads (Spanner *ligature,
43 Array<Grob_info> primitives);
46 Vaticana_ligature_engraver::Vaticana_ligature_engraver ()
51 Vaticana_ligature_engraver::create_ligature_spanner ()
53 return make_spanner ("VaticanaLigature", SCM_EOL);
57 Vaticana_ligature_engraver::is_stacked_head (int prefix_set,
62 // upper head of pes is stacked upon lower head of pes ...
63 is_stacked_b = context_info & PES_UPPER;
65 // ... unless this note starts a flexa
66 if (context_info & FLEXA_LEFT)
70 if (context_info & PES_LOWER)
73 // ... or the previous note is a semivocalis or inclinatum
74 if (context_info & AFTER_DEMINUTUM)
77 // auctum head is never stacked upon preceding note
78 if (prefix_set & AUCTUM)
81 // virga is never stacked upon preceding note
82 if (prefix_set & VIRGA)
85 // oriscus is never stacked upon preceding note
86 if (prefix_set & ORISCUS)
89 if ((prefix_set & DEMINUTUM)
90 && ! (prefix_set & INCLINATUM)
91 && (context_info & FLEXA_RIGHT))
92 is_stacked_b = true; // semivocalis head of deminutus form
98 * When aligning the heads, sometimes extra space is needed, e.g. to
99 * avoid clashing with the appendix of an adjacent notehead or with an
100 * adjacent notehead itself if it has the same pitch. Extra space is
101 * added at most once between to heads.
104 Vaticana_ligature_engraver::need_extra_horizontal_space (int prev_prefix_set, int prefix_set,
105 int context_info, int delta_pitch)
107 if (prev_prefix_set & VIRGA)
109 * After a virga, make a an additional small space such that the
110 * appendix on the right side of the head does not touch the
115 if ((prefix_set & INCLINATUM)
116 && ! (prev_prefix_set & INCLINATUM))
118 * Always start a series of inclinatum heads with an extra space.
122 if ((context_info & FLEXA_LEFT) && ! (context_info & PES_UPPER))
124 * Before a flexa (but not within a torculus), make a an
125 * additional small space such that the appendix on the left side
126 * of the flexa does not touch the this head.
130 if (delta_pitch == 0)
132 * If there are two adjacent noteheads with the same pitch, add
133 * additional small space between them, such that they do not
142 Vaticana_ligature_engraver::align_heads (Array<Grob_info> primitives,
146 if (!primitives.size ())
148 programming_error ("Vaticana_ligature: "
149 "empty ligature [ignored]");
154 * The paper column where we put the whole ligature into.
157 = dynamic_cast<Item *> (primitives[0].grob_)->get_column ();
160 = thickness * column->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
163 * Amount of extra space two put between some particular
164 * configurations of adjacent heads.
166 * TODO: make this a property of primtive grobs.
168 Real extra_space = 4.0 * join_thickness;
171 * Keep track of the total width of the ligature.
173 Real ligature_width = 0.0;
175 Item *prev_primitive = 0;
176 int prev_prefix_set = 0;
177 for (int i = 0; i < primitives.size (); i++)
179 Item *primitive = dynamic_cast<Item *> (primitives[i].grob_);
181 = scm_to_int (primitive->get_property ("prefix-set"));
183 = scm_to_int (primitive->get_property ("context-info"));
186 * Get glyph_name, delta_pitch and context_info for this head.
189 SCM glyph_name_scm = primitive->get_property ("glyph-name");
190 if (glyph_name_scm == SCM_EOL)
192 primitive->programming_error ("Vaticana_ligature:"
193 "undefined glyph-name -> "
197 String glyph_name = ly_scm2string (glyph_name_scm);
200 if (prev_primitive) /* urgh, need prev_primitive only here */
202 SCM delta_pitch_scm = prev_primitive->get_property ("delta-pitch");
203 if (delta_pitch_scm != SCM_EOL)
205 delta_pitch = scm_to_int (delta_pitch_scm);
209 primitive->programming_error ("Vaticana_ligature:"
210 "delta-pitch undefined -> "
217 * Now determine width and x-offset of head.
223 if (context_info & STACKED_HEAD)
226 * This head is stacked upon the previous one; hence, it
227 * does not contribute to the total width of the ligature,
228 * and its width is assumed to be 0.0. Moreover, it is
229 * shifted to the left by its width such that the right side
230 * of this and the other head are horizontally aligned.
233 x_offset = join_thickness
234 - Font_interface::get_default_font (primitive)->
235 find_by_name ("noteheads." + glyph_name).extent (X_AXIS).length ();
237 else if (!String::compare (glyph_name, "flexa")
238 || !String::compare (glyph_name, ""))
241 * This head represents either half of a flexa shape.
242 * Hence, it is assigned half the width of this shape.
244 head_width = 0.5 * flexa_width;
250 * This is a regular head, placed right to the previous one.
251 * Retrieve its width from corresponding font.
254 = Font_interface::get_default_font (primitive)->
255 find_by_name ("noteheads." + glyph_name).extent (X_AXIS).length ();
260 * Save the head's final x-offset.
262 primitive->set_property ("x-offset",
263 scm_make_real (x_offset));
266 * If the head is the 2nd head of a pes or flexa (but not a
267 * flexa shape), mark this head to be joined with the left-side
268 * neighbour head (i.e. the previous head) by a vertical beam.
270 if ((context_info & PES_UPPER)
271 || ((context_info & FLEXA_RIGHT)
272 && ! (context_info & PES_LOWER)))
276 primitive->programming_error ("vaticana ligature: add-join: "
277 "missing previous primitive");
281 prev_primitive->set_property ("add-join",
285 * Create a small overlap of adjacent heads so that the join
286 * can be drawn perfectly between them.
288 ligature_width -= join_thickness;
291 else if (!String::compare (glyph_name, ""))
294 * This is the 2nd (virtual) head of flexa shape. Join it
295 * tightly with 1st head, i.e. do *not* add additional
296 * space, such that next head will not be off from the flexa
301 if (need_extra_horizontal_space (prev_prefix_set, prefix_set,
302 context_info, delta_pitch))
303 ligature_width += extra_space;
306 * Horizontally line-up this head to form a ligature.
308 get_set_column (primitive, column);
309 primitive->translate_axis (ligature_width, X_AXIS);
310 ligature_width += head_width;
312 prev_primitive = primitive;
313 prev_prefix_set = prefix_set;
317 * Add extra horizontal padding space after ligature, such that
318 * neighbouring ligatures do not touch each other.
320 ligature_width += extra_space;
322 return ligature_width;
326 * Depending on the typographical features of a particular ligature
327 * style, some prefixes may be ignored. In particular, if a curved
328 * flexa shape is produced, any prefixes to either of the two
329 * contributing heads that would select a head other than punctum, is
330 * by definition ignored.
332 * This function prints a warning, if the given primitive is prefixed
333 * such that a head other than punctum would be chosen, if this
334 * primitive were engraved as a stand-alone head.
337 check_for_prefix_loss (Item *primitive)
340 = scm_to_int (primitive->get_property ("prefix-set"));
341 if (prefix_set & ~PES_OR_FLEXA)
343 String prefs = Gregorian_ligature::prefixes_to_str (primitive);
344 primitive->warning (_f ("ignored prefix (es) `%s' of this head according "
345 "to restrictions of the selected ligature style",
351 Vaticana_ligature_engraver::transform_heads (Spanner *ligature,
352 Array<Grob_info> primitives)
354 Real flexa_width = robust_scm2double (ligature->get_property ("flexa-width"), 2);
356 Real thickness = robust_scm2double (ligature->get_property ("thickness"), 1);
358 Item *prev_primitive = 0;
359 int prev_prefix_set = 0;
360 int prev_context_info = 0;
361 int prev_delta_pitch = 0;
362 String prev_glyph_name = "";
363 for (int i = 0; i < primitives.size (); i++)
365 Item *primitive = dynamic_cast<Item *> (primitives[i].grob_);
368 SCM delta_pitch_scm = primitive->get_property ("delta-pitch");
369 if (delta_pitch_scm != SCM_EOL)
371 delta_pitch = scm_to_int (delta_pitch_scm);
375 primitive->programming_error ("Vaticana_ligature:"
376 "delta-pitch undefined -> "
381 /* retrieve & complete prefix_set and context_info */
383 = scm_to_int (primitive->get_property ("prefix-set"));
385 = scm_to_int (primitive->get_property ("context-info"));
386 if (is_stacked_head (prefix_set, context_info))
388 context_info |= STACKED_HEAD;
389 primitive->set_property ("context-info",
390 scm_int2num (context_info));
394 * Now determine which head to typeset (this is context sensitive
395 * information, since it depends on neighbouring heads; therefore,
396 * this decision must be made here in the engraver rather than in
400 if (prefix_set & VIRGA)
402 glyph_name = "svaticana.punctum";
403 primitive->set_property ("add-stem", ly_bool2scm (true));
405 else if (prefix_set & QUILISMA)
406 glyph_name = "svaticana.quilisma";
407 else if (prefix_set & ORISCUS)
408 glyph_name = "ssolesmes.oriscus";
409 else if (prefix_set & STROPHA)
410 if (prefix_set & AUCTUM)
411 glyph_name = "ssolesmes.stropha.aucta";
412 else glyph_name = "ssolesmes.stropha";
413 else if (prefix_set & INCLINATUM)
414 if (prefix_set & AUCTUM)
415 glyph_name = "ssolesmes.incl.auctum";
416 else if (prefix_set & DEMINUTUM)
417 glyph_name = "ssolesmes.incl.parvum";
419 glyph_name = "svaticana.inclinatum";
420 else if (prefix_set & DEMINUTUM)
424 glyph_name = "svaticana.reverse.plica";
426 else if (prev_delta_pitch > 0)
429 if (! (prev_context_info & FLEXA_RIGHT))
430 /* correct head of previous primitive */
431 if (prev_delta_pitch > 1)
433 prev_glyph_name = "svaticana.epiphonus";
434 glyph_name = "svaticana.plica";
438 prev_glyph_name = "svaticana.vepiphonus";
439 glyph_name = "svaticana.vplica";
442 else if (prev_delta_pitch < 0)
445 if (! (prev_context_info & FLEXA_RIGHT))
446 /* correct head of previous primitive */
450 /* cephalicus head with fixed size cauda */
451 prev_glyph_name = "svaticana.inner.cephalicus";
455 /* cephalicus head without cauda */
456 prev_glyph_name = "svaticana.cephalicus";
460 * Flexa has no variable size cauda if its left head is
461 * stacked on the right head. This is true for
462 * cephalicus. Hence, remove the cauda.
464 * Urgh: for the current implementation, this rule only
465 * applies for cephalicus; but it is a fundamental rule.
466 * Therefore, the following line of code should be
467 * placed somewhere else.
469 prev_primitive->set_property ("add-cauda",
470 ly_bool2scm (false));
472 if (prev_delta_pitch < - 1)
474 glyph_name = "svaticana.reverse.plica";
478 glyph_name = "svaticana.reverse.vplica";
481 else // (prev_delta_pitch == 0)
483 primitive->programming_error ("Vaticana_ligature:"
484 "deminutum head must have different "
485 "pitch -> ignoring grob");
487 else if (prefix_set & (CAVUM | LINEA))
488 if ((prefix_set & CAVUM) && (prefix_set & LINEA))
489 glyph_name = "svaticana.linea.punctum.cavum";
490 else if (prefix_set & CAVUM)
491 glyph_name = "svaticana.punctum.cavum";
493 glyph_name = "svaticana.linea.punctum";
494 else if (prefix_set & AUCTUM)
495 if (prefix_set & ASCENDENS)
496 glyph_name = "ssolesmes.auct.asc";
498 glyph_name = "ssolesmes.auct.desc";
499 else if ((context_info & STACKED_HEAD)
500 && (context_info & PES_UPPER))
501 if (prev_delta_pitch > 1)
502 glyph_name = "svaticana.upes";
504 glyph_name = "svaticana.vupes";
506 glyph_name = "svaticana.punctum";
509 * This head needs a cauda, if it starts a flexa, is not the upper
510 * head of a pes, and if it is a punctum.
512 if ((context_info & FLEXA_LEFT) && ! (context_info & PES_UPPER))
513 if (!String::compare (glyph_name, "svaticana.punctum"))
514 primitive->set_property ("add-cauda", ly_bool2scm (true));
517 * Execptional rule for porrectus:
519 * If the current head is preceded by a \flexa and succeded by a
520 * \pes (e.g. "a \flexa g \pes a"), then join the current head and
521 * the previous head into a single curved flexa shape.
523 if ((context_info & FLEXA_RIGHT) && (context_info & PES_LOWER))
525 check_for_prefix_loss (prev_primitive);
526 prev_glyph_name = "flexa";
527 prev_primitive->set_property ("flexa-height",
528 scm_int2num (prev_delta_pitch));
529 prev_primitive->set_property ("flexa-width",
530 scm_make_real (flexa_width));
531 bool add_cauda = !(prev_prefix_set && PES_OR_FLEXA);
532 prev_primitive->set_property ("add-cauda",
533 ly_bool2scm (add_cauda));
534 check_for_prefix_loss (primitive);
536 primitive->set_property ("flexa-width",
537 scm_make_real (flexa_width));
541 * Exceptional rule for pes:
543 * If this head is stacked on the previous one due to a \pes, then
544 * set the glyph of the previous head to that for this special
545 * case, thereby avoiding potential vertical collision with the
548 if (prefix_set & PES_OR_FLEXA)
550 if ((context_info & PES_UPPER) && (context_info & STACKED_HEAD))
552 if (!String::compare (prev_glyph_name, "svaticana.punctum"))
553 if (prev_delta_pitch > 1)
554 prev_glyph_name = "svaticana.lpes";
556 prev_glyph_name = "svaticana.vlpes";
561 prev_primitive->set_property ("glyph-name",
562 scm_makfrom0str (prev_glyph_name.to_str0 ()));
565 * In the backend, flexa shapes and joins need to know about line
566 * thickness. Hence, for simplicity, let's distribute the
567 * ligature grob's value for thickness to each ligature head (even
568 * if not all of them need to know).
570 primitive->set_property ("thickness", scm_make_real (thickness));
572 prev_primitive = primitive;
573 prev_prefix_set = prefix_set;
574 prev_context_info = context_info;
575 prev_delta_pitch = delta_pitch;
576 prev_glyph_name = glyph_name;
579 prev_primitive->set_property ("glyph-name",
580 scm_makfrom0str (prev_glyph_name.to_str0 ()));
582 align_heads (primitives, flexa_width, thickness);
584 #if 0 // experimental code to collapse spacing after ligature
585 /* TODO: set to max (old/new spacing-increment), since other
586 voices/staves also may want to set this property. */
587 Item *first_primitive = dynamic_cast<Item *> (primitives[0].grob_);
588 Paper_column *paper_column = first_primitive->get_column ();
589 paper_column->warning (_f ("Vaticana_ligature_engraver: "
590 "setting `spacing-increment = %f': ptr =%ul",
591 ligature_width, paper_column));
593 set_property ("forced-spacing", scm_make_real (ligature_width));
597 ADD_TRANSLATOR (Vaticana_ligature_engraver,
598 /* descr */ "Handles ligatures by glueing special ligature heads together.",
599 /* creats*/ "VaticanaLigature",
600 /* accepts */ "ligature-event",
601 /* acks */ "note-head-interface rest-interface",