OSDN Git Service

2011-12-10 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / debug / safe_base.h
index 2851fc3..a1aa536 100644 (file)
@@ -1,12 +1,12 @@
 // Safe sequence/iterator base implementation  -*- C++ -*-
 
-// Copyright (C) 2003, 2004, 2005, 2006
+// Copyright (C) 2003, 2004, 2005, 2006, 2009, 2010
 // Free Software Foundation, Inc.
 //
 // This file is part of the GNU ISO C++ Library.  This library 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 2, or (at your option)
+// Free Software Foundation; either version 3, or (at your option)
 // any later version.
 
 // This library is distributed in the hope that it will be useful,
 // 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 this library; see the file COPYING.  If not, write to the Free
-// Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
-// USA.
+// Under Section 7 of GPL version 3, you are granted additional
+// permissions described in the GCC Runtime Library Exception, version
+// 3.1, as published by the Free Software Foundation.
 
-// As a special exception, you may use this file as part of a free software
-// library without restriction.  Specifically, if other files instantiate
-// templates or use macros or inline functions from this file, or you compile
-// this file and link it with other files to produce an executable, this
-// file does not by itself cause the resulting executable to be covered by
-// the GNU General Public License.  This exception does not however
-// invalidate any other reasons why the executable file might be covered by
-// the GNU General Public License.
+// You should have received a copy of the GNU General Public License and
+// a copy of the GCC Runtime Library Exception along with this program;
+// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
+// <http://www.gnu.org/licenses/>.
+
+/** @file debug/safe_base.h
+ *  This file is a GNU debug extension to the Standard C++ Library.
+ */
 
 #ifndef _GLIBCXX_DEBUG_SAFE_BASE_H
 #define _GLIBCXX_DEBUG_SAFE_BASE_H 1
@@ -37,7 +36,7 @@ namespace __gnu_debug
 {
   class _Safe_sequence_base;
 
-  /** \brief Basic functionality for a "safe" iterator.
+  /** \brief Basic functionality for a @a safe iterator.
    *
    *  The %_Safe_iterator_base base class implements the functionality
    *  of a safe iterator that is not specific to a particular iterator
@@ -80,7 +79,7 @@ namespace __gnu_debug
     { }
 
     /** Initialize the iterator to reference the sequence pointed to
-     *  by @p__seq. @p __constant is true when we are initializing a
+     *  by @p __seq. @p __constant is true when we are initializing a
      *  constant iterator, and false if it is a mutable iterator. Note
      *  that @p __seq may be NULL, in which case the iterator will be
      *  singular. Otherwise, the iterator will reference @p __seq and
@@ -106,7 +105,7 @@ namespace __gnu_debug
     ~_Safe_iterator_base() { this->_M_detach(); }
 
     /** For use in _Safe_iterator. */
-    __gnu_cxx::__mutex& _M_get_mutex();
+    __gnu_cxx::__mutex& _M_get_mutex() throw ();
 
   public:
     /** Attaches this iterator to the given sequence, detaching it
@@ -117,7 +116,7 @@ namespace __gnu_debug
     void _M_attach(_Safe_sequence_base* __seq, bool __constant);
 
     /** Likewise, but not thread-safe. */
-    void _M_attach_single(_Safe_sequence_base* __seq, bool __constant);
+    void _M_attach_single(_Safe_sequence_base* __seq, bool __constant) throw ();
 
     /** Detach the iterator for whatever sequence it is attached to,
      * if any.
@@ -125,19 +124,38 @@ namespace __gnu_debug
     void _M_detach();
 
     /** Likewise, but not thread-safe. */
-    void _M_detach_single();
+    void _M_detach_single() throw ();
 
     /** Determines if we are attached to the given sequence. */
     bool _M_attached_to(const _Safe_sequence_base* __seq) const
     { return _M_sequence == __seq; }
 
     /** Is this iterator singular? */
-    bool _M_singular() const;
+    _GLIBCXX_PURE bool _M_singular() const throw ();
 
     /** Can we compare this iterator to the given iterator @p __x?
        Returns true if both iterators are nonsingular and reference
        the same sequence. */
-    bool _M_can_compare(const _Safe_iterator_base& __x) const;
+    _GLIBCXX_PURE bool _M_can_compare(const _Safe_iterator_base& __x) const throw ();
+
+    /** Invalidate the iterator, making it singular. */
+    void
+    _M_invalidate()
+    { _M_version = 0; }
+
+    /** Reset all member variables */
+    void
+    _M_reset() throw ();
+
+    /** Unlink itself */
+    void
+    _M_unlink() throw ()
+    {
+      if (_M_prior)
+       _M_prior->_M_next = _M_next;
+      if (_M_next)
+       _M_next->_M_prior = _M_prior;
+    }
   };
 
   /**
@@ -154,7 +172,7 @@ namespace __gnu_debug
    * invalidation of all iterators that reference the container.
    *
    * This class must ensure that no operation on it may throw an
-   * exception, otherwise "safe" sequences may fail to provide the
+   * exception, otherwise @a safe sequences may fail to provide the
    * exception-safety guarantees required by the C++ standard.
    */
   class _Safe_sequence_base
@@ -193,7 +211,7 @@ namespace __gnu_debug
 
     /** Revalidates all attached singular iterators.  This method may
      *  be used to validate iterators that were invalidated before
-     *  (but for some reasion, such as an exception, need to become
+     *  (but for some reason, such as an exception, need to become
      *  valid again).
      */
     void
@@ -208,13 +226,29 @@ namespace __gnu_debug
     _M_swap(_Safe_sequence_base& __x);
 
     /** For use in _Safe_sequence. */
-    __gnu_cxx::__mutex& _M_get_mutex();
+    __gnu_cxx::__mutex& _M_get_mutex() throw ();
 
   public:
     /** Invalidates all iterators. */
     void
     _M_invalidate_all() const
     { if (++_M_version == 0) _M_version = 1; }
+
+    /** Attach an iterator to this sequence. */
+    void
+    _M_attach(_Safe_iterator_base* __it, bool __constant);
+
+    /** Likewise but not thread safe. */
+    void
+    _M_attach_single(_Safe_iterator_base* __it, bool __constant) throw ();
+
+    /** Detach an iterator from this sequence */
+    void
+    _M_detach(_Safe_iterator_base* __it);
+
+    /** Likewise but not thread safe. */
+    void
+    _M_detach_single(_Safe_iterator_base* __it) throw ();
   };
 } // namespace __gnu_debug