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