]> git.donarmstrong.com Git - lilypond.git/blob - lily/vaticana-ligature-engraver.cc
Doc-es: Update of Input.
[lilypond.git] / lily / vaticana-ligature-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 2003--2009 Juergen Reuter <reuter@ipd.uka.de>
5
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.
10
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.
15
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/>.
18 */
19
20 #include "gregorian-ligature-engraver.hh"
21
22 #include "font-interface.hh"
23 #include "gregorian-ligature.hh"
24 #include "international.hh"
25 #include "output-def.hh"
26 #include "paper-column.hh"
27 #include "separation-item.hh"
28 #include "spanner.hh"
29 #include "staff-symbol-referencer.hh"
30 #include "stream-event.hh"
31 #include "vaticana-ligature.hh"
32 #include "warn.hh"
33 #include "dot-column.hh"
34 #include "rhythmic-head.hh"
35 #include "pitch.hh"
36 #include "translator.icc"
37
38 /*
39  * This class implements the notation specific aspects of Vaticana
40  * style ligatures for Gregorian chant notation.
41  */
42
43 /*
44  * TODO: Maybe move handling of dots/mora to
45  * Gregorian_ligature_engraver?  It's probably common for all types of
46  * Gregorian chant notation that have dotted notes.
47  *
48  * FIXME: The horizontal alignment of the mora column is bad (too far
49  * to the left), if the last dotted note is not the last primitive in
50  * the ligature.  Fortunately, in practice this bug should have no
51  * negative impact, since dotted notes appear within a ligature
52  * usually always at the end of the ligature, such that the bug never
53  * should apply for valid ligatures.
54  *
55  * TODO: Graduale Triplex, tempus per annum, hebdomada septima,
56  * alleluia (page 280) shows a counter-example for collecting dots
57  * always in a single column behind the ligature.  Maybe only the last
58  * two dots in a ligature should be collected and all other dots put
59  * behind or on top of the head?
60  */
61 class Vaticana_ligature_engraver : public Gregorian_ligature_engraver
62 {
63
64 private:
65   static bool
66   need_extra_horizontal_space (int prev_prefix_set, int prefix_set,
67                                int context_info, int delta_pitch);
68   bool is_stacked_head (int prefix_set,
69                         int context_info);
70   Real align_heads (vector<Grob_info> primitives,
71                     Real flexa_width,
72                     Real thickness);
73   void check_for_prefix_loss (Item *primitive);
74   void check_for_ambiguous_dot_pitch (Grob_info primitive);
75   void add_mora_column (Paper_column *column);
76   vector<Grob_info> augmented_primitives_;
77
78 public:
79   TRANSLATOR_DECLARATIONS (Vaticana_ligature_engraver);
80
81 protected:
82   virtual Spanner *create_ligature_spanner ();
83   virtual void transform_heads (Spanner *ligature,
84                                 vector<Grob_info> primitives);
85   DECLARE_TRANSLATOR_LISTENER (pes_or_flexa);
86   DECLARE_TRANSLATOR_LISTENER (ligature);
87 };
88
89 IMPLEMENT_TRANSLATOR_LISTENER (Vaticana_ligature_engraver, pes_or_flexa);
90 void
91 Vaticana_ligature_engraver::listen_pes_or_flexa (Stream_event *ev)
92 {
93   Gregorian_ligature_engraver::listen_pes_or_flexa (ev);
94 }
95
96 IMPLEMENT_TRANSLATOR_LISTENER (Vaticana_ligature_engraver, ligature);
97 void
98 Vaticana_ligature_engraver::listen_ligature (Stream_event *ev)
99 {
100   Ligature_engraver::listen_ligature (ev);
101 }
102
103 Vaticana_ligature_engraver::Vaticana_ligature_engraver ()
104 {
105   brew_ligature_primitive_proc = 
106     Vaticana_ligature::brew_ligature_primitive_proc;
107   augmented_primitives_.clear ();
108 }
109
110 Spanner *
111 Vaticana_ligature_engraver::create_ligature_spanner ()
112 {
113   return make_spanner ("VaticanaLigature", SCM_EOL);
114 }
115
116 bool
117 Vaticana_ligature_engraver::is_stacked_head (int prefix_set,
118                                              int context_info)
119 {
120   bool is_stacked;
121
122   // upper head of pes is stacked upon lower head of pes ...
123   is_stacked = context_info & PES_UPPER;
124
125   // ... unless this note starts a flexa
126   if (context_info & FLEXA_LEFT)
127     is_stacked = false;
128
129   // ... or another pes
130   if (context_info & PES_LOWER)
131     is_stacked = false;
132
133   // ... or the previous note is a semivocalis or inclinatum
134   if (context_info & AFTER_DEMINUTUM)
135     is_stacked = false;
136
137   // auctum head is never stacked upon preceding note
138   if (prefix_set & AUCTUM)
139     is_stacked = false;
140
141   // virga is never stacked upon preceding note
142   if (prefix_set & VIRGA)
143     is_stacked = false;
144
145   // oriscus is never stacked upon preceding note
146   if (prefix_set & ORISCUS)
147     is_stacked = false;
148
149   if ((prefix_set & DEMINUTUM)
150       && ! (prefix_set & INCLINATUM)
151       && (context_info & FLEXA_RIGHT))
152     is_stacked = true; // semivocalis head of deminutus form
153
154   return is_stacked;
155 }
156
157 /*
158  * When aligning the heads, sometimes extra space is needed, e.g. to
159  * avoid clashing with the appendix of an adjacent notehead or with an
160  * adjacent notehead itself if it has the same pitch.  Extra space is
161  * added at most once between to heads.
162  */
163 bool
164 Vaticana_ligature_engraver::need_extra_horizontal_space (int prev_prefix_set, int prefix_set,
165                                                          int context_info, int delta_pitch)
166 {
167   if (prev_prefix_set & VIRGA)
168     /*
169      * After a virga, make a an additional small space such that the
170      * appendix on the right side of the head does not touch the
171      * following head.
172      */
173     return true;
174
175   if ((prefix_set & INCLINATUM)
176       && ! (prev_prefix_set & INCLINATUM))
177     /*
178      * Always start a series of inclinatum heads with an extra space.
179      */
180     return true;
181
182   if ((context_info & FLEXA_LEFT) && ! (context_info & PES_UPPER))
183     /*
184      * Before a flexa (but not within a torculus), make a an
185      * additional small space such that the appendix on the left side
186      * of the flexa does not touch the this head.
187      */
188     return true;
189
190   if (delta_pitch == 0)
191     /*
192      * If there are two adjacent noteheads with the same pitch, add
193      * additional small space between them, such that they do not
194      * touch each other.
195      */
196     return true;
197
198   return false;
199 }
200
201 Real
202 Vaticana_ligature_engraver::align_heads (vector<Grob_info> primitives,
203                                          Real flexa_width,
204                                          Real thickness)
205 {
206   if (!primitives.size ())
207     {
208       programming_error ("Vaticana_ligature: "
209                          "empty ligature [ignored]");
210       return 0.0;
211     }
212
213   /*
214    * The paper column where we put the whole ligature into.
215    */
216   Paper_column *column
217     = dynamic_cast<Item *> (primitives[0].grob ())->get_column ();
218
219   Real join_thickness
220     = thickness * column->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
221
222   /*
223    * Amount of extra space two put between some particular
224    * configurations of adjacent heads.
225    *
226    * TODO: make this a property of primtive grobs.
227    */
228   Real extra_space = 4.0 * join_thickness;
229
230   /*
231    * Keep track of the total width of the ligature.
232    */
233   Real ligature_width = 0.0;
234
235   Item *prev_primitive = 0;
236   int prev_prefix_set = 0;
237   for (vsize i = 0; i < primitives.size (); i++)
238     {
239       Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
240       int prefix_set
241         = scm_to_int (primitive->get_property ("prefix-set"));
242       int context_info
243         = scm_to_int (primitive->get_property ("context-info"));
244
245       /*
246        * Get glyph_name, delta_pitch and context_info for this head.
247        */
248
249       SCM glyph_name_scm = primitive->get_property ("glyph-name");
250       if (glyph_name_scm == SCM_EOL)
251         {
252           primitive->programming_error ("Vaticana_ligature:"
253                                         " undefined glyph-name ->"
254                                         " ignoring grob");
255           continue;
256         }
257       string glyph_name = ly_scm2string (glyph_name_scm);
258
259       int delta_pitch = 0;
260       if (prev_primitive) /* urgh, need prev_primitive only here */
261         {
262           SCM delta_pitch_scm = prev_primitive->get_property ("delta-position");
263           if (delta_pitch_scm != SCM_EOL)
264             delta_pitch = scm_to_int (delta_pitch_scm);
265           else
266             {
267               primitive->programming_error ("Vaticana_ligature:"
268                                             " delta-position undefined ->"
269                                             " ignoring grob");
270               continue;
271             }
272         }
273
274       /*
275        * Now determine width and x-offset of head.
276        */
277
278       Real head_width;
279       Real x_offset;
280
281       if (context_info & STACKED_HEAD)
282         {
283           /*
284            * This head is stacked upon the previous one; hence, it
285            * does not contribute to the total width of the ligature,
286            * and its width is assumed to be 0.0.  Moreover, it is
287            * shifted to the left by its width such that the right side
288            * of this and the other head are horizontally aligned.
289            */
290           head_width = 0.0;
291           x_offset = join_thickness
292             - Font_interface::get_default_font (primitive)->
293             find_by_name ("noteheads.s" + glyph_name).extent (X_AXIS).length ();
294         }
295       else if (glyph_name == "flexa" || glyph_name == "")
296         {
297           /*
298            * This head represents either half of a flexa shape.
299            * Hence, it is assigned half the width of this shape.
300            */
301           head_width = 0.5 * flexa_width;
302           x_offset = 0.0;
303         }
304       else
305         {
306           /*
307            * This is a regular head, placed right to the previous one.
308            * Retrieve its width from corresponding font.
309            */
310           head_width
311             = Font_interface::get_default_font (primitive)->
312             find_by_name ("noteheads.s" + glyph_name).extent (X_AXIS).length ();
313           x_offset = 0.0;
314         }
315
316       /*
317        * Save the head's final x-offset.
318        */
319       primitive->set_property ("x-offset",
320                                scm_from_double (x_offset));
321
322       /*
323        * If the head is the 2nd head of a pes or flexa (but not a
324        * flexa shape), mark this head to be joined with the left-side
325        * neighbour head (i.e. the previous head) by a vertical beam.
326        */
327       if ((context_info & PES_UPPER)
328           || ((context_info & FLEXA_RIGHT)
329               && ! (context_info & PES_LOWER)))
330         {
331           if (!prev_primitive)
332             {
333               primitive->programming_error ("vaticana ligature: add-join: "
334                                             "missing previous primitive");
335             }
336           else
337             {
338               prev_primitive->set_property ("add-join",
339                                             ly_bool2scm (true));
340
341               /*
342                * Create a small overlap of adjacent heads so that the join
343                * can be drawn perfectly between them.
344                */
345               ligature_width -= join_thickness;
346             }
347         }
348       else if (glyph_name == "")
349         {
350           /*
351            * This is the 2nd (virtual) head of flexa shape.  Join it
352            * tightly with 1st head, i.e. do *not* add additional
353            * space, such that next head will not be off from the flexa
354            * shape.
355            */
356         }
357
358       if (need_extra_horizontal_space (prev_prefix_set, prefix_set,
359                                        context_info, delta_pitch))
360         ligature_width += extra_space;
361
362       /*
363        * Horizontally line-up this head to form a ligature.
364        */
365       move_related_items_to_column (primitive, column, ligature_width);
366       ligature_width += head_width;
367
368       prev_primitive = primitive;
369       prev_prefix_set = prefix_set;
370     }
371
372   /*
373    * Add extra horizontal padding space after ligature, such that
374    * neighbouring ligatures do not touch each other.
375    */
376   ligature_width += extra_space;
377
378   return ligature_width;
379 }
380
381 /*
382  * Depending on the typographical features of a particular ligature
383  * style, some prefixes may be ignored.  In particular, if a curved
384  * flexa shape is produced, any prefixes to either of the two
385  * contributing heads that would select a head other than punctum, is
386  * by definition ignored.
387  *
388  * This function prints a warning, if the given primitive is prefixed
389  * such that a head other than punctum would be chosen, if this
390  * primitive were engraved as a stand-alone head.
391  */
392 void
393 Vaticana_ligature_engraver::check_for_prefix_loss (Item *primitive)
394 {
395   int prefix_set
396     = scm_to_int (primitive->get_property ("prefix-set"));
397   if (prefix_set & ~PES_OR_FLEXA)
398     {
399       string prefs = Gregorian_ligature::prefixes_to_str (primitive);
400       primitive->warning (_f ("ignored prefix (es) `%s' of this head according "
401                               "to restrictions of the selected ligature style",
402                               prefs.c_str ()));
403     }
404 }
405
406 void
407 Vaticana_ligature_engraver::add_mora_column (Paper_column *column)
408 {
409   if (augmented_primitives_.size () == 0) // no dot for column
410     return;
411   if (!column) // empty ligature???
412     {
413       augmented_primitives_[0].grob ()->
414         programming_error ("no paper column to add dot");
415       return;
416     }
417   Item *dotcol = make_item ("DotColumn", SCM_EOL);
418   dotcol->set_parent (column, X_AXIS);
419   for (vsize i = 0; i < augmented_primitives_.size (); i++)
420     {
421       Item *primitive =
422         dynamic_cast<Item *> (augmented_primitives_[i].grob ());
423       Item *dot = make_item ("Dots", primitive->self_scm ());
424       dot->set_property ("dot-count", scm_from_int (1));
425       dot->set_parent (primitive, Y_AXIS);
426       primitive->set_object ("dot", dot->self_scm ());
427       Dot_column::add_head (dotcol, primitive);
428
429       // FIXME: why isn't the dot picked up by Paper_column_engraver?
430       Separation_item::add_item (column, dot);
431     }
432 }
433
434 /*
435  * This function prints a warning, if the given primitive has the same
436  * pitch as at least one of the primitives already stored in the
437  * augmented_primitives_ array.
438  *
439  * The rationale of this check is, that, if there are two dotted
440  * primitives with the same pitch, then collecting all dots in a dot
441  * column behind the ligature leads to a notational ambiguity of to
442  * which head the corresponding dot refers.
443  *
444  * Such a case should be treated as a badly specified ligature.  The
445  * user should split the ligature to make the notation of dots
446  * unambiguous.
447  */
448 void
449 Vaticana_ligature_engraver::check_for_ambiguous_dot_pitch (Grob_info primitive)
450 {
451   // TODO: Fix performance, which is currently O (n^2) (since this
452   // method is called O (n) times and takes O (n) steps in the for
453   // loop), but could be O (n) (by replacing the for loop by e.g. a
454   // bitmask based O (1) test); where n=<number of primitives in the
455   // ligature> (which is typically small (n<10), though).
456   Stream_event *new_cause = primitive.event_cause ();
457   int new_pitch = unsmob_pitch (new_cause->get_property ("pitch"))->steps ();
458   for (vsize i = 0; i < augmented_primitives_.size (); i++)
459     {
460       Stream_event *cause = augmented_primitives_[i].event_cause ();
461       int pitch = unsmob_pitch (cause->get_property ("pitch"))->steps ();
462       if (pitch == new_pitch)
463         {
464           primitive.grob ()->
465             warning ("Ambiguous use of dots in ligature: there are "
466                      "multiple dotted notes with the same pitch.  "
467                      "The ligature should be split.");
468           return; // supress multiple identical warnings
469         }
470     }
471 }
472
473 void
474 Vaticana_ligature_engraver::transform_heads (Spanner *ligature,
475                                              vector<Grob_info> primitives)
476 {
477   Real flexa_width = robust_scm2double (ligature->get_property ("flexa-width"), 2);
478
479   Real thickness = robust_scm2double (ligature->get_property ("thickness"), 1);
480
481   Item *prev_primitive = 0;
482   int prev_prefix_set = 0;
483   int prev_context_info = 0;
484   int prev_delta_pitch = 0;
485   string prev_glyph_name = "";
486   augmented_primitives_.clear ();
487   for (vsize i = 0; i < primitives.size (); i++)
488     {
489       Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
490
491       int delta_pitch;
492       SCM delta_pitch_scm = primitive->get_property ("delta-position");
493       if (delta_pitch_scm != SCM_EOL)
494         delta_pitch = scm_to_int (delta_pitch_scm);
495       else
496         {
497           primitive->programming_error ("Vaticana_ligature:"
498                                         " delta-position undefined ->"
499                                         " ignoring grob");
500           continue;
501         }
502
503       /* retrieve & complete prefix_set and context_info */
504       int prefix_set
505         = scm_to_int (primitive->get_property ("prefix-set"));
506       int context_info
507         = scm_to_int (primitive->get_property ("context-info"));
508
509       if (Rhythmic_head::dot_count (primitive) > 0)
510         // remove dots from primitive and add remember primitive for
511         // creating a dot column
512         {
513           Rhythmic_head::get_dots (primitive)->set_property ("dot-count",
514                                                              scm_from_int (0));
515           // TODO: Maybe completely remove grob "Dots" (dots->suicide
516           // () ?) rather than setting property "dot-count" to 0.
517
518           check_for_ambiguous_dot_pitch (primitives[i]);
519           augmented_primitives_.push_back (primitives[i]);
520         }
521       else if (augmented_primitives_.size () > 0)
522         {
523           primitive->warning ("This ligature has a dotted head followed by "
524                               "a non-dotted head.  The ligature should be "
525                               "split after the last dotted head before "
526                               "this head.");
527         }
528
529       if (is_stacked_head (prefix_set, context_info))
530         {
531           context_info |= STACKED_HEAD;
532           primitive->set_property ("context-info",
533                                    scm_from_int (context_info));
534         }
535
536       /*
537        * Now determine which head to typeset (this is context sensitive
538        * information, since it depends on neighbouring heads; therefore,
539        * this decision must be made here in the engraver rather than in
540        * the backend).
541        */
542       string glyph_name;
543       if (prefix_set & VIRGA)
544         {
545           glyph_name = "vaticana.punctum";
546           primitive->set_property ("add-stem", ly_bool2scm (true));
547         }
548       else if (prefix_set & QUILISMA)
549         glyph_name = "vaticana.quilisma";
550       else if (prefix_set & ORISCUS)
551         glyph_name = "solesmes.oriscus";
552       else if (prefix_set & STROPHA)
553         if (prefix_set & AUCTUM)
554           glyph_name = "solesmes.stropha.aucta";
555         else glyph_name = "solesmes.stropha";
556       else if (prefix_set & INCLINATUM)
557         if (prefix_set & AUCTUM)
558           glyph_name = "solesmes.incl.auctum";
559         else if (prefix_set & DEMINUTUM)
560           glyph_name = "solesmes.incl.parvum";
561         else
562           glyph_name = "vaticana.inclinatum";
563       else if (prefix_set & DEMINUTUM)
564         {
565           if (i == 0)
566             {
567               // initio debilis
568               glyph_name = "vaticana.reverse.plica";
569             }
570           else if (prev_delta_pitch > 0)
571             {
572               // epiphonus
573               if (! (prev_context_info & FLEXA_RIGHT))
574                 {
575                   /* correct head of previous primitive */
576                   if (prev_delta_pitch > 1)
577                     prev_glyph_name = "vaticana.epiphonus";
578                   else
579                     prev_glyph_name = "vaticana.vepiphonus";
580                 }
581               if (prev_delta_pitch > 1)
582                 glyph_name = "vaticana.plica";
583               else
584                 glyph_name = "vaticana.vplica";
585             }
586           else if (prev_delta_pitch < 0)
587             {
588               // cephalicus
589               if (! (prev_context_info & FLEXA_RIGHT))
590                 /* correct head of previous primitive */
591                 {
592                   if (i > 1)
593                     {
594                       /* cephalicus head with fixed size cauda */
595                       prev_glyph_name = "vaticana.inner.cephalicus";
596                     }
597                   else
598                     {
599                       /* cephalicus head without cauda */
600                       prev_glyph_name = "vaticana.cephalicus";
601                     }
602
603                   /*
604                    * Flexa has no variable size cauda if its left head is
605                    * stacked on the right head.  This is true for
606                    * cephalicus.  Hence, remove the cauda.
607                    *
608                    * Urgh: for the current implementation, this rule only
609                    * applies for cephalicus; but it is a fundamental rule.
610                    * Therefore, the following line of code should be
611                    * placed somewhere else.
612                    */
613                   prev_primitive->set_property ("add-cauda",
614                                                 ly_bool2scm (false));
615                 }
616               if (prev_delta_pitch < - 1)
617                 glyph_name = "vaticana.reverse.plica";
618               else
619                 glyph_name = "vaticana.reverse.vplica";
620             }
621           else // (prev_delta_pitch == 0)
622             {
623               primitive->programming_error ("Vaticana_ligature:"
624                                             " deminutum head must have different"
625                                             " pitch -> ignoring grob");
626             }
627         }
628       else if (prefix_set & (CAVUM | LINEA))
629         if ((prefix_set & CAVUM) && (prefix_set & LINEA))
630           glyph_name = "vaticana.linea.punctum.cavum";
631         else if (prefix_set & CAVUM)
632           glyph_name = "vaticana.punctum.cavum";
633         else
634           glyph_name = "vaticana.linea.punctum";
635       else if (prefix_set & AUCTUM)
636         if (prefix_set & ASCENDENS)
637           glyph_name = "solesmes.auct.asc";
638         else
639           glyph_name = "solesmes.auct.desc";
640       else if ((context_info & STACKED_HEAD)
641                && (context_info & PES_UPPER))
642         if (prev_delta_pitch > 1)
643           glyph_name = "vaticana.upes";
644         else
645           glyph_name = "vaticana.vupes";
646       else
647         glyph_name = "vaticana.punctum";
648
649       /*
650        * This head needs a cauda, if it starts a flexa, is not the upper
651        * head of a pes, and if it is a punctum.
652        */
653       if ((context_info & FLEXA_LEFT) && ! (context_info & PES_UPPER))
654         if (glyph_name == "vaticana.punctum")
655           primitive->set_property ("add-cauda", ly_bool2scm (true));
656
657       /*
658        * Execptional rule for porrectus:
659        *
660        * If the current head is preceded by a \flexa and succeded by a
661        * \pes (e.g. "a \flexa g \pes a"), then join the current head and
662        * the previous head into a single curved flexa shape.
663        */
664       if ((context_info & FLEXA_RIGHT) && (context_info & PES_LOWER))
665         {
666           check_for_prefix_loss (prev_primitive);
667           prev_glyph_name = "flexa";
668           prev_primitive->set_property ("flexa-height",
669                                         scm_from_int (prev_delta_pitch));
670           prev_primitive->set_property ("flexa-width",
671                                         scm_from_double (flexa_width));
672           bool add_cauda = !(prev_prefix_set && PES_OR_FLEXA);
673           prev_primitive->set_property ("add-cauda",
674                                         ly_bool2scm (add_cauda));
675           check_for_prefix_loss (primitive);
676           glyph_name = "";
677           primitive->set_property ("flexa-width",
678                                    scm_from_double (flexa_width));
679         }
680
681       /*
682        * Exceptional rule for pes:
683        *
684        * If this head is stacked on the previous one due to a \pes, then
685        * set the glyph of the previous head to that for this special
686        * case, thereby avoiding potential vertical collision with the
687        * current head.
688        */
689       if (prefix_set & PES_OR_FLEXA)
690         {
691           if ((context_info & PES_UPPER) && (context_info & STACKED_HEAD))
692             {
693               if (prev_glyph_name == "vaticana.punctum")
694                 {
695                   if (prev_delta_pitch > 1)
696                     prev_glyph_name = "vaticana.lpes";
697                   else
698                     prev_glyph_name = "vaticana.vlpes";
699                 }
700             }
701         }
702
703       if (prev_primitive)
704         prev_primitive->set_property ("glyph-name",
705                                       ly_string2scm (prev_glyph_name));
706
707       /*
708        * In the backend, flexa shapes and joins need to know about line
709        * thickness.  Hence, for simplicity, let's distribute the
710        * ligature grob's value for thickness to each ligature head (even
711        * if not all of them need to know).
712        */
713       primitive->set_property ("thickness", scm_from_double (thickness));
714
715       prev_primitive = primitive;
716       prev_prefix_set = prefix_set;
717       prev_context_info = context_info;
718       prev_delta_pitch = delta_pitch;
719       prev_glyph_name = glyph_name;
720     }
721
722   prev_primitive->set_property ("glyph-name",
723                                 ly_string2scm (prev_glyph_name));
724
725   align_heads (primitives, flexa_width, thickness);
726
727   // append all dots to paper column of ligature's last head
728   add_mora_column (prev_primitive->get_column ());
729
730 #if 0 // experimental code to collapse spacing after ligature
731   /* TODO: set to max (old/new spacing-increment), since other
732      voices/staves also may want to set this property. */
733   Item *first_primitive = dynamic_cast<Item *> (primitives[0].grob ());
734   Paper_column *paper_column = first_primitive->get_column ();
735   paper_column->warning (_f ("Vaticana_ligature_engraver: "
736                              "setting `spacing-increment = %f': ptr =%ul",
737                              ligature_width, paper_column));
738   paper_column->
739     set_property ("forced-spacing", scm_from_double (ligature_width));
740 #endif
741 }
742
743 ADD_ACKNOWLEDGER (Vaticana_ligature_engraver, rest);
744 ADD_ACKNOWLEDGER (Vaticana_ligature_engraver, note_head);
745 ADD_TRANSLATOR (Vaticana_ligature_engraver,
746                 /* doc */
747                 "Handle ligatures by glueing special ligature heads together.",
748
749                 /* create */
750                 "VaticanaLigature "
751                 "DotColumn ",
752
753                 /* read */
754                 "",
755
756                 /* write */
757                 ""
758                 );