(triangle): add s to 0triangle.

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

diff --git a/lily/include/stencil.hh b/lily/include/stencil.hh
index 9d81bdc13ae9e612d9d25704344de3ad871ff145..dfda4f2547e9d8485d9051892ebae484f5740e9b 100644 (file)
--- a/lily/include/stencil.hh
+++ b/lily/include/stencil.hh
@@ -8,12 +8,10 @@
 #ifndef STENCIL_HH
 #define STENCIL_HH
 
-#include <stdlib.h>            // size_t
+#include <cstdlib>             // size_t
+
 #include "lily-proto.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 stencils
@@ -21,28 +19,40 @@
 
     It is implemented as a "tree" of scheme expressions, as in
 
-     Expr = combine Expr Expr
-              | translate Offset Expr
-             | SCHEME
-             ;
+     Expr = combine Expr-list
+            | translate Offset Expr
+           | origin (ORIGIN) Expr
+           | no-origin Expr
+           | (SCHEME)
+           ;
 
     SCHEME is a Scheme expression that --when eval'd-- produces the
     desired output.  
 
-
-    Because of the way that Stencil is implemented, it is the most
-    efficient to add "fresh" stencils to what you're going to build.
+    Notes:
     
-    Dimension behavior:
+    * Because of the way that Stencil is implemented, it is the most
+    efficient to add "fresh" stencils to what you're going to build.
 
-    Empty stencils have empty dimensions.  If add_at_edge is used to
+    * Do not create Stencil objects on the heap. That includes passing
+    around Stencil* which are produced by unsmob_stencil(). Either
+    copy Stencil objects, or use SCM references.
+    
+    * Empty stencils have empty dimensions.  If add_at_edge is used to
     init the stencil, we assume that
-    DIMENSIONS = (Interval (0,0),Interval (0,0)
+
+      DIMENSIONS = (Interval (0,0),Interval (0,0)
 */
 class Stencil
 {
   friend SCM ly_stencil_set_extent_x (SCM, SCM, SCM);
-  
+
+  /*
+    This provides the reference point of the symbol, for example with
+    characters, it is on the base line of the character. Usually,
+    ORIGIN is inside DIM_
+   */
+  Offset origin_;
   Box dim_;
   SCM expr_;
   
@@ -50,14 +60,16 @@ class Stencil
 public:
   Stencil (Box, SCM s);
   Stencil ();
-
-
-  SCM smobbed_copy () const;
-  SCM get_expr () const;
+  
+  Offset origin () const;
+  SCM expr () const;
 
   /**
      Set dimensions to empty, or to (Interval (0,0),Interval (0,0) */
   void set_empty (bool);
+  Stencil moved_to_edge (Axis a, Direction d, const Stencil &m, Real padding,
+                        Real minimum) const;
+
   void add_at_edge (Axis a, Direction d, const Stencil &m, Real padding,
                    Real minimum);
   void add_stencil (Stencil const &m);
@@ -67,13 +79,8 @@ public:
   
   Interval extent (Axis) const;
   Box extent_box () const;
-  /**
-     codify THIS into a Scheme expression.
-   */
-  SCM create_scheme () const;
   bool is_empty () const;
 
-
   static SCM ly_get_stencil_extent (SCM mol, SCM axis);
   static SCM ly_set_stencil_extent_x (SCM,SCM,SCM);
   static SCM ly_stencil_combined_at_edge (SCM,SCM,SCM,SCM,SCM);
@@ -83,8 +90,12 @@ public:
 DECLARE_UNSMOB(Stencil,stencil);
 SCM fontify_atom (Font_metric const*, SCM atom);
 
-Stencil create_stencil (SCM print);
-
+void interpret_stencil_expression (SCM expr,
+                        void (*func) (void*, SCM),
+                        void *func_arg,
+                        Offset o);
 
+Stencil create_stencil (SCM print);
+SCM find_expression_fonts (SCM expr);
 
-#endif
+#endif /* STENCIL_HH */