Imported Upstream version 2.14.2

[lilypond.git] / lily / include / smobs.hh

diff --git a/lily/include/smobs.hh b/lily/include/smobs.hh
index c563f6df19aff2121c26c75c3f0b9fe36d7791be..cf6ffcc9a3fb2f5f4754ffe875b17025885973df 100644 (file)
--- a/lily/include/smobs.hh
+++ b/lily/include/smobs.hh
@@ -1,15 +1,27 @@
 /*
-  smobs.hh -- declare smob related stuff.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1999--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  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 <http://www.gnu.org/licenses/>.
 */
 
 #ifndef SMOBS_HH
 #define SMOBS_HH
 
 #include "lily-guile.hh"
+#include "warn.hh"
 
 /*
   Smobs are GUILEs mechanism of exporting C(++) objects to the Scheme
@@ -26,7 +38,7 @@
   SCM smobbed_copy ().
 
   Simple smobs are created by adding the
-  DECLARE_SIMPLE_SMOBS(Classname, ) to the declaration
+  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
@@ -57,7 +69,7 @@
   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
+  Complex smobs are made with DECLARE_SMOBS (Classname) in the class
   declaration.
 
   CALLING INTERFACE
@@ -87,7 +99,7 @@
   from file "ly-smobs.icc"
 */
 
-#define DECLARE_SIMPLE_SMOBS(CL, dummy)                \
+#define DECLARE_SIMPLE_SMOBS(CL)               \
   public:                                      \
   SCM smobbed_copy () const;                   \
   DECLARE_BASE_SMOBS (CL)
@@ -95,13 +107,14 @@
 #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)                                    \
+  static CL *unsmob (SCM s) __attribute__((pure))              \
   {                                                            \
     if (SCM_NIMP (s) && SCM_CELL_TYPE (s) == smob_tag_)                \
       return (CL *) SCM_CELL_WORD_1 (s);                       \
@@ -112,7 +125,7 @@
   static void init_smobs ();                                   \
   private:
 
-#define DECLARE_SMOBS(CL, dummy)               \
+#define DECLARE_SMOBS(CL)                      \
   DECLARE_BASE_SMOBS (CL)                      \
     protected:                                 \
   virtual ~CL ();                              \
@@ -120,7 +133,10 @@
   private:                                     \
   void smobify_self ();                                \
   SCM self_scm_;                               \
+  SCM protection_cons_;                                \
   public:                                      \
+  SCM unprotect ();                            \
+  void protect ();                             \
   SCM self_scm () const { return self_scm_; }  \
   private:
 
@@ -133,5 +149,25 @@
 
 #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 */