【原创】G_STRLOC 宏

       研究 mysql proxy 源码过程时，经常会看到类似下面这种调试打印： 

<a href="http://my.oschina.net/moooofly/blog/113979#">?</a>

1

2

3

<code>if</code> <code>(0 != network_mysqld_con_command_states_init(con, &amp;p)) {</code>

<code>    </code><code>g_debug(</code><code>"%s: "</code><code>, g_strloc);</code>

<code>}</code>

       其中的  g_strloc 是什么呢？ 查看 glib 的源码（glib-2.35.4），可知 

<code>#define g_stringify(macro_or_string)    g_stringify_arg (macro_or_string)</code>

<code>#define g_stringify_arg(contents)       #contents</code>

4

5

6

<code>/* provide a string identifying the current code position */</code>

<code>#if defined(__gnuc__) &amp;&amp; (__gnuc__ &lt; 3) &amp;&amp; !defined(__cplusplus)</code>

<code>#  define g_strloc  __file__ ":" g_stringify (__line__) ":" __pretty_function__ "()"</code>

<code>#else</code>

<code>#  define g_strloc  __file__ ":" g_stringify (__line__)</code>

<code>#endif</code>

 综上，g_strloc 是用于定位打印信息所在位置的宏。 

------------------ 

之前遗漏了针对上述代码中 __gnuc__ 值的判定说明，glib 中代码注释如下： 

7

8

9

10

11

12

13

<code>#ifndef g_disable_deprecated</code>

<code>/* wrap the gcc __pretty_function__ and __function__ variables with</code>

<code> </code><code>* macros, so we can refer to them as strings unconditionally.</code>

<code> </code><code>* usage not-recommended since gcc-3.0</code>

<code> </code><code>*/</code>

<code>    </code><code>#if defined (__gnuc__) &amp;&amp; (__gnuc__ &lt; 3)</code>

<code>        </code><code>#define g_gnuc_function         __function__</code>

<code>        </code><code>#define g_gnuc_pretty_function  __pretty_function__</code>

<code>    </code><code>#else   /* !__gnuc__ */</code>

<code>        </code><code>#define g_gnuc_function         ""</code>

<code>        </code><code>#define g_gnuc_pretty_function  ""</code>

<code>    </code><code>#endif  /* !__gnuc__ */</code>

<code>#endif  /* !g_disable_deprecated */</code>

       大致意思是：如果你没有通过定义宏 g_disable_deprecated 显式地要求不允许使用已经过时功能的话，那么在 gcc-3.0 之前的版本中，宏 __function__ 和 __pretty_function__ 是可用的，并且以字符串形式呈现。 

        现在问题变成了： __file__、 __line__、 __pretty_function__、 __gnuc__ 和  __cplusplus  都是什么？ 可以参考下面的文章说明： 

======= 我是分隔线 =========

【前言】

       我们在写程序的时候，总是或多或少会加入一些 printf 之类的语句用于输出调试信息，但是 printf 语句有个很不方便的地方，就是当我们需要发布程序的时候，要一条一条的把这些语句删除，而一旦需要再次调试的时候，这些语句又不得不一条条的加上，这给我们带来了很大的不便，浪费了我们很多的时间，也造成了调试的效率低下。所以很多人会选择使用宏定义的方式来输出调试语句。 

比如，定义一个宏开关： 

<code>#define __debug</code>

当需要调试的时候，使用语句： 

<code>#ifdef __debug</code>

<code>    </code><code>printf</code><code>(xxx);</code>

        这种方式的调试，可以通过 #undef __debug 的方式让告知编译器不编译这些语句，从而不再输出这些语句。但是这种方式的麻烦之处也是显而易见的，每一条调试语句都需要使用两条宏定义来包围，这不但在代码的编写上不便，源码结构也不好看，工作量依然不小。 

      如果我们能够把这三条语句编程一条，那该多舒服呀~，于是，我们想到使用这样的语句： 

<code>    </code><code>#define debug(info)   </code><code>printf</code><code>(info)</code>

<code>    </code><code>#define debug(info)</code>

       这样，我们在编写代码的时候，使用 debug 一条语句就可以了，我们把宏开关 __debug 打开，所有的debug(info) 宏定义信息都会被替换为 printf(info) ，关上则会被替换成空，因此不会被编译。嗯，这次方便多了，一条语句就可以了~~~。但是，问题也随之而来了，printf 是支持多个参数的，而且是不定参数，当你使用下面这样的语句时就会报错： 

<code>debug(</code><code>"%s"</code><code>,msg)</code>

这是因为，debug(info) 这条宏定义只支持一个参数的替换。 

       因此，我们希望 debug 能够像 printf 那样，支持多个参数，并且这些参数刚好展开成为 printf 语句本身使用的参数，譬如我们希望 debug("%s",msg) 能够展开为 printf("%s",msg) 。

【正文】 

于是，我们定义了一个这样的东东： 

<code>#define debug(format, ...) printf (format, ##__va_args__)</code>

       其中，' ## ' 的意思是，如果可变参数被忽略或为空，将使预处理器（ preprocessor ）去除掉它前面的那个逗号。 

       于是乎，我们神奇地发现，debug 完全取代了 printf ，所有的 debug(…) 都被完成的替换成了 printf(…) ，再也不会因那个可恶的逗号而烦恼了。 

       但是，我们发现，光有 printf 还不够，虽然调试信息是输出了，可是很多的调试信息输出，我们并不能一下子知道这条信息到底是在那里打印出来的，于是，我们又想，能不能把当前所在文件名和源码行位置也打印出来呢，这样不就一目了然了吗，哪里还用的着去想，去找调试信息在哪里输出的呢，都已经打印出来了！ 

      于是我们就有了下面的故事。。。

【编译器内置宏】 

      先介绍几个编译器内置的宏定义，这些宏定义不仅可以帮助我们完成跨平台的源码编写，灵活使用也可以巧妙地帮我们输出非常有用的调试信息。 

ansi c 标准中有几个标准预定义宏（也是常用的）： 

__line__：在源代码中插入当前源代码行号；

__file__：在源文件中插入当前源文件名；

__date__：在源文件中插入当前的编译日期；

__time__：在源文件中插入当前编译时间；

__stdc__：当要求程序严格遵循ansi c标准时该标识被赋值为1；

__cplusplus：当编写 c++ 程序时该标识符被定义。

编译器在进行源码编译的时候，会自动将这些宏替换为相应内容。 

      看到这里，你的眼睛应该一亮了吧，嗯，是的，__file__ 和 __line__ 正是我们前面想要的输出的，于是，我们的每一条语句都变成了： 

<code>debug(</code><code>"file: %s, line: %d…"</code><code>,__file__,__line__,…)</code>

      其实没有必要，__file__ 本身就会被编译器置换为字符常量，于是乎我们的语句又变成了这样： 

<code>debug(</code><code>"file:"</code><code>__file__</code><code>", line: %d…"</code><code>,__line__,…)</code>

      但是，我们还是不满足，依然发现，还是很讨厌，为什么每条语句都要写 "file:"__file__", line: %d" 以及 ",__line__," 这两个部分呢？这不是浪费我们时间么？ 

      哈哈，是的，这就是本次大结局，把 debug 写成这样： 

<code>debug(format,...)</code><code>printf</code><code>(</code><code>"file: "</code><code>__file__</code><code>", line: %d: "</code><code>format</code><code>"/n"</code><code>, __line__, ##__va_args__)</code>

       没错，就是这样！下面，所有的 debug 信息都会按照这样的方式输出： 

<code>file: xxx, line: xxx, …….</code>

      最后，老规矩，coding测试。

14

15

<code>#include &lt;stdio.h&gt;</code>

<code>#define __debug__</code>

<code>#ifdef __debug__</code>

<code>        </code><code>#define debug(format, ...) printf("file: "__file__", line: %05d   "format"\n", __line__, ##__va_args__)</code>

<code>        </code><code>#define debug(format, ...)</code>

<code>int</code> <code>main()</code>

<code>{</code>

<code>        </code><code>char</code> <code>str[] =</code><code>"hello world"</code><code>;</code>

<code>        </code><code>debug(</code><code>"a ha, check me: %s"</code><code>, str);</code>

<code>        </code><code>return</code> <code>0;</code>

输出结果

<code>[root@betty cpp_code]</code><code># gcc print_debug_by_macro.cpp -lstdc++</code>

<code>[root@betty cpp_code]</code><code># ./a.out</code>

<code>file: print_debug_by_macro.cpp, line: 00013   a ha, check me: hello world</code>

============== __gnuc__、_msc_ver ==================

【__gnuc__】

__gnuc__ 是 gcc 编译器编译代码时预定义的一个宏。需要针对 gcc 编写代码时， 可以使用该宏进行条件编译。

__gnuc__ 值表示 gcc 的主版本号。针对 gcc 特定版本编写代码时，可使用该宏进行条件编译。

__gnuc__ 的类型是 "int" ，该宏被扩展后得到的是整数字面值。可以通过预处理，查看宏扩展后的文本。

示例：

16

17

<code>#include &lt;assert.h&gt;</code>

<code>#include &lt;typeinfo&gt;</code>

<code>#ifndef __gnuc__</code>

<code>    </code><code>#error sample</code><code>for</code> <code>gcc compiler</code>

<code>　　</code><code>/* use gcc special extension: #warning , __attribute__, etc.  */</code>

<code>    </code><code>printf</code><code>(</code><code>"hello gcc %d\n"</code><code>,__gnuc__);</code>

<code>    </code><code>assert</code><code>(</code><code>typeid</code><code>(__gnuc__)==</code><code>typeid</code><code>(</code><code>int</code><code>) );</code>

<code>    </code><code>printf</code><code>(</code><code>"press enter to exit\n"</code><code>);</code>

<code>    </code><code>(</code><code>void</code><code>)</code><code>getchar</code><code>();</code>

【 _msc_ver】 

 _msc_ver 是微软 c/c++ 编译器 -- cl.exe 编译代码时预定义的一个宏。需要针对 cl.exe 编写代码时， 可以使用该宏进行条件编译。

_msc_ver 的值表示 cl.exe 的版本。需要针对 cl.exe 特定版本编写代码时， 可使用该宏进行条件编译。

_msc_ver 的类型是 "int" 。该宏扩展后得到的是整数字面值。可以通过预处理， 查看宏扩展后的文本。

18

19

20

21

22

23

24

25

26

27

28

<code>#include &lt;stdlib.h&gt;</code>

<code>#define to_literal(text) to_literal_(text)</code>

<code>#define to_literal_(text) #text</code>

<code>#ifndef _msc_ver</code>

<code>    </code><code>#error sample</code><code>for</code> <code>msvc compiler</code>

<code>    </code><code>/* use msvc special extension: #pragma message,__declspec,__stdcall,etc. */</code>

<code>    </code><code>#pragma message("----------------------------------------\n")</code>

<code>    </code><code>#pragma message(</code><code>"----------------------------------------\n"</code><code>)</code>

<code>    </code><code>#pragma message(</code><code>"---------- hello msvc "</code> <code>to_literal(_msc_ver)</code><code>" -------------"</code><code>)</code>

<code>    </code><code>#pragma message(</code><code>"\n----------------------------------------\n"</code><code>)</code>

<code>    </code><code>extern</code> <code>__declspec</code><code>(</code><code>dllimport</code><code>)</code><code>void</code> <code>__stdcall declare_but_dont_reference(</code><code>void</code><code>);</code>

<code>    </code><code>printf</code><code>(</code><code>"hello msvc, version=%d\n"</code><code>,_msc_ver);</code>

<code>    </code><code>printf</code><code>(</code><code>"typeof _msc_ver=\"%s\"\n"</code><code>,</code><code>typeid</code><code>(_msc_ver).name());</code>

<code>    </code><code>system</code><code>(</code><code>"pause"</code><code>);</code><code>/* msvc only on windows? */</code>

<code>    </code><code>return</code> <code>0;</code>

============== __pretty_function__ ==================

gcc 编译器预定义了两个标识符存储当前函数的标识。

      __function__ 标识符只存储函数名字，__pretty_function__ 则存储函数的全称。在 c 程序里，这两种名字是一样的，但是在 c++ 程序里它们有区别。

       在 c++ 里，__function__ 和 __pretty_function__ 是变量，而不是宏定义，所以 #ifdef __function__ 是没有意义的。

注意：如果你的 gcc 是 3.2 版本或更高，那么 __function__ 和 __pretty_function__ 的行为就和 c99 定义的 __func__ 变量是一样的。早于 3.2 版本的 gcc 编译器把 __function__ 和 __pretty_function__ 定义成字符串，所以它们可以和其他字符串进行串接操作。