/*
- * Copyright 2001-2006 Internet2
- *
+ * Copyright 2001-2009 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
*/
/**
- * @file unicode.h
- *
+ * @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>
-using namespace xercesc;
-
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
- * @return a UTF-8 string allocated by the Xerces memory manager
+ *
+ * @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
*/
- extern XMLTOOL_API char* toUTF8(const XMLCh* src);
+ 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
- * @return a 16-bit Unicode string allocated by the Xerces memory manager
+ *
+ * @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
+ */
+ 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
+ */
+ 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 XMLCh* fromUTF8(const char* src);
+ 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(NULL) {
+ }
+
+ /**
* 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(XMLString::transcode(src)) {if (trim && m_buf) XMLString::trim(m_buf);}
+ auto_ptr_char(const XMLCh* src, bool trim=true) : m_buf(xercesc::XMLString::transcode(src)) {
+ if (trim && m_buf) xercesc::XMLString::trim(m_buf);
+ }
/**
* 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(XMLString::replicate(src)) {if (trim && m_buf) XMLString::trim(m_buf);}
+ auto_ptr_char(const char* src, bool trim=true) : m_buf(xercesc::XMLString::replicate(src)) {
+ if (trim && m_buf) xercesc::XMLString::trim(m_buf);
+ }
/**
* Destructor frees the wrapped buffer using the Xerces memory manager.
*/
- ~auto_ptr_char() { XMLString::release(&m_buf); }
+ ~auto_ptr_char() {
+ xercesc::XMLString::release(&m_buf);
+ }
/**
* Returns the wrapped buffer.
* @return a null-terminated local code page string
*/
- const char* get() const { return m_buf; }
+ const char* get() const {
+ return m_buf;
+ }
/**
* Returns the wrapped buffer and transfers ownership of it to the caller.
* @return a null-terminated local code page string
*/
- char* release() { char* temp=m_buf; m_buf=NULL; return temp; }
+ char* release() {
+ char* temp=m_buf; m_buf=NULL; return temp;
+ }
- private:
+ private:
char* m_buf;
- MAKE_NONCOPYABLE(auto_ptr_char);
};
/**
* 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(NULL) {
+ }
+
+ /**
* 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(XMLString::transcode(src)) {if (trim && m_buf) XMLString::trim(m_buf);}
+ auto_ptr_XMLCh(const char* src, bool trim=true) : m_buf(xercesc::XMLString::transcode(src)) {
+ if (trim && m_buf) xercesc::XMLString::trim(m_buf);
+ }
/**
* 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(XMLString::replicate(src)) {if (trim && m_buf) XMLString::trim(m_buf);}
+ auto_ptr_XMLCh(const XMLCh* src, bool trim=true) : m_buf(xercesc::XMLString::replicate(src)) {
+ if (trim && m_buf) xercesc::XMLString::trim(m_buf);
+ }
/**
* Destructor frees the wrapped buffer using the Xerces memory manager.
*/
- ~auto_ptr_XMLCh() { XMLString::release(&m_buf); }
+ ~auto_ptr_XMLCh() {
+ xercesc::XMLString::release(&m_buf);
+ }
/**
* Returns the wrapped buffer.
* @return a null-terminated Unicode string
*/
- const XMLCh* get() const { return m_buf; }
-
+ 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* release() {
+ XMLCh* temp=m_buf; m_buf=NULL; return temp;
+ }
private:
XMLCh* m_buf;
- MAKE_NONCOPYABLE(auto_ptr_XMLCh);
};
+ /**
+ * An auto_ptr that uses array delete on its contents.
+ *
+ * @param T type of pointer to wrap
+ */
+ template <typename T> class auto_arrayptr
+ {
+ T* m_ptr;
+
+ auto_arrayptr(const auto_arrayptr<T>&);
+ auto_arrayptr<T>& operator=(const auto_arrayptr<T>&);
+ public:
+ /**
+ * Constructor.
+ *
+ * @param ptr pointer to wrap
+ */
+ auto_arrayptr(T* ptr) : m_ptr(ptr) {
+ }
+
+ /**
+ * Destructor, uses array delete operation on wrapped pointer.
+ */
+ ~auto_arrayptr() {
+ delete[] m_ptr;
+ }
+
+ /**
+ * Returns the wrapped pointer.
+ * @return the wrapped pointer
+ */
+ const T* get() const {
+ return m_ptr;
+ }
+
+ /**
+ * Returns the wrapped pointer and transfers ownership of it to the caller.
+ * @return the wrapped pointer
+ */
+ T* release() {
+ T* temp=m_ptr; m_ptr=NULL; return temp;
+ }
+ };
};
#endif /* __xmltooling_unicode_h__ */