Doc-es: various updates.

[lilypond.git] / lily / stream-event-scheme.cc

diff --git a/lily/stream-event-scheme.cc b/lily/stream-event-scheme.cc
index f578a8332a5fafe25c89aaf2360568caa7011cff..ccc37e0110d599717a439aac311d76549841bd30 100644 (file)
--- a/lily/stream-event-scheme.cc
+++ b/lily/stream-event-scheme.cc
@@ -1,41 +1,56 @@
 /*
-  stream-event.cc -- implement Scheme bindings for Stream_event
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2006--2015 Erik Sandberg  <mandolaerik@gmail.com>
 
-  (c) 2006--2007 Erik Sandberg  <mandolaerik@gmail.com>
+  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 "stream-event.hh"
 
+LY_DEFINE (ly_stream_event_p, "ly:stream-event?",
+           1, 0, 0, (SCM obj),
+           "Is @code{@var{obj}} a @code{Stream_event} object?")
+{
+  return scm_from_bool (unsmob<Stream_event> (obj));
+}
+
 LY_DEFINE (ly_make_stream_event, "ly:make-stream-event",
-          1, 1, 0, (SCM cl, SCM proplist),
-          "Create a stream event of class @var{cl} with the given"
-          " mutable property list.")
+           1, 1, 0, (SCM cl, SCM proplist),
+           "Create a stream event of class @var{cl} with the given"
+           " mutable property list.")
 {
-  LY_ASSERT_TYPE (ly_is_symbol, cl, 1);
+  LY_ASSERT_TYPE (ly_is_pair, cl, 1);
 
   /* should be scm_list_p, but scm_list_p is expensive. */
   LY_ASSERT_TYPE (scm_is_pair, proplist, 2);
-  
-  if (proplist == SCM_UNDEFINED)
+
+  if (SCM_UNBNDP (proplist))
     proplist = SCM_EOL;
 
   Stream_event *e = new Stream_event (cl, proplist);
   return e->unprotect ();
 }
 
-LY_DEFINE (ly_event_property, "ly:event-property", 
-           2, 0, 0, (SCM sev, SCM sym),
-          "Get the property @var{sym} of stream event @var{mus}."
-          "  If @var{sym} is undefined, return @code{'()}.")
+LY_DEFINE (ly_event_property, "ly:event-property",
+           2, 1, 0, (SCM sev, SCM sym, SCM val),
+           "Get the property @var{sym} of stream event @var{sev}."
+           "  If @var{sym} is undefined, return @var{val} or"
+           " @code{'()} if @var{val} is not specified.")
 {
   LY_ASSERT_SMOB (Stream_event, sev, 1);
-  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
-
-  Stream_event *e = unsmob_stream_event (sev);
-
-  return e->internal_get_property (sym);
+  return ly_prob_property (sev, sym, val);
 }
 
 LY_DEFINE (ly_event_set_property_x, "ly:event-set-property!",
@@ -44,23 +59,23 @@ LY_DEFINE (ly_event_set_property_x, "ly:event-set-property!",
 {
   LY_ASSERT_SMOB (Stream_event, ev, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
-  
+
   return ly_prob_set_property_x (ev, sym, val);
 }
 
 LY_DEFINE (ly_event_deep_copy, "ly:event-deep-copy",
-          1, 0, 0, (SCM m),
-          "Copy @var{m} and all sub expressions of@tie{}@var{m}.")
+           1, 0, 0, (SCM m),
+           "Copy @var{m} and all sub expressions of@tie{}@var{m}.")
 {
   SCM copy = m;
-  if (Stream_event *ev = unsmob_stream_event (m))
+  if (Stream_event *ev = unsmob<Stream_event> (m))
     {
       ev = ev->clone ();
       copy = ev->unprotect ();
     }
   else if (scm_is_pair (m))
     copy = scm_cons (ly_event_deep_copy (scm_car (m)),
-                    ly_event_deep_copy (scm_cdr (m)));
+                     ly_event_deep_copy (scm_cdr (m)));
 
   return copy;
 }