lily/grob-scheme.cc

   1 /*
   2   grob-scheme.cc --
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7                  Han-Wen Nienhuys <hanwen@cs.uu.nl>
   8 */
   9
  10 #include "grob.hh"
  11 #include "warn.hh"
  12 #include "spanner.hh"
  13 #include "item.hh"
  14 #include "paper-def.hh"
  15 #include "system.hh"
  16
  17
  18 LY_DEFINE (ly_grob_set_property,"ly:grob-set-property!", 3, 0, 0,
  19  (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 (gh_symbol_p (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_get_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 {
  41   Grob *sc = unsmob_grob (grob);
  42   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  43   SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  44
  45   return sc->internal_get_property (sym);
  46 }
  47
  48 LY_DEFINE (spanner_get_bound, "ly:spanner-get-bound", 2 , 0, 0,
  49            (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_paper,"ly:grob-paper", 1, 0, 0,
  62  (SCM g),
  63   "Get @code{\\paper} 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_paper ()->self_scm ();
  69 }
  70
  71
  72 LY_DEFINE(ly_grob_alist_chain, "ly:grob-alist-chain",
  73           1, 0, 0,
  74           (SCM g),
  75           "Get an alist chain for grob @var{g}."
  76           )
  77 {
  78   Grob * sc = unsmob_grob (g);
  79   SCM_ASSERT_TYPE (sc, g, SCM_ARG1, __FUNCTION__, "grob");
  80
  81   SCM defaults = sc->get_paper ()->lookup_variable (ly_symbol2scm ("font-defaults"));
  82   return sc->get_property_alist_chain (defaults);
  83 }
  84
  85
  86 LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
  87            (SCM grob, SCM refp, SCM axis),
  88            "Get the extent in @var{axis} direction of @var{grob} relative to "
  89            "the grob @var{refp}")
  90 {
  91   Grob * sc = unsmob_grob (grob);
  92   Grob * ref = unsmob_grob (refp);
  93   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  94   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
  95
  96   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
  97
  98   return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
  99 }
 100
 101 LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
 102            "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
 103            "1 for the Y-axis.")
 104 {
 105   Grob * sc = unsmob_grob (grob);
 106   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
 107   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
 108
 109   Grob *par = sc->get_parent (Axis (gh_scm2int (axis)));
 110   return par ? par->self_scm () : SCM_EOL;
 111 }
 112
 113 LY_DEFINE (ly_get_system, "ly:grob-system",
 114            1, 0, 0, (SCM g),
 115            "Return the System Grob of @var{g}.")
 116 {
 117   Grob *me = unsmob_grob (g);
 118   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 119
 120   if (System *g = me->get_system ())
 121     return g->self_scm ();
 122
 123   return SCM_EOL;
 124 }
 125
 126 LY_DEFINE (ly_get_original, "ly:grob-original",
 127            1, 0, 0, (SCM grob),
 128            "Return the unbroken original Grob of @var{grob}.")
 129 {
 130   Grob *me = unsmob_grob (grob);
 131   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 132   return me->original_ ? me->original_->self_scm () : me->self_scm ();
 133 }
 134
 135 /* FIXME: ly prefix? spanner in name? */
 136 /* TODO: maybe we should return a vector -- random access is more
 137    logical for this list? */
 138 LY_DEFINE (get_broken_into, "ly:spanner-broken-into",
 139            1, 0, 0, (SCM spanner),
 140            "Return broken-into list for @var{spanner}.")
 141 {
 142   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
 143   SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
 144
 145   SCM s = SCM_EOL;
 146   for (int i = me->broken_intos_.size (); i; i--)
 147     s = gh_cons (me->broken_intos_[i-1]->self_scm (), s);
 148   return s;
 149 }
 150
 151 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
 152            1, 0, 0, (SCM g),
 153            "Kill @var{g}.")
 154 {
 155   Grob *me = unsmob_grob (g);
 156   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 157
 158   me->suicide ();
 159   return SCM_UNDEFINED;
 160 }
 161
 162 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
 163            3, 0, 0, (SCM g, SCM d, SCM a),
 164            "Translate @var{g} on axis @var{a} over distance @var{d}.")
 165 {
 166   Grob *me = unsmob_grob (g);
 167   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 168   SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
 169   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 170
 171   me->translate_axis (gh_scm2double (d), Axis (gh_scm2int (a)));
 172   return SCM_UNDEFINED;
 173 }
 174
 175 LY_DEFINE (ly_spanner_p, "ly:spanner?",
 176            1, 0, 0, (SCM g),
 177            "Is  @var{g} a spanner object?")
 178 {
 179   Grob *me = unsmob_grob (g);
 180   bool b = dynamic_cast<Spanner*> (me);
 181
 182   return gh_bool2scm (b);
 183 }
 184
 185 LY_DEFINE (ly_item_p, "ly:item?",
 186            1, 0, 0, (SCM g),
 187            "Is @var{g} an @code{Item} object?")
 188 {
 189   Grob *me = unsmob_grob (g);
 190   bool b = dynamic_cast<Item*> (me);
 191   return gh_bool2scm (b);
 192 }
 193
 194 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
 195            1, 0, 0, (SCM it),
 196            "The break status dir of item @var{it}. @code{-1} is end of "
 197            "line, @code{0} unbroken, and @code{1} begin of line.")
 198 {
 199   Item *me = dynamic_cast<Item*> (unsmob_grob (it));
 200   SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
 201   return gh_int2scm (me->break_status_dir ());
 202 }