lily/grob-scheme.cc

   1 /*
   2   grob-scheme.cc -- Scheme entry points for the grob datatype
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2007 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>
   8 */
   9
  10 #include "warn.hh"              // error()
  11 #include "item.hh"
  12 #include "output-def.hh"
  13 #include "system.hh"
  14 #include "font-interface.hh"
  15 #include "paper-score.hh"
  16 #include "grob-array.hh"
  17
  18 LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
  19            2, 0, 0, (SCM grob, SCM sym),
  20            "Retrieve @var{sym} for @var{grob} but don't process callbacks.")
  21 {
  22   Grob *sc = unsmob_grob (grob);
  23
  24   LY_FUNC_NOTE_FIRST_ARG(grob);
  25   LY_ASSERT_SMOB(Grob, 1);
  26
  27   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  28
  29   return sc->get_property_data (sym);
  30 }
  31
  32 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
  33            3, 0, 0, (SCM grob, SCM sym, SCM val),
  34            "Set @var{sym} in grob @var{grob} to value @var{val}")
  35 {
  36   Grob *sc = unsmob_grob (grob);
  37   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  38   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  39
  40   if (!ly_is_procedure (val)
  41       && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
  42     error ("typecheck failed");
  43
  44   sc->set_property (sym, val);
  45   return SCM_UNSPECIFIED;
  46 }
  47
  48 LY_DEFINE (ly_grob_property, "ly:grob-property",
  49            2, 1, 0, (SCM grob, SCM sym, SCM deflt),
  50            "Return the value of a value in grob @var{g} of property @var{sym}. "
  51            "It will return @code{'()} or @var{deflt} (if specified) "
  52            "if  @var{sym} is undefined in @var{g}."
  53            "\n\n")
  54 {
  55   Grob *sc = unsmob_grob (grob);
  56   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  57   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  58   if (deflt == SCM_UNDEFINED)
  59     deflt = SCM_EOL;
  60
  61   SCM retval = sc->internal_get_property (sym);
  62   if (retval == SCM_EOL)
  63     retval = deflt;
  64
  65   return retval;
  66 }
  67
  68
  69 LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
  70            1, 0, 0, (SCM grob),
  71            "Return the interfaces list of grob @var{grob}.")
  72 {
  73   Grob *sc = unsmob_grob (grob);
  74   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  75
  76   return sc->interfaces ();
  77 }
  78
  79 LY_DEFINE (ly_grob_object, "ly:grob-object",
  80            2, 0, 0, (SCM grob, SCM sym),
  81            "Return the value of a pointer in grob @var{g} of property @var{sym}. "
  82            "It will return @code{' ()} (end-of-list) "
  83            "if  @var{sym} is undefined in @var{g}."
  84            "\n\n")
  85 {
  86   Grob *sc = unsmob_grob (grob);
  87   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  88   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  89
  90   return sc->internal_get_object (sym);
  91 }
  92
  93
  94
  95 /* TODO: make difference between scaled and unscalead variable in
  96    calling (i.e different funcs.) */
  97 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
  98            1, 0, 0, (SCM g),
  99            "Get @code{\\layout} definition from grob @var{g}.")
 100 {
 101   Grob *sc = unsmob_grob (g);
 102   SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
 103
 104   return sc->layout ()->self_scm ();
 105 }
 106
 107 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
 108            1, 1, 0, (SCM grob, SCM global),
 109            "Get an alist chain for grob @var{grob}, with @var{global} as the "
 110            "global default. If unspecified, @code{font-defaults} "
 111            "from the layout block is taken. ")
 112 {
 113   Grob *sc = unsmob_grob (grob);
 114   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 115
 116   if (global == SCM_UNDEFINED)
 117     {
 118       global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
 119       if (global == SCM_UNDEFINED)
 120         global = SCM_EOL;
 121     }
 122
 123   return sc->get_property_alist_chain (global);
 124 }
 125
 126 LY_DEFINE (ly_grob_extent, "ly:grob-extent",
 127            3, 0, 0, (SCM grob, SCM refp, SCM axis),
 128            "Get the extent in @var{axis} direction of @var{grob} relative to "
 129            "the grob @var{refp}")
 130 {
 131   Grob *sc = unsmob_grob (grob);
 132   Grob *ref = unsmob_grob (refp);
 133
 134   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 135   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
 136   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 137
 138   Axis a = Axis (scm_to_int (axis));
 139
 140
 141   if (ref->common_refpoint (sc, a) != ref)
 142     {
 143       // ugh. should use other error message
 144       SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
 145     }
 146   return ly_interval2scm (sc->extent (ref, a));
 147 }
 148
 149 LY_DEFINE (ly_grob_robust_relative_extent, "ly:grob-robust-relative-extent",
 150            3, 0, 0, (SCM grob, SCM refp, SCM axis),
 151            "Get the extent in @var{axis} direction of @var{grob} relative to "
 152            "the grob @var{refp}, or (0,0) if empty")
 153 {
 154   Grob *sc = unsmob_grob (grob);
 155   Grob *ref = unsmob_grob (refp);
 156
 157   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 158   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
 159   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 160
 161   Axis a = Axis (scm_to_int (axis));
 162
 163   if (ref->common_refpoint (sc, a) != ref)
 164     {
 165       // ugh. should use other error message
 166       SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
 167     }
 168
 169   return ly_interval2scm (robust_relative_extent (sc, ref, a));
 170 }
 171
 172 LY_DEFINE (ly_grob_relative_coordinate, "ly:grob-relative-coordinate",
 173            3, 0, 0, (SCM grob, SCM refp, SCM axis),
 174            "Get the coordinate in @var{axis} direction of @var{grob} relative to "
 175            "the grob @var{refp}")
 176 {
 177   Grob *sc = unsmob_grob (grob);
 178   Grob *ref = unsmob_grob (refp);
 179
 180   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 181   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
 182   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 183
 184   Axis a = Axis (scm_to_int (axis));
 185
 186
 187   if (ref->common_refpoint (sc, a) != ref)
 188     {
 189       // ugh. should use other error message
 190       SCM_ASSERT_TYPE (false, refp, SCM_ARG2, __FUNCTION__, "common refpoint");
 191     }
 192
 193   return scm_from_double (sc->relative_coordinate (ref,a));
 194 }
 195
 196
 197 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
 198            2, 0, 0, (SCM grob, SCM axis),
 199            "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
 200            "1 for the Y-axis.")
 201 {
 202   Grob *sc = unsmob_grob (grob);
 203   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 204   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
 205
 206   Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
 207   return par ? par->self_scm () : SCM_EOL;
 208 }
 209
 210 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
 211            1, 0, 0, (SCM grob),
 212            "Get the mutable proprerties of @var{grob}.")
 213 {
 214   Grob *g = unsmob_grob (grob);
 215   SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
 216
 217   /* FIXME: uhg? copy/read only? */
 218   return g->mutable_property_alist_;
 219 }
 220
 221 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
 222            1, 0, 0, (SCM grob),
 223            "Get the immutable properties of @var{grob}.")
 224 {
 225   Grob *g = unsmob_grob (grob);
 226   SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
 227
 228   /* FIXME: uhg? copy/read only? */
 229   return g->immutable_property_alist_;
 230 }
 231
 232 LY_DEFINE (ly_grob_system, "ly:grob-system",
 233            1, 0, 0, (SCM g),
 234            "Return the System Grob of @var{g}.")
 235 {
 236   Grob *me = unsmob_grob (g);
 237   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 238
 239   if (System *g = me->get_system ())
 240     return g->self_scm ();
 241
 242   return SCM_EOL;
 243 }
 244
 245 LY_DEFINE (ly_grob_original, "ly:grob-original",
 246            1, 0, 0, (SCM grob),
 247            "Return the unbroken original Grob of @var{grob}.")
 248 {
 249   Grob *me = unsmob_grob (grob);
 250   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 251   return me->original () ? me->original ()->self_scm () : me->self_scm ();
 252 }
 253
 254
 255 LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
 256            1, 0, 0, (SCM g),
 257            "Kill @var{g}.")
 258 {
 259   Grob *me = unsmob_grob (g);
 260   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 261
 262   me->suicide ();
 263   return SCM_UNSPECIFIED;
 264 }
 265
 266 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
 267            3, 0, 0, (SCM g, SCM d, SCM a),
 268            "Translate @var{g} on axis @var{a} over distance @var{d}.")
 269 {
 270   Grob *me = unsmob_grob (g);
 271   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 272   SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
 273   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 274
 275   me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
 276   return SCM_UNSPECIFIED;
 277 }
 278
 279 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
 280            1, 0, 0, (SCM grob),
 281            "Return the default font for grob @var{gr}.")
 282 {
 283   Grob *gr = unsmob_grob (grob);
 284   SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
 285
 286   return Font_interface::get_default_font (gr)->self_scm ();
 287 }
 288
 289
 290 /*
 291   TODO: consider swapping order, so we can do
 292
 293   (grob-common-refpoint a b c d e)
 294  */
 295 LY_DEFINE (ly_grob_common_refpoint, "ly:grob-common-refpoint",
 296            3, 0, 0,  (SCM grob, SCM other, SCM axis),
 297            "Find the common refpoint of @var{grob} and @var{other} for @var{axis}."
 298            )
 299 {
 300
 301   Grob *gr = unsmob_grob (grob);
 302   SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
 303
 304   Grob *o = unsmob_grob (other);
 305   SCM_ASSERT_TYPE (o, other, SCM_ARG2, __FUNCTION__, "grob");
 306
 307   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 308
 309   Grob *refp = gr->common_refpoint (o,  Axis (scm_to_int (axis)));
 310   return refp ? refp->self_scm () : SCM_BOOL_F;
 311 }
 312
 313 LY_DEFINE (ly_grob_common_refpoint_of_array, "ly:grob-common-refpoint-of-array",
 314            3, 0, 0,  (SCM grob, SCM others, SCM axis),
 315            "Find the common refpoint of @var{grob} and @var{others} "
 316            "(a grob-array) for @var{axis}."
 317            )
 318 {
 319   Grob *gr = unsmob_grob (grob);
 320   SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
 321
 322   Grob_array *ga = unsmob_grob_array (others);
 323   SCM_ASSERT_TYPE (ga, others, SCM_ARG2, __FUNCTION__, "grob array");
 324   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 325
 326   Grob *refp = common_refpoint_of_array (ga->array (), gr, Axis (scm_to_int (axis)));
 327   return refp ? refp->self_scm () : SCM_BOOL_F;
 328 }