Diagnostics.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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-2023 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.7, 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" rel="start" title="Top">
  27. <link href="Index-of-Directives.html" rel="index" title="Index of Directives">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="index.html" rel="up" title="Top">
  30. <link href="Line-Control.html" rel="next" title="Line Control">
  31. <link href="Deleted-Code.html" 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. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.lisp {margin-left: 3.2em}
  39. kbd {font-style: oblique}
  40. pre.display {font-family: inherit}
  41. pre.format {font-family: inherit}
  42. pre.menu-comment {font-family: serif}
  43. pre.menu-preformatted {font-family: serif}
  44. span.nolinebreak {white-space: nowrap}
  45. span.roman {font-family: initial; font-weight: normal}
  46. span.sansserif {font-family: sans-serif; font-weight: normal}
  47. ul.no-bullet {list-style: none}
  48. -->
  49. </style>
  50. </head>
  51. <body lang="en">
  52. <span id="Diagnostics"></span><div class="header">
  53. <p>
  54. Next: <a href="Line-Control.html" accesskey="n" rel="next">Line Control</a>, Previous: <a href="Conditionals.html" accesskey="p" rel="prev">Conditionals</a>, Up: <a href="index.html" 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" title="Index" rel="index">Index</a>]</p>
  55. </div>
  56. <hr>
  57. <span id="Diagnostics-1"></span><h2 class="chapter">5 Diagnostics</h2>
  58. <span id="index-diagnostic"></span>
  59. <span id="index-reporting-errors"></span>
  60. <span id="index-reporting-warnings"></span>
  61. <span id="index-_0023error"></span>
  62. <p>The directive &lsquo;<samp>#error</samp>&rsquo; causes the preprocessor to report a fatal
  63. error. The tokens forming the rest of the line following &lsquo;<samp>#error</samp>&rsquo;
  64. are used as the error message.
  65. </p>
  66. <p>You would use &lsquo;<samp>#error</samp>&rsquo; inside of a conditional that detects a
  67. combination of parameters which you know the program does not properly
  68. support. For example, if you know that the program will not run
  69. properly on a VAX, you might write
  70. </p>
  71. <div class="example">
  72. <pre class="example">#ifdef __vax__
  73. #error &quot;Won't work on VAXen. See comments at get_last_object.&quot;
  74. #endif
  75. </pre></div>
  76. <p>If you have several configuration parameters that must be set up by
  77. the installation in a consistent way, you can use conditionals to detect
  78. an inconsistency and report it with &lsquo;<samp>#error</samp>&rsquo;. For example,
  79. </p>
  80. <div class="example">
  81. <pre class="example">#if !defined(FOO) &amp;&amp; defined(BAR)
  82. #error &quot;BAR requires FOO.&quot;
  83. #endif
  84. </pre></div>
  85. <span id="index-_0023warning"></span>
  86. <p>The directive &lsquo;<samp>#warning</samp>&rsquo; is like &lsquo;<samp>#error</samp>&rsquo;, but causes the
  87. preprocessor to issue a warning and continue preprocessing. The tokens
  88. following &lsquo;<samp>#warning</samp>&rsquo; are used as the warning message.
  89. </p>
  90. <p>You might use &lsquo;<samp>#warning</samp>&rsquo; in obsolete header files, with a message
  91. directing the user to the header file which should be used instead.
  92. </p>
  93. <p>Neither &lsquo;<samp>#error</samp>&rsquo; nor &lsquo;<samp>#warning</samp>&rsquo; macro-expands its argument.
  94. Internal whitespace sequences are each replaced with a single space.
  95. The line must consist of complete tokens. It is wisest to make the
  96. argument of these directives be a single string constant; this avoids
  97. problems with apostrophes and the like.
  98. </p>
  99. </body>
  100. </html>