标签 宏 下的文章

当可执行程序版本信息变更时

在Unix/Linux上,我们一般可以通过两种方法查看到一个可执行程序的版本信息,以下以Ubuntu中的Gcc为例。

第一种方法:我们可以直接通过程序名字得到版本信息,例如:
$ which gcc
/usr/bin/gcc
$ ls -l /usr/bin/gcc
lrwxrwxrwx 1 root root 7 2010-08-21 00:18 /usr/bin/gcc -> gcc-4.4*

可以看到我用的Gcc的版本号为4.4,但似乎这个版本信息还不够全,只包含了major和minor版本号,还不包括bugfix修订号。

第二种方法,也是最常见的,获得版本信息最为详细的方法,它就是通过-v或–version命令行选项来查看可执行程序的版本号,绝大多数Unix/Linux下的程序都是支持这种方法的。比如:

$ gcc –version
gcc (Ubuntu 4.4.3-4ubuntu5) 4.4.3

可能有人会认为无论是将版本信息放入程序名字中还是在程序内部加上版本信息,都不是神马难事儿,没有必要单写一篇文章来说明。没错,这些的确不是什么困难的事。

在程序名字中放入版本号,通过Gcc命令即可完成:
$ gcc -o foo-1.3.1 foo.c

如果你使用Makefile来构建你的程序,你可以这样做:

/* Makefile */
TARGET = foo-1.3.1
all: $(TARGET)
    gcc -o $(TARGET) foo.c

而在程序内部加上版本信息的最简单方法莫过于在头文件中定义一个宏,然后在version函数中输出这个宏的内容:

/* version.h */
#define VERSION  "1.3.1"

/* version.c */
void version() {
    printf("%s\n", VERSION);
}

我相信很多朋友都是如是做的。

如果大家真的都是这样做的,那么问题就出现了:"当可执行程序的版本信息发生变更时,我们需要修改两个地方"。又有人会说:"修改两个地方也不是很麻烦啊"。没错,但这绝不是吹毛求疵,而是实实在在发生的问题。实际开发中很多开发人员总是只记得修改一处,而忘记了另外一处,这样就导致了两处版本信息的不一致。

我们不能完全依靠开发人员的细心和责任心来消除这一问题,我这里提供一种方法供大家参考:

我们在Makefile中像这样定义一组版本信息相关的变量,最重要的是通过一个外部宏定义FOO_VERSION_INFO将版本内容传递到程序内部:

# Makefile

MAJOR := 1
MINOR := 3
BUGFIX := 1

TARGET := foo-$(MAJOR).$(MINOR)

CFLAGS = -DFOO_VERSION_INFO=\"${MAJOR}.${MINOR}.${BUGFIX}\"

all:
    gcc -o $(TARGET) $(CFLAGS) foo.c

/* foo.c */
void version() {
    /* 这里直接使用Makefile中定义的FOO_VERSION_INFO宏 */
    printf("%s\n", FOO_VERSION_INFO);
}

int main() {
    version();
    return 0;
}

$ foo-1.3
$ 1.3.1

这样一来,即使版本号发生变更了,我们也只需修改Makefile这一处包含版本信息的文件即可。

很多可执行程序的文件名中并不包含版本信息,像ls。如果是这样的话,一切就变得简单了。但是若像Gcc那样,在程序名以及程序内部都包含有版本信息的,我相信使用这个方法/技巧还是大有裨益的。

关于宏定义切换以及屏蔽的例子

assert是大家常用的宏,它的用法相信大家都有所了解。P.J Plauger的"The C Standard Library"一书中提到在源代码中切换assert宏定义的方法:
/* turn assertion on */
#undef NDEBUG
#include

/* turn assertions off */
#define NDEBUG
#include

我顺手写了一个例子如下:
/* testmacro1.c */
#define NDEBUG
#include

int main() {

        assert(0); // => ((void)0);

#undef NDEBUG
        #include
        assert(0); // => (void)((0) || (__assert("0", "testmacro.c", 10), 0));
}
测试结果正如P.J Plauger的说明。但仔细看来似乎有些疑惑:总觉得第二个assert也应该展开成((void)0)才对啊。由于NDEBUG被定义,在第一次assert.h展开时,assert就被替换成了((void)0),而后虽然NDEBUG被disable了,但此时由于assert.h的header file guard保护,assert的新定义并没有被重新loaded & evaluated,所以assert似乎依然应该被展开为((void)0),但执行结果却不是。

我自己写了一个程序测试了一下:
/* testmacro1.h */
#ifndef TEST_MACRO1_H
#define TEST_MACRO1_H

#ifdef X_DEBUG
#define x_debug(expr)   ((void)0)
#else
#define x_debug(expr)   #expr
#endif
#endif

/* testmacro1.c */
#define X_DEBUG
#include "testmacro1.h"

int main() {
        x_debug(0); // => ((void)0);

#undef X_DEBUG
        #include "testmacro1.h"
        x_debug(0); // => ((void)0)
}
果不其然,结果正如我所猜测的:
#undef X_DEBUG
#include "testmacro1.h"
并没有改变x_debug的定义,那么第一个例子到底是怎么回事呢?

其实这是C标准库设计所致,打开你所在系统的assert.h标准文件,我在sun solairs 9上是这样的:
#ifndef _ASSERT_H
#define _ASSERT_H
… …
#endif

#undef  assert
#ifdef  NDEBUG
#define assert(EX) ((void)0)
#else
#define assert(EX) (void)((EX) || (__assert(#EX, __FILE__, __LINE__), 0))
#endif  /* NDEBUG */

哈哈,这下子看清楚了,原来assert的定义根本不在Header File Guards的保护下,怪不得我思前想后都对不上呢:),因为没有File Guards的保护。使头文件中的宏有机会被重新loaded&envaluated。

下面例子中的第三个assert屏蔽掉了标准库中的assert实现:
/* testmacro3.c */
#define NDEBUG
#include

int main() {

        assert(0); // => ((void)0);

#undef NDEBUG
        #include
        assert(0); // => (void)((0) || (__assert("0", "testmacro3.c", 10), 0));

#define assert(exp) (#exp)
        assert(x==0); // => ("x==0");
}
这种屏蔽很简单,就不多说了,自己看吧。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats