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