2 smobs.hh -- declare smob related stuff.
4 source file of the GNU LilyPond music typesetter
6 (c) 1999--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
12 #include "lily-guile.hh"
13 #include "virtual-methods.hh"
17 Smobs are GUILEs mechanism of exporting C(++) objects to the Scheme
18 world. They are documented in the GUILE manual.
21 In LilyPond, smobs are created from C++ objects through macros.
22 There are two types of smob objects.
24 1. Simple smobs are intended for simple objects like numbers:
25 immutable objects that can be copied without change of meaning.
27 To obtain an SCM version of a simple smob, use the member function
30 Simple smobs are created by adding the
31 DECLARE_SIMPLE_SMOBS(Classname) to the declaration
33 2. Complex smobs are objects that have an identity. These objects
34 carry this identity in the form of a self_scm () method, which is a
35 SCM pointer to the object itself.
37 The constructor for a complex smob should have 3 steps:
39 * initialize all SCM members to a non-immediate value (like SCM_EOL)
41 * call smobify_self ()
43 * initialize SCM members
47 Complex_smob::Complex_smob () {
48 scm_member_ = SCM_EOL;
50 scm_member_ = <..what you want to store..>
53 after construction, the self_scm () field of a complex smob is
54 protected from Garbage Collection. This protection should be
55 removed once the object is put into another (reachable) Scheme data
58 Complex_smob *p = new Complex_smob;
59 list = scm_cons (p->self_scm (), list);
60 scm_gc_unprotect_object (p->self_scm ());
62 Complex smobs are made with DECLARE_SMOBS (Classname) in the class
67 Common public methods to C++ smob objects:
69 unsmob (SCM x) - unpacks X and returns pointer to the C++ object, or 0
70 if it has the wrong type.
72 SCM equal_p (SCM a, SCM b) - compare A and B. Returns a Scheme boolean
77 For implementating a class, the following should be provided
79 - an equal_p () function (a default is in the
80 IMPLEMENT_DEFAULT_EQUAL_P macro in ly-smobs.icc)
82 - mark_smob () function, that calls scm_gc_mark () on all Scheme
85 - a print_smob () function, that displays a representation for
88 - A call to one of the IMPLEMENT_SMOBS or IMPLEMENT_SIMPLE_SMOBS macros
89 from file "ly-smobs.icc"
92 #define DECLARE_SIMPLE_SMOBS(CL) \
94 SCM smobbed_copy () const; \
95 DECLARE_BASE_SMOBS (CL)
97 #define DECLARE_BASE_SMOBS(CL) \
98 friend class Non_existent_class; \
100 static scm_t_bits smob_tag_; \
101 static SCM mark_smob (SCM); \
102 static size_t free_smob (SCM s); \
103 static int print_smob (SCM s, SCM p, scm_print_state*); \
105 static SCM equal_p (SCM a, SCM b); \
106 static CL *unsmob (SCM s) \
108 if (SCM_NIMP (s) && SCM_CELL_TYPE (s) == smob_tag_) \
109 return (CL *) SCM_CELL_WORD_1 (s); \
113 static SCM smob_p (SCM); \
114 static void init_smobs (); \
117 #define DECLARE_SMOBS(CL) \
118 DECLARE_BASE_SMOBS (CL) \
121 SCM unprotected_smobify_self (); \
123 void smobify_self (); \
125 SCM protection_cons_; \
129 SCM self_scm () const { return self_scm_; } \
132 #define DECLARE_UNSMOB(CL, name) \
134 unsmob_ ## name (SCM s) \
136 return CL::unsmob (s); \
139 #define DECLARE_TYPE_P(CL) extern SCM CL ## _type_p_proc
141 void protect_smob (SCM smob, SCM *prot_cons);
142 void unprotect_smob (SCM smob, SCM *prot_cons);
144 extern bool parsed_objects_should_be_dead;
146 #define ASSERT_LIVE_IS_ALLOWED() \
147 static bool passed_here_once;\
148 if (parsed_objects_should_be_dead && !passed_here_once) { \
149 programming_error (string ("Parsed object should be dead: ") + __PRETTY_FUNCTION__ ); \
150 passed_here_once = true;\
153 #endif /* SMOBS_HH */