CPPXT-104 - Add exception handling to integer conversions
[shibboleth/cpp-xmltooling.git] / xmltooling / unicode.h
index 6cc8763..eb842c4 100644 (file)
@@ -1,65 +1,77 @@
-/*
- *  Copyright 2001-2007 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
+ * 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.
+ * 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 xmltooling/unicode.h
- * 
+ *
  * Helper classes and types for manipulating Unicode
  */
+
 #ifndef __xmltooling_unicode_h__
 #define __xmltooling_unicode_h__
 
 #include <xmltooling/base.h>
 
+#ifndef HAVE_GOOD_STL
+# include <xmltooling/char_traits.h>
+#endif
+
 #include <string>
 #include <iostream>
 #include <xercesc/util/XMLString.hpp>
 
 namespace xmltooling {
-    
-    #ifdef HAVE_GOOD_STL
+
+#ifdef HAVE_GOOD_STL
         /**
          * An STL string type that supports 16-bit Unicode.
-         * Most compilers support this, but various versions of gcc3 do not.
          */
         typedef std::basic_string<XMLCh> xstring;
-    #endif
+#else
+        /**
+         * An STL string type that supports 16-bit Unicode.
+         */
+        typedef std::basic_string< XMLCh,char_traits<XMLCh> > xstring;
+#endif
 
     /**
      * Transcodes a 16-bit Unicode string into UTF-8.
-     * 
+     *
      * @param src           the 16-bit string to transcode
      * @param use_malloc    true iff the result should be allocated with malloc, false to use new
-     * @return      a UTF-8 string allocated by the Xerces memory manager 
+     * @return      a UTF-8 string allocated by new or malloc
      */
     extern XMLTOOL_API char* toUTF8(const XMLCh* src, bool use_malloc=false);
 
     /**
      * Transcodes a UTF-8 string into 16-bit Unicode.
-     * 
+     *
      * @param src           the UTF-8 string to transcode
      * @param use_malloc    true iff the result should be allocated with malloc, false to use new
-     * @return      a 16-bit Unicode string allocated by the Xerces memory manager 
+     * @return      a 16-bit Unicode string allocated by new or malloc
      */
     extern XMLTOOL_API XMLCh* fromUTF8(const char* src, bool use_malloc=false);
 
     /**
      * Writes a Unicode string to an ASCII stream by transcoding to UTF8.
-     * 
+     *
      * @param ostr  stream to write to
      * @param s     string to write
      * @return      reference to output stream
@@ -67,20 +79,35 @@ namespace xmltooling {
     extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const XMLCh* s);
 
     /**
+     * Writes a Unicode string to an ASCII stream by transcoding to UTF8.
+     *
+     * @param ostr  stream to write to
+     * @param s     string to write
+     * @return      reference to output stream
+     */
+    extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const xstring& s);
+
+    /**
      * A minimal auto_ptr-like class that can copy or transcode a buffer into
      * the local code page and free the result automatically.
-     * 
+     *
      * Needed because a standard auto_ptr would use delete on the resulting
-     * pointer. 
+     * pointer.
      */
     class XMLTOOL_API auto_ptr_char
     {
         MAKE_NONCOPYABLE(auto_ptr_char);
     public:
         /**
+         * Default constructor.
+         */
+        auto_ptr_char() : m_buf(nullptr) {
+        }
+
+        /**
          * Constructor transcodes a 16-bit Unicode string into the local code page (NOT UTF-8) and wraps the result.
          * @param src   the 16-bit string to transcode and wrap
-         * @param trim  trims leading/trailing whitespace from the result (defaults to true) 
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true)
          */
         auto_ptr_char(const XMLCh* src, bool trim=true) : m_buf(xercesc::XMLString::transcode(src)) {
             if (trim && m_buf) xercesc::XMLString::trim(m_buf);
@@ -89,7 +116,7 @@ namespace xmltooling {
         /**
          * Constructor copies a local code page (NOT UTF-8) string and wraps the result.
          * @param src   the local string to copy and wrap
-         * @param trim  trims leading/trailing whitespace from the result (defaults to true) 
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true)
          */
         auto_ptr_char(const char* src, bool trim=true) : m_buf(xercesc::XMLString::replicate(src)) {
             if (trim && m_buf) xercesc::XMLString::trim(m_buf);
@@ -115,28 +142,34 @@ namespace xmltooling {
          * @return a null-terminated local code page string
          */
         char* release() {
-            char* temp=m_buf; m_buf=NULL; return temp;
+            char* temp=m_buf; m_buf=nullptr; return temp;
         }
 
-    private:    
+    private:
         char* m_buf;
     };
 
     /**
      * A minimal auto_ptr-like class that can copy or transcode a buffer into
      * 16-bit Unicode and free the result automatically.
-     * 
+     *
      * Needed because a standard auto_ptr would use delete on the resulting
-     * pointer. 
+     * pointer.
      */
     class XMLTOOL_API auto_ptr_XMLCh
     {
         MAKE_NONCOPYABLE(auto_ptr_XMLCh);
     public:
         /**
+         * Default constructor.
+         */
+        auto_ptr_XMLCh() : m_buf(nullptr) {
+        }
+
+        /**
          * Constructor transcodes a local code page (NOT UTF-8) string into 16-bit Unicode and wraps the result.
          * @param src   the local string to transcode and wrap
-         * @param trim  trims leading/trailing whitespace from the result (defaults to true) 
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true)
          */
         auto_ptr_XMLCh(const char* src, bool trim=true) : m_buf(xercesc::XMLString::transcode(src)) {
             if (trim && m_buf) xercesc::XMLString::trim(m_buf);
@@ -145,7 +178,7 @@ namespace xmltooling {
         /**
          * Constructor copies a 16-bit Unicode string and wraps the result.
          * @param src   the Unicode string to copy and wrap
-         * @param trim  trims leading/trailing whitespace from the result (defaults to true) 
+         * @param trim  trims leading/trailing whitespace from the result (defaults to true)
          */
         auto_ptr_XMLCh(const XMLCh* src, bool trim=true) : m_buf(xercesc::XMLString::replicate(src)) {
             if (trim && m_buf) xercesc::XMLString::trim(m_buf);
@@ -165,13 +198,13 @@ namespace xmltooling {
         const XMLCh* get() const {
             return m_buf;
         }
-        
+
         /**
          * Returns the wrapped buffer and transfers ownership of it to the caller.
          * @return a null-terminated Unicode string
          */
         XMLCh* release() {
-            XMLCh* temp=m_buf; m_buf=NULL; return temp;
+            XMLCh* temp=m_buf; m_buf=nullptr; return temp;
         }
 
     private:
@@ -218,7 +251,7 @@ namespace xmltooling {
          * @return the wrapped pointer
          */
         T* release() {
-            T* temp=m_ptr; m_ptr=NULL; return temp;
+            T* temp=m_ptr; m_ptr=nullptr; return temp;
         }
     };
 };