]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
* Documentation/user/refman.itely: remove superfluous -'s
[lilypond.git] / lily / music.cc
index 159f4310906aefdd90dcfd037ee56e03c15b12f2..7e6fe2b14fec55a2e17421c447b61111727d6eed 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include "main.hh"
 #include "pitch.hh"
 #include "ly-smobs.icc"
 
-SCM
-ly_deep_mus_copy (SCM m)
-{
-  if (unsmob_music (m))
-    {
-      SCM ss =  unsmob_music (m)->clone ()->self_scm ();
-      scm_gc_unprotect_object (ss);
-      return ss;
-    }
-  else if (gh_pair_p (m))
-    {
-      return gh_cons (ly_deep_mus_copy (ly_car (m)), ly_deep_mus_copy (ly_cdr (m)));
-    }
-  else
-    return m;
-}
-
-
-
-
 
+SCM ly_deep_mus_copy (SCM);
 
 bool
 Music::internal_is_music_type (SCM k)const
@@ -44,6 +25,22 @@ Music::internal_is_music_type (SCM k)const
   return scm_memq (k, ifs) != SCM_BOOL_F;
 }
 
+String
+Music::name () const
+{
+  SCM nm = get_mus_property ("name");
+  if (gh_symbol_p (nm))
+    {
+      return ly_symbol2string (nm);
+    }
+  else
+    {
+      return classname (this);
+    }
+}
+
+
+
 Music::Music (Music const &m)
 {
   immutable_property_alist_ = m.immutable_property_alist_;
@@ -83,19 +80,8 @@ Music::mark_smob (SCM m)
   return SCM_EOL;
 }
 
-void    
-Music::compress (Moment f)
-{
-  SCM l = get_mus_property ("compress-procedure");
-  if (gh_procedure_p (l))
-    {
-      SCM res = gh_call2 (l, self_scm (), f.smobbed_copy());
-    }
-}
-
-
 Moment
-Music::length_mom () const
+Music::get_length () const
 {
   SCM l = get_mus_property ("length");
   if (unsmob_moment (l))
@@ -143,42 +129,65 @@ Music::print_smob (SCM s, SCM p, scm_print_state*)
 {
   scm_puts ("#<Music ", p);
   Music* m = unsmob_music (s);
-  scm_puts (classname (m),p);
 
-  print_alist (m->mutable_property_alist_, p);
-  print_alist (m->immutable_property_alist_, p);
+  SCM nm = m->get_mus_property ("name");
+  if (gh_symbol_p (nm) || gh_string_p (nm))
+    {
+      scm_display (nm, p);
+    }
+  else
+    {
+      scm_puts (classname (m),p);
+    }
   
+  /*
+    Printing properties takes a lot of time, especially during backtraces.
+    For inspecting, it is better to explicitly use an inspection
+    function.
+   */
+
   scm_puts (">",p);
   return 1;
 }
 
 Pitch
-Music::to_relative_octave (Pitch m)
+Music::to_relative_octave (Pitch p)
 {
-  return m;
+  SCM elt = get_mus_property ("element");
+
+  if (Music* m = unsmob_music (elt))
+    p = m->to_relative_octave (p);
+
+  p = music_list_to_relative (get_mus_property ("elements"),
+                             p, false);
+  return p;
+}
+
+void
+Music::compress (Moment factor)
+{
+  SCM elt = get_mus_property ("element");
+
+  if (Music* m = unsmob_music (elt))
+    m->compress (factor);
+
+  compress_music_list (get_mus_property ("elements"), factor);
 }
 
 
 void
 Music::transpose (Pitch delta)
 {
-  Pitch *p = unsmob_pitch (get_mus_property ("pitch"));
-  if (!p)
-    return ;
+  SCM elt = get_mus_property ("element");
 
-  Pitch np = *p;
-  np.transpose (delta);
-  
-  if (abs (np.alteration_) > 2)
-    {
-       warning (_f ("Transposition by %s makes accidental larger than two",
-         delta.string ()));
-    }
+  if (Music* m = unsmob_music (elt))
+    m->transpose (delta);
 
-  set_mus_property ("pitch", np.smobbed_copy ());
+  transpose_music_list (get_mus_property ("elements"), delta);
 }
 
-IMPLEMENT_TYPE_P (Music, "music?");
+
+IMPLEMENT_TYPE_P (Music, "ly:music?");
 
 IMPLEMENT_SMOBS (Music);
 IMPLEMENT_DEFAULT_EQUAL_P (Music);
@@ -229,9 +238,20 @@ Music::~Music ()
   
 }
 
+LY_DEFINE(ly_get_music_length,
+         "ly:get-music-length", 1, 0, 0,  (SCM mus),
+         "Get the length (in musical time) of music expression @var{mus}.")
+{
+  Music * sc = unsmob_music (mus);
+  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
+  return sc->get_length().smobbed_copy();
+}
+
 LY_DEFINE(ly_get_mus_property,
-         "ly-get-mus-property", 2, 0, 0,  (SCM mus, SCM sym),
-         "Get the property @var{sym} of music expression @var{mus}.")
+         "ly:get-mus-property", 2, 0, 0,  (SCM mus, SCM sym),
+         "Get the property @var{sym} of music expression @var{mus}.\n"
+         "If @var{sym} is undefined, return @code{'()}.\n"
+         )
 {
   Music * sc = unsmob_music (mus);
   SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
@@ -241,7 +261,7 @@ LY_DEFINE(ly_get_mus_property,
 }
 
 LY_DEFINE(ly_set_mus_property,
-         "ly-set-mus-property!", 3, 0, 0,
+         "ly:set-mus-property!", 3, 0, 0,
          (SCM mus, SCM sym, SCM val),
          "Set property @var{sym} in music expression @var{mus} to @var{val}.")
 {
@@ -259,7 +279,7 @@ LY_DEFINE(ly_set_mus_property,
 }
 
 
-LY_DEFINE(ly_music_name, "ly-music-name", 1, 0, 0, 
+LY_DEFINE(ly_music_name, "ly:music-name", 1, 0, 0, 
   (SCM mus),
   "Return the name of @var{music}.")
 {
@@ -274,17 +294,16 @@ LY_DEFINE(ly_music_name, "ly-music-name", 1, 0, 0,
 
 // to do  property args 
 LY_DEFINE(ly_extended_make_music,
-         "ly-make-bare-music", 2, 0, 0,  (SCM type, SCM props),
-         "
-Make a music object/expression of type @var{type}, init with
-@var{props}. Warning: this interface will likely change in the near
-future.
-
-Music is the data type that music expressions are stored in. The data
-type does not yet offer many manipulations.
-
-WARNING: deprecated; use make-music-by-name. 
-")
+         "ly:make-bare-music", 2, 0, 0,  (SCM type, SCM props),
+         "Make a music object/expression of type @var{type}, init with\n"
+"@var{props}. Warning: this interface will likely change in the near\n"
+"future.\n"
+"\n"
+"Music is the data type that music expressions are stored in. The data\n"
+"type does not yet offer many manipulations.\n"
+"\n"
+"WARNING: only for internal use. Please use make-music-by-name. \n"
+)
 {
   SCM_ASSERT_TYPE(gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
 
@@ -294,6 +313,20 @@ WARNING: deprecated; use make-music-by-name.
   return s;
 }
 
+// to do  property args 
+LY_DEFINE(ly_get_mutable_properties,
+         "ly:get-mutable-properties", 1, 0, 0,  (SCM mus),
+"Return an alist signifying the mutable properties of @var{mus}.\n"
+"The immutable properties are not available; they should be initialized\n"
+"by the functions make-music-by-name function.\n"
+)
+{
+  Music *m = unsmob_music (mus);
+  SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__, "music");
+
+  return m->get_property_alist (true);
+}
+
 LY_DEFINE(ly_music_list_p,"music-list?", 1, 0, 0, 
   (SCM l),"Type predicate: return true if @var{l} is a list of music objects.")
 {
@@ -311,6 +344,40 @@ LY_DEFINE(ly_music_list_p,"music-list?", 1, 0, 0,
 ADD_MUSIC(Music);
 
 
+
+LY_DEFINE(ly_deep_mus_copy,
+         "ly:music-deep-copy", 1,0,0, (SCM m),
+         "Copy @var{m} and all sub expressions of @var{m}")
+{
+  if (unsmob_music (m))
+    {
+      SCM ss =  unsmob_music (m)->clone ()->self_scm ();
+      scm_gc_unprotect_object (ss);
+      return ss;
+    }
+  else if (gh_pair_p (m))
+    {
+      return gh_cons (ly_deep_mus_copy (ly_car (m)), ly_deep_mus_copy (ly_cdr (m)));
+    }
+  else
+    return m;
+}
+
+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}.")
+{
+  Music * sc = unsmob_music (m);
+  Pitch * sp = unsmob_pitch (p);
+  SCM_ASSERT_TYPE(sc, m, SCM_ARG1, __FUNCTION__, "music");
+  SCM_ASSERT_TYPE(sp, p, SCM_ARG2, __FUNCTION__, "pitch");
+
+  sc->transpose (*sp);
+  return sc->self_scm();       // SCM_UNDEFINED ? 
+}
+
+
 SCM make_music_proc;