Run `make grand-replace'.

[lilypond.git] / lily / pitch-scheme.cc

diff --git a/lily/pitch-scheme.cc b/lily/pitch-scheme.cc
index e2f3aecf694632c03bb315d9d8098d47537528ce..b059c6f1abf669ddfbc9b06c1cc95046362b15c0 100644 (file)
--- a/lily/pitch-scheme.cc
+++ b/lily/pitch-scheme.cc
@@ -3,15 +3,15 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "pitch.hh"
 
 LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
           2, 0, 0, (SCM p, SCM delta),
-          "Transpose @var{p} by the amount @var{delta}, "
-          "where @var{delta} is relative to middle C.")
+          "Transpose @var{p} by the amount @var{delta},"
+          " where @var{delta} is relative to middle@tie{}C.")
 {
   LY_ASSERT_SMOB (Pitch, p, 1);
   LY_ASSERT_SMOB (Pitch, delta, 2);
@@ -24,11 +24,11 @@ LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
 /* Should add optional args.  */
 LY_DEFINE (ly_make_pitch, "ly:make-pitch",
           2, 1, 0, (SCM octave, SCM note, SCM alter),
-          "@var{octave} is specified by an integer, "
-          "zero for the octave containing middle C.  "
-          "@var{note} is a number from 0 to 6, "
-          "with 0 corresponding to C and 6 corresponding to B.  "
-          "The @var{alter} is a rational number of whole tones for alteration.")
+          "@var{octave} is specified by an integer, zero for the octave"
+          " containing middle@tie{}C.  @var{note} is a number from 0"
+          " to@tie{}6, with 0 corresponding to pitch@tie{}C and 6"
+          " corresponding to pitch@tie{}B.  @var{alter} is a rational"
+          " number of whole tones for alteration.")
 {
   LY_ASSERT_TYPE (scm_is_integer, octave, 1);
   LY_ASSERT_TYPE (scm_is_integer, note, 2);
@@ -51,7 +51,8 @@ LY_DEFINE (ly_pitch_negate, "ly:pitch-negate", 1, 0, 0,
 
 LY_DEFINE (ly_pitch_steps, "ly:pitch-steps", 1, 0, 0,
           (SCM p),
-          "Number of steps counted from middle C of the pitch @var{p}.")
+          "Number of steps counted from middle@tie{}C of the"
+          " pitch@tie{}@var{p}.")
 {
   LY_ASSERT_SMOB (Pitch, p, 1);
   Pitch *pp = unsmob_pitch (p);
@@ -60,7 +61,7 @@ LY_DEFINE (ly_pitch_steps, "ly:pitch-steps", 1, 0, 0,
 
 LY_DEFINE (ly_pitch_octave, "ly:pitch-octave",
           1, 0, 0, (SCM pp),
-          "Extract the octave from pitch @var{p}.")
+          "Extract the octave from pitch@tie{}@var{pp}.")
 {
   LY_ASSERT_SMOB (Pitch, pp, 1);
   Pitch *p = unsmob_pitch (pp);
@@ -70,7 +71,7 @@ LY_DEFINE (ly_pitch_octave, "ly:pitch-octave",
 
 LY_DEFINE (ly_pitch_alteration, "ly:pitch-alteration",
           1, 0, 0, (SCM pp),
-          "Extract the alteration from pitch  @var{p}.")
+          "Extract the alteration from pitch@tie{}@var{pp}.")
 {
   LY_ASSERT_SMOB (Pitch, pp, 1);
   Pitch *p = unsmob_pitch (pp);
@@ -81,7 +82,7 @@ LY_DEFINE (ly_pitch_alteration, "ly:pitch-alteration",
 
 LY_DEFINE (pitch_notename, "ly:pitch-notename",
           1, 0, 0, (SCM pp),
-          "Extract the note name from pitch  @var{pp}.")
+          "Extract the note name from pitch @var{pp}.")
 {
   LY_ASSERT_SMOB (Pitch, pp, 1);
   Pitch *p = unsmob_pitch (pp);
@@ -91,7 +92,8 @@ LY_DEFINE (pitch_notename, "ly:pitch-notename",
 
 LY_DEFINE (ly_pitch_quartertones, "ly:pitch-quartertones",
           1, 0, 0, (SCM pp),
-          "Calculate the number of quarter tones of @var{p} from middle C.")
+          "Calculate the number of quarter tones of@tie{}@var{pp} from"
+          " middle@tie{}C.")
 {
   LY_ASSERT_SMOB (Pitch, pp, 1);
   Pitch *p = unsmob_pitch (pp);
@@ -101,7 +103,8 @@ LY_DEFINE (ly_pitch_quartertones, "ly:pitch-quartertones",
 
 LY_DEFINE (ly_pitch_semitones, "ly:pitch-semitones",
           1, 0, 0, (SCM pp),
-          "calculate the number of semitones of @var{p} from middle C.")
+          "Calculate the number of semitones of@tie{}@var{pp} from"
+          " middle@tie{}C.")
 {
   LY_ASSERT_SMOB (Pitch, pp, 1);
   Pitch *p = unsmob_pitch (pp);
@@ -127,8 +130,8 @@ LY_DEFINE (ly_pitch_less_p, "ly:pitch<?",
 
 LY_DEFINE (ly_pitch_diff, "ly:pitch-diff",
           2, 0, 0, (SCM pitch, SCM root),
-          "Return pitch @var{delta} such that @code{pitch} transposed by "
-          "@var{delta} equals @var{root}")
+          "Return pitch @var{delta} such that @var{pitch} transposed by"
+          " @var{delta} equals @var{root}.")
 {
  
   LY_ASSERT_SMOB (Pitch, pitch, 1);
@@ -139,3 +142,21 @@ LY_DEFINE (ly_pitch_diff, "ly:pitch-diff",
 
   return pitch_interval (*r, *p).smobbed_copy ();
 }
+
+/* FIXME: probably isn't the right place for this function */
+#include "context.hh"
+LY_DEFINE (ly_set_middle_C_x, "ly:set-middle-C!",
+          1, 0, 0, (SCM context),
+          "Set the @code{middleCPosition} variable in @var{context}"
+          " based on the variables @code{middleCClefPosition} and"
+          " middleCOffset.")
+{
+  LY_ASSERT_SMOB (Context, context, 1);
+
+  Context *c = unsmob_context (context);
+  int clef_pos = robust_scm2int (c->get_property ("middleCClefPosition"), 0);
+  int offset = robust_scm2int (c->get_property ("middleCOffset"), 0);
+
+  c->set_property (ly_symbol2scm ("middleCPosition"), scm_from_int (clef_pos + offset));
+  return SCM_UNDEFINED;
+}