Initial check-in
[shibboleth/cpp-xmltooling.git] / xmltooling / unicode.h
diff --git a/xmltooling/unicode.h b/xmltooling/unicode.h
new file mode 100644 (file)
index 0000000..311ffb7
--- /dev/null
@@ -0,0 +1,154 @@
+/*\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 unicode.h\r
+ * \r
+ * Helper classes and types for manipulating Unicode\r
+ */\r
\r
+#if !defined(__xmltooling_unicode_h__)\r
+#define __xmltooling_unicode_h__\r
+\r
+#include <string>\r
+#include <xercesc/util/XMLString.hpp>\r
+#include <xmltooling/base.h>\r
+\r
+using namespace xercesc;\r
+\r
+namespace xmltooling {\r
+    \r
+    #ifdef HAVE_GOOD_STL\r
+        /**\r
+         * An STL string type that supports 16-bit Unicode.\r
+         * Most compilers support this, but various versions of gcc3 do not.\r
+         */\r
+        typedef std::basic_string<XMLCh> xstring;\r
+    #endif\r
+\r
+    /**\r
+     * Transcodes a 16-bit Unicode string into UTF-8.\r
+     * @param src   the 16-bit string to transcode\r
+     * @return      a UTF-8 string allocated by the Xerces memory manager \r
+     */\r
+    extern XMLTOOL_API char* toUTF8(const XMLCh* src);\r
+\r
+    /**\r
+     * Transcodes a UTF-8 string into 16-bit Unicode.\r
+     * @param src   the UTF-8 string to transcode\r
+     * @return      a 16-bit Unicode string allocated by the Xerces memory manager \r
+     */\r
+    extern XMLTOOL_API XMLCh* fromUTF8(const char* src);\r
+\r
+    /**\r
+     * A minimal auto_ptr-like class that can copy or transcode a buffer into\r
+     * the local code page and free the result automatically.\r
+     * \r
+     * Needed because a standard auto_ptr would use delete on the resulting\r
+     * pointer. \r
+     */\r
+    class XMLTOOL_API auto_ptr_char\r
+    {\r
+    public:\r
+        /**\r
+         * Constructor transcodes a 16-bit Unicode string into the local code page (NOT UTF-8) and wraps the result.\r
+         * @param src   the 16-bit string to transcode and wrap\r
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true) \r
+         */\r
+        auto_ptr_char(const XMLCh* src, bool trim=true) : m_buf(XMLString::transcode(src)) {if (trim && m_buf) XMLString::trim(m_buf);}\r
+\r
+        /**\r
+         * Constructor copies a local code page (NOT UTF-8) string and wraps the result.\r
+         * @param src   the local string to copy and wrap\r
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true) \r
+         */\r
+        auto_ptr_char(const char* src, bool trim=true) : m_buf(XMLString::replicate(src)) {if (trim && m_buf) XMLString::trim(m_buf);}\r
+\r
+        /**\r
+         * Destructor frees the wrapped buffer using the Xerces memory manager.\r
+         */\r
+        ~auto_ptr_char() { XMLString::release(&m_buf); }\r
+\r
+        /**\r
+         * Returns the wrapped buffer.\r
+         * @return a null-terminated local code page string\r
+         */\r
+        const char* get() const { return m_buf; }\r
+\r
+        /**\r
+         * Returns the wrapped buffer and transfers ownership of it to the caller.\r
+         * @return a null-terminated local code page string\r
+         */\r
+        char* release() { char* temp=m_buf; m_buf=NULL; return temp; }\r
+\r
+    private:\r
+        auto_ptr_char(const auto_ptr_char&);\r
+        auto_ptr_char& operator=(const auto_ptr_char&);\r
+        \r
+        char* m_buf;\r
+    };\r
+\r
+    /**\r
+     * A minimal auto_ptr-like class that can copy or transcode a buffer into\r
+     * 16-bit Unicode and free the result automatically.\r
+     * \r
+     * Needed because a standard auto_ptr would use delete on the resulting\r
+     * pointer. \r
+     */\r
+    class XMLTOOL_API auto_ptr_XMLCh\r
+    {\r
+    public:\r
+        /**\r
+         * Constructor transcodes a local code page (NOT UTF-8) string into 16-bit Unicode and wraps the result.\r
+         * @param src   the local string to transcode and wrap\r
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true) \r
+         */\r
+        auto_ptr_XMLCh(const char* src, bool trim=true) : m_buf(XMLString::transcode(src)) {if (trim && m_buf) XMLString::trim(m_buf);}\r
+\r
+        /**\r
+         * Constructor copies a 16-bit Unicode string and wraps the result.\r
+         * @param src   the Unicode string to copy and wrap\r
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true) \r
+         */\r
+        auto_ptr_XMLCh(const XMLCh* src, bool trim=true) : m_buf(XMLString::replicate(src)) {if (trim && m_buf) XMLString::trim(m_buf);}\r
+\r
+        /**\r
+         * Destructor frees the wrapped buffer using the Xerces memory manager.\r
+         */\r
+        ~auto_ptr_XMLCh() { XMLString::release(&m_buf); }\r
+\r
+        /**\r
+         * Returns the wrapped buffer.\r
+         * @return a null-terminated Unicode string\r
+         */\r
+        const XMLCh* get() const { return m_buf; }\r
+        \r
+        /**\r
+         * Returns the wrapped buffer and transfers ownership of it to the caller.\r
+         * @return a null-terminated Unicode string\r
+         */\r
+        XMLCh* release() { XMLCh* temp=m_buf; m_buf=NULL; return temp; }\r
+\r
+    private:\r
+        auto_ptr_XMLCh(const auto_ptr_XMLCh&);\r
+        auto_ptr_XMLCh& operator=(const auto_ptr_XMLCh&);\r
+\r
+        XMLCh* m_buf;\r
+    };\r
+\r
+};\r
+\r
+#endif /* __xmltooling_unicode_h__ */\r