Include-Syntax.html 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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>Include Syntax (The C Preprocessor)</title>
  21. <meta name="description" content="Include Syntax (The C Preprocessor)">
  22. <meta name="keywords" content="Include Syntax (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="Header-Files.html" rel="up" title="Header Files">
  30. <link href="Include-Operation.html" rel="next" title="Include Operation">
  31. <link href="Header-Files.html" rel="prev" title="Header Files">
  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="Include-Syntax"></span><div class="header">
  53. <p>
  54. Next: <a href="Include-Operation.html" accesskey="n" rel="next">Include Operation</a>, Up: <a href="Header-Files.html" accesskey="u" rel="up">Header Files</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="Include-Syntax-1"></span><h3 class="section">2.1 Include Syntax</h3>
  58. <span id="index-_0023include"></span>
  59. <p>Both user and system header files are included using the preprocessing
  60. directive &lsquo;<samp>#include</samp>&rsquo;. It has two variants:
  61. </p>
  62. <dl compact="compact">
  63. <dt><code>#include &lt;<var>file</var>&gt;</code></dt>
  64. <dd><p>This variant is used for system header files. It searches for a file
  65. named <var>file</var> in a standard list of system directories. You can prepend
  66. directories to this list with the <samp>-I</samp> option (see <a href="Invocation.html">Invocation</a>).
  67. </p>
  68. </dd>
  69. <dt><code>#include &quot;<var>file</var>&quot;</code></dt>
  70. <dd><p>This variant is used for header files of your own program. It
  71. searches for a file named <var>file</var> first in the directory containing
  72. the current file, then in the quote directories and then the same
  73. directories used for <code>&lt;<var>file</var>&gt;</code>. You can prepend directories
  74. to the list of quote directories with the <samp>-iquote</samp> option.
  75. </p></dd>
  76. </dl>
  77. <p>The argument of &lsquo;<samp>#include</samp>&rsquo;, whether delimited with quote marks or
  78. angle brackets, behaves like a string constant in that comments are not
  79. recognized, and macro names are not expanded. Thus, <code>#include&nbsp;&lt;x/*y&gt;<!-- /@w --></code> specifies inclusion of a system header file named <samp>x/*y</samp>.
  80. </p>
  81. <p>However, if backslashes occur within <var>file</var>, they are considered
  82. ordinary text characters, not escape characters. None of the character
  83. escape sequences appropriate to string constants in C are processed.
  84. Thus, <code>#include&nbsp;&quot;x\n\\y&quot;<!-- /@w --></code> specifies a filename containing three
  85. backslashes. (Some systems interpret &lsquo;<samp>\</samp>&rsquo; as a pathname separator.
  86. All of these also interpret &lsquo;<samp>/</samp>&rsquo; the same way. It is most portable
  87. to use only &lsquo;<samp>/</samp>&rsquo;.)
  88. </p>
  89. <p>It is an error if there is anything (other than comments) on the line
  90. after the file name.
  91. </p>
  92. </body>
  93. </html>