]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/mensural-ligature.cc
apply Julian's patch to fix install-info warnings
[lilypond.git] / lily / mensural-ligature.cc
index a60e2fe5ed274cf32751f1a3b1d5edaff118b59a..ad2f0918a9ab22cd427bef19b349401bbeafc0e8 100644 (file)
 /*
-  mensural-ligature.cc -- implement Mensural_ligature
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 2002--2003 Juergen Reuter <reuter@ipd.uka.de>
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 2002--2011 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 "font-interface.hh"
-#include "molecule.hh"
+#include "international.hh"
+#include "item.hh"
 #include "lookup.hh"
-#include "staff-symbol-referencer.hh"
 #include "note-head.hh"
-#include "paper-def.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?
  */
-Molecule
+Stencil
 brew_flexa (Grob *me,
-           Real interval,
            bool solid,
            Real width,
            Real thickness,
-           bool add_stem,
-           Direction stem_direction)
+           bool begin)
 {
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real height = 0.6 * staff_space;
-  Molecule molecule = Molecule ();
-
-  if (add_stem)
-    {
-      bool consider_interval =
-       stem_direction * interval > 0.0;
-
-      Interval stem_box_x (0, thickness);
-      Interval stem_box_y;
-
-      if (consider_interval)
-        {
-         Real y_length = max (interval/2.0*staff_space, 1.2*staff_space);
-         stem_box_y = Interval (0, y_length);
-       }
-      else
-       stem_box_y = Interval (0, staff_space);
 
-      Real y_correction =
-       (stem_direction == UP) ?
-       +0.5*height :
-       -0.5*height - stem_box_y.length();
+  /*
+    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;
 
-      Box stem_box (stem_box_x, stem_box_y);
-      Molecule stem = Lookup::filledbox (stem_box);
-      stem.translate_axis (y_correction, Y_AXIS);
-      molecule.add_molecule(stem);
-    }
+  // 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;
 
-  if (solid)
+  if (solid) // colorated flexae
     {
-      Molecule solid_head =
-       Lookup::horizontal_slope (width, corrected_slope, height);
-      molecule.add_molecule (solid_head);
+      stencil = Lookup::beam (corrected_slope, width * 0.5, staff_space, 0.0);
     }
   else // outline
     {
-      Molecule left_edge =
-       Lookup::horizontal_slope (thickness, corrected_slope, height);
-      molecule.add_molecule(left_edge);
-
-      Molecule right_edge =
-       Lookup::horizontal_slope (thickness, corrected_slope, height);
-      right_edge.translate_axis (width-thickness, X_AXIS);
-      right_edge.translate_axis (corrected_slope * (width-thickness), Y_AXIS);
-      molecule.add_molecule(right_edge);
-
-      Molecule bottom_edge =
-       Lookup::horizontal_slope (width, corrected_slope, thickness);
+      stencil = Lookup::beam (corrected_slope, thickness, height, 0.0);
+      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,
+                      0.0);
       bottom_edge.translate_axis (-0.5*height, Y_AXIS);
-      molecule.add_molecule (bottom_edge);
+      stencil.add_stencil (bottom_edge);
 
-      Molecule top_edge =
-       Lookup::horizontal_slope (width, corrected_slope, thickness);
+      Stencil top_edge =
+        Lookup::beam (corrected_slope, width * 0.5, horizontal_line_thickness,
+                      0.0);
       top_edge.translate_axis (+0.5*height, Y_AXIS);
-      molecule.add_molecule (top_edge);
+      stencil.add_stencil (top_edge);
     }
-  molecule.translate_axis (ypos_correction, Y_AXIS);
-  return molecule;
-}
 
-void
-add_ledger_lines (Grob *me, Molecule *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);
-      Molecule ledger_lines =
-       Note_head::brew_ledger_lines (me, pos, interspaces,
-                                     l_extents,
-                                     ledger_take_space);
-      ledger_lines.translate_axis (offs, Y_AXIS);
-      out->add_molecule (ledger_lines);
+      stencil.translate_axis (0.5 * thickness, X_AXIS);
+
+      stencil.translate_axis (interval / -4.0 * staff_space, Y_AXIS);
     }
+
+  return stencil;
 }
 
-Molecule
-internal_brew_primitive (Grob *me, bool ledger_take_space)
+Stencil
+internal_brew_primitive (Grob *me)
 {
-  SCM primitive_scm = me->get_grob_property ("primitive");
+  SCM primitive_scm = me->get_property ("primitive");
   if (primitive_scm == SCM_EOL)
     {
       programming_error ("Mensural_ligature:"
-                        "undefined primitive -> ignoring grob");
-      return Molecule ();
+                        " undefined primitive -> ignoring grob");
+      return Lookup::blank (Box (Interval (0, 0), Interval (0, 0)));
     }
+  int primitive = scm_to_int (primitive_scm);
 
-  Molecule out;
-  int primitive = gh_scm2int (primitive_scm);
-  int delta_pitch = 0;
+  Stencil out;
   Real thickness = 0.0;
+  Real width = 0.0;
   Real flexa_width = 0.0;
   Real staff_space = Staff_symbol_referencer::staff_space (me);
+
+  bool const color =
+    me->get_property ("style") == ly_symbol2scm ("blackpetrucci");
+  bool const semi =
+    me->get_property ("style") == ly_symbol2scm ("semipetrucci");
+
   if (primitive & MLP_ANY)
     {
-      SCM thickness_scm = me->get_grob_property ("thickness");
-      if (thickness_scm != SCM_EOL)
-       {
-         thickness = gh_scm2double (thickness_scm);
-       }
-      else
-       {
-         programming_error (_f ("Mensural_ligature:"
-                                "thickness undefined on flexa %d; assuming 1.4",
-                                primitive));
-         thickness = 1.4 * me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
-       }
+      thickness = robust_scm2double (me->get_property ("thickness"), .14);
+      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;
+
+  int const note_shape = primitive & MLP_ANY;
+
+  switch (note_shape)
     {
-      SCM delta_pitch_scm = me->get_grob_property ("delta-pitch");
-      if (delta_pitch_scm != SCM_EOL)
-       {
-         delta_pitch = gh_scm2int (delta_pitch_scm);
-       }
-      else
-       {
-         programming_error (_f ("Mensural_ligature:"
-                                "delta-pitch undefined on flexa %d; assuming 0",
-                                primitive));
-         delta_pitch = 0;
-       }
+    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
+       (color ? "noteheads.sM2blackmensural" :
+         semi ? "noteheads.sM2semimensural" : "noteheads.sM2mensural");
+      break;
+    case MLP_BREVIS: // mensural brevis head
+      out = Font_interface::get_default_font (me)->find_by_name
+       (color ? "noteheads.sM1blackmensural" :
+         semi ? "noteheads.sM1semimensural" : "noteheads.sM1mensural");
+      break;
+    case MLP_MAXIMA: // should be mensural maxima head without stem
+      out = Font_interface::get_default_font (me)->find_by_name
+       (color ? "noteheads.sM3blackligmensural" :
+         semi ? "noteheads.sM3semiligmensural" : "noteheads.sM3ligmensural");
+      break;
+    case MLP_FLEXA_BEGIN:
+    case MLP_FLEXA_END:
+      out = brew_flexa (me, color, 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 flexa_width_scm = me->get_grob_property ("flexa-width");
-      if (flexa_width_scm != SCM_EOL)
-       {
-         flexa_width = gh_scm2double (flexa_width_scm);
-       }
-      else
+  Real blotdiameter
+    = (me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")));
+
+  if (primitive & MLP_STEM)
+    {
+      // assume MLP_UP
+      Real y_bottom = 0.0, y_top = 3.0 * staff_space;
+
+      if (primitive & MLP_DOWN)
        {
-         programming_error (_f ("Mensural_ligature:"
-                                "flexa-width undefined on flexa %d; assuming 2.0",
-                                primitive));
-         flexa_width = 2.0 * staff_space;
+         y_bottom = -y_top;
+         y_top = 0.0;
        }
-    }
 
-  switch (primitive)
-    {
-      case MLP_NONE:
-       return Molecule();
-      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 Molecule ();
+      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);
     }
 
-  SCM join_left_scm = me->get_grob_property ("join-left-amount");
-  if (join_left_scm != SCM_EOL)
+  if (to_boolean (me->get_property ("add-join")))
     {
-      int join_left = gh_scm2int (join_left_scm);
-      if (!join_left)
-       programming_error (_f ("Mensural_ligature: (join_left == 0)"));
-      Real blotdiameter = (me->get_paper ()->get_realvar (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);
-      Box stem_box (x_extent, y_extent);
-
-      Molecule stem = Lookup::roundfilledbox (stem_box, blotdiameter);
-      out.add_molecule (stem);
+      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)
+               /*
+                 instead of 3.0 the length of a longa stem should be used
+                 Font_interface::get_default_font (???)->find_by_name
+                 ("noteheads.s-2mensural").extent (Y_AXIS).length () * 0.5
+               */
+               y_bottom -= 3.0 * staff_space;
+           }
+
+         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)"));
     }
 
-  int pos = (int)rint (Staff_symbol_referencer::get_position (me));
-  add_ledger_lines(me, &out, pos, 0, ledger_take_space);
+#if 0 /* what happend with the ledger lines? */
+  int pos = Staff_symbol_referencer::get_rounded_position (me);
   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;
 }
@@ -250,17 +250,25 @@ 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, brew_molecule, 1);
+MAKE_SCHEME_CALLBACK (Mensural_ligature, print, 1);
 SCM
-Mensural_ligature::brew_molecule (SCM)
+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 "
+              );