X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fmolecule.cc;h=127850d1238e12e2c05b3a571e35f7e8468dfc1b;hb=1403a2c3b4a03ee78be253ac4c4f206b7a3b05db;hp=663a554e93a3a7e9c771b290b3dd4ea731e75f26;hpb=1a66290a98e7de8d6d41485b5b71a9f7e1fe35c7;p=lilypond.git diff --git a/lily/molecule.cc b/lily/molecule.cc index 663a554e93..127850d123 100644 --- a/lily/molecule.cc +++ b/lily/molecule.cc @@ -3,138 +3,345 @@ source file of the GNU LilyPond music typesetter - (c) 1997 Han-Wen Nienhuys + (c) 1997--2002 Han-Wen Nienhuys */ +#include +#include // isinf + +#include "font-metric.hh" +#include "dimensions.hh" #include "interval.hh" -#include "dimen.hh" #include "string.hh" #include "molecule.hh" -#include "symbol.hh" -#include "debug.hh" -#include "tex.hh" +#include "warn.hh" + + +#include "ly-smobs.icc" -String -Molecule::TeX_string() const + +SCM +Molecule::smobbed_copy () const { - String s; - for (iter_top (ats,c); c.ok(); c++) - s+=c->TeX_string(); - return s; + Molecule * m = new Molecule (*this); + + return m->smobbed_self (); } -Box -Molecule::extent() const +Interval +Molecule::extent (Axis a) const { - Box b; - for (iter_top (ats,c); c.ok(); c++) - b.unite (c->extent()); - return b; + return dim_[a]; } -void -Molecule::translate (Offset o) +Molecule::Molecule (Box b, SCM func) { - for (iter_top (ats,c); c.ok(); c++) - c->translate (o); + expr_ = func; + dim_ = b; } -void -Molecule::translate (Real x,Axis a) +Molecule::Molecule () { - for (iter_top (ats,c); c.ok(); c++) - c->translate (x,a); + expr_ = SCM_EOL; + set_empty (true); } void -Molecule::add (Molecule const &m) +Molecule::translate (Offset o) { - for (iter_top (m.ats,c); c.ok(); c++) { - add (**c); + Axis a = X_AXIS; + while (a < NO_AXES) + { + if (abs (o[a]) > 100 CM + || isinf (o[a]) || isnan (o[a])) + { + programming_error ("Improbable offset for translation: setting to zero"); + o[a] = 0.0; + } + incr (a); } + + expr_ = scm_list_n (ly_symbol2scm ("translate-molecule"), + ly_offset2scm (o), + expr_, SCM_UNDEFINED); + if (!empty_b ()) + dim_.translate (o); } + void -Molecule::add_right (Molecule const &m) +Molecule::translate_axis (Real x,Axis a) { - if (!ats.size()) { - add (m); - return; - } - Real xof=extent().x ().right - m.extent ().x ().left; - - - Molecule toadd (m); - toadd.translate (Offset (xof, 0.0)); - add (toadd); + Offset o (0,0); + o[a] = x; + translate (o); +} + + + +void +Molecule::add_molecule (Molecule const &m) +{ + expr_ = scm_list_n (ly_symbol2scm ("combine-molecule"), + m.expr_, + expr_, SCM_UNDEFINED); + dim_.unite (m.dim_); } void -Molecule::add_left (Molecule const &m) +Molecule::set_empty (bool e) { - if (!ats.size()) { - add (m); - return; + if (e) + { + dim_[X_AXIS].set_empty (); + dim_[Y_AXIS].set_empty (); + } + else + { + dim_[X_AXIS] = Interval (0,0); + dim_[Y_AXIS] = Interval (0,0); } - Real xof=extent().x ().left - m.extent ().x ().right; - - Molecule toadd (m); - toadd.translate (Offset (xof, 0.0)); - add (toadd); } void -Molecule::add_top (Molecule const &m) +Molecule::align_to (Axis a, Direction d) { - if (!ats.size()) { - add (m); - return; - } - Real yof=extent().y ().right - m.extent ().y ().left; + if (empty_b()) + return ; - Molecule toadd (m); - toadd.translate (yof, Y_AXIS); - add (toadd); + Interval i (extent (a)); + Real r = (d == CENTER) ? i.center () : i[d]; + translate_axis (-r, a); } void -Molecule::add_bottom (Molecule const &m) +Molecule::add_at_edge (Axis a, Direction d, Molecule const &m, Real padding) { - if (!ats.size()) { - add (m); - return; + Real my_extent= empty_b () ? 0.0 : dim_[a][d]; + Interval i (m.extent (a)); + Real his_extent; + if (i.empty_b ()) + { + programming_error ("Molecule::add_at_edge: adding empty molecule."); + his_extent = 0.0; } - Real yof=extent().y ().left- m.extent ().y ().right; - Molecule toadd (m); - toadd.translate (yof, Y_AXIS); - add (toadd); + else + his_extent = i[-d]; + + Real offset = my_extent - his_extent; + Molecule toadd (m); + toadd.translate_axis (offset + d * padding, a); + add_molecule (toadd); } -void -Molecule::operator = (Molecule const &) +LY_DEFINE(ly_set_molecule_extent_x,"ly:set-molecule-extent!", 3 , 0, 0, + (SCM mol, SCM axis, SCM np), + "Set the extent (@var{extent} must be a pair of numbers) of @var{mol} in +@var{axis} direction (0 or 1 for x- and y-axis respectively). + +Note that an extent @code{(A . B)} is an interval and hence @code{A} is +smaller than @code{B}, and is often negative. +5") { - assert (false); + Molecule* m = unsmob_molecule (mol); + SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule"); + SCM_ASSERT_TYPE (ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + SCM_ASSERT_TYPE (ly_number_pair_p (np), np, SCM_ARG3, __FUNCTION__, "number pair"); + + Interval iv = ly_scm2interval (np); + m->dim_[Axis (gh_scm2int (axis))] = iv; + + return SCM_UNDEFINED; } -Molecule::Molecule (Molecule const &s) +LY_DEFINE(ly_get_molecule_extent, + "ly:get-molecule-extent", 2 , 0, 0, (SCM mol, SCM axis), + "Return a pair of numbers signifying the extent of @var{mol} in +@var{axis} direction (0 or 1 for x and y axis respectively). +") { - add (s); + Molecule *m = unsmob_molecule (mol); + SCM_ASSERT_TYPE (m, mol, SCM_ARG1, __FUNCTION__, "molecule"); + SCM_ASSERT_TYPE (ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + + return ly_interval2scm (m->extent (Axis (gh_scm2int (axis)))); } -void -Molecule::print() const + +LY_DEFINE(ly_molecule_combined_at_edge, + "ly:combine-molecule-at-edge", + 5 , 0, 0, (SCM first, SCM axis, SCM direction, + SCM second, SCM padding), + "Construct a molecule by putting @var{second} next to +@var{first}. @var{axis} can be 0 (x-axis) or 1 (y-axis), @var{direction} can be +-1 (left or down) or 1 (right or up). @var{padding} specifies extra +space to add in between measured in global staff space.") + +{ + Molecule * m1 = unsmob_molecule (first); + Molecule * m2 = unsmob_molecule (second); + Molecule result; + + + SCM_ASSERT_TYPE(ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + SCM_ASSERT_TYPE(ly_dir_p (direction), direction, SCM_ARG3, __FUNCTION__, "dir"); + SCM_ASSERT_TYPE(gh_number_p (padding), padding, SCM_ARG4, __FUNCTION__, "number"); + + if (m1) + result = *m1; + if (m2) + result.add_at_edge (Axis (gh_scm2int (axis)), Direction (gh_scm2int (direction)), + *m2, gh_scm2double (padding)); + + return result.smobbed_copy (); +} + +/* + FIXME: support variable number of arguments " + */ +LY_DEFINE(ly_add_molecule , + "ly:add-molecule", 2, 0,0,(SCM first, SCM second), + "Combine two molecules." + ) +{ + Molecule * m1 = unsmob_molecule (first); + Molecule * m2 = unsmob_molecule (second); + Molecule result; + + + if (m1) + result = *m1; + if (m2) + result.add_molecule (*m2); + + return result.smobbed_copy (); +} + +LY_DEFINE(ly_make_molecule, + "ly:make-molecule", 3, 0, 0, (SCM expr, SCM xext, SCM yext), + " +The objective of any typesetting system is to put ink on paper in the +right places. For LilyPond, this final stage is left to the @TeX{} and +the printer subsystem. For lily, the last stage in processing a score is +outputting a description of what to put where. This description roughly +looks like +@example + PUT glyph AT (x,y) + PUT glyph AT (x,y) + PUT glyph AT (x,y) +@end example +you merely have to look at the tex output of lily to see this. +Internally these instructions are encoded in Molecules.@footnote{At some +point LilyPond also contained Atom-objects, but they have been replaced +by Scheme expressions, making the name outdated.} A molecule is +what-to-print-where information that also contains dimension information +(how large is this glyph?). + +Conceptually, Molecules can be constructed from Scheme code, by +translating a Molecule and by combining two molecules. In BNF +notation: + +@example +Molecule :: COMBINE Molecule Molecule + | TRANSLATE Offset Molecule + | GLYPH-DESCRIPTION + ; +@end example + +If you are interested in seeing how this information is stored, you +can run with the @code{-f scm} option. The scheme expressions are then +dumped in the output file.") +{ + SCM_ASSERT_TYPE (ly_number_pair_p (xext), xext, SCM_ARG2, __FUNCTION__, "number pair"); + SCM_ASSERT_TYPE (ly_number_pair_p (yext), yext, SCM_ARG3, __FUNCTION__, "number pair"); + + Box b (ly_scm2interval (xext), ly_scm2interval(yext)); + Molecule m (b, expr); + return m.smobbed_copy (); +} + +SCM +fontify_atom (Font_metric const * met, SCM f) +{ + if (f == SCM_EOL) + return f; + else + return scm_list_n (ly_symbol2scm ("fontify"), + ly_quote_scm (met->description_), f, SCM_UNDEFINED); +} + +LY_DEFINE(ly_fontify_atom,"ly:fontify-atom", 2, 0, 0, + (SCM met, SCM f), + "Add a font selection command for the font metric @var{met} to @var{f}.") +{ + SCM_ASSERT_TYPE(unsmob_metrics (met), met, SCM_ARG1, __FUNCTION__, "font metric"); + + return fontify_atom (unsmob_metrics (met), f); +} +LY_DEFINE(ly_align_to_x,"ly:align-to!", 3, 0, 0, (SCM mol, SCM axis, SCM dir), + "Align @var{mol} using its own extents.") +{ + SCM_ASSERT_TYPE(unsmob_molecule (mol), mol, SCM_ARG1, __FUNCTION__, "molecule"); + SCM_ASSERT_TYPE(ly_axis_p (axis), axis, SCM_ARG2, __FUNCTION__, "axis"); + SCM_ASSERT_TYPE(ly_dir_p (dir), dir, SCM_ARG3, __FUNCTION__, "dir"); + + unsmob_molecule (mol)->align_to ((Axis)gh_scm2int (axis), Direction (gh_scm2int (dir))); + + return SCM_UNDEFINED; +} + + + +/* + Hmm... maybe this is not such a good idea ; stuff can be empty, + while expr_ == '() + */ +bool +Molecule::empty_b () const +{ + return expr_ == SCM_EOL; +} + +SCM +Molecule::get_expr () const +{ + return expr_; +} + + + +Box +Molecule::extent_box () const +{ + return dim_; +} +IMPLEMENT_SIMPLE_SMOBS (Molecule); + + +int +Molecule::print_smob (SCM , SCM port, scm_print_state *) { -#ifndef NPRINT - if (! check_debug) - return; - for (iter_top (ats,c); c.ok(); c++) - c->print(); + scm_puts ("#string ()); + scm_puts ((char *)str.to_str0 (), port); #endif + scm_puts (" >", port); + + return 1; } -void -Molecule::add (Atom const &a) + +SCM +Molecule::mark_smob (SCM s) { - ats.bottom().add (new Atom (a)); + Molecule *r = (Molecule *) ly_cdr (s); + + return r->expr_; } + +IMPLEMENT_TYPE_P (Molecule, "ly:molecule?"); +IMPLEMENT_DEFAULT_EQUAL_P (Molecule); +