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