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