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--2005 Jan Nieuwenhuizen <janneke@gnu.org>
   7   Han-Wen Nienhuys <hanwen@xs4all.nl>
   8 */
   9
  10 #include "grob.hh"
  11
  12 #include "warn.hh"
  13 #include "item.hh"
  14 #include "output-def.hh"
  15 #include "system.hh"
  16 #include "font-interface.hh"
  17
  18
  19
  20 LY_DEFINE (ly_grob_property_data, "ly:grob-property-data",
  21            2, 0, 0, (SCM grob, SCM sym),
  22            //, SCM dfault),
  23            "Retrieve @var{sym} for @var{grob} but don't process callbacks.")
  24 {
  25   Grob *sc = unsmob_grob (grob);
  26   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  27   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  28   //  SCM_ASSERT_TYPE (ly_is_procedure (proc), proc, SCM_ARG3, __FUNCTION__, "procedure");
  29
  30   return sc->get_property_data (sym);
  31 }
  32
  33 LY_DEFINE (ly_grob_set_property_x, "ly:grob-set-property!",
  34            3, 0, 0, (SCM grob, SCM sym, SCM val),
  35            "Set @var{sym} in grob @var{grob} to value @var{val}")
  36 {
  37   Grob *sc = unsmob_grob (grob);
  38   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  39   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  40
  41   if (!ly_is_procedure (val)
  42       && !type_check_assignment (sym, val, ly_symbol2scm ("backend-type?")))
  43     error ("typecheck failed");
  44
  45   sc->internal_set_property (sym, val);
  46   return SCM_UNSPECIFIED;
  47 }
  48
  49 LY_DEFINE (ly_grob_property, "ly:grob-property",
  50            2, 0, 0, (SCM grob, SCM sym),
  51            "Return the value of a value in grob @var{g} of property @var{sym}. "
  52            "It will return @code{'()} (end-of-list) "
  53            "if  @var{sym} is undefined in @var{g}."
  54            "\n\n")
  55 {
  56   Grob *sc = unsmob_grob (grob);
  57   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  58   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  59
  60   return sc->internal_get_property (sym);
  61 }
  62
  63
  64 LY_DEFINE (ly_grob_interfaces, "ly:grob-interfaces",
  65            1, 0, 0, (SCM grob),
  66            "Return the interfaces list of  grob @var{grob}.")
  67 {
  68   Grob *sc = unsmob_grob (grob);
  69   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  70
  71   return sc->interfaces ();
  72 }
  73
  74 LY_DEFINE (ly_grob_object, "ly:grob-object",
  75            2, 0, 0, (SCM grob, SCM sym),
  76            "Return the value of a pointer in grob @var{g} of property @var{sym}. "
  77            "It will return @code{' ()} (end-of-list) "
  78            "if  @var{sym} is undefined in @var{g}."
  79            "\n\n")
  80 {
  81   Grob *sc = unsmob_grob (grob);
  82   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  83   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  84
  85   return sc->internal_get_object (sym);
  86 }
  87
  88 LY_DEFINE (ly_spanner_get_bound, "ly:spanner-get-bound",
  89            2, 0, 0, (SCM slur, SCM dir),
  90            "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
  91            "for left, and @code{1} for right.")
  92 {
  93   Spanner *sl = dynamic_cast<Spanner *> (unsmob_grob (slur));
  94   SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
  95   SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
  96   return sl->get_bound (to_dir (dir))->self_scm ();
  97 }
  98
  99 /* TODO: make difference between scaled and unscalead variable in
 100    calling (i.e different funcs.) */
 101 LY_DEFINE (ly_grob_layout, "ly:grob-layout",
 102            1, 0, 0, (SCM g),
 103            "Get @code{\\layout} definition from grob @var{g}.")
 104 {
 105   Grob *sc = unsmob_grob (g);
 106   SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
 107
 108   return sc->layout ()->self_scm ();
 109 }
 110
 111 LY_DEFINE (ly_grob_alist_chain, "ly:grob-alist-chain",
 112            1, 1, 0, (SCM grob, SCM global),
 113            "Get an alist chain for grob @var{grob}, with @var{global} as the "
 114            "global default. If unspecified, @code{font-defaults} "
 115            "from the layout block is taken. ")
 116 {
 117   Grob *sc = unsmob_grob (grob);
 118   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 119
 120   if (global == SCM_UNDEFINED)
 121     {
 122       global = sc->layout ()->lookup_variable (ly_symbol2scm ("font-defaults"));
 123       if (global == SCM_UNDEFINED)
 124         global = SCM_EOL;
 125     }
 126
 127   return sc->get_property_alist_chain (global);
 128 }
 129
 130 LY_DEFINE (ly_get_extent, "ly:grob-extent",
 131            3, 0, 0, (SCM grob, SCM refp, SCM axis),
 132            "Get the extent in @var{axis} direction of @var{grob} relative to "
 133            "the grob @var{refp}")
 134 {
 135   Grob *sc = unsmob_grob (grob);
 136   Grob *ref = unsmob_grob (refp);
 137   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 138   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
 139   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
 140
 141   return ly_interval2scm (sc->extent (ref, Axis (scm_to_int (axis))));
 142 }
 143
 144 LY_DEFINE (ly_grob_parent, "ly:grob-parent",
 145            2, 0, 0, (SCM grob, SCM axis),
 146            "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
 147            "1 for the Y-axis.")
 148 {
 149   Grob *sc = unsmob_grob (grob);
 150   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 151   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
 152
 153   Grob *par = sc->get_parent (Axis (scm_to_int (axis)));
 154   return par ? par->self_scm () : SCM_EOL;
 155 }
 156
 157 LY_DEFINE (ly_grob_properties, "ly:grob-properties",
 158            1, 0, 0, (SCM grob),
 159            "Get the mutable proprerties of @var{grob}.")
 160 {
 161   Grob *g = unsmob_grob (grob);
 162   SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
 163
 164   /* FIXME: uhg? copy/read only? */
 165   return g->mutable_property_alist_;
 166 }
 167
 168 LY_DEFINE (ly_grob_basic_properties, "ly:grob-basic-properties",
 169            1, 0, 0, (SCM grob),
 170            "Get the immutable properties of @var{grob}.")
 171 {
 172   Grob *g = unsmob_grob (grob);
 173   SCM_ASSERT_TYPE (g, grob, SCM_ARG1, __FUNCTION__, "grob");
 174
 175   /* FIXME: uhg? copy/read only? */
 176   return g->immutable_property_alist_;
 177 }
 178
 179 LY_DEFINE (ly_grob_system, "ly:grob-system",
 180            1, 0, 0, (SCM g),
 181            "Return the System Grob of @var{g}.")
 182 {
 183   Grob *me = unsmob_grob (g);
 184   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 185
 186   if (System *g = me->get_system ())
 187     return g->self_scm ();
 188
 189   return SCM_EOL;
 190 }
 191
 192 LY_DEFINE (ly_grob_original, "ly:grob-original",
 193            1, 0, 0, (SCM grob),
 194            "Return the unbroken original Grob of @var{grob}.")
 195 {
 196   Grob *me = unsmob_grob (grob);
 197   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 198   return me->original () ? me->original ()->self_scm () : me->self_scm ();
 199 }
 200
 201 /* TODO: maybe we should return a vector -- random access is more
 202    logical for this list? */
 203 LY_DEFINE (ly_spanner_broken_into, "ly:spanner-broken-into",
 204            1, 0, 0, (SCM spanner),
 205            "Return broken-into list for @var{spanner}.")
 206 {
 207   Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (spanner));
 208   SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
 209
 210   SCM s = SCM_EOL;
 211   for (int i = me->broken_intos_.size (); i--;)
 212     s = scm_cons (me->broken_intos_[i]->self_scm (), s);
 213   return s;
 214 }
 215
 216 LY_DEFINE (ly_grob_suicide_x, "ly:grob-suicide!",
 217            1, 0, 0, (SCM g),
 218            "Kill @var{g}.")
 219 {
 220   Grob *me = unsmob_grob (g);
 221   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 222
 223   me->suicide ();
 224   return SCM_UNSPECIFIED;
 225 }
 226
 227 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
 228            3, 0, 0, (SCM g, SCM d, SCM a),
 229            "Translate @var{g} on axis @var{a} over distance @var{d}.")
 230 {
 231   Grob *me = unsmob_grob (g);
 232   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 233   SCM_ASSERT_TYPE (scm_is_number (d), d, SCM_ARG2, __FUNCTION__, "dimension");
 234   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 235
 236   me->translate_axis (scm_to_double (d), Axis (scm_to_int (a)));
 237   return SCM_UNSPECIFIED;
 238 }
 239
 240 LY_DEFINE (ly_spanner_p, "ly:spanner?",
 241            1, 0, 0, (SCM g),
 242            "Is  @var{g} a spanner object?")
 243 {
 244   Grob *me = unsmob_grob (g);
 245   bool b = dynamic_cast<Spanner *> (me);
 246
 247   return ly_bool2scm (b);
 248 }
 249
 250 LY_DEFINE (ly_grob_key, "ly:grob-key",
 251            1, 0, 0,
 252            (SCM grob),
 253            "Return the object-key for @var{grob}.")
 254 {
 255   Grob *me = unsmob_grob (grob);
 256   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "Grob");
 257   return me->key ()->self_scm ();
 258 }
 259
 260 LY_DEFINE (ly_grob_default_font, "ly:grob-default-font",
 261            1, 0, 0, (SCM grob),
 262            "Return the default font for grob @var{gr}.")
 263 {
 264   Grob *gr = unsmob_grob (grob);
 265   SCM_ASSERT_TYPE (gr, grob, SCM_ARG1, __FUNCTION__, "grob");
 266
 267   return Font_interface::get_default_font (gr)->self_scm ();
 268 }