X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fbreathing-sign.cc;h=6037e777e510d24289cdb8634aa184d1bfbd7114;hb=ad81ea93a0e1af18561633ddb028e927ac924d91;hp=5233d4bf2b3ee378665c72513ec10588862ae45a;hpb=e0f05af1a81be57aac0e294c67bcec70f9e7754b;p=lilypond.git

diff --git a/lily/breathing-sign.cc b/lily/breathing-sign.cc
index 5233d4bf2b..6037e777e5 100644
--- a/lily/breathing-sign.cc
+++ b/lily/breathing-sign.cc
@@ -1,101 +1,55 @@
 /*
-  breathing_sign.cc -- implement Breathing_sign
+  This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1999 Michael Krause
+  Copyright (C) 1999--2015 Michael Krause
+  Extensions for ancient notation (c) 2003--2015 by Juergen Reuter
 
-  written for the GNU LilyPond music typesetter
+  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.
 
-  TODO: --> see breathing-sign-engraver.cc
+  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.
 
-  Extensions for ancient notation (C) 2003 by Juergen Reuter
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
 #include "breathing-sign.hh"
-#include "string.hh"
-#include "molecule.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
 
 #include "dimensions.hh"
 #include "direction.hh"
-#include "text-item.hh"
+#include "directional-element-interface.hh"
 #include "font-interface.hh"
+#include "grob.hh"
+#include "lookup.hh"
+#include "output-def.hh"
+#include "staff-symbol.hh"
+#include "staff-symbol-referencer.hh"
+#include "text-interface.hh"
 
 /*
- * TODO: thickness should be a grob property (unit:
- * stafflinethickness) rather than hardwired to (staff_space / 6).
- */
-
-MAKE_SCHEME_CALLBACK (Breathing_sign,brew_molecule,1);
-SCM 
-Breathing_sign::brew_molecule (SCM smob)
-{
-  Grob *me = unsmob_grob (smob);
-  SCM text = me->get_grob_property ("text");
-  if (text == SCM_EOL)
-    return divisio_minima (smob);
-  SCM properties = Font_interface::font_alist_chain (me);
-  Molecule out;
-  out = Text_item::text2molecule (me, text, properties);
-  SCM space_scm = me->get_grob_property ("word-space");
-  if (gh_number_p (space_scm))
-    {
-      Molecule mol;
-      mol.set_empty (false);
-      out.add_at_edge (X_AXIS, RIGHT, mol, gh_scm2double (space_scm) *
-		       Staff_symbol_referencer::staff_space (me), 0);
-    }
-  return out.smobbed_copy ();
-}
-
-/*
-  Simplistic caesura.
- */
-MAKE_SCHEME_CALLBACK (Breathing_sign,railtracks,1);
-SCM 
-Breathing_sign::railtracks (SCM smob)
-{
-  Grob * me = unsmob_grob (smob);
-  Real space = Staff_symbol_referencer::staff_space (me);
-  Real th = me->get_paper ()->get_var ("linethickness");
-  SCM lt =  me->get_grob_property ("thickness");
-  if (gh_number_p (lt))
-    th *= gh_scm2double (lt);
-  
-  Offset x1 (0, -space);
-  Offset x2 (space / 3, space);
-  Molecule l1 (Lookup::line (th, x1, x2));
-  Molecule l2 (l1);
-  l2.translate_axis (space *0.6 , X_AXIS);
-  l1.add_molecule (l2);
-  return l1.smobbed_copy();
-}
+  UGH : this is full of C&P code. Consolidate!  --hwn
+*/
 
 /*
   Gregorian chant divisio minima.  (Actually, this was the original
   breathing sign by Michael. -- jr)
- */
-MAKE_SCHEME_CALLBACK (Breathing_sign,divisio_minima,1);
-SCM 
+*/
+MAKE_SCHEME_CALLBACK (Breathing_sign, divisio_minima, 1);
+SCM
 Breathing_sign::divisio_minima (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real staff_size;
-  Real thickness = me->get_paper ()->get_var ("linethickness");
-  SCM lt =  me->get_grob_property ("thickness");
-  if (gh_number_p (lt))
-    thickness *= gh_scm2double (lt);
-  if (Staff_symbol_referencer::get_staff_symbol (me))
-    {
-      staff_size = (Staff_symbol_referencer::line_count (me) - 1) * staff_space;
-    }
-  else
-    staff_size = 0.0;
 
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
+  Real thickness = Staff_symbol_referencer::line_thickness (me);
+  thickness *= robust_scm2double (me->get_property ("thickness"), 1.0);
+
+  Real blotdiameter = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 
   /*
    * Draw a small vertical line through the uppermost (or, depending
@@ -104,135 +58,167 @@ Breathing_sign::divisio_minima (SCM smob)
   Interval xdim (0, thickness);
   Interval ydim (-0.5 * staff_space, +0.5 * staff_space);
   Box b (xdim, ydim);
-  Molecule out = Lookup::roundfilledbox (b, blotdiameter);
+  Stencil out = Lookup::round_filled_box (b, blotdiameter);
   return out.smobbed_copy ();
 }
 
 /*
   Gregorian chant divisio maior.
- */
-MAKE_SCHEME_CALLBACK (Breathing_sign,divisio_maior,1);
-SCM 
+*/
+MAKE_SCHEME_CALLBACK (Breathing_sign, divisio_maior, 1);
+SCM
 Breathing_sign::divisio_maior (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real staff_size;
-  Real thickness = me->get_paper ()->get_var ("linethickness");
-  SCM lt =  me->get_grob_property ("thickness");
-  if (gh_number_p (lt))
-    thickness *= gh_scm2double (lt);
-  if (Staff_symbol_referencer::get_staff_symbol (me))
-    {
-      staff_size = (Staff_symbol_referencer::line_count (me) - 1) * staff_space;
-    }
-  else
-    staff_size = 0.0;
+  Grob *me = unsmob<Grob> (smob);
+  Real thickness = Staff_symbol_referencer::line_thickness (me);
+  thickness *= robust_scm2double (me->get_property ("thickness"), 1.0);
 
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
+  Real blotdiameter = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 
   /*
-   * Draw a vertical line that is vertically centered in the staff
-   * (just like a bar).  The height of this line should be a little
-   * more than half the size of the staff, such that the endings of
-   * the line are in the middle of a staff space.
-   */
-  int lines = Staff_symbol_referencer::line_count (me);
-  int height = lines / 2; // little more than half of staff size
-  if ((lines & 1) != (height & 1))
-    height++; // ensure endings are centered in staff space
+    Draw a vertical line that is roughly centered vertically in
+    the staff (just like a bar) with the following requirements:
+    1. length should be at least half the size of the staff
+    2. both ends should be in the middle of a staff space.
+
+    These two requirements contradict if the first or last space is
+    larger than half of the whole staff (e.g. the staff consists of
+    two lines only); in such cases the first prescription wins.
+  */
+  Interval ydim (0.0, 0.0);
+  if (Grob *staff = Staff_symbol_referencer::get_staff_symbol (me))
+    {
+      std::vector<Real> line_pos = Staff_symbol::line_positions (staff);
+      if (!line_pos.empty ())
+        {
+          std::sort (line_pos.begin (), line_pos.end ());
+          ydim[DOWN] = line_pos.front ();
+          ydim[UP] = line_pos.back ();
+          if (Real const height = ydim.length ())
+            {
+              ydim.widen (-0.25 * height);
+
+              /*
+                ydim has now the required height; to satisfy req. 2
+                find the staff spaces containing current endpoints.
+
+                standard algorithms are suitable to find the upper
+                line of these spaces; we must choose between
+                upper_bound and lower_bound considering that if
+                there's a line exactly at quarter of the staff (the
+                lower end) then we need the space below it, while if
+                there's a line exactly at three quarters of the staff
+                (upper end) then we need the space above it.
+
+                if the middle of the space found is not low/high
+                enough, take the next space (if there are no more
+                spaces, ydim won't be enlarged further).
+              */
+              std::vector<Real>::const_iterator it
+                = std::lower_bound (line_pos.begin (), line_pos.end (),
+                                    ydim[DOWN]);
+              assert (line_pos.begin () < it);
+              double val = (it[-1] + it[0]) / 2;
+              if (ydim[DOWN] < val && line_pos.begin () < it - 1)
+                val = (it[-2] + it[-1]) / 2;
+              ydim.add_point (val);
+
+              it = std::upper_bound (line_pos.begin (), line_pos.end (),
+                                     ydim[UP]);
+              assert (it < line_pos.end ());
+              val = (it[-1] + it[0]) / 2;
+              if (val < ydim[UP] && it + 1 < line_pos.end ())
+                val = (it[0] + it[1]) / 2;
+              ydim.add_point (val);
+            }
+        }
+    }
+
+  ydim *= Staff_symbol_referencer::staff_space (me) / 2;
 
   Interval xdim (0, thickness);
-  Interval ydim (-0.5 * height, +0.5 * height);
   Box b (xdim, ydim);
-  Molecule out = Lookup::roundfilledbox (b, blotdiameter);
+  Stencil out = Lookup::round_filled_box (b, blotdiameter);
   return out.smobbed_copy ();
 }
 
 /*
   Gregorian chant divisio maxima.
- */
-MAKE_SCHEME_CALLBACK (Breathing_sign,divisio_maxima,1);
-SCM 
+*/
+MAKE_SCHEME_CALLBACK (Breathing_sign, divisio_maxima, 1);
+SCM
 Breathing_sign::divisio_maxima (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real staff_size;
-  Real thickness = me->get_paper ()->get_var ("linethickness");
-  SCM lt =  me->get_grob_property ("thickness");
-  if (gh_number_p (lt))
-    thickness *= gh_scm2double (lt);
-  if (Staff_symbol_referencer::get_staff_symbol (me))
-    {
-      staff_size = (Staff_symbol_referencer::line_count (me) - 1) * staff_space;
-    }
-  else
-    staff_size = 0.0;
+  Real thickness = Staff_symbol_referencer::line_thickness (me);
+  thickness *= robust_scm2double (me->get_property ("thickness"), 1.0);
 
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
+  Real blotdiameter = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 
   // like a "|" type bar
   Interval xdim (0, thickness);
-  Interval ydim (-0.5 * staff_size, +0.5 * staff_size);
+  Interval ydim = Staff_symbol_referencer::staff_span (me);
+  ydim *= staff_space / 2;
   Box b (xdim, ydim);
-  Molecule out = Lookup::roundfilledbox (b, blotdiameter);
+  Stencil out = Lookup::round_filled_box (b, blotdiameter);
   return out.smobbed_copy ();
 }
 
 /*
   Gregorian chant finalis.
- */
-MAKE_SCHEME_CALLBACK (Breathing_sign,finalis,1);
-SCM 
+*/
+MAKE_SCHEME_CALLBACK (Breathing_sign, finalis, 1);
+SCM
 Breathing_sign::finalis (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  Real staff_size;
-  Real thickness = me->get_paper ()->get_var ("linethickness");
-  SCM lt =  me->get_grob_property ("thickness");
-  if (gh_number_p (lt))
-    thickness *= gh_scm2double (lt);
-  if (Staff_symbol_referencer::get_staff_symbol (me))
-    {
-      staff_size = (Staff_symbol_referencer::line_count (me) - 1) * staff_space;
-    }
-  else
-    staff_size = 0.0;
+  Real thickness = Staff_symbol_referencer::line_thickness (me);
+  thickness *= robust_scm2double (me->get_property ("thickness"), 1.0);
 
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
+  Real blotdiameter = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
 
   // like a "||" type bar
   Interval xdim (0, thickness);
-  Interval ydim (-0.5 * staff_size, +0.5 * staff_size);
+  Interval ydim = Staff_symbol_referencer::staff_span (me);
+  ydim *= staff_space / 2;
   Box b (xdim, ydim);
-  Molecule line1 = Lookup::roundfilledbox (b, blotdiameter);
-  Molecule line2 (line1);
+  Stencil line1 = Lookup::round_filled_box (b, blotdiameter);
+  Stencil line2 (line1);
   line2.translate_axis (0.5 * staff_space, X_AXIS);
-  line1.add_molecule (line2);
+  line1.add_stencil (line2);
 
-  return line2.smobbed_copy ();
+  return line1.smobbed_copy ();
 }
 
-MAKE_SCHEME_CALLBACK (Breathing_sign,offset_callback,2);
+MAKE_SCHEME_CALLBACK (Breathing_sign, offset_callback, 1);
 SCM
-Breathing_sign::offset_callback (SCM element_smob, SCM)
+Breathing_sign::offset_callback (SCM smob)
 {
-  Grob *me = unsmob_grob (element_smob);
-  
-  Direction d = Directional_element_interface::get (me);
+  Grob *me = unsmob<Grob> (smob);
+
+  Direction d = get_grob_direction (me);
   if (!d)
     {
       d = UP;
-      Directional_element_interface::set (me, d);
+      set_grob_direction (me, d);
     }
 
-  Real inter_f = Staff_symbol_referencer::staff_space (me)/2;
-  int sz = Staff_symbol_referencer::line_count (me)-1;
-  return gh_double2scm (inter_f * sz * d);
+  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+  if (staff)
+    {
+      Interval iv = Staff_symbol::line_span (staff);
+      Real inter = Staff_symbol::staff_space (staff) / 2;
+      return scm_from_double (inter * iv[d]);
+    }
+
+  return scm_from_double (0.0);
 }
 
-ADD_INTERFACE(Breathing_sign, "breathing-sign-interface",
-	      "A breathing sign.",
-	      "direction");
+ADD_INTERFACE (Breathing_sign,
+               "A breathing sign.",
+
+               /* properties */
+               "direction "
+              );