Function-Names.html 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2017 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <title>Using the GNU Compiler Collection (GCC): Function Names</title>
  20. <meta name="description" content="Using the GNU Compiler Collection (GCC): Function Names">
  21. <meta name="keywords" content="Using the GNU Compiler Collection (GCC): Function Names">
  22. <meta name="resource-type" content="document">
  23. <meta name="distribution" content="global">
  24. <meta name="Generator" content="makeinfo">
  25. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="C-Extensions.html#C-Extensions" rel="up" title="C Extensions">
  30. <link href="Return-Address.html#Return-Address" rel="next" title="Return Address">
  31. <link href="Incomplete-Enums.html#Incomplete-Enums" rel="prev" title="Incomplete Enums">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.smallquotation {font-size: smaller}
  36. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.indentedblock {margin-left: 3.2em}
  39. div.lisp {margin-left: 3.2em}
  40. div.smalldisplay {margin-left: 3.2em}
  41. div.smallexample {margin-left: 3.2em}
  42. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style:oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nocodebreak {white-space:nowrap}
  54. span.nolinebreak {white-space:nowrap}
  55. span.roman {font-family:serif; font-weight:normal}
  56. span.sansserif {font-family:sans-serif; font-weight:normal}
  57. ul.no-bullet {list-style: none}
  58. -->
  59. </style>
  60. </head>
  61. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  62. <a name="Function-Names"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Return-Address.html#Return-Address" accesskey="n" rel="next">Return Address</a>, Previous: <a href="Incomplete-Enums.html#Incomplete-Enums" accesskey="p" rel="prev">Incomplete Enums</a>, Up: <a href="C-Extensions.html#C-Extensions" accesskey="u" rel="up">C Extensions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  66. </div>
  67. <hr>
  68. <a name="Function-Names-as-Strings"></a>
  69. <h3 class="section">6.48 Function Names as Strings</h3>
  70. <a name="index-_005f_005ffunc_005f_005f-identifier"></a>
  71. <a name="index-_005f_005fFUNCTION_005f_005f-identifier"></a>
  72. <a name="index-_005f_005fPRETTY_005fFUNCTION_005f_005f-identifier"></a>
  73. <p>GCC provides three magic constants that hold the name of the current
  74. function as a string. In C++11 and later modes, all three are treated
  75. as constant expressions and can be used in <code>constexpr</code> constexts.
  76. The first of these constants is <code>__func__</code>, which is part of
  77. the C99 standard:
  78. </p>
  79. <p>The identifier <code>__func__</code> is implicitly declared by the translator
  80. as if, immediately following the opening brace of each function
  81. definition, the declaration
  82. </p>
  83. <div class="smallexample">
  84. <pre class="smallexample">static const char __func__[] = &quot;function-name&quot;;
  85. </pre></div>
  86. <p>appeared, where function-name is the name of the lexically-enclosing
  87. function. This name is the unadorned name of the function. As an
  88. extension, at file (or, in C++, namespace scope), <code>__func__</code>
  89. evaluates to the empty string.
  90. </p>
  91. <p><code>__FUNCTION__</code> is another name for <code>__func__</code>, provided for
  92. backward compatibility with old versions of GCC.
  93. </p>
  94. <p>In C, <code>__PRETTY_FUNCTION__</code> is yet another name for
  95. <code>__func__</code>, except that at file (or, in C++, namespace scope),
  96. it evaluates to the string <code>&quot;top level&quot;</code>. In addition, in C++,
  97. <code>__PRETTY_FUNCTION__</code> contains the signature of the function as
  98. well as its bare name. For example, this program:
  99. </p>
  100. <div class="smallexample">
  101. <pre class="smallexample">extern &quot;C&quot; int printf (const char *, ...);
  102. class a {
  103. public:
  104. void sub (int i)
  105. {
  106. printf (&quot;__FUNCTION__ = %s\n&quot;, __FUNCTION__);
  107. printf (&quot;__PRETTY_FUNCTION__ = %s\n&quot;, __PRETTY_FUNCTION__);
  108. }
  109. };
  110. int
  111. main (void)
  112. {
  113. a ax;
  114. ax.sub (0);
  115. return 0;
  116. }
  117. </pre></div>
  118. <p>gives this output:
  119. </p>
  120. <div class="smallexample">
  121. <pre class="smallexample">__FUNCTION__ = sub
  122. __PRETTY_FUNCTION__ = void a::sub(int)
  123. </pre></div>
  124. <p>These identifiers are variables, not preprocessor macros, and may not
  125. be used to initialize <code>char</code> arrays or be concatenated with string
  126. literals.
  127. </p>
  128. <hr>
  129. <div class="header">
  130. <p>
  131. Next: <a href="Return-Address.html#Return-Address" accesskey="n" rel="next">Return Address</a>, Previous: <a href="Incomplete-Enums.html#Incomplete-Enums" accesskey="p" rel="prev">Incomplete Enums</a>, Up: <a href="C-Extensions.html#C-Extensions" accesskey="u" rel="up">C Extensions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  132. </div>
  133. </body>
  134. </html>