windows-nt/Source/XPSP1/NT/admin/display/proppage/cstr.h
2020-09-26 16:20:57 +08:00

608 lines
22 KiB
C++

// This is copied from the Microsoft Foundation Classes C++ library.
// Copyright (C) Microsoft Corporation, 1992 - 1999
// All rights reserved.
//
// This has been modified from the original MFC version to provide
// two classes: CStrW manipulates and stores only wide char strings,
// and CStr uses TCHARs.
//
#ifndef __STR_H__
#define __STR_H__
#include <wchar.h>
#include <tchar.h>
#define STRAPI __stdcall
struct _STR_DOUBLE { BYTE doubleBits[sizeof(double)]; };
BOOL STRAPI IsValidString(LPCSTR lpsz, int nLength);
BOOL STRAPI IsValidString(LPCWSTR lpsz, int nLength);
BOOL STRAPI IsValidAddressz(const void* lp, UINT nBytes, BOOL bReadWrite=TRUE);
int STRAPI StrLoadString(HINSTANCE hInst, UINT nID, LPTSTR lpszBuf);
int STRAPI StrLoadStringW(HINSTANCE hInst, UINT nID, LPWSTR lpszBuf);
class CStr
{
public:
// Constructors
CStr();
CStr(const CStr& stringSrc);
CStr(TCHAR ch, int nRepeat = 1);
CStr(LPCSTR lpsz);
CStr(LPCWSTR lpsz);
CStr(LPCTSTR lpch, int nLength);
CStr(const unsigned char* psz);
// Attributes & Operations
// as an array of characters
int GetLength() const;
BOOL IsEmpty() const;
void Empty(); // free up the data
TCHAR GetAt(int nIndex) const; // 0 based
TCHAR operator[](int nIndex) const; // same as GetAt
void SetAt(int nIndex, TCHAR ch);
operator LPCTSTR() const; // as a C string
// overloaded assignment
const CStr& operator=(const CStr& stringSrc);
const CStr& operator=(TCHAR ch);
#ifdef UNICODE
const CStr& operator=(char ch);
#endif
const CStr& operator=(LPCSTR lpsz);
const CStr& operator=(LPCWSTR lpsz);
const CStr& operator=(const unsigned char* psz);
// string concatenation
const CStr& operator+=(const CStr& string);
const CStr& operator+=(TCHAR ch);
#ifdef UNICODE
const CStr& operator+=(char ch);
#endif
const CStr& operator+=(LPCTSTR lpsz);
friend CStr STRAPI operator+(const CStr& string1,
const CStr& string2);
friend CStr STRAPI operator+(const CStr& string, TCHAR ch);
friend CStr STRAPI operator+(TCHAR ch, const CStr& string);
#ifdef UNICODE
friend CStr STRAPI operator+(const CStr& string, char ch);
friend CStr STRAPI operator+(char ch, const CStr& string);
#endif
friend CStr STRAPI operator+(const CStr& string, LPCTSTR lpsz);
friend CStr STRAPI operator+(LPCTSTR lpsz, const CStr& string);
// string comparison
int Compare(LPCTSTR lpsz) const; // straight character
int CompareNoCase(LPCTSTR lpsz) const; // ignore case
int Collate(LPCTSTR lpsz) const; // NLS aware
// simple sub-string extraction
CStr Mid(int nFirst, int nCount) const;
CStr Mid(int nFirst) const;
CStr Left(int nCount) const;
CStr Right(int nCount) const;
CStr SpanIncluding(LPCTSTR lpszCharSet) const;
CStr SpanExcluding(LPCTSTR lpszCharSet) const;
// upper/lower/reverse conversion
void MakeUpper();
void MakeLower();
void MakeReverse();
// trimming whitespace (either side)
void TrimRight();
void TrimLeft();
// searching (return starting index, or -1 if not found)
// look for a single character match
int Find(TCHAR ch) const; // like "C" strchr
int ReverseFind(TCHAR ch) const;
int FindOneOf(LPCTSTR lpszCharSet) const;
// look for a specific sub-string
int Find(LPCTSTR lpszSub) const; // like "C" strstr
// simple formatting
void Format(LPCTSTR lpszFormat, ...);
// Windows support
BOOL LoadString(HINSTANCE hInst, UINT nID); // load from string resource
// 255 chars max
#ifndef UNICODE
// ANSI <-> OEM support (convert string in place)
void AnsiToOem();
void OemToAnsi();
#endif
BSTR AllocSysString();
BSTR SetSysString(BSTR* pbstr);
// Access to string implementation buffer as "C" character array
LPTSTR GetBuffer(int nMinBufLength);
void ReleaseBuffer(int nNewLength = -1);
LPTSTR GetBufferSetLength(int nNewLength);
void FreeExtra();
// Implementation
public:
~CStr();
int GetAllocLength() const;
protected:
// lengths/sizes in characters
// (note: an extra character is always allocated)
LPTSTR m_pchData; // actual string (zero terminated)
int m_nDataLength; // does not include terminating 0
int m_nAllocLength; // does not include terminating 0
// implementation helpers
void Init();
void AllocCopy(CStr& dest, int nCopyLen, int nCopyIndex, int nExtraLen) const;
BOOL AllocBuffer(int nLen);
void AssignCopy(int nSrcLen, LPCTSTR lpszSrcData);
void ConcatCopy(int nSrc1Len, LPCTSTR lpszSrc1Data, int nSrc2Len, LPCTSTR lpszSrc2Data);
void ConcatInPlace(int nSrcLen, LPCTSTR lpszSrcData);
static void SafeDelete(LPTSTR& lpch);
static int SafeStrlen(LPCTSTR lpsz);
};
// Compare helpers
bool STRAPI operator==(const CStr& s1, const CStr& s2);
bool STRAPI operator==(const CStr& s1, LPCTSTR s2);
bool STRAPI operator==(LPCTSTR s1, const CStr& s2);
bool STRAPI operator!=(const CStr& s1, const CStr& s2);
bool STRAPI operator!=(const CStr& s1, LPCTSTR s2);
bool STRAPI operator!=(LPCTSTR s1, const CStr& s2);
bool STRAPI operator<(const CStr& s1, const CStr& s2);
bool STRAPI operator<(const CStr& s1, LPCTSTR s2);
bool STRAPI operator<(LPCTSTR s1, const CStr& s2);
bool STRAPI operator>(const CStr& s1, const CStr& s2);
bool STRAPI operator>(const CStr& s1, LPCTSTR s2);
bool STRAPI operator>(LPCTSTR s1, const CStr& s2);
bool STRAPI operator<=(const CStr& s1, const CStr& s2);
bool STRAPI operator<=(const CStr& s1, LPCTSTR s2);
bool STRAPI operator<=(LPCTSTR s1, const CStr& s2);
bool STRAPI operator>=(const CStr& s1, const CStr& s2);
bool STRAPI operator>=(const CStr& s1, LPCTSTR s2);
bool STRAPI operator>=(LPCTSTR s1, const CStr& s2);
// conversion helpers
int mmc_wcstombsz(char* mbstr, const wchar_t* wcstr, size_t count);
int mmc_mbstowcsz(wchar_t* wcstr, const char* mbstr, size_t count);
// Globals
extern const CStr strEmptyStringT;
extern TCHAR strChNilT;
// Compiler doesn't inline for DBG
/////////////////////////////////////////////////////////////////////////////
// Inline function declarations
inline int CStr::SafeStrlen(LPCTSTR lpsz)
{ return (int)((lpsz == NULL) ? NULL : _tcslen(lpsz)); }
inline CStr::CStr(const unsigned char* lpsz)
{ Init(); *this = (LPCSTR)lpsz; }
inline const CStr& CStr::operator=(const unsigned char* lpsz)
{ *this = (LPCSTR)lpsz; return *this; }
#ifdef _UNICODE
inline const CStr& CStr::operator+=(char ch)
{ *this += (TCHAR)ch; return *this; }
inline const CStr& CStr::operator=(char ch)
{ *this = (TCHAR)ch; return *this; }
inline CStr STRAPI operator+(const CStr& string, char ch)
{ return string + (TCHAR)ch; }
inline CStr STRAPI operator+(char ch, const CStr& string)
{ return (TCHAR)ch + string; }
#endif
inline int CStr::GetLength() const
{ return m_nDataLength; }
inline int CStr::GetAllocLength() const
{ return m_nAllocLength; }
inline BOOL CStr::IsEmpty() const
{ return m_nDataLength == 0; }
inline CStr::operator LPCTSTR() const
{ return (LPCTSTR)m_pchData; }
// String support (windows specific)
inline int CStr::Compare(LPCTSTR lpsz) const
{ return _tcscmp(m_pchData, lpsz); } // MBCS/Unicode aware
inline int CStr::CompareNoCase(LPCTSTR lpsz) const
{ return _tcsicmp(m_pchData, lpsz); } // MBCS/Unicode aware
// CStr::Collate is often slower than Compare but is MBSC/Unicode
// aware as well as locale-sensitive with respect to sort order.
inline int CStr::Collate(LPCTSTR lpsz) const
{ return _tcscoll(m_pchData, lpsz); } // locale sensitive
inline void CStr::MakeUpper()
{ ::CharUpper(m_pchData); }
inline void CStr::MakeLower()
{ ::CharLower(m_pchData); }
inline void CStr::MakeReverse()
{ _tcsrev(m_pchData); }
inline TCHAR CStr::GetAt(int nIndex) const
{
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
return m_pchData[nIndex];
}
inline TCHAR CStr::operator[](int nIndex) const
{
// same as GetAt
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
return m_pchData[nIndex];
}
inline void CStr::SetAt(int nIndex, TCHAR ch)
{
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
dspAssert(ch != 0);
m_pchData[nIndex] = ch;
}
inline bool STRAPI operator==(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) == 0; }
inline bool STRAPI operator==(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) == 0; }
inline bool STRAPI operator==(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) == 0; }
inline bool STRAPI operator!=(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) != 0; }
inline bool STRAPI operator!=(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) != 0; }
inline bool STRAPI operator!=(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) != 0; }
inline bool STRAPI operator<(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) < 0; }
inline bool STRAPI operator<(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) < 0; }
inline bool STRAPI operator<(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) > 0; }
inline bool STRAPI operator>(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) > 0; }
inline bool STRAPI operator>(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) > 0; }
inline bool STRAPI operator>(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) < 0; }
inline bool STRAPI operator<=(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) <= 0; }
inline bool STRAPI operator<=(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) <= 0; }
inline bool STRAPI operator<=(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) >= 0; }
inline bool STRAPI operator>=(const CStr& s1, const CStr& s2)
{ return s1.Compare(s2) >= 0; }
inline bool STRAPI operator>=(const CStr& s1, LPCTSTR s2)
{ return s1.Compare(s2) >= 0; }
inline bool STRAPI operator>=(LPCTSTR s1, const CStr& s2)
{ return s2.Compare(s1) <= 0; }
#ifndef UNICODE
inline void CStr::AnsiToOem()
{ ::AnsiToOem(m_pchData, m_pchData); }
inline void CStr::OemToAnsi()
{ ::OemToAnsi(m_pchData, m_pchData); }
#endif // UNICODE
// General Exception for memory
class MemoryException
{
public:
MemoryException(){}
void DisplayMessage()
{
::MessageBox(NULL, _T("Memory Exception"), _T("System Out of Memory"), MB_OK|MB_ICONSTOP);
}
};
// General Exception for memory
class ResourceException
{
public:
ResourceException()
{
::MessageBox(NULL, _T("Resource Exception"), _T("Unable to Load Resource"), MB_OK|MB_ICONSTOP);
}
};
class CStrW
{
public:
// Constructors
CStrW();
CStrW(const CStrW& stringSrc);
CStrW(WCHAR ch, int nRepeat = 1);
CStrW(LPCSTR lpsz);
CStrW(LPCWSTR lpsz);
CStrW(LPCWSTR lpch, int nLength);
CStrW(const unsigned char* psz);
// Attributes & Operations
// as an array of characters
int GetLength() const;
BOOL IsEmpty() const;
void Empty(); // free up the data
WCHAR GetAt(int nIndex) const; // 0 based
WCHAR operator[](int nIndex) const; // same as GetAt
void SetAt(int nIndex, WCHAR ch);
operator LPCWSTR() const; // as a C string
operator PWSTR(); // as a C string
// overloaded assignment
const CStrW& operator=(const CStrW& stringSrc);
const CStrW& operator=(WCHAR ch);
#ifdef UNICODE
const CStrW& operator=(char ch);
#endif
const CStrW& operator=(LPCSTR lpsz);
const CStrW& operator=(LPCWSTR lpsz);
const CStrW& operator=(const unsigned char* psz);
const CStrW& operator=(UNICODE_STRING unistr);
const CStrW& operator=(UNICODE_STRING * punistr);
// string concatenation
const CStrW& operator+=(const CStrW& string);
const CStrW& operator+=(WCHAR ch);
#ifdef UNICODE
const CStrW& operator+=(char ch);
#endif
const CStrW& operator+=(LPCWSTR lpsz);
friend CStrW STRAPI operator+(const CStrW& string1,
const CStrW& string2);
friend CStrW STRAPI operator+(const CStrW& string, WCHAR ch);
friend CStrW STRAPI operator+(WCHAR ch, const CStrW& string);
#ifdef UNICODE
friend CStrW STRAPI operator+(const CStrW& string, char ch);
friend CStrW STRAPI operator+(char ch, const CStrW& string);
#endif
friend CStrW STRAPI operator+(const CStrW& string, LPCWSTR lpsz);
friend CStrW STRAPI operator+(LPCWSTR lpsz, const CStrW& string);
// string comparison
int Compare(LPCWSTR lpsz) const; // straight character
int CompareNoCase(LPCWSTR lpsz) const; // ignore case
int Collate(LPCWSTR lpsz) const; // NLS aware
// simple sub-string extraction
CStrW Mid(int nFirst, int nCount) const;
CStrW Mid(int nFirst) const;
CStrW Left(int nCount) const;
CStrW Right(int nCount) const;
CStrW SpanIncluding(LPCWSTR lpszCharSet) const;
CStrW SpanExcluding(LPCWSTR lpszCharSet) const;
// upper/lower/reverse conversion
void MakeUpper();
void MakeLower();
void MakeReverse();
// trimming whitespace (either side)
void TrimRight();
void TrimLeft();
// searching (return starting index, or -1 if not found)
// look for a single character match
int Find(WCHAR ch) const; // like "C" strchr
int ReverseFind(WCHAR ch) const;
int FindOneOf(LPCWSTR lpszCharSet) const;
// look for a specific sub-string
int Find(LPCWSTR lpszSub) const; // like "C" strstr
// simple formatting
void Format(LPCWSTR lpszFormat, ...);
// formatting for localization (uses FormatMessage API)
// format using FormatMessage API on passed string
void FormatMessage(PCWSTR pwzFormat, ...);
// format using FormatMessage API on referenced string resource
void FormatMessage(HINSTANCE hInst, UINT nFormatID, ...);
// Windows support
BOOL LoadString(HINSTANCE hInst, UINT nID); // load from string resource
// 255 chars max
BSTR AllocSysString();
BSTR SetSysString(BSTR* pbstr);
// Access to string implementation buffer as "C" character array
PWSTR GetBuffer(int nMinBufLength);
void ReleaseBuffer(int nNewLength = -1);
PWSTR GetBufferSetLength(int nNewLength);
void FreeExtra();
// Implementation
public:
~CStrW();
int GetAllocLength() const;
protected:
// lengths/sizes in characters
// (note: an extra character is always allocated)
PWSTR m_pchData; // actual string (zero terminated)
int m_nDataLength; // does not include terminating 0
int m_nAllocLength; // does not include terminating 0
// implementation helpers
void Init();
void AllocCopy(CStrW& dest, int nCopyLen, int nCopyIndex, int nExtraLen) const;
BOOL AllocBuffer(int nLen);
void AssignCopy(int nSrcLen, LPCWSTR lpszSrcData);
void ConcatCopy(int nSrc1Len, LPCWSTR lpszSrc1Data, int nSrc2Len, LPCWSTR lpszSrc2Data);
void ConcatInPlace(int nSrcLen, LPCWSTR lpszSrcData);
static void SafeDelete(PWSTR& lpch);
static int SafeStrlen(LPCWSTR lpsz);
};
// Compare helpers
bool STRAPI operator==(const CStrW& s1, const CStrW& s2);
bool STRAPI operator==(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator==(LPCWSTR s1, const CStrW& s2);
bool STRAPI operator!=(const CStrW& s1, const CStrW& s2);
bool STRAPI operator!=(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator!=(LPCWSTR s1, const CStrW& s2);
bool STRAPI operator<(const CStrW& s1, const CStrW& s2);
bool STRAPI operator<(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator<(LPCWSTR s1, const CStrW& s2);
bool STRAPI operator>(const CStrW& s1, const CStrW& s2);
bool STRAPI operator>(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator>(LPCWSTR s1, const CStrW& s2);
bool STRAPI operator<=(const CStrW& s1, const CStrW& s2);
bool STRAPI operator<=(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator<=(LPCWSTR s1, const CStrW& s2);
bool STRAPI operator>=(const CStrW& s1, const CStrW& s2);
bool STRAPI operator>=(const CStrW& s1, LPCWSTR s2);
bool STRAPI operator>=(LPCWSTR s1, const CStrW& s2);
// conversion helpers
int mmc_wcstombsz(char* mbstr, const wchar_t* wcstr, size_t count);
int mmc_mbstowcsz(wchar_t* wcstr, const char* mbstr, size_t count);
// Globals
extern const CStrW strEmptyStringW;
extern WCHAR strChNilW;
// Compiler doesn't inline for DBG
/////////////////////////////////////////////////////////////////////////////
// Inline function declarations
inline int CStrW::SafeStrlen(LPCWSTR lpsz)
{ return (int)((lpsz == NULL) ? NULL : wcslen(lpsz)); }
inline CStrW::CStrW(const unsigned char* lpsz)
{ Init(); *this = (LPCSTR)lpsz; }
inline const CStrW& CStrW::operator=(const unsigned char* lpsz)
{ *this = (LPCSTR)lpsz; return *this; }
#ifdef _UNICODE
inline const CStrW& CStrW::operator+=(char ch)
{ *this += (WCHAR)ch; return *this; }
inline const CStrW& CStrW::operator=(char ch)
{ *this = (WCHAR)ch; return *this; }
inline CStrW STRAPI operator+(const CStrW& string, char ch)
{ return string + (WCHAR)ch; }
inline CStrW STRAPI operator+(char ch, const CStrW& string)
{ return (WCHAR)ch + string; }
#endif
inline int CStrW::GetLength() const
{ return m_nDataLength; }
inline int CStrW::GetAllocLength() const
{ return m_nAllocLength; }
inline BOOL CStrW::IsEmpty() const
{ return m_nDataLength == 0; }
inline CStrW::operator LPCWSTR() const
{ return (LPCWSTR)m_pchData; }
inline CStrW::operator PWSTR()
{ return m_pchData; }
// String support (windows specific)
inline int CStrW::Compare(LPCWSTR lpsz) const
{ return wcscmp(m_pchData, lpsz); } // MBCS/Unicode aware
inline int CStrW::CompareNoCase(LPCWSTR lpsz) const
{ return _wcsicmp(m_pchData, lpsz); } // MBCS/Unicode aware
// CStrW::Collate is often slower than Compare but is MBSC/Unicode
// aware as well as locale-sensitive with respect to sort order.
inline int CStrW::Collate(LPCWSTR lpsz) const
{ return wcscoll(m_pchData, lpsz); } // locale sensitive
inline void CStrW::MakeUpper()
{ ::CharUpperW(m_pchData); }
inline void CStrW::MakeLower()
{ ::CharLowerW(m_pchData); }
inline void CStrW::MakeReverse()
{ wcsrev(m_pchData); }
inline WCHAR CStrW::GetAt(int nIndex) const
{
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
return m_pchData[nIndex];
}
inline WCHAR CStrW::operator[](int nIndex) const
{
// same as GetAt
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
return m_pchData[nIndex];
}
inline void CStrW::SetAt(int nIndex, WCHAR ch)
{
dspAssert(nIndex >= 0);
dspAssert(nIndex < m_nDataLength);
dspAssert(ch != 0);
m_pchData[nIndex] = ch;
}
inline bool STRAPI operator==(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) == 0; }
inline bool STRAPI operator==(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) == 0; }
inline bool STRAPI operator==(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) == 0; }
inline bool STRAPI operator!=(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) != 0; }
inline bool STRAPI operator!=(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) != 0; }
inline bool STRAPI operator!=(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) != 0; }
inline bool STRAPI operator<(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) < 0; }
inline bool STRAPI operator<(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) < 0; }
inline bool STRAPI operator<(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) > 0; }
inline bool STRAPI operator>(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) > 0; }
inline bool STRAPI operator>(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) > 0; }
inline bool STRAPI operator>(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) < 0; }
inline bool STRAPI operator<=(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) <= 0; }
inline bool STRAPI operator<=(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) <= 0; }
inline bool STRAPI operator<=(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) >= 0; }
inline bool STRAPI operator>=(const CStrW& s1, const CStrW& s2)
{ return s1.Compare(s2) >= 0; }
inline bool STRAPI operator>=(const CStrW& s1, LPCWSTR s2)
{ return s1.Compare(s2) >= 0; }
inline bool STRAPI operator>=(LPCWSTR s1, const CStrW& s2)
{ return s2.Compare(s1) <= 0; }
//
// Added by JonN 4/16/98
//
class CStrListItem
{
public:
CStr str;
CStrListItem* pnext;
};
void FreeCStrList( IN OUT CStrListItem** ppList );
void CStrListAdd( IN OUT CStrListItem** ppList, IN LPCTSTR lpsz );
bool CStrListContains( IN CStrListItem** ppList, IN LPCTSTR lpsz );
int CountCStrList( IN CStrListItem** ppList );
#endif // __STR_H__
/////////////////////////////////////////////////////////////////////////////