string.h revision c829b606c5535f37e00ffee381cca0815a57f319
/* $Id$ */
/** @file
* MS COM / XPCOM Abstraction Layer:
* Smart string classes declaration
*/
/*
* Copyright (C) 2006-2009 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___VBox_com_string_h
#define ___VBox_com_string_h
/* Make sure all the stdint.h macros are included - must come first! */
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
#if defined (VBOX_WITH_XPCOM)
# include <nsMemory.h>
#endif
{
/**
* Helper class that represents the |BSTR| type and hides platform-specific
* implementation details.
*
* This class uses COM/XPCOM-provided memory management routines to allocate
* and free string buffers. This makes it possible to:
* their values to callers through component methods' output parameters
* using the #cloneTo() operation;
* - adopt (take ownership of) string buffers returned in output parameters
* of COM methods using the #asOutParam() operation and correctly free them
* afterwards.
*/
{
typedef CBSTR ConstString;
#if defined (VBOX_WITH_XPCOM)
{
}
#endif
/** Shortcut that calls #alloc(aSize) right after object creation. */
{
if (bstr)
{
::SysFreeString(bstr);
}
return *this;
}
{
{
::SysFreeString(bstr);
}
return *this;
}
/**
* Allocates memory for a string capable to store \a aSize - 1 characters;
* in other words, aSize includes the terminating zero character. If \a aSize
* is zero, or if a memory allocation error occurs, this object will become null.
*/
{
setNull();
if (aSize)
{
if (bstr)
bstr[0] = 0;
}
return *this;
}
{
}
{
}
#if defined (VBOX_WITH_XPCOM)
{
}
{
}
#endif
#if defined (VBOX_WITH_XPCOM)
{
}
#endif
{
}
/** Intended to to pass instances as |CBSTR| input parameters to methods. */
/**
* Intended to to pass instances as |BSTR| input parameters to methods.
* Note that we have to provide this mutable BSTR operator since in MS COM
* input BSTR parameters of interface methods are not const.
*/
/**
* The same as operator CBSTR(), but for situations where the compiler
* cannot typecast implicitly (for example, in printf() argument list).
*/
/**
* Returns a non-const raw pointer that allows to modify the string directly.
* @warning
* Be sure not to modify data beyond the allocated memory! The
* guaranteed size of the allocated memory is at least #length()
* bytes after creation and after every assignment operation.
*/
/**
* Intended to assign copies of instances to |BSTR| out parameters from
* within the interface method. Transfers the ownership of the duplicated
* string to the caller.
*/
{
if (pstr)
{
}
return *this;
}
/**
* Intended to assign instances to |BSTR| out parameters from within the
* interface method. Transfers the ownership of the original string to the
* caller and resets the instance to null.
*
* As opposed to cloneTo(), this method doesn't create a copy of the
* string.
*/
{
return *this;
}
/**
* Intended to assign copies of instances to |char *| out parameters from
* within the interface method. Transfers the ownership of the duplicated
* string to the caller.
*/
/**
* Intended to pass instances as |BSTR| out parameters to methods.
* Takes the ownership of the returned data.
*/
/**
* Static immutable null object. May be used for comparison purposes.
*/
{
{
setNull();
}
}
{
if (rs)
}
{
if (rs)
{
::RTStrToUtf16(rs, &s);
::RTUtf16Free(s);
}
}
};
/* symmetric compare operators */
////////////////////////////////////////////////////////////////////////////////
/**
* Helper class that represents UTF8 (|char *|) strings. Useful in
* conjunction with Bstr to simplify conversions between UTF16 (|BSTR|)
* and UTF8.
*
* This class uses COM/XPCOM-provided memory management routines to allocate
* and free string buffers. This makes it possible to:
* their values to callers through component methods' output parameters
* using the #cloneTo() operation;
* - adopt (take ownership of) string buffers returned in output parameters
* of COM methods using the #asOutParam() operation and correctly free them
* afterwards.
*/
{
Utf8Str() {}
: MiniString(that)
{}
: MiniString(that)
{}
{
}
{
}
{
return *this;
}
{
return *this;
}
{
cleanup();
return *this;
}
{
cleanup();
return *this;
}
/**
* Intended to assign instances to |char *| out parameters from within the
* interface method. Transfers the ownership of the duplicated string to the
* caller.
*
* @remarks The returned string must be freed by RTStrFree, not RTMemFree.
*/
{
if (pstr) /** @todo r=bird: This needs to if m_psz is NULL. Shouldn't it also throw std::bad_alloc? */
return *this;
}
/**
* Intended to assign instances to |char *| out parameters from within the
* interface method. Transfers the ownership of the original string to the
* caller and resets the instance to null.
*
* As opposed to cloneTo(), this method doesn't create a copy of the
* string.
*/
{
m_cbAllocated = 0;
m_cbLength = 0;
return *this;
}
/**
* Intended to assign instances to |BSTR| out parameters from within the
* interface method. Transfers the ownership of the duplicated string to the
* caller.
*/
{
if (pstr)
{
}
return *this;
}
/**
* Converts "this" to lower case by calling RTStrToLower().
* @return
*/
/**
* Converts "this" to upper case by calling RTStrToUpper().
* @return
*/
/**
* Removes a trailing slash from the member string, if present.
* Calls RTPathStripTrailingSlash() without having to mess with mutableRaw().
*/
void stripTrailingSlash();
/**
* Removes a trailing filename from the member string, if present.
* Calls RTPathStripFilename() without having to mess with mutableRaw().
*/
void stripFilename();
/**
* Removes a trailing file name extension from the member string, if present.
* Calls RTPathStripExt() without having to mess with mutableRaw().
*/
void stripExt();
/**
* Attempts to convert the member string into a 32-bit integer.
*
* @returns 32-bit unsigned number on success.
* @returns 0 on failure.
*/
int toInt32() const
{
return RTStrToInt32(m_psz);
}
/**
* Attempts to convert the member string into an unsigned 32-bit integer.
*
* @returns 32-bit unsigned number on success.
* @returns 0 on failure.
*/
int toUInt32() const
{
return RTStrToUInt32(m_psz);
}
/**
* Intended to pass instances as out (|char **|) parameters to methods. Takes
* the ownership of the returned data.
*
* @remarks See ministring::jolt().
*/
char **asOutParam()
{
cleanup();
return &m_psz;
}
/**
* Static immutable null object. May be used for comparison purposes.
*/
/**
* As with the ministring::copyFrom() variants, this unconditionally
* sets the members to a copy of the given other strings and makes
* no assumptions about previous contents. This can therefore be used
* both in copy constructors, when member variables have no defined
* value, and in assignments after having called cleanup().
*
* This variant converts from a UTF-16 string, most probably from
* a Bstr assignment.
*
* @param rs
*/
{
if (s)
{
RTUtf16ToUtf8((PRTUTF16)s, &m_psz); /** @todo r=bird: This isn't throwing std::bad_alloc / handling return codes.
* Also, this technically requires using RTStrFree, ministring::cleanup() uses RTMemFree. */
}
else
{
m_cbLength = 0;
m_cbAllocated = 0;
}
}
};
// work around error C2593 of the stupid MSVC 7.x ambiguity resolver
////////////////////////////////////////////////////////////////////////////////
// inlined Bstr members that depend on Utf8Str
{
}
{
}
{
setNull();
return *this;
}
{
setNull();
return *this;
}
{
if (pstr)
{
}
return *this;
}
////////////////////////////////////////////////////////////////////////////////
/**
* This class is a printf-like formatter for Utf8Str strings. Its purpose is
* to construct Utf8Str objects from a format string and a list of arguments
* for the format string.
*
* The usage of this class is like the following:
* <code>
* Utf8StrFmt string ("program name = %s", argv[0]);
* </code>
*/
{
/**
* Constructs a new string given the format string and the list
* of the arguments for the format string.
*
* @param format printf-like format string (in UTF-8 encoding)
* @param ... list of the arguments for the format string
*/
{
}
Utf8StrFmt() {}
};
/**
* This class is a vprintf-like formatter for Utf8Str strings. It is
* identical to Utf8StrFmt except that its constructor takes a va_list
* argument instead of ellipsis.
*
* Note that a separate class is necessary because va_list is defined as
* |char *| on most platforms. For this reason, if we had two overloaded
* constructors in Utf8StrFmt (one taking ellipsis and another one taking
* va_list) then composing a constructor call using exactly two |char *|
* arguments would cause the compiler to use the va_list overload instead of
* the ellipsis one which is obviously wrong. The compiler would choose
* va_list because ellipsis has the lowest rank when it comes to resolving
* overloads, as opposed to va_list which is an exact match for |char *|.
*/
{
/**
* Constructs a new string given the format string and the list
* of the arguments for the format string.
*
* @param format printf-like format string (in UTF-8 encoding)
* @param args list of arguments for the format string
*/
};
/**
* The BstrFmt class is a shortcut to <tt>Bstr(Utf8StrFmt(...))</tt>.
*/
{
/**
* Constructs a new string given the format string and the list of the
* arguments for the format string.
*
* @param aFormat printf-like format string (in UTF-8 encoding).
* @param ... List of the arguments for the format string.
*/
{
}
};
/**
* The BstrFmtVA class is a shortcut to <tt>Bstr(Utf8StrFmtVA(...))</tt>.
*/
{
/**
* Constructs a new string given the format string and the list of the
* arguments for the format string.
*
* @param aFormat printf-like format string (in UTF-8 encoding).
* @param aArgs List of arguments for the format string
*/
{
}
};
} /* namespace com */
#endif /* !___VBox_com_string_h */