X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fprob-scheme.cc;h=57881112d4b657aba078b80bc6bfe4da4a4990b5;hb=4084f5affb220e6de38399e5e016be9759521045;hp=cc74f8ada128f525e6970b5d347fddaf709a7871;hpb=38d7d319eabc906e82fb42002678c6d42a23b6f7;p=lilypond.git diff --git a/lily/prob-scheme.cc b/lily/prob-scheme.cc index cc74f8ada1..57881112d4 100644 --- a/lily/prob-scheme.cc +++ b/lily/prob-scheme.cc @@ -1,9 +1,20 @@ /* - paper-system-scheme.cc -- implement Prob bindings + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2005--2011 Han-Wen Nienhuys - (c) 2005--2009 Han-Wen Nienhuys + 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 . */ #include "prob.hh" @@ -25,25 +36,27 @@ LY_DEFINE (ly_prob_set_property_x, "ly:prob-set-property!", */ LY_DEFINE (ly_prob_property_p, "ly:prob-property?", 2, 1, 0, (SCM obj, SCM sym), - "Is boolean prop @var{sym} set?") + "Is boolean prop @var{sym} of @var{sym} set?") { return scm_equal_p (SCM_BOOL_T, ly_prob_property (obj, sym, SCM_BOOL_F)); } LY_DEFINE (ly_prob_property, "ly:prob-property", - 2, 1, 0, (SCM obj, SCM sym, SCM dfault), - "Return the value for @var{sym}.") + 2, 1, 0, (SCM prob, SCM sym, SCM val), + "Return the value for property @var{sym} of Prob object" + " @var{prob}. If no value is found, return @var{val} or" + " @code{'()} if @var{val} is not specified.") { - LY_ASSERT_SMOB (Prob, obj, 1); - Prob *ps = unsmob_prob (obj); + LY_ASSERT_SMOB (Prob, prob, 1); + Prob *ps = unsmob_prob (prob); LY_ASSERT_TYPE (ly_is_symbol, sym, 2); - if (dfault == SCM_UNDEFINED) - dfault = SCM_EOL; + if (val == SCM_UNDEFINED) + val = SCM_EOL; SCM retval = ps->internal_get_property (sym); if (retval == SCM_EOL) - return dfault; + return val; else return retval; } @@ -90,7 +103,7 @@ LY_DEFINE (ly_prob_mutable_properties, "ly:prob-mutable-properties", LY_DEFINE (ly_prob_immutable_properties, "ly:prob-immutable-properties", 1, 0, 0, (SCM prob), - "Retrieve an alist of mutable properties.") + "Retrieve an alist of immutable properties.") { LY_ASSERT_SMOB (Prob, prob, 1); Prob *ps = unsmob_prob (prob);