]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/mensural-ligature.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / mensural-ligature.cc
index c9cab99eb4d3a3838be26cea5ea675fdfb65811b..2c1059eb87b9995ae7829e1f1236ab3d082d88e5 100644 (file)
 /*
-  mensural-ligature.cc -- implement Mensural_ligature
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 2002--2004 Juergen Reuter <reuter@ipd.uka.de>
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 2002--2014 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 <math.h>
-#include "item.hh"
 #include "mensural-ligature.hh"
+
+#include "directional-element-interface.hh"
 #include "font-interface.hh"
-#include "stencil.hh"
+#include "international.hh"
+#include "item.hh"
 #include "lookup.hh"
-#include "staff-symbol-referencer.hh"
 #include "note-head.hh"
 #include "output-def.hh"
+#include "staff-symbol-referencer.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 thickness,
-           bool add_cauda,
-           Direction cauda_direction)
+            bool solid,
+            Real width,
+            Real thickness,
+            bool begin)
 {
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real height = 0.6 * staff_space;
-  Stencil stencil;
 
-  if (add_cauda)
-    {
-      bool consider_interval =
-       cauda_direction * interval > 0.0;
+  /*
+    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;
 
-      Interval cauda_box_x (0, thickness);
-      Interval cauda_box_y;
-
-      if (consider_interval)
-        {
-         Real y_length = max (interval/2.0*staff_space, 1.2*staff_space);
-         cauda_box_y = Interval (0, y_length);
-       }
-      else
-       cauda_box_y = Interval (0, staff_space);
-
-      Real y_correction =
-       (cauda_direction == UP) ?
-       +0.5*height :
-       -0.5*height - cauda_box_y.length ();
-
-      Box cauda_box (cauda_box_x, cauda_box_y);
-      Stencil cauda = Lookup::filled_box (cauda_box);
-      cauda.translate_axis (y_correction, Y_AXIS);
-      stencil.add_stencil (cauda);
-    }
+  // 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
   // and right endings due to slope.
-  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 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;
 
-  if (solid)
+  if (solid) // colorated flexae
     {
-      Stencil solid_head =
-       Lookup::beam (corrected_slope, width, height, 0.0);
-      stencil.add_stencil (solid_head);
+      stencil = Lookup::beam (corrected_slope, width * 0.5, staff_space, blotdiameter);
     }
   else // outline
     {
-      Stencil left_edge =
-       Lookup::beam (corrected_slope, thickness, height, 0.0);
-      stencil.add_stencil (left_edge);
-
-      Stencil right_edge =
-       Lookup::beam (corrected_slope, thickness, height, 0.0);
-      right_edge.translate_axis (width-thickness, X_AXIS);
-      right_edge.translate_axis (corrected_slope * (width-thickness), Y_AXIS);
-      stencil.add_stencil (right_edge);
-
-      Stencil bottom_edge =
-       Lookup::beam (corrected_slope, width, thickness, 0.0);
-      bottom_edge.translate_axis (-0.5*height, Y_AXIS);
+      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 * 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, thickness, 0.0);
-      top_edge.translate_axis (+0.5*height, Y_AXIS);
+      Stencil top_edge
+        = 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);
-  return stencil;
-}
 
-void
-add_ledger_lines (Grob *me, Stencil *out, int pos, Real offs,
-                 bool ledger_take_space)
-{
-  int interspaces = Staff_symbol_referencer::line_count (me)-1;
-  if (abs (pos) - interspaces > 1)
+  if (begin)
+    stencil.translate_axis (ypos_correction, Y_AXIS);
+  else
     {
-      Interval hd = out->extent (X_AXIS);
-      Real left_ledger_protusion = hd.length ()/4;
-      Real right_ledger_protusion = left_ledger_protusion;
-
-      Interval l_extents = Interval (hd[LEFT] - left_ledger_protusion,
-                                    hd[RIGHT] + right_ledger_protusion);
-      Stencil ledger_lines =
-       Note_head::brew_ledger_lines (me, pos, interspaces,
-                                     l_extents,0,
-                                     ledger_take_space);
-      ledger_lines.translate_axis (offs, Y_AXIS);
-      out->add_stencil (ledger_lines);
+      stencil.translate_axis (0.5 * thickness - blotdiameter, X_AXIS);
+
+      stencil.translate_axis (interval / -4.0 * staff_space, Y_AXIS);
     }
+
+  return stencil;
 }
 
 Stencil
-internal_brew_primitive (Grob *me, bool ledger_take_space)
+internal_brew_primitive (Grob *me)
 {
   SCM primitive_scm = me->get_property ("primitive");
   if (primitive_scm == SCM_EOL)
     {
       programming_error ("Mensural_ligature:"
-                        "undefined primitive -> ignoring grob");
-      return Stencil ();
+                         " undefined primitive -> ignoring grob");
+      return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
     }
+  int primitive = scm_to_int (primitive_scm);
 
-  Stencil out;
-  int primitive = ly_scm2int (primitive_scm);
-  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);
+
+  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)
     {
-      thickness = robust_scm2double ( me->get_property ("thickness"), .14);
+      thickness = robust_scm2double (me->get_property ("thickness"), .13);
+      width = robust_scm2double (me->get_property ("head-width"), staff_space);
     }
-
   if (primitive & MLP_FLEXA)
-    {
-      delta_pitch = robust_scm2int (me->get_property ("delta-pitch"),
-                                   0);
+    flexa_width = robust_scm2double (me->get_property ("flexa-width"), 2.0)
+                  * staff_space;
 
-      flexa_width = robust_scm2double (me->get_property ("flexa-width"), 2.0 * staff_space);
-    }
+  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 (primitive)
+  switch (note_shape)
     {
-      case MLP_NONE:
-       return Stencil ();
-      case MLP_BB:
-       out = brew_flexa (me, delta_pitch, false,
-                         flexa_width, thickness, true, DOWN);
-       break;
-      case MLP_sc:
-       out = Font_interface::get_default_font (me)->find_by_name ("noteheads--2mensural");
-       break;
-      case MLP_ss:
-       out = Font_interface::get_default_font (me)->find_by_name ("noteheads--1mensural");
-       break;
-      case MLP_cs:
-       out = Font_interface::get_default_font (me)->find_by_name ("noteheads-lmensural");
-       break;
-      case MLP_SS:
-       out = brew_flexa (me, delta_pitch, false,
-                         flexa_width, thickness, true, UP);
-       break;
-      case MLP_LB:
-       out = brew_flexa (me, delta_pitch, false,
-                         flexa_width, thickness, false, CENTER);
-       break;
-      default:
-       programming_error (_f ("Mensural_ligature:"
-                              "unexpected case fall-through"));
-       return Stencil ();
+    case MLP_NONE:
+      return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
+    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_FLEXA_BEGIN:
+    case MLP_FLEXA_END:
+      out = brew_flexa (me, black, flexa_width, thickness,
+                        note_shape == MLP_FLEXA_BEGIN);
+      break;
+    default:
+      programming_error ("Mensural_ligature:"
+                         " unexpected case fall-through");
+      return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
     }
 
-  SCM join_left_scm = me->get_property ("join-left-amount");
-  if (join_left_scm != SCM_EOL)
+  /*
+    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)
     {
-      int join_left = ly_scm2int (join_left_scm);
-      if (!join_left)
-       programming_error (_f ("Mensural_ligature: (join_left == 0)"));
-      Real blotdiameter = (me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter")));
-      Interval x_extent = Interval (0, thickness);
-      Interval y_extent = (join_left > 0) ?
-       Interval (-join_left * 0.5 * staff_space, 0) :
-       Interval (0, -join_left * 0.5 * staff_space);
+      // assume MLP_UP
+      Real y_bottom = 0.0, y_top = stem_length;
+
+      if (primitive & MLP_DOWN)
+        {
+          y_bottom = -y_top;
+          y_top = 0.0;
+        }
+
+      Interval x_extent (0, thickness);
+      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);
     }
 
+  if (to_boolean (me->get_property ("add-join")))
+    {
+      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;
+
+              /*
+                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 ("Mensural_ligature: (join_right == 0)");
+    }
+
+#if 0 /* what happend with the ledger lines? */
   int pos = Staff_symbol_referencer::get_rounded_position (me);
-  add_ledger_lines (me, &out, pos, 0, ledger_take_space);
   if (primitive & MLP_FLEXA)
     {
       pos += delta_pitch;
-      add_ledger_lines (me, &out, pos, 0.5*delta_pitch, ledger_take_space);
+      add_ledger_lines (me, &out, pos, 0.5 * delta_pitch, ledger_take_space);
     }
+#endif
 
   return out;
 }
@@ -218,7 +271,7 @@ SCM
 Mensural_ligature::brew_ligature_primitive (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  return internal_brew_primitive (me, false).smobbed_copy ();
+  return internal_brew_primitive (me).smobbed_copy ();
 }
 
 MAKE_SCHEME_CALLBACK (Mensural_ligature, print, 1);
@@ -228,7 +281,15 @@ Mensural_ligature::print (SCM)
   return SCM_EOL;
 }
 
-ADD_INTERFACE (Mensural_ligature, "mensural-ligature-interface",
-              "A mensural ligature",
-              "delta-pitch flexa-width head-width join-left join-left-amount "
-              "ligature-primitive-callback primitive thickness");
+ADD_INTERFACE (Mensural_ligature,
+               "A mensural ligature.",
+
+               /* properties */
+               "delta-position "
+               "ligature-flexa "
+               "head-width "
+               "add-join "
+               "flexa-interval "
+               "primitive "
+               "thickness "
+              );