lily/include/ly-smobs.icc

   1 /*
   2   ly-smobs.icc -- implement smob glue.
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7  */
   8
   9 #ifndef LY_SMOBS_ICC
  10 #define LY_SMOBS_ICC
  11
  12 #include "smobs.hh"
  13
  14 #define IMPLEMENT_TYPE_P(CL, FUNCNAME) \
  15 SCM CL ## _type_p_proc; \
  16 void init_type_ ## CL () \
  17 { \
  18   SCM subr = scm_c_define_gsubr (FUNCNAME, 1, 0, 0, \
  19                                  (Scheme_function_unknown) CL::smob_p); \
  20   CL ## _type_p_proc = subr; \
  21   ly_add_function_documentation (subr, FUNCNAME, "(SCM x)", \
  22                                  "Is @var{x} a @code{" #CL "} object?"); \
  23   scm_c_export (FUNCNAME, NULL); \
  24 } \
  25 ADD_SCM_INIT_FUNC (init_type_ ## CL, init_type_ ## CL)
  26
  27 #ifndef SCM_CELL_TYPE
  28 #define SCM_CELL_TYPE(X) SCM_CAR (X)
  29 #endif
  30
  31 #ifndef SCM_CELL_WORD_1
  32 #define SCM_CELL_WORD_1(X) SCM_CDR (X)
  33 #endif
  34
  35 #define IMPLEMENT_BASE_SMOBS(CL) \
  36 scm_t_bits CL::smob_tag_; \
  37 SCM \
  38 CL::smob_p (SCM s) \
  39 { \
  40   if (SCM_NIMP (s) && SCM_CELL_TYPE (s) == smob_tag_) \
  41     return SCM_BOOL_T; \
  42   else \
  43     return SCM_BOOL_F; \
  44  \
  45 } \
  46   \
  47 void \
  48 CL::init_smobs () \
  49 { \
  50   smob_tag_ = scm_make_smob_type (#CL, 0); \
  51   scm_set_smob_mark (smob_tag_, CL::mark_smob); \
  52   scm_set_smob_free (smob_tag_, CL::free_smob); \
  53   scm_set_smob_print (smob_tag_, CL::print_smob); \
  54   scm_set_smob_equalp (smob_tag_, CL::equal_p); \
  55 } \
  56   \
  57 size_t \
  58 CL::free_smob (SCM ses) \
  59 { \
  60   CL *s = (CL*) SCM_CDR (ses); \
  61   delete s; \
  62   scm_gc_unregister_collectable_memory (s, sizeof (CL), #CL " smob"); \
  63   return SMOB_FREE_RETURN_VAL(CL); \
  64 } \
  65   \
  66 ADD_SCM_INIT_FUNC (CL, CL::init_smobs)
  67
  68 #define IMPLEMENT_SIMPLE_SMOBS(CL) \
  69 IMPLEMENT_BASE_SMOBS(CL); \
  70 SCM CL::smobbed_copy () const \
  71 { \
  72   CL *ptr = new CL (*this); \
  73   SCM s; \
  74   s = scm_cons (SCM_PACK (CL::smob_tag_), SCM_PACK (ptr)); \
  75   scm_gc_register_collectable_memory ((CL*)this, sizeof (CL), #CL " smob"); \
  76  \
  77   return s; \
  78 } \
  79
  80
  81 #define IMPLEMENT_SMOBS(CL) \
  82 IMPLEMENT_BASE_SMOBS (CL) \
  83 void \
  84 CL::smobify_self () \
  85 { \
  86   SCM s = unprotected_smobify_self (); \
  87   scm_gc_protect_object (s); \
  88 } \
  89   \
  90 SCM \
  91 CL::unprotected_smobify_self () \
  92 { \
  93   /* \
  94     This is local. We don't assign to self_scm_ directly, to assure \
  95     that S isn't GC-ed from under us. \
  96     \
  97     We don't use smobbed_self () to ensure that mark_smob () doesn't have to \
  98     deal half-initialized objects: scm_done_malloc ( ) might trigger GC. \
  99     the warning in smobs.hh is just to be doubleplus goodly sure \
 100    */ \
 101   SCM s; \
 102   SCM_NEWSMOB (s, CL::smob_tag_, this); \
 103   self_scm_ = s; \
 104  scm_gc_register_collectable_memory (this, sizeof (CL), #CL " smob"); \
 105   return s; \
 106 }
 107
 108 #define IMPLEMENT_DEFAULT_EQUAL_P(CL) \
 109 SCM \
 110 CL::equal_p (SCM a , SCM b) \
 111 { \
 112   return a == b ? SCM_BOOL_T : SCM_BOOL_F; \
 113 } \
 114
 115
 116 #endif /* LY_SMOBS_ICC */
 117
 118