boost::preprocessor库之文件重复与自我重复

四月 7th, 2008 by Soloman | Print boost::preprocessor库之文件重复与自我重复 | 659 views

上回中,我们利用LOCAL重复将3个模板类生成到了单独的三行,可是我们还是不会满足,毕竟,一行一个类还是不便于阅读和调试。要进一步改进,我们需要运用新的方法:文件重复(File重复)。

顾名思义,文件重复需要用到文件,我们将用于重复的模式单独写到一个文件中,然后调用这个模式重复产生代码。

开始动手,首先创建一个单独的文件:pattern.hpp:

#define n BOOST_PP_ITERATION()

#define TINY_print(~,~,data) data

template <BOOST_PP_ENUM_PARAMS(n, class T)>
struct tiny_size<
  BOOST_PP_ENUM_PARAMS(n,T)
  BOOST_PP_COMMA_IF(n)
  BOOST_PP_ENUM(BOOST_PP_SUB(M,n), TINY_print, none)
> : mpl::int_<n> {};

#undef n

这个文件将不会用于编译,而作为一个模式的承载。我们应该注意到,没有了每行后面的’\'符号,因为,它并不是用来产生一行的代码,而是用了产生一个代码块。宏函数ITERATION()则用来获得当前重复的索引。

为了触发这个模式,我们在我们的主代码中这样写:(test.cpp

#include <boost/preprocessor/repetition.hpp>
#include <boost/preprocessor/arithmetic/sub.hpp>
#include <boost/preprocessor/punctuation/comma_if.hpp>
#include <boost/preprocessor/iteration/iterate.hpp>

#define M 3

#define BOOST_PP_ITERATION_LIMITS (0,M-1)
#define BOOST_PP_FILENAME_1       "pattern.hpp"
#include BOOST_PP_ITERATE()

现在,我们有了两个文件,主文件是test.cpp,模式文件是pattern.hpp。可以看出,文件重复和LOCAL重复一样,需要预先定义两个东西:一个是重复的范围LIMITS;另一个是重复的内容,不过这次不是MACRO了,而是模式文件的文件名。另外,我们注意到,FILENAME宏后面有个1,这个是用来指明循环的嵌套层次,用于多层嵌套循环。

编译执行的命令行稍微有所变化:

] g++ -P -E -I. test.cpp > test.out.cpp

区别在于,多了一个-I参数,这个参数指定了当前目录为头文件搜索目录,这是因为,我们的模式文件在当前目录。如果不加这个参数,预编译器就找不到模式文件了。

好了,我们来看下预编译的输出:

template <>
struct tiny_size<
  none , none , none
> : mpl::int_<0> {};

template < class T0>
struct tiny_size<
  T0
  ,
  none , none
> : mpl::int_<1> {};

template < class T0 , class T1>
struct tiny_size<
  T0 , T1
  ,
  none
> : mpl::int_<2> {};

不错,这下每个模板类被分散到了多行,阅读起来方便多了。

然而,虽然结果满意了,但附加引入的模式文件增加了我们项目管理的负担,不用担心,boost还为我们提供了一个文件重复的改进:自我重复。它的目的很直接:消除这额外的模式文件。

其实,自我重复,并没有引入新的宏函数,它只是用到了我们常常碰到的一个小trick。还记得我们在每个头文件中都包含的宏吧:

#ifndef __THIS_HEADER_FILE__
#define __THIS_HEADER_FILE__

// definations...

#endif

boost pp库依葫芦画瓢,在循环体中,为我们定义了一个叫BOOST_PP_IS_ITERATING的宏,我们根据改宏是否定义来判断是否处于循环体中。这样,我们就把重复模式和重复触发给揉合在了一个文件里:

#ifndef BOOST_PP_IS_ITERATING
// we are in normal file
#include <boost/preprocessor/repetition.hpp>
#include <boost/preprocessor/arithmetic/sub.hpp>
#include <boost/preprocessor/punctuation/comma_if.hpp>
#include <boost/preprocessor/iteration/iterate.hpp>

#define M 3

#define BOOST_PP_ITERATION_LIMITS (0,M-1)
#define BOOST_PP_FILENAME_1       "test.cpp"
#include BOOST_PP_ITERATE()

#else // now we are in loop

#define n BOOST_PP_ITERATION()

#define TINY_print(z,n,data) data

template <BOOST_PP_ENUM_PARAMS(n, class T)>
struct tiny_size<
  BOOST_PP_ENUM_PARAMS(n,T)
  BOOST_PP_COMMA_IF(n)
  BOOST_PP_ENUM(BOOST_PP_SUB(M,n), TINY_print, none)
> : mpl::int_<n> {};

#undef n

#endif

这样我们就把模式内容放到了同一个文件里,减轻了我们同时维护两个文件的烦恼。

至此,我们基本上满意了:一来我们替换出来的代码拥有漂亮的格式(不在同一行中);二来我们只需要维护一个文件。

总结一下,pp库的代码重复主要分横向重复和纵向重复,横向重复适用于参数列表的重复,而纵向重复能更好地控制代码的格式。而纵向重复又分LOCAL重复、文件重复和自我重复,我们可以根据实际情况确定采取哪种重复。

, , ,

 

添加评论 (支持Gravatar头像)

注意: 评论者允许使用'@user空格'的方式将自己的评论通知另外评论者。例如, ABC是本文的评论者之一,则使用'@ABC '(不包括单引号)将会自动将您的评论发送给ABC。使用'@all ',将会将评论发送给之前所有其它评论者。请务必注意user必须和评论者名相匹配(大小写一致)。

实时评论预览