Item 16:如何將vector和string的數(shù)據(jù)傳給傳統(tǒng)的API函數(shù)
因?yàn)?C++語言已經(jīng)于1998年被標(biāo)準(zhǔn)化,C++的中堅(jiān)分子在試圖推動(dòng)程序員從數(shù)組轉(zhuǎn)到vector時(shí)就沒什么顧慮了。同樣的情況也發(fā)生于從char *指針轉(zhuǎn)到string對(duì)象的過程中。有很好的理由來做這些轉(zhuǎn)變,比如可以消除常見的編程錯(cuò)誤(Item 13),和有機(jī)會(huì)獲得STL泛型算法的全部強(qiáng)大能力 (參見,比如,Item 31)。
但是,麻煩還是有的,而最常見的一個(gè)就是已經(jīng)存在的傳統(tǒng)C風(fēng)格API函數(shù)接受的是數(shù)組和char *指針,而不是vector和string對(duì)象。這樣的API函數(shù)還將會(huì)存在很長時(shí)間,如果我們要高效使用STL的話,就必須和它們和平共處。
幸運(yùn)的是,這很容易。如果你有一個(gè)vector對(duì)象v,而你需要得到一個(gè)指向v中數(shù)據(jù)的指針,以使得它可以被當(dāng)作一個(gè)數(shù)組,只要使用&v[0]就可以了。對(duì)于string對(duì)象s,相應(yīng)的語法是很簡單的s.c_str()。但只能從上面讀。如廣告時(shí)常指明的,有幾個(gè)限制。。
給定一個(gè)
vector<int> v;
表達(dá)式v[0]生產(chǎn)一個(gè)指向vector中首元素的引用,所以,&v[0]是指向那個(gè)首元素的指針。vector中的元素被C++標(biāo)準(zhǔn)限定為存儲(chǔ)在連續(xù)內(nèi)存中,就象是一個(gè)數(shù)組,所以,如果我們傳遞v給如此形式的C風(fēng)格API函數(shù)
void doSomething(const int* pInts, size_t numInts);
我們可以這么做:
doSomething(&v[0],v.size());
也許吧。可能吧。唯一的問題就是,如果v是空的。如果這樣的話,v.size()是0,而&v[0]試圖產(chǎn)生一個(gè)指向根本就不存在的東西的指針。這不是件好事。其結(jié)果未定義。一個(gè)較安全的方法是這樣:
if (!v.empty()) {
doSomething(&v[0], v.size());
}
如果走得不對(duì)路,你可能會(huì)碰到些半瓶子的人物,他們會(huì)告訴你說可以用v.begin()代替&v[0],因?yàn)?這些討厭的家伙將會(huì)告訴你)begin()返回指向vector內(nèi)部的iterator,而對(duì)于vector,其iterators實(shí)際上是指針。那經(jīng)常是正確的,但如Item 50所說,并不總是如此,你不該依賴于此。begin()的返回類型是iterator,而不是一個(gè)指針,當(dāng)你需要一個(gè)指向vector內(nèi)部數(shù)據(jù)的指針時(shí)絕不該使用begin()。如果你基于某些原因決定鍵入v.begin(),就鍵入&*v.begin(), 因?yàn)檫@將會(huì)產(chǎn)生和&v[0]相同的指針,雖然它讓你有更多的擊鍵工作且讓代碼讀起來更晦澀。坦白地說,如果你正被告訴你使用v.begin()代替&v[0]的人圍繞的話,你該重新考慮一下你的社交圈了。
類似的從vector上獲取指向內(nèi)部數(shù)據(jù)的指針的方法,對(duì)string是不可靠的,因?yàn)?
(1) string中的數(shù)據(jù)并沒有承諾被存儲(chǔ)在連續(xù)內(nèi)存中,
(2)string的內(nèi)部表示形式并沒承諾以一個(gè)空字符結(jié)束。
這解釋了string的成員函數(shù)c_str()存在的原因,它返回一個(gè)按C風(fēng)格設(shè)計(jì)指針,指向string的值(which returns a pointer to the value of the string in a form designed for C)。 我們可以如此傳遞一個(gè)string對(duì)象s給這個(gè)函數(shù),
void doSomething(const char *pString);
就象這樣:
doSomething(s.c_str());
即使是字符串的長度為0,它都能工作。在那種情況下,c_str()將返回一個(gè)指向結(jié)束符的指針。即使字符串內(nèi)部自己存在結(jié)束符時(shí),它同樣能工作。然而,如果真的這樣,doSomething很可能將第一個(gè)結(jié)束符解釋為字符串結(jié)束。string對(duì)象不在意是否容納了結(jié)束符,但基于char *的C風(fēng)格API函數(shù)在意。
再看一下doSomething()的申明:
void doSomething(const int* pInts, size_t numInts);
void doSomething(const char *pString);
在兩種形式下,指針都被傳遞為指向const的指針。vector和string的數(shù)據(jù)被傳給只讀取而不修改它們的API函數(shù)。到目前為止都做的是最安全的事情。對(duì)于string,這也是唯一可做的,因?yàn)闆]有承諾說c_str()產(chǎn)生的指針指在string數(shù)據(jù)的內(nèi)部表示形式上;它可以返回一個(gè)指針指向數(shù)據(jù)的一個(gè)不可修改的拷貝,這個(gè)拷貝滿足C風(fēng)格API函數(shù)對(duì)格式的要求。(如果這個(gè)恐嚇令你寒毛都立起來的話,還請(qǐng)寬心,因?yàn)樗苍S不成立。我沒聽說目前哪個(gè)運(yùn)行庫的實(shí)現(xiàn)是使用了這個(gè)自由權(quán)的。)
對(duì)于vector,有更多一點(diǎn)點(diǎn)靈活性。如果你將v傳給一個(gè)修改其元素的C風(fēng)格API函數(shù)的話,典型情況都是沒問題,但被調(diào)用的函數(shù)絕不能試圖改變vector中元素的個(gè)數(shù)。比如,它絕不能試圖在vector還未使用的容量(capacity)上“創(chuàng)建”新的元素。如果這么干了,v將會(huì)變得內(nèi)部狀態(tài)不一致,因?yàn)樗僖膊恢雷约旱恼_大小(size)了。v.size()將會(huì)得到一個(gè)不正確的結(jié)果。并且,如果被調(diào)用的函數(shù)試圖在一個(gè)大小和容量(見Item 14)相等的vector上追加數(shù)據(jù)的話,真的會(huì)發(fā)生災(zāi)難性事件。我甚至根本就不愿去想象它。實(shí)在太可怕了。
你注意到我在前面用的是“典型地”一詞嗎?你當(dāng)然注意到了。有些vector對(duì)其數(shù)據(jù)有些額外的限制,你一定要確保這些額外限制繼續(xù)被滿足。舉個(gè)例子,Item 23解釋了排序的vector常用來實(shí)現(xiàn)關(guān)聯(lián)容器,但對(duì)這些vector而言,保持排序非常重要。如果你將一個(gè)排序的vector傳給一個(gè)可能修改其數(shù)據(jù)的API函數(shù),你需要重視vector在調(diào)用返回后不再保持排序的情況。
如果你想用C風(fēng)格API函數(shù)返回的元素初始化一個(gè)vector,你可以利用vector和數(shù)組內(nèi)在的相容性,通過將存儲(chǔ)vecotr的元素的空間傳給API函數(shù):
// C API: this function takes a pointer to an array of at most arraySize
// doubles and writes data to it. It returns the number of doubles written,
// which is never more than maxNumDoubles.
size_t fillArray(double *pArray, size_t arraySize);
vector<double> vd(maxNumDoubles); // create a vector whose
// size is maxNumDoubles
vd.resize(fillArray(&vd[0], vd.size())); // have fillArray write data
// into vd, then resize vd
// to the number of
// elements fillArray wrote
這個(gè)技巧只能工作于vector,因?yàn)橹挥衯ector承諾了與數(shù)組具有相同的內(nèi)在內(nèi)存分布。但是,如果你想用來自C風(fēng)格API函數(shù)的數(shù)據(jù)初始化string對(duì)象,你可以做得足夠簡單。只要讓API函數(shù)將數(shù)據(jù)放入一個(gè)vector<char>,然后從vector中將數(shù)據(jù)拷到string:
// C API: this function takes a pointer to an array of at most arraySize
// chars and writes data to it. It returns the number of chars written,
// which is never more than maxNumChars.
size_t fillString(char *pArray, size_t arraySize);
vector<char> vc(maxNumChars); // create a vector whose
// size is maxNumChars
size_t charsWritten = fillString(&vc[0], vc.size()); // have fillString write
// into vc
string s(vc.begin(), vc.begin()+charsWritten); // copy data from vc to s
// via range constructor
// ( see Item 5)
事實(shí)上,這個(gè)主意總是有效的:讓C風(fēng)格API函數(shù)將數(shù)據(jù)放入一個(gè)vector,然后拷到你實(shí)際想要的STL容器中。
size_t fillArray(double *pArray, size_t arraySize); // as above
vector<double> vd(maxNumDoubles); // also as above
vd.resize(fillArray(&vd[0], vd.size());
deque<double> d(vd.begin(), vd.end()); // copy data into
// deque
list<double> l(vd.begin(), vd.end()); // copy data into list
set<double> s(vd.begin(), vd.end()); // copy data into set
此外,這也提示了vector和string以外的STL容器如何將它們的數(shù)據(jù)傳給C風(fēng)格API函數(shù)。只要將容器的每個(gè)數(shù)據(jù)拷到vector,然后將它們傳給API函數(shù):
void doSomething(const int* pInts, size_t numInts); // C API (from above)
set<int> intSet; // set that will hold
... // data to pass to API
vector<int> v(intSet.begin(), intSet.end()); // copy set data into
// a vector
if (!v.empty()) doSomething(&v[0], v.size()); // pass the data to
// the API
你也可以將數(shù)據(jù)拷進(jìn)一個(gè)數(shù)組,然后將數(shù)組傳給C風(fēng)格的API,但你為什么想這樣做?除非你在編譯期就知道容器的大小,否則你不得不分配動(dòng)態(tài)數(shù)組,而Item 13解釋了為什么你應(yīng)該總是使用vector來取代動(dòng)態(tài)分配的數(shù)組。