]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/duration-scheme.cc
Web-ja: update introduction
[lilypond.git] / lily / duration-scheme.cc
index e683b22454e93aa79b6ec853a6f0f2685e6ba90d..7d0788ea3eef5c4aa42e5b67d1e9dde2be60c1b8 100644 (file)
@@ -1,10 +1,21 @@
 /*
-  duration.cc -- implement Duration
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the LilyPond music typesetter
-
-  (c) 1997--2005 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1997--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   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 "duration.hh"
@@ -14,8 +25,8 @@ MAKE_SCHEME_CALLBACK (Duration, less_p, 2);
 SCM
 Duration::less_p (SCM p1, SCM p2)
 {
-  Duration *a = unsmob_duration (p1);
-  Duration *b = unsmob_duration (p2);
+  Duration *a = unsmob<Duration> (p1);
+  Duration *b = unsmob<Duration> (p2);
 
   if (compare (*a, *b) < 0)
     return SCM_BOOL_T;
@@ -24,14 +35,14 @@ Duration::less_p (SCM p1, SCM p2)
 }
 
 LY_DEFINE (ly_duration_less_p, "ly:duration<?",
-          2, 0, 0, (SCM p1, SCM p2),
-          "Is @var{p1} shorter than @var{p2}?")
+           2, 0, 0, (SCM p1, SCM p2),
+           "Is @var{p1} shorter than @var{p2}?")
 {
-  Duration *a = unsmob_duration (p1);
-  Duration *b = unsmob_duration (p2);
+  LY_ASSERT_SMOB (Duration, p1, 1);
+  LY_ASSERT_SMOB (Duration, p2, 2);
 
-  SCM_ASSERT_TYPE (a, p1, SCM_ARG1, __FUNCTION__, "Duration");
-  SCM_ASSERT_TYPE (b, p2, SCM_ARG2, __FUNCTION__, "Duration");
+  Duration *a = unsmob<Duration> (p1);
+  Duration *b = unsmob<Duration> (p2);
 
   if (Duration::compare (*a, *b) < 0)
     return SCM_BOOL_T;
@@ -40,42 +51,40 @@ LY_DEFINE (ly_duration_less_p, "ly:duration<?",
 }
 
 LY_DEFINE (ly_make_duration, "ly:make-duration",
-          1, 3, 0, (SCM length, SCM dotcount, SCM num, SCM den),
-          "@var{length} is the negative logarithm (base 2) of the duration:\n"
-          "1 is a half note, 2 is a quarter note, 3 is an eighth\n"
-          "note, etc.  The number of dots after the note is given by\n"
-          "the optional argument @var{dotcount}.\n"
-          "\n"
-          "The duration factor is optionally given by @var{num}\n"
-          "and @var{den}.\n\n"
-          "A duration is a musical duration, "
-          "i.e. a length of time described by a power of two "
-          "(whole, half, quarter, etc.) and a number of augmentation\n"
-          "dots. \n")
+           1, 3, 0, (SCM length, SCM dotcount, SCM num, SCM den),
+           "@var{length} is the negative logarithm (base 2) of the duration:"
+           " 1@tie{}is a half note, 2@tie{}is a quarter note, 3@tie{}is an"
+           " eighth note, etc.  The number of dots after the note is given by"
+           " the optional argument @var{dotcount}.\n"
+           "\n"
+           "The duration factor is optionally given by integers @var{num} and"
+           " @var{den}, alternatively by a single rational number.\n"
+           "\n"
+           "A duration is a musical duration, i.e., a length of time"
+           " described by a power of two (whole, half, quarter, etc.) and a"
+           " number of augmentation dots.")
 {
-  SCM_ASSERT_TYPE (scm_integer_p (length) == SCM_BOOL_T,
-                  length, SCM_ARG1, __FUNCTION__, "integer");
+  LY_ASSERT_TYPE (scm_is_integer, length, 1);
 
   int dots = 0;
-  if (dotcount != SCM_UNDEFINED)
+  if (!SCM_UNBNDP (dotcount))
     {
-      SCM_ASSERT_TYPE (scm_integer_p (dotcount) == SCM_BOOL_T,
-                      dotcount, SCM_ARG2, __FUNCTION__, "integer");
+      LY_ASSERT_TYPE (scm_is_integer, dotcount, 2);
       dots = scm_to_int (dotcount);
     }
 
   bool compress = false;
-  if (num != SCM_UNDEFINED)
+  if (!SCM_UNBNDP (num))
     {
-      SCM_ASSERT_TYPE (scm_is_number (num), num, SCM_ARG3, __FUNCTION__, "integer");
+      LY_ASSERT_TYPE (ly_is_rational, num, 3);
       compress = true;
     }
   else
     num = scm_from_int (1);
 
-  if (den != SCM_UNDEFINED)
+  if (!SCM_UNBNDP (den))
     {
-      SCM_ASSERT_TYPE (scm_is_number (den), den, SCM_ARG4, __FUNCTION__, "integer");
+      LY_ASSERT_TYPE (scm_is_integer, den, 4);
       compress = true;
     }
   else
@@ -83,41 +92,71 @@ LY_DEFINE (ly_make_duration, "ly:make-duration",
 
   Duration p (scm_to_int (length), dots);
   if (compress)
-    p = p.compressed (Rational (scm_to_int (num), scm_to_int (den)));
+    p = p.compressed (ly_scm2rational (scm_divide (num, den)));
 
   return p.smobbed_copy ();
 }
 
 LY_DEFINE (ly_duration_log, "ly:duration-log",
-          1, 0, 0, (SCM dur),
-          "Extract the duration log from @var{dur}")
+           1, 0, 0, (SCM dur),
+           "Extract the duration log from @var{dur}.")
 {
-  SCM_ASSERT_TYPE (unsmob_duration (dur), dur, SCM_ARG1, __FUNCTION__, "duration");
-  return scm_from_int (unsmob_duration (dur)->duration_log ());
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  return scm_from_int (unsmob<Duration> (dur)->duration_log ());
 }
 
 LY_DEFINE (ly_duration_dot_count, "ly:duration-dot-count",
-          1, 0, 0, (SCM dur),
-          "Extract the dot count from @var{dur}")
+           1, 0, 0, (SCM dur),
+           "Extract the dot count from @var{dur}.")
 {
-  SCM_ASSERT_TYPE (unsmob_duration (dur), dur, SCM_ARG1, __FUNCTION__, "duration");
-  return scm_from_int (unsmob_duration (dur)->dot_count ());
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  return scm_from_int (unsmob<Duration> (dur)->dot_count ());
 }
 
 LY_DEFINE (ly_intlog2, "ly:intlog2",
-          1, 0, 0, (SCM d),
-          "The 2-logarithm of 1/@var{d}.")
+           1, 0, 0, (SCM d),
+           "The 2-logarithm of 1/@var{d}.")
 {
-  SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG1, __FUNCTION__, "integer");
+  LY_ASSERT_TYPE (scm_is_number, d, 1);
   int log = intlog2 (scm_to_int (d));
   return scm_from_int (log);
 }
 
+LY_DEFINE (ly_duration_length, "ly:duration-length",
+           1, 0, 0, (SCM dur),
+           "The length of the duration as a @code{moment}.")
+{
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  return Moment (unsmob<Duration> (dur)->get_length ()).smobbed_copy ();
+}
+
+LY_DEFINE (ly_duration_2_string, "ly:duration->string",
+           1, 0, 0, (SCM dur),
+           "Convert @var{dur} to a string.")
+{
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  return ly_string2scm (unsmob<Duration> (dur)->to_string ());
+}
+
 LY_DEFINE (ly_duration_factor, "ly:duration-factor",
-          1, 0, 0, (SCM dur),
-          "Extract the compression factor from @var{dur}. Return as a pair.")
+           1, 0, 0, (SCM dur),
+           "Extract the compression factor from @var{dur}."
+           "  Return it as a pair.")
 {
-  SCM_ASSERT_TYPE (unsmob_duration (dur), dur, SCM_ARG1, __FUNCTION__, "duration");
-  Rational r = unsmob_duration (dur)->factor ();
-  return scm_cons (scm_from_int (r.num ()), scm_from_int (r.den ()));
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  Rational r = unsmob<Duration> (dur)->factor ();
+  return scm_cons (scm_from_int64 (r.num ()), scm_from_int64 (r.den ()));
+}
+
+// This is likely what ly:duration-factor should have been in the
+// first place.
+LY_DEFINE (ly_duration_scale, "ly:duration-scale",
+           1, 0, 0, (SCM dur),
+           "Extract the compression factor from @var{dur}."
+           "  Return it as a rational.")
+{
+  LY_ASSERT_SMOB (Duration, dur, 1);
+  Rational r = unsmob<Duration> (dur)->factor ();
+
+  return ly_rational2scm (r);
 }