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 LY_DEFINE (ly_get_extent, "ly:grob-extent", 3, 0, 0,
  72            (SCM grob, SCM refp, SCM axis),
  73            "Get the extent in @var{axis} direction of @var{grob} relative to "
  74            "the grob @var{refp}")
  75 {
  76   Grob * sc = unsmob_grob (grob);
  77   Grob * ref = unsmob_grob (refp);
  78   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  79   SCM_ASSERT_TYPE (ref, refp, SCM_ARG2, __FUNCTION__, "grob");
  80
  81   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
  82
  83   return ly_interval2scm ( sc->extent (ref, Axis (gh_scm2int (axis))));
  84 }
  85
  86 LY_DEFINE (ly_get_parent, "ly:grob-parent", 2, 0, 0, (SCM grob, SCM axis),
  87            "Get the parent of @var{grob}.  @var{axis} is 0 for the X-axis, "
  88            "1 for the Y-axis.")
  89 {
  90   Grob * sc = unsmob_grob (grob);
  91   SCM_ASSERT_TYPE (sc, grob, SCM_ARG1, __FUNCTION__, "grob");
  92   SCM_ASSERT_TYPE (is_axis (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
  93
  94   Grob *par = sc->get_parent (Axis (gh_scm2int (axis)));
  95   return par ? par->self_scm () : SCM_EOL;
  96 }
  97
  98 LY_DEFINE (ly_get_system, "ly:grob-system",
  99            1, 0, 0, (SCM g),
 100            "Return the System Grob of @var{g}.")
 101 {
 102   Grob *me = unsmob_grob (g);
 103   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 104
 105   if (System *g = me->get_system ())
 106     return g->self_scm ();
 107
 108   return SCM_EOL;
 109 }
 110
 111 LY_DEFINE (ly_get_original, "ly:grob-original",
 112            1, 0, 0, (SCM grob),
 113            "Return the unbroken original Grob of @var{grob}.")
 114 {
 115   Grob *me = unsmob_grob (grob);
 116   SCM_ASSERT_TYPE (me, grob, SCM_ARG1, __FUNCTION__, "grob");
 117   return me->original_ ? me->original_->self_scm () : me->self_scm ();
 118 }
 119
 120 /* FIXME: ly prefix? spanner in name? */
 121 /* TODO: maybe we should return a vector -- random access is more
 122    logical for this list? */
 123 LY_DEFINE (get_broken_into, "ly:spanner-broken-into",
 124            1, 0, 0, (SCM spanner),
 125            "Return broken-into list for @var{spanner}.")
 126 {
 127   Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (spanner));
 128   SCM_ASSERT_TYPE (me, spanner, SCM_ARG1, __FUNCTION__, "spanner");
 129
 130   SCM s = SCM_EOL;
 131   for (int i = me->broken_intos_.size (); i; i--)
 132     s = gh_cons (me->broken_intos_[i-1]->self_scm (), s);
 133   return s;
 134 }
 135
 136 LY_DEFINE (ly_grob_suicide, "ly:grob-suicide",
 137            1, 0, 0, (SCM g),
 138            "Kill @var{g}.")
 139 {
 140   Grob *me = unsmob_grob (g);
 141   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 142
 143   me->suicide ();
 144   return SCM_UNDEFINED;
 145 }
 146
 147 LY_DEFINE (ly_grob_translate_axis_x, "ly:grob-translate-axis!",
 148            3, 0, 0, (SCM g, SCM d, SCM a),
 149            "Translate @var{g} on axis @var{a} over distance @var{d}.")
 150 {
 151   Grob *me = unsmob_grob (g);
 152   SCM_ASSERT_TYPE (me, g, SCM_ARG1, __FUNCTION__, "grob");
 153   SCM_ASSERT_TYPE (gh_number_p (d), d, SCM_ARG2, __FUNCTION__, "dimension");
 154   SCM_ASSERT_TYPE (is_axis (a), a, SCM_ARG3, __FUNCTION__, "axis");
 155
 156   me->translate_axis (gh_scm2double (d), Axis (gh_scm2int (a)));
 157   return SCM_UNDEFINED;
 158 }
 159
 160 LY_DEFINE (ly_spanner_p, "ly:spanner?",
 161            1, 0, 0, (SCM g),
 162            "Is  @var{g} a spanner object?")
 163 {
 164   Grob *me = unsmob_grob (g);
 165   bool b = dynamic_cast<Spanner*> (me);
 166
 167   return gh_bool2scm (b);
 168 }
 169
 170 LY_DEFINE (ly_item_p, "ly:item?",
 171            1, 0, 0, (SCM g),
 172            "Is @var{g} an @code{Item} object?")
 173 {
 174   Grob *me = unsmob_grob (g);
 175   bool b = dynamic_cast<Item*> (me);
 176   return gh_bool2scm (b);
 177 }
 178
 179 LY_DEFINE (ly_item_break_dir, "ly:item-break-dir",
 180            1, 0, 0, (SCM it),
 181            "The break status dir of item @var{it}. @code{-1} is end of "
 182            "line, @code{0} unbroken, and @code{1} begin of line.")
 183 {
 184   Item *me = dynamic_cast<Item*> (unsmob_grob (it));
 185   SCM_ASSERT_TYPE (me, it, SCM_ARG1, __FUNCTION__, "Item");
 186   return gh_int2scm (me->break_status_dir ());
 187 }