Accessors.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  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>GNU Compiler Collection (GCC) Internals: Accessors</title>
  20. <meta name="description" content="GNU Compiler Collection (GCC) Internals: Accessors">
  21. <meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Accessors">
  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="RTL.html#RTL" rel="up" title="RTL">
  30. <link href="Special-Accessors.html#Special-Accessors" rel="next" title="Special Accessors">
  31. <link href="RTL-Classes.html#RTL-Classes" rel="prev" title="RTL Classes">
  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="Accessors"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Special-Accessors.html#Special-Accessors" accesskey="n" rel="next">Special Accessors</a>, Previous: <a href="RTL-Classes.html#RTL-Classes" accesskey="p" rel="prev">RTL Classes</a>, Up: <a href="RTL.html#RTL" accesskey="u" rel="up">RTL</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="Access-to-Operands"></a>
  69. <h3 class="section">13.3 Access to Operands</h3>
  70. <a name="index-accessors"></a>
  71. <a name="index-access-to-operands"></a>
  72. <a name="index-operand-access"></a>
  73. <a name="index-XEXP"></a>
  74. <a name="index-XINT"></a>
  75. <a name="index-XWINT"></a>
  76. <a name="index-XSTR"></a>
  77. <p>Operands of expressions are accessed using the macros <code>XEXP</code>,
  78. <code>XINT</code>, <code>XWINT</code> and <code>XSTR</code>. Each of these macros takes
  79. two arguments: an expression-pointer (RTX) and an operand number
  80. (counting from zero). Thus,
  81. </p>
  82. <div class="smallexample">
  83. <pre class="smallexample">XEXP (<var>x</var>, 2)
  84. </pre></div>
  85. <p>accesses operand 2 of expression <var>x</var>, as an expression.
  86. </p>
  87. <div class="smallexample">
  88. <pre class="smallexample">XINT (<var>x</var>, 2)
  89. </pre></div>
  90. <p>accesses the same operand as an integer. <code>XSTR</code>, used in the same
  91. fashion, would access it as a string.
  92. </p>
  93. <p>Any operand can be accessed as an integer, as an expression or as a string.
  94. You must choose the correct method of access for the kind of value actually
  95. stored in the operand. You would do this based on the expression code of
  96. the containing expression. That is also how you would know how many
  97. operands there are.
  98. </p>
  99. <p>For example, if <var>x</var> is a <code>subreg</code> expression, you know that it has
  100. two operands which can be correctly accessed as <code>XEXP (<var>x</var>, 0)</code>
  101. and <code>XINT (<var>x</var>, 1)</code>. If you did <code>XINT (<var>x</var>, 0)</code>, you
  102. would get the address of the expression operand but cast as an integer;
  103. that might occasionally be useful, but it would be cleaner to write
  104. <code>(int) XEXP (<var>x</var>, 0)</code>. <code>XEXP (<var>x</var>, 1)</code> would also
  105. compile without error, and would return the second, integer operand cast as
  106. an expression pointer, which would probably result in a crash when
  107. accessed. Nothing stops you from writing <code>XEXP (<var>x</var>, 28)</code> either,
  108. but this will access memory past the end of the expression with
  109. unpredictable results.
  110. </p>
  111. <p>Access to operands which are vectors is more complicated. You can use the
  112. macro <code>XVEC</code> to get the vector-pointer itself, or the macros
  113. <code>XVECEXP</code> and <code>XVECLEN</code> to access the elements and length of a
  114. vector.
  115. </p>
  116. <dl compact="compact">
  117. <dd><a name="index-XVEC"></a>
  118. </dd>
  119. <dt><code>XVEC (<var>exp</var>, <var>idx</var>)</code></dt>
  120. <dd><p>Access the vector-pointer which is operand number <var>idx</var> in <var>exp</var>.
  121. </p>
  122. <a name="index-XVECLEN"></a>
  123. </dd>
  124. <dt><code>XVECLEN (<var>exp</var>, <var>idx</var>)</code></dt>
  125. <dd><p>Access the length (number of elements) in the vector which is
  126. in operand number <var>idx</var> in <var>exp</var>. This value is an <code>int</code>.
  127. </p>
  128. <a name="index-XVECEXP"></a>
  129. </dd>
  130. <dt><code>XVECEXP (<var>exp</var>, <var>idx</var>, <var>eltnum</var>)</code></dt>
  131. <dd><p>Access element number <var>eltnum</var> in the vector which is
  132. in operand number <var>idx</var> in <var>exp</var>. This value is an RTX.
  133. </p>
  134. <p>It is up to you to make sure that <var>eltnum</var> is not negative
  135. and is less than <code>XVECLEN (<var>exp</var>, <var>idx</var>)</code>.
  136. </p></dd>
  137. </dl>
  138. <p>All the macros defined in this section expand into lvalues and therefore
  139. can be used to assign the operands, lengths and vector elements as well as
  140. to access them.
  141. </p>
  142. <hr>
  143. <div class="header">
  144. <p>
  145. Next: <a href="Special-Accessors.html#Special-Accessors" accesskey="n" rel="next">Special Accessors</a>, Previous: <a href="RTL-Classes.html#RTL-Classes" accesskey="p" rel="prev">RTL Classes</a>, Up: <a href="RTL.html#RTL" accesskey="u" rel="up">RTL</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>
  146. </div>
  147. </body>
  148. </html>