/*
- gregorian-ligature-engraver.cc -- implement Gregorian_ligature_engraver
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2003 Juergen Reuter <reuter@ipd.uka.de>
- */
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 2003--2014 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 "gregorian-ligature.hh"
-#include "item.hh"
-#include "warn.hh"
-#include "staff-symbol-referencer.hh"
-#include "spanner.hh"
+#include "international.hh"
#include "paper-column.hh"
+#include "pitch.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+/* ASSIGN_EVENT_ONCE */
+#include "translator.icc"
/*
* This abstract class is the common superclass for all ligature
pes_or_flexa_req_ = 0;
}
-bool
-Gregorian_ligature_engraver::try_music (Music *m)
+void
+Gregorian_ligature_engraver::listen_pes_or_flexa (Stream_event *ev)
{
- if (m->is_mus_type ("pes-or-flexa-event"))
- {
- pes_or_flexa_req_ = m;
- return true;
- }
- else
- return Ligature_engraver::try_music (m);
+ ASSIGN_EVENT_ONCE (pes_or_flexa_req_, ev);
}
-void fix_prefix (char *name, int mask,
- int *current_set, int min_set, int max_set,
- Grob *primitive)
+void fix_prefix (char const *name, int mask,
+ int *current_set, int min_set, int max_set,
+ Grob *primitive)
{
bool current = *current_set & mask;
bool min = min_set & mask;
fix_prefix ("pes_or_flexa", LINEA, current_set, min_set, max_set, primitive);
}
-void check_and_fix_all_prefixes (Array<Grob_info> primitives)
+void check_and_fix_all_prefixes (vector<Grob_info> const &primitives)
{
- /* Check for illegal head modifier combinations */
- for (int i = 0; i < primitives.size(); i++)
+ /* Check for invalid head modifier combinations */
+ for (vsize i = 0; i < primitives.size (); i++)
{
- Grob *primitive = primitives[i].grob_;
-
- /* compute head prefix set by inspecting primitive grob properties */
- int prefix_set =
- (VIRGA * to_boolean (primitive->get_property ("virga"))) |
- (STROPHA * to_boolean (primitive->get_property ("stropha"))) |
- (INCLINATUM * to_boolean (primitive->get_property ("inclinatum"))) |
- (AUCTUM * to_boolean (primitive->get_property ("auctum"))) |
- (DESCENDENS * to_boolean (primitive->get_property ("descendens"))) |
- (ASCENDENS * to_boolean (primitive->get_property ("ascendens"))) |
- (ORISCUS * to_boolean (primitive->get_property ("oriscus"))) |
- (QUILISMA * to_boolean (primitive->get_property ("quilisma"))) |
- (DEMINUTUM * to_boolean (primitive->get_property ("deminutum"))) |
- (CAVUM * to_boolean (primitive->get_property ("cavum"))) |
- (LINEA * to_boolean (primitive->get_property ("linea"))) |
- (PES_OR_FLEXA * to_boolean (primitive->get_property ("pes-or-flexa")));
+ Grob *primitive = primitives[i].grob ();
- /* check: ascendens and descendens exclude each other; same with
- auctum and deminutum */
- if (prefix_set & DESCENDENS)
- {
- fix_prefix_set (&prefix_set,
- prefix_set & ~ASCENDENS,
- prefix_set & ~ASCENDENS,
- primitive);
- }
- if (prefix_set & AUCTUM)
- {
- fix_prefix_set (&prefix_set,
- prefix_set & ~DEMINUTUM,
- prefix_set & ~DEMINUTUM,
- primitive);
- }
+ /* compute head prefix set by inspecting primitive grob properties */
+ int prefix_set
+ = (VIRGA * to_boolean (primitive->get_property ("virga")))
+ | (STROPHA * to_boolean (primitive->get_property ("stropha")))
+ | (INCLINATUM * to_boolean (primitive->get_property ("inclinatum")))
+ | (AUCTUM * to_boolean (primitive->get_property ("auctum")))
+ | (DESCENDENS * to_boolean (primitive->get_property ("descendens")))
+ | (ASCENDENS * to_boolean (primitive->get_property ("ascendens")))
+ | (ORISCUS * to_boolean (primitive->get_property ("oriscus")))
+ | (QUILISMA * to_boolean (primitive->get_property ("quilisma")))
+ | (DEMINUTUM * to_boolean (primitive->get_property ("deminutum")))
+ | (CAVUM * to_boolean (primitive->get_property ("cavum")))
+ | (LINEA * to_boolean (primitive->get_property ("linea")))
+ | (PES_OR_FLEXA * to_boolean (primitive->get_property ("pes-or-flexa")));
- /* check: virga, quilisma and oriscus can not be combined with any
- other prefix, but may be part of a pes or flexa */
- if (prefix_set & VIRGA)
- {
- fix_prefix_set (&prefix_set,
- VIRGA,
- VIRGA | PES_OR_FLEXA,
- primitive);
- }
- if (prefix_set & QUILISMA)
- {
- fix_prefix_set (&prefix_set,
- QUILISMA,
- QUILISMA | PES_OR_FLEXA,
- primitive);
- }
- if (prefix_set & ORISCUS)
- {
- fix_prefix_set (&prefix_set,
- ORISCUS,
- ORISCUS | PES_OR_FLEXA,
- primitive);
- }
+ /* check: ascendens and descendens exclude each other; same with
+ auctum and deminutum */
+ if (prefix_set & DESCENDENS)
+ {
+ fix_prefix_set (&prefix_set,
+ prefix_set & ~ASCENDENS,
+ prefix_set & ~ASCENDENS,
+ primitive);
+ }
+ if (prefix_set & AUCTUM)
+ {
+ fix_prefix_set (&prefix_set,
+ prefix_set & ~DEMINUTUM,
+ prefix_set & ~DEMINUTUM,
+ primitive);
+ }
- /* check: auctum is the only valid optional prefix for stropha */
- if (prefix_set & STROPHA)
- {
- fix_prefix_set (&prefix_set,
- STROPHA,
- STROPHA | AUCTUM,
- primitive);
- }
+ /* check: virga, quilisma and oriscus cannot be combined with any
+ other prefix, but may be part of a pes or flexa */
+ if (prefix_set & VIRGA)
+ {
+ fix_prefix_set (&prefix_set,
+ VIRGA,
+ VIRGA | PES_OR_FLEXA,
+ primitive);
+ }
+ if (prefix_set & QUILISMA)
+ {
+ fix_prefix_set (&prefix_set,
+ QUILISMA,
+ QUILISMA | PES_OR_FLEXA,
+ primitive);
+ }
+ if (prefix_set & ORISCUS)
+ {
+ fix_prefix_set (&prefix_set,
+ ORISCUS,
+ ORISCUS | PES_OR_FLEXA,
+ primitive);
+ }
+ /* check: auctum is the only valid optional prefix for stropha */
+ if (prefix_set & STROPHA)
+ {
+ fix_prefix_set (&prefix_set,
+ STROPHA,
+ STROPHA | AUCTUM,
+ primitive);
+ }
- /* check: inclinatum may be prefixed with auctum or deminutum only */
- if (prefix_set & INCLINATUM)
- {
- fix_prefix_set (&prefix_set,
- INCLINATUM,
- INCLINATUM | AUCTUM | DEMINUTUM,
- primitive);
- }
- /* check: semivocalis (deminutum but not inclinatum) must occur in
- combination with and only with pes or flexa */
- else if (prefix_set & DEMINUTUM)
- {
- fix_prefix_set (&prefix_set,
- DEMINUTUM | PES_OR_FLEXA,
- DEMINUTUM | PES_OR_FLEXA,
- primitive);
- }
+ /* check: inclinatum may be prefixed with auctum or deminutum only */
+ if (prefix_set & INCLINATUM)
+ {
+ fix_prefix_set (&prefix_set,
+ INCLINATUM,
+ INCLINATUM | AUCTUM | DEMINUTUM,
+ primitive);
+ }
+ /* check: semivocalis (deminutum but not inclinatum) must occur in
+ combination with and only with pes or flexa */
+ else if (prefix_set & DEMINUTUM)
+ {
+ fix_prefix_set (&prefix_set,
+ DEMINUTUM | PES_OR_FLEXA,
+ DEMINUTUM | PES_OR_FLEXA,
+ primitive);
+ }
- /* check: cavum and linea (either or both) may be applied only
- upon core punctum */
- if (prefix_set & (CAVUM | LINEA))
- {
- fix_prefix_set (&prefix_set,
- 0,
- CAVUM | LINEA,
- primitive);
- }
+ /* check: cavum and linea (either or both) may be applied only
+ upon core punctum */
+ if (prefix_set & (CAVUM | LINEA))
+ {
+ fix_prefix_set (&prefix_set,
+ 0,
+ CAVUM | LINEA,
+ primitive);
+ }
- /* all other combinations should be valid (unless I made a
- mistake) */
+ /* all other combinations should be valid (unless I made a
+ mistake) */
- primitive->set_property ("prefix-set", gh_int2scm (prefix_set));
- }
+ primitive->set_property ("prefix-set", scm_from_int (prefix_set));
+ }
}
/*
* Marks those heads that participate in a pes or flexa.
*/
void
-provide_context_info (Array<Grob_info> primitives)
+provide_context_info (vector<Grob_info> const &primitives)
{
Grob *prev_primitive = 0;
int prev_prefix_set = 0;
int prev_context_info = 0;
int prev_pitch = 0;
- for (int i = 0; i < primitives.size(); i++) {
- Grob *primitive = primitives[i].grob_;
- Music *music_cause = primitives[i].music_cause ();
- int context_info = 0;
- int pitch = unsmob_pitch (music_cause->get_property ("pitch"))->steps ();
- int prefix_set = gh_scm2int (primitive->get_property ("prefix-set"));
+ for (vsize i = 0; i < primitives.size (); i++)
+ {
+ Grob *primitive = primitives[i].grob ();
+ Stream_event *event_cause = primitives[i].event_cause ();
+ int context_info = 0;
+ int pitch = Pitch::unsmob (event_cause->get_property ("pitch"))->steps ();
+ int prefix_set = scm_to_int (primitive->get_property ("prefix-set"));
- if (prefix_set & PES_OR_FLEXA)
- if (!i) // ligature may not start with 2nd head of pes or flexa
- {
- primitive->warning ("may not apply `\\~' on first head of "
- "ligature; ignoring `\\~'");
- }
- else if (pitch > prev_pitch) // pes
- {
- prev_context_info |= PES_LOWER;
- context_info |= PES_UPPER;
- }
- else if (pitch < prev_pitch) // flexa
- {
- prev_context_info |= FLEXA_LEFT;
- context_info |= FLEXA_RIGHT;
- }
- else // (pitch == prev_pitch)
- {
- primitive->warning ("may not apply `\\~' on heads with "
- "identical pitch; ignoring `\\~'");
- }
- if (prev_prefix_set & DEMINUTUM)
- {
- context_info |= AFTER_DEMINUTUM;
- }
+ if (prefix_set & PES_OR_FLEXA)
+ {
+ if (!i) // ligature may not start with 2nd head of pes or flexa
+ primitive->warning (_ ("cannot apply `\\~' on first head of ligature"));
+ else if (pitch > prev_pitch) // pes
+ {
+ prev_context_info |= PES_LOWER;
+ context_info |= PES_UPPER;
+ }
+ else if (pitch < prev_pitch) // flexa
+ {
+ prev_context_info |= FLEXA_LEFT;
+ context_info |= FLEXA_RIGHT;
+ }
+ else // (pitch == prev_pitch)
+ primitive->warning (_ ("cannot apply `\\~' on heads with identical pitch"));
+ }
+ if (prev_prefix_set & DEMINUTUM)
+ context_info |= AFTER_DEMINUTUM;
- if (prev_primitive)
- prev_primitive->set_property ("context-info",
- gh_int2scm (prev_context_info));
- prev_primitive = primitive;
- prev_prefix_set = prefix_set;
- prev_context_info = context_info;
- prev_pitch = pitch;
- }
+ if (prev_primitive)
+ prev_primitive->set_property ("context-info",
+ scm_from_int (prev_context_info));
+ prev_primitive = primitive;
+ prev_prefix_set = prefix_set;
+ prev_context_info = context_info;
+ prev_pitch = pitch;
+ }
if (prev_primitive)
prev_primitive->set_property ("context-info",
- gh_int2scm (prev_context_info));
-}
-
-void
-Gregorian_ligature_engraver::transform_heads (Spanner *, Array<Grob_info>)
-{
- programming_error ("Gregorian_ligature_engraver::transform_heads (): "
- "this is an abstract method that should not be called, "
- "but overridden by a subclass");
+ scm_from_int (prev_context_info));
}
void
Gregorian_ligature_engraver::build_ligature (Spanner *ligature,
- Array<Grob_info> primitives)
+ vector<Grob_info> const &primitives)
{
// apply style-independent checking and transformation
check_and_fix_all_prefixes (primitives);
pes_or_flexa_req_ = 0;
}
-ENTER_DESCRIPTION (Gregorian_ligature_engraver,
-/* descr */ "This is an abstract class. Subclasses such as Vaticana_ligature_engraver handle ligatures by glueing special ligature heads together.",
-/* creats*/ "",
-/* accepts */ "ligature-event",
-/* acks */ "note-head-interface rest-interface",
-/* reads */ "",
-/* write */ "");
+// no ADD_ACKNOWLEDGER / ADD_ACKNOWLEDGER / ADD_TRANSLATOR macro calls
+// since this class is abstract
projects / lilypond.git / blobdiff