2 molecule-scheme.cc -- implement Molecule
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "font-metric.hh"
12 LY_DEFINE(ly_molecule_set_extent_x,"ly:molecule-set-extent!", 3 , 0, 0,
13 (SCM mol, SCM axis, SCM np),
14 "Set the extent (@var{extent} must be a pair of numbers) of @var{mol} in \n"
15 "@var{axis} direction (0 or 1 for x- and y-axis respectively).\n"
17 "Note that an extent @code{(A . B)} is an interval and hence @code{A} is\n"
18 "smaller than @code{B}, and is often negative.\n"
21 Molecule* m = unsmob_molecule (mol);
22 SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule");
23 SCM_ASSERT_TYPE (ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
24 SCM_ASSERT_TYPE (ly_number_pair_p (np), np, SCM_ARG3, __FUNCTION__, "number pair");
26 Interval iv = ly_scm2interval (np);
27 m->dim_[Axis (gh_scm2int (axis))] = iv;
33 LY_DEFINE(ly_translate_molecule_axis,"ly:molecule-translate-axis", 3, 0, 0,
34 (SCM mol, SCM amount, SCM axis),
35 "Return a @var{mol}, but translated by @var{amount} in @var{axis} direction")
37 Molecule* m = unsmob_molecule (mol);
38 SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule");
39 SCM_ASSERT_TYPE (gh_number_p (amount), amount, SCM_ARG2, __FUNCTION__, "number pair");
40 SCM_ASSERT_TYPE (ly_axis_p (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
44 q.translate_axis (gh_scm2double (amount), Axis (gh_scm2int (axis)));
46 return q.smobbed_copy();
49 LY_DEFINE(ly_translate_molecule,"ly:molecule-translate", 2, 0, 0,
50 (SCM mol, SCM offset),
51 "Return a @var{mol}, but translated by @var{offset} (a pair of numbers).")
53 Molecule* m = unsmob_molecule (mol);
54 SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule");
55 SCM_ASSERT_TYPE (ly_number_pair_p (offset), offset, SCM_ARG2, __FUNCTION__, "number pair");
56 Offset o = ly_scm2offset (offset);
60 return q.smobbed_copy();
63 LY_DEFINE(ly_molecule_get_extent,
64 "ly:molecule-get-extent", 2 , 0, 0, (SCM mol, SCM axis),
65 "Return a pair of numbers signifying the extent of @var{mol} in "
66 "@var{axis} direction (0 or 1 for x and y axis respectively)."
69 Molecule *m = unsmob_molecule (mol);
70 SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule");
71 SCM_ASSERT_TYPE (ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
73 return ly_interval2scm (m->extent (Axis (gh_scm2int (axis))));
77 LY_DEFINE(ly_molecule_combined_at_edge,
78 "ly:molecule-combine-at-edge",
79 4, 2, 0, (SCM first, SCM axis, SCM direction,
83 "Construct a molecule by putting @var{second} next to "
84 "@var{first}. @var{axis} can be 0 (x-axis) or 1 (y-axis), @var{direction} can be "
85 "-1 (left or down) or 1 (right or up). "
86 "The molecules are juxtaposed with @var{padding} as extra space. If "
87 "this puts the reference points closer than @var{minimum}, they are moved "
88 "by the latter amount.")
91 Molecule * m1 = unsmob_molecule (first);
92 Molecule * m2 = unsmob_molecule (second);
96 SCM_ASSERT_TYPE(ly_axis_p (axis), axis, SCM_ARG3, __FUNCTION__, "axis");
97 SCM_ASSERT_TYPE(ly_dir_p (direction), direction, SCM_ARG4, __FUNCTION__, "dir");
100 if (padding != SCM_UNDEFINED)
102 SCM_ASSERT_TYPE(gh_number_p (padding), padding, SCM_ARG5, __FUNCTION__, "number");
103 p = gh_scm2double (padding);
106 if (minimum != SCM_UNDEFINED)
108 SCM_ASSERT_TYPE(gh_number_p (minimum), minimum, SCM_ARG6, __FUNCTION__, "number");
109 m = gh_scm2double (minimum);
115 result.add_at_edge (Axis (gh_scm2int (axis)), Direction (gh_scm2int (direction)),
118 return result.smobbed_copy ();
122 FIXME: support variable number of arguments.
125 LY_DEFINE(ly_molecule_add ,
126 "ly:molecule-add", 2, 0, 0, (SCM first, SCM second),
127 "Combine two molecules."
130 Molecule * m1 = unsmob_molecule (first);
131 Molecule * m2 = unsmob_molecule (second);
138 result.add_molecule (*m2);
140 return result.smobbed_copy ();
143 LY_DEFINE(ly_make_molecule,
144 "ly:make-molecule", 3, 0, 0, (SCM expr, SCM xext, SCM yext),
146 "The objective of any typesetting system is to put ink on paper in the \n"
147 "right places. For LilyPond, this final stage is left to the @TeX{} and \n"
148 "the printer subsystem. For lily, the last stage in processing a score is \n"
149 "outputting a description of what to put where. This description roughly \n"
152 " PUT glyph AT (x,y) \n"
153 " PUT glyph AT (x,y) \n"
154 " PUT glyph AT (x,y) \n"
156 "you merely have to look at the tex output of lily to see this. \n"
157 "Internally these instructions are encoded in Molecules.@footnote{At some \n"
158 "point LilyPond also contained Atom-objects, but they have been replaced \n"
159 "by Scheme expressions, making the name outdated.} A molecule is \n"
160 "what-to-print-where information that also contains dimension information \n"
161 "(how large is this glyph?). \n"
163 "Conceptually, Molecules can be constructed from Scheme code, by \n"
164 "translating a Molecule and by combining two molecules. In BNF \n"
168 "Molecule :: COMBINE Molecule Molecule \n"
169 " | TRANSLATE Offset Molecule \n"
170 " | GLYPH-DESCRIPTION \n"
174 "If you are interested in seeing how this information is stored, you \n"
175 "can run with the @code{-f scm} option. The scheme expressions are then \n"
176 "dumped in the output file.")
178 SCM_ASSERT_TYPE (ly_number_pair_p (xext), xext, SCM_ARG2, __FUNCTION__, "number pair");
179 SCM_ASSERT_TYPE (ly_number_pair_p (yext), yext, SCM_ARG3, __FUNCTION__, "number pair");
181 Box b (ly_scm2interval (xext), ly_scm2interval(yext));
182 Molecule m (b, expr);
183 return m.smobbed_copy ();
188 fontify_atom (Font_metric const * met, SCM f)
193 return scm_list_n (ly_symbol2scm ("fontify"),
194 ly_quote_scm (met->description_), f, SCM_UNDEFINED);
197 LY_DEFINE(ly_fontify_atom,"ly:fontify-atom", 2, 0, 0,
199 "Add a font selection command for the font metric @var{met} to @var{f}.")
201 SCM_ASSERT_TYPE(unsmob_metrics (met), met, SCM_ARG1, __FUNCTION__, "font metric");
203 return fontify_atom (unsmob_metrics (met), f);
205 LY_DEFINE(ly_align_to_x,"ly:molecule-align-to!", 3, 0, 0, (SCM mol, SCM axis, SCM dir),
206 "Align @var{mol} using its own extents.")
208 SCM_ASSERT_TYPE(unsmob_molecule (mol), mol, SCM_ARG1, __FUNCTION__, "molecule");
209 SCM_ASSERT_TYPE(ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis");
210 SCM_ASSERT_TYPE(ly_dir_p (dir), dir, SCM_ARG3, __FUNCTION__, "dir");
212 unsmob_molecule (mol)->align_to ((Axis)gh_scm2int (axis), Direction (gh_scm2int (dir)));
214 return SCM_UNDEFINED;