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{g} does nott have @var{sym} set."
  38            "\n\n"
  39            "Grob properties are stored as GUILE association lists, "
  40            "with symbols as keys. "
  41            "All lookup functions identify undefined properties "
  42            "with end-of-list (i.e. @code{' ()} in Scheme "
  43            "or @code{SCM_EOL} in C.")
  44 {
  45   Grob *sc = unsmob_grob (grob);
  46   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  47   SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  48
  49   return sc->internal_get_property (sym);
  50 }
  51
  52 LY_DEFINE (spanner_get_bound, "ly:spanner-get-bound", 2 , 0, 0,
  53            (SCM slur, SCM dir),
  54            "Get one of the bounds of @var{spanner}. @var{dir} is @code{-1} "
  55            "for left, and @code{1} for right.")
  56 {
  57   Spanner * sl = dynamic_cast<Spanner*> (unsmob_grob (slur));
  58   SCM_ASSERT_TYPE (sl, slur, SCM_ARG1, __FUNCTION__, "spanner grob");
  59   SCM_ASSERT_TYPE (is_direction (dir), slur, SCM_ARG2, __FUNCTION__, "dir");
  60   return sl->get_bound (to_dir (dir))->self_scm ();
  61 }
  62
  63 /* TODO: make difference between scaled and unscalead variable in
  64    calling (i.e different funcs.) */
  65 LY_DEFINE (ly_grob_paper,"ly:grob-paper", 1, 0, 0,
  66  (SCM grob),
  67   "Get \\paper definition from a grob.")
  68 {
  69   Grob * sc = unsmob_grob (grob);
  70   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  71
  72   return sc->get_paper ()->self_scm ();
  73 }
  74
  75 LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
  76            (SCM grob, SCM refp, SCM axis),
  77            "Get the extent in @var{axis} direction of @var{grob} relative to "
  78            "the grob @var{refp}")
  79 {
  80   Grob * sc = unsmob_grob (grob);
  81   Grob * ref = unsmob_grob (refp);
  82   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  83   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
  84
  85   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
  86
  87   return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
  88 }
  89
  90 LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
  91            "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
  92            "1 for the Y-axis.")
  93 {
  94   Grob * sc = unsmob_grob (grob);
  95   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  96   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
  97
  98   Grob *par = sc->get_parent (Axis (gh_scm2int (axis)));
  99   return par ? par->self_scm () : SCM_EOL;
 100 }
 101
 102 LY_DEFINE (ly_get_system, "ly:grob-system",
 103            1, 0, 0, (SCM grob),
 104            "Return the System Grob of @var{grob}.")
 105 {
 106   Grob *me = unsmob_grob (grob);
 107   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 108
 109   if (System *g = me->get_system ())
 110     return g->self_scm ();
 111
 112   return SCM_EOL;
 113 }
 114
 115 LY_DEFINE (ly_get_original, "ly:grob-original",
 116            1, 0, 0, (SCM grob),
 117            "Return the unbroken original Grob of @var{grob}.")
 118 {
 119   Grob *me = unsmob_grob (grob);
 120   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 121   return me->original_ ? me->original_->self_scm () : me->self_scm ();
 122 }
 123
 124 /* FIXME: ly prefix? spanner in name? */
 125 /* TODO: maybe we should return a vector -- random access is more
 126    logical for this list? */
 127 LY_DEFINE (get_broken_into, "ly:spanner-broken-into",
 128            1, 0, 0, (SCM spanner),
 129            "Return broken-into list for @var{spanner}.")
 130 {
 131   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
 132   SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
 133
 134   SCM s = SCM_EOL;
 135   for (int i = me->broken_intos_.size (); i; i--)
 136     s = gh_cons (me->broken_intos_[i-1]->self_scm (), s);
 137   return s;
 138 }
 139
 140 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
 141            1, 0, 0, (SCM g),
 142            "Kill @var{g}.")
 143 {
 144   Grob *me = unsmob_grob (g);
 145   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 146
 147   me->suicide ();
 148   return SCM_UNDEFINED;
 149 }
 150
 151 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
 152            3, 0, 0, (SCM g, SCM d, SCM a),
 153            "Translate @var{g} on axis @var{a} over distance @var{d}.")
 154 {
 155   Grob *me = unsmob_grob (g);
 156   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 157   SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
 158   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 159
 160   me->translate_axis (gh_scm2double (d), Axis (gh_scm2int (a)));
 161   return SCM_UNDEFINED;
 162 }
 163
 164 LY_DEFINE (ly_spanner_p, "ly:spanner?",
 165            1, 0, 0, (SCM g),
 166            "Is  @var{g} a spanner object?")
 167 {
 168   Grob *me = unsmob_grob (g);
 169   bool b = dynamic_cast<Spanner*> (me);
 170
 171   return gh_bool2scm (b);
 172 }
 173
 174 LY_DEFINE (ly_item_p, "ly:item?",
 175            1, 0, 0, (SCM g),
 176            "Is @var{g} a item object?")
 177 {
 178   Grob *me = unsmob_grob (g);
 179   bool b = dynamic_cast<Item*> (me);
 180   return gh_bool2scm (b);
 181 }
 182
 183 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
 184            1, 0, 0, (SCM it),
 185            "The break status dir of  @var{it}.")
 186 {
 187   Item *me = dynamic_cast<Item*> ( unsmob_grob (it));
 188   SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
 189   return gh_int2scm (me->break_status_dir ());
 190 }