You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Diagnostics.html 5.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1987-2020 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. A copy of
  7. the license is included in the
  8. section entitled "GNU Free Documentation License".
  9. This manual contains no Invariant Sections. The Front-Cover Texts are
  10. (a) (see below), and the Back-Cover Texts are (b) (see below).
  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 6.5, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  20. <title>Diagnostics (The C Preprocessor)</title>
  21. <meta name="description" content="Diagnostics (The C Preprocessor)">
  22. <meta name="keywords" content="Diagnostics (The C Preprocessor)">
  23. <meta name="resource-type" content="document">
  24. <meta name="distribution" content="global">
  25. <meta name="Generator" content="makeinfo">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Index-of-Directives.html#Index-of-Directives" rel="index" title="Index of Directives">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="index.html#Top" rel="up" title="Top">
  30. <link href="Line-Control.html#Line-Control" rel="next" title="Line Control">
  31. <link href="Deleted-Code.html#Deleted-Code" rel="prev" title="Deleted Code">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.indentedblock {margin-right: 0em}
  36. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  37. blockquote.smallquotation {font-size: smaller}
  38. div.display {margin-left: 3.2em}
  39. div.example {margin-left: 3.2em}
  40. div.lisp {margin-left: 3.2em}
  41. div.smalldisplay {margin-left: 3.2em}
  42. div.smallexample {margin-left: 3.2em}
  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.nolinebreak {white-space: nowrap}
  54. span.roman {font-family: initial; font-weight: normal}
  55. span.sansserif {font-family: sans-serif; font-weight: normal}
  56. ul.no-bullet {list-style: none}
  57. -->
  58. </style>
  59. </head>
  60. <body lang="en">
  61. <a name="Diagnostics"></a>
  62. <div class="header">
  63. <p>
  64. Next: <a href="Line-Control.html#Line-Control" accesskey="n" rel="next">Line Control</a>, Previous: <a href="Conditionals.html#Conditionals" accesskey="p" rel="prev">Conditionals</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index-of-Directives.html#Index-of-Directives" title="Index" rel="index">Index</a>]</p>
  65. </div>
  66. <hr>
  67. <a name="Diagnostics-1"></a>
  68. <h2 class="chapter">5 Diagnostics</h2>
  69. <a name="index-diagnostic"></a>
  70. <a name="index-reporting-errors"></a>
  71. <a name="index-reporting-warnings"></a>
  72. <a name="index-_0023error"></a>
  73. <p>The directive &lsquo;<samp>#error</samp>&rsquo; causes the preprocessor to report a fatal
  74. error. The tokens forming the rest of the line following &lsquo;<samp>#error</samp>&rsquo;
  75. are used as the error message.
  76. </p>
  77. <p>You would use &lsquo;<samp>#error</samp>&rsquo; inside of a conditional that detects a
  78. combination of parameters which you know the program does not properly
  79. support. For example, if you know that the program will not run
  80. properly on a VAX, you might write
  81. </p>
  82. <div class="smallexample">
  83. <pre class="smallexample">#ifdef __vax__
  84. #error &quot;Won't work on VAXen. See comments at get_last_object.&quot;
  85. #endif
  86. </pre></div>
  87. <p>If you have several configuration parameters that must be set up by
  88. the installation in a consistent way, you can use conditionals to detect
  89. an inconsistency and report it with &lsquo;<samp>#error</samp>&rsquo;. For example,
  90. </p>
  91. <div class="smallexample">
  92. <pre class="smallexample">#if !defined(FOO) &amp;&amp; defined(BAR)
  93. #error &quot;BAR requires FOO.&quot;
  94. #endif
  95. </pre></div>
  96. <a name="index-_0023warning"></a>
  97. <p>The directive &lsquo;<samp>#warning</samp>&rsquo; is like &lsquo;<samp>#error</samp>&rsquo;, but causes the
  98. preprocessor to issue a warning and continue preprocessing. The tokens
  99. following &lsquo;<samp>#warning</samp>&rsquo; are used as the warning message.
  100. </p>
  101. <p>You might use &lsquo;<samp>#warning</samp>&rsquo; in obsolete header files, with a message
  102. directing the user to the header file which should be used instead.
  103. </p>
  104. <p>Neither &lsquo;<samp>#error</samp>&rsquo; nor &lsquo;<samp>#warning</samp>&rsquo; macro-expands its argument.
  105. Internal whitespace sequences are each replaced with a single space.
  106. The line must consist of complete tokens. It is wisest to make the
  107. argument of these directives be a single string constant; this avoids
  108. problems with apostrophes and the like.
  109. </p>
  110. </body>
  111. </html>