* VERSION (MY_PATCH_LEVEL): make 1.7.0

[lilypond.git] / lily / include / molecule.hh

diff --git a/lily/include/molecule.hh b/lily/include/molecule.hh
index 37021a214ee9e0f335e01dc1ab40ef470e5b10af..a1b887066f840c23c0d782e9324bdebc887a0436 100644 (file)
--- a/lily/include/molecule.hh
+++ b/lily/include/molecule.hh
@@ -1,36 +1,98 @@
+/*
+  molecule.hh -- declare Molecule
+
+  source file of the GNU LilyPond music typesetter
+
+  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+*/
 #ifndef MOLECULE_HH
 #define MOLECULE_HH
 
+#include <stdlib.h>            // size_t
 #include "lily-proto.hh"
-#include "plist.hh"
-#include "boxes.hh"
-
+#include "box.hh"
+#include "axes.hh"
+#include "direction.hh"
+#include "lily-guile.hh"
+#include "smobs.hh"
 
 /** a group of individually translated symbols. You can add molecules
-    to the top, to the right, etc.  */
-struct Molecule {
-    Pointer_list<Atom*> ats;   // change to List<Atom>? 
+    to the top, to the right, etc.
+
+    It is implemented as a "tree" of scheme expressions, as in
+
+     Expr = combine Expr Expr
+              | translate Offset Expr
+             | SCHEME
+             ;
+
+    SCHEME is a Scheme expression that --when eval'd-- produces the
+    desired output.  
 
-    /* *************** */
+
+    Because of the way that Molecule is implemented, it is the most
+    efficient to add "fresh" molecules to what you're going to build.
     
-    Molecule() { }
-    Molecule(Atom const &a) { add(a) ;}
-
-    void add_right(const Molecule &m);
-    void add_left(const Molecule &m);
-    void add_top(const Molecule &m);
-    void add_bottom(const Molecule &m);
-    void add(Molecule const &m);
-    void translate(Offset);
-    void add(Atom const & a) ;
-    /// how big is #this#? 
-    Box extent() const;
-
-    String TeX_string() const;
-
-    Molecule(const Molecule&s);
-    void print() const;
-private:
-    void operator=(const Molecule&);
+    Dimension behavior:
+
+    Empty molecules have empty dimensions.  If add_at_edge is used to
+    init the molecule, we assume that
+    DIMENSIONS = (Interval (0,0),Interval (0,0)
+*/
+class Molecule
+{
+  friend SCM ly_set_molecule_extent_x (SCM, SCM, SCM);
+  
+  Box dim_;
+  SCM expr_;
+  
+  DECLARE_SIMPLE_SMOBS (Molecule,);  
+public:
+  Molecule (Box, SCM s);
+  Molecule ();
+
+
+  SCM smobbed_copy () const;
+  SCM get_expr () const;
+
+  /**
+     Set dimensions to empty, or to (Interval (0,0),Interval (0,0) */
+  void set_empty (bool);
+  void add_at_edge (Axis a, Direction d, const Molecule &m, Real padding);
+  void add_molecule (Molecule const &m);
+  void translate (Offset);
+  
+  /**
+     align D direction in axis A.
+
+     If D == CENTER, then move the dimension (A).center () to (0,0)
+
+     Else, move so dimension (A)[D] == 0.0
+     
+   */
+  void align_to (Axis a, Direction d);
+  void translate_axis (Real,Axis);
+  
+  Interval extent (Axis) const;
+  Box extent_box () const;
+  /**
+     codify THIS into a Scheme expression.
+   */
+  SCM create_scheme () const;
+  bool empty_b () const;
+
+
+  static SCM ly_get_molecule_extent (SCM mol, SCM axis);
+  static SCM ly_set_molecule_extent_x (SCM,SCM,SCM);
+  static SCM ly_molecule_combined_at_edge (SCM,SCM,SCM,SCM,SCM);
 };
+
+
+DECLARE_UNSMOB(Molecule,molecule);
+SCM fontify_atom (Font_metric const*, SCM atom);
+
+Molecule create_molecule (SCM brew_molecule);
+
+
+
 #endif