]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob-scheme.cc
new file, move from
[lilypond.git] / lily / grob-scheme.cc
index 2906d08dd5b83e8795a5654af37538d9f8893b22..740491f52a1b32a20a9f0a20b67fc9a0af3176c0 100644 (file)
@@ -1,41 +1,48 @@
+/*
+  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"
 #include "item.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "system.hh"
 
 
-LY_DEFINE (ly_set_grob_property,"ly:set-grob-property!", 3, 0, 0,
 (SCM grob, SCM sym, SCM val),
+LY_DEFINE (ly_grob_set_property,"ly:grob-set-property!", 3, 0, 0,
+ (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 (ly_c_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 
   if (!type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
     error ("typecheck failed");
-      
-  sc->internal_set_grob_property (sym, val);
+
+  sc->internal_set_property (sym, val);
   return SCM_UNSPECIFIED;
 }
 
-LY_DEFINE (ly_get_grob_property,
-         "ly:get-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{sym} is undefined in @var{g}."
+          "\n\n"
+          )
 {
-  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 (ly_c_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 
-  return sc->internal_get_grob_property (sym);
+  return sc->internal_get_property (sym);
 }
 
 LY_DEFINE (spanner_get_bound, "ly:spanner-get-bound", 2 , 0, 0,
@@ -52,16 +59,32 @@ 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),
-  "Get \\paper definition from a grob.")
(SCM g),
+  "Get @code{\\paper} definition from grob @var{g}.")
 {
-  Grob * sc = unsmob_grob (grob);
-  SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
+  Grob * sc = unsmob_grob (g);
+  SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
 
   return sc->get_paper ()->self_scm ();
 }
 
 
+LY_DEFINE(ly_grob_alist_chain, "ly:grob-alist-chain",
+         1, 1, 0,
+         (SCM g, SCM global),
+         "Get an alist chain for grob @var{g}, with @var{global} as the "
+         "global default. If unspecified, @code{font-defaults} "
+         "from the paper block is taken. "
+         )
+{
+  Grob * sc = unsmob_grob (g);
+  SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
+
+  if (global == SCM_UNDEFINED)
+    global = sc->get_paper ()->lookup_variable (ly_symbol2scm ("font-defaults"));
+
+  return sc->get_property_alist_chain (global);
+}
 
 
 LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
@@ -73,10 +96,10 @@ 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))));
+  return ly_interval2scm ( sc->extent (ref, Axis (ly_scm2int (axis))));
 }
 
 LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
@@ -87,26 +110,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 (ly_scm2int (axis)));
   return par ? par->self_scm () : SCM_EOL;
 }
 
-LY_DEFINE (ly_get_system,
-          "ly:grob-system",
-          1, 0, 0, (SCM grob),
-          "Return the System Grob of @var{grob}.")
+LY_DEFINE (ly_get_system, "ly:grob-system",
+          1, 0, 0, (SCM g),
+          "Return the System Grob of @var{g}.")
 {
-  Grob *me = unsmob_grob (grob);
-  SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
-  
+  Grob *me = unsmob_grob (g);
+  SCM_ASSERT_TYPE (me, g, 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,28 +136,24 @@ 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");
 
   SCM s = SCM_EOL;
-  for (int i = me->broken_intos_.size (); i; i--)
-    s = gh_cons (me->broken_intos_[i-1]->self_scm (), s);
+  for (int i = me->broken_intos_.size (); i--;)
+    s = scm_cons (me->broken_intos_[i]->self_scm (), s);
   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,56 +163,44 @@ 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);
   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
-  SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
+  SCM_ASSERT_TYPE (ly_c_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 (ly_scm2double (d), Axis (ly_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);
   bool b = dynamic_cast<Spanner*> (me);
 
-  return gh_bool2scm (b);
+  return ly_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} an @code{Item} object?")
 {
   Grob *me = unsmob_grob (g);
   bool b = dynamic_cast<Item*> (me);
-
-  return gh_bool2scm (b);
+  return ly_bool2scm (b);
 }
 
-
-LY_DEFINE (ly_item_break_dir,
-         "ly:item-break-dir", 1, 0, 0,
-          (SCM it),
-          "The break status dir of  @var{it}.")
+LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
+          1, 0, 0, (SCM it),
+          "The break status dir of item @var{it}. @code{-1} is end of "
+          "line, @code{0} unbroken, and @code{1} begin of line.")
 {
-  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 scm_int2num (me->break_status_dir ());
 }
-