XMLRegisterCleanup.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:7k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: XMLRegisterCleanup.hpp,v 1.2 2002/11/04 15:22:05 tng Exp $
  58.  * $Log: XMLRegisterCleanup.hpp,v $
  59.  * Revision 1.2  2002/11/04 15:22:05  tng
  60.  * C++ Namespace Support.
  61.  *
  62.  * Revision 1.1.1.1  2002/02/01 22:22:15  peiyongz
  63.  * sane_include
  64.  *
  65.  * Revision 1.4  2001/10/25 21:55:29  peiyongz
  66.  * copy ctor explicity declared private to prevent supprise.
  67.  *
  68.  * Revision 1.3  2001/10/24 18:13:06  peiyongz
  69.  * CVS tag added
  70.  *
  71.  *
  72.  */
  73. #if !defined(XMLREGISTERCLEANUP_HPP)
  74. #define XMLREGISTERCLEANUP_HPP
  75. #include <xercesc/util/Mutexes.hpp>
  76. XERCES_CPP_NAMESPACE_BEGIN
  77. // This is a mutex for exclusive use by this class
  78. extern XMLMutex* gXMLCleanupListMutex;
  79. // This is the head of a list of XMLRegisterCleanup objects that
  80. // is used during XMLPlatformUtils::Terminate() to find objects to
  81. // clean up
  82. class XMLRegisterCleanup;
  83. extern XMLRegisterCleanup* gXMLCleanupList;
  84. //
  85. //  For internal use only.
  86. //
  87. //  This class is used by the platform utilities class to support
  88. //  reinitialisation of global/static data which is lazily created.
  89. //  Since that data is widely spread out the platform utilities
  90. //  class cannot know about them directly. So, the code that creates such
  91. //  objects creates an registers a cleanup for the object. The platform
  92. //  termination call will iterate the list and delete the objects.
  93. //
  94. //  N.B. These objects need to be statically allocated.  I couldn't think
  95. //  of a neat way of ensuring this - can anyone else?
  96. class XMLRegisterCleanup
  97. {
  98. public :
  99. // The cleanup function to be called on XMLPlatformUtils::Terminate()
  100. typedef void (*XMLCleanupFn)();
  101. void doCleanup() {
  102. // When performing cleanup, we only do this once, but we can
  103. // cope if somehow we have been called twice.
  104. if (m_cleanupFn)
  105.             m_cleanupFn();
  106.         // We need to remove "this" from the list
  107.         // irregardless of the cleanup Function
  108.         unregisterCleanup();
  109. }
  110. // This function is called during initialisation of static data to
  111. // register a function to be called on XMLPlatformUtils::Terminate.
  112. // It gives an object that uses static data an opportunity to reset
  113. // such data.
  114. void registerCleanup(XMLCleanupFn cleanupFn) {
  115. // Store the cleanup function
  116. m_cleanupFn = cleanupFn;
  117. // Add this object to the list head, if it is not already
  118. // present - which it shouldn't be.
  119. // This is done under a mutex to ensure thread safety.
  120. gXMLCleanupListMutex->lock();
  121. if (!m_nextCleanup && !m_prevCleanup) {
  122. m_nextCleanup = gXMLCleanupList;
  123. gXMLCleanupList = this;
  124. if (m_nextCleanup)
  125. m_nextCleanup->m_prevCleanup = this;
  126. }
  127. gXMLCleanupListMutex->unlock();
  128. }
  129. // This function can be called either from XMLPlatformUtils::Terminate
  130. // to state that the cleanup has been performed and should not be
  131. // performed again, or from code that you have written that determines
  132. // that cleanup is no longer necessary.
  133. void unregisterCleanup() {
  134. gXMLCleanupListMutex->lock();
  135.         //
  136.         // To protect against some compiler's (eg hp11) optimization
  137.         // to change "this" as they update gXMLCleanupList
  138.         //
  139.         // refer to
  140.         // void XMLPlatformUtils::Terminate()
  141.         //       ...
  142.         //       while (gXMLCleanupList)
  143. //            gXMLCleanupList->doCleanup();
  144.         //
  145.         XMLRegisterCleanup *tmpThis = (XMLRegisterCleanup*) this;
  146.         // Unlink this object from the cleanup list
  147. if (m_nextCleanup) m_nextCleanup->m_prevCleanup = m_prevCleanup;
  148. if (!m_prevCleanup) gXMLCleanupList = m_nextCleanup;
  149. else m_prevCleanup->m_nextCleanup = m_nextCleanup;
  150. gXMLCleanupListMutex->unlock();
  151. // Reset the object to the default state
  152. tmpThis->resetCleanup();
  153. }
  154. // The default constructor sets a state that ensures that this object
  155. // will do nothing
  156. XMLRegisterCleanup()
  157. {
  158. resetCleanup();
  159. }
  160. private:
  161.     //
  162.     // unsupported ctor and operator
  163.     //
  164. XMLRegisterCleanup(const XMLRegisterCleanup&)
  165. {}
  166. // This is the cleanup function to be called
  167. XMLCleanupFn m_cleanupFn;
  168. // These are list pointers to the next/prev cleanup function to be called
  169. XMLRegisterCleanup *m_nextCleanup, *m_prevCleanup;
  170. // This function reinitialises the object to the default state
  171. void resetCleanup() {
  172. m_nextCleanup = 0;
  173. m_prevCleanup = 0;
  174. m_cleanupFn = 0;
  175. }
  176. };
  177. XERCES_CPP_NAMESPACE_END
  178. #endif