Run `make grand-replace'.

[lilypond.git] / lily / grob-scheme.cc

diff --git a/lily/grob-scheme.cc b/lily/grob-scheme.cc
index e9720ea986f0b1c69c363f265e22bd2bd935f657..4d6ed8f69b1524236b81b8f32291382cf75846db 100644 (file)
--- a/lily/grob-scheme.cc
+++ b/lily/grob-scheme.cc
@@ -3,11 +3,11 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1998--2008 Jan Nieuwenhuizen <janneke@gnu.org>
   Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-#include "warn.hh"             // error()
+#include "warn.hh"             // error ()
 #include "item.hh"
 #include "output-def.hh"
 #include "system.hh"
@@ -21,20 +21,20 @@ LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
 {
   Grob *sc = unsmob_grob (grob);
 
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE (ly_is_symbol, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   return sc->get_property_data (sym);
 }
 
 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
           3, 0, 0, (SCM grob, SCM sym, SCM val),
-          "Set @var{sym} in grob @var{grob} to value @var{val}")
+          "Set @var{sym} in grob @var{grob} to value @var{val}.")
 {
   Grob *sc = unsmob_grob (grob);
  
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE (ly_is_symbol, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   if (!ly_is_procedure (val)
       && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
@@ -46,15 +46,15 @@ LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
 
 LY_DEFINE (ly_grob_property, "ly:grob-property",
           2, 1, 0, (SCM grob, SCM sym, SCM deflt),
-          "Return the value of a value in grob @var{g} of property @var{sym}. "
-          "It will return @code{'()} or @var{deflt} (if specified) "
-          "if  @var{sym} is undefined in @var{g}."
-          "\n\n")
+          "Return the value of a value in grob@tie{}@var{g} of property"
+          " @var{sym}.  It returns @code{'()} (end-of-list) or"
+          " @var{deflt} (if specified) if @var{sym} is undefined"
+          " in@tie{}@var{g}.")
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE (ly_is_symbol, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
   if (deflt == SCM_UNDEFINED)
     deflt = SCM_EOL;
 
@@ -72,22 +72,21 @@ LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   return sc->interfaces ();
 }
 
 LY_DEFINE (ly_grob_object, "ly:grob-object",
           2, 0, 0, (SCM grob, SCM sym),
-          "Return the value of a pointer in grob @var{g} of property @var{sym}. "
-          "It will return @code{' ()} (end-of-list) "
-          "if  @var{sym} is undefined in @var{g}."
-          "\n\n")
+          "Return the value of a pointer in grob@tie{}@var{g} of property"
+          " @var{sym}.  It returns @code{'()} (end-of-list) if @var{sym}"
+          " is undefined in@tie{}@var{g}.")
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE (ly_is_symbol, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   return sc->internal_get_object (sym);
 }
@@ -102,20 +101,20 @@ LY_DEFINE (ly_grob_layout, "ly:grob-layout",
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   return sc->layout ()->self_scm ();
 }
 
 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
           1, 1, 0, (SCM grob, SCM global),
-          "Get an alist chain for grob @var{grob}, with @var{global} as the "
-          "global default. If unspecified, @code{font-defaults} "
-          "from the layout block is taken. ")
+          "Get an alist chain for grob @var{grob}, with @var{global} as"
+          " the global default.  If unspecified, @code{font-defaults}"
+          " from the layout block is taken.")
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   if (global == SCM_UNDEFINED)
     {
@@ -129,16 +128,16 @@ LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
 
 LY_DEFINE (ly_grob_extent, "ly:grob-extent",
           3, 0, 0, (SCM grob, SCM refp, SCM axis),
-          "Get the extent in @var{axis} direction of @var{grob} relative to "
-          "the grob @var{refp}")
+          "Get the extent in @var{axis} direction of @var{grob} relative to"
+          " the grob @var{refp}.")
 {
   Grob *sc = unsmob_grob (grob);
   Grob *ref = unsmob_grob (refp);
   
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_SMOB(Grob, 2);
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_SMOB (Grob, refp, 2);
+  LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Axis a = Axis (scm_to_int (axis));
 
@@ -153,16 +152,16 @@ LY_DEFINE (ly_grob_extent, "ly:grob-extent",
 
 LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
           3, 0, 0, (SCM grob, SCM refp, SCM axis),
-          "Get the extent in @var{axis} direction of @var{grob} relative to "
-          "the grob @var{refp}, or (0,0) if empty")
+          "Get the extent in @var{axis} direction of @var{grob} relative to"
+          " the grob @var{refp}, or @code{(0,0)} if empty.")
 {
   Grob *sc = unsmob_grob (grob);
   Grob *ref = unsmob_grob (refp);
   
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_SMOB(Grob, 2);
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_SMOB (Grob, refp, 2);
+  LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Axis a = Axis (scm_to_int (axis));
     
@@ -177,16 +176,16 @@ LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
 
 LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
           3, 0, 0, (SCM grob, SCM refp, SCM axis),
-          "Get the coordinate in @var{axis} direction of @var{grob} relative to "
-          "the grob @var{refp}")
+          "Get the coordinate in @var{axis} direction of @var{grob} relative"
+          " to the grob @var{refp}.")
 {
   Grob *sc = unsmob_grob (grob);
   Grob *ref = unsmob_grob (refp);
   
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_SMOB(Grob, 2);
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_SMOB (Grob, refp, 2);
+  LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Axis a = Axis (scm_to_int (axis));
 
@@ -197,19 +196,19 @@ LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
       SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
     }
 
-  return scm_from_double (sc->relative_coordinate (ref,a));
+  return scm_from_double (sc->relative_coordinate (ref, a));
 }
 
 
 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
           2, 0, 0, (SCM grob, SCM axis),
-          "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
-          "1 for the Y-axis.")
+          "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis,"
+          " 1@tie{}for the Y-axis.")
 {
   Grob *sc = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE(is_axis, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (is_axis, axis, 2);
 
   Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
   return par ? par->self_scm () : SCM_EOL;
@@ -217,11 +216,11 @@ LY_DEFINE (ly_grob_parent, "ly:grob-parent",
 
 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
           1, 0, 0, (SCM grob),
-          "Get the mutable proprerties of @var{grob}.")
+          "Get the mutable properties of @var{grob}.")
 {
   Grob *g = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   /* FIXME: uhg? copy/read only? */
   return g->mutable_property_alist_;
@@ -233,7 +232,7 @@ LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
 {
   Grob *g = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   /* FIXME: uhg? copy/read only? */
   return g->immutable_property_alist_;
@@ -241,11 +240,11 @@ LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
 
 LY_DEFINE (ly_grob_system, "ly:grob-system",
           1, 0, 0, (SCM grob),
-          "Return the System Grob of @var{grob}.")
+          "Return the system grob of @var{grob}.")
 {
   Grob *me = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   if (System *g = me->get_system ())
     return g->self_scm ();
@@ -255,11 +254,11 @@ LY_DEFINE (ly_grob_system, "ly:grob-system",
 
 LY_DEFINE (ly_grob_original, "ly:grob-original",
           1, 0, 0, (SCM grob),
-          "Return the unbroken original Grob of @var{grob}.")
+          "Return the unbroken original grob of @var{grob}.")
 {
   Grob *me = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
   return me->original () ? me->original ()->self_scm () : me->self_scm ();
 }
 
@@ -270,7 +269,7 @@ LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
 {
   Grob *me = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   me->suicide ();
   return SCM_UNSPECIFIED;
@@ -278,13 +277,14 @@ LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
 
 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
           3, 0, 0, (SCM grob, SCM d, SCM a),
-          "Translate @var{g} on axis @var{a} over distance @var{d}.")
+          "Translate @var{g} on axis@tie{}@var{a} over"
+          " distance@tie{}@var{d}.")
 {
   Grob *me = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_TYPE(scm_is_number, 2);
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_TYPE (scm_is_number, d, 2);
+  LY_ASSERT_TYPE (is_axis, a, 3);
 
   me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
   return SCM_UNSPECIFIED;
@@ -296,7 +296,7 @@ LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
 {
   Grob *gr = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
+  LY_ASSERT_SMOB (Grob, grob, 1);
 
   return Font_interface::get_default_font (gr)->self_scm ();
 }
@@ -309,18 +309,18 @@ LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
  */
 LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
           3, 0, 0,  (SCM grob, SCM other, SCM axis),
-          "Find the common refpoint of @var{grob} and @var{other} for @var{axis}."
-          )
+          "Find the common refpoint of @var{grob} and @var{other}"
+          " for @var{axis}.")
 {
   
   Grob *gr = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_SMOB(Grob, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_SMOB (Grob, other, 2);
 
   Grob *o = unsmob_grob (other);
 
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Grob *refp = gr->common_refpoint (o,  Axis (scm_to_int (axis)));
   return refp ? refp->self_scm () : SCM_BOOL_F;
@@ -328,17 +328,16 @@ LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
 
 LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
           3, 0, 0,  (SCM grob, SCM others, SCM axis),
-          "Find the common refpoint of @var{grob} and @var{others} "
-          "(a grob-array) for @var{axis}."
-          )
+          "Find the common refpoint of @var{grob} and @var{others}"
+          " (a grob-array) for @var{axis}.")
 {
   Grob *gr = unsmob_grob (grob);
    
-  LY_ASSERT_FIRST_SMOB(Grob, grob);
-  LY_ASSERT_SMOB(Grob_array, 2);
+  LY_ASSERT_SMOB (Grob, grob, 1);
+  LY_ASSERT_SMOB (Grob_array, others, 2);
 
   Grob_array *ga = unsmob_grob_array (others);
-  LY_ASSERT_TYPE(is_axis, 3);
+  LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
   return refp ? refp->self_scm () : SCM_BOOL_F;