【原創】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__ 定義成字元串，是以它們可以和其他字元串進行串接操作。