/*
- vaticana-ligature-engraver.cc -- implement Vaticana_ligature_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2003--2011 Juergen Reuter <reuter@ipd.uka.de>
- (c) 2003--2006 Juergen Reuter <reuter@ipd.uka.de>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "gregorian-ligature-engraver.hh"
#include "international.hh"
#include "output-def.hh"
#include "paper-column.hh"
+#include "separation-item.hh"
#include "spanner.hh"
#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
#include "vaticana-ligature.hh"
#include "warn.hh"
-
+#include "dot-column.hh"
+#include "rhythmic-head.hh"
+#include "pitch.hh"
#include "translator.icc"
/*
* style ligatures for Gregorian chant notation.
*/
+/*
+ * TODO: Maybe move handling of dots/mora to
+ * Gregorian_ligature_engraver? It's probably common for all types of
+ * Gregorian chant notation that have dotted notes.
+ *
+ * FIXME: The horizontal alignment of the mora column is bad (too far
+ * to the left), if the last dotted note is not the last primitive in
+ * the ligature. Fortunately, in practice this bug should have no
+ * negative impact, since dotted notes appear within a ligature
+ * usually always at the end of the ligature, such that the bug never
+ * should apply for valid ligatures.
+ *
+ * TODO: Graduale Triplex, tempus per annum, hebdomada septima,
+ * alleluia (page 280) shows a counter-example for collecting dots
+ * always in a single column behind the ligature. Maybe only the last
+ * two dots in a ligature should be collected and all other dots put
+ * behind or on top of the head?
+ */
class Vaticana_ligature_engraver : public Gregorian_ligature_engraver
{
Real align_heads (vector<Grob_info> primitives,
Real flexa_width,
Real thickness);
+ void check_for_prefix_loss (Item *primitive);
+ void check_for_ambiguous_dot_pitch (Grob_info primitive);
+ void add_mora_column (Paper_column *column);
+ vector<Grob_info> augmented_primitives_;
public:
TRANSLATOR_DECLARATIONS (Vaticana_ligature_engraver);
virtual Spanner *create_ligature_spanner ();
virtual void transform_heads (Spanner *ligature,
vector<Grob_info> primitives);
+ DECLARE_TRANSLATOR_LISTENER (pes_or_flexa);
+ DECLARE_TRANSLATOR_LISTENER (ligature);
};
+IMPLEMENT_TRANSLATOR_LISTENER (Vaticana_ligature_engraver, pes_or_flexa);
+void
+Vaticana_ligature_engraver::listen_pes_or_flexa (Stream_event *ev)
+{
+ Gregorian_ligature_engraver::listen_pes_or_flexa (ev);
+}
+
+IMPLEMENT_TRANSLATOR_LISTENER (Vaticana_ligature_engraver, ligature);
+void
+Vaticana_ligature_engraver::listen_ligature (Stream_event *ev)
+{
+ Ligature_engraver::listen_ligature (ev);
+}
+
Vaticana_ligature_engraver::Vaticana_ligature_engraver ()
{
- brew_ligature_primitive_proc =
+ brew_ligature_primitive_proc =
Vaticana_ligature::brew_ligature_primitive_proc;
+ augmented_primitives_.clear ();
}
Spanner *
Vaticana_ligature_engraver::is_stacked_head (int prefix_set,
int context_info)
{
- bool is_stacked_b;
+ bool is_stacked;
// upper head of pes is stacked upon lower head of pes ...
- is_stacked_b = context_info & PES_UPPER;
+ is_stacked = context_info & PES_UPPER;
// ... unless this note starts a flexa
if (context_info & FLEXA_LEFT)
- is_stacked_b = false;
+ is_stacked = false;
// ... or another pes
if (context_info & PES_LOWER)
- is_stacked_b = false;
+ is_stacked = false;
// ... or the previous note is a semivocalis or inclinatum
if (context_info & AFTER_DEMINUTUM)
- is_stacked_b = false;
+ is_stacked = false;
// auctum head is never stacked upon preceding note
if (prefix_set & AUCTUM)
- is_stacked_b = false;
+ is_stacked = false;
// virga is never stacked upon preceding note
if (prefix_set & VIRGA)
- is_stacked_b = false;
+ is_stacked = false;
// oriscus is never stacked upon preceding note
if (prefix_set & ORISCUS)
- is_stacked_b = false;
+ is_stacked = false;
if ((prefix_set & DEMINUTUM)
&& ! (prefix_set & INCLINATUM)
&& (context_info & FLEXA_RIGHT))
- is_stacked_b = true; // semivocalis head of deminutus form
+ is_stacked = true; // semivocalis head of deminutus form
- return is_stacked_b;
+ return is_stacked;
}
/*
{
if (!primitives.size ())
{
- programming_error ("Vaticana_ligature: "
- "empty ligature [ignored]");
+ programming_error ("Vaticana_ligature:"
+ " empty ligature [ignored]");
return 0.0;
}
if (glyph_name_scm == SCM_EOL)
{
primitive->programming_error ("Vaticana_ligature:"
- "undefined glyph-name -> "
- "ignoring grob");
+ " undefined glyph-name ->"
+ " ignoring grob");
continue;
}
string glyph_name = ly_scm2string (glyph_name_scm);
else
{
primitive->programming_error ("Vaticana_ligature:"
- "delta-position undefined -> "
- "ignoring grob");
+ " delta-position undefined ->"
+ " ignoring grob");
continue;
}
}
{
if (!prev_primitive)
{
- primitive->programming_error ("vaticana ligature: add-join: "
- "missing previous primitive");
+ primitive->programming_error ("Vaticana ligature: add-join:"
+ " missing previous primitive");
}
else
{
/*
* Horizontally line-up this head to form a ligature.
*/
- get_set_column (primitive, column);
- primitive->translate_axis (ligature_width, X_AXIS);
+ move_related_items_to_column (primitive, column, ligature_width);
ligature_width += head_width;
prev_primitive = primitive;
* primitive were engraved as a stand-alone head.
*/
void
-check_for_prefix_loss (Item *primitive)
+Vaticana_ligature_engraver::check_for_prefix_loss (Item *primitive)
{
int prefix_set
= scm_to_int (primitive->get_property ("prefix-set"));
if (prefix_set & ~PES_OR_FLEXA)
{
string prefs = Gregorian_ligature::prefixes_to_str (primitive);
- primitive->warning (_f ("ignored prefix (es) `%s' of this head according "
- "to restrictions of the selected ligature style",
+ primitive->warning (_f ("ignored prefix(es) `%s' of this head"
+ " according to restrictions of the selected"
+ " ligature style",
prefs.c_str ()));
}
}
+void
+Vaticana_ligature_engraver::add_mora_column (Paper_column *column)
+{
+ if (augmented_primitives_.size () == 0) // no dot for column
+ return;
+ if (!column) // empty ligature???
+ {
+ augmented_primitives_[0].grob ()->
+ programming_error ("no paper column to add dot");
+ return;
+ }
+ Item *dotcol = make_item ("DotColumn", SCM_EOL);
+ dotcol->set_parent (column, X_AXIS);
+ for (vsize i = 0; i < augmented_primitives_.size (); i++)
+ {
+ Item *primitive =
+ dynamic_cast<Item *> (augmented_primitives_[i].grob ());
+ Item *dot = make_item ("Dots", primitive->self_scm ());
+ dot->set_property ("dot-count", scm_from_int (1));
+ dot->set_parent (primitive, Y_AXIS);
+ primitive->set_object ("dot", dot->self_scm ());
+ Dot_column::add_head (dotcol, primitive);
+
+ // FIXME: why isn't the dot picked up by Paper_column_engraver?
+ Separation_item::add_item (column, dot);
+ }
+}
+
+/*
+ * This function prints a warning, if the given primitive has the same
+ * pitch as at least one of the primitives already stored in the
+ * augmented_primitives_ array.
+ *
+ * The rationale of this check is, that, if there are two dotted
+ * primitives with the same pitch, then collecting all dots in a dot
+ * column behind the ligature leads to a notational ambiguity of to
+ * which head the corresponding dot refers.
+ *
+ * Such a case should be treated as a badly specified ligature. The
+ * user should split the ligature to make the notation of dots
+ * unambiguous.
+ */
+void
+Vaticana_ligature_engraver::check_for_ambiguous_dot_pitch (Grob_info primitive)
+{
+ // TODO: Fix performance, which is currently O (n^2) (since this
+ // method is called O (n) times and takes O (n) steps in the for
+ // loop), but could be O (n) (by replacing the for loop by e.g. a
+ // bitmask based O (1) test); where n=<number of primitives in the
+ // ligature> (which is typically small (n<10), though).
+ Stream_event *new_cause = primitive.event_cause ();
+ int new_pitch = unsmob_pitch (new_cause->get_property ("pitch"))->steps ();
+ for (vsize i = 0; i < augmented_primitives_.size (); i++)
+ {
+ Stream_event *cause = augmented_primitives_[i].event_cause ();
+ int pitch = unsmob_pitch (cause->get_property ("pitch"))->steps ();
+ if (pitch == new_pitch)
+ {
+ primitive.grob ()->
+ warning ("Ambiguous use of dots in ligature: there are"
+ " multiple dotted notes with the same pitch."
+ " The ligature should be split.");
+ return; // supress multiple identical warnings
+ }
+ }
+}
+
void
Vaticana_ligature_engraver::transform_heads (Spanner *ligature,
vector<Grob_info> primitives)
int prev_context_info = 0;
int prev_delta_pitch = 0;
string prev_glyph_name = "";
+ augmented_primitives_.clear ();
for (vsize i = 0; i < primitives.size (); i++)
{
Item *primitive = dynamic_cast<Item *> (primitives[i].grob ());
else
{
primitive->programming_error ("Vaticana_ligature:"
- "delta-position undefined -> "
- "ignoring grob");
+ " delta-position undefined ->"
+ " ignoring grob");
continue;
}
= scm_to_int (primitive->get_property ("prefix-set"));
int context_info
= scm_to_int (primitive->get_property ("context-info"));
+
+ if (Rhythmic_head::dot_count (primitive) > 0)
+ // remove dots from primitive and add remember primitive for
+ // creating a dot column
+ {
+ Rhythmic_head::get_dots (primitive)->set_property ("dot-count",
+ scm_from_int (0));
+ // TODO: Maybe completely remove grob "Dots" (dots->suicide
+ // () ?) rather than setting property "dot-count" to 0.
+
+ check_for_ambiguous_dot_pitch (primitives[i]);
+ augmented_primitives_.push_back (primitives[i]);
+ }
+ else if (augmented_primitives_.size () > 0)
+ {
+ primitive->warning ("This ligature has a dotted head followed by"
+ " a non-dotted head. The ligature should be"
+ " split after the last dotted head before"
+ " this head.");
+ }
+
if (is_stacked_head (prefix_set, context_info))
{
context_info |= STACKED_HEAD;
else
glyph_name = "vaticana.inclinatum";
else if (prefix_set & DEMINUTUM)
- if (i == 0)
- {
- // initio debilis
- glyph_name = "vaticana.reverse.plica";
- }
- else if (prev_delta_pitch > 0)
- {
- // epiphonus
- if (! (prev_context_info & FLEXA_RIGHT))
- /* correct head of previous primitive */
+ {
+ if (i == 0)
+ {
+ // initio debilis
+ glyph_name = "vaticana.reverse.plica";
+ }
+ else if (prev_delta_pitch > 0)
+ {
+ // epiphonus
+ if (! (prev_context_info & FLEXA_RIGHT))
+ {
+ /* correct head of previous primitive */
+ if (prev_delta_pitch > 1)
+ prev_glyph_name = "vaticana.epiphonus";
+ else
+ prev_glyph_name = "vaticana.vepiphonus";
+ }
if (prev_delta_pitch > 1)
- prev_glyph_name = "vaticana.epiphonus";
+ glyph_name = "vaticana.plica";
else
- prev_glyph_name = "vaticana.vepiphonus";
- if (prev_delta_pitch > 1)
- glyph_name = "vaticana.plica";
- else
- glyph_name = "vaticana.vplica";
- }
- else if (prev_delta_pitch < 0)
- {
- // cephalicus
- if (! (prev_context_info & FLEXA_RIGHT))
- /* correct head of previous primitive */
- {
- if (i > 1)
- {
- /* cephalicus head with fixed size cauda */
- prev_glyph_name = "vaticana.inner.cephalicus";
- }
- else
- {
- /* cephalicus head without cauda */
- prev_glyph_name = "vaticana.cephalicus";
- }
-
- /*
- * Flexa has no variable size cauda if its left head is
- * stacked on the right head. This is true for
- * cephalicus. Hence, remove the cauda.
- *
- * Urgh: for the current implementation, this rule only
- * applies for cephalicus; but it is a fundamental rule.
- * Therefore, the following line of code should be
- * placed somewhere else.
- */
- prev_primitive->set_property ("add-cauda",
- ly_bool2scm (false));
- }
- if (prev_delta_pitch < - 1)
- glyph_name = "vaticana.reverse.plica";
- else
- glyph_name = "vaticana.reverse.vplica";
- }
- else // (prev_delta_pitch == 0)
- {
- primitive->programming_error ("Vaticana_ligature:"
- "deminutum head must have different "
- "pitch -> ignoring grob");
- }
+ glyph_name = "vaticana.vplica";
+ }
+ else if (prev_delta_pitch < 0)
+ {
+ // cephalicus
+ if (! (prev_context_info & FLEXA_RIGHT))
+ /* correct head of previous primitive */
+ {
+ if (i > 1)
+ {
+ /* cephalicus head with fixed size cauda */
+ prev_glyph_name = "vaticana.inner.cephalicus";
+ }
+ else
+ {
+ /* cephalicus head without cauda */
+ prev_glyph_name = "vaticana.cephalicus";
+ }
+
+ /*
+ * Flexa has no variable size cauda if its left head is
+ * stacked on the right head. This is true for
+ * cephalicus. Hence, remove the cauda.
+ *
+ * Urgh: for the current implementation, this rule only
+ * applies for cephalicus; but it is a fundamental rule.
+ * Therefore, the following line of code should be
+ * placed somewhere else.
+ */
+ prev_primitive->set_property ("add-cauda",
+ ly_bool2scm (false));
+ }
+ if (prev_delta_pitch < - 1)
+ glyph_name = "vaticana.reverse.plica";
+ else
+ glyph_name = "vaticana.reverse.vplica";
+ }
+ else // (prev_delta_pitch == 0)
+ {
+ primitive->programming_error ("Vaticana_ligature:"
+ " deminutum head must have different"
+ " pitch -> ignoring grob");
+ }
+ }
else if (prefix_set & (CAVUM | LINEA))
if ((prefix_set & CAVUM) && (prefix_set & LINEA))
glyph_name = "vaticana.linea.punctum.cavum";
if ((context_info & PES_UPPER) && (context_info & STACKED_HEAD))
{
if (prev_glyph_name == "vaticana.punctum")
- if (prev_delta_pitch > 1)
- prev_glyph_name = "vaticana.lpes";
- else
- prev_glyph_name = "vaticana.vlpes";
+ {
+ if (prev_delta_pitch > 1)
+ prev_glyph_name = "vaticana.lpes";
+ else
+ prev_glyph_name = "vaticana.vlpes";
+ }
}
}
if (prev_primitive)
prev_primitive->set_property ("glyph-name",
- scm_makfrom0str (prev_glyph_name.c_str ()));
+ ly_string2scm (prev_glyph_name));
/*
* In the backend, flexa shapes and joins need to know about line
}
prev_primitive->set_property ("glyph-name",
- scm_makfrom0str (prev_glyph_name.c_str ()));
+ ly_string2scm (prev_glyph_name));
align_heads (primitives, flexa_width, thickness);
+ // append all dots to paper column of ligature's last head
+ add_mora_column (prev_primitive->get_column ());
+
#if 0 // experimental code to collapse spacing after ligature
/* TODO: set to max (old/new spacing-increment), since other
voices/staves also may want to set this property. */
Item *first_primitive = dynamic_cast<Item *> (primitives[0].grob ());
Paper_column *paper_column = first_primitive->get_column ();
- paper_column->warning (_f ("Vaticana_ligature_engraver: "
- "setting `spacing-increment = %f': ptr =%ul",
+ paper_column->warning (_f ("Vaticana_ligature_engraver:"
+ " setting `spacing-increment = %f': ptr =%ul",
ligature_width, paper_column));
paper_column->
set_property ("forced-spacing", scm_from_double (ligature_width));
}
ADD_ACKNOWLEDGER (Vaticana_ligature_engraver, rest);
-ADD_ACKNOWLEDGER (Vaticana_ligature_engraver, note_head);
+ADD_ACKNOWLEDGER (Vaticana_ligature_engraver, ligature_head);
ADD_TRANSLATOR (Vaticana_ligature_engraver,
- /* doc */ "Handles ligatures by glueing special ligature heads together.",
- /* create */ "VaticanaLigature",
- /* accept */ "ligature-event",
- /* read */ "",
- /* write */ "");
+ /* doc */
+ "Handle ligatures by glueing special ligature heads"
+ " together.",
+
+ /* create */
+ "VaticanaLigature "
+ "DotColumn ",
+
+ /* read */
+ "",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff