gcc const fix, converted linefeeds
[shibboleth/cpp-xmltooling.git] / xmltooling / util / ParserPool.h
index 64910df..f4f9a8f 100644 (file)
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file ParserPool.h\r
- * \r
- * XML parsing\r
- */\r
-\r
-#if !defined(__xmltooling_pool_h__)\r
-#define __xmltooling_pool_h__\r
-\r
-#include <xmltooling/unicode.h>\r
-#include <xmltooling/util/Threads.h>\r
-\r
-#include <map>\r
-#include <stack>\r
-#include <istream>\r
-#include <xercesc/dom/DOM.hpp>\r
-#include <xercesc/sax/InputSource.hpp>\r
-#include <xercesc/util/BinInputStream.hpp>\r
-\r
-using namespace xercesc;\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( push )\r
-    #pragma warning( disable : 4250 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
-\r
-    /**\r
-     * A thread-safe pool of DOMBuilders that share characteristics\r
-     */\r
-    class XMLTOOL_API ParserPool : public DOMEntityResolver, DOMErrorHandler\r
-    {\r
-        MAKE_NONCOPYABLE(ParserPool);\r
-    public:\r
-        /**\r
-         * Constructs a new pool\r
-         * \r
-         * @param namespaceAware    indicates whether parsers should be namespace-aware or not\r
-         * @param schemaAware       indicates whether parsers should be schema-validating or not\r
-         */\r
-        ParserPool(bool namespaceAware=true, bool schemaAware=false);\r
-        ~ParserPool();\r
-\r
-        /**\r
-         * Creates a new document using a parser from this pool.\r
-         * \r
-         * @return new XML document\r
-         * \r
-         */\r
-        DOMDocument* newDocument();\r
-\r
-        /**\r
-         * Parses a document using a pooled parser with the proper settings\r
-         * \r
-         * @param domsrc A DOM source containing the content to be parsed\r
-         * @return The DOM document resulting from the parse\r
-         * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML\r
-         */\r
-        DOMDocument* parse(DOMInputSource& domsrc);\r
-\r
-        /**\r
-         * Parses a document using a pooled parser with the proper settings\r
-         * \r
-         * @param is An input stream containing the content to be parsed\r
-         * @return The DOM document resulting from the parse\r
-         * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML\r
-         */\r
-        DOMDocument* parse(std::istream& is);\r
-\r
-        /**\r
-         * Load an OASIS catalog file to map schema namespace URIs to filenames.\r
-         * \r
-         * This does not provide real catalog support; only the &lt;uri&gt; element\r
-         * is supported to map from a namespace URI to a relative path or file:// URI.\r
-         * \r
-         * @param pathname  path to a catalog file\r
-         * @return true iff the catalog was successfully processed\r
-         */\r
-        bool loadCatalog(const XMLCh* pathname);\r
-        \r
-        /**\r
-         * Load a schema explicitly from a local file.\r
-         * \r
-         * Note that "successful processing" does not imply that the schema is valid,\r
-         * only that a reference to it was successfully registered with the pool.\r
-         * \r
-         * @param nsURI     XML namespace to load\r
-         * @param pathname  path to schema file\r
-         * @return true iff the schema was successfully processed\r
-         */\r
-        bool loadSchema(const XMLCh* nsURI, const XMLCh* pathname);\r
-\r
-        /**\r
-         * Supplies all external entities (primarily schemas) to the parser\r
-         */\r
-        DOMInputSource* resolveEntity(const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const baseURI);\r
-\r
-        /**\r
-         * Handles parsing errors\r
-         */\r
-        bool handleError(const DOMError& e);\r
-\r
-    private:\r
-        DOMBuilder* createBuilder();\r
-        DOMBuilder* checkoutBuilder();\r
-        void checkinBuilder(DOMBuilder* builder);\r
-\r
-#ifdef HAVE_GOOD_STL\r
-        xstring m_schemaLocations;\r
-        std::map<xstring,xstring> m_schemaLocMap;\r
-#else\r
-        std::string m_schemaLocations;\r
-        std::map<std::string,std::string> m_schemaLocMap;\r
-#endif\r
-        bool m_namespaceAware,m_schemaAware;\r
-        std::stack<DOMBuilder*> m_pool;\r
-        Mutex* m_lock;\r
-    };\r
-\r
-    /**\r
-     * A parser source that wraps a C++ input stream\r
-     */\r
-    class XMLTOOL_API StreamInputSource : public InputSource\r
-    {\r
-    MAKE_NONCOPYABLE(StreamInputSource);\r
-    public:\r
-        /**\r
-         * Constructs an input source around an input stream reference.\r
-         * \r
-         * @param is        reference to an input stream\r
-         * @param systemId  optional system identifier to attach to the stream\r
-         */\r
-        StreamInputSource(std::istream& is, const char* systemId=NULL) : InputSource(systemId), m_is(is) {}\r
-        /// @cond off\r
-        virtual BinInputStream* makeStream() const { return new StreamBinInputStream(m_is); }\r
-        /// @endcond\r
-\r
-        /**\r
-         * A Xerces input stream that wraps a C++ input stream\r
-         */\r
-        class XMLTOOL_API StreamBinInputStream : public BinInputStream\r
-        {\r
-        public:\r
-            /**\r
-             * Constructs a Xerces input stream around a C++ input stream reference.\r
-             * \r
-             * @param is        reference to an input stream\r
-             */\r
-            StreamBinInputStream(std::istream& is) : m_is(is), m_pos(0) {}\r
-            /// @cond off\r
-            virtual unsigned int curPos() const { return m_pos; }\r
-            virtual unsigned int readBytes(XMLByte* const toFill, const unsigned int maxToRead);\r
-            /// @endcond\r
-        private:\r
-            std::istream& m_is;\r
-            unsigned int m_pos;\r
-        };\r
-\r
-    private:\r
-        std::istream& m_is;\r
-    };\r
-};\r
-\r
-#if defined (_MSC_VER)\r
-    #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_pool_h__ */\r
+/*
+ *  Copyright 2001-2006 Internet2
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file ParserPool.h
+ * 
+ * XML parsing
+ */
+
+#if !defined(__xmltooling_pool_h__)
+#define __xmltooling_pool_h__
+
+#include <xmltooling/unicode.h>
+#include <xmltooling/util/Threads.h>
+
+#include <map>
+#include <stack>
+#include <istream>
+#include <xercesc/dom/DOM.hpp>
+#include <xercesc/sax/InputSource.hpp>
+#include <xercesc/util/BinInputStream.hpp>
+
+using namespace xercesc;
+
+#if defined (_MSC_VER)
+    #pragma warning( push )
+    #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+    /**
+     * A thread-safe pool of DOMBuilders that share characteristics
+     */
+    class XMLTOOL_API ParserPool : public DOMEntityResolver, DOMErrorHandler
+    {
+        MAKE_NONCOPYABLE(ParserPool);
+    public:
+        /**
+         * Constructs a new pool
+         * 
+         * @param namespaceAware    indicates whether parsers should be namespace-aware or not
+         * @param schemaAware       indicates whether parsers should be schema-validating or not
+         */
+        ParserPool(bool namespaceAware=true, bool schemaAware=false);
+        ~ParserPool();
+
+        /**
+         * Creates a new document using a parser from this pool.
+         * 
+         * @return new XML document
+         * 
+         */
+        DOMDocument* newDocument();
+
+        /**
+         * Parses a document using a pooled parser with the proper settings
+         * 
+         * @param domsrc A DOM source containing the content to be parsed
+         * @return The DOM document resulting from the parse
+         * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML
+         */
+        DOMDocument* parse(DOMInputSource& domsrc);
+
+        /**
+         * Parses a document using a pooled parser with the proper settings
+         * 
+         * @param is An input stream containing the content to be parsed
+         * @return The DOM document resulting from the parse
+         * @throws XMLParserException thrown if there was a problem reading, parsing, or validating the XML
+         */
+        DOMDocument* parse(std::istream& is);
+
+        /**
+         * Load an OASIS catalog file to map schema namespace URIs to filenames.
+         * 
+         * This does not provide real catalog support; only the &lt;uri&gt; element
+         * is supported to map from a namespace URI to a relative path or file:// URI.
+         * 
+         * @param pathname  path to a catalog file
+         * @return true iff the catalog was successfully processed
+         */
+        bool loadCatalog(const XMLCh* pathname);
+        
+        /**
+         * Load a schema explicitly from a local file.
+         * 
+         * Note that "successful processing" does not imply that the schema is valid,
+         * only that a reference to it was successfully registered with the pool.
+         * 
+         * @param nsURI     XML namespace to load
+         * @param pathname  path to schema file
+         * @return true iff the schema was successfully processed
+         */
+        bool loadSchema(const XMLCh* nsURI, const XMLCh* pathname);
+
+        /**
+         * Supplies all external entities (primarily schemas) to the parser
+         */
+        DOMInputSource* resolveEntity(const XMLCh* const publicId, const XMLCh* const systemId, const XMLCh* const baseURI);
+
+        /**
+         * Handles parsing errors
+         */
+        bool handleError(const DOMError& e);
+
+    private:
+        DOMBuilder* createBuilder();
+        DOMBuilder* checkoutBuilder();
+        void checkinBuilder(DOMBuilder* builder);
+
+#ifdef HAVE_GOOD_STL
+        xstring m_schemaLocations;
+        std::map<xstring,xstring> m_schemaLocMap;
+#else
+        std::string m_schemaLocations;
+        std::map<std::string,std::string> m_schemaLocMap;
+#endif
+        bool m_namespaceAware,m_schemaAware;
+        std::stack<DOMBuilder*> m_pool;
+        Mutex* m_lock;
+    };
+
+    /**
+     * A parser source that wraps a C++ input stream
+     */
+    class XMLTOOL_API StreamInputSource : public InputSource
+    {
+    MAKE_NONCOPYABLE(StreamInputSource);
+    public:
+        /**
+         * Constructs an input source around an input stream reference.
+         * 
+         * @param is        reference to an input stream
+         * @param systemId  optional system identifier to attach to the stream
+         */
+        StreamInputSource(std::istream& is, const char* systemId=NULL) : InputSource(systemId), m_is(is) {}
+        /// @cond off
+        virtual BinInputStream* makeStream() const { return new StreamBinInputStream(m_is); }
+        /// @endcond
+
+        /**
+         * A Xerces input stream that wraps a C++ input stream
+         */
+        class XMLTOOL_API StreamBinInputStream : public BinInputStream
+        {
+        public:
+            /**
+             * Constructs a Xerces input stream around a C++ input stream reference.
+             * 
+             * @param is        reference to an input stream
+             */
+            StreamBinInputStream(std::istream& is) : m_is(is), m_pos(0) {}
+            /// @cond off
+            virtual unsigned int curPos() const { return m_pos; }
+            virtual unsigned int readBytes(XMLByte* const toFill, const unsigned int maxToRead);
+            /// @endcond
+        private:
+            std::istream& m_is;
+            unsigned int m_pos;
+        };
+
+    private:
+        std::istream& m_is;
+    };
+};
+
+#if defined (_MSC_VER)
+    #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_pool_h__ */