C++ Programmer's Cookbook

C++字符串完全指引之二 —— 字符串封裝類


原著：Michael Dunn

作者：Chengjie Sun

原文出處：CodeProject：The Complete Guide to C++ Strings, Part II



引言

　　因為C語言風格的字符串容易出錯且不易管理，黑客們甚至利用可能存在的緩沖區溢出bug把C語言風格的字符串作為攻擊目標，所以出現了很多字符串封裝類。不幸的是，在某些場合下我們不知道該使用哪個字符串類，也不知道怎樣把一個C風格的字符串轉換成一個字符串封裝類。
　　這篇文章將介紹所有在Win32 API, MFC, STL, WTL 和 Visual C++ 運行庫中出現的字符串類型。我將描述每一個類的用法，告訴大家怎樣創建每一個類的對象以及怎樣把一個類轉換成其他類。受控字符串和Visual C++ 7中的類兩部分是Nish完成的。
　　為了更好的從這篇文章中受益，你必須要明白不同的字符類型和編碼，這些內容我在第一部分中介紹過。

Rule #1 of string classes

　　使用cast來實現類型轉換是不好的做法，除非有文檔明確指出這種轉換可以使用。
促使我寫這兩篇文章的原因是字符串類型轉換中經常遇到的一些問題。當我們使用cast把字符串從類型X轉換到類型Z的時候，我們不知道為什么代碼不能正常工作。各種各樣的字符串類型，尤其是BSTR，幾乎沒有在任何一個地方的文檔中被明確的指出可以用cast來實現類型轉換。所以我想一些人可能會使用cast來實現類型轉換并希望這種轉換能夠正常工作。
　　除非源字符串是一個被明確指明支持轉換操作符的字符串包裝類，否則cast不對字符串做任何轉換。對常量字符串使用cast不會起到任何作用，所以下面的代碼：

void SomeFunc ( LPCWSTR widestr );
main()
{
  SomeFunc ( (LPCWSTR) "C:\\foo.txt" );  // WRONG!
}      

C-style strings and typedefs

　　正如我在第一部分中提到的，windows APIs 是用TCHARs來定義的，在編譯時，它可以根據你是否定義_MBCS或者_UNICODE被編譯成MBCS或者Unicode字符。你可以參看第一部分中對TCHAR的完整描述，這里為了方便，我列出了字符的typedefs

　　一個增加的字符類型是OLETYPE。它表示自動化接口（如word提供的可以使你操作文檔的接口）中使用的字符類型。這種類型一般被定義成wchar_t，然而如果你定義了OLE2ANSI預處理標記，OLECHAR將會被定義成char類型。我知道現在已經沒有理由定義OLE2ANSI（從MFC3以后，微軟已經不使用它了），所以從現在起我將把OLECHAR當作Unicode字符。
這里給出你將會看到的一些OLECHAR相關的typedefs：

　　還有兩個用于包圍字符串和字符常量的宏定義，它們可以使同樣的代碼被用于MBCS和Unicode builds ：

　　在文檔或例程中，你還會看到好多_T的變體。有四個等價的宏定義，它們是TEXT, _TEXT, __TEXT和__T，它們都起同樣的做用。

COM 中的字符串 —— BSTR 和 VARIANT

　　很多自動化和COM接口使用BSTR來定義字符串。BSTRs中有幾個"陷阱"，所以這里我用單獨的部分來說明它。
　　BSTR 是 Pascal-style 字符串（字符串長度被明確指出）和C-style字符串（字符串的長度要通過尋找結束符來計算）的混合產物。一個BSTR是一個Unicode字符串，它的長度是預先考慮的，并且它還有一個0字符作為結束標記。下面是一個BSTR的示例：

　

　　注意字符串的長度是如何被加到字符串數據中的。長度是DWORD類型的，保存了字符串中包含的字節數，但不包括結束標記。在這個例子中，"Bob"包含3個Unicode字符（不包括結束符），總共6個字節。字符串的長度被預先存儲好，以便當一個BSTR在進程或者計算機之間被傳遞時，COM庫知道多少數據需要傳送。（另一方面，一個BSTR能夠存儲任意數據塊，而不僅僅是字符，它還可以包含嵌入在數據中的0字符。然而，由于這篇文章的目的，我將不考慮那些情況）。
　　在 C++ 中，一個 BSTR 實際上就是一個指向字符串中第一個字符的指針。它的定義如下：

BSTR bstr = NULL;
  bstr = SysAllocString ( L"Hi Bob!" ); 
  if ( NULL == bstr )
    // out of memory error 
  // Use bstr here...
 SysFreeString ( bstr );      

// Constructing
_bstr_t bs1 = "char string";       // construct from a LPCSTR
_bstr_t bs2 = L"wide char string"; // construct from a LPCWSTR
_bstr_t bs3 = bs1;                 // copy from another _bstr_t
_variant_t v = "Bob";
_bstr_t bs4 = v;                   // construct from a _variant_t that has a string
 
// Extracting data
LPCSTR psz1 = bs1;              // automatically converts to MBCS string
LPCSTR psz2 = (LPCSTR) bs1;     // cast OK, same as previous line
LPCWSTR pwsz1 = bs1;            // returns the internal Unicode string
LPCWSTR pwsz2 = (LPCWSTR) bs1;  // cast OK, same as previous line
BSTR    bstr = bs1.copy();      // copies bs1, returns it as a BSTR
 
  // ...
SysFreeString ( bstr );      

// Constructing
_variant_t v1 = "char string";       // construct from a LPCSTR
_variant_t v2 = L"wide char string"; // construct from a LPCWSTR
_bstr_t bs1 = "Bob";
_variant_t v3 = bs1;                 // copy from a _bstr_t object
 
// Extracting data
_bstr_t bs2 = v1;           // extract BSTR from the VARIANT
_bstr_t bs3 = (_bstr_t) v1; // cast OK, same as previous line      

// Specializations
typedef basic_string tstring; // string of TCHARs
 
// Constructing
string str = "char string";         // construct from a LPCSTR
wstring wstr = L"wide char string"; // construct from a LPCWSTR
tstring tstr = _T("TCHAR string");  // construct from a LPCTSTR
 
// Extracting data
LPCSTR psz = str.c_str();    // read-only pointer to str''s buffer
LPCWSTR pwsz = wstr.c_str(); // read-only pointer to wstr''s buffer
LPCTSTR ptsz = tstr.c_str(); // read-only pointer to tstr''s buffer

// Example, construct _bstr_t from basic_string
_bstr_t bs1 = str.c_str();  // construct a _bstr_t from a LPCSTR
_bstr_t bs2 = wstr.c_str(); // construct a _bstr_t from a LPCWSTR      

// Sample interface:
struct IStuff : public IUnknown
{
  // Boilerplate COM stuff omitted...
  STDMETHOD(SetText)(BSTR bsText);
  STDMETHOD(GetText)(BSTR* pbsText);
};      

CComBSTR bs1;
CComBSTR bs2 = "new text";
 
  pStuff->GetText ( &bs1 );       // ok, takes address of internal BSTR
  pStuff->SetText ( bs2 );        // ok, calls BSTR converter
  pStuff->SetText ( (BSTR) bs2 ); // cast ok, same as previous line      

// Constructing
CComBSTR bs1 = "char string";       // construct from a LPCSTR
CComBSTR bs2 = L"wide char string"; // construct from a LPCWSTR
CComBSTR bs3 = bs1;                 // copy from another CComBSTR
CComBSTR bs4;

  bs4.LoadString ( IDS_SOME_STR );  // load string from string table
// Extracting data
BSTR bstr1 = bs1;        // returns internal BSTR, but don''t modify it!
BSTR bstr2 = (BSTR) bs1; // cast ok, same as previous line
BSTR bstr3 = bs1.Copy(); // copies bs1, returns it as a BSTR
BSTR bstr4;
  bstr4 = bs1.Detach();  // bs1 no longer manages its BSTR
  // ...
  SysFreeString ( bstr3 );
  SysFreeString ( bstr4 );      

std::list< CAdapt > bstr_list;

　　CAdapt提供容器所需要的操作符，但這些操作符對你的代碼是透明的。你可以把一個bstr_list當作一個CComBSTR的list來使用。

CComVariant
　　CComVariant是VARIANT的封裝類。然而，不像_variant_t，在CComVariant中VARIANT沒有被隱藏。事實上你需要直接訪問VARIANT的成員。CComVariant提供了很多構造函數來對VARIANT能夠包含的多種類型進行處理。這里，我將只介紹和字符串相關的操作。

// Constructing
CComVariant v1 = "char string";       // construct from a LPCSTR
CComVariant v2 = L"wide char string"; // construct from a LPCWSTR
CComBSTR bs1 = "BSTR bob";
CComVariant v3 = (BSTR) bs1;          // copy from a BSTR
 
// Extracting data
CComBSTR bs2 = v1.bstrVal;            // extract BSTR from the VARIANT      

CComVariant v4 = ... // Init v4 from somewhere
CComBSTR bs3;
 
  if ( SUCCEEDED( v4.ChangeType ( VT_BSTR ) ))
    bs3 = v4.bstrVal;      

ATL轉換宏

　　ATL：轉換宏是各種字符編碼之間進行轉換的一種很方便的方式，在函數調用時，它們顯得非常有用。ATL轉換宏的名稱是根據下面的模式來命名的[源類型]2[新類型]或者[源類型]2C[新類型]。據有第二種形式的名字的宏的轉換結果是常量指針（對應名字中的"C"）。各種類型的簡稱如下：

A: MBCS string, char* (A for ANSI)
W: Unicode string, wchar_t* (W for wide)
T: TCHAR string, TCHAR*
OLE: OLECHAR string, OLECHAR* (in practice, equivalent to W)
BSTR: BSTR (used as the destination type only)

　　所以，W2A()宏把一個Unicode字符串轉換成一個MBCS字符串。T2CW()宏把一個TCHAR字符串轉轉成一個Unicode字符串常量。
　　為了使用這些宏，需要先包含atlconv.h頭文件。你甚至可以在非ATL工程中包含這個頭文件來使用其中定義的宏，因為這個頭文件獨立于ATL中的其他部分，不需要一個_Module全局變量。當你在一個函數中使用轉換宏時，需要把USES_CONVERSION宏放在函數的開頭。它定義了轉換宏所需的一些局部變量。
　　當轉換的目的類型是除了BSTR以外的其他類型時，被轉換的字符串是存在棧中的。所以，如果你想讓字符串的生命周期比當前的函數長，你需要把這個字符串拷貝到其他的字符串類中。當目的類型是BSTR時，內存不會自動被釋放，你必須把返回值賦給一個BSTR變量或者一個BSTR封裝類以避免內存泄漏。
　　下面是一些各種轉換宏的使用例子：

// Functions taking various strings:
void Foo ( LPCWSTR wstr );
void Bar ( BSTR bstr );
// Functions returning strings:
void Baz ( BSTR* pbstr );
#include 
main()
{
using std::string;
USES_CONVERSION;    // declare locals used by the ATL macros
// Example 1: Send an MBCS string to Foo()
LPCSTR psz1 = "Bob";
string str1 = "Bob";
 
  Foo ( A2CW(psz1) );
  Foo ( A2CW(str1.c_str()) );
 
// Example 2: Send a MBCS and Unicode string to Bar()
LPCSTR psz2 = "Bob";
LPCWSTR wsz = L"Bob";
BSTR bs1;
CComBSTR bs2;
 
  bs1 = A2BSTR(psz2);         // create a BSTR
  bs2.Attach ( W2BSTR(wsz) ); // ditto, assign to a CComBSTR 
  Bar ( bs1 );
  Bar ( bs2 );
 
  SysFreeString ( bs1 );      // free bs1 memory
  // No need to free bs2 since CComBSTR will do it for us.
 
// Example 3: Convert the BSTR returned by Baz()
BSTR bs3 = NULL;
string str2;
  Baz ( &bs3 );          // Baz() fills in bs3
  str2 = W2CA(bs3);      // convert to an MBCS string
  SysFreeString ( bs3 ); // free bs3 memory
}      

　　正如你所看見的，當你有一個和函數所需的參數類型不同的字符串時，使用這些轉換宏是非常方便的。

MFC類

CString
　　因為一個MFC CString類的對象包含TCHAR類型的字符，所以確切的字符類型取決于你所定義的預處理符號。大體來說，CString 很像STL string，這意味著你必須把它當成不透明的對象，只能使用CString提供的方法來修改CString對象。CString有一個string所不具備的優點：CString具有接收MBCS和Unicode兩種字符串的構造函數，它還有一個LPCTSTR轉換符，所以你可以把CString對象直接傳給一個接收LPCTSTR的函數而不需要調用c_str()函數。

// Constructing
CString s1 = "char string";  // construct from a LPCSTR
CString s2 = L"wide char string";  // construct from a LPCWSTR
CString s3 ( '' '', 100 );  // pre-allocate a 100-byte buffer, fill with spaces
CString s4 = "New window text";
 
  // You can pass a CString in place of an LPCTSTR:
  SetWindowText ( hwndSomeWindow, s4 );
 
  // Or, equivalently, explicitly cast the CString:
  SetWindowText ( hwndSomeWindow, (LPCTSTR) s4 );        

　　你可以從你的字符串表中裝載一個字符串，CString的一個構造函數和LoadString()函數可以完成它。Format()方法能夠從字符串表中隨意的讀取一個具有一定格式的字符串。　　　　　

// Constructing/loading from string table
CString s5 ( (LPCTSTR) IDS_SOME_STR );  // load from string table
CString s6, s7; 
  // Load from string table.
  s6.LoadString ( IDS_SOME_STR );
 
  // Load printf-style format string from the string table:
  s7.Format ( IDS_SOME_FORMAT, "bob", nSomeStuff, ... );  

　　第一個構造函數看起來有點奇怪，但是這實際上是文檔說明的裝入一個字符串的方法。 注意，對一個CString變量，你可以使用的唯一合法轉換符是LPCTSTR。轉換成LPTSTR（非常量指針）是錯誤的。養成把一個CString變量轉換成LPTSTR的習慣將會給你帶來傷害，因為當你的程序后來崩潰時，你可能不知道為什么，因為你到處都使用同樣的代碼而那時它們都恰巧正常工作。正確的得到一個指向緩沖區的非常量指針的方法是調用GetBuffer()方法。下面是正確的用法的一個例子，這段代碼是給一個列表控件中的項設定文字：

CString str = _T("new text");
LVITEM item = {0};
  item.mask = LVIF_TEXT;
  item.iItem = 1;
  item.pszText = (LPTSTR)(LPCTSTR) str; // WRONG!
  item.pszText = str.GetBuffer(0);      // correct
 
  ListView_SetItem ( &item );
str.ReleaseBuffer();  // return control of the buffer to str      

　　pszText成員是一個LPTSTR變量，一個非常量指針，因此你需要對str調用GetBuffer()。GetBuffer()的參數是你需要CString為緩沖區分配的最小長度。如果因為某些原因，你需要一個可修改的緩沖區來存放1K TCHARs，你需要調用GetBuffer(1024)。把0作為參數時，GetBuffer()返回的是指向字符串當前內容的指針。
　　上面劃線的語句可以被編譯，在這種情況下，甚至可以正常起作用。但這并不意味著這行代碼是正確的。通過使用非常量轉換，你已經破壞了面向對象的封裝，并對CString的內部實現作了某些假定。如果你有這樣的轉換習慣，你終將會陷入代碼崩潰的境地。你會想代碼為什么不能正常工作了，因為你到處都使用同樣的代碼而那些代碼看起來是正確的。
　　你知道人們總是抱怨現在的軟件的bug是多么的多嗎？軟件中的bug是因為程序員寫了不正確的代碼。難道你真的想寫一些你知道是錯誤的代碼來為所有的軟件都滿是bug這種認識做貢獻嗎？花些時間來學習使用CString的正確方法讓你的代碼在任何時間都正常工作把。
　　CString 有兩個函數來從一個 CString 創建一個 BSTR。它們是 AllocSysString() 和SetSysString()。

// Converting to BSTR
CString s5 = "Bob!";
BSTR bs1 = NULL, bs2 = NULL;
  bs1 = s5.AllocSysString();
  s5.SetSysString ( &bs2 );
  SysFreeString ( bs1 );
  SysFreeString ( bs2 );      

COleVariant
　　COleVariant和CComVariant.很相似。COleVariant繼承自VARIANT，所以它可以傳給接收VARIANT的函數。然而，不像CComVariant，COleVariant只有一個LPCTSTR構造函數。沒有對LPCSTR 和LPCWSTR的構造函數。在大多數情況下這不是一個問題，因為不管怎樣你的字符串很可能是LPCTSTRs，但這是一個需要意識到的問題。COleVariant還有一個接收CString參數的構造函數。

// Constructing
CString s1 = _T("tchar string");
COleVariant v1 = _T("Bob"); // construct from an LPCTSTR
COleVariant v2 = s1; // copy from a CString      

　　像CComVariant一樣，你必須直接訪問VARIANT的成員。如果需要把VARIANT轉換成一個字符串，你應該使用ChangeType()方法。然而，COleVariant::ChangeType()如果失敗會拋出異常，而不是返回一個表示失敗的HRESULT代碼。

// Extracting data
COleVariant v3 = ...; // fill in v3 from somewhere
BSTR bs = NULL;
  try
    {
    v3.ChangeType ( VT_BSTR );
    bs = v3.bstrVal;
    }
  catch ( COleException* e )
    {
    // error, couldn''t convert
    }
  SysFreeString ( bs );      

WTL 類

CString
　　WTL的CString的行為和MFC的 CString完全一樣，所以你可以參考上面關于MFC的 CString的介紹。

CLR 和 VC 7 類

　　System::String是用來處理字符串的.NET類。在內部，一個String對象包含一個不可改變的字符串序列。任何對String對象的操作實際上都是返回了一個新的String對象，因為原始的對象是不可改變的。String的一個特性是如果你有不止一個String對象包含相同的字符序列，它們實際上是指向相同的對象的。相對于C++的使用擴展是增加了一個新的字符串常量前綴S，S用來代表一個受控的字符串常量（a managed string literal）。

// Constructing
String* ms = S"This is a nice managed string";      

　　你可以傳遞一個非受控的字符串來創建一個String對象，但是樣會比使用受控字符串來創建String對象造成效率的微小損失。這是因為所有以S作為前綴的相同的字符串實例都代表同樣的對象，但這對非受控對象是不適用的。下面的代碼清楚地闡明了這一點：

String* ms1 = S"this is nice";
String* ms2 = S"this is nice";
String* ms3 = L"this is nice";
  Console::WriteLine ( ms1 == ms2 ); // prints true
  Console::WriteLine ( ms1 == ms3);  // prints false      

正確的比較可能沒有使用S前綴的字符串的方法是使用String::CompareTo()

  Console::WriteLine ( ms1->CompareTo(ms2) );
  Console::WriteLine ( ms1->CompareTo(ms3) );      

　　上面的兩行代碼都會打印0，0表示兩個字符串相等。 String和MFC 7 CString之間的轉換是很容易的。CString有一個向LPCTSTR的轉換操作，而String有兩個接收char* 和 wchar_t*的構造函數，因此你可以把一個CString變量直接傳給一個String的構造函數。

CString s1 ( "hello world" );
String* s2 ( s1 );  // copy from a CString      

反方向的轉換也很類似

String* s1 = S"Three cats";
CString s2 ( s1 );      

　　這也許會使你感到一點迷惑，但是它確實是起作用的。因為從VS.NET 開始，CString 有了一個接收String 對象的構造函數。

  CStringT ( System::String* pString );      

對于一些快速操作，你可能想訪問底層的字符串：

String* s1 = S"Three cats";
  Console::WriteLine ( s1 );
const __wchar_t __pin* pstr = PtrToStringChars(s1);
  for ( int i = 0; i < wcslen(pstr); i++ )
    (*const_cast<__wchar_t*>(pstr+i))++;
  Console::WriteLine ( s1 );      

　　PtrToStringChars()返回一個指向底層字符串的const __wchar_t* ，我們需要固定它，否則垃圾收集器或許會在我們正在管理它的內容的時候移動了它。

在 printf-style 格式函數中使用字符串類

　　當你在printf()或者類似的函數中使用字符串封裝類時你必須十分小心。這些函數包括sprintf()和它的變體，還有TRACE和ATLTRACE宏。因為這些函數沒有對添加的參數的類型檢查，你必須小心，只能傳給它們C語言風格的字符串指針，而不是一個完整的字符串類。
　　例如，要把一個_bstr_t 字符串傳給ATLTRACE()，你必須使用顯式轉換(LPCSTR) 或者(LPCWSTR)：

_bstr_t bs = L"Bob!";
ATLTRACE("The string is: %s in line %d\n", (LPCSTR) bs, nLine);

　　如果你忘了使用轉換符而把整個_bstr_t對象傳給了函數，將會顯示一些毫無意義的輸出，因為_bstr_t保存的內部數據會全部被輸出。

所有類的總結

　　兩個字符串類之間進行轉換的常用方式是：先把源字符串轉換成一個C語言風格的字符串指針，然后把這個指針傳遞給目的類型的構造函數。下面這張表顯示了怎樣把一個字符串轉換成一個C語言風格的字符串指針以及哪些類具有接收C語言風格的字符串指針的構造函數。

Class	string type	convert to char*?	convert to const char*?	convert to wchar_t*?	convert to const wchar_t*?	convert to BSTR?	construct from char*?	construct from wchar_t*?
_bstr_t	BSTR	yes cast1	yes cast	yes cast1	yes cast	yes2	yes	yes
_variant_t	BSTR	no	no	no	cast to _bstr_t3	cast to _bstr_t3	yes	yes
string	MBCS	no	yes c_str() method	no	no	no	yes	no
wstring	Unicode	no	no	no	yes c_str() method	no	no	yes
CComBSTR	BSTR	no	no	no	yes cast to BSTR	yes cast	yes	yes
CComVariant	BSTR	no	no	no	yes4	yes4	yes	yes
CString	TCHAR	no6	in MBCS builds, cast	no6	in Unicode builds, cast	no5	yes	yes
COleVariant	BSTR	no	no	no	yes4	yes4	in MBCS builds	in Unicode builds
1、即使 _bstr_t 提供了向非常量指針的轉換操作符，修改底層的緩沖區也會已引起GPF如果你溢出了緩沖區或者造成內存泄漏。 2、_bstr_t 在內部用一個 wchar_t* 來保存 BSTR，所以你可以使用 const wchar_t* 來訪問BSTR。這是一個實現細節，你可以小心的使用它，將來這個細節也許會改變。 3、如果數據不能轉換成BSTR會拋出一個異常。 4、使用 ChangeType()，然后訪問 VARIANT 的 bstrVal 成員。在MFC中，如果數據轉換不成功將會拋出異常。 5、這里沒有轉換 BSTR 函數，然而 AllocSysString() 返回一個新的BSTR。 6、使用 GetBuffer() 方法，你可以暫時地得到一個非常量的TCHAR指針。