Doc-es: various updates.

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

diff --git a/lily/grob-scheme.cc b/lily/grob-scheme.cc
index 1bbc53212ab2b04fa3280fcbd1639d3b2b4a1182..572a49ac84afcf788be814ce2a00c2e6c0fde05f 100644 (file)
--- a/lily/grob-scheme.cc
+++ b/lily/grob-scheme.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2014 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
@@ -23,7 +23,6 @@
 #include "item.hh"
 #include "output-def.hh"
 #include "paper-score.hh"
-#include "simple-closure.hh"
 #include "system.hh"
 #include "unpure-pure-container.hh"
 #include "warn.hh"              // error ()
@@ -33,7 +32,7 @@ LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
            "Return the value for property @var{sym} of @var{grob},"
            " but do not process callbacks.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
@@ -45,13 +44,12 @@ 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}.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 
   if (!ly_is_procedure (val)
-      && !is_simple_closure (val)
       && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
     error ("typecheck failed");
 
@@ -63,7 +61,7 @@ LY_DEFINE (ly_grob_set_nested_property_x, "ly:grob-set-nested-property!",
            3, 0, 0, (SCM grob, SCM symlist, SCM val),
            "Set nested property @var{symlist} in grob @var{grob} to value @var{val}.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -88,17 +86,17 @@ LY_DEFINE (ly_grob_pure_property, "ly:grob-pure-property",
            "  If no value is found, return @var{val} or @code{'()}"
            " if @var{val} is not specified.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
   LY_ASSERT_TYPE (scm_is_integer, beg, 3);
   LY_ASSERT_TYPE (scm_is_integer, end, 4);
-  if (val == SCM_UNDEFINED)
+  if (SCM_UNBNDP (val))
     val = SCM_EOL;
 
   SCM retval = sc->internal_get_pure_property (sym, scm_to_int (beg), scm_to_int (end));
-  if (retval == SCM_EOL)
+  if (scm_is_null (retval))
     retval = val;
 
   return retval;
@@ -110,17 +108,17 @@ LY_DEFINE (ly_grob_pure_height, "ly:grob-pure-height",
            "  If no value is found, return @var{val} or @code{'()}"
            " if @var{val} is not specified.")
 {
-  Grob *sc = unsmob_grob (grob);
-  Grob *ref = unsmob_grob (refp);
+  Grob *sc = unsmob<Grob> (grob);
+  Grob *ref = unsmob<Grob> (refp);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob, refp, 2);
   LY_ASSERT_TYPE (scm_is_integer, beg, 3);
   LY_ASSERT_TYPE (scm_is_integer, end, 4);
-  if (val == SCM_UNDEFINED)
+  if (SCM_UNBNDP (val))
     val = SCM_EOL;
 
-  Interval retval = sc->pure_height (ref, scm_to_int (beg), scm_to_int (end));
+  Interval retval = sc->pure_y_extent (ref, scm_to_int (beg), scm_to_int (end));
 
   return ly_interval2scm (retval);
 }
@@ -131,15 +129,15 @@ LY_DEFINE (ly_grob_property, "ly:grob-property",
            "  If no value is found, return @var{val} or @code{'()}"
            " if @var{val} is not specified.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
-  if (val == SCM_UNDEFINED)
+  if (SCM_UNBNDP (val))
     val = SCM_EOL;
 
-  SCM retval = sc->internal_get_property (sym);
-  if (retval == SCM_EOL)
+  SCM retval = sc->get_property (sym);
+  if (scm_is_null (retval))
     retval = val;
 
   return retval;
@@ -149,7 +147,7 @@ LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
            1, 0, 0, (SCM grob),
            "Return the interfaces list of grob @var{grob}.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -162,7 +160,7 @@ LY_DEFINE (ly_grob_object, "ly:grob-object",
            " @var{sym}.  It returns @code{'()} (end-of-list) if @var{sym}"
            " is undefined in @var{grob}.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
@@ -174,7 +172,7 @@ LY_DEFINE (ly_grob_set_object_x, "ly:grob-set-object!",
            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);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
@@ -189,7 +187,7 @@ LY_DEFINE (ly_grob_layout, "ly:grob-layout",
            1, 0, 0, (SCM grob),
            "Get @code{\\layout} definition from grob @var{grob}.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -202,14 +200,14 @@ LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
            " the global default.  If unspecified, @code{font-defaults}"
            " from the layout block is taken.")
 {
-  Grob *sc = unsmob_grob (grob);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
-  if (global == SCM_UNDEFINED)
+  if (SCM_UNBNDP (global))
     {
       global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
-      if (global == SCM_UNDEFINED)
+      if (SCM_UNBNDP (global))
         global = SCM_EOL;
     }
 
@@ -221,8 +219,8 @@ LY_DEFINE (ly_grob_extent, "ly:grob-extent",
            "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);
+  Grob *sc = unsmob<Grob> (grob);
+  Grob *ref = unsmob<Grob> (refp);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob, refp, 2);
@@ -243,8 +241,8 @@ LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
            "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);
+  Grob *sc = unsmob<Grob> (grob);
+  Grob *ref = unsmob<Grob> (refp);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob, refp, 2);
@@ -266,8 +264,8 @@ LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
            "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);
+  Grob *sc = unsmob<Grob> (grob);
+  Grob *ref = unsmob<Grob> (refp);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob, refp, 2);
@@ -289,7 +287,7 @@ LY_DEFINE (ly_grob_parent, "ly:grob-parent",
            "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);
+  Grob *sc = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (is_axis, axis, 2);
@@ -302,8 +300,8 @@ LY_DEFINE (ly_grob_set_parent_x, "ly:grob-set-parent!",
            3, 0, 0, (SCM grob, SCM axis, SCM parent_grob),
            "Set @var{parent-grob} the parent of grob @var{grob} in axis @var{axis}.")
 {
-  Grob *gr = unsmob_grob (grob);
-  Grob *parent = unsmob_grob (parent_grob);
+  Grob *gr = unsmob<Grob> (grob);
+  Grob *parent = unsmob<Grob> (parent_grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (is_axis, axis, 2);
@@ -318,7 +316,7 @@ LY_DEFINE (ly_grob_properties, "ly:grob-properties",
            1, 0, 0, (SCM grob),
            "Get the mutable properties of @var{grob}.")
 {
-  Grob *g = unsmob_grob (grob);
+  Grob *g = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -330,7 +328,7 @@ LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
            1, 0, 0, (SCM grob),
            "Get the immutable properties of @var{grob}.")
 {
-  Grob *g = unsmob_grob (grob);
+  Grob *g = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -342,7 +340,7 @@ LY_DEFINE (ly_grob_system, "ly:grob-system",
            1, 0, 0, (SCM grob),
            "Return the system grob of @var{grob}.")
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -356,7 +354,7 @@ LY_DEFINE (ly_grob_original, "ly:grob-original",
            1, 0, 0, (SCM grob),
            "Return the unbroken original grob of @var{grob}.")
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   return me->original () ? me->original ()->self_scm () : me->self_scm ();
@@ -366,7 +364,7 @@ LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
            1, 0, 0, (SCM grob),
            "Kill @var{grob}.")
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -379,7 +377,7 @@ LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
            "Translate @var{grob} on axis@tie{}@var{a} over"
            " distance@tie{}@var{d}.")
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_TYPE (scm_is_number, d, 2);
@@ -393,7 +391,7 @@ LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
            1, 0, 0, (SCM grob),
            "Return the default font for grob @var{grob}.")
 {
-  Grob *gr = unsmob_grob (grob);
+  Grob *gr = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
@@ -411,12 +409,12 @@ LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
            " for @var{axis}.")
 {
 
-  Grob *gr = unsmob_grob (grob);
+  Grob *gr = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob, other, 2);
 
-  Grob *o = unsmob_grob (other);
+  Grob *o = unsmob<Grob> (other);
 
   LY_ASSERT_TYPE (is_axis, axis, 3);
 
@@ -429,12 +427,12 @@ LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
            "Find the common refpoint of @var{grob} and @var{others}"
            " (a grob-array) for @var{axis}.")
 {
-  Grob *gr = unsmob_grob (grob);
+  Grob *gr = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
   LY_ASSERT_SMOB (Grob_array, others, 2);
 
-  Grob_array *ga = unsmob_grob_array (others);
+  Grob_array *ga = unsmob<Grob_array> (others);
   LY_ASSERT_TYPE (is_axis, axis, 3);
 
   Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
@@ -448,10 +446,10 @@ LY_DEFINE (ly_grob_chain_callback, "ly:grob-chain-callback",
            " to the head of this, meaning that it is called"
            " using @var{grob} and the previous callback's result.")
 {
-  Grob *gr = unsmob_grob (grob);
+  Grob *gr = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
-  SCM_ASSERT_TYPE (ly_is_procedure (proc) || is_unpure_pure_container (proc), proc, SCM_ARG2, __FUNCTION__, "procedure or unpure pure container");
+  SCM_ASSERT_TYPE (ly_is_procedure (proc) || unsmob<Unpure_pure_container> (proc), proc, SCM_ARG2, __FUNCTION__, "procedure or unpure pure container");
   LY_ASSERT_TYPE (ly_is_symbol, sym, 3);
 
   chain_callback (gr, proc, sym);
@@ -465,8 +463,8 @@ LY_DEFINE (ly_grob_vertical_less_p, "ly:grob-vertical<?",
   LY_ASSERT_SMOB (Grob, a, 1);
   LY_ASSERT_SMOB (Grob, b, 2);
 
-  Grob *ga = unsmob_grob (a);
-  Grob *gb = unsmob_grob (b);
+  Grob *ga = unsmob<Grob> (a);
+  Grob *gb = unsmob<Grob> (b);
 
   return ly_bool2scm (Grob::vertical_less (ga, gb));
 }
@@ -476,9 +474,24 @@ LY_DEFINE (ly_grob_get_vertical_axis_group_index, "ly:grob-get-vertical-axis-gro
            "Get the index of the vertical axis group the grob @var{grob} belongs to;"
            " return @code{-1} if none is found.")
 {
-  Grob *gr = unsmob_grob (grob);
+  Grob *gr = unsmob<Grob> (grob);
 
   LY_ASSERT_SMOB (Grob, grob, 1);
 
   return scm_from_int (Grob::get_vertical_axis_group_index (gr));
 }
+
+LY_DEFINE (ly_grob_spanned_rank_interval, "ly:grob-spanned-rank-interval",
+           1, 0, 0, (SCM grob),
+           "Returns a pair with the @code{rank} of the furthest left"
+           " column and the @code{rank} of the furthest right column"
+           " spanned by @code{grob}.")
+{
+  Grob *gr = unsmob<Grob> (grob);
+
+  LY_ASSERT_SMOB (Grob, grob, 1);
+
+  Interval_t<int> iv = gr->spanned_rank_interval ();
+
+  return scm_cons (scm_from_int(iv[LEFT]), scm_from_int(iv[RIGHT]));
+}