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