/*
- pitch-scheme.cc -- implement scheme functions for Pitch
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2005--2007 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 "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);
/* 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 indexing the"
+ " global default scale, with 0 corresponding to pitch@tie{}C"
+ " and 6 usually corresponding to pitch@tie{}B. @var{alter} is"
+ " a rational number of 200-cent whole tones for alteration.")
+
{
LY_ASSERT_TYPE (scm_is_integer, octave, 1);
LY_ASSERT_TYPE (scm_is_integer, note, 2);
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);
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);
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);
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);
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);
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);
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);
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);
+ /* middleCCuePosition overrides the clef! */
+ SCM cue_pos = c->get_property ("middleCCuePosition");
+ if (scm_is_number (cue_pos))
+ clef_pos = robust_scm2int (cue_pos, 0);
+
+ c->set_property (ly_symbol2scm ("middleCPosition"), scm_from_int (clef_pos + offset));
+ return SCM_UNDEFINED;
+}
projects / lilypond.git / blobdiff