Conventions.html 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>Conventions (The GNU C Preprocessor Internals)</title>
  7. <meta name="description" content="Conventions (The GNU C Preprocessor Internals)">
  8. <meta name="keywords" content="Conventions (The GNU C Preprocessor Internals)">
  9. <meta name="resource-type" content="document">
  10. <meta name="distribution" content="global">
  11. <meta name="Generator" content="makeinfo">
  12. <link href="index.html" rel="start" title="Top">
  13. <link href="Concept-Index.html" rel="index" title="Concept Index">
  14. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  15. <link href="index.html" rel="up" title="Top">
  16. <link href="Lexer.html" rel="next" title="Lexer">
  17. <link href="index.html" rel="prev" title="Top">
  18. <style type="text/css">
  19. <!--
  20. a.summary-letter {text-decoration: none}
  21. blockquote.indentedblock {margin-right: 0em}
  22. div.display {margin-left: 3.2em}
  23. div.example {margin-left: 3.2em}
  24. div.lisp {margin-left: 3.2em}
  25. kbd {font-style: oblique}
  26. pre.display {font-family: inherit}
  27. pre.format {font-family: inherit}
  28. pre.menu-comment {font-family: serif}
  29. pre.menu-preformatted {font-family: serif}
  30. span.nolinebreak {white-space: nowrap}
  31. span.roman {font-family: initial; font-weight: normal}
  32. span.sansserif {font-family: sans-serif; font-weight: normal}
  33. ul.no-bullet {list-style: none}
  34. -->
  35. </style>
  36. </head>
  37. <body lang="en">
  38. <span id="Conventions"></span><div class="header">
  39. <p>
  40. Next: <a href="Lexer.html" accesskey="n" rel="next">Lexer</a>, Previous: <a href="index.html" accesskey="p" rel="prev">Top</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="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
  41. </div>
  42. <hr>
  43. <span id="Conventions-1"></span><h2 class="unnumbered">Conventions</h2>
  44. <span id="index-interface"></span>
  45. <span id="index-header-files"></span>
  46. <p>cpplib has two interfaces&mdash;one is exposed internally only, and the
  47. other is for both internal and external use.
  48. </p>
  49. <p>The convention is that functions and types that are exposed to multiple
  50. files internally are prefixed with &lsquo;<samp>_cpp_</samp>&rsquo;, and are to be found in
  51. the file <samp>internal.h</samp>. Functions and types exposed to external
  52. clients are in <samp>cpplib.h</samp>, and prefixed with &lsquo;<samp>cpp_</samp>&rsquo;. For
  53. historical reasons this is no longer quite true, but we should strive to
  54. stick to it.
  55. </p>
  56. <p>We are striving to reduce the information exposed in <samp>cpplib.h</samp> to the
  57. bare minimum necessary, and then to keep it there. This makes clear
  58. exactly what external clients are entitled to assume, and allows us to
  59. change internals in the future without worrying whether library clients
  60. are perhaps relying on some kind of undocumented implementation-specific
  61. behavior.
  62. </p>
  63. </body>
  64. </html>