在c語言中,API的體現為c函數,如操作系統提供的一系列API,在c++中,API的體現為自由函數,這裡的自由函數是指除普通成員函數、靜態成員函數、友元函數外的能在某命名空間作用域或全局空間內直接訪問的函數,而這更多地體現為函數模板,如stl提供的一系列算法,其中著名的如swap、count,sort等。相對於c API,c++ API具有類型安全和封閉開放的優點,類型安全是因為c++本身就是一種比c更強的靜態類型語言,而封閉開放是指函數的設計實現一部分是固定的,而另一部分可以是靈活擴展的,這表現為函數模板的重載和全局特化實現。本文主要講述如何運用函數模板來設計自己的應用程序API,並以windows API為基礎示例說明。
在windows中,很多API通常都有ANSI和UNICODE兩種字符集形式,其命名對應表現為xxxA和xxxW。如果應用層需要針對這些API來封裝自己的API,為完備起見,就需要考慮ANSI和UNICODE兩種版本。一般有2種方法,其一是先實現一個A(或W)版本,而W(或A)版本的實現則是在其內部將UNICODE(或ANSI)型數化轉化為ANSI(或UNICODE)類型,再調用A(或W)版本,這種方法因需要作字符集的轉換來實現,因而效率較低;其二是兩個版本平行實現,即A版本調用原windows A版本API實現,W版本調用原windows W版本API實現,這種方法的缺點是結果產生除了A或W API調用不同外很多的重復代碼。在A和W版本都實現後,進一步,可根據編譯器的宏定義_UNICODE或UNICODE來定義一個自己的API宏。那麼除以上2種方法外,還有沒有更好的方法來實現呢?而這種方法必然要能夠兼顧效率和避免代碼的重復冗余。在這裡,講述一種使用函數模板來封裝設計的方法,在使用這個方法前,有幾個問題需要解決:1)如何根據泛型參數來選擇定義正確的結構體,因為有些windows API的參數中不僅字符串類型有A和W兩種類型,而且凡是其內部包含字符串類型的結構體因而也帶有A和W兩種類型。2)如何根據泛型參數來選擇調用正確版本的原windows API。
對於windows API的封裝,泛型參數通常只有A或W兩種,因此針對上述第1個問題,可以使用選擇特征類模板來實現,如boost中的if_c,softstl中的select_first_type類模板,也可以自己實現這樣的類模板。對上述第2個問題,與第1個問題不同的是,它是選擇函數而不是類型,本質上講就是選擇變量,因此需要開發實現一種基於類型或非類型參數選擇變量的基礎設施,那麼這個基礎設施該怎麼實現呢?於結果而言,我期望這個基礎設施是這麼使用的:select_variable<flag>(xxxA,xxxW)(arg1,arg2,...,argN); flag是一個布爾非類型模板實參,當其值為true時表示選擇返回windows API xxxA,反之選擇返回windows API xxxW,然後接下來跟著一系列參數,表示調用對應的A或W版本windows API,因此select_variable應該實現為函數模板比較方便,如果實現為類模板(關於實現可以參考boost中的function),則需要顯式指定函數返回值和參數類型,這樣一來,當函數參數過多,就是一個噩夢了,因為模板實參演繹不能用於類模板及其構造函數,只能應用於其成員函數模板。關於這兩個問題的解決,我已實現為特征模板,並作為基礎庫來開發維護,命名為select_trait,代碼如下:
1#define TEMPLATE_BOOL_TRAIT_DEF1(trait,T,c)\
2template<typename T>\
3struct trait\
4{\
5 static const bool value=c;\
6};\
7
8#define TEMPLATE_BOOL_TRAIT_SPEC1(trait,sp,c)\
9template<>\
10struct trait<sp>\
11{\
12 static const bool value=c;\
13};\
14
15template<bool flag,typename T1,typename T2>
16struct select_type;
17
18template<typename T1,typename T2>
19struct select_type<true,T1,T2>
20{
21 typedef T1 type;
22};
23
24template<typename T1,typename T2>
25struct select_type<false,T1,T2>
26{
27 typedef T2 type;
28};
29
30template<bool flag,typename T1,typename T2>
31inline typename select_type<flag,T1,T2>::type select_variable(T1 t1,T2 t2)
32{
33 return select_variable_impl(typename select_type<flag,int,long>::type(),t1,t2);
34}
35
36template<typename T1,typename T2>
37inline T1 select_variable_impl(int,T1 t1,T2 t2)
38{
39 return t1;
40}
41
42template<typename T1,typename T2>
43inline T2 select_variable_impl(long,T1 t1,T2 t2)
44{
45 return t2;
46}
47
48TEMPLATE_BOOL_TRAIT_DEF1(is_ansi_char,T,false)
49TEMPLATE_BOOL_TRAIT_SPEC1(is_ansi_char,char,true)
50TEMPLATE_BOOL_TRAIT_SPEC1(is_ansi_char,char const,true)
51TEMPLATE_BOOL_TRAIT_SPEC1(is_ansi_char,char volatile,true)
52TEMPLATE_BOOL_TRAIT_SPEC1(is_ansi_char,char const volatile,true)
53
54#undef TEMPLATE_BOOL_TRAIT_DEF1
55#undef TEMPLATE_BOOL_TRAIT_SPEC1
有了這個基礎設施select_trait特征模板,封裝設計自己的API就方便多了,在函數模板中,類型的參數化體現在其參數、返回值、內部實現中,下面就從這3個方面示例說明其應用:
(1)參數類型化,比如根據路徑來判斷是否為目錄或文件,對於調用方來說,可以靈活指定A或W版本的字符串路徑,如下所示: www.2cto.com
1template<typename charT>
2inline int IsDirectoryOrFile(const charT* path)
3{
4 DWORD dwFlag = select_variable<is_ansi_char<charT>::value>(GetFileAttributesA,GetFileAttributesW)(path);
5 if (INVALID_FILE_ATTRIBUTES == dwFlag)
6 return 0;
7 return (dwFlag & FILE_ATTRIBUTE_DIRECTORY) ? 1 : 2;
8}
(2)返回值類型化,比如最常見獲取當前應用程序的路徑,對於調用方來說,可以靈活指定想要返回A或W版本字符串表示的路徑,如下所示:
1template<typename T>
2inline std::basic_string<T> GetExePath()
3{
4 T szExePath[MAX_PATH];
5 select_variable<is_ansi_char<T>::value>(GetModuleFileNameA,GetModuleFileNameW)(NULL,szExePath);
6 return szExePath;
7}
(3)內部實現類型化,比如計算某一目錄或文件的大小,因內部用到了FirstFirstFile和FirstNextFile,而這兩個API不僅路徑,而且WIN32_FIND_DATA結構體都有A和W版本,因此需要選擇定義正確的結構體變量和調用正確的API函數,如下所示:
1template<typename charT>
2inline ULONGLONG GetDirSize(const charT* path)
3{
4 int ret = IsDirectoryOrFile(path);
5 if (0==ret) return 0L;
6
7 std::basic_string<charT> strPath = path;
8 if (1==ret)
9 {
10 if (strPath.length() - 1 != strPath.rfind((charT)'\\'))
11 strPath += (charT)'\\';
12 strPath += select_variable<is_ansi_char<charT>::value>("*.*",L"*.*");
13 }
14 ULONGLONG ullSumSize = 0;
15 typename select_type<is_ansi_char<charT>::value,WIN32_FIND_DATAA,WIN32_FIND_DATAW>::type findData;
16 HANDLE hFindFile = select_variable<is_ansi_char<charT>::value>(FindFirstFileA,FindFirstFileW)(strPath.c_str(), &findData);
17
18 for(BOOL bResult = (hFindFile != INVALID_HANDLE_VALUE);
19 bResult; bResult = select_variable<is_ansi_char<charT>::value>(FindNextFileA,FindNextFileW)(hFindFile, &findData))
20 {
21 if(findData.cFileName[0] == (charT)'.')
22 continue;
23 if(findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
24 {
25 strPath = strPath.substr(0,strPath.rfind((charT)'\\')+1)+findData.cFileName;
26 ullSumSize += GetDirSize(strPath.c_str(), bExitCalc);
27 }
28 else
29 ullSumSize += (((ULONGLONG)findData.nFileSizeHigh) << 32) + findData.nFileSizeLow;
30 }
31 ::FindClose(hFindFile);
32 return ullSumSize;
33}
摘自 天道酬勤