lily/include/protected-scm.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #ifndef PROTECTED_SCM_HH
  21 #define PROTECTED_SCM_HH
  22
  23 #include "lily-guile.hh"
  24
  25 /*
  26   Mix GUILE GC with C++ ctors and dtors.
  27
  28   This version is intended to be only used for variables of static
  29   lifetime (which are not feasible to protect using the per-instance
  30   mechanism of the smob classes) but possibly varying content.  As a
  31   result, the protection mechanism being used is the irreversible
  32   scm_permanent_object.  The destructor (typically called after the
  33   end of program execution) does not free resources and consequently
  34   does not require the memory subsystem to be still workable.  A
  35   working memory subsystem is only required once a non-immediate
  36   Scheme value is assigned to the variable.  Since creation of a
  37   non-immediate Scheme value requires a working memory subsystem in
  38   the first place, this is not really a restriction.
  39
  40   To avoid accidental creation of temporaries, the copy constructor is
  41   made unavailable.
  42 */
  43 class Protected_scm
  44 {
  45   SCM object_;
  46   static SCM list_;
  47   static SCM last_;
  48   Protected_scm (Protected_scm const &);
  49   void protectify (SCM);
  50 public:
  51   Protected_scm ();
  52   Protected_scm (SCM);
  53   Protected_scm &operator = (SCM);
  54   Protected_scm &operator = (Protected_scm const &);
  55   operator const SCM & () const;
  56   operator SCM & ();
  57   bool is_bound () const;  // SCM_UNBNDP balks at Protected_scm
  58 };
  59
  60 #endif /* PROTECTED_SCM_HH */