]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/stencil.hh
(SCM_VECTOR_P): Compile fix.
[lilypond.git] / lily / include / stencil.hh
index 5168dca5efa548a438c40bf564a4134fb01a7250..dfda4f2547e9d8485d9051892ebae484f5740e9b 100644 (file)
@@ -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
 
     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
 {
@@ -86,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 */