Enumerator-Attributes.html 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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): Enumerator Attributes</title>
  20. <meta name="description" content="Using the GNU Compiler Collection (GCC): Enumerator Attributes">
  21. <meta name="keywords" content="Using the GNU Compiler Collection (GCC): Enumerator Attributes">
  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="C-Extensions.html#C-Extensions" rel="up" title="C Extensions">
  30. <link href="Statement-Attributes.html#Statement-Attributes" rel="next" title="Statement Attributes">
  31. <link href="Label-Attributes.html#Label-Attributes" rel="prev" title="Label Attributes">
  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="Enumerator-Attributes"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Statement-Attributes.html#Statement-Attributes" accesskey="n" rel="next">Statement Attributes</a>, Previous: <a href="Label-Attributes.html#Label-Attributes" accesskey="p" rel="prev">Label Attributes</a>, Up: <a href="C-Extensions.html#C-Extensions" accesskey="u" rel="up">C Extensions</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="Enumerator-Attributes-1"></a>
  69. <h3 class="section">6.35 Enumerator Attributes</h3>
  70. <a name="index-Enumerator-Attributes"></a>
  71. <p>GCC allows attributes to be set on enumerators. See <a href="Attribute-Syntax.html#Attribute-Syntax">Attribute Syntax</a>, for
  72. details of the exact syntax for using attributes. Other attributes are
  73. available for functions (see <a href="Function-Attributes.html#Function-Attributes">Function Attributes</a>), variables
  74. (see <a href="Variable-Attributes.html#Variable-Attributes">Variable Attributes</a>), labels (see <a href="Label-Attributes.html#Label-Attributes">Label Attributes</a>), statements
  75. (see <a href="Statement-Attributes.html#Statement-Attributes">Statement Attributes</a>), and for types (see <a href="Type-Attributes.html#Type-Attributes">Type Attributes</a>).
  76. </p>
  77. <p>This example uses the <code>deprecated</code> enumerator attribute to indicate the
  78. <code>oldval</code> enumerator is deprecated:
  79. </p>
  80. <div class="smallexample">
  81. <pre class="smallexample">enum E {
  82. oldval __attribute__((deprecated)),
  83. newval
  84. };
  85. int
  86. fn (void)
  87. {
  88. return oldval;
  89. }
  90. </pre></div>
  91. <dl compact="compact">
  92. <dt><code>deprecated</code></dt>
  93. <dd><a name="index-deprecated-enumerator-attribute"></a>
  94. <p>The <code>deprecated</code> attribute results in a warning if the enumerator
  95. is used anywhere in the source file. This is useful when identifying
  96. enumerators that are expected to be removed in a future version of a
  97. program. The warning also includes the location of the declaration
  98. of the deprecated enumerator, to enable users to easily find further
  99. information about why the enumerator is deprecated, or what they should
  100. do instead. Note that the warnings only occurs for uses.
  101. </p>
  102. </dd>
  103. </dl>
  104. </body>
  105. </html>