]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/music.cc
* Documentation/user/refman.itely: remove superfluous -'s
[lilypond.git] / lily / music.cc
index 48cefa076615560f7f3c734831a85b497b3976e0..7e6fe2b14fec55a2e17421c447b61111727d6eed 100644 (file)
@@ -3,53 +3,74 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
+#include "main.hh"
 #include "input-smob.hh"
 #include "music.hh"
 #include "music-list.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "pitch.hh"
 #include "ly-smobs.icc"
 
-SCM
-ly_deep_mus_copy (SCM m)
+
+SCM ly_deep_mus_copy (SCM);
+
+bool
+Music::internal_is_music_type (SCM k)const
 {
-  if (unsmob_music (m))
+  SCM ifs = get_mus_property ("types");
+
+  return scm_memq (k, ifs) != SCM_BOOL_F;
+}
+
+String
+Music::name () const
+{
+  SCM nm = get_mus_property ("name");
+  if (gh_symbol_p (nm))
     {
-      SCM ss =  unsmob_music (m)->clone ()->self_scm ();
-      scm_unprotect_object (ss);
-      return ss;
+      return ly_symbol2string (nm);
     }
-  else if (gh_pair_p (m))
+  else
     {
-      return gh_cons (ly_deep_mus_copy (gh_car (m)), ly_deep_mus_copy (gh_cdr (m)));
+      return classname (this);
     }
-  else
-    return m;
 }
 
 
+
 Music::Music (Music const &m)
 {
   immutable_property_alist_ = m.immutable_property_alist_;
-  SCM c =ly_deep_mus_copy (m.mutable_property_alist_);
-  mutable_property_alist_ = c;
+  mutable_property_alist_ = SCM_EOL;
+  self_scm_ = SCM_EOL;
 
+  /*
+    First we smobify_self, then we copy over the stuff.  If we don't,
+    stack vars that hold the copy might be optimized away, meaning
+    that they won't be protected from GC.
+   */
   smobify_self ();
-
+  mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
   set_spot (*m.origin ());
 }
 
-
-Music::Music (SCM l)
+Music::Music ()
 {
-  immutable_property_alist_ = l;
+  self_scm_ = SCM_EOL;
+  immutable_property_alist_ = SCM_EOL;
   mutable_property_alist_ = SCM_EOL;
   smobify_self ();
 }
 
+SCM
+Music::get_property_alist (bool m) const
+{
+  return (m) ? mutable_property_alist_ : immutable_property_alist_;
+}
+
 SCM
 Music::mark_smob (SCM m)
 {
@@ -59,15 +80,8 @@ Music::mark_smob (SCM m)
   return SCM_EOL;
 }
 
-void    
-Music::compress (Moment)
-{
-}
-
-
-
 Moment
-Music::length_mom () const
+Music::get_length () const
 {
   SCM l = get_mus_property ("length");
   if (unsmob_moment (l))
@@ -81,14 +95,31 @@ Music::length_mom () const
   return 0;
 }
 
+Moment
+Music::start_mom () const
+{
+  SCM l = get_mus_property ("start-moment-function");
+  if (gh_procedure_p (l))
+    {
+      SCM res = gh_call1 (l, self_scm ());
+      return *unsmob_moment (res);
+    }
+
+  Moment m ;
+  return m;
+}
+
 void
 print_alist (SCM a, SCM port)
 {
-  for (SCM s = a; gh_pair_p (s); s = gh_cdr (s))
+  /*
+    SCM_EOL  -> catch malformed lists.
+  */
+  for (SCM s = a; gh_pair_p (s); s = ly_cdr (s))
     {
-      scm_display (gh_caar (s), port);
+      scm_display (ly_caar (s), port);
       scm_puts (" = ", port); 
-      scm_write (gh_cdar (s), port);
+      scm_write (ly_cdar (s), port);
       scm_puts ("\n", port);
     }
 }
@@ -98,104 +129,102 @@ 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)
+Music::transpose (Pitch delta)
 {
+  SCM elt = get_mus_property ("element");
+
+  if (Music* m = unsmob_music (elt))
+    m->transpose (delta);
+
+  transpose_music_list (get_mus_property ("elements"), delta);
 }
 
-IMPLEMENT_TYPE_P (Music, "music?");
-IMPLEMENT_UNSMOB (Music,music);
+
+IMPLEMENT_TYPE_P (Music, "ly:music?");
+
 IMPLEMENT_SMOBS (Music);
 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 
 /****************************/
 
 SCM
-Music::get_mus_property (const char *nm) const
-{
-  SCM sym = ly_symbol2scm (nm);
-  return get_mus_property (sym);
-}
-
-SCM
-Music::get_mus_property (SCM sym) const
+Music::internal_get_mus_property (SCM sym) const
 {
   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
   if (s != SCM_BOOL_F)
-    return gh_cdr (s);
+    return ly_cdr (s);
 
   s = scm_sloppy_assq (sym, immutable_property_alist_);
-  return (s == SCM_BOOL_F) ? SCM_EOL : gh_cdr (s); 
-}
-
-/*
-  Remove the value associated with KEY, and return it. The result is
-  that a next call will yield SCM_EOL (and not the underlying
-  `basic' property.
-*/
-SCM
-Music::remove_mus_property (const char* key)
-{
-  SCM val = get_mus_property (key);
-  if (val != SCM_EOL)
-    set_mus_property (key, SCM_EOL);
-  return val;
+  return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s); 
 }
 
 void
-Music::set_mus_property (const char* k, SCM v)
+Music::internal_set_mus_property (SCM s, SCM v)
 {
-  SCM s = ly_symbol2scm (k);
-  set_mus_property (s, v);
-}
+  if (internal_type_checking_global_b)
+    if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
+      abort ();
 
-void
-Music::set_immutable_mus_property (const char*k, SCM v)
-{
-  SCM s = ly_symbol2scm (k);
-  set_immutable_mus_property (s, v);
+  mutable_property_alist_ =  scm_assq_set_x (mutable_property_alist_, s, v);
 }
 
-void
-Music::set_immutable_mus_property (SCM s, SCM v)
-{
-  immutable_property_alist_ = gh_cons (gh_cons (s,v), mutable_property_alist_);
-  mutable_property_alist_ = scm_assq_remove_x (mutable_property_alist_, s);
-}
-void
-Music::set_mus_property (SCM s, SCM v)
-{
-  mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
-}
+
 
 #include "main.hh"
+
 void
 Music::set_spot (Input ip)
 {
-  /* misuse midi-debug flag: don't store origin */
-  if (midi_debug_global_b)
-    return;
   set_mus_property ("origin", make_input (ip));
 }
 
-
-
 Input*
 Music::origin () const
 {
@@ -204,99 +233,165 @@ Music::origin () const
 }
 
 
-
-
-
 Music::~Music ()
 {
   
 }
 
-SCM
-ly_get_mus_property (SCM mus, SCM sym)
+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);
-  
-  if (sc)
-    {
-      return sc->get_mus_property (sym);
-    }
-  else
-    {
-      warning (_ ("ly_get_mus_property (): Not a Music"));
-      scm_write (mus, scm_current_error_port ());
-    }
-  return SCM_EOL;
+  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
+  return sc->get_length().smobbed_copy();
 }
 
-
-SCM
-ly_set_mus_property (SCM mus, SCM sym, SCM val)
+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}.\n"
+         "If @var{sym} is undefined, return @code{'()}.\n"
+         )
 {
   Music * sc = unsmob_music (mus);
+  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
+  SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
 
-  if (!gh_symbol_p (sym))
-    {
-      warning (_ ("ly_set_mus_property (): Not a symbol"));
-      scm_write (mus, scm_current_error_port ());      
+  return sc->internal_get_mus_property (sym);
+}
 
-      return SCM_UNSPECIFIED;
-    }
+LY_DEFINE(ly_set_mus_property,
+         "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}.")
+{
+  Music * sc = unsmob_music (mus);
+  SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
+  SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
 
-  if (sc)
+  bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
+  if (ok)
     {
-      sc->set_mus_property (sym, val);
+      sc->internal_set_mus_property (sym, val);
     }
-  else
-    {
-      warning (_ ("ly_set_mus_property ():  not of type Music"));
-      scm_write (mus, scm_current_error_port ());
-    }
-
+    
   return SCM_UNSPECIFIED;
 }
 
 
+LY_DEFINE(ly_music_name, "ly:music-name", 1, 0, 0, 
+  (SCM mus),
+  "Return the name of @var{music}.")
+{
+  Music * m = unsmob_music (mus);
+  SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__ ,"music");
+  
+  const char * nm = classname (m);
+  return scm_makfrom0str (nm);
+}
+
+
+
 // to do  property args 
-SCM
-ly_make_music (SCM type)
+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\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"
+)
 {
-  if (!gh_string_p (type))
-    {
-      warning (_ ("ly_make_music (): Not a string"));
-      scm_write (type, scm_current_error_port ());      
+  SCM_ASSERT_TYPE(gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
 
-      return SCM_UNSPECIFIED;
-    }
-  else
+  SCM s = make_music (ly_scm2string (type))->self_scm ();
+  unsmob_music (s)->immutable_property_alist_ = props;
+  scm_gc_unprotect_object (s);
+  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.")
+{
+  if (scm_list_p (l) != SCM_BOOL_T)
+    return SCM_BOOL_F;
+
+  while (gh_pair_p (l))
     {
-      SCM s =       get_music (ly_scm2string (type))->self_scm ();
-      scm_unprotect_object (s);
-      return s;
+      if (!unsmob_music (gh_car (l)))
+       return SCM_BOOL_F;
+      l =gh_cdr (l);
     }
+  return SCM_BOOL_T;
 }
+ADD_MUSIC(Music);
 
-SCM
-ly_music_name (SCM mus)
+
+
+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}")
 {
-  Music * m = unsmob_music (mus);
-  const char *nm ="";
-  if (!m)
+  if (unsmob_music (m))
     {
-      warning (_ ("ly_music_name (): Not a music expression"));
-      scm_write (mus, scm_current_error_port ());      
+      SCM ss =  unsmob_music (m)->clone ()->self_scm ();
+      scm_gc_unprotect_object (ss);
+      return ss;
     }
-   else
-     nm = classname (m);
-   return ly_str02scm (nm);
+  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 ? 
 }
 
-static void
-init_functions ()
+
+SCM make_music_proc;
+
+
+Music*
+make_music_by_name (SCM sym)
 {
-  scm_make_gsubr ("ly-get-mus-property", 2, 0, 0, (Scheme_function_unknown)ly_get_mus_property);
-  scm_make_gsubr ("ly-set-mus-property", 3, 0, 0, (Scheme_function_unknown)ly_set_mus_property);
-  scm_make_gsubr ("ly-make-music", 1, 0, 0, (Scheme_function_unknown)ly_make_music);
-  scm_make_gsubr ("ly-music-name", 1, 0, 0, (Scheme_function_unknown)ly_music_name);    
+  if (!make_music_proc)
+    make_music_proc = scm_primitive_eval (ly_symbol2scm ("make-music-by-name"));
+       
+  SCM rv = scm_call_1 (make_music_proc, sym);
+
+  /*
+    UGH.
+  */
+  scm_gc_protect_object (rv);
+  return unsmob_music (rv);
 }
-ADD_SCM_INIT_FUNC (musicscm,init_functions);