X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fsmobs.hh;h=cf6ffcc9a3fb2f5f4754ffe875b17025885973df;hb=e90f0536f9be39ada0bef0aeb0d275dec3b2fb5b;hp=5a5b5ce1811dffa67d23401c4b64d80260840a84;hpb=0f26985bb738f1bd3373d3b8bc3dc0980c202169;p=lilypond.git diff --git a/lily/include/smobs.hh b/lily/include/smobs.hh index 5a5b5ce181..cf6ffcc9a3 100644 --- a/lily/include/smobs.hh +++ b/lily/include/smobs.hh @@ -1,17 +1,27 @@ -/* - smobs.hh -- declare smob related stuff. - - source file of the GNU LilyPond music typesetter - - (c) 1999--2004 Han-Wen Nienhuys - - */ +/* + This file is part of LilyPond, the GNU music typesetter. + + Copyright (C) 1999--2011 Han-Wen Nienhuys + + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #ifndef SMOBS_HH #define SMOBS_HH #include "lily-guile.hh" - +#include "warn.hh" /* Smobs are GUILEs mechanism of exporting C(++) objects to the Scheme @@ -22,119 +32,142 @@ There are two types of smob objects. 1. Simple smobs are intended for simple objects like numbers: - immutable objects that can be copied without change of meaning. + immutable objects that can be copied without change of meaning. - To obtain an SCM version of a simple smob, use the member function - SCM smobbed_copy (). + To obtain an SCM version of a simple smob, use the member function + SCM smobbed_copy (). - Simple smobs are created by adding the - DECLARE_SIMPLE_SMOBS(Classname,) to the declaration + Simple smobs are created by adding the + DECLARE_SIMPLE_SMOBS(Classname) to the declaration 2. Complex smobs are objects that have an identity. These objects - carry this identity in the form of a self_scm () method, which is a - SCM pointer to the object itself. + carry this identity in the form of a self_scm () method, which is a + SCM pointer to the object itself. + + The constructor for a complex smob should have 3 steps: + + * initialize all SCM members to a non-immediate value (like SCM_EOL) - The constructor for a complex smob should have 3 steps: + * call smobify_self () - * initialize all SCM members to a non-immediate value (like SCM_EOL) + * initialize SCM members - * call smobify_self () + For example, - * initialize SCM members + Complex_smob::Complex_smob () { + scm_member_ = SCM_EOL; + smobify_self (); + scm_member_ = <..what you want to store..> + } - For example, + after construction, the self_scm () field of a complex smob is + protected from Garbage Collection. This protection should be + removed once the object is put into another (reachable) Scheme data + structure, i.e. - Complex_smob::Complex_smob () { - scm_member_ = SCM_EOL; - smobify_self (); - scm_member_ = <..what you want to store..> - } - - after construction, the self_scm () field of a complex smob is - protected from Garbage Collection. This protection should be - removed once the object is put into another (reachable) Scheme data - structure, i.e. + Complex_smob *p = new Complex_smob; + list = scm_cons (p->self_scm (), list); + scm_gc_unprotect_object (p->self_scm ()); - Complex_smob *p = new Complex_smob; - list = scm_cons (p->self_scm (), list); - scm_gc_unprotect_object (p->self_scm ()); + Complex smobs are made with DECLARE_SMOBS (Classname) in the class + declaration. - Complex smobs are made with DECLARE_SMOBS (Classname,) in the class - declaration. + CALLING INTERFACE - CALLING INTERFACE - - Common public methods to C++ smob objects: + Common public methods to C++ smob objects: - unsmob (SCM x) - unpacks X and returns pointer to the C++ object, or 0 - if it has the wrong type. + unsmob (SCM x) - unpacks X and returns pointer to the C++ object, or 0 + if it has the wrong type. - SCM equal_p (SCM a, SCM b) - compare A and B. Returns a Scheme boolean + SCM equal_p (SCM a, SCM b) - compare A and B. Returns a Scheme boolean - - IMPLEMENTATION - - For implementating a class, the following should be provided - - an equal_p () function (a default is in the - IMPLEMENT_DEFAULT_EQUAL_P macro in ly-smobs.icc) + IMPLEMENTATION - - mark_smob () function, that calls scm_gc_mark () on all Scheme - objects in the class + For implementating a class, the following should be provided - - a print_smob () function, that displays a representation for - debugging purposes + - an equal_p () function (a default is in the + IMPLEMENT_DEFAULT_EQUAL_P macro in ly-smobs.icc) - - A call to one of the IMPLEMENT_SMOBS or IMPLEMENT_SIMPLE_SMOBS macros - from file "ly-smobs.icc" + - mark_smob () function, that calls scm_gc_mark () on all Scheme + objects in the class + + - a print_smob () function, that displays a representation for + debugging purposes + + - A call to one of the IMPLEMENT_SMOBS or IMPLEMENT_SIMPLE_SMOBS macros + from file "ly-smobs.icc" */ -#define DECLARE_SIMPLE_SMOBS(CL, dummy) \ -public: \ - SCM smobbed_copy () const; \ -DECLARE_BASE_SMOBS(CL) - - -#define DECLARE_BASE_SMOBS(CL) \ - friend class Non_existent_class; \ -private: \ - static scm_t_bits smob_tag_; \ - static SCM mark_smob (SCM); \ - static size_t free_smob (SCM s); \ - static int print_smob (SCM s, SCM p, scm_print_state*); \ -public: \ - static SCM equal_p (SCM a, SCM b);\ - static CL * unsmob (SCM s){\ - if (SCM_NIMP (s) && SCM_CELL_TYPE (s) == smob_tag_) \ - return (CL*) SCM_CELL_WORD_1 (s); \ - else \ - return 0; \ -} \ - static SCM smob_p (SCM);\ - static void init_smobs (); \ -private: - - -#define DECLARE_SMOBS(CL,dummy) \ - DECLARE_BASE_SMOBS (CL) \ -protected:\ - virtual ~CL ();\ - SCM unprotected_smobify_self ();\ -private: \ - SCM smobify_self (); \ - SCM self_scm_; \ -public: \ - SCM self_scm () const { return self_scm_; } \ -private: - -#define DECLARE_UNSMOB(CL,name) \ -inline CL * \ -unsmob_ ## name (SCM s) \ -{ \ -return CL::unsmob (s); \ -} +#define DECLARE_SIMPLE_SMOBS(CL) \ + public: \ + SCM smobbed_copy () const; \ + DECLARE_BASE_SMOBS (CL) + +#define DECLARE_BASE_SMOBS(CL) \ + friend class Non_existent_class; \ + private: \ + static const char* smob_name_; \ + static scm_t_bits smob_tag_; \ + static SCM mark_smob (SCM); \ + static size_t free_smob (SCM s); \ + static int print_smob (SCM s, SCM p, scm_print_state*); \ + public: \ + static SCM equal_p (SCM a, SCM b); \ + static CL *unsmob (SCM s) __attribute__((pure)) \ + { \ + if (SCM_NIMP (s) && SCM_CELL_TYPE (s) == smob_tag_) \ + return (CL *) SCM_CELL_WORD_1 (s); \ + else \ + return 0; \ + } \ + static SCM smob_p (SCM); \ + static void init_smobs (); \ + private: + +#define DECLARE_SMOBS(CL) \ + DECLARE_BASE_SMOBS (CL) \ + protected: \ + virtual ~CL (); \ + SCM unprotected_smobify_self (); \ + private: \ + void smobify_self (); \ + SCM self_scm_; \ + SCM protection_cons_; \ + public: \ + SCM unprotect (); \ + void protect (); \ + SCM self_scm () const { return self_scm_; } \ + private: + +#define DECLARE_UNSMOB(CL, name) \ + inline CL * \ + unsmob_ ## name (SCM s) \ + { \ + return CL::unsmob (s); \ + } #define DECLARE_TYPE_P(CL) extern SCM CL ## _type_p_proc +void protect_smob (SCM smob, SCM *prot_cons); +void unprotect_smob (SCM smob, SCM *prot_cons); + +extern bool parsed_objects_should_be_dead; + +#ifndef NDEBUG +#define ASSERT_LIVE_IS_ALLOWED() \ + do { \ + static bool passed_here_once;\ + if (parsed_objects_should_be_dead && !passed_here_once) { \ + ::programming_error (string ("Parsed object should be dead: ") + __PRETTY_FUNCTION__ ); \ + passed_here_once = true;\ + } \ + } \ + while (0) +#else +#define ASSERT_LIVE_IS_ALLOWED() do { } \ + while (0) +#endif + #endif /* SMOBS_HH */