X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fmusic-scheme.cc;h=b8b49e0fd2c867fa9a24b56a73a356da96807d87;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=ca152ef812d03c388ae74390e3103869bf4bcd5f;hpb=92918346012f79ef9109ef0c391947af2d3165ca;p=lilypond.git diff --git a/lily/music-scheme.cc b/lily/music-scheme.cc index ca152ef812..b8b49e0fd2 100644 --- a/lily/music-scheme.cc +++ b/lily/music-scheme.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 2005--2007 Han-Wen Nienhuys + (c) 2005--2008 Han-Wen Nienhuys */ #include "music.hh" @@ -13,27 +13,29 @@ LY_DEFINE (ly_music_length, "ly:music-length", 1, 0, 0, (SCM mus), - "Get the length of music expression @var{mus}, and return as a @code{Moment} object.") + "Get the length of music expression @var{mus} and return" + " it as a @code{Moment} object.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); + LY_ASSERT_TYPE (unsmob_music, mus, 1); Music *sc = unsmob_music (mus); return sc->get_length ().smobbed_copy (); } LY_DEFINE (ly_music_property, "ly:music-property", 2, 1, 0, (SCM mus, SCM sym, SCM dfault), - "Get the property @var{sym} of music expression @var{mus}.\n" - "If @var{sym} is undefined, return @code{'()}.\n") + "Get the property @var{sym} of music expression @var{mus}." + " If @var{sym} is undefined, return @code{'()}.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); - return ly_prob_property (mus,sym,dfault); + LY_ASSERT_TYPE (unsmob_music, mus, 1); + return ly_prob_property (mus, sym, dfault); } LY_DEFINE (ly_music_set_property_x, "ly:music-set-property!", 3, 0, 0, (SCM mus, SCM sym, SCM val), - "Set property @var{sym} in music expression @var{mus} to @var{val}.") + "Set property @var{sym} in music expression @var{mus} to" + " @var{val}.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); + LY_ASSERT_TYPE (unsmob_music, mus, 1); return ly_prob_set_property_x (mus, sym, val); } @@ -42,12 +44,12 @@ LY_DEFINE (ly_music_set_property_x, "ly:music-set-property!", /* todo: property args */ LY_DEFINE (ly_make_music, "ly:make-music", 1, 0, 0, (SCM props), - "Make a C++ Music object, initialize with\n" - "@var{props}. \n\n" - "" - "This function is for internal use, and is only called by " - "@code{make-music}, which is the preferred interface " - "for creating music objects. ") + "Make a C++ @code{Music} object and initialize it with" + " @var{props}.\n" + "\n" + "This function is for internal use and is only called by" + " @code{make-music}, which is the preferred interface" + " for creating music objects.") { Music *ms = new Music (props); return ms->unprotect (); @@ -55,7 +57,7 @@ LY_DEFINE (ly_make_music, "ly:make-music", LY_DEFINE (ly_music_p, "ly:music?", 1, 0, 0, (SCM obj), - "Type predicate") + "Type predicate.") { return scm_from_bool (unsmob_music (obj)); } @@ -63,20 +65,19 @@ LY_DEFINE (ly_music_p, "ly:music?", /* todo: property args */ LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties", 1, 0, 0, (SCM mus), - "Return an alist containing the mutable properties of @var{mus}.\n" - "The immutable properties are not available, since " - "they are constant and initialized by the " - "@code{make-music} function.\n") + "Return an alist containing the mutable properties of @var{mus}." + " The immutable properties are not available, since they are" + " constant and initialized by the @code{make-music} function.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); + LY_ASSERT_TYPE (unsmob_music, mus, 1); Music *m = unsmob_music (mus); return m->get_property_alist (true); } LY_DEFINE (ly_music_list_p, "ly:music-list?", 1, 0, 0, (SCM lst), - "Type predicate: return true if @var{lst} is a list " - "of music objects.") + "Type predicate: Return true if @var{lst} is a list" + " of music objects.") { if (scm_list_p (lst) == SCM_BOOL_T) while (scm_is_pair (lst)) @@ -91,7 +92,7 @@ LY_DEFINE (ly_music_list_p, "ly:music-list?", LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy", 1, 0, 0, (SCM m), - "Copy @var{m} and all sub expressions of @var{m}") + "Copy @var{m} and all sub expressions of@tie{}@var{m}.") { SCM copy = m; if (unsmob_music (m)) @@ -107,11 +108,11 @@ LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy", LY_DEFINE (ly_music_transpose, "ly:music-transpose", 2, 0, 0, (SCM m, SCM p), - "Transpose @var{m} such that central C is mapped to @var{p}. " - "Return @var{m}.") + "Transpose @var{m} such that central@tie{}C is mapped" + " to@tie{}@var{p}. Return@tie{}@var{m}.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, m); - LY_ASSERT_SMOB (Pitch, 2); + LY_ASSERT_TYPE (unsmob_music, m, 1); + LY_ASSERT_SMOB (Pitch, p, 2); Music *sc = unsmob_music (m); Pitch *sp = unsmob_pitch (p); @@ -126,10 +127,10 @@ LY_DEFINE (ly_music_transpose, "ly:music-transpose", */ LY_DEFINE (ly_music_compress, "ly:music-compress", 2, 0, 0, (SCM m, SCM factor), - "Compress music object @var{m} by moment @var{factor}.") + "Compress music object@tie{}@var{m} by moment @var{factor}.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, m); - LY_ASSERT_TYPE(unsmob_moment, 2); + LY_ASSERT_TYPE (unsmob_music, m, 1); + LY_ASSERT_TYPE (unsmob_moment, factor, 2); Music *sc = unsmob_music (m); sc->compress (*unsmob_moment (factor)); @@ -138,9 +139,10 @@ LY_DEFINE (ly_music_compress, "ly:music-compress", LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0, (SCM mus), - "Extract the duration field from @var{mus}, and return the length.") + "Extract the duration field from @var{mus} and return the" + " length.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); + LY_ASSERT_TYPE (unsmob_music, mus, 1); Music *m = unsmob_music (mus); Duration *d = unsmob_duration (m->get_property ("duration")); @@ -155,10 +157,11 @@ LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0, LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0, (SCM mus, SCM fact), - "Compress @var{mus} by factor @var{fact}, which is a @code{Moment}.") + "Compress @var{mus} by factor @var{fact}, which is a" + " @code{Moment}.") { - LY_ASSERT_FIRST_TYPE (unsmob_music, mus); - LY_ASSERT_SMOB (Moment, 2); + LY_ASSERT_TYPE (unsmob_music, mus, 1); + LY_ASSERT_SMOB (Moment, fact, 2); Music *m = unsmob_music (mus); Moment *f = unsmob_moment (fact); @@ -178,7 +181,8 @@ LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0, */ LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist", 2, 0, 0, (SCM l, SCM pit), - "Make a new key alist of @var{l} transposed by pitch @var{pit}") + "Make a new key alist of@tie{}@var{l} transposed by" + " pitch @var{pit}.") { SCM newlist = SCM_EOL; Pitch *p = unsmob_pitch (pit);