Diagnostic-Pragmas.html 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  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): Diagnostic Pragmas</title>
  20. <meta name="description" content="Using the GNU Compiler Collection (GCC): Diagnostic Pragmas">
  21. <meta name="keywords" content="Using the GNU Compiler Collection (GCC): Diagnostic Pragmas">
  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="Pragmas.html#Pragmas" rel="up" title="Pragmas">
  30. <link href="Visibility-Pragmas.html#Visibility-Pragmas" rel="next" title="Visibility Pragmas">
  31. <link href="Weak-Pragmas.html#Weak-Pragmas" rel="prev" title="Weak Pragmas">
  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="Diagnostic-Pragmas"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Visibility-Pragmas.html#Visibility-Pragmas" accesskey="n" rel="next">Visibility Pragmas</a>, Previous: <a href="Weak-Pragmas.html#Weak-Pragmas" accesskey="p" rel="prev">Weak Pragmas</a>, Up: <a href="Pragmas.html#Pragmas" accesskey="u" rel="up">Pragmas</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="Diagnostic-Pragmas-1"></a>
  69. <h4 class="subsection">6.62.12 Diagnostic Pragmas</h4>
  70. <p>GCC allows the user to selectively enable or disable certain types of
  71. diagnostics, and change the kind of the diagnostic. For example, a
  72. project&rsquo;s policy might require that all sources compile with
  73. <samp>-Werror</samp> but certain files might have exceptions allowing
  74. specific types of warnings. Or, a project might selectively enable
  75. diagnostics and treat them as errors depending on which preprocessor
  76. macros are defined.
  77. </p>
  78. <dl compact="compact">
  79. <dt><code>#pragma GCC diagnostic <var>kind</var> <var>option</var></code></dt>
  80. <dd><a name="index-pragma_002c-diagnostic"></a>
  81. <p>Modifies the disposition of a diagnostic. Note that not all
  82. diagnostics are modifiable; at the moment only warnings (normally
  83. controlled by &lsquo;<samp>-W&hellip;</samp>&rsquo;) can be controlled, and not all of them.
  84. Use <samp>-fdiagnostics-show-option</samp> to determine which diagnostics
  85. are controllable and which option controls them.
  86. </p>
  87. <p><var>kind</var> is &lsquo;<samp>error</samp>&rsquo; to treat this diagnostic as an error,
  88. &lsquo;<samp>warning</samp>&rsquo; to treat it like a warning (even if <samp>-Werror</samp> is
  89. in effect), or &lsquo;<samp>ignored</samp>&rsquo; if the diagnostic is to be ignored.
  90. <var>option</var> is a double quoted string that matches the command-line
  91. option.
  92. </p>
  93. <div class="smallexample">
  94. <pre class="smallexample">#pragma GCC diagnostic warning &quot;-Wformat&quot;
  95. #pragma GCC diagnostic error &quot;-Wformat&quot;
  96. #pragma GCC diagnostic ignored &quot;-Wformat&quot;
  97. </pre></div>
  98. <p>Note that these pragmas override any command-line options. GCC keeps
  99. track of the location of each pragma, and issues diagnostics according
  100. to the state as of that point in the source file. Thus, pragmas occurring
  101. after a line do not affect diagnostics caused by that line.
  102. </p>
  103. </dd>
  104. <dt><code>#pragma GCC diagnostic push</code></dt>
  105. <dt><code>#pragma GCC diagnostic pop</code></dt>
  106. <dd>
  107. <p>Causes GCC to remember the state of the diagnostics as of each
  108. <code>push</code>, and restore to that point at each <code>pop</code>. If a
  109. <code>pop</code> has no matching <code>push</code>, the command-line options are
  110. restored.
  111. </p>
  112. <div class="smallexample">
  113. <pre class="smallexample">#pragma GCC diagnostic error &quot;-Wuninitialized&quot;
  114. foo(a); /* error is given for this one */
  115. #pragma GCC diagnostic push
  116. #pragma GCC diagnostic ignored &quot;-Wuninitialized&quot;
  117. foo(b); /* no diagnostic for this one */
  118. #pragma GCC diagnostic pop
  119. foo(c); /* error is given for this one */
  120. #pragma GCC diagnostic pop
  121. foo(d); /* depends on command-line options */
  122. </pre></div>
  123. </dd>
  124. </dl>
  125. <p>GCC also offers a simple mechanism for printing messages during
  126. compilation.
  127. </p>
  128. <dl compact="compact">
  129. <dt><code>#pragma message <var>string</var></code></dt>
  130. <dd><a name="index-pragma_002c-diagnostic-1"></a>
  131. <p>Prints <var>string</var> as a compiler message on compilation. The message
  132. is informational only, and is neither a compilation warning nor an error.
  133. </p>
  134. <div class="smallexample">
  135. <pre class="smallexample">#pragma message &quot;Compiling &quot; __FILE__ &quot;...&quot;
  136. </pre></div>
  137. <p><var>string</var> may be parenthesized, and is printed with location
  138. information. For example,
  139. </p>
  140. <div class="smallexample">
  141. <pre class="smallexample">#define DO_PRAGMA(x) _Pragma (#x)
  142. #define TODO(x) DO_PRAGMA(message (&quot;TODO - &quot; #x))
  143. TODO(Remember to fix this)
  144. </pre></div>
  145. <p>prints &lsquo;<samp>/tmp/file.c:4: note: #pragma message:
  146. TODO - Remember to fix this</samp>&rsquo;.
  147. </p>
  148. </dd>
  149. </dl>
  150. <hr>
  151. <div class="header">
  152. <p>
  153. Next: <a href="Visibility-Pragmas.html#Visibility-Pragmas" accesskey="n" rel="next">Visibility Pragmas</a>, Previous: <a href="Weak-Pragmas.html#Weak-Pragmas" accesskey="p" rel="prev">Weak Pragmas</a>, Up: <a href="Pragmas.html#Pragmas" accesskey="u" rel="up">Pragmas</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>
  154. </div>
  155. </body>
  156. </html>