Defining-Mode-Iterators.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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: Defining Mode Iterators</title>
  20. <meta name="description" content="GNU Compiler Collection (GCC) Internals: Defining Mode Iterators">
  21. <meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Defining Mode Iterators">
  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="Mode-Iterators.html#Mode-Iterators" rel="up" title="Mode Iterators">
  30. <link href="Substitutions.html#Substitutions" rel="next" title="Substitutions">
  31. <link href="Mode-Iterators.html#Mode-Iterators" rel="prev" title="Mode Iterators">
  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="Defining-Mode-Iterators"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Substitutions.html#Substitutions" accesskey="n" rel="next">Substitutions</a>, Up: <a href="Mode-Iterators.html#Mode-Iterators" accesskey="u" rel="up">Mode Iterators</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="Defining-Mode-Iterators-1"></a>
  69. <h4 class="subsubsection">16.23.1.1 Defining Mode Iterators</h4>
  70. <a name="index-define_005fmode_005fiterator"></a>
  71. <p>The syntax for defining a mode iterator is:
  72. </p>
  73. <div class="smallexample">
  74. <pre class="smallexample">(define_mode_iterator <var>name</var> [(<var>mode1</var> &quot;<var>cond1</var>&quot;) &hellip; (<var>moden</var> &quot;<var>condn</var>&quot;)])
  75. </pre></div>
  76. <p>This allows subsequent <samp>.md</samp> file constructs to use the mode suffix
  77. <code>:<var>name</var></code>. Every construct that does so will be expanded
  78. <var>n</var> times, once with every use of <code>:<var>name</var></code> replaced by
  79. <code>:<var>mode1</var></code>, once with every use replaced by <code>:<var>mode2</var></code>,
  80. and so on. In the expansion for a particular <var>modei</var>, every
  81. C condition will also require that <var>condi</var> be true.
  82. </p>
  83. <p>For example:
  84. </p>
  85. <div class="smallexample">
  86. <pre class="smallexample">(define_mode_iterator P [(SI &quot;Pmode == SImode&quot;) (DI &quot;Pmode == DImode&quot;)])
  87. </pre></div>
  88. <p>defines a new mode suffix <code>:P</code>. Every construct that uses
  89. <code>:P</code> will be expanded twice, once with every <code>:P</code> replaced
  90. by <code>:SI</code> and once with every <code>:P</code> replaced by <code>:DI</code>.
  91. The <code>:SI</code> version will only apply if <code>Pmode == SImode</code> and
  92. the <code>:DI</code> version will only apply if <code>Pmode == DImode</code>.
  93. </p>
  94. <p>As with other <samp>.md</samp> conditions, an empty string is treated
  95. as &ldquo;always true&rdquo;. <code>(<var>mode</var> &quot;&quot;)</code> can also be abbreviated
  96. to <code><var>mode</var></code>. For example:
  97. </p>
  98. <div class="smallexample">
  99. <pre class="smallexample">(define_mode_iterator GPR [SI (DI &quot;TARGET_64BIT&quot;)])
  100. </pre></div>
  101. <p>means that the <code>:DI</code> expansion only applies if <code>TARGET_64BIT</code>
  102. but that the <code>:SI</code> expansion has no such constraint.
  103. </p>
  104. <p>Iterators are applied in the order they are defined. This can be
  105. significant if two iterators are used in a construct that requires
  106. substitutions. See <a href="Substitutions.html#Substitutions">Substitutions</a>.
  107. </p>
  108. </body>
  109. </html>