ruby-vpi 11.0.0 → 11.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (260) hide show
  1. data/HEADER +15 -14
  2. data/HISTORY +36 -1
  3. data/MEMO +17 -14
  4. data/README +2 -19
  5. data/Rakefile +1 -2
  6. data/bin/generate_test.rb +4 -4
  7. data/bin/generate_test_tpl/bench.rb +1 -0
  8. data/bin/generate_test_tpl/bench.v +1 -1
  9. data/bin/header_to_ruby.rb +2 -2
  10. data/doc/background.organization.html +1 -1
  11. data/doc/hacking.html +3 -0
  12. data/doc/hacking.release-packages.html +7 -0
  13. data/doc/index.html +2 -2
  14. data/doc/manual.txt +69 -13
  15. data/doc/problem.ivl.html +3 -3
  16. data/doc/problems.html +1 -1
  17. data/doc/problems.ruby.html +1 -1
  18. data/doc/problems.vsim.html +1 -1
  19. data/doc/setup.installation.html +1 -1
  20. data/doc/src/manual.xml +130 -20
  21. data/doc/usage.examples.html +1 -1
  22. data/doc/usage.tutorial.html +1 -1
  23. data/header.html +15 -14
  24. data/header.part.html +15 -14
  25. data/history.html +88 -15
  26. data/history.part.html +73 -1
  27. data/lib/ruby-vpi.rb +5 -5
  28. data/lib/ruby-vpi/verilog_parser.rb +1 -1
  29. data/lib/ruby-vpi/vpi.rb +184 -169
  30. data/memo.html +44 -38
  31. data/memo.part.html +29 -24
  32. data/readme.html +17 -47
  33. data/readme.part.html +2 -33
  34. data/ref/c/annotated.html +40 -0
  35. data/ref/c/common_8h.html +146 -0
  36. data/ref/c/doxygen.css +358 -0
  37. data/ref/c/doxygen.png +0 -0
  38. data/ref/c/files.html +36 -0
  39. data/ref/c/functions.html +154 -0
  40. data/ref/c/functions_vars.html +154 -0
  41. data/ref/c/globals.html +261 -0
  42. data/ref/c/globals_0x62.html +62 -0
  43. data/ref/c/globals_0x63.html +103 -0
  44. data/ref/c/globals_0x65.html +62 -0
  45. data/ref/c/globals_0x66.html +72 -0
  46. data/ref/c/globals_0x67.html +64 -0
  47. data/ref/c/globals_0x69.html +62 -0
  48. data/ref/c/globals_0x6c.html +64 -0
  49. data/ref/c/globals_0x6d.html +62 -0
  50. data/ref/c/globals_0x6e.html +63 -0
  51. data/ref/c/globals_0x70.html +78 -0
  52. data/ref/c/globals_0x72.html +73 -0
  53. data/ref/c/globals_0x73.html +251 -0
  54. data/ref/c/globals_0x74.html +62 -0
  55. data/ref/c/globals_0x75.html +63 -0
  56. data/ref/c/globals_0x76.html +483 -0
  57. data/ref/c/globals_0x78.html +62 -0
  58. data/ref/c/globals_defs.html +86 -0
  59. data/ref/c/globals_defs_0x65.html +55 -0
  60. data/ref/c/globals_defs_0x6c.html +57 -0
  61. data/ref/c/globals_defs_0x6e.html +56 -0
  62. data/ref/c/globals_defs_0x70.html +56 -0
  63. data/ref/c/globals_defs_0x72.html +57 -0
  64. data/ref/c/globals_defs_0x73.html +164 -0
  65. data/ref/c/globals_defs_0x75.html +56 -0
  66. data/ref/c/globals_defs_0x76.html +470 -0
  67. data/ref/c/globals_defs_0x78.html +55 -0
  68. data/ref/c/globals_enum.html +39 -0
  69. data/ref/c/globals_eval.html +40 -0
  70. data/ref/c/globals_func.html +208 -0
  71. data/ref/c/globals_func_0x66.html +62 -0
  72. data/ref/c/globals_func_0x67.html +55 -0
  73. data/ref/c/globals_func_0x69.html +53 -0
  74. data/ref/c/globals_func_0x70.html +53 -0
  75. data/ref/c/globals_func_0x72.html +57 -0
  76. data/ref/c/globals_func_0x73.html +114 -0
  77. data/ref/c/globals_func_0x76.html +57 -0
  78. data/ref/c/globals_type.html +66 -0
  79. data/ref/c/globals_vars.html +126 -0
  80. data/ref/c/index.html +20 -0
  81. data/ref/c/relay_8c.html +214 -0
  82. data/ref/c/relay_8h.html +129 -0
  83. data/ref/c/structrelay____RubyOptions____def.html +67 -0
  84. data/ref/c/structswig__cast__info.html +98 -0
  85. data/ref/c/structswig__class.html +115 -0
  86. data/ref/c/structswig__module__info.html +132 -0
  87. data/ref/c/structswig__type__info.html +132 -0
  88. data/ref/c/structt__cb__data.html +168 -0
  89. data/ref/c/structt__vpi__delay.html +151 -0
  90. data/ref/c/structt__vpi__error__info.html +219 -0
  91. data/ref/c/structt__vpi__strengthval.html +83 -0
  92. data/ref/c/structt__vpi__systf__data.html +185 -0
  93. data/ref/c/structt__vpi__time.html +100 -0
  94. data/ref/c/structt__vpi__value.html +314 -0
  95. data/ref/c/structt__vpi__vecval.html +66 -0
  96. data/ref/c/structt__vpi__vlog__info.html +151 -0
  97. data/ref/c/swig_8c.html +80 -0
  98. data/ref/c/swig_8h.html +83 -0
  99. data/ref/c/swig__vpi_8h.html +8739 -0
  100. data/ref/c/swig__wrap_8cin.html +11556 -0
  101. data/ref/c/tab_b.gif +0 -0
  102. data/ref/c/tab_l.gif +0 -0
  103. data/ref/c/tab_r.gif +0 -0
  104. data/ref/c/tabs.css +102 -0
  105. data/ref/c/unions__vpi__value__value.html +166 -0
  106. data/ref/c/verilog_8h.html +117 -0
  107. data/ref/c/vlog_8c.html +168 -0
  108. data/ref/c/vlog_8h.html +128 -0
  109. data/ref/c/vpi__user_8h.html +8739 -0
  110. data/ref/ruby/classes/ERB.html +158 -0
  111. data/ref/ruby/classes/ERB.src/M000034.html +29 -0
  112. data/ref/ruby/classes/FileUtils.html +165 -0
  113. data/ref/ruby/classes/FileUtils.src/M000081.html +18 -0
  114. data/ref/ruby/classes/FileUtils.src/M000082.html +18 -0
  115. data/ref/ruby/classes/Integer.html +398 -0
  116. data/ref/ruby/classes/Integer.src/M000012.html +25 -0
  117. data/ref/ruby/classes/Integer.src/M000013.html +18 -0
  118. data/ref/ruby/classes/Integer.src/M000014.html +18 -0
  119. data/ref/ruby/classes/Integer.src/M000015.html +18 -0
  120. data/ref/ruby/classes/Integer.src/M000016.html +18 -0
  121. data/ref/ruby/classes/Integer.src/M000017.html +18 -0
  122. data/ref/ruby/classes/Integer.src/M000020.html +22 -0
  123. data/ref/ruby/classes/Integer.src/M000021.html +22 -0
  124. data/ref/ruby/classes/Integer.src/M000022.html +25 -0
  125. data/ref/ruby/classes/Integer.src/M000023.html +31 -0
  126. data/ref/ruby/classes/Integer.src/M000024.html +25 -0
  127. data/ref/ruby/classes/Integer.src/M000025.html +30 -0
  128. data/ref/ruby/classes/OutputInfo.html +294 -0
  129. data/ref/ruby/classes/OutputInfo.src/M000030.html +50 -0
  130. data/ref/ruby/classes/RDoc.html +135 -0
  131. data/ref/ruby/classes/RDoc.src/M000095.html +40 -0
  132. data/ref/ruby/classes/RubyVpi.html +206 -0
  133. data/ref/ruby/classes/RubyVpi.src/M000083.html +78 -0
  134. data/ref/ruby/classes/RubyVpi.src/M000084.html +20 -0
  135. data/ref/ruby/classes/RubyVpi/Config.html +159 -0
  136. data/ref/ruby/classes/String.html +159 -0
  137. data/ref/ruby/classes/String.src/M000032.html +41 -0
  138. data/ref/ruby/classes/String.src/M000033.html +18 -0
  139. data/ref/ruby/classes/Table.html +191 -0
  140. data/ref/ruby/classes/Table.src/M000026.html +38 -0
  141. data/ref/ruby/classes/Table.src/M000027.html +18 -0
  142. data/ref/ruby/classes/Table.src/M000028.html +18 -0
  143. data/ref/ruby/classes/Table.src/M000029.html +18 -0
  144. data/ref/ruby/classes/Template.html +158 -0
  145. data/ref/ruby/classes/Template.src/M000031.html +18 -0
  146. data/ref/ruby/classes/VerilogParser.html +187 -0
  147. data/ref/ruby/classes/VerilogParser.src/M000005.html +34 -0
  148. data/ref/ruby/classes/VerilogParser/Module.html +172 -0
  149. data/ref/ruby/classes/VerilogParser/Module.src/M000006.html +29 -0
  150. data/ref/ruby/classes/VerilogParser/Module/Parameter.html +160 -0
  151. data/ref/ruby/classes/VerilogParser/Module/Parameter.src/M000011.html +21 -0
  152. data/ref/ruby/classes/VerilogParser/Module/Port.html +207 -0
  153. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000007.html +21 -0
  154. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000008.html +18 -0
  155. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000009.html +18 -0
  156. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000010.html +18 -0
  157. data/ref/ruby/classes/Vpi.html +124 -0
  158. data/ref/ruby/classes/Vpi/Handle.html +383 -0
  159. data/ref/ruby/classes/Vpi/Handle.src/M000085.html +18 -0
  160. data/ref/ruby/classes/Vpi/Handle.src/M000086.html +18 -0
  161. data/ref/ruby/classes/Vpi/Handle.src/M000087.html +22 -0
  162. data/ref/ruby/classes/Vpi/Handle.src/M000088.html +44 -0
  163. data/ref/ruby/classes/Vpi/Handle.src/M000089.html +87 -0
  164. data/ref/ruby/classes/Vpi/Handle.src/M000090.html +30 -0
  165. data/ref/ruby/classes/Vpi/Handle.src/M000091.html +24 -0
  166. data/ref/ruby/classes/Vpi/Handle.src/M000093.html +68 -0
  167. data/ref/ruby/classes/Vpi/Handle/Property.html +130 -0
  168. data/ref/ruby/classes/Vpi/Handle/Property.src/M000094.html +80 -0
  169. data/ref/ruby/classes/XX.html +138 -0
  170. data/ref/ruby/classes/XX/Document.html +295 -0
  171. data/ref/ruby/classes/XX/Document.src/M000072.html +22 -0
  172. data/ref/ruby/classes/XX/Document.src/M000073.html +20 -0
  173. data/ref/ruby/classes/XX/Document.src/M000074.html +20 -0
  174. data/ref/ruby/classes/XX/Document.src/M000075.html +20 -0
  175. data/ref/ruby/classes/XX/Document.src/M000076.html +22 -0
  176. data/ref/ruby/classes/XX/Document.src/M000077.html +21 -0
  177. data/ref/ruby/classes/XX/Document.src/M000078.html +21 -0
  178. data/ref/ruby/classes/XX/Document.src/M000079.html +34 -0
  179. data/ref/ruby/classes/XX/Document.src/M000080.html +98 -0
  180. data/ref/ruby/classes/XX/HTML4.html +145 -0
  181. data/ref/ruby/classes/XX/HTML4.src/M000036.html +20 -0
  182. data/ref/ruby/classes/XX/HTML4/Strict.html +138 -0
  183. data/ref/ruby/classes/XX/HTML4/Strict.src/M000038.html +20 -0
  184. data/ref/ruby/classes/XX/HTML4/Transitional.html +138 -0
  185. data/ref/ruby/classes/XX/HTML4/Transitional.src/M000037.html +20 -0
  186. data/ref/ruby/classes/XX/Markup.html +160 -0
  187. data/ref/ruby/classes/XX/Markup.src/M000043.html +28 -0
  188. data/ref/ruby/classes/XX/Markup/ClassMethods.html +236 -0
  189. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000044.html +22 -0
  190. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000045.html +20 -0
  191. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000046.html +25 -0
  192. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000047.html +20 -0
  193. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000048.html +27 -0
  194. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000049.html +20 -0
  195. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000050.html +27 -0
  196. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000051.html +22 -0
  197. data/ref/ruby/classes/XX/Markup/Error.html +111 -0
  198. data/ref/ruby/classes/XX/Markup/InstanceMethods.html +474 -0
  199. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000052.html +56 -0
  200. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000053.html +33 -0
  201. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000054.html +31 -0
  202. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000055.html +48 -0
  203. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000056.html +20 -0
  204. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000057.html +31 -0
  205. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000058.html +32 -0
  206. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000059.html +32 -0
  207. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000060.html +28 -0
  208. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000061.html +23 -0
  209. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000062.html +26 -0
  210. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000063.html +20 -0
  211. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000064.html +20 -0
  212. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000065.html +20 -0
  213. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000066.html +20 -0
  214. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000067.html +20 -0
  215. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000068.html +21 -0
  216. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000069.html +20 -0
  217. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000070.html +20 -0
  218. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000071.html +20 -0
  219. data/ref/ruby/classes/XX/XHTML.html +145 -0
  220. data/ref/ruby/classes/XX/XHTML.src/M000039.html +36 -0
  221. data/ref/ruby/classes/XX/XHTML/Strict.html +138 -0
  222. data/ref/ruby/classes/XX/XHTML/Strict.src/M000041.html +20 -0
  223. data/ref/ruby/classes/XX/XHTML/Transitional.html +138 -0
  224. data/ref/ruby/classes/XX/XHTML/Transitional.src/M000040.html +20 -0
  225. data/ref/ruby/classes/XX/XML.html +138 -0
  226. data/ref/ruby/classes/XX/XML.src/M000035.html +20 -0
  227. data/ref/ruby/classes/XX/XMLish.html +138 -0
  228. data/ref/ruby/classes/XX/XMLish.src/M000042.html +18 -0
  229. data/ref/ruby/created.rid +1 -0
  230. data/ref/ruby/files/bin/generate_test_rb.html +248 -0
  231. data/ref/ruby/files/bin/generate_test_rb.src/M000001.html +18 -0
  232. data/ref/ruby/files/bin/generate_test_rb.src/M000002.html +40 -0
  233. data/ref/ruby/files/bin/header_to_ruby_rb.html +124 -0
  234. data/ref/ruby/files/lib/ruby-vpi/erb_rb.html +108 -0
  235. data/ref/ruby/files/lib/ruby-vpi/integer_rb.html +101 -0
  236. data/ref/ruby/files/lib/ruby-vpi/rake_rb.html +108 -0
  237. data/ref/ruby/files/lib/ruby-vpi/rcov_rb.html +111 -0
  238. data/ref/ruby/files/lib/ruby-vpi/rdoc_rb.html +108 -0
  239. data/ref/ruby/files/lib/ruby-vpi/rspec_rb.html +115 -0
  240. data/ref/ruby/files/lib/ruby-vpi/runner_proxy_rb.html +108 -0
  241. data/ref/ruby/files/lib/ruby-vpi/runner_rb.html +208 -0
  242. data/ref/ruby/files/lib/ruby-vpi/runner_rb.src/M000003.html +24 -0
  243. data/ref/ruby/files/lib/ruby-vpi/runner_rb.src/M000004.html +26 -0
  244. data/ref/ruby/files/lib/ruby-vpi/verilog_parser_rb.html +107 -0
  245. data/ref/ruby/files/lib/ruby-vpi/vpi_rb.html +108 -0
  246. data/ref/ruby/files/lib/ruby-vpi/xx_rb.html +148 -0
  247. data/ref/ruby/files/lib/ruby-vpi_rb.html +111 -0
  248. data/ref/ruby/fr_class_index.html +57 -0
  249. data/ref/ruby/fr_file_index.html +40 -0
  250. data/ref/ruby/fr_method_index.html +121 -0
  251. data/ref/ruby/index.html +24 -0
  252. data/ref/ruby/rdoc-style.css +208 -0
  253. data/samp/counter/counter_rspec_bench.rb +1 -0
  254. data/samp/counter/counter_rspec_bench.v +1 -1
  255. data/samp/counter/counter_xunit_bench.rb +1 -0
  256. data/samp/counter/counter_xunit_bench.v +1 -1
  257. data/samp/pipelined_alu/hw5_unit_test_bench.rb +1 -0
  258. data/samp/pipelined_alu/hw5_unit_test_bench.v +1 -1
  259. data/samp/pipelined_alu/int_gen.rb +6 -7
  260. metadata +269 -2
data/ref/c/common_8h.html ADDED
@@ -0,0 +1,146 @@
1
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
+ <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
+ <title>Ruby-VPI: common.h File Reference</title>
4
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
5
+ <link href="tabs.css" rel="stylesheet" type="text/css">
6
+ </head><body>
7
+ <!-- Generated by Doxygen 1.4.7 -->
8
+ <div class="tabs">
9
+ <ul>
10
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
+ <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
12
+ <li id="current"><a href="files.html"><span>Files</span></a></li>
13
+ </ul></div>
14
+ <div class="tabs">
15
+ <ul>
16
+ <li><a href="files.html"><span>File&nbsp;List</span></a></li>
17
+ <li><a href="globals.html"><span>Globals</span></a></li>
18
+ </ul></div>
19
+ <h1>common.h File Reference</h1>Things common to all Ruby-VPI code. <a href="#_details">More...</a>
20
+ <p>
21
+ <code>#include &quot;<a class="el" href="verilog_8h.html">verilog.h</a>&quot;</code><br>
22
+ <table border="0" cellpadding="0" cellspacing="0">
23
+ <tr><td></td></tr>
24
+ <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
25
+ <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf</a>()&nbsp;&nbsp;&nbsp;vpi_printf(&quot;Ruby-VPI: &quot;); vpi_printf(__VA_ARGS__); vpi_printf(&quot;\n&quot;);</td></tr>
26
+
27
+ <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line. <a href="#88235e5f8aab82571d68045e9f73fe81"></a><br></td></tr>
28
+ <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#fcdad79cb06a5c61737b2f434218dc95">common_debug</a>()</td></tr>
29
+
30
+ <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A wrapper for <a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf()</a> which marks the given message as being debugging output. <a href="#fcdad79cb06a5c61737b2f434218dc95"></a><br></td></tr>
31
+ <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f30d3fc89fbb3ed2aab2f5904ab76815">common_boolToStr</a>(aBoolExpr)&nbsp;&nbsp;&nbsp;( (aBoolExpr) ? &quot;true&quot; : &quot;false&quot; )</td></tr>
32
+
33
+ <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the string "true" if the given boolean expression is true. <a href="#f30d3fc89fbb3ed2aab2f5904ab76815"></a><br></td></tr>
34
+ <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
35
+ <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a> { <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c">false</a> = 0,
36
+ <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b">true</a> = 1
37
+ }</td></tr>
38
+
39
+ <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A boolean variable with two possible values: true and false. <a href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">More...</a><br></td></tr>
40
+ </table>
41
+ <hr><a name="_details"></a><h2>Detailed Description</h2>
42
+ Things common to all Ruby-VPI code.
43
+ <p>
44
+ <hr><h2>Define Documentation</h2>
45
+ <a class="anchor" name="f30d3fc89fbb3ed2aab2f5904ab76815"></a><!-- doxytag: member="common.h::common_boolToStr" ref="f30d3fc89fbb3ed2aab2f5904ab76815" args="(aBoolExpr)" -->
46
+ <div class="memitem">
47
+ <div class="memproto">
48
+ <table class="memname">
49
+ <tr>
50
+ <td class="memname">#define common_boolToStr </td>
51
+ <td>(</td>
52
+ <td class="paramtype">aBoolExpr&nbsp;</td>
53
+ <td class="paramname"> </td>
54
+ <td>&nbsp;)&nbsp;</td>
55
+ <td width="100%">&nbsp;&nbsp;&nbsp;( (aBoolExpr) ? &quot;true&quot; : &quot;false&quot; )</td>
56
+ </tr>
57
+ </table>
58
+ </div>
59
+ <div class="memdoc">
60
+
61
+ <p>
62
+ Returns the string "true" if the given boolean expression is true.
63
+ <p>
64
+ Otherwise returns the string "false".
65
+ </div>
66
+ </div><p>
67
+ <a class="anchor" name="fcdad79cb06a5c61737b2f434218dc95"></a><!-- doxytag: member="common.h::common_debug" ref="fcdad79cb06a5c61737b2f434218dc95" args="()" -->
68
+ <div class="memitem">
69
+ <div class="memproto">
70
+ <table class="memname">
71
+ <tr>
72
+ <td class="memname">#define common_debug </td>
73
+ <td>(</td>
74
+ &nbsp;</td>
75
+ <td class="paramname"> </td>
76
+ <td>&nbsp;)&nbsp;</td>
77
+ <td width="100%"></td>
78
+ </tr>
79
+ </table>
80
+ </div>
81
+ <div class="memdoc">
82
+
83
+ <p>
84
+ A wrapper for <a class="el" href="common_8h.html#88235e5f8aab82571d68045e9f73fe81">common_printf()</a> which marks the given message as being debugging output.
85
+ <p>
86
+
87
+ </div>
88
+ </div><p>
89
+ <a class="anchor" name="88235e5f8aab82571d68045e9f73fe81"></a><!-- doxytag: member="common.h::common_printf" ref="88235e5f8aab82571d68045e9f73fe81" args="()" -->
90
+ <div class="memitem">
91
+ <div class="memproto">
92
+ <table class="memname">
93
+ <tr>
94
+ <td class="memname">#define common_printf </td>
95
+ <td>(</td>
96
+ &nbsp;</td>
97
+ <td class="paramname"> </td>
98
+ <td>&nbsp;)&nbsp;</td>
99
+ <td width="100%">&nbsp;&nbsp;&nbsp;vpi_printf(&quot;Ruby-VPI: &quot;); vpi_printf(__VA_ARGS__); vpi_printf(&quot;\n&quot;);</td>
100
+ </tr>
101
+ </table>
102
+ </div>
103
+ <div class="memdoc">
104
+
105
+ <p>
106
+ A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line.
107
+ <p>
108
+ <dl compact><dt><b>Parameters:</b></dt><dd>
109
+ <table border="0" cellspacing="2" cellpadding="0">
110
+ <tr><td valign="top"></td><td valign="top"><em>...</em>&nbsp;</td><td>Arguments to vpi_printf() </td></tr>
111
+ </table>
112
+ </dl>
113
+
114
+ </div>
115
+ </div><p>
116
+ <hr><h2>Enumeration Type Documentation</h2>
117
+ <a class="anchor" name="f6a258d8f3ee5206d682d799316314b1"></a><!-- doxytag: member="common.h::bool" ref="f6a258d8f3ee5206d682d799316314b1" args="" -->
118
+ <div class="memitem">
119
+ <div class="memproto">
120
+ <table class="memname">
121
+ <tr>
122
+ <td class="memname">enum <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a> </td>
123
+ </tr>
124
+ </table>
125
+ </div>
126
+ <div class="memdoc">
127
+
128
+ <p>
129
+ A boolean variable with two possible values: true and false.
130
+ <p>
131
+ Pass aroung this value instead of zero and non-zero integers. <dl compact><dt><b>Enumerator: </b></dt><dd>
132
+ <table border="0" cellspacing="2" cellpadding="0">
133
+ <tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c"></a><!-- doxytag: member="false" ref="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c" args="" -->false</em>&nbsp;</td><td>
134
+ </td></tr>
135
+ <tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b"></a><!-- doxytag: member="true" ref="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b" args="" -->true</em>&nbsp;</td><td>
136
+ </td></tr>
137
+ </table>
138
+ </dl>
139
+
140
+ </div>
141
+ </div><p>
142
+ <hr size="1"><address style="align: right;"><small>Generated on Wed Nov 8 19:07:51 2006 for Ruby-VPI by&nbsp;
143
+ <a href="http://www.doxygen.org/index.html">
144
+ <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
145
+ </body>
146
+ </html>
data/ref/c/doxygen.css ADDED
@@ -0,0 +1,358 @@
1
+ BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
2
+ font-family: Geneva, Arial, Helvetica, sans-serif;
3
+ }
4
+ BODY,TD {
5
+ font-size: 90%;
6
+ }
7
+ H1 {
8
+ text-align: center;
9
+ font-size: 160%;
10
+ }
11
+ H2 {
12
+ font-size: 120%;
13
+ }
14
+ H3 {
15
+ font-size: 100%;
16
+ }
17
+ CAPTION { font-weight: bold }
18
+ DIV.qindex {
19
+ width: 100%;
20
+ background-color: #e8eef2;
21
+ border: 1px solid #84b0c7;
22
+ text-align: center;
23
+ margin: 2px;
24
+ padding: 2px;
25
+ line-height: 140%;
26
+ }
27
+ DIV.nav {
28
+ width: 100%;
29
+ background-color: #e8eef2;
30
+ border: 1px solid #84b0c7;
31
+ text-align: center;
32
+ margin: 2px;
33
+ padding: 2px;
34
+ line-height: 140%;
35
+ }
36
+ DIV.navtab {
37
+ background-color: #e8eef2;
38
+ border: 1px solid #84b0c7;
39
+ text-align: center;
40
+ margin: 2px;
41
+ margin-right: 15px;
42
+ padding: 2px;
43
+ }
44
+ TD.navtab {
45
+ font-size: 70%;
46
+ }
47
+ A.qindex {
48
+ text-decoration: none;
49
+ font-weight: bold;
50
+ color: #1A419D;
51
+ }
52
+ A.qindex:visited {
53
+ text-decoration: none;
54
+ font-weight: bold;
55
+ color: #1A419D
56
+ }
57
+ A.qindex:hover {
58
+ text-decoration: none;
59
+ background-color: #ddddff;
60
+ }
61
+ A.qindexHL {
62
+ text-decoration: none;
63
+ font-weight: bold;
64
+ background-color: #6666cc;
65
+ color: #ffffff;
66
+ border: 1px double #9295C2;
67
+ }
68
+ A.qindexHL:hover {
69
+ text-decoration: none;
70
+ background-color: #6666cc;
71
+ color: #ffffff;
72
+ }
73
+ A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff }
74
+ A.el { text-decoration: none; font-weight: bold }
75
+ A.elRef { font-weight: bold }
76
+ A.code:link { text-decoration: none; font-weight: normal; color: #0000FF}
77
+ A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF}
78
+ A.codeRef:link { font-weight: normal; color: #0000FF}
79
+ A.codeRef:visited { font-weight: normal; color: #0000FF}
80
+ A:hover { text-decoration: none; background-color: #f2f2ff }
81
+ DL.el { margin-left: -1cm }
82
+ .fragment {
83
+ font-family: monospace, fixed;
84
+ font-size: 95%;
85
+ }
86
+ PRE.fragment {
87
+ border: 1px solid #CCCCCC;
88
+ background-color: #f5f5f5;
89
+ margin-top: 4px;
90
+ margin-bottom: 4px;
91
+ margin-left: 2px;
92
+ margin-right: 8px;
93
+ padding-left: 6px;
94
+ padding-right: 6px;
95
+ padding-top: 4px;
96
+ padding-bottom: 4px;
97
+ }
98
+ DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
99
+
100
+ DIV.groupHeader {
101
+ margin-left: 16px;
102
+ margin-top: 12px;
103
+ margin-bottom: 6px;
104
+ font-weight: bold;
105
+ }
106
+ DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% }
107
+ BODY {
108
+ background: white;
109
+ color: black;
110
+ margin-right: 20px;
111
+ margin-left: 20px;
112
+ }
113
+ TD.indexkey {
114
+ background-color: #e8eef2;
115
+ font-weight: bold;
116
+ padding-right : 10px;
117
+ padding-top : 2px;
118
+ padding-left : 10px;
119
+ padding-bottom : 2px;
120
+ margin-left : 0px;
121
+ margin-right : 0px;
122
+ margin-top : 2px;
123
+ margin-bottom : 2px;
124
+ border: 1px solid #CCCCCC;
125
+ }
126
+ TD.indexvalue {
127
+ background-color: #e8eef2;
128
+ font-style: italic;
129
+ padding-right : 10px;
130
+ padding-top : 2px;
131
+ padding-left : 10px;
132
+ padding-bottom : 2px;
133
+ margin-left : 0px;
134
+ margin-right : 0px;
135
+ margin-top : 2px;
136
+ margin-bottom : 2px;
137
+ border: 1px solid #CCCCCC;
138
+ }
139
+ TR.memlist {
140
+ background-color: #f0f0f0;
141
+ }
142
+ P.formulaDsp { text-align: center; }
143
+ IMG.formulaDsp { }
144
+ IMG.formulaInl { vertical-align: middle; }
145
+ SPAN.keyword { color: #008000 }
146
+ SPAN.keywordtype { color: #604020 }
147
+ SPAN.keywordflow { color: #e08000 }
148
+ SPAN.comment { color: #800000 }
149
+ SPAN.preprocessor { color: #806020 }
150
+ SPAN.stringliteral { color: #002080 }
151
+ SPAN.charliteral { color: #008080 }
152
+ .mdescLeft {
153
+ padding: 0px 8px 4px 8px;
154
+ font-size: 80%;
155
+ font-style: italic;
156
+ background-color: #FAFAFA;
157
+ border-top: 1px none #E0E0E0;
158
+ border-right: 1px none #E0E0E0;
159
+ border-bottom: 1px none #E0E0E0;
160
+ border-left: 1px none #E0E0E0;
161
+ margin: 0px;
162
+ }
163
+ .mdescRight {
164
+ padding: 0px 8px 4px 8px;
165
+ font-size: 80%;
166
+ font-style: italic;
167
+ background-color: #FAFAFA;
168
+ border-top: 1px none #E0E0E0;
169
+ border-right: 1px none #E0E0E0;
170
+ border-bottom: 1px none #E0E0E0;
171
+ border-left: 1px none #E0E0E0;
172
+ margin: 0px;
173
+ }
174
+ .memItemLeft {
175
+ padding: 1px 0px 0px 8px;
176
+ margin: 4px;
177
+ border-top-width: 1px;
178
+ border-right-width: 1px;
179
+ border-bottom-width: 1px;
180
+ border-left-width: 1px;
181
+ border-top-color: #E0E0E0;
182
+ border-right-color: #E0E0E0;
183
+ border-bottom-color: #E0E0E0;
184
+ border-left-color: #E0E0E0;
185
+ border-top-style: solid;
186
+ border-right-style: none;
187
+ border-bottom-style: none;
188
+ border-left-style: none;
189
+ background-color: #FAFAFA;
190
+ font-size: 80%;
191
+ }
192
+ .memItemRight {
193
+ padding: 1px 8px 0px 8px;
194
+ margin: 4px;
195
+ border-top-width: 1px;
196
+ border-right-width: 1px;
197
+ border-bottom-width: 1px;
198
+ border-left-width: 1px;
199
+ border-top-color: #E0E0E0;
200
+ border-right-color: #E0E0E0;
201
+ border-bottom-color: #E0E0E0;
202
+ border-left-color: #E0E0E0;
203
+ border-top-style: solid;
204
+ border-right-style: none;
205
+ border-bottom-style: none;
206
+ border-left-style: none;
207
+ background-color: #FAFAFA;
208
+ font-size: 80%;
209
+ }
210
+ .memTemplItemLeft {
211
+ padding: 1px 0px 0px 8px;
212
+ margin: 4px;
213
+ border-top-width: 1px;
214
+ border-right-width: 1px;
215
+ border-bottom-width: 1px;
216
+ border-left-width: 1px;
217
+ border-top-color: #E0E0E0;
218
+ border-right-color: #E0E0E0;
219
+ border-bottom-color: #E0E0E0;
220
+ border-left-color: #E0E0E0;
221
+ border-top-style: none;
222
+ border-right-style: none;
223
+ border-bottom-style: none;
224
+ border-left-style: none;
225
+ background-color: #FAFAFA;
226
+ font-size: 80%;
227
+ }
228
+ .memTemplItemRight {
229
+ padding: 1px 8px 0px 8px;
230
+ margin: 4px;
231
+ border-top-width: 1px;
232
+ border-right-width: 1px;
233
+ border-bottom-width: 1px;
234
+ border-left-width: 1px;
235
+ border-top-color: #E0E0E0;
236
+ border-right-color: #E0E0E0;
237
+ border-bottom-color: #E0E0E0;
238
+ border-left-color: #E0E0E0;
239
+ border-top-style: none;
240
+ border-right-style: none;
241
+ border-bottom-style: none;
242
+ border-left-style: none;
243
+ background-color: #FAFAFA;
244
+ font-size: 80%;
245
+ }
246
+ .memTemplParams {
247
+ padding: 1px 0px 0px 8px;
248
+ margin: 4px;
249
+ border-top-width: 1px;
250
+ border-right-width: 1px;
251
+ border-bottom-width: 1px;
252
+ border-left-width: 1px;
253
+ border-top-color: #E0E0E0;
254
+ border-right-color: #E0E0E0;
255
+ border-bottom-color: #E0E0E0;
256
+ border-left-color: #E0E0E0;
257
+ border-top-style: solid;
258
+ border-right-style: none;
259
+ border-bottom-style: none;
260
+ border-left-style: none;
261
+ color: #606060;
262
+ background-color: #FAFAFA;
263
+ font-size: 80%;
264
+ }
265
+ .search { color: #003399;
266
+ font-weight: bold;
267
+ }
268
+ FORM.search {
269
+ margin-bottom: 0px;
270
+ margin-top: 0px;
271
+ }
272
+ INPUT.search { font-size: 75%;
273
+ color: #000080;
274
+ font-weight: normal;
275
+ background-color: #e8eef2;
276
+ }
277
+ TD.tiny { font-size: 75%;
278
+ }
279
+ a {
280
+ color: #1A41A8;
281
+ }
282
+ a:visited {
283
+ color: #2A3798;
284
+ }
285
+ .dirtab { padding: 4px;
286
+ border-collapse: collapse;
287
+ border: 1px solid #84b0c7;
288
+ }
289
+ TH.dirtab { background: #e8eef2;
290
+ font-weight: bold;
291
+ }
292
+ HR { height: 1px;
293
+ border: none;
294
+ border-top: 1px solid black;
295
+ }
296
+
297
+ /* Style for detailed member documentation */
298
+ .memtemplate {
299
+ font-size: 80%;
300
+ color: #606060;
301
+ font-weight: normal;
302
+ }
303
+ .memnav {
304
+ background-color: #e8eef2;
305
+ border: 1px solid #84b0c7;
306
+ text-align: center;
307
+ margin: 2px;
308
+ margin-right: 15px;
309
+ padding: 2px;
310
+ }
311
+ .memitem {
312
+ padding: 4px;
313
+ background-color: #eef3f5;
314
+ border-width: 1px;
315
+ border-style: solid;
316
+ border-color: #dedeee;
317
+ -moz-border-radius: 8px 8px 8px 8px;
318
+ }
319
+ .memname {
320
+ white-space: nowrap;
321
+ font-weight: bold;
322
+ }
323
+ .memdoc{
324
+ padding-left: 10px;
325
+ }
326
+ .memproto {
327
+ background-color: #d5e1e8;
328
+ width: 100%;
329
+ border-width: 1px;
330
+ border-style: solid;
331
+ border-color: #84b0c7;
332
+ font-weight: bold;
333
+ -moz-border-radius: 8px 8px 8px 8px;
334
+ }
335
+ .paramkey {
336
+ text-align: right;
337
+ }
338
+ .paramtype {
339
+ white-space: nowrap;
340
+ }
341
+ .paramname {
342
+ color: #602020;
343
+ font-style: italic;
344
+ }
345
+ /* End Styling for detailed member documentation */
346
+
347
+ /* for the tree view */
348
+ .ftvtree {
349
+ font-family: sans-serif;
350
+ margin:0.5em;
351
+ }
352
+ .directory { font-size: 9pt; font-weight: bold; }
353
+ .directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; }
354
+ .directory > h3 { margin-top: 0; }
355
+ .directory p { margin: 0px; white-space: nowrap; }
356
+ .directory div { display: none; margin: 0px; }
357
+ .directory img { vertical-align: -30%; }
358
+