C语言宏定义总结

宏使用中的常见的基础问题
1. 防止一个头文件被重复包含
#ifndef BODYDEF_H
#define BODYDEF_H
//头文件内容
#endif

2. 重新定义一些类型，防止由于各种平台和编译器的不同，而产生的类型字节数差异，方便移植。
typedef unsigned char boolean; /* Boolean type. */
typedef unsigned long uint32; /* Unsigned 32 bit */
typedef unsigned short uint16; /* Unsigned 16 bit */
typedef unsigned char uint8; /* Unsigned 8 bit */
typedef signed long int int32; /* Signed 32 bit */
typedef signed short int16; /* Signed 16 bit */
typedef signed char int8; /* Signed 8 bit */

//下面的不建议使用
typedef unsigned char byte; /* Unsigned 8 bit type. */
typedef unsigned short word; /* Unsinged 16 bit type. */
typedef unsigned long dword; /* Unsigned 32 bit type. */
typedef unsigned char uint1; /* Unsigned 8 bit type. */
typedef unsigned short uint2; /* Unsigned 16 bit type. */
typedef unsigned long uint4; /* Unsigned 32 bit type. */
typedef signed char int1; /* Signed 8 bit type. */
typedef signed short int2; /* Signed 16 bit type. */
typedef long int int4; /* Signed 32 bit type. */
typedef signed long sint31; /* Signed 32 bit */
typedef signed short sint15; /* Signed 16 bit */
typedef signed char sint7; /* Signed 8 bit */

3. 得到指定地址上的一个字节或字
#define MEM_B(x) (*((uint8*)(x)))
#define MEM_W(x) (*((uint16*)(x)))

4. 得到一个field在结构体(struct)中的偏移量
#define FPOS(type,field) ((uint32) &((type *)0)->field)

5. 得到一个结构体中field所占用的字节数
#define FSIZ(type,field) sizeof(((type *)0)->field)

6. 求最大值和最小值
#define MAX(x,y) (((x)>(y))?(x):(y))
#define MIN(x,y) (((x)<(y))?(x):(y))

7. 得到一个变量的地址
#define B_PTR(var) ((byte *) (void *) &(var))
#define W_PTR(var) ((word *) (void *) &(var))

8. 按照LSB格式把两个字节转化为一个Word
#define FLIPW(ray) ((((word) (ray)[0]) * 256) + (ray)[1])

9. 按照LSB格式把一个Word转化为两个字节
#define FLOPW( ray, val ) /
(ray)[0] = ((val) / 256); /
(ray)[1] = ((val) & 0xFF)

10.得到一个字的高位和低位字节
#define WORD_LO(***) ((byte) ((word)(***) & 0xFF))
#define WORD_HI(***) ((byte) ((word)(***) >> 8))

11.将一个字母转换为大写
#define UPCASE(c) (((c) >= 'a' && (c) <= 'z') ? ((c) - 0x20) : (c))

12.判断字符是不是10进值的数字
#define DECCHK(c) ((c) >= '0' && (c) <= '9')

13.判断字符是不是16进值的数字
#define HEXCHK(c) (((c) >= '0' && (c) <= '9') || /
((c) >= 'A' && (c) <= 'F') || /
((c) >= 'a' && (c) <= 'f'))

14.防止溢出的一个方法
#define INC_SAT(val) (val = ((val)+1 > (val)) ? (val)+1 : (val))

15.返回数组元素的个数
#define ARR_SIZE(a) (sizeof((a)) / sizeof((a[0])))

16.返回一个比X大的最接近的8的倍数
#define RND8(x) ((((x) + 7) / 8 ) * 8)

17.返回一个无符号数n尾的值MOD_BY_POWER_OF_TWO(X,n)=X%(2^n)
#define MOD_BY_POWER_OF_TWO(val, mod_by) /
((dword)(val) & (dword)((mod_by)-1))

18.对于IO空间映射在存储空间的结构，输入输出处理
#define inp(port) (*((volatile byte *) (port)))
#define inpw(port) (*((volatile word *) (port)))
#define inpdw(port) (*((volatile dword *)(port)))
#define outp(port, val) (*((volatile byte *) (port)) = ((byte) (val)))
#define outpw(port, val) (*((volatile word *) (port)) = ((word) (val)))
#define outpdw(port, val) (*((volatile dword *) (port)) = ((dword) (val)))

19.使用一些宏跟踪调试
ANSI标准说明了五个预定义的宏名。它们是：
__LINE__ (两个下划线)，对应%d
__FILE__ 对应%s
__DATE__ 对应%s
__TIME__ 对应%s
__STDC__

如果编译不是标准的，则可能仅支持以上宏名中的几个，或根本不支持。记住编译程序也许还提供其它预定义的宏名。
__LINE__宏指令表示当前指令所在的行，是个整型数
__FILE__宏指令表示当前指令所在文件，包含完整路径
__DATE__宏指令含有形式为月/日/年的串，表示源文件被翻译到代码时的日期。
__TIME__宏指令包含源代码翻译到目标代码的时间。串形式为时：分：秒。
如果实现是标准的，则宏__STDC__含有十进制常量1。如果它含有任何其它数，则实现是非标准的。

可以定义宏，例如:
当定义了_DEBUG，输出数据信息和所在文件所在行
#ifdef _DEBUG
#define DEBUGMSG(msg,date) printf(msg);printf("%d%d%d",date,_LINE_,_FILE_)
#else
#define DEBUGMSG(msg,date)
#endif

20.宏定义防止使用时错误
用小括号包含。

例如：#define ADD(a,b) (a+b)
用do{}while(0)语句包含多语句防止错误

例如：#define DO(a,b) /
a+b; /
a++;
应用时：if(...)
O(a,b); //产生错误
else

解决方法: #difne DO(a,b) /
do{ /
a+b; /
a++; /
}while(0)

宏中"#"和"##"的用法
在C语言的宏中，#的功能是将其后面的宏参数进行字符串化操作(Stringfication)，简单说就是在对它所引用的宏变量通过替换后在其左右各加上一个双引号。
而##被称为连接符(concatenator)，用来将两个Token连接为一个Token.注意这里连接的对象是Token就行，而不一定是宏的变量。
1. 一般用法
我们使用#把宏参数变为一个字符串,用##把两个宏参数贴合在一起.
#include <stdio.h>
#include <stdLib.h>

#define STR(s) #s
#define CONS(a,b) int(a##e##b)

int main()
{
Printf(STR(vck)); // 输出字符串"vck"
printf("%d/n", CONS(2,3)); // 2e3 输出:2000
return 0;
}

2. 当宏参数是另一个宏的时候
需要注意的是凡宏定义里有用"#"或"##"的地方宏参数是不会再展开.
(1)非'#'和'##'的情况
#define TOW (2)
#define MUL(a,b) (a*b)

printf("%d*%d=%d/n", TOW, TOW, MUL(TOW,TOW));
这行的宏会被展开为：
printf("%d*%d=%d/n", (2), (2), ((2)*(2)));
MUL里的参数TOW会被展开为(2).

(2)当有'#'或'##'的时候
#define A (2)
#define STR(s) #s
#define CONS(a,b) int(a##e##b)

printf("int max: %s/n", STR(INT_MAX)); // INT_MAX #include<climits>
这行会被展开为：
printf("int max: %s/n", "INT_MAX");

printf("%s/n", CONS(A,A)); // compile error
这一行则被展开为：
printf("%s/n", int(AeA));

INT_MAX和A都不会再被展开, 然而解决这个问题的方法很简单. 加多一层中间转换宏.
加这层宏的用意是把所有宏的参数在这层里全部展开, 那么在转换宏里的那一个宏(_STR)就能得到正确的宏参数

#define A (2)
#define _STR(s) #s
#define STR(s) _STR(s) // 转换宏
#define _CONS(a,b) int(a##e##b)
#define CONS(a,b) _CONS(a,b) // 转换宏

printf("int max: %s/n", STR(INT_MAX)); // INT_MAX,int型的最大值
输出为: int max: 0x7fffffff
STR(INT_MAX) --> _STR(0x7fffffff) 然后再转换成字符串；

printf("%d/n", CONS(A, A));
输出为：200
CONS(A, A) --> _CONS((2), (2)) --> int((2)e(2))

3. "#"和"##"的一些应用特例
(1)合并匿名变量名
#define ___ANONYMOUS1(type, var, line) type var##line
#define __ANONYMOUS0(type, line) ___ANONYMOUS1(type, _anonymous, line)
#define ANONYMOUS(type) __ANONYMOUS0(type, __LINE__)
例：ANONYMOUS(static int); 即: static int _anonymous70; 70表示该行行号;
第一层：ANONYMOUS(static int); --> __ANONYMOUS0(static int, __LINE__);
第二层： --> ___ANONYMOUS1(static int, _anonymous, 70);
第三层： --> static int _anonymous70;
即每次只能解开当前层的宏,所以__LINE__在第二层才能被解开;

(2)填充结构
#define FILL(a) {a, #a}

enum IDD{OPEN, CLOSE};
typedef struct MSG{
IDD id;
const char * msg;
}MSG;

MSG _msg[] = {FILL(OPEN), FILL(CLOSE)};
相当于：
MSG _msg[] = {{OPEN, "OPEN"},
{CLOSE, "CLOSE"}};

(3)记录文件名
#define _GET_FILE_NAME(f) #f
#define GET_FILE_NAME(f) _GET_FILE_NAME(f)
static char FILE_NAME[] = GET_FILE_NAME(__FILE__);

(4)得到一个数值类型所对应的字符串缓冲大小
#define _TYPE_BUF_SIZE(type) sizeof #type
#define TYPE_BUF_SIZE(type) _TYPE_BUF_SIZE(type)
char buf[TYPE_BUF_SIZE(INT_MAX)];
--> char buf[_TYPE_BUF_SIZE(0x7fffffff)];
--> char buf[sizeof "0x7fffffff"];
这里相当于：
char buf[11];

......符号的使用
......在C宏中称为Variadic Macro，也就是变参宏。比如：

#define myprintf(templt, ......) fprintf(stderr,templt,__VA_ARGS__)

// 或者

#define myprintf(templt, args......) fprintf(stderr,templt,args)

第一个宏中由于没有对变参起名，我们用默认的宏__VA_ARGS__来替代它。第二个宏中，我们显式地命名变参为args，那么我们在宏定义中就可以用args来代指变参了。同C语言的stdcall一样，变参必须作为参数表的最后一项出现。当上面的宏中我们只能提供第一个参数templt时，C标准要求我们必须写成：myprintf(templt,);的形式。这时的替换过程为：

myprintf("Error!/n",);

替换为：

fprintf(stderr,"Error!/n",);

这是一个语法错误，不能正常编译。这个问题一般有两个解决方法。首先，GNU CPP提供的解决方法允许上面的宏调用写成：

myprintf(templt);

而它将会被通过替换变成：

fprintf(stderr,"templt",);

很明显，这里仍然会产生编译错误(非本例的某些情况下不会产生编译错误)。除了这种方式外，c99和GNU CPP都支持下面的宏定义方式：

#define myprintf(templt,......) fprintf(stderr,templt, ##__VAR_ARGS__)

这时，##这个连接符号充当的作用就是当__VAR_ARGS__为空的时候，消除前面的那个逗号。那么此时的翻译过程如下：

myprintf(templt)；

被转化为：

fprintf(stderr，templt)；

这样如果templt合法，将不会产生编译错误。

另外，在vxworks中，还可以允许下面的宏定义:

#define myprintf(arg...) printf(arg)

宏的第一个参数就设置为变参，因此下面的几种使用方式都是正确的:

myprintf("number");
myprintf("number %d",2);
myprintf("number %d %d",2,3);

宏使用中的陷阱
这里列出了一些宏使用中容易出错的地方，以及合适的使用方式。

错误的嵌套－Misnesting

宏的定义不一定要有完整的、配对的括号，但是为了避免出错并且提高可读性，最好避免这样使用。

由操作符优先级引起的问题－Operator Precedence Problem

由于宏只是简单的替换，宏的参数如果是复合结构，那么通过替换之后可能由于各个参数之间的操作符优先级高于单个参数内部各部分之间相互作用的操作符优先级，如果我们不用括号保护各个宏参数，可能会产生预想不到的情形。比如：

#define ceil_div(x, y) (x + y - 1) / y

那么

a = ceil_div( b & c, sizeof(int) );

将被转化为：

a = ( b & c + sizeof(int) - 1) / sizeof(int);

// 由于+/-的优先级高于&的优先级，那么上面式子等同于：

a = ( b & (c + sizeof(int) - 1)) / sizeof(int);

这显然不是调用者的初衷。为了避免这种情况发生，应当多写几个括号：

define ceil_div(x, y) (((x) + (y) - 1) / (y))

消除多余的分号－Semicolon Swallowing

通常情况下，为了使函数模样的宏在表面上看起来像一个通常的C语言调用一样，通常情况下我们在宏的后面加上一个分号，比如下面的带参宏：

MY_MACRO(x);

但是如果是下面的情况：

#define MY_MACRO(x) { /
/* line 1 */ /
/* line 2 */ /
/* line 3 */ }
//......

if (condition())
MY_MACRO(a);
else
{......}

这样会由于多出的那个分号产生编译错误。为了避免这种情况出现同时保持MY_MACRO(x);的这种写法，我们需要把宏定义为这种形式：

#define MY_MACRO(x) do { /
/* line 1 */ /
/* line 2 */ /
/* line 3 */ } while(0)

这样只要保证总是使用分号，就不会有任何问题。

Duplication of Side Effects

这里的Side Effect是指宏在展开的时候对其参数可能进行多次Evaluation(也就是取值)，但是如果这个宏参数是一个函数，那么就有可能被调用多次从而达到不一致的结果，甚至会发生更严重的错误。比如：

#define min(X，Y) ((X) > (Y) ? (Y) : (X))
//......

c = min(a，foo(b));

这时foo()函数就被调用了两次。为了解决这个潜在的问题，我们应当这样写min(X,Y)这个宏：

#define min(X,Y) ({ /
typeof (X) x_ = (X); /
typeof (Y) y_ = (Y); /
(x_ < y_) ? x_ : y_;})

({......})的作用是将内部的几条语句中最后一条的值返回，它也允许在内部声明变量(因为它通过大括号组成了一个局部Scope)。