Doc-es: various updates.

[lilypond.git] / lily / staff-symbol-referencer-scheme.cc

diff --git a/lily/staff-symbol-referencer-scheme.cc b/lily/staff-symbol-referencer-scheme.cc
index d58f5a50438967aea763bf80c13d8f7f3df1d4bf..5fbd8c080be9d514b8377c392c26159b2bb42ca5 100644 (file)
--- a/lily/staff-symbol-referencer-scheme.cc
+++ b/lily/staff-symbol-referencer-scheme.cc
@@ -1,25 +1,36 @@
 /*
-  staff-symbol-referencer-scheme.cc -- implement Staff_symbol_referencer bindings
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1999--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  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 "grob.hh"
-#include "staff-symbol-referencer.hh"
-#include "staff-symbol.hh"
 #include "libc-extension.hh"
+#include "staff-symbol.hh"
+#include "staff-symbol-referencer.hh"
 
 LY_DEFINE (ly_grob_staff_position, "ly:grob-staff-position",
-          1, 0, 0, (SCM sg),
-          "Return the Y-position of @var{sg} relative to the staff.")
+           1, 0, 0, (SCM sg),
+           "Return the Y-position of @var{sg} relative to the staff.")
 {
   LY_ASSERT_SMOB (Grob, sg, 1);
-  Grob *g = unsmob_grob (sg);
+  Grob *g = unsmob<Grob> (sg);
   Real pos = Staff_symbol_referencer::get_position (g);
 
-  if (fabs (rint (pos) -pos) < 1e-6) // ugh.
+  if (fabs (rint (pos) - pos) < 1e-6) // ugh.
     return scm_from_int ((int) my_round (pos));
   else
     return scm_from_double (pos);
@@ -27,11 +38,12 @@ LY_DEFINE (ly_grob_staff_position, "ly:grob-staff-position",
 
 LY_DEFINE (ly_position_on_line_p, "ly:position-on-line?",
            2, 0, 0, (SCM sg, SCM spos),
-           "Return whether @var{pos} is on a line of the staff associated with the the grob @var{sg} (even on an extender line).")
+           "Return whether @var{spos} is on a line of the staff associated"
+           " with the grob @var{sg} (even on an extender line).")
 {
   LY_ASSERT_SMOB (Grob, sg, 1);
   LY_ASSERT_TYPE (scm_is_number, spos, 2);
-  Grob *g = unsmob_grob (sg);
+  Grob *g = unsmob<Grob> (sg);
   Grob *st = Staff_symbol_referencer::get_staff_symbol (g);
   int pos = scm_to_int (spos);
   bool on_line = st ? Staff_symbol::on_line (g, pos) : false;
@@ -40,10 +52,36 @@ LY_DEFINE (ly_position_on_line_p, "ly:position-on-line?",
 
 LY_DEFINE (ly_staff_symbol_line_thickness, "ly:staff-symbol-line-thickness",
            1, 0, 0, (SCM grob),
-           "Returns the line-thickness of the staff associated with @var{grob}.")
+           "Returns the current staff-line thickness in the staff"
+           " associated with @var{grob}, expressed as a multiple of the"
+           " current staff-space height.")
 {
   LY_ASSERT_SMOB (Grob, grob, 1);
-  Grob *g = unsmob_grob (grob);
+  Grob *g = unsmob<Grob> (grob);
   Real thickness = Staff_symbol_referencer::line_thickness (g);
   return scm_from_double (thickness);
 }
+
+LY_DEFINE (ly_staff_symbol_staff_space, "ly:staff-symbol-staff-space",
+           1, 0, 0, (SCM grob),
+           "Returns the current staff-space height in the staff"
+           " associated with @var{grob}, expressed as a multiple of the"
+           " default height of a staff-space in the traditional"
+           " five-line staff.")
+{
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  Grob *g = unsmob<Grob> (grob);
+  Real staff_space = Staff_symbol_referencer::staff_space (g);
+  return scm_from_double (staff_space);
+}
+
+LY_DEFINE (ly_staff_symbol_staff_radius, "ly:staff-symbol-staff-radius",
+           1, 0, 0, (SCM grob),
+           "Returns the radius of the staff associated with"
+           " @var{grob}.")
+{
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  Grob *g = unsmob<Grob> (grob);
+  Real staff_radius = Staff_symbol_referencer::staff_radius (g);
+  return scm_from_double (staff_radius);
+}