C语言边角料4:利用_Pragma来温柔的废弃API

时间:2021-05-02

一、前言

想象一下这个工作场景:你在为一个项目写一个功能库,别人调用库中提供的函数,后来你发现库里的函数A是多余的。

具有完美情节的你,就是想把这个函数A废弃掉,此时肯定是不能直接删掉,因为你不知道别人在多少个地方调用了这个函数。

这种情况如何处理比较好呢?

这篇小短文就来聊一聊这个问题。

二、操作过程

1. 第一个版本的库

测试文件只有 3 个:api.h, api.c 和 main.c

  • api.h 和 api.c: 库文件,编译得到 libapi.so;
  • main.c:生成可执行程序,利用了上面生成的库 libapi.so;

api.h 文件内容:声明了 2 个函数。

api.c 文件内容:定义了 2 个函数。

编译得到库文件 libapi.so。编译指令:

  • gcc-fPIC-sharedapi.c-olibapi.so
  • main.c 文件内容:

    编译得到可执行文件:

  • gccmain.c-omain-L./-Wl,-rpath=./-lapi
  • 以上代码的简单程度,等价于 helloworld 了。

    2. 第二个版本的库

    现在,你觉得 init 这个函数是多余的,想把它去掉,可以这么来修改。

    api.c 文件中,把 init() 函数删除掉。

    api.h 文件内容改为如下:

    关键代码是这一行:

  • #defineinit()(1)API_DEPRECATED
  • 既然 api.c 文件已经把这个函数删除了,但是 main.c 文件中又调用了这个函数,因此以宏定义的形式提供 init 这个符号。

    也就是说:

    在第一个版本中,main.c 文件中的 init 是一个函数,被编译器处理,在链接阶段从 libapi.so 库中找到这个函数的地址;

    在第二个版本中,init 被定义成宏,在预处理阶段被替换成后面的 (1) API_DEPRECATED。

    • (1) 是在宏替换时的表达式。因为这个函数可能被用在 if 条件判断中,因此需要返回一个值。
    • API_DEPRECATED 是另一个宏定义,扩展开来后就是让编译器在编译可执行程序时,打印出一段提示信息。

    在编译可执行文件时,编译器输出下面的这段话:

  • gccmain.c-omain-L./-Wl,-rpath=./-lapi
  • 这样就达到了最初的目的!也就是提示使用者:这个函数已经被废弃了,最好别用它!

    三 _Prama 其他用法

    _Pragma 类似于 Microsoft 特定的 __pragma 关键字,只不过它是标准的一部分。它是在 C99 中为 C 引入的。对于 c + +,它是在 c + + 11 中引入的。它允许将指令放入宏定义中。

    1. 处理头文件重复包含

    在头文件中,为了防止被重复包含,一般有 3 种处理方式:

    (1) 第一种处理方式:

  • #ifdefMY_API
  • #defineMY_API
  • //头文件内容
  • #endif
  • (2) 第二种处理方式

  • #pragmaonce
  • //头文件内容
  • 以上这 2 种方式都可以防止同一个头文件被重复包含,但是还是有一些区别的。

    第一种方式:预处理器还是需要去搜寻文件,然后打开文件,读取文件的内容之后,检查 MY_API 是否已经被定义过。

    第二种方式:能加快编译速度,因为这是一种高端的机制;编译器会自动比对文件名,而不需要在头文件去判断 #ifndef 和 #endif,这样就省去了中间的搜寻、打开和读取操作。

    (3) 第三种处理方式

  • _Pragma("once")
  • 这种方式与第二种方式的区别是:

    • #pragma :是一条预处理的指令,用来向编译器传达语言标准以外的一些信息,不能使用在宏中;
    • _Pragma :是一个操作符,属于语言的标准,因此可以嵌套在宏中,就像上面示例中那样;

    #pragma 是编译器的扩展,也就是说它是由编译器来决定的,也许编译器A支持,但是编译器B就不一定支持了,虽然这种可能性比较小。

    _Pragma 操作符是语言层面的标准,既然是标准,那么编译器就必须要遵循标准,所以也推荐使用这种方式。

    记得侯杰老师在 C++ 的视频课程中说到:我们写代码,不仅仅要保证功能上的正确,而且要把代码写的很大气!我感觉用 _Pragma 可能比 #ifndef 更大气一些。

    2. 输出编译信息

  • #pragmamessage("the#pragmaway")
  • _Pragma("message(\"the_Pragmaway\")")
  • 上面两行的内容输出信息是一样的,需要注意的是嵌套的双引号需要用反斜线去转义。

    原文地址:https://mp.weixin.qq.com/s/zmi7f-03fgTLgO_ZHcMk_g

    声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。

    相关文章