2 stencil.hh -- declare Stencil
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include <stdlib.h> // size_t
12 #include "lily-proto.hh"
14 #include "direction.hh"
15 #include "lily-guile.hh"
18 /** a group of individually translated symbols. You can add stencils
19 to the top, to the right, etc.
21 It is implemented as a "tree" of scheme expressions, as in
23 Expr = combine Expr-list
24 | translate Offset Expr
25 | origin (ORIGIN) Expr
30 SCHEME is a Scheme expression that --when eval'd-- produces the
35 * Because of the way that Stencil is implemented, it is the most
36 efficient to add "fresh" stencils to what you're going to build.
38 * Do not create Stencil objects on the heap. That includes passing
39 around Stencil* which are produced by unsmob_stencil(). Either
40 copy Stencil objects, or use SCM references.
42 * Empty stencils have empty dimensions. If add_at_edge is used to
43 init the stencil, we assume that
45 DIMENSIONS = (Interval (0,0),Interval (0,0)
49 friend SCM ly_stencil_set_extent_x (SCM, SCM, SCM);
52 This provides the reference point of the symbol, for example with
53 characters, it is on the base line of the character. Usually,
60 DECLARE_SIMPLE_SMOBS (Stencil,);
65 Offset origin () const;
69 Set dimensions to empty, or to (Interval (0,0),Interval (0,0) */
70 void set_empty (bool);
71 Stencil moved_to_edge (Axis a, Direction d, const Stencil &m, Real padding,
74 void add_at_edge (Axis a, Direction d, const Stencil &m, Real padding,
76 void add_stencil (Stencil const &m);
77 void translate (Offset);
78 void align_to (Axis a, Real x);
79 void translate_axis (Real,Axis);
81 Interval extent (Axis) const;
82 Box extent_box () const;
83 bool is_empty () const;
85 static SCM ly_get_stencil_extent (SCM mol, SCM axis);
86 static SCM ly_set_stencil_extent_x (SCM,SCM,SCM);
87 static SCM ly_stencil_combined_at_edge (SCM,SCM,SCM,SCM,SCM);
91 DECLARE_UNSMOB(Stencil,stencil);
92 SCM fontify_atom (Font_metric const*, SCM atom);
94 void interpret_stencil_expression (SCM expr,
95 void (*func) (void*, SCM),
99 Stencil create_stencil (SCM print);
100 SCM find_expression_fonts (SCM expr);
102 #endif /* STENCIL_HH */