]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/molecule.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / molecule.cc
index e135b6b3fc07efd113c30d3b27602001c5e161fd..15cc8f2f07c37e5d281144eed8fa14b2226b77c0 100644 (file)
@@ -3,19 +3,19 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include <math.h>
-#include <libc-extension.hh>
+#include <libc-extension.hh>   // isinf
 
 #include "font-metric.hh" 
 #include "dimensions.hh"
 #include "interval.hh"
 #include "string.hh"
 #include "molecule.hh"
-#include "debug.hh"
-#include "killing-cons.tcc"
+#include "warn.hh"
+
 
 #include "ly-smobs.icc"
 
 SCM
 Molecule::smobbed_copy () const
 {
-  Molecule * m = new Molecule(*this);
+  Molecule * m = new Molecule (*this);
 
   return m->smobbed_self ();
 }
 
 Interval
-Molecule::extent(Axis a) const
+Molecule::extent (Axis a) const
 {
   return dim_[a];
 }
@@ -40,7 +40,7 @@ Molecule::Molecule (Box b, SCM func)
   dim_ = b;
 }
 
-Molecule::Molecule()
+Molecule::Molecule ()
 {
   expr_ = SCM_EOL;
   set_empty (true);
@@ -52,7 +52,7 @@ Molecule::translate (Offset o)
   Axis a = X_AXIS;
   while (a < NO_AXES)
     {
-      if (abs(o[a]) > 30 CM
+      if (abs (o[a]) > 100 CM
          || isinf (o[a]) || isnan (o[a]))
        {
          programming_error ("Improbable offset for translation: setting to zero");
@@ -61,7 +61,7 @@ Molecule::translate (Offset o)
       incr (a);
     }
 
-  expr_ = gh_list (ly_symbol2scm ("translate-molecule"),
+  expr_ = scm_list_n (ly_symbol2scm ("translate-molecule"),
                   ly_offset2scm (o),
                   expr_, SCM_UNDEFINED);
   if (!empty_b ())
@@ -72,7 +72,7 @@ Molecule::translate (Offset o)
 void
 Molecule::translate_axis (Real x,Axis a)
 {
-  Offset o(0,0);
+  Offset o (0,0);
   o[a] = x;
   translate (o);
 }  
@@ -82,7 +82,7 @@ Molecule::translate_axis (Real x,Axis a)
 void
 Molecule::add_molecule (Molecule const &m)
 {
-  expr_ = gh_list (ly_symbol2scm ("combine-molecule"),
+  expr_ = scm_list_n (ly_symbol2scm ("combine-molecule"),
                   m.expr_,
                   expr_, SCM_UNDEFINED);
   dim_.unite (m.dim_);
@@ -98,7 +98,7 @@ Molecule::set_empty (bool e)
     }
   else
     {
-      dim_[X_AXIS] = Interval(0,0);
+      dim_[X_AXIS] = Interval (0,0);
       dim_[Y_AXIS] = Interval (0,0);
     }
 }
@@ -107,8 +107,11 @@ Molecule::set_empty (bool e)
 void
 Molecule::align_to (Axis a, Direction d)
 {
+  if (empty_b())
+    return ;
+
   Interval i (extent (a));
-  Real r =  (d == CENTER) ? i.center () : i[d];
+  Real r = (d == CENTER) ? i.center () : i[d];
   translate_axis (-r, a);
 }
 
@@ -132,20 +135,172 @@ Molecule::add_at_edge (Axis a, Direction d, Molecule const &m, Real padding)
   add_molecule (toadd);
 }
 
-bool
-Molecule::empty_b () 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")
 {
-  return expr_ == SCM_EOL;
+  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;
+}
+
+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).
+")
+{
+  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))));
+}
+
+
+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 * met, SCM f)
+fontify_atom (Font_metric const * met, SCM f)
 {
   if (f == SCM_EOL)
     return f;
   else
-    return  gh_list (ly_symbol2scm ("fontify"),
-                    ly_quote_scm (met->description_), f, SCM_UNDEFINED);
+    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
@@ -161,17 +316,18 @@ Molecule::extent_box () const
 {
   return dim_;
 }
-IMPLEMENT_SIMPLE_SMOBS(Molecule);
+IMPLEMENT_SIMPLE_SMOBS (Molecule);
 
 
 int
-Molecule::print_smob (SCM s, SCM port, scm_print_state *)
+Molecule::print_smob (SCM , SCM port, scm_print_state *)
 {
-  Molecule  *r = (Molecule *) gh_cdr (s);
-     
   scm_puts ("#<Molecule ", port);
-  /*  String str(r->str());
-  scm_puts ((char *)str.ch_C(), port);*/
+#if 0
+  Molecule  *r = (Molecule *) ly_cdr (s);
+  String string (r->string ());
+  scm_puts ((char *)str.to_str0 (), port);
+#endif
   scm_puts (" >", port);
   
   return 1;
@@ -181,11 +337,11 @@ Molecule::print_smob (SCM s, SCM port, scm_print_state *)
 SCM
 Molecule::mark_smob (SCM s)
 {
-  Molecule  *r = (Molecule *) gh_cdr (s);
+  Molecule  *r = (Molecule *) ly_cdr (s);
   
   return r->expr_;
 }
 
-IMPLEMENT_TYPE_P(Molecule, "molecule?");
-IMPLEMENT_DEFAULT_EQUAL_P(Molecule);
-IMPLEMENT_UNSMOB(Molecule, molecule);
+IMPLEMENT_TYPE_P (Molecule, "molecule?");
+IMPLEMENT_DEFAULT_EQUAL_P (Molecule);
+