2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2015 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 Super *ptr = Super::unsmob (arg);
37 return ptr->mark_smob ();
41 template <class Super>
43 Smob_base<Super>::print_trampoline (SCM arg, SCM port, scm_print_state *p)
45 Super *ptr = Super::unsmob (arg);
47 return ptr->print_smob (port, p);
51 template <class Super>
53 Smob_base<Super>::register_ptr (Super *p)
55 // Don't use SCM_RETURN_NEWSMOB since that would require us to
56 // first register the memory and then create the smob. That would
57 // announce the memory as being GC-controlled before even
58 // allocating the controlling smob.
59 SCM s = SCM_UNDEFINED;
60 SCM_NEWSMOB (s, smob_tag (), p);
61 scm_gc_register_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
65 // Defaults, should not actually get called
66 template <class Super>
68 Smob_base<Super>::mark_smob ()
70 return SCM_UNSPECIFIED;
73 template <class Super>
75 Smob_base<Super>::free_smob (SCM)
80 template <class Super>
82 Smob_base<Super>::equal_p (SCM, SCM)
87 // Default, will often get called
89 template <class Super>
91 Smob_base<Super>::print_smob (SCM p, scm_print_state *)
94 scm_puts (smob_name_.c_str (), p);
99 template <class Super>
101 Smob_base<Super>::unregister_ptr (SCM obj)
103 Super *p = Super::unchecked_unsmob (obj);
104 scm_gc_unregister_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
105 SCM_SET_SMOB_DATA (obj, static_cast<Super *> (0));
109 template <class Super>
110 string Smob_base<Super>::smob_name_;
112 template <class Super>
113 scm_t_bits Smob_base<Super>::init_id ()
115 smob_name_ = typeid (Super).name ();
116 // Primitive demangling, suitable for GCC, should be harmless
117 // elsewhere. The worst that can happen is that we get material
118 // unsuitable for Texinfo documentation. If that proves to be an
119 // issue, we need some smarter strategy.
120 smob_name_ = smob_name_.substr (smob_name_.find_first_not_of ("0123456789"));
121 scm_t_bits smob_tag = scm_make_smob_type (smob_name_.c_str (), 0);
122 // The following have trivial private default definitions not
123 // referring to any aspect of the Super class apart from its name.
124 // They should be overridden (or rather masked) at Super level: that
125 // way they can refer to Super-private data.
126 // While that's not a consideration for type_p_name_, it's easier
127 // doing it like the rest.
129 if (&Super::free_smob != &Smob_base<Super>::free_smob)
130 scm_set_smob_free (smob_tag, Super::free_smob);
131 // Old GCC versions get their type lattice for pointers-to-members
132 // tangled up to a degree where we need to typecast _both_ covariant
133 // types in order to be able to compare them. The other comparisons
134 // are for static member functions and thus are ordinary function
135 // pointers which work without those contortions.
136 if (static_cast<SCM (Super::*)()>(&Super::mark_smob) !=
137 static_cast<SCM (Super::*)()>(&Smob_base<Super>::mark_smob))
138 scm_set_smob_mark (smob_tag, Super::mark_trampoline);
139 scm_set_smob_print (smob_tag, Super::print_trampoline);
140 if (&Super::equal_p != &Smob_base<Super>::equal_p)
141 scm_set_smob_equalp (smob_tag, Super::equal_p);
142 if (Super::type_p_name_ != 0)
144 SCM subr = scm_c_define_gsubr (Super::type_p_name_, 1, 0, 0,
145 (scm_t_subr) smob_p);
146 string fundoc = string("Is @var{x} a @code{") + smob_name_
148 ly_add_function_documentation (subr, Super::type_p_name_, "(SCM x)",
150 scm_c_export (Super::type_p_name_, NULL);
152 ly_add_type_predicate ((void *) is_smob, smob_name_.c_str ());
153 if (Super::smob_proc_signature_ >= 0)
154 scm_set_smob_apply (smob_tag,
155 (scm_t_subr)Super::smob_proc,
156 Super::smob_proc_signature_ >> 8,
157 (Super::smob_proc_signature_ >> 4)&0xf,
158 Super::smob_proc_signature_ & 0xf);