]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/gregorian-ligature-engraver.cc
2003 -> 2004
[lilypond.git] / lily / gregorian-ligature-engraver.cc
index 8faf888f6b4e7f909ae15b27a88b8ab01d81e968..f1d58d7c0925e3afbcd833f0e623b8f161cecd51 100644 (file)
@@ -3,7 +3,7 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c)  2003 Juergen Reuter <reuter@ipd.uka.de>
+  (c) 2003 Juergen Reuter <reuter@ipd.uka.de>
  */
 
 #include "gregorian-ligature-engraver.hh"
 #include "paper-column.hh"
 
 /*
- * TODO: This class shares some code with Mensural_ligature_engraver.
- * Maybe we should create a common super class "Rod_ligature_engraver"
- * and derive all shared code from it.
+ * This abstract class is the common superclass for all ligature
+ * engravers for Gregorian chant notation.  It cares for the musical
+ * handling of the neumes, such as checking for valid combinations of
+ * neumes and providing context information.  Notational aspects such
+ * as the glyphs to use or calculating the total width of a ligature,
+ * are left to the concrete subclass.  Currently, there is only a
+ * single subclass, Vaticana_ligature_engraver.  Other ligature
+ * engravers for Gregorian chant will be added in the future, such as
+ * Medicaea_ligature_engraver or Hufnagel_ligature_engraver.
  */
-
 Gregorian_ligature_engraver::Gregorian_ligature_engraver ()
 {
   pes_or_flexa_req_ = 0;
 }
 
-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");
-}
-
 bool
 Gregorian_ligature_engraver::try_music (Music *m)
 {
@@ -45,43 +42,6 @@ Gregorian_ligature_engraver::try_music (Music *m)
     return Ligature_engraver::try_music (m);
 }
 
-/*
- * TODO: move this function to class Item?
- */
-void
-Gregorian_ligature_engraver::get_set_column (Item *item, Paper_column *column)
-{
-  Item *parent = dynamic_cast<Item*> (item->get_parent (X_AXIS));
-  if (!parent)
-    {
-      programming_error ("failed tweaking paper column in ligature");
-      return;
-    }
-
-  String name = parent->name ();
-  if (!String::compare (name, "PaperColumn"))
-    {
-      // Change column not only for targeted item (NoteColumn), but
-      // also for all associated grobs (NoteSpacing, SeparationItem).
-      Grob *sl = Staff_symbol_referencer::get_staff_symbol (item);
-      for (SCM tail = parent->get_grob_property ("elements");
-          gh_pair_p (tail);
-          tail = ly_cdr (tail))
-       {
-         Item *sibling = unsmob_item (ly_car (tail));
-         if ((sibling) &&
-             (Staff_symbol_referencer::get_staff_symbol (sibling) == sl))
-           {
-             sibling->set_parent (column, X_AXIS);
-           }
-       }
-    }
-  else
-    {
-      get_set_column (parent, column);
-    }
-}
-
 void fix_prefix (char *name, int mask,
                 int *current_set, int min_set, int max_set,
                 Grob *primitive)
@@ -116,8 +76,7 @@ void fix_prefix_set (int *current_set, int min_set, int max_set, Grob *primitive
   fix_prefix ("ascendens", ASCENDENS, current_set, min_set, max_set, primitive);
   fix_prefix ("oriscus", ORISCUS, current_set, min_set, max_set, primitive);
   fix_prefix ("quilisma", QUILISMA, current_set, min_set, max_set, primitive);
-  fix_prefix ("deminutus", DEMINUTUM, current_set, min_set, max_set, primitive);
-  fix_prefix ("semivocalis", SEMIVOCALIS, current_set, min_set, max_set, primitive);
+  fix_prefix ("deminutum", DEMINUTUM, current_set, min_set, max_set, primitive);
   fix_prefix ("cavum", CAVUM, current_set, min_set, max_set, primitive);
   fix_prefix ("linea", LINEA, current_set, min_set, max_set, primitive);
   fix_prefix ("pes_or_flexa", LINEA, current_set, min_set, max_set, primitive);
@@ -141,13 +100,12 @@ void check_and_fix_all_prefixes (Array<Grob_info> primitives)
       (ORISCUS * to_boolean (primitive->get_grob_property ("oriscus"))) |
       (QUILISMA * to_boolean (primitive->get_grob_property ("quilisma"))) |
       (DEMINUTUM * to_boolean (primitive->get_grob_property ("deminutum"))) |
-      (SEMIVOCALIS * to_boolean (primitive->get_grob_property ("semivocalis"))) |
       (CAVUM * to_boolean (primitive->get_grob_property ("cavum"))) |
       (LINEA * to_boolean (primitive->get_grob_property ("linea"))) |
       (PES_OR_FLEXA * to_boolean (primitive->get_grob_property ("pes-or-flexa")));
 
     /* check: ascendens and descendens exclude each other; same with
-       auctum and diminutum */
+       auctum and deminutum */
     if (prefix_set & DESCENDENS)
       {
        fix_prefix_set (&prefix_set,
@@ -196,17 +154,8 @@ void check_and_fix_all_prefixes (Array<Grob_info> primitives)
                        primitive);
       }
 
-    /* check: semivocalis must occur in combination with and only with
-       pes or flexa */
-    if (prefix_set & SEMIVOCALIS)
-      {
-       fix_prefix_set (&prefix_set,
-                       SEMIVOCALIS | PES_OR_FLEXA,
-                       SEMIVOCALIS | PES_OR_FLEXA,
-                       primitive);
-      }
 
-    /* check: inclinatum may be prefixed with auctum or diminutum only */
+    /* check: inclinatum may be prefixed with auctum or deminutum only */
     if (prefix_set & INCLINATUM)
       {
        fix_prefix_set (&prefix_set,
@@ -214,6 +163,15 @@ void check_and_fix_all_prefixes (Array<Grob_info> primitives)
                        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 */
@@ -250,7 +208,12 @@ provide_context_info (Array<Grob_info> primitives)
     int prefix_set = gh_scm2int (primitive->get_grob_property ("prefix-set"));
 
     if (prefix_set & PES_OR_FLEXA)
-      if (pitch > prev_pitch) // pes
+      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;
@@ -265,9 +228,9 @@ provide_context_info (Array<Grob_info> primitives)
          primitive->warning ("may not apply `\\~' on heads with "
                              "identical pitch; ignoring `\\~'");
        }
-    if (prev_prefix_set & VIRGA)
+    if (prev_prefix_set & DEMINUTUM)
       {
-       context_info |= AFTER_VIRGA;
+       context_info |= AFTER_DEMINUTUM;
       }
 
     if (prev_primitive)
@@ -284,34 +247,37 @@ provide_context_info (Array<Grob_info> primitives)
 }
 
 void
-Gregorian_ligature_engraver::typeset_ligature (Spanner *ligature,
-                                              Array<Grob_info> primitives)
+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");
+}
+
+void
+Gregorian_ligature_engraver::build_ligature (Spanner *ligature,
+                                            Array<Grob_info> primitives)
 {
   // apply style-independent checking and transformation
   check_and_fix_all_prefixes (primitives);
   provide_context_info (primitives);
 
-  // apply style-specific transformation (including line-up)
+  // apply style-specific transformation (including line-up); to be
+  // implemented by subclass
   transform_heads (ligature, primitives);
-
-  // typeset
-  for (int i = 0; i < primitives.size (); i++)
-    {
-      typeset_grob (primitives[i].grob_);
-    }
 }
 
 void
-Gregorian_ligature_engraver::start_translation_timestep ()
+Gregorian_ligature_engraver::stop_translation_timestep ()
 {
-  Ligature_engraver::start_translation_timestep ();
+  Ligature_engraver::stop_translation_timestep ();
   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 abort-event",
-/* acks  */      "ligature-head-interface note-head-interface rest-interface",
+/* accepts */     "ligature-event",
+/* acks  */      "note-head-interface rest-interface",
 /* reads */       "",
 /* write */       "");