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