2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
23 // Contains generic template definitions. With GCC, it is just
24 // included from smobs.hh, but other template expansion systems might
25 // make it feasible to compile this only a single time.
27 #include "lily-guile-macros.hh"
31 template <class Super>
33 Smob_base<Super>::mark_trampoline (SCM arg)
35 return (Super::unsmob (arg))->mark_smob ();
38 template <class Super>
40 Smob_base<Super>::register_ptr (Super *p)
42 // Don't use SCM_RETURN_NEWSMOB since that would require us to
43 // first register the memory and then create the smob. That would
44 // announce the memory as being GC-controlled before even
45 // allocating the controlling smob.
46 SCM s = SCM_UNDEFINED;
47 SCM_NEWSMOB (s, smob_tag (), p);
48 scm_gc_register_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
52 // Default, should not actually get called
53 template <class Super>
55 Smob_base<Super>::mark_smob ()
57 return SCM_UNSPECIFIED;
60 template <class Super>
62 Smob_base<Super>::print_smob (SCM, SCM p, scm_print_state *)
65 scm_puts (smob_name_.c_str (), p);
70 template <class Super>
72 Smob_base<Super>::unregister_ptr (SCM obj)
74 Super *p = Super::unchecked_unsmob (obj);
75 scm_gc_unregister_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
79 template <class Super>
80 scm_t_bits Smob_base<Super>::smob_tag_ = 0;
82 template <class Super>
83 Scm_init Smob_base<Super>::scm_init_ = init;
85 template <class Super>
86 string Smob_base<Super>::smob_name_;
88 template <class Super>
89 void Smob_base<Super>::init ()
91 smob_name_ = typeid (Super).name ();
92 // Primitive demangling, suitable for GCC, should be harmless
93 // elsewhere. The worst that can happen is that we get material
94 // unsuitable for Texinfo documentation. If that proves to be an
95 // issue, we need some smarter strategy.
96 smob_name_ = smob_name_.substr (smob_name_.find_first_not_of ("0123456789"));
98 smob_tag_ = scm_make_smob_type (smob_name_.c_str (), 0);
99 // The following have trivial private default definitions not
100 // referring to any aspect of the Super class apart from its name.
101 // They should be overridden (or rather masked) at Super level: that
102 // way they can refer to Super-private data.
103 // While that's not a consideration for type_p_name_, it's easier
104 // doing it like the rest.
106 if (Super::free_smob != 0)
107 scm_set_smob_free (smob_tag_, Super::free_smob);
108 if (&Super::mark_smob != &Smob_base<Super>::mark_smob)
109 scm_set_smob_mark (smob_tag_, Super::mark_trampoline);
110 if (Super::print_smob != 0)
111 scm_set_smob_print (smob_tag_, Super::print_smob);
112 if (Super::equal_p != 0)
113 scm_set_smob_equalp (smob_tag_, Super::equal_p);
114 if (Super::type_p_name_ != 0)
116 SCM subr = scm_c_define_gsubr (Super::type_p_name_, 1, 0, 0,
117 (scm_t_subr) smob_p);
118 string fundoc = string("Is @var{x} a @code{") + smob_name_
120 ly_add_function_documentation (subr, Super::type_p_name_, "(SCM x)",
122 scm_c_export (Super::type_p_name_, NULL);
124 ly_add_type_predicate ((void *) unsmob, smob_name_.c_str ());
125 if (Super::smob_proc != 0)
126 scm_set_smob_apply (smob_tag_,
127 (scm_t_subr)Super::smob_proc,
128 Super::smob_proc_signature_ >> 8,
129 (Super::smob_proc_signature_ >> 4)&0xf,
130 Super::smob_proc_signature_ & 0xf);