]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-scheme.cc
* lily/stencil-scheme.cc:
[lilypond.git] / lily / grob-scheme.cc
index f825996bc499fef11a99e87df8b833b75207822f..ffee573c797fc1572a5892aca4da26b4b3ffb6ed 100644 (file)
@@ -1,3 +1,12 @@
+/*
+  grob-scheme.cc --
+
+  source file of the GNU LilyPond music typesetter
+
+  (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+                 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+*/
+
 #include "grob.hh"
 #include "warn.hh"
 #include "spanner.hh"
 
 
 LY_DEFINE (ly_grob_set_property,"ly:grob-set-property!", 3, 0, 0,
 (SCM grob, SCM sym, SCM val),
+ (SCM grob, SCM sym, SCM val),
   "Set @var{sym} in grob @var{grob} to value @var{val}")
 {
   Grob * sc = unsmob_grob (grob);
   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
+  SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 
   if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
     error ("typecheck failed");
-      
+
   sc->internal_set_property (sym, val);
   return SCM_UNSPECIFIED;
 }
 
-LY_DEFINE (ly_get_property,
-         "ly:grob-property", 2, 0, 0, (SCM grob, SCM sym),
-         "Get the value of a value in grob @var{g} of property @var{sym}. It\n"
-"will return @code{'()} (end-of-list) if @var{g} doesn't have @var{sym} set.\n"
-"\n"
-"Grob properties are stored as GUILE association lists, with symbols as\n"
-"keys. All lookup functions identify undefined properties with\n"
-"end-of-list (i.e. @code{'()} in Scheme or @code{SCM_EOL} in C)\n"
-"\n")
+LY_DEFINE (ly_get_property, "ly:grob-property",
+          2, 0, 0, (SCM grob, SCM sym),
+         "Return the value of a value in grob @var{g} of property @var{sym}. "
+          "It will return @code{' ()} (end-of-list) "
+          "if @var{g} does nott have @var{sym} set."
+          "\n\n"
+          "Grob properties are stored as GUILE association lists, "
+          "with symbols as keys. "
+          "All lookup functions identify undefined properties "
+          "with end-of-list (i.e. @code{' ()} in Scheme "
+          "or @code{SCM_EOL} in C.")
 {
-  Grob * sc = unsmob_grob (grob);
+  Grob *sc = unsmob_grob (grob);
   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");  
+  SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 
   return sc->internal_get_property (sym);
 }
@@ -52,7 +63,7 @@ LY_DEFINE (spanner_get_bound, "ly:spanner-get-bound", 2 , 0, 0,
 /* TODO: make difference between scaled and unscalead variable in
    calling (i.e different funcs.) */
 LY_DEFINE (ly_grob_paper,"ly:grob-paper", 1, 0, 0,
 (SCM grob),
+ (SCM grob),
   "Get \\paper definition from a grob.")
 {
   Grob * sc = unsmob_grob (grob);
@@ -61,9 +72,6 @@ LY_DEFINE (ly_grob_paper,"ly:grob-paper", 1, 0, 0,
   return sc->get_paper ()->self_scm ();
 }
 
-
-
-
 LY_DEFINE (ly_get_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 "
@@ -73,7 +81,7 @@ LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
   Grob * ref = unsmob_grob (refp);
   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
-  
+
   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 
   return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
@@ -87,26 +95,24 @@ LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
 
-  Grob * par = sc->get_parent (Axis (gh_scm2int (axis)));
+  Grob *par = sc->get_parent (Axis (gh_scm2int (axis)));
   return par ? par->self_scm () : SCM_EOL;
 }
 
-LY_DEFINE (ly_get_system,
-          "ly:grob-system",
+LY_DEFINE (ly_get_system, "ly:grob-system",
           1, 0, 0, (SCM grob),
           "Return the System Grob of @var{grob}.")
 {
   Grob *me = unsmob_grob (grob);
   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
-  
+
   if (System *g = me->get_system ())
     return g->self_scm ();
-    
+
   return SCM_EOL;
 }
 
-LY_DEFINE (ly_get_original,
-          "ly:grob-original",
+LY_DEFINE (ly_get_original, "ly:grob-original",
           1, 0, 0, (SCM grob),
           "Return the unbroken original Grob of @var{grob}.")
 {
@@ -115,16 +121,13 @@ LY_DEFINE (ly_get_original,
   return me->original_ ? me->original_->self_scm () : me->self_scm ();
 }
 
-
-/* ly prefix? spanner in name? */
+/* FIXME: ly prefix? spanner in name? */
 /* TODO: maybe we should return a vector -- random access is more
-  logical for this list? */
-
-LY_DEFINE (get_broken_into,
-         "ly:spanner-broken-into", 1, 0, 0, (SCM spanner),
+   logical for this list? */
+LY_DEFINE (get_broken_into, "ly:spanner-broken-into",
+          1, 0, 0, (SCM spanner),
           "Return broken-into list for @var{spanner}.")
 {
-  ///  Spanner *me = unsmob_spanner (spanner);
   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
   SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
 
@@ -134,9 +137,8 @@ LY_DEFINE (get_broken_into,
   return s;
 }
 
-
-LY_DEFINE (ly_grob_suicide,
-         "ly:grob-suicide", 1, 0, 0, (SCM g),
+LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
+          1, 0, 0, (SCM g),
           "Kill @var{g}.")
 {
   Grob *me = unsmob_grob (g);
@@ -146,11 +148,8 @@ LY_DEFINE (ly_grob_suicide,
   return SCM_UNDEFINED;
 }
 
-
-
-LY_DEFINE (ly_grob_translate_axis_x,
-         "ly:grob-translate-axis!", 3, 0, 0,
-          (SCM g, SCM d, SCM a),
+LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
+          3, 0, 0, (SCM g, SCM d, SCM a),
           "Translate @var{g} on axis @var{a} over distance @var{d}.")
 {
   Grob *me = unsmob_grob (g);
@@ -158,16 +157,12 @@ LY_DEFINE (ly_grob_translate_axis_x,
   SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 
-  me->translate_axis (gh_scm2double (d),
-                     Axis (gh_scm2int (a)));
+  me->translate_axis (gh_scm2double (d), Axis (gh_scm2int (a)));
   return SCM_UNDEFINED;
 }
 
-
-
-LY_DEFINE (ly_spanner_p,
-         "ly:spanner?", 1, 0, 0,
-          (SCM g),
+LY_DEFINE (ly_spanner_p, "ly:spanner?",
+          1, 0, 0, (SCM g),
           "Is  @var{g} a spanner object?")
 {
   Grob *me = unsmob_grob (g);
@@ -176,26 +171,20 @@ LY_DEFINE (ly_spanner_p,
   return gh_bool2scm (b);
 }
 
-LY_DEFINE (ly_item_p,
-         "ly:item?", 1, 0, 0,
-          (SCM g),
-          "Is  @var{g} a item object?")
+LY_DEFINE (ly_item_p, "ly:item?",
+          1, 0, 0, (SCM g),
+          "Is @var{g} a item object?")
 {
   Grob *me = unsmob_grob (g);
   bool b = dynamic_cast<Item*> (me);
-
   return gh_bool2scm (b);
 }
 
-
-LY_DEFINE (ly_item_break_dir,
-         "ly:item-break-dir", 1, 0, 0,
-          (SCM it),
+LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
+          1, 0, 0, (SCM it),
           "The break status dir of  @var{it}.")
 {
-  Item * me = dynamic_cast<Item*> ( unsmob_grob (it));
+  Item *me = dynamic_cast<Item*> ( unsmob_grob (it));
   SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
-  
-   return gh_int2scm (me->break_status_dir ());
+  return gh_int2scm (me->break_status_dir ());
 }
-