[188] | 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 | /*
|
---|
| 58 | * $Id: XMLRegisterCleanup.hpp,v 1.3 2004/01/29 11:48:47 cargilld Exp $
|
---|
| 59 | * $Log: XMLRegisterCleanup.hpp,v $
|
---|
| 60 | * Revision 1.3 2004/01/29 11:48:47 cargilld
|
---|
| 61 | * Code cleanup changes to get rid of various compiler diagnostic messages.
|
---|
| 62 | *
|
---|
| 63 | * Revision 1.2 2002/11/04 15:22:05 tng
|
---|
| 64 | * C++ Namespace Support.
|
---|
| 65 | *
|
---|
| 66 | * Revision 1.1.1.1 2002/02/01 22:22:15 peiyongz
|
---|
| 67 | * sane_include
|
---|
| 68 | *
|
---|
| 69 | * Revision 1.4 2001/10/25 21:55:29 peiyongz
|
---|
| 70 | * copy ctor explicity declared private to prevent supprise.
|
---|
| 71 | *
|
---|
| 72 | * Revision 1.3 2001/10/24 18:13:06 peiyongz
|
---|
| 73 | * CVS tag added
|
---|
| 74 | *
|
---|
| 75 | *
|
---|
| 76 | */
|
---|
| 77 |
|
---|
| 78 | #if !defined(XMLREGISTERCLEANUP_HPP)
|
---|
| 79 | #define XMLREGISTERCLEANUP_HPP
|
---|
| 80 |
|
---|
| 81 | #include <xercesc/util/Mutexes.hpp>
|
---|
| 82 |
|
---|
| 83 | XERCES_CPP_NAMESPACE_BEGIN
|
---|
| 84 |
|
---|
| 85 | // This is a mutex for exclusive use by this class
|
---|
| 86 | extern XMLMutex* gXMLCleanupListMutex;
|
---|
| 87 |
|
---|
| 88 | // This is the head of a list of XMLRegisterCleanup objects that
|
---|
| 89 | // is used during XMLPlatformUtils::Terminate() to find objects to
|
---|
| 90 | // clean up
|
---|
| 91 | class XMLRegisterCleanup;
|
---|
| 92 | extern XMLRegisterCleanup* gXMLCleanupList;
|
---|
| 93 |
|
---|
| 94 | //
|
---|
| 95 | // For internal use only.
|
---|
| 96 | //
|
---|
| 97 | // This class is used by the platform utilities class to support
|
---|
| 98 | // reinitialisation of global/static data which is lazily created.
|
---|
| 99 | // Since that data is widely spread out the platform utilities
|
---|
| 100 | // class cannot know about them directly. So, the code that creates such
|
---|
| 101 | // objects creates an registers a cleanup for the object. The platform
|
---|
| 102 | // termination call will iterate the list and delete the objects.
|
---|
| 103 | //
|
---|
| 104 | // N.B. These objects need to be statically allocated. I couldn't think
|
---|
| 105 | // of a neat way of ensuring this - can anyone else?
|
---|
| 106 |
|
---|
| 107 | class XMLRegisterCleanup
|
---|
| 108 | {
|
---|
| 109 | public :
|
---|
| 110 | // The cleanup function to be called on XMLPlatformUtils::Terminate()
|
---|
| 111 | typedef void (*XMLCleanupFn)();
|
---|
| 112 |
|
---|
| 113 | void doCleanup() {
|
---|
| 114 | // When performing cleanup, we only do this once, but we can
|
---|
| 115 | // cope if somehow we have been called twice.
|
---|
| 116 | if (m_cleanupFn)
|
---|
| 117 | m_cleanupFn();
|
---|
| 118 |
|
---|
| 119 | // We need to remove "this" from the list
|
---|
| 120 | // irregardless of the cleanup Function
|
---|
| 121 | unregisterCleanup();
|
---|
| 122 | }
|
---|
| 123 |
|
---|
| 124 | // This function is called during initialisation of static data to
|
---|
| 125 | // register a function to be called on XMLPlatformUtils::Terminate.
|
---|
| 126 | // It gives an object that uses static data an opportunity to reset
|
---|
| 127 | // such data.
|
---|
| 128 | void registerCleanup(XMLCleanupFn cleanupFn) {
|
---|
| 129 | // Store the cleanup function
|
---|
| 130 | m_cleanupFn = cleanupFn;
|
---|
| 131 |
|
---|
| 132 | // Add this object to the list head, if it is not already
|
---|
| 133 | // present - which it shouldn't be.
|
---|
| 134 | // This is done under a mutex to ensure thread safety.
|
---|
| 135 | gXMLCleanupListMutex->lock();
|
---|
| 136 | if (!m_nextCleanup && !m_prevCleanup) {
|
---|
| 137 | m_nextCleanup = gXMLCleanupList;
|
---|
| 138 | gXMLCleanupList = this;
|
---|
| 139 |
|
---|
| 140 | if (m_nextCleanup)
|
---|
| 141 | m_nextCleanup->m_prevCleanup = this;
|
---|
| 142 | }
|
---|
| 143 | gXMLCleanupListMutex->unlock();
|
---|
| 144 | }
|
---|
| 145 |
|
---|
| 146 | // This function can be called either from XMLPlatformUtils::Terminate
|
---|
| 147 | // to state that the cleanup has been performed and should not be
|
---|
| 148 | // performed again, or from code that you have written that determines
|
---|
| 149 | // that cleanup is no longer necessary.
|
---|
| 150 | void unregisterCleanup() {
|
---|
| 151 | gXMLCleanupListMutex->lock();
|
---|
| 152 |
|
---|
| 153 | //
|
---|
| 154 | // To protect against some compiler's (eg hp11) optimization
|
---|
| 155 | // to change "this" as they update gXMLCleanupList
|
---|
| 156 | //
|
---|
| 157 | // refer to
|
---|
| 158 | // void XMLPlatformUtils::Terminate()
|
---|
| 159 | // ...
|
---|
| 160 | // while (gXMLCleanupList)
|
---|
| 161 | // gXMLCleanupList->doCleanup();
|
---|
| 162 | //
|
---|
| 163 |
|
---|
| 164 | XMLRegisterCleanup *tmpThis = (XMLRegisterCleanup*) this;
|
---|
| 165 |
|
---|
| 166 | // Unlink this object from the cleanup list
|
---|
| 167 | if (m_nextCleanup) m_nextCleanup->m_prevCleanup = m_prevCleanup;
|
---|
| 168 |
|
---|
| 169 | if (!m_prevCleanup) gXMLCleanupList = m_nextCleanup;
|
---|
| 170 | else m_prevCleanup->m_nextCleanup = m_nextCleanup;
|
---|
| 171 |
|
---|
| 172 | gXMLCleanupListMutex->unlock();
|
---|
| 173 |
|
---|
| 174 | // Reset the object to the default state
|
---|
| 175 | tmpThis->resetCleanup();
|
---|
| 176 | }
|
---|
| 177 |
|
---|
| 178 | // The default constructor sets a state that ensures that this object
|
---|
| 179 | // will do nothing
|
---|
| 180 | XMLRegisterCleanup()
|
---|
| 181 | {
|
---|
| 182 | resetCleanup();
|
---|
| 183 | }
|
---|
| 184 |
|
---|
| 185 | private:
|
---|
| 186 | // -----------------------------------------------------------------------
|
---|
| 187 | // Unimplemented constructors and operators
|
---|
| 188 | // -----------------------------------------------------------------------
|
---|
| 189 | XMLRegisterCleanup(const XMLRegisterCleanup&);
|
---|
| 190 | XMLRegisterCleanup& operator=(const XMLRegisterCleanup&);
|
---|
| 191 |
|
---|
| 192 | // This is the cleanup function to be called
|
---|
| 193 | XMLCleanupFn m_cleanupFn;
|
---|
| 194 |
|
---|
| 195 | // These are list pointers to the next/prev cleanup function to be called
|
---|
| 196 | XMLRegisterCleanup *m_nextCleanup, *m_prevCleanup;
|
---|
| 197 |
|
---|
| 198 | // This function reinitialises the object to the default state
|
---|
| 199 | void resetCleanup() {
|
---|
| 200 | m_nextCleanup = 0;
|
---|
| 201 | m_prevCleanup = 0;
|
---|
| 202 | m_cleanupFn = 0;
|
---|
| 203 | }
|
---|
| 204 | };
|
---|
| 205 |
|
---|
| 206 | XERCES_CPP_NAMESPACE_END
|
---|
| 207 |
|
---|
| 208 | #endif
|
---|