在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版本的字符串路径,如下所示:
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函数,如下所示:
|