]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/duration.cc
* lily/include/lily-guile.hh: is_x -> ly_c_X_p naming.
[lilypond.git] / lily / duration.cc
index d04491af592f58df77e54a6bdfaf9498c7128c3a..3740b09f9a63149962110f66d5e9c5959489714d 100644 (file)
@@ -1,15 +1,16 @@
 /*
-  duration.cc -- implement Duration, Plet, 
+  duration.cc -- implement Duration
 
   source file of the LilyPond music typesetter
 
-  (c)  1997--2002 Jan Nieuwenhuizen <janneke@gnu.org>
-           Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+                 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
 */
 
 #include <assert.h>
 
+#include "misc.hh"
 #include "lily-proto.hh"
 #include "string.hh"
 #include "moment.hh"
 #include "ly-smobs.icc"
 
 
-
 int
 Duration::compare (Duration const &left, Duration const &right)
 {
-  return Rational::compare (left.length_mom (), right.length_mom ());
+  return Rational::compare (left.get_length (), right.get_length ());
 }
 
 Duration::Duration ()
 {
-  durlog_i_ = 0;
-  dots_i_ = 0;
-  factor_ = Rational (1,1);
+  durlog_ = 0;
+  dots_ = 0;
+  factor_ = Rational (1, 1);
 }
 
-Duration::Duration (int l, int d)
+Duration::Duration (int log, int d)
 {
-  durlog_i_ = l;
-  dots_i_ = d;
-  factor_ = Rational (1,1);
+  durlog_ = log;
+  dots_ = d;
+  factor_ = Rational (1, 1);
 }
 
 Duration
@@ -47,16 +47,15 @@ Duration::compressed (Rational m) const
 }
 
 Rational
-Duration::length_mom () const
+Duration::get_length () const
 {
-  Rational mom (1 << abs (durlog_i_));
+  Rational mom (1 << abs (durlog_));
 
-  if (durlog_i_> 0)
-    mom = Rational (1)/mom;
+  if (durlog_> 0)
+    mom = Rational (1) / mom;
 
   Rational delta = mom;
-
-  for (int d = dots_i_; d; d--)
+  for (int i = 0; i < dots_; i++)
     {
       delta /= Rational (2);
       mom += delta;
@@ -65,21 +64,24 @@ Duration::length_mom () const
   return mom * factor_;
 }
 
-
-
 String
-Duration::str () const
+Duration::to_string () const
 {
-  String s =  to_str (durlog_i_) + to_str ('.', dots_i_);
-  if (factor_ != Moment (Rational (1,1)))
-    {
-      s += "*" + factor_.str ();
-    }
+  String s;
+
+  if (durlog_ < 0  )
+    s = "log = "  + ::to_string (durlog_);
+  else
+    s = ::to_string (1 << durlog_);
+
+  s += ::to_string ('.', dots_);
+  if (factor_ != Moment (Rational (1, 1)))
+    s += "*" + factor_.to_string ();
   return s;
 }
 
 
-IMPLEMENT_TYPE_P (Duration, "duration?");
+IMPLEMENT_TYPE_P (Duration, "ly:duration?");
 
 SCM
 Duration::mark_smob (SCM)
@@ -88,17 +90,15 @@ Duration::mark_smob (SCM)
 }
 
 IMPLEMENT_SIMPLE_SMOBS (Duration);
-
-
 int
 Duration::print_smob (SCM s, SCM port, scm_print_state *)
 {
   Duration  *r = (Duration *) ly_cdr (s);
-     
+
   scm_puts ("#<Duration ", port);
-  scm_display (ly_str02scm (r->str ().ch_C ()), port);
+  scm_display (scm_makfrom0str (r->to_string ().to_str0 ()), port);
   scm_puts (" >", port);
-  
+
   return 1;
 }
 
@@ -106,15 +106,15 @@ SCM
 Duration::equal_p (SCM a , SCM b)
 {
   Duration  *p = (Duration *) ly_cdr (a);
-  Duration  *q = (Duration *) ly_cdr (b);  
+  Duration  *q = (Duration *) ly_cdr (b);
 
-  bool eq = p->dots_i_ == q->dots_i_
-    && p->durlog_i_ == q->durlog_i_
+  bool eq = p->dots_ == q->dots_
+    && p->durlog_ == q->durlog_
     && p->factor_ == q->factor_;
 
   return eq ? SCM_BOOL_T : SCM_BOOL_F;
 }
-  
+
 MAKE_SCHEME_CALLBACK (Duration, less_p, 2);
 SCM
 Duration::less_p (SCM p1, SCM p2)
@@ -128,38 +128,114 @@ Duration::less_p (SCM p1, SCM p2)
     return SCM_BOOL_F;
 }
 
-static SCM
-make_duration (SCM l, SCM d)
+LY_DEFINE (duration_less, "ly:duration<?",
+          2, 0, 0, (SCM p1, SCM p2),
+         "Is @var{p1} shorter than @var{p2}?")
 {
-  Duration p (gh_scm2int (l), gh_scm2int (d));
+  Duration *a = unsmob_duration (p1);
+  Duration *b = unsmob_duration (p2);
+
+  SCM_ASSERT_TYPE (a, p1, SCM_ARG1, __FUNCTION__, "Duration");
+  SCM_ASSERT_TYPE (b, p2, SCM_ARG2, __FUNCTION__, "Duration");
+
+  if (Duration::compare (*a, *b) < 0)
+    return SCM_BOOL_T;
+  else
+    return SCM_BOOL_F;
+}
+
+LY_DEFINE (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")
+{
+  SCM_ASSERT_TYPE (scm_integer_p (length) == SCM_BOOL_T,
+                  length, SCM_ARG1, __FUNCTION__, "integer");
+
+  int dots = 0;
+  if (dotcount != SCM_UNDEFINED)
+    {
+      SCM_ASSERT_TYPE (scm_integer_p (dotcount) == SCM_BOOL_T,
+                      dotcount, SCM_ARG2, __FUNCTION__, "integer");
+      dots = ly_scm2int (dotcount);
+    }
+
+  bool compress = false;
+  if (num != SCM_UNDEFINED)
+    {
+      SCM_ASSERT_TYPE (ly_c_number_p (num), length, SCM_ARG3, __FUNCTION__, "integer");
+      compress = true;
+    }
+  else
+    num = scm_int2num (1);
+
+  if (den != SCM_UNDEFINED)
+    {
+      SCM_ASSERT_TYPE (ly_c_number_p (den), length, SCM_ARG4, __FUNCTION__, "integer");
+      compress = true;
+    }
+  else
+    den = scm_int2num (1);
+
+  Duration p (ly_scm2int (length), dots);
+  if (compress)
+    p = p.compressed (Rational (ly_scm2int (num), ly_scm2int (den)));
+
   return p.smobbed_copy ();
 }
 
-static void
-add_funcs ()
+LY_DEFINE (duration_log, "ly:duration-log",
+          1, 0, 0, (SCM dur),
+         "Extract the duration log from @var{dur}")
 {
-  scm_c_define_gsubr ("make-duration", 2, 0, 0,
-                     (Scheme_function_unknown)make_duration);
+  SCM_ASSERT_TYPE (unsmob_duration (dur), dur, SCM_ARG1, __FUNCTION__, "duration");
+  return scm_int2num (unsmob_duration (dur)->duration_log ());
 }
 
-ADD_SCM_INIT_FUNC (duration, add_funcs);
+LY_DEFINE (dot_count_log, "ly:duration-dot-count", 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_int2num (unsmob_duration (dur)->dot_count ());
+}
 
-SCM
-Duration::smobbed_copy ()const
+
+LY_DEFINE (ly_intlog2, "ly:intlog2",
+          1, 0, 0, (SCM d),
+         "The 2-logarithm of 1/@var{d}.")
 {
-  Duration *  p = new Duration (*this);
-  return p->smobbed_self ();
+  SCM_ASSERT_TYPE (ly_c_number_p (d), d, SCM_ARG1, __FUNCTION__, "integer");
+  int log = intlog2 (ly_scm2int (d));
+  return scm_int2num (log);
+}
+
+LY_DEFINE (compression_factor, "ly:duration-factor",
+          1, 0, 0, (SCM dur),
+         "Extract the compression factor from @var{dur}. Return as a pair.")
+{
+  SCM_ASSERT_TYPE (unsmob_duration (dur), dur, SCM_ARG1, __FUNCTION__, "duration");
+  Rational r = unsmob_duration (dur)->factor ();
+  return scm_cons (scm_int2num (r.num ()), scm_int2num (r.den ()));
 }
 
 int
 Duration::duration_log () const
 {
-  return durlog_i_;
+  return durlog_;
 }
 
 int
 Duration::dot_count () const
 {
-  return dots_i_;
+  return dots_;
 }
-