]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/mensural-ligature.cc
Doc-es: various updates.
[lilypond.git] / lily / mensural-ligature.cc
index 88a11810581abb86de38528c15456d7399803d04..5a3b3e9543a210e1e95e5338bb838f347ada0014 100644 (file)
@@ -1,14 +1,26 @@
 /*
-  mensural-ligature.cc -- implement Mensural_ligature
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 2002--2006 Juergen Reuter <reuter@ipd.uka.de>,
+  Copyright (C) 2002--2015 Juergen Reuter <reuter@ipd.uka.de>,
   Pal Benko <benkop@freestart.hu>
+
+  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 "mensural-ligature.hh"
 
+#include "directional-element-interface.hh"
 #include "font-interface.hh"
 #include "international.hh"
 #include "item.hh"
 #include "warn.hh"
 
 /*
+  draws one half a flexa, i.e. a portion corresponding to a single note.
+  this way coloration of the two notes building up the flexa can be
+  handled independently.
+
  * TODO: divide this function into mensural and neo-mensural style.
  *
  * TODO: move this function to class Lookup?
  */
 Stencil
 brew_flexa (Grob *me,
-           Real interval,
-           bool solid,
-           Real width,
-           Real vertical_line_thickness)
+            bool solid,
+            Real width,
+            Real thickness,
+            bool begin)
 {
   Real staff_space = Staff_symbol_referencer::staff_space (me);
+
+  /*
+    The thickness of the horizontal lines of the flexa shape
+    should be equal to that of the horizontal lines of the
+    neomensural brevis note head (see mf/parmesan-heads.mf).
+  */
+  Real const horizontal_line_thickness = staff_space * 0.35;
+
+  // URGH!  vertical_line_thickness is adjustable (via thickness
+  // property), while horizontal_line_thickness is constant.
+  // Maybe both should be adjustable independently?
+
+  Real height = staff_space - horizontal_line_thickness;
+  Stencil stencil;
+  Real const interval
+    = robust_scm2double (me->get_property ("flexa-interval"), 0.0);
   Real slope = (interval / 2.0 * staff_space) / width;
 
   // Compensate optical illusion regarding vertical position of left
@@ -38,53 +70,46 @@ brew_flexa (Grob *me,
   Real ypos_correction = -0.1 * staff_space * sign (slope);
   Real slope_correction = 0.2 * staff_space * sign (slope);
   Real corrected_slope = slope + slope_correction / width;
+  Real blotdiameter
+    = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+  width += 2 * blotdiameter;
 
-  Stencil stencil;
   if (solid) // colorated flexae
     {
-      Stencil solid_head
-       = Lookup::beam (corrected_slope, width, staff_space, 0.0);
-      stencil.add_stencil (solid_head);
+      stencil = Lookup::beam (corrected_slope, width * 0.5, staff_space, blotdiameter);
     }
   else // outline
     {
-      /*
-       The thickness of the horizontal lines of the flexa shape
-       should be equal to that of the horizontal lines of the
-       neomensural brevis note head (see mf/parmesan-heads.mf).
-      */
-      Real const horizontal_line_thickness = staff_space * 0.35;
-
-      // URGH!  vertical_line_thickness is adjustable (via thickness
-      // property), while horizontal_line_thickness is constant.
-      // Maybe both should be adjustable independently?
-
-      Real height = staff_space - horizontal_line_thickness;
-
-      Stencil left_edge
-       = Lookup::beam (corrected_slope, vertical_line_thickness, height, 0.0);
-      stencil.add_stencil (left_edge);
-
-      Stencil right_edge
-       = Lookup::beam (corrected_slope, vertical_line_thickness, height, 0.0);
-      right_edge.translate_axis (width - vertical_line_thickness, X_AXIS);
-      right_edge.translate_axis ((width - vertical_line_thickness) *
-                                corrected_slope, Y_AXIS);
-      stencil.add_stencil (right_edge);
+      stencil = Lookup::beam (corrected_slope, thickness, height, blotdiameter);
+      if (!begin)
+        {
+          stencil.translate_axis (width * 0.5 - thickness, X_AXIS);
+          stencil.translate_axis (corrected_slope * (width * 0.5 - thickness),
+                                  Y_AXIS);
+        }
 
       Stencil bottom_edge
-       = Lookup::beam (corrected_slope, width,
-                       horizontal_line_thickness, 0.0);
+        = Lookup::beam (corrected_slope, width * 0.5, horizontal_line_thickness,
+                        blotdiameter);
       bottom_edge.translate_axis (-0.5 * height, Y_AXIS);
       stencil.add_stencil (bottom_edge);
 
       Stencil top_edge
-       = Lookup::beam (corrected_slope, width,
-                       horizontal_line_thickness, 0.0);
+        = Lookup::beam (corrected_slope, width * 0.5, horizontal_line_thickness,
+                        blotdiameter);
       top_edge.translate_axis (+0.5 * height, Y_AXIS);
       stencil.add_stencil (top_edge);
     }
-  stencil.translate_axis (ypos_correction, Y_AXIS);
+
+  if (begin)
+    stencil.translate_axis (ypos_correction, Y_AXIS);
+  else
+    {
+      stencil.translate_axis (0.5 * thickness - blotdiameter, X_AXIS);
+
+      stencil.translate_axis (interval / -4.0 * staff_space, Y_AXIS);
+    }
+
   return stencil;
 }
 
@@ -92,70 +117,101 @@ Stencil
 internal_brew_primitive (Grob *me)
 {
   SCM primitive_scm = me->get_property ("primitive");
-  if (primitive_scm == SCM_EOL)
+  if (scm_is_null (primitive_scm))
     {
-      programming_error ("Mensural_ligature: "
-                        "undefined primitive -> ignoring grob");
+      programming_error ("Mensural_ligature:"
+                         " undefined primitive -> ignoring grob");
       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
     }
   int primitive = scm_to_int (primitive_scm);
 
-  Stencil out;
-  int delta_pitch = 0;
   Real thickness = 0.0;
   Real width = 0.0;
+  Real flexa_width = 0.0;
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  if (primitive & MLP_ANY)
-    thickness = robust_scm2double (me->get_property ("thickness"), .14);
 
-  if (primitive & MLP_FLEXA)
+  SCM style = me->get_property ("style");
+  bool const black
+    = scm_is_eq (style, ly_symbol2scm ("blackpetrucci"));
+  bool const semi
+    = scm_is_eq (style, ly_symbol2scm ("semipetrucci"));
+
+  if (primitive & MLP_ANY)
     {
-      delta_pitch = robust_scm2int (me->get_property ("delta-position"),
-                                   0);
-      width
-       = robust_scm2double (me->get_property ("flexa-width"), 2.0 * staff_space);
+      thickness = robust_scm2double (me->get_property ("thickness"), .13);
+      width = robust_scm2double (me->get_property ("head-width"), staff_space);
     }
-  if (primitive & MLP_SINGLE_HEAD)
-    width = robust_scm2double (me->get_property ("head-width"), staff_space);
+  if (primitive & MLP_FLEXA)
+    flexa_width = robust_scm2double (me->get_property ("flexa-width"), 2.0)
+                  * staff_space;
 
-  switch (primitive & MLP_ANY)
+  Stencil out;
+  int const note_shape = primitive & MLP_ANY;
+  int duration_log = 0;
+  Font_metric *fm = Font_interface::get_default_font (me);
+  string prefix = "noteheads.";
+  string index;
+  string suffix;
+  string color = "";
+  if (black)
+    color = "black";
+  if (semi)
+    color = "semi";
+
+  switch (note_shape)
     {
     case MLP_NONE:
       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
-    case MLP_LONGA: // mensural brevis head with right cauda
-      out = Font_interface::get_default_font (me)->find_by_name
-       ("noteheads.s-2mensural");
-      break;
-    case MLP_BREVIS: // mensural brevis head
-      out = Font_interface::get_default_font (me)->find_by_name
-       ("noteheads.s-1mensural");
+    case MLP_MAXIMA:
+      duration_log--;
+    case MLP_LONGA:
+      duration_log--;
+    case MLP_BREVIS:
+      duration_log--;
+      suffix = ::to_string (duration_log) + color
+               + (duration_log < -1 ? "lig" : "") + "mensural";
+      index = prefix + "s";
+      out = fm->find_by_name (index + "r" + suffix);
+      if (!out.is_empty ()
+          && !Staff_symbol_referencer::on_line
+          (me,
+           robust_scm2int (me->get_property ("staff-position"), 0)))
+        index += "r";
+      out = fm->find_by_name (index + suffix);
       break;
-    case MLP_MAXIMA: // should be mensural maxima head without stem
-      out = Font_interface::get_default_font (me)->find_by_name
-       ("noteheads.s-1neomensural");
-      break;
-    case MLP_FLEXA:
-      out = brew_flexa (me, delta_pitch, false, width, thickness);
+    case MLP_FLEXA_BEGIN:
+    case MLP_FLEXA_END:
+      out = brew_flexa (me, black, flexa_width, thickness,
+                        note_shape == MLP_FLEXA_BEGIN);
       break;
     default:
-      programming_error (_f ("Mensural_ligature: "
-                            "unexpected case fall-through"));
+      programming_error ("Mensural_ligature:"
+                         " unexpected case fall-through");
       return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
     }
 
-  Real blotdiameter
-    = (me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")));
+  /*
+    we use thickness because the stem end of the glyph
+    "noteheads.sM2ligmensural" is round.
+  */
+  Real blotdiameter = thickness;
+  /*
+    instead of 2.5 the length of a longa stem should be used
+    Font_interface::get_default_font (???)->find_by_name
+    ("noteheads.sM2ligmensural").extent (Y_AXIS).length () * 0.5
+  */
+  Real stem_length = 2.5 * staff_space;
 
   if (primitive & MLP_STEM)
     {
       // assume MLP_UP
-      Real y_bottom = 0.0, y_top = 3.0 * staff_space;
+      Real y_bottom = 0.0, y_top = stem_length;
 
       if (primitive & MLP_DOWN)
-       {
-         y_bottom = -y_top;
-         y_top = 0.0;
-       }
+        {
+          y_bottom = -y_top;
+          y_top = 0.0;
+        }
 
       Interval x_extent (0, thickness);
       Interval y_extent (y_bottom, y_top);
@@ -165,31 +221,37 @@ internal_brew_primitive (Grob *me)
       out.add_stencil (join);
     }
 
-  SCM join_right_scm = me->get_property ("join-right-amount");
-
-  if (scm_is_number (join_right_scm))
+  if (to_boolean (me->get_property ("add-join")))
     {
-      int join_right = scm_to_int (join_right_scm);
+      int join_right = scm_to_int (me->get_property ("delta-position"));
       if (join_right)
-       {
-         Real y_top = join_right * 0.5 * staff_space;
-         Real y_bottom = 0.0;
-
-         if (y_top < 0.0)
-           {
-             y_bottom = y_top;
-             y_top = 0.0;
-           }
-
-         Interval x_extent (width - thickness, width);
-         Interval y_extent (y_bottom, y_top);
-         Box join_box (x_extent, y_extent);
-         Stencil join = Lookup::round_filled_box (join_box, blotdiameter);
-
-         out.add_stencil (join);
-       }
+        {
+          Real y_top = join_right * 0.5 * staff_space;
+          Real y_bottom = 0.0;
+
+          if (y_top < 0.0)
+            {
+              y_bottom = y_top;
+              y_top = 0.0;
+
+              /*
+                if the previous note is longa-shaped,
+                the joining line may hide the stem, so made it longer
+                to serve as stem as well
+              */
+              if (primitive & MLP_LONGA)
+                y_bottom -= stem_length + 0.25 * blotdiameter;
+            }
+
+          Interval x_extent (width - thickness, width);
+          Interval y_extent (y_bottom, y_top);
+          Box join_box (x_extent, y_extent);
+          Stencil join = Lookup::round_filled_box (join_box, blotdiameter);
+
+          out.add_stencil (join);
+        }
       else
-       programming_error (_f ("Mensural_ligature: (join_right == 0)"));
+        programming_error ("Mensural_ligature: (join_right == 0)");
     }
 
 #if 0 /* what happend with the ledger lines? */
@@ -208,7 +270,7 @@ MAKE_SCHEME_CALLBACK (Mensural_ligature, brew_ligature_primitive, 1);
 SCM
 Mensural_ligature::brew_ligature_primitive (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   return internal_brew_primitive (me).smobbed_copy ();
 }
 
@@ -220,13 +282,14 @@ Mensural_ligature::print (SCM)
 }
 
 ADD_INTERFACE (Mensural_ligature,
-              "A mensural ligature",
-
-              "delta-position "
-              "flexa-width "
-              "head-width "
-              "join-right-amount "
-              "primitive "
-              "thickness"
-              );
-
+               "A mensural ligature.",
+
+               /* properties */
+               "delta-position "
+               "ligature-flexa "
+               "head-width "
+               "add-join "
+               "flexa-interval "
+               "primitive "
+               "thickness "
+              );