]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/gregorian-ligature-engraver.cc
* lily/coherent-ligature-engraver.cc,
[lilypond.git] / lily / gregorian-ligature-engraver.cc
index 12ec008a7929b63ba2ac44142891b6beb9dfe5b2..482b60ba718b0b47c54d55dabd6c676d3de8d3e6 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 ()
 {
-  porrectus_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");
+  pes_or_flexa_req_ = 0;
 }
 
 bool
 Gregorian_ligature_engraver::try_music (Music *m)
 {
-  if (m->is_mus_type ("porrectus-event"))
+  if (m->is_mus_type ("pes-or-flexa-event"))
     {
-      porrectus_req_ = m;
+      pes_or_flexa_req_ = m;
       return true;
     }
   else
     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)
@@ -126,7 +86,8 @@ void fix_prefix_set (int *current_set, int min_set, int max_set, Grob *primitive
 void check_and_fix_all_prefixes (Array<Grob_info> primitives)
 {
   /* Check for illegal head modifier combinations */
-  for (int i = 0; i < primitives.size(); i++) {
+  for (int i = 0; i < primitives.size(); i++)
+    {
     Grob *primitive = primitives[i].grob_;
 
     /* compute head prefix set by inspecting primitive grob properties */
@@ -238,6 +199,7 @@ void
 provide_context_info (Array<Grob_info> 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++) {
@@ -263,10 +225,16 @@ provide_context_info (Array<Grob_info> primitives)
          primitive->warning ("may not apply `\\~' on heads with "
                              "identical pitch; ignoring `\\~'");
        }
+    if (prev_prefix_set & VIRGA)
+      {
+       context_info |= AFTER_VIRGA;
+      }
+
     if (prev_primitive)
       prev_primitive->set_grob_property ("context-info",
                                         gh_int2scm (prev_context_info));
     prev_primitive = primitive;
+    prev_prefix_set = prefix_set;
     prev_context_info = context_info;
     prev_pitch = pitch;
   }
@@ -276,28 +244,31 @@ 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 ()
 {
   Ligature_engraver::start_translation_timestep ();
-  porrectus_req_ = 0;
+  pes_or_flexa_req_ = 0;
 }
 
 ENTER_DESCRIPTION (Gregorian_ligature_engraver,
@@ -307,12 +278,3 @@ ENTER_DESCRIPTION (Gregorian_ligature_engraver,
 /* acks  */      "ligature-head-interface note-head-interface rest-interface",
 /* reads */       "",
 /* write */       "");
-
-class Gregorian_ligature {
-public:
-  static bool has_interface (Grob *);
-};
-ADD_INTERFACE (Gregorian_ligature, "gregorian-ligature-interface",
-              "A gregorian ligature",
-              "virga stropha inclinatum auctum descendens ascendens "
-              "pes-or-flexa semivocalis oriscus quilisma deminutum");