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>::register_ptr (Super *p)
35 // Don't use SCM_RETURN_NEWSMOB since that would require us to
36 // first register the memory and then create the smob. That would
37 // announce the memory as being GC-controlled before even
38 // allocating the controlling smob.
39 SCM s = SCM_UNDEFINED;
40 SCM_NEWSMOB (s, smob_tag (), p);
41 scm_gc_register_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
45 template <class Super>
47 Smob_base<Super>::print_smob (SCM, SCM p, scm_print_state *)
50 scm_puts (smob_name_.c_str (), p);
55 template <class Super>
57 Smob_base<Super>::unregister_ptr (SCM obj)
59 Super *p = Super::unchecked_unsmob (obj);
60 scm_gc_unregister_collectable_memory (p, sizeof (*p), smob_name_.c_str ());
64 template <class Super>
65 scm_t_bits Smob_base<Super>::smob_tag_ = 0;
67 template <class Super>
68 Scm_init Smob_base<Super>::scm_init_ = init;
70 template <class Super>
71 string Smob_base<Super>::smob_name_;
73 template <class Super>
74 void Smob_base<Super>::init ()
76 smob_name_ = typeid (Super).name ();
77 // Primitive demangling, suitable for GCC, should be harmless
78 // elsewhere. The worst that can happen is that we get material
79 // unsuitable for Texinfo documentation. If that proves to be an
80 // issue, we need some smarter strategy.
81 smob_name_ = smob_name_.substr (smob_name_.find_first_not_of ("0123456789"));
83 smob_tag_ = scm_make_smob_type (smob_name_.c_str (), 0);
84 // The following have trivial private default definitions not
85 // referring to any aspect of the Super class apart from its name.
86 // They should be overridden (or rather masked) at Super level: that
87 // way they can refer to Super-private data.
88 // While that's not a consideration for type_p_name_, it's easier
89 // doing it like the rest.
91 if (Super::free_smob != 0)
92 scm_set_smob_free (smob_tag_, Super::free_smob);
93 if (Super::mark_smob != 0)
94 scm_set_smob_mark (smob_tag_, Super::mark_smob);
95 if (Super::print_smob != 0)
96 scm_set_smob_print (smob_tag_, Super::print_smob);
97 if (Super::equal_p != 0)
98 scm_set_smob_equalp (smob_tag_, Super::equal_p);
99 if (Super::type_p_name_ != 0)
101 SCM subr = scm_c_define_gsubr (Super::type_p_name_, 1, 0, 0,
102 (scm_t_subr) smob_p);
103 string fundoc = string("Is @var{x} a @code{") + smob_name_
105 ly_add_function_documentation (subr, Super::type_p_name_, "(SCM x)",
107 scm_c_export (Super::type_p_name_, NULL);
109 ly_add_type_predicate ((void *) unsmob, smob_name_.c_str ());