C里的宏
宏名: assert
功 能: 测试一个条件并可能使程序终止
用 法: void assert(int test);
程序例:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
struct
ITEM {
int
key;
int
value;
};
/* add item to list, make sure list is not null */
void
additem(
struct
ITEM *itemptr) {
assert
(itemptr != NULL);
/* add item to list */
}
int
main(
void
)
{
additem(NULL);
return
0;
}
|
assert() 宏用法
注意:assert是宏,而不是函数。在C的
assert.h头文件中。
assert宏的原型定义在<assert.h>中,其作用是如果它的条件返回错误,则终止程序执行,原型定义:
1
2
|
#include <assert.h>
void
assert
(
int
expression );
|
assert的作用是先计算表达式
expression,如果其值为假(即为0),那么它先向标准错误流
stderr打印一条出错信息,然后通过调用
abort来终止程序运行;否则,assert()无任何作用。宏assert()一般用于确认程序的正常操作,其中表达式构造无错时才为真值。完成调试后,不必从源代码中删除assert()语句,因为宏NDEBUG有定义时,宏assert()的定义为空。
[1]
请看下面的程序清单badptr.c:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
#include <stdio.h>
#include <assert.h>
#include <stdlib.h>
int
main(
void
)
{
FILE
*fp;
fp =
fopen
(
"test.txt"
,
"w"
);
//以可写的方式打开一个文件,如果不存在就创建一个同名文件
assert
( fp );
//所以这里不会出错
fclose
( fp );
fp =
fopen
(
"noexitfile.txt"
,
"r"
);
//以只读的方式打开一个文件,如果不存在就打开文件失败
assert
( fp );
//所以这里出错
fclose
( fp );
//程序永远都执行不到这里来
return
0;
}
|
[root@localhost error_process]# gcc badptr.c
[root@localhost error_process]# ./a.out
a.out: badptr.c:14: main: Assertion `fp' failed.
已放弃
使用assert的缺点是,频繁的调用会极大的影响程序的性能,增加额外的开销。
在调试结束后,可以通过在包含#include <assert.h>的语句之前插入 #define NDEBUG 来禁用assert调用,示例代码如下:
1
2
3
|
#include <stdio.h>
#define NDEBUG
#include <assert.h>
|
用法总结与注意事项:
1)在函数开始处检验传入参数的合法性
如:
1
2
3
4
5
6
7
8
9
10
|
int
resetBufferSize(
int
nNewSize)
{
//功能:改变缓冲区大小,
//参数:nNewSize缓冲区新长度
//返回值:缓冲区当前长度
//说明:保持原信息内容不变 nNewSize<=0表示清除缓冲区
assert
(nNewSize >= 0);
assert
(nNewSize <= MAX_BUFFER_SIZE);
...
}
|
2)每个assert只检验一个条件,因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败
1
2
3
4
5
|
/***不好***/
assert
(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);
/****好****/
assert
(nOffset >= 0);
assert
(nOffset+nSize <= m_nInfomationSize);
|
3)不能使用改变环境的语句,因为assert只在DEBUG个生效,如果这么做,会使用程序在真正运行时遇到问题
错误: assert(i++ < 100)
这是因为如果出错,比如在执行之前i=100,那么这条语句就不会执行,那么i++这条命令就没有执行。
正确: assert(i < 100)
i++;
4)assert和后面的语句应空一行,以形成逻辑和视觉上的一致感
5)有的地方,assert不能代替条件过滤
注意:当对于浮点数:
1
2
3
|
#include<assert.h>
float
pi=3.14f;
assert
(pi==3.14f);
|
在switch语句中总是要有default子句来显示信息(Assert)。
1
2
3
4
5
6
7
8
9
10
11
12
13
|
int
number = SomeMethod();
switch
(number)
{
case
1:
Trace.WriteLine(
"Case 1:"
);
break
;
case
2:
Trace.WriteLine(
"Case 2:"
);
break
;
default
:
Debug.Assert(
false
);
break
;
}
|