taskjuggler 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (571) hide show
  1. data/COPYING +280 -0
  2. data/README +31 -0
  3. data/Rakefile +20 -0
  4. data/benchmarks/UTF-8-Strings.rb +58 -0
  5. data/benchmarks/allocate.tjp +30 -0
  6. data/benchmarks/booking.tjp +62 -0
  7. data/benchmarks/depends.tjp +112 -0
  8. data/benchmarks/htmltaskreport.tjp +45 -0
  9. data/benchmarks/runbench.rb +24 -0
  10. data/bin/tj3 +3 -0
  11. data/bin/tj3man +3 -0
  12. data/doc/classes/AppConfig.html +808 -0
  13. data/doc/classes/Arguments.html +226 -0
  14. data/doc/classes/String.html +395 -0
  15. data/doc/classes/TaskJuggler.html +1358 -0
  16. data/doc/classes/TaskJuggler/Account.html +257 -0
  17. data/doc/classes/TaskJuggler/AccountScenario.html +218 -0
  18. data/doc/classes/TaskJuggler/Allocation.html +419 -0
  19. data/doc/classes/TaskJuggler/AllocationAttribute.html +291 -0
  20. data/doc/classes/TaskJuggler/AttributeBase.html +608 -0
  21. data/doc/classes/TaskJuggler/AttributeDefinition.html +259 -0
  22. data/doc/classes/TaskJuggler/Booking.html +307 -0
  23. data/doc/classes/TaskJuggler/BookingListAttribute.html +263 -0
  24. data/doc/classes/TaskJuggler/BooleanAttribute.html +261 -0
  25. data/doc/classes/TaskJuggler/CSVFile.html +325 -0
  26. data/doc/classes/TaskJuggler/Charge.html +279 -0
  27. data/doc/classes/TaskJuggler/ChargeListAttribute.html +229 -0
  28. data/doc/classes/TaskJuggler/ChargeSet.html +440 -0
  29. data/doc/classes/TaskJuggler/ChargeSetListAttribute.html +276 -0
  30. data/doc/classes/TaskJuggler/ColumnTable.html +260 -0
  31. data/doc/classes/TaskJuggler/DateAttribute.html +194 -0
  32. data/doc/classes/TaskJuggler/DependencyListAttribute.html +267 -0
  33. data/doc/classes/TaskJuggler/DurationAttribute.html +229 -0
  34. data/doc/classes/TaskJuggler/FixnumAttribute.html +194 -0
  35. data/doc/classes/TaskJuggler/FlagListAttribute.html +263 -0
  36. data/doc/classes/TaskJuggler/FloatAttribute.html +229 -0
  37. data/doc/classes/TaskJuggler/GanttChart.html +667 -0
  38. data/doc/classes/TaskJuggler/GanttContainer.html +441 -0
  39. data/doc/classes/TaskJuggler/GanttHeader.html +280 -0
  40. data/doc/classes/TaskJuggler/GanttHeaderScaleItem.html +245 -0
  41. data/doc/classes/TaskJuggler/GanttLine.html +398 -0
  42. data/doc/classes/TaskJuggler/GanttLoadStack.html +327 -0
  43. data/doc/classes/TaskJuggler/GanttMilestone.html +415 -0
  44. data/doc/classes/TaskJuggler/GanttRouter.html +425 -0
  45. data/doc/classes/TaskJuggler/GanttTaskBar.html +429 -0
  46. data/doc/classes/TaskJuggler/HTMLDocument.html +240 -0
  47. data/doc/classes/TaskJuggler/HTMLGraphics.html +231 -0
  48. data/doc/classes/TaskJuggler/Interval.html +552 -0
  49. data/doc/classes/TaskJuggler/IntervalListAttribute.html +267 -0
  50. data/doc/classes/TaskJuggler/KeywordDocumentation.html +796 -0
  51. data/doc/classes/TaskJuggler/Limits.html +416 -0
  52. data/doc/classes/TaskJuggler/Limits/Limit.html +381 -0
  53. data/doc/classes/TaskJuggler/LimitsAttribute.html +261 -0
  54. data/doc/classes/TaskJuggler/Log.html +613 -0
  55. data/doc/classes/TaskJuggler/LogicalAttribute.html +226 -0
  56. data/doc/classes/TaskJuggler/LogicalExpression.html +251 -0
  57. data/doc/classes/TaskJuggler/LogicalFlag.html +229 -0
  58. data/doc/classes/TaskJuggler/LogicalFunction.html +324 -0
  59. data/doc/classes/TaskJuggler/LogicalOperation.html +299 -0
  60. data/doc/classes/TaskJuggler/Macro.html +194 -0
  61. data/doc/classes/TaskJuggler/MacroParser.html +360 -0
  62. data/doc/classes/TaskJuggler/MacroTable.html +366 -0
  63. data/doc/classes/TaskJuggler/Message.html +281 -0
  64. data/doc/classes/TaskJuggler/MessageHandler.html +215 -0
  65. data/doc/classes/TaskJuggler/Project.html +1606 -0
  66. data/doc/classes/TaskJuggler/ProjectFileParser.html +412 -0
  67. data/doc/classes/TaskJuggler/PropertyList.html +597 -0
  68. data/doc/classes/TaskJuggler/PropertySet.html +1200 -0
  69. data/doc/classes/TaskJuggler/PropertyTreeNode.html +1449 -0
  70. data/doc/classes/TaskJuggler/Query.html +600 -0
  71. data/doc/classes/TaskJuggler/RealFormat.html +252 -0
  72. data/doc/classes/TaskJuggler/ReferenceAttribute.html +194 -0
  73. data/doc/classes/TaskJuggler/Report.html +528 -0
  74. data/doc/classes/TaskJuggler/ReportElement.html +1070 -0
  75. data/doc/classes/TaskJuggler/ReportTable.html +497 -0
  76. data/doc/classes/TaskJuggler/ReportTableCell.html +518 -0
  77. data/doc/classes/TaskJuggler/ReportTableColumn.html +364 -0
  78. data/doc/classes/TaskJuggler/ReportTableElement.html +644 -0
  79. data/doc/classes/TaskJuggler/ReportTableLegend.html +343 -0
  80. data/doc/classes/TaskJuggler/ReportTableLine.html +431 -0
  81. data/doc/classes/TaskJuggler/Resource.html +211 -0
  82. data/doc/classes/TaskJuggler/ResourceListAttribute.html +267 -0
  83. data/doc/classes/TaskJuggler/ResourceListRE.html +249 -0
  84. data/doc/classes/TaskJuggler/ResourceScenario.html +1137 -0
  85. data/doc/classes/TaskJuggler/RichText.html +537 -0
  86. data/doc/classes/TaskJuggler/RichTextAttribute.html +229 -0
  87. data/doc/classes/TaskJuggler/RichTextDocument.html +418 -0
  88. data/doc/classes/TaskJuggler/RichTextElement.html +829 -0
  89. data/doc/classes/TaskJuggler/RichTextException.html +212 -0
  90. data/doc/classes/TaskJuggler/RichTextParser.html +317 -0
  91. data/doc/classes/TaskJuggler/RichTextProtocolExample.html +303 -0
  92. data/doc/classes/TaskJuggler/RichTextProtocolHandler.html +194 -0
  93. data/doc/classes/TaskJuggler/RichTextScanner.html +561 -0
  94. data/doc/classes/TaskJuggler/RichTextSnip.html +364 -0
  95. data/doc/classes/TaskJuggler/RichTextSyntaxRules.html +883 -0
  96. data/doc/classes/TaskJuggler/Scenario.html +163 -0
  97. data/doc/classes/TaskJuggler/ScenarioData.html +354 -0
  98. data/doc/classes/TaskJuggler/Scoreboard.html +638 -0
  99. data/doc/classes/TaskJuggler/Shift.html +255 -0
  100. data/doc/classes/TaskJuggler/ShiftAssignment.html +488 -0
  101. data/doc/classes/TaskJuggler/ShiftAssignments.html +715 -0
  102. data/doc/classes/TaskJuggler/ShiftAssignmentsAttribute.html +261 -0
  103. data/doc/classes/TaskJuggler/ShiftScenario.html +282 -0
  104. data/doc/classes/TaskJuggler/SourceFileInfo.html +247 -0
  105. data/doc/classes/TaskJuggler/StringAttribute.html +229 -0
  106. data/doc/classes/TaskJuggler/SymbolAttribute.html +194 -0
  107. data/doc/classes/TaskJuggler/SyntaxReference.html +516 -0
  108. data/doc/classes/TaskJuggler/TOCEntry.html +242 -0
  109. data/doc/classes/TaskJuggler/TableColumnDefinition.html +273 -0
  110. data/doc/classes/TaskJuggler/TableOfContents.html +256 -0
  111. data/doc/classes/TaskJuggler/Task.html +203 -0
  112. data/doc/classes/TaskJuggler/TaskDependency.html +251 -0
  113. data/doc/classes/TaskJuggler/TaskListAttribute.html +267 -0
  114. data/doc/classes/TaskJuggler/TaskListRE.html +250 -0
  115. data/doc/classes/TaskJuggler/TaskScenario.html +2206 -0
  116. data/doc/classes/TaskJuggler/TextParser.html +670 -0
  117. data/doc/classes/TaskJuggler/TextParser/Pattern.html +923 -0
  118. data/doc/classes/TaskJuggler/TextParser/Rule.html +779 -0
  119. data/doc/classes/TaskJuggler/TextParser/StackElement.html +267 -0
  120. data/doc/classes/TaskJuggler/TextParser/TextParserResultArray.html +212 -0
  121. data/doc/classes/TaskJuggler/TextParser/TokenDoc.html +221 -0
  122. data/doc/classes/TaskJuggler/TextScanner.html +708 -0
  123. data/doc/classes/TaskJuggler/TextScanner/BufferStreamHandle.html +355 -0
  124. data/doc/classes/TaskJuggler/TextScanner/FileStreamHandle.html +341 -0
  125. data/doc/classes/TaskJuggler/TextScanner/StreamHandle.html +260 -0
  126. data/doc/classes/TaskJuggler/TjException.html +185 -0
  127. data/doc/classes/TaskJuggler/TjTime.html +1845 -0
  128. data/doc/classes/TaskJuggler/TjpExample.html +310 -0
  129. data/doc/classes/TaskJuggler/TjpExportRE.html +329 -0
  130. data/doc/classes/TaskJuggler/TjpSyntaxRules.html +8928 -0
  131. data/doc/classes/TaskJuggler/UserManual.html +606 -0
  132. data/doc/classes/TaskJuggler/WorkingHours.html +582 -0
  133. data/doc/classes/TaskJuggler/WorkingHoursAttribute.html +284 -0
  134. data/doc/classes/TaskJuggler/XMLBlob.html +207 -0
  135. data/doc/classes/TaskJuggler/XMLComment.html +206 -0
  136. data/doc/classes/TaskJuggler/XMLDocument.html +293 -0
  137. data/doc/classes/TaskJuggler/XMLElement.html +341 -0
  138. data/doc/classes/TaskJuggler/XMLNamedText.html +174 -0
  139. data/doc/classes/TaskJuggler/XMLText.html +221 -0
  140. data/doc/files/COPYING.html +448 -0
  141. data/doc/files/README.html +134 -0
  142. data/doc/files/lib/AccountScenario_rb.html +116 -0
  143. data/doc/files/lib/Account_rb.html +118 -0
  144. data/doc/files/lib/Allocation_rb.html +118 -0
  145. data/doc/files/lib/AppConfig_rb.html +116 -0
  146. data/doc/files/lib/AttributeBase_rb.html +106 -0
  147. data/doc/files/lib/AttributeDefinition_rb.html +106 -0
  148. data/doc/files/lib/Attributes_rb.html +130 -0
  149. data/doc/files/lib/Booking_rb.html +106 -0
  150. data/doc/files/lib/ChargeSet_rb.html +116 -0
  151. data/doc/files/lib/Charge_rb.html +116 -0
  152. data/doc/files/lib/HTMLDocument_rb.html +116 -0
  153. data/doc/files/lib/Interval_rb.html +116 -0
  154. data/doc/files/lib/KeywordDocumentation_rb.html +122 -0
  155. data/doc/files/lib/Limits_rb.html +116 -0
  156. data/doc/files/lib/Log_rb.html +116 -0
  157. data/doc/files/lib/LogicalExpression_rb.html +122 -0
  158. data/doc/files/lib/LogicalFlag_rb.html +116 -0
  159. data/doc/files/lib/LogicalFunction_rb.html +116 -0
  160. data/doc/files/lib/LogicalOperation_rb.html +116 -0
  161. data/doc/files/lib/MacroParser_rb.html +118 -0
  162. data/doc/files/lib/MacroTable_rb.html +122 -0
  163. data/doc/files/lib/MessageHandler_rb.html +106 -0
  164. data/doc/files/lib/Message_rb.html +116 -0
  165. data/doc/files/lib/ProjectFileParser_rb.html +122 -0
  166. data/doc/files/lib/Project_rb.html +148 -0
  167. data/doc/files/lib/PropertyList_rb.html +106 -0
  168. data/doc/files/lib/PropertySet_rb.html +118 -0
  169. data/doc/files/lib/PropertyTreeNode_rb.html +106 -0
  170. data/doc/files/lib/Query_rb.html +116 -0
  171. data/doc/files/lib/RealFormat_rb.html +106 -0
  172. data/doc/files/lib/ResourceScenario_rb.html +116 -0
  173. data/doc/files/lib/Resource_rb.html +118 -0
  174. data/doc/files/lib/RichTextDocument_rb.html +120 -0
  175. data/doc/files/lib/RichTextElement_rb.html +120 -0
  176. data/doc/files/lib/RichTextParser_rb.html +120 -0
  177. data/doc/files/lib/RichTextProtocolExample_rb.html +120 -0
  178. data/doc/files/lib/RichTextProtocolHandler_rb.html +106 -0
  179. data/doc/files/lib/RichTextScanner_rb.html +116 -0
  180. data/doc/files/lib/RichTextSnip_rb.html +118 -0
  181. data/doc/files/lib/RichTextSyntaxRules_rb.html +106 -0
  182. data/doc/files/lib/RichText_rb.html +118 -0
  183. data/doc/files/lib/ScenarioData_rb.html +118 -0
  184. data/doc/files/lib/Scenario_rb.html +116 -0
  185. data/doc/files/lib/Scoreboard_rb.html +106 -0
  186. data/doc/files/lib/ShiftAssignments_rb.html +116 -0
  187. data/doc/files/lib/ShiftScenario_rb.html +116 -0
  188. data/doc/files/lib/Shift_rb.html +118 -0
  189. data/doc/files/lib/SourceFileInfo_rb.html +106 -0
  190. data/doc/files/lib/SyntaxReference_rb.html +122 -0
  191. data/doc/files/lib/TOCEntry_rb.html +118 -0
  192. data/doc/files/lib/TableColumnDefinition_rb.html +106 -0
  193. data/doc/files/lib/TableOfContents_rb.html +118 -0
  194. data/doc/files/lib/TaskDependency_rb.html +106 -0
  195. data/doc/files/lib/TaskJuggler_rb.html +120 -0
  196. data/doc/files/lib/TaskScenario_rb.html +116 -0
  197. data/doc/files/lib/Task_rb.html +118 -0
  198. data/doc/files/lib/TextParser/Pattern_rb.html +116 -0
  199. data/doc/files/lib/TextParser/Rule_rb.html +106 -0
  200. data/doc/files/lib/TextParser/StackElement_rb.html +106 -0
  201. data/doc/files/lib/TextParser/TokenDoc_rb.html +106 -0
  202. data/doc/files/lib/TextParser_rb.html +124 -0
  203. data/doc/files/lib/TextScanner_rb.html +128 -0
  204. data/doc/files/lib/Tj3Config_rb.html +118 -0
  205. data/doc/files/lib/TjException_rb.html +106 -0
  206. data/doc/files/lib/TjTime_rb.html +118 -0
  207. data/doc/files/lib/TjpExample_rb.html +116 -0
  208. data/doc/files/lib/TjpSyntaxRules_rb.html +106 -0
  209. data/doc/files/lib/UTF8String_rb.html +132 -0
  210. data/doc/files/lib/UserManual_rb.html +124 -0
  211. data/doc/files/lib/WorkingHours_rb.html +116 -0
  212. data/doc/files/lib/XMLDocument_rb.html +116 -0
  213. data/doc/files/lib/XMLElement_rb.html +116 -0
  214. data/doc/files/lib/reports/CSVFile_rb.html +116 -0
  215. data/doc/files/lib/reports/ColumnTable_rb.html +116 -0
  216. data/doc/files/lib/reports/GanttChart_rb.html +122 -0
  217. data/doc/files/lib/reports/GanttContainer_rb.html +116 -0
  218. data/doc/files/lib/reports/GanttHeaderScaleItem_rb.html +106 -0
  219. data/doc/files/lib/reports/GanttHeader_rb.html +116 -0
  220. data/doc/files/lib/reports/GanttLine_rb.html +126 -0
  221. data/doc/files/lib/reports/GanttLoadStack_rb.html +116 -0
  222. data/doc/files/lib/reports/GanttMilestone_rb.html +116 -0
  223. data/doc/files/lib/reports/GanttRouter_rb.html +106 -0
  224. data/doc/files/lib/reports/GanttTaskBar_rb.html +116 -0
  225. data/doc/files/lib/reports/HTMLGraphics_rb.html +106 -0
  226. data/doc/files/lib/reports/ReportElement_rb.html +118 -0
  227. data/doc/files/lib/reports/ReportTableCell_rb.html +106 -0
  228. data/doc/files/lib/reports/ReportTableColumn_rb.html +106 -0
  229. data/doc/files/lib/reports/ReportTableElement_rb.html +122 -0
  230. data/doc/files/lib/reports/ReportTableLegend_rb.html +106 -0
  231. data/doc/files/lib/reports/ReportTableLine_rb.html +116 -0
  232. data/doc/files/lib/reports/ReportTable_rb.html +118 -0
  233. data/doc/files/lib/reports/Report_rb.html +126 -0
  234. data/doc/files/lib/reports/ResourceListRE_rb.html +122 -0
  235. data/doc/files/lib/reports/TaskListRE_rb.html +122 -0
  236. data/doc/files/lib/reports/TjpExportRE_rb.html +116 -0
  237. data/doc/files/lib/taskjuggler3_rb.html +276 -0
  238. data/doc/files/lib/tj3man_rb.html +189 -0
  239. data/doc/fr_class_index.html +285 -0
  240. data/doc/fr_file_index.html +223 -0
  241. data/doc/fr_method_index.html +1953 -0
  242. data/doc/index.html +21 -0
  243. data/doc/rdoc-style.css +299 -0
  244. data/examples/tutorial.tjp +361 -0
  245. data/gem_spec.rb +30 -0
  246. data/lib/Account.rb +50 -0
  247. data/lib/AccountScenario.rb +39 -0
  248. data/lib/Allocation.rb +102 -0
  249. data/lib/AppConfig.rb +134 -0
  250. data/lib/AttributeBase.rb +131 -0
  251. data/lib/AttributeDefinition.rb +47 -0
  252. data/lib/Attributes.rb +478 -0
  253. data/lib/BatchProcessor.rb +209 -0
  254. data/lib/Booking.rb +59 -0
  255. data/lib/Charge.rb +71 -0
  256. data/lib/ChargeSet.rb +126 -0
  257. data/lib/HTMLDocument.rb +59 -0
  258. data/lib/Interval.rb +127 -0
  259. data/lib/KeywordDocumentation.rb +560 -0
  260. data/lib/Limits.rb +219 -0
  261. data/lib/Log.rb +160 -0
  262. data/lib/LogicalExpression.rb +71 -0
  263. data/lib/LogicalFlag.rb +34 -0
  264. data/lib/LogicalFunction.rb +102 -0
  265. data/lib/LogicalOperation.rb +118 -0
  266. data/lib/MacroParser.rb +77 -0
  267. data/lib/MacroTable.rb +84 -0
  268. data/lib/Message.rb +56 -0
  269. data/lib/MessageHandler.rb +34 -0
  270. data/lib/Project.rb +662 -0
  271. data/lib/ProjectFileParser.rb +333 -0
  272. data/lib/PropertyList.rb +181 -0
  273. data/lib/PropertySet.rb +304 -0
  274. data/lib/PropertyTreeNode.rb +461 -0
  275. data/lib/Query.rb +227 -0
  276. data/lib/RealFormat.rb +73 -0
  277. data/lib/Resource.rb +42 -0
  278. data/lib/ResourceScenario.rb +511 -0
  279. data/lib/RichText.rb +147 -0
  280. data/lib/RichTextDocument.rb +139 -0
  281. data/lib/RichTextElement.rb +391 -0
  282. data/lib/RichTextParser.rb +66 -0
  283. data/lib/RichTextProtocolExample.rb +65 -0
  284. data/lib/RichTextProtocolHandler.rb +35 -0
  285. data/lib/RichTextScanner.rb +390 -0
  286. data/lib/RichTextSnip.rb +104 -0
  287. data/lib/RichTextSyntaxRules.rb +265 -0
  288. data/lib/Scenario.rb +27 -0
  289. data/lib/ScenarioData.rb +65 -0
  290. data/lib/Scoreboard.rb +141 -0
  291. data/lib/Shift.rb +48 -0
  292. data/lib/ShiftAssignments.rb +291 -0
  293. data/lib/ShiftScenario.rb +46 -0
  294. data/lib/SourceFileInfo.rb +37 -0
  295. data/lib/SyntaxReference.rb +284 -0
  296. data/lib/TOCEntry.rb +76 -0
  297. data/lib/TableColumnDefinition.rb +54 -0
  298. data/lib/TableOfContents.rb +46 -0
  299. data/lib/Task.rb +37 -0
  300. data/lib/TaskDependency.rb +39 -0
  301. data/lib/TaskJuggler.rb +84 -0
  302. data/lib/TaskScenario.rb +1622 -0
  303. data/lib/TextParser.rb +416 -0
  304. data/lib/TextParser/Pattern.rb +263 -0
  305. data/lib/TextParser/Rule.rb +171 -0
  306. data/lib/TextParser/StackElement.rb +45 -0
  307. data/lib/TextParser/TokenDoc.rb +38 -0
  308. data/lib/TextScanner.rb +682 -0
  309. data/lib/Tj3Config.rb +27 -0
  310. data/lib/TjException.rb +27 -0
  311. data/lib/TjTime.rb +395 -0
  312. data/lib/TjpExample.rb +119 -0
  313. data/lib/TjpSyntaxRules.rb +4022 -0
  314. data/lib/UTF8String.rb +100 -0
  315. data/lib/UserManual.rb +282 -0
  316. data/lib/WorkingHours.rb +323 -0
  317. data/lib/XMLDocument.rb +54 -0
  318. data/lib/XMLElement.rb +175 -0
  319. data/lib/reports/CSVFile.rb +146 -0
  320. data/lib/reports/ColumnTable.rb +66 -0
  321. data/lib/reports/GanttChart.rb +308 -0
  322. data/lib/reports/GanttContainer.rb +107 -0
  323. data/lib/reports/GanttHeader.rb +141 -0
  324. data/lib/reports/GanttHeaderScaleItem.rb +42 -0
  325. data/lib/reports/GanttLine.rb +329 -0
  326. data/lib/reports/GanttLoadStack.rb +113 -0
  327. data/lib/reports/GanttMilestone.rb +80 -0
  328. data/lib/reports/GanttRouter.rb +375 -0
  329. data/lib/reports/GanttTaskBar.rb +95 -0
  330. data/lib/reports/HTMLGraphics.rb +65 -0
  331. data/lib/reports/Report.rb +344 -0
  332. data/lib/reports/ReportElement.rb +427 -0
  333. data/lib/reports/ReportTable.rb +144 -0
  334. data/lib/reports/ReportTableCell.rb +142 -0
  335. data/lib/reports/ReportTableColumn.rb +82 -0
  336. data/lib/reports/ReportTableElement.rb +852 -0
  337. data/lib/reports/ReportTableLegend.rb +167 -0
  338. data/lib/reports/ReportTableLine.rb +87 -0
  339. data/lib/reports/ResourceListRE.rb +72 -0
  340. data/lib/reports/TaskListRE.rb +73 -0
  341. data/lib/reports/TjpExportRE.rb +394 -0
  342. data/lib/taskjuggler3.rb +106 -0
  343. data/lib/tj3man.rb +88 -0
  344. data/manual/Day_To_Day_Juggling +168 -0
  345. data/manual/Getting_Started +61 -0
  346. data/manual/How_To_Contribute +185 -0
  347. data/manual/Installation +68 -0
  348. data/manual/Intro +102 -0
  349. data/manual/Reporting_Bugs +26 -0
  350. data/manual/Rich_Text_Attributes +90 -0
  351. data/manual/TaskJuggler_2x_Migration +40 -0
  352. data/manual/Tutorial +579 -0
  353. data/manual/fdl +450 -0
  354. data/prj_cfg.rb +43 -0
  355. data/setup.rb +1585 -0
  356. data/tasks/csts.rake +72 -0
  357. data/tasks/gem.rake +14 -0
  358. data/tasks/manual.rake +10 -0
  359. data/tasks/missing.rake +21 -0
  360. data/tasks/rcov.rake +14 -0
  361. data/tasks/rdoc.rake +17 -0
  362. data/tasks/rexml_fix.rb +16 -0
  363. data/tasks/rexml_fix_19.rb +49 -0
  364. data/tasks/show.rake +21 -0
  365. data/tasks/stats.rake +25 -0
  366. data/tasks/test.rake +11 -0
  367. data/test/MessageChecker.rb +53 -0
  368. data/test/TestSuite/CSV-Reports/celltext-Reference.csv +14 -0
  369. data/test/TestSuite/CSV-Reports/celltext.tjp +7 -0
  370. data/test/TestSuite/CSV-Reports/genrefs +6 -0
  371. data/test/TestSuite/CSV-Reports/project-1.tji +57 -0
  372. data/test/TestSuite/CSV-Reports/resourcereport-Reference.csv +4 -0
  373. data/test/TestSuite/CSV-Reports/resourcereport.tjp +10 -0
  374. data/test/TestSuite/CSV-Reports/resourcereport_with_tasks-Reference.csv +22 -0
  375. data/test/TestSuite/CSV-Reports/resourcereport_with_tasks.tjp +11 -0
  376. data/test/TestSuite/CSV-Reports/sortByTree-Reference.csv +14 -0
  377. data/test/TestSuite/CSV-Reports/sortByTree.tjp +8 -0
  378. data/test/TestSuite/CSV-Reports/sortBy_duration.down-Reference.csv +14 -0
  379. data/test/TestSuite/CSV-Reports/sortBy_duration.down.tjp +10 -0
  380. data/test/TestSuite/CSV-Reports/sortBy_effort.up-Reference.csv +14 -0
  381. data/test/TestSuite/CSV-Reports/sortBy_effort.up.tjp +10 -0
  382. data/test/TestSuite/CSV-Reports/sortBy_plan.start.down-Reference.csv +14 -0
  383. data/test/TestSuite/CSV-Reports/sortBy_plan.start.down.tjp +10 -0
  384. data/test/TestSuite/CSV-Reports/taskreport-Reference.csv +14 -0
  385. data/test/TestSuite/CSV-Reports/taskreport.tjp +10 -0
  386. data/test/TestSuite/CSV-Reports/taskreport_with_resources-Reference.csv +24 -0
  387. data/test/TestSuite/CSV-Reports/taskreport_with_resources.tjp +11 -0
  388. data/test/TestSuite/Scheduler/Correct/Allocate.tjp +86 -0
  389. data/test/TestSuite/Scheduler/Correct/AutomaticMilestones.tjp +63 -0
  390. data/test/TestSuite/Scheduler/Correct/Booking.tjp +161 -0
  391. data/test/TestSuite/Scheduler/Correct/Depends.tjp +50 -0
  392. data/test/TestSuite/Scheduler/Correct/Duration.tjp +34 -0
  393. data/test/TestSuite/Scheduler/Correct/InheritStartEnd.tjp +129 -0
  394. data/test/TestSuite/Scheduler/Correct/Limits.tjp +81 -0
  395. data/test/TestSuite/Scheduler/Correct/MultipleMandatories.tjp +43 -0
  396. data/test/TestSuite/Scheduler/Correct/Optimize-1.tjp +28 -0
  397. data/test/TestSuite/Scheduler/Correct/Optimize-2.tjp +33 -0
  398. data/test/TestSuite/Scheduler/Correct/Optimize-3.tjp +33 -0
  399. data/test/TestSuite/Scheduler/Correct/Optimize-4.tjp +34 -0
  400. data/test/TestSuite/Scheduler/Correct/Optimize-5.tjp +62 -0
  401. data/test/TestSuite/Scheduler/Correct/Precedes.tjp +50 -0
  402. data/test/TestSuite/Scheduler/Correct/Shift.tjp +102 -0
  403. data/test/TestSuite/Scheduler/Errors/account_no_leaf.tjp +13 -0
  404. data/test/TestSuite/Scheduler/Errors/booking_conflict.tjp +10 -0
  405. data/test/TestSuite/Scheduler/Errors/booking_no_duty.tjp +9 -0
  406. data/test/TestSuite/Scheduler/Errors/booking_on_vacation.tjp +9 -0
  407. data/test/TestSuite/Scheduler/Errors/container_booking.tjp +14 -0
  408. data/test/TestSuite/Scheduler/Errors/container_duration.tjp +11 -0
  409. data/test/TestSuite/Scheduler/Errors/effort_no_allocations.tjp +7 -0
  410. data/test/TestSuite/Scheduler/Errors/loop_detected_1.tjp +19 -0
  411. data/test/TestSuite/Scheduler/Errors/loop_detected_10.tjp +36 -0
  412. data/test/TestSuite/Scheduler/Errors/loop_detected_11.tjp +27 -0
  413. data/test/TestSuite/Scheduler/Errors/loop_detected_12.tjp +20 -0
  414. data/test/TestSuite/Scheduler/Errors/loop_detected_13.tjp +27 -0
  415. data/test/TestSuite/Scheduler/Errors/loop_detected_14.tjp +26 -0
  416. data/test/TestSuite/Scheduler/Errors/loop_detected_2.tjp +24 -0
  417. data/test/TestSuite/Scheduler/Errors/loop_detected_3.tjp +18 -0
  418. data/test/TestSuite/Scheduler/Errors/loop_detected_4.tjp +36 -0
  419. data/test/TestSuite/Scheduler/Errors/loop_detected_5.tjp +37 -0
  420. data/test/TestSuite/Scheduler/Errors/loop_detected_6.tjp +35 -0
  421. data/test/TestSuite/Scheduler/Errors/loop_detected_7.tjp +46 -0
  422. data/test/TestSuite/Scheduler/Errors/loop_detected_8.tjp +51 -0
  423. data/test/TestSuite/Scheduler/Errors/loop_detected_9.tjp +20 -0
  424. data/test/TestSuite/Scheduler/Errors/maxend.tjp +8 -0
  425. data/test/TestSuite/Scheduler/Errors/maxstart.tjp +8 -0
  426. data/test/TestSuite/Scheduler/Errors/milestone_booking.tjp +10 -0
  427. data/test/TestSuite/Scheduler/Errors/milestone_duration.tjp +8 -0
  428. data/test/TestSuite/Scheduler/Errors/milestone_start_end.tjp +8 -0
  429. data/test/TestSuite/Scheduler/Errors/minend.tjp +8 -0
  430. data/test/TestSuite/Scheduler/Errors/minstart.tjp +8 -0
  431. data/test/TestSuite/Scheduler/Errors/multiple_durations.tjp +11 -0
  432. data/test/TestSuite/Scheduler/Errors/no_tasks.tjp +6 -0
  433. data/test/TestSuite/Scheduler/Errors/not_scheduled.tjp +8 -0
  434. data/test/TestSuite/Scheduler/Errors/task_depend_child.tjp +10 -0
  435. data/test/TestSuite/Scheduler/Errors/task_depend_multi.tjp +13 -0
  436. data/test/TestSuite/Scheduler/Errors/task_depend_parent.tjp +11 -0
  437. data/test/TestSuite/Scheduler/Errors/task_depend_self.tjp +10 -0
  438. data/test/TestSuite/Scheduler/Errors/task_depend_unknown.tjp +10 -0
  439. data/test/TestSuite/Scheduler/Errors/task_overspecified_1.tjp +9 -0
  440. data/test/TestSuite/Scheduler/Errors/task_overspecified_2.tjp +14 -0
  441. data/test/TestSuite/Scheduler/Errors/task_overspecified_3.tjp +14 -0
  442. data/test/TestSuite/Scheduler/Errors/task_underspecified_1.tjp +8 -0
  443. data/test/TestSuite/Scheduler/Errors/task_underspecified_2.tjp +8 -0
  444. data/test/TestSuite/Scheduler/Errors/task_underspecified_3.tjp +9 -0
  445. data/test/TestSuite/Syntax/Correct/Account.tjp +53 -0
  446. data/test/TestSuite/Syntax/Correct/Allocate-1.tjp +24 -0
  447. data/test/TestSuite/Syntax/Correct/Alternative.tjp +13 -0
  448. data/test/TestSuite/Syntax/Correct/AutoMacros.tjp +14 -0
  449. data/test/TestSuite/Syntax/Correct/Booking.tjp +26 -0
  450. data/test/TestSuite/Syntax/Correct/Caption.tjp +33 -0
  451. data/test/TestSuite/Syntax/Correct/Celltext.tjp +28 -0
  452. data/test/TestSuite/Syntax/Correct/Comments.tjp +29 -0
  453. data/test/TestSuite/Syntax/Correct/Complete.tjp +16 -0
  454. data/test/TestSuite/Syntax/Correct/CompletedWork.tji +20 -0
  455. data/test/TestSuite/Syntax/Correct/CriticalPath.tjp +31 -0
  456. data/test/TestSuite/Syntax/Correct/Currencyformat.tjp +12 -0
  457. data/test/TestSuite/Syntax/Correct/CustomAttributes.tjp +14 -0
  458. data/test/TestSuite/Syntax/Correct/Depends1.tjp +22 -0
  459. data/test/TestSuite/Syntax/Correct/Durations.tjp +29 -0
  460. data/test/TestSuite/Syntax/Correct/Efficiency.tjp +19 -0
  461. data/test/TestSuite/Syntax/Correct/Export.tjp +40 -0
  462. data/test/TestSuite/Syntax/Correct/Flags.tjp +32 -0
  463. data/test/TestSuite/Syntax/Correct/Freeze.tjp +28 -0
  464. data/test/TestSuite/Syntax/Correct/Gap.tjp +15 -0
  465. data/test/TestSuite/Syntax/Correct/HtmlTaskReport.tjp +33 -0
  466. data/test/TestSuite/Syntax/Correct/Limits-1.tjp +71 -0
  467. data/test/TestSuite/Syntax/Correct/LoadUnits.tjp +31 -0
  468. data/test/TestSuite/Syntax/Correct/Macro-1.tjp +19 -0
  469. data/test/TestSuite/Syntax/Correct/Mandatory.tjp +17 -0
  470. data/test/TestSuite/Syntax/Correct/Milestone.tjp +12 -0
  471. data/test/TestSuite/Syntax/Correct/MinMax.tjp +17 -0
  472. data/test/TestSuite/Syntax/Correct/Numberformat.tjp +12 -0
  473. data/test/TestSuite/Syntax/Correct/Period.tjp +16 -0
  474. data/test/TestSuite/Syntax/Correct/Persistent.tjp +11 -0
  475. data/test/TestSuite/Syntax/Correct/Precedes1.tjp +17 -0
  476. data/test/TestSuite/Syntax/Correct/Priority.tjp +30 -0
  477. data/test/TestSuite/Syntax/Correct/Project.tjp +21 -0
  478. data/test/TestSuite/Syntax/Correct/ProjectIDs.tjp +23 -0
  479. data/test/TestSuite/Syntax/Correct/RawHTML.tjp +29 -0
  480. data/test/TestSuite/Syntax/Correct/Reports.tjp +54 -0
  481. data/test/TestSuite/Syntax/Correct/Resource.tjp +20 -0
  482. data/test/TestSuite/Syntax/Correct/Responsible.tjp +16 -0
  483. data/test/TestSuite/Syntax/Correct/Scenario.tjp +15 -0
  484. data/test/TestSuite/Syntax/Correct/Scheduling.tjp +26 -0
  485. data/test/TestSuite/Syntax/Correct/Select.tjp +27 -0
  486. data/test/TestSuite/Syntax/Correct/Shift.tjp +55 -0
  487. data/test/TestSuite/Syntax/Correct/Simple.tjp +25 -0
  488. data/test/TestSuite/Syntax/Correct/String.tjp +12 -0
  489. data/test/TestSuite/Syntax/Correct/Supplement.tjp +24 -0
  490. data/test/TestSuite/Syntax/Correct/TaskRoot.tjp +34 -0
  491. data/test/TestSuite/Syntax/Correct/TimeFrame.tjp +19 -0
  492. data/test/TestSuite/Syntax/Correct/Timezone.tjp +8 -0
  493. data/test/TestSuite/Syntax/Correct/Vacation.tjp +33 -0
  494. data/test/TestSuite/Syntax/Correct/csvtest +16 -0
  495. data/test/TestSuite/Syntax/Correct/manual2example.rb +24 -0
  496. data/test/TestSuite/Syntax/Correct/tutorial.tjp +485 -0
  497. data/test/TestSuite/Syntax/Errors/bad_include.tjp +11 -0
  498. data/test/TestSuite/Syntax/Errors/booking_group.tjp +14 -0
  499. data/test/TestSuite/Syntax/Errors/booking_milestone.tjp +13 -0
  500. data/test/TestSuite/Syntax/Errors/booking_no_leaf.tjp +13 -0
  501. data/test/TestSuite/Syntax/Errors/chargeset.tjp +14 -0
  502. data/test/TestSuite/Syntax/Errors/chargeset_master.tjp +15 -0
  503. data/test/TestSuite/Syntax/Errors/container_attribute.tjp +13 -0
  504. data/test/TestSuite/Syntax/Errors/cost_acct_no_top.tjp +24 -0
  505. data/test/TestSuite/Syntax/Errors/cost_rev_same.tjp +24 -0
  506. data/test/TestSuite/Syntax/Errors/date_in_range.tjp +7 -0
  507. data/test/TestSuite/Syntax/Errors/effort_zero.tjp +8 -0
  508. data/test/TestSuite/Syntax/Errors/empty.tjp +1 -0
  509. data/test/TestSuite/Syntax/Errors/export_bad_extn.tjp +9 -0
  510. data/test/TestSuite/Syntax/Errors/extend_id_cap.tjp +7 -0
  511. data/test/TestSuite/Syntax/Errors/interval_end_in_range.tjp +7 -0
  512. data/test/TestSuite/Syntax/Errors/interval_start_in_range.tjp +7 -0
  513. data/test/TestSuite/Syntax/Errors/leaf_resource_id_expected.tjp +12 -0
  514. data/test/TestSuite/Syntax/Errors/misaligned_date.tjp +7 -0
  515. data/test/TestSuite/Syntax/Errors/no_csv_suffix.tjp +10 -0
  516. data/test/TestSuite/Syntax/Errors/no_html_suffix.tjp +10 -0
  517. data/test/TestSuite/Syntax/Errors/operand_attribute.tjp +11 -0
  518. data/test/TestSuite/Syntax/Errors/operand_unkn_flag.tjp +11 -0
  519. data/test/TestSuite/Syntax/Errors/operand_unkn_scen.tjp +11 -0
  520. data/test/TestSuite/Syntax/Errors/overtime_range.tjp +13 -0
  521. data/test/TestSuite/Syntax/Errors/purge_no_list.tjp +8 -0
  522. data/test/TestSuite/Syntax/Errors/purge_unknown_id.tjp +8 -0
  523. data/test/TestSuite/Syntax/Errors/report_end.tjp +10 -0
  524. data/test/TestSuite/Syntax/Errors/report_redifinition.tjp +10 -0
  525. data/test/TestSuite/Syntax/Errors/report_start.tjp +10 -0
  526. data/test/TestSuite/Syntax/Errors/resource_exists.tjp +7 -0
  527. data/test/TestSuite/Syntax/Errors/resource_id_expected.tjp +8 -0
  528. data/test/TestSuite/Syntax/Errors/rev_acct_no_top.tjp +24 -0
  529. data/test/TestSuite/Syntax/Errors/scenario_exists.tjp +7 -0
  530. data/test/TestSuite/Syntax/Errors/shift_assignment_overlap.tjp +15 -0
  531. data/test/TestSuite/Syntax/Errors/shift_exists.tjp +7 -0
  532. data/test/TestSuite/Syntax/Errors/shift_id_expected.tjp +7 -0
  533. data/test/TestSuite/Syntax/Errors/sloppy_range.tjp +13 -0
  534. data/test/TestSuite/Syntax/Errors/sort_direction.tjp +11 -0
  535. data/test/TestSuite/Syntax/Errors/sort_unknown_scen.tjp +11 -0
  536. data/test/TestSuite/Syntax/Errors/sorting_crit_exptd1.tjp +11 -0
  537. data/test/TestSuite/Syntax/Errors/sorting_crit_exptd2.tjp +11 -0
  538. data/test/TestSuite/Syntax/Errors/sorting_wbs.tjp +11 -0
  539. data/test/TestSuite/Syntax/Errors/start_before_end1.tjp +7 -0
  540. data/test/TestSuite/Syntax/Errors/start_before_end2.tjp +6 -0
  541. data/test/TestSuite/Syntax/Errors/task_complete.tjp +8 -0
  542. data/test/TestSuite/Syntax/Errors/task_exists.tjp +7 -0
  543. data/test/TestSuite/Syntax/Errors/task_priority.tjp +8 -0
  544. data/test/TestSuite/Syntax/Errors/task_without_chargeset.tjp +9 -0
  545. data/test/TestSuite/Syntax/Errors/time_interval.tjp +12 -0
  546. data/test/TestSuite/Syntax/Errors/too_many_bangs.tjp +10 -0
  547. data/test/TestSuite/Syntax/Errors/undecl_flag.tjp +6 -0
  548. data/test/TestSuite/Syntax/Errors/unknown_projectid.tjp +7 -0
  549. data/test/TestSuite/Syntax/Errors/unknown_scenario_id.tjp +6 -0
  550. data/test/TestSuite/Syntax/Errors/unknown_scenario_idx.tjp +11 -0
  551. data/test/TestSuite/Syntax/Errors/unknown_task.tjp +10 -0
  552. data/test/all.rb +31 -0
  553. data/test/test_BatchProcessor.rb +54 -0
  554. data/test/test_CSV-Reports.rb +101 -0
  555. data/test/test_Limits.rb +104 -0
  556. data/test/test_LogicalExpression.rb +110 -0
  557. data/test/test_MacroTable.rb +51 -0
  558. data/test/test_Project.rb +57 -0
  559. data/test/test_PropertySet.rb +71 -0
  560. data/test/test_Query.rb +83 -0
  561. data/test/test_RealFormat.rb +83 -0
  562. data/test/test_RichText.rb +869 -0
  563. data/test/test_Scheduler.rb +42 -0
  564. data/test/test_ShiftAssignments.rb +77 -0
  565. data/test/test_Syntax.rb +41 -0
  566. data/test/test_TextScanner.rb +95 -0
  567. data/test/test_TjTime.rb +114 -0
  568. data/test/test_TjpExample.rb +169 -0
  569. data/test/test_UTF8String.rb +84 -0
  570. data/test/test_WorkingHours.rb +56 -0
  571. metadata +649 -0
@@ -0,0 +1,923 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <title>Class: TaskJuggler::TextParser::Pattern [TaskJuggler III API documentation]</title>
6
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
8
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
9
+ <script type="text/javascript">
10
+ // <![CDATA[
11
+
12
+ function popupCode( url ) {
13
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
14
+ }
15
+
16
+ function toggleCode( id ) {
17
+ if ( document.getElementById )
18
+ elem = document.getElementById( id );
19
+ else if ( document.all )
20
+ elem = eval( "document.all." + id );
21
+ else
22
+ return false;
23
+
24
+ elemStyle = elem.style;
25
+
26
+ if ( elemStyle.display != "block" ) {
27
+ elemStyle.display = "block"
28
+ } else {
29
+ elemStyle.display = "none"
30
+ }
31
+
32
+ return true;
33
+ }
34
+
35
+ // Make codeblocks hidden by default
36
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
37
+
38
+ // ]]>
39
+ </script>
40
+
41
+ </head>
42
+ <body>
43
+
44
+
45
+ <div id="classHeader">
46
+ <table class="header-table">
47
+ <tr class="top-aligned-row">
48
+ <td><strong>Class</strong></td>
49
+ <td class="class-name-in-header">TaskJuggler::TextParser::Pattern</td>
50
+ </tr>
51
+ <tr class="top-aligned-row">
52
+ <td><strong>In:</strong></td>
53
+ <td>
54
+
55
+
56
+ <a href="../../../files/lib/TextParser/Pattern_rb.html">
57
+
58
+ lib/TextParser/Pattern.rb
59
+
60
+ </a>
61
+
62
+
63
+ <br />
64
+
65
+ </td>
66
+ </tr>
67
+
68
+
69
+ <tr class="top-aligned-row">
70
+ <td><strong>Parent:</strong></td>
71
+ <td>
72
+
73
+ Object
74
+
75
+ </td>
76
+ </tr>
77
+
78
+ </table>
79
+ </div>
80
+ <!-- banner header -->
81
+
82
+ <div id="bodyContent">
83
+
84
+ <div id="contextContent">
85
+
86
+ <div id="description">
87
+ <p>
88
+ This class models the most crutial elements of a syntax description - the
89
+ pattern. A TextParserPattern primarily consists of a set of tokens. Tokens
90
+ are Strings where the first character determines the type of the token.
91
+ There are 4 known types.
92
+ </p>
93
+ <p>
94
+ Terminal token: The terminal token is prefixed by an underscore. Terminal
95
+ tokens are terminal symbols of the syntax tree. They just represent
96
+ themselves.
97
+ </p>
98
+ <p>
99
+ Variable token: The variable token describes values of a certain class such
100
+ as strings or numbers. The token is prefixed by a dollar sign and the text
101
+ of the token specifies the variable type. See <a
102
+ href="../ProjectFileParser.html">ProjectFileParser</a> for a complete list
103
+ of variable types.
104
+ </p>
105
+ <p>
106
+ Reference token: The reference token specifies a reference to another
107
+ parser rule. The token is prefixed by a bang and the text matches the name
108
+ of the rule. See TextParserRule for details.
109
+ </p>
110
+ <p>
111
+ End token: The . token marks the expected end of the input stream.
112
+ </p>
113
+ <p>
114
+ In addition to the pure syntax tree information the pattern also holds
115
+ documentary information about the pattern.
116
+ </p>
117
+
118
+ </div>
119
+
120
+ </div>
121
+
122
+
123
+ <div id="method-list">
124
+ <h3 class="section-bar">Methods</h3>
125
+
126
+ <div class="name-list">
127
+
128
+ <a href="#M000468">[]</a>&nbsp;&nbsp;
129
+
130
+ <a href="#M000469">each</a>&nbsp;&nbsp;
131
+
132
+ <a href="#M000470">empty?</a>&nbsp;&nbsp;
133
+
134
+ <a href="#M000471">length</a>&nbsp;&nbsp;
135
+
136
+ <a href="#M000462">new</a>&nbsp;&nbsp;
137
+
138
+ <a href="#M000472">optional?</a>&nbsp;&nbsp;
139
+
140
+ <a href="#M000464">setArg</a>&nbsp;&nbsp;
141
+
142
+ <a href="#M000463">setDoc</a>&nbsp;&nbsp;
143
+
144
+ <a href="#M000467">setExample</a>&nbsp;&nbsp;
145
+
146
+ <a href="#M000465">setLastSyntaxToken</a>&nbsp;&nbsp;
147
+
148
+ <a href="#M000466">setSeeAlso</a>&nbsp;&nbsp;
149
+
150
+ <a href="#M000473">terminalSymbol?</a>&nbsp;&nbsp;
151
+
152
+ <a href="#M000474">terminalToken</a>&nbsp;&nbsp;
153
+
154
+ <a href="#M000477">to_s</a>&nbsp;&nbsp;
155
+
156
+ <a href="#M000475">to_syntax</a>&nbsp;&nbsp;
157
+
158
+ <a href="#M000476">to_syntax_r</a>&nbsp;&nbsp;
159
+
160
+ </div>
161
+ </div>
162
+
163
+ </div>
164
+
165
+ <!-- if includes -->
166
+
167
+ <div id="section">
168
+
169
+
170
+
171
+ <div id="attribute-list">
172
+ <h3 class="section-bar">Attributes</h3>
173
+
174
+ <div class="name-list">
175
+ <table>
176
+
177
+ <tr class="top-aligned-row context-row">
178
+ <td class="context-item-name">doc</td>
179
+
180
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
181
+
182
+ <td class="context-item-desc"></td>
183
+ </tr>
184
+
185
+ <tr class="top-aligned-row context-row">
186
+ <td class="context-item-name">exampleFile</td>
187
+
188
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
189
+
190
+ <td class="context-item-desc"></td>
191
+ </tr>
192
+
193
+ <tr class="top-aligned-row context-row">
194
+ <td class="context-item-name">exampleTag</td>
195
+
196
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
197
+
198
+ <td class="context-item-desc"></td>
199
+ </tr>
200
+
201
+ <tr class="top-aligned-row context-row">
202
+ <td class="context-item-name">function</td>
203
+
204
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
205
+
206
+ <td class="context-item-desc"></td>
207
+ </tr>
208
+
209
+ <tr class="top-aligned-row context-row">
210
+ <td class="context-item-name">keyword</td>
211
+
212
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
213
+
214
+ <td class="context-item-desc"></td>
215
+ </tr>
216
+
217
+ <tr class="top-aligned-row context-row">
218
+ <td class="context-item-name">seeAlso</td>
219
+
220
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
221
+
222
+ <td class="context-item-desc"></td>
223
+ </tr>
224
+
225
+ <tr class="top-aligned-row context-row">
226
+ <td class="context-item-name">tokens</td>
227
+
228
+ <td class="context-item-value">&nbsp;[R]&nbsp;</td>
229
+
230
+ <td class="context-item-desc"></td>
231
+ </tr>
232
+
233
+ </table>
234
+ </div>
235
+ </div>
236
+
237
+
238
+ <!-- if method_list -->
239
+
240
+ <div id="methods">
241
+
242
+ <h3 class="section-bar">Public Class methods</h3>
243
+
244
+
245
+ <div id="method-M000462" class="method-detail">
246
+ <a name="M000462"></a>
247
+
248
+ <div class="method-heading">
249
+
250
+ <a href="#M000462" class="method-signature">
251
+
252
+ <span class="method-name">new</span><span class="method-args">(tokens, function = nil)</span>
253
+
254
+ </a>
255
+
256
+ </div>
257
+
258
+ <div class="method-description">
259
+
260
+ <p><a class="source-toggle" href="#"
261
+ onclick="toggleCode('M000462-source');return false;">[Source]</a></p>
262
+ <div class="method-source-code" id="M000462-source">
263
+ <pre>
264
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 44</span>
265
+ 44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">tokens</span>, <span class="ruby-identifier">function</span> = <span class="ruby-keyword kw">nil</span>)
266
+ 45: <span class="ruby-comment cmt"># A unique name for the pattern that is used in the documentation.</span>
267
+ 46: <span class="ruby-ivar">@keyword</span> = <span class="ruby-keyword kw">nil</span>
268
+ 47: <span class="ruby-comment cmt"># Initialize pattern doc as empty.</span>
269
+ 48: <span class="ruby-ivar">@doc</span> = <span class="ruby-keyword kw">nil</span>
270
+ 49: <span class="ruby-comment cmt"># A list of TokenDoc elements that describe the meaning of variable</span>
271
+ 50: <span class="ruby-comment cmt"># tokens. The order of the tokens and entries in the Array must correlate.</span>
272
+ 51: <span class="ruby-ivar">@args</span> = []
273
+ 52: <span class="ruby-comment cmt"># A list of references to other patterns that are related to this pattern.</span>
274
+ 53: <span class="ruby-ivar">@seeAlso</span> = []
275
+ 54: <span class="ruby-comment cmt"># A reference to a file under test/TestSuite/Syntax/Correct and a tag</span>
276
+ 55: <span class="ruby-comment cmt"># within that file. This identifies example TJP code to be included with</span>
277
+ 56: <span class="ruby-comment cmt"># the reference manual.</span>
278
+ 57: <span class="ruby-ivar">@exampleFile</span> = <span class="ruby-keyword kw">nil</span>
279
+ 58: <span class="ruby-ivar">@exampleTag</span> = <span class="ruby-keyword kw">nil</span>
280
+ 59:
281
+ 60: <span class="ruby-identifier">tokens</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">token</span><span class="ruby-operator">|</span>
282
+ 61: <span class="ruby-keyword kw">unless</span> <span class="ruby-value str">'!$_.'</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">token</span>[<span class="ruby-value">0</span>])
283
+ 62: <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Fatal Error: All pattern tokens must start with a type &quot;</span> <span class="ruby-operator">+</span>
284
+ 63: <span class="ruby-node">&quot;identifier [!$_.]: #{tokens.join(', ')}&quot;</span>
285
+ 64: <span class="ruby-keyword kw">end</span>
286
+ 65: <span class="ruby-comment cmt"># Initialize pattern argument descriptions as empty.</span>
287
+ 66: <span class="ruby-ivar">@args</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-keyword kw">nil</span>
288
+ 67: <span class="ruby-keyword kw">end</span>
289
+ 68: <span class="ruby-ivar">@tokens</span> = <span class="ruby-identifier">tokens</span>
290
+ 69: <span class="ruby-ivar">@function</span> = <span class="ruby-identifier">function</span>
291
+ 70: <span class="ruby-comment cmt"># In some cases we don't want to show all tokens in the syntax</span>
292
+ 71: <span class="ruby-comment cmt"># documentation. This value specifies the index of the last shown token.</span>
293
+ 72: <span class="ruby-ivar">@lastSyntaxToken</span> = <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
294
+ 73: <span class="ruby-keyword kw">end</span>
295
+ </pre>
296
+ </div>
297
+
298
+ </div>
299
+ </div>
300
+
301
+
302
+ <h3 class="section-bar">Public Instance methods</h3>
303
+
304
+
305
+ <div id="method-M000468" class="method-detail">
306
+ <a name="M000468"></a>
307
+
308
+ <div class="method-heading">
309
+
310
+ <a href="#M000468" class="method-signature">
311
+
312
+ <span class="method-name">[]</span><span class="method-args">(i)</span>
313
+
314
+ </a>
315
+
316
+ </div>
317
+
318
+ <div class="method-description">
319
+
320
+ <p>
321
+ Conveniance function to access individual tokens by index.
322
+ </p>
323
+
324
+ <p><a class="source-toggle" href="#"
325
+ onclick="toggleCode('M000468-source');return false;">[Source]</a></p>
326
+ <div class="method-source-code" id="M000468-source">
327
+ <pre>
328
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 103</span>
329
+ 103: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">i</span>)
330
+ 104: <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">i</span>]
331
+ 105: <span class="ruby-keyword kw">end</span>
332
+ </pre>
333
+ </div>
334
+
335
+ </div>
336
+ </div>
337
+
338
+
339
+ <div id="method-M000469" class="method-detail">
340
+ <a name="M000469"></a>
341
+
342
+ <div class="method-heading">
343
+
344
+ <a href="#M000469" class="method-signature">
345
+
346
+ <span class="method-name">each</span><span class="method-args">() {|tok| ...}</span>
347
+
348
+ </a>
349
+
350
+ </div>
351
+
352
+ <div class="method-description">
353
+
354
+ <p>
355
+ Iterator for tokens.
356
+ </p>
357
+
358
+ <p><a class="source-toggle" href="#"
359
+ onclick="toggleCode('M000469-source');return false;">[Source]</a></p>
360
+ <div class="method-source-code" id="M000469-source">
361
+ <pre>
362
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 108</span>
363
+ 108: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
364
+ 109: <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">tok</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">tok</span> }
365
+ 110: <span class="ruby-keyword kw">end</span>
366
+ </pre>
367
+ </div>
368
+
369
+ </div>
370
+ </div>
371
+
372
+
373
+ <div id="method-M000470" class="method-detail">
374
+ <a name="M000470"></a>
375
+
376
+ <div class="method-heading">
377
+
378
+ <a href="#M000470" class="method-signature">
379
+
380
+ <span class="method-name">empty?</span><span class="method-args">()</span>
381
+
382
+ </a>
383
+
384
+ </div>
385
+
386
+ <div class="method-description">
387
+
388
+ <p>
389
+ Returns true of the pattern is empty.
390
+ </p>
391
+
392
+ <p><a class="source-toggle" href="#"
393
+ onclick="toggleCode('M000470-source');return false;">[Source]</a></p>
394
+ <div class="method-source-code" id="M000470-source">
395
+ <pre>
396
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 113</span>
397
+ 113: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty?</span>
398
+ 114: <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">empty?</span>
399
+ 115: <span class="ruby-keyword kw">end</span>
400
+ </pre>
401
+ </div>
402
+
403
+ </div>
404
+ </div>
405
+
406
+
407
+ <div id="method-M000471" class="method-detail">
408
+ <a name="M000471"></a>
409
+
410
+ <div class="method-heading">
411
+
412
+ <a href="#M000471" class="method-signature">
413
+
414
+ <span class="method-name">length</span><span class="method-args">()</span>
415
+
416
+ </a>
417
+
418
+ </div>
419
+
420
+ <div class="method-description">
421
+
422
+ <p>
423
+ Returns the number of tokens in the pattern.
424
+ </p>
425
+
426
+ <p><a class="source-toggle" href="#"
427
+ onclick="toggleCode('M000471-source');return false;">[Source]</a></p>
428
+ <div class="method-source-code" id="M000471-source">
429
+ <pre>
430
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 118</span>
431
+ 118: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">length</span>
432
+ 119: <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">length</span>
433
+ 120: <span class="ruby-keyword kw">end</span>
434
+ </pre>
435
+ </div>
436
+
437
+ </div>
438
+ </div>
439
+
440
+
441
+ <div id="method-M000472" class="method-detail">
442
+ <a name="M000472"></a>
443
+
444
+ <div class="method-heading">
445
+
446
+ <a href="#M000472" class="method-signature">
447
+
448
+ <span class="method-name">optional?</span><span class="method-args">(rules)</span>
449
+
450
+ </a>
451
+
452
+ </div>
453
+
454
+ <div class="method-description">
455
+
456
+ <p>
457
+ Return true if all tokens of the pattern are optional. If a token
458
+ references a rule, this rule is followed for the check.
459
+ </p>
460
+
461
+ <p><a class="source-toggle" href="#"
462
+ onclick="toggleCode('M000472-source');return false;">[Source]</a></p>
463
+ <div class="method-source-code" id="M000472-source">
464
+ <pre>
465
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 124</span>
466
+ 124: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
467
+ 125: <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">token</span><span class="ruby-operator">|</span>
468
+ 126: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">token</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?_</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">token</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?$</span>
469
+ 127: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
470
+ 128: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">token</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?!</span>
471
+ 129: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">token</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
472
+ 130: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">optional?</span>(<span class="ruby-identifier">rules</span>)
473
+ 131: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span>
474
+ 132: <span class="ruby-keyword kw">end</span>
475
+ 133: <span class="ruby-keyword kw">end</span>
476
+ 134: <span class="ruby-keyword kw">end</span>
477
+ 135: <span class="ruby-keyword kw">true</span>
478
+ 136: <span class="ruby-keyword kw">end</span>
479
+ </pre>
480
+ </div>
481
+
482
+ </div>
483
+ </div>
484
+
485
+
486
+ <div id="method-M000464" class="method-detail">
487
+ <a name="M000464"></a>
488
+
489
+ <div class="method-heading">
490
+
491
+ <a href="#M000464" class="method-signature">
492
+
493
+ <span class="method-name">setArg</span><span class="method-args">(idx, doc)</span>
494
+
495
+ </a>
496
+
497
+ </div>
498
+
499
+ <div class="method-description">
500
+
501
+ <p>
502
+ Set the documentation text and for the idx-th variable.
503
+ </p>
504
+
505
+ <p><a class="source-toggle" href="#"
506
+ onclick="toggleCode('M000464-source');return false;">[Source]</a></p>
507
+ <div class="method-source-code" id="M000464-source">
508
+ <pre>
509
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 82</span>
510
+ 82: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setArg</span>(<span class="ruby-identifier">idx</span>, <span class="ruby-identifier">doc</span>)
511
+ 83: <span class="ruby-ivar">@args</span>[<span class="ruby-identifier">idx</span>] = <span class="ruby-identifier">doc</span>
512
+ 84: <span class="ruby-keyword kw">end</span>
513
+ </pre>
514
+ </div>
515
+
516
+ </div>
517
+ </div>
518
+
519
+
520
+ <div id="method-M000463" class="method-detail">
521
+ <a name="M000463"></a>
522
+
523
+ <div class="method-heading">
524
+
525
+ <a href="#M000463" class="method-signature">
526
+
527
+ <span class="method-name">setDoc</span><span class="method-args">(keyword, doc)</span>
528
+
529
+ </a>
530
+
531
+ </div>
532
+
533
+ <div class="method-description">
534
+
535
+ <p>
536
+ Set the keyword and documentation text for the pattern.
537
+ </p>
538
+
539
+ <p><a class="source-toggle" href="#"
540
+ onclick="toggleCode('M000463-source');return false;">[Source]</a></p>
541
+ <div class="method-source-code" id="M000463-source">
542
+ <pre>
543
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 76</span>
544
+ 76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setDoc</span>(<span class="ruby-identifier">keyword</span>, <span class="ruby-identifier">doc</span>)
545
+ 77: <span class="ruby-ivar">@keyword</span> = <span class="ruby-identifier">keyword</span>
546
+ 78: <span class="ruby-ivar">@doc</span> = <span class="ruby-identifier">doc</span>
547
+ 79: <span class="ruby-keyword kw">end</span>
548
+ </pre>
549
+ </div>
550
+
551
+ </div>
552
+ </div>
553
+
554
+
555
+ <div id="method-M000467" class="method-detail">
556
+ <a name="M000467"></a>
557
+
558
+ <div class="method-heading">
559
+
560
+ <a href="#M000467" class="method-signature">
561
+
562
+ <span class="method-name">setExample</span><span class="method-args">(file, tag)</span>
563
+
564
+ </a>
565
+
566
+ </div>
567
+
568
+ <div class="method-description">
569
+
570
+ <p>
571
+ Set the file and tag for the TJP code example.
572
+ </p>
573
+
574
+ <p><a class="source-toggle" href="#"
575
+ onclick="toggleCode('M000467-source');return false;">[Source]</a></p>
576
+ <div class="method-source-code" id="M000467-source">
577
+ <pre>
578
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 97</span>
579
+ 97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setExample</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">tag</span>)
580
+ 98: <span class="ruby-ivar">@exampleFile</span> = <span class="ruby-identifier">file</span>
581
+ 99: <span class="ruby-ivar">@exampleTag</span> = <span class="ruby-identifier">tag</span>
582
+ 100: <span class="ruby-keyword kw">end</span>
583
+ </pre>
584
+ </div>
585
+
586
+ </div>
587
+ </div>
588
+
589
+
590
+ <div id="method-M000465" class="method-detail">
591
+ <a name="M000465"></a>
592
+
593
+ <div class="method-heading">
594
+
595
+ <a href="#M000465" class="method-signature">
596
+
597
+ <span class="method-name">setLastSyntaxToken</span><span class="method-args">(idx)</span>
598
+
599
+ </a>
600
+
601
+ </div>
602
+
603
+ <div class="method-description">
604
+
605
+ <p>
606
+ Restrict the syntax documentation to the first <tt>idx</tt> tokens.
607
+ </p>
608
+
609
+ <p><a class="source-toggle" href="#"
610
+ onclick="toggleCode('M000465-source');return false;">[Source]</a></p>
611
+ <div class="method-source-code" id="M000465-source">
612
+ <pre>
613
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 87</span>
614
+ 87: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setLastSyntaxToken</span>(<span class="ruby-identifier">idx</span>)
615
+ 88: <span class="ruby-ivar">@lastSyntaxToken</span> = <span class="ruby-identifier">idx</span>
616
+ 89: <span class="ruby-keyword kw">end</span>
617
+ </pre>
618
+ </div>
619
+
620
+ </div>
621
+ </div>
622
+
623
+
624
+ <div id="method-M000466" class="method-detail">
625
+ <a name="M000466"></a>
626
+
627
+ <div class="method-heading">
628
+
629
+ <a href="#M000466" class="method-signature">
630
+
631
+ <span class="method-name">setSeeAlso</span><span class="method-args">(also)</span>
632
+
633
+ </a>
634
+
635
+ </div>
636
+
637
+ <div class="method-description">
638
+
639
+ <p>
640
+ Set the references to related patterns.
641
+ </p>
642
+
643
+ <p><a class="source-toggle" href="#"
644
+ onclick="toggleCode('M000466-source');return false;">[Source]</a></p>
645
+ <div class="method-source-code" id="M000466-source">
646
+ <pre>
647
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 92</span>
648
+ 92: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setSeeAlso</span>(<span class="ruby-identifier">also</span>)
649
+ 93: <span class="ruby-ivar">@seeAlso</span> = <span class="ruby-identifier">also</span>
650
+ 94: <span class="ruby-keyword kw">end</span>
651
+ </pre>
652
+ </div>
653
+
654
+ </div>
655
+ </div>
656
+
657
+
658
+ <div id="method-M000473" class="method-detail">
659
+ <a name="M000473"></a>
660
+
661
+ <div class="method-heading">
662
+
663
+ <a href="#M000473" class="method-signature">
664
+
665
+ <span class="method-name">terminalSymbol?</span><span class="method-args">(i)</span>
666
+
667
+ </a>
668
+
669
+ </div>
670
+
671
+ <div class="method-description">
672
+
673
+ <p>
674
+ Returns true if the i-th token is a terminal symbol.
675
+ </p>
676
+
677
+ <p><a class="source-toggle" href="#"
678
+ onclick="toggleCode('M000473-source');return false;">[Source]</a></p>
679
+ <div class="method-source-code" id="M000473-source">
680
+ <pre>
681
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 139</span>
682
+ 139: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">terminalSymbol?</span>(<span class="ruby-identifier">i</span>)
683
+ 140: <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">i</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?$</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">i</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?_</span>
684
+ 141: <span class="ruby-keyword kw">end</span>
685
+ </pre>
686
+ </div>
687
+
688
+ </div>
689
+ </div>
690
+
691
+
692
+ <div id="method-M000474" class="method-detail">
693
+ <a name="M000474"></a>
694
+
695
+ <div class="method-heading">
696
+
697
+ <a href="#M000474" class="method-signature">
698
+
699
+ <span class="method-name">terminalToken</span><span class="method-args">(rules, index = 0)</span>
700
+
701
+ </a>
702
+
703
+ </div>
704
+
705
+ <div class="method-description">
706
+
707
+ <p>
708
+ Find recursively the first terminal token of this pattern. If an index is
709
+ specified start the search at this n-th pattern token instead of the first.
710
+ The return value is either nil or a [ token, pattern ] tuple.
711
+ </p>
712
+
713
+ <p><a class="source-toggle" href="#"
714
+ onclick="toggleCode('M000474-source');return false;">[Source]</a></p>
715
+ <div class="method-source-code" id="M000474-source">
716
+ <pre>
717
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 146</span>
718
+ 146: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">terminalToken</span>(<span class="ruby-identifier">rules</span>, <span class="ruby-identifier">index</span> = <span class="ruby-value">0</span>)
719
+ 147: <span class="ruby-comment cmt"># Terminal token start with an underscore or dollar character.</span>
720
+ 148: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?_</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?$</span>
721
+ 149: <span class="ruby-keyword kw">return</span> [ <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>].<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>), <span class="ruby-keyword kw">self</span> ]
722
+ 150: <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?!</span>
723
+ 151: <span class="ruby-comment cmt"># Token starting with a bang reference another rule. We have to continue</span>
724
+ 152: <span class="ruby-comment cmt"># the search at this rule. First, we get rid of the bang to get the rule</span>
725
+ 153: <span class="ruby-comment cmt"># name.</span>
726
+ 154: <span class="ruby-identifier">token</span> = <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>].<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">index</span>].<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
727
+ 155: <span class="ruby-comment cmt"># Then find the rule</span>
728
+ 156: <span class="ruby-identifier">rule</span> = <span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>]
729
+ 157: <span class="ruby-comment cmt"># The rule may only have a single pattern. If not, then this pattern has</span>
730
+ 158: <span class="ruby-comment cmt"># no terminal token.</span>
731
+ 159: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">!=</span> <span class="ruby-value">1</span>
732
+ 160: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">rule</span>.<span class="ruby-identifier">patterns</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">terminalToken</span>(<span class="ruby-identifier">rules</span>)
733
+ 161: <span class="ruby-keyword kw">end</span>
734
+ 162: <span class="ruby-keyword kw">nil</span>
735
+ 163: <span class="ruby-keyword kw">end</span>
736
+ </pre>
737
+ </div>
738
+
739
+ </div>
740
+ </div>
741
+
742
+
743
+ <div id="method-M000477" class="method-detail">
744
+ <a name="M000477"></a>
745
+
746
+ <div class="method-heading">
747
+
748
+ <a href="#M000477" class="method-signature">
749
+
750
+ <span class="method-name">to_s</span><span class="method-args">()</span>
751
+
752
+ </a>
753
+
754
+ </div>
755
+
756
+ <div class="method-description">
757
+
758
+ <p><a class="source-toggle" href="#"
759
+ onclick="toggleCode('M000477-source');return false;">[Source]</a></p>
760
+ <div class="method-source-code" id="M000477-source">
761
+ <pre>
762
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 247</span>
763
+ 247: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
764
+ 248: <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">' '</span>)
765
+ 249: <span class="ruby-keyword kw">end</span>
766
+ </pre>
767
+ </div>
768
+
769
+ </div>
770
+ </div>
771
+
772
+
773
+ <div id="method-M000475" class="method-detail">
774
+ <a name="M000475"></a>
775
+
776
+ <div class="method-heading">
777
+
778
+ <a href="#M000475" class="method-signature">
779
+
780
+ <span class="method-name">to_syntax</span><span class="method-args">(argDocs, rules, skip = 0)</span>
781
+
782
+ </a>
783
+
784
+ </div>
785
+
786
+ <div class="method-description">
787
+
788
+ <p>
789
+ Returns a string that expresses the elements of the pattern in an EBNF like
790
+ fashion. The resolution of the pattern is done recursively. This is just
791
+ the wrapper function that sets up the stack.
792
+ </p>
793
+
794
+ <p><a class="source-toggle" href="#"
795
+ onclick="toggleCode('M000475-source');return false;">[Source]</a></p>
796
+ <div class="method-source-code" id="M000475-source">
797
+ <pre>
798
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 168</span>
799
+ 168: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_syntax</span>(<span class="ruby-identifier">argDocs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span> = <span class="ruby-value">0</span>)
800
+ 169: <span class="ruby-identifier">to_syntax_r</span>({}, <span class="ruby-identifier">argDocs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
801
+ 170: <span class="ruby-keyword kw">end</span>
802
+ </pre>
803
+ </div>
804
+
805
+ </div>
806
+ </div>
807
+
808
+
809
+ <div id="method-M000476" class="method-detail">
810
+ <a name="M000476"></a>
811
+
812
+ <div class="method-heading">
813
+
814
+ <a href="#M000476" class="method-signature">
815
+
816
+ <span class="method-name">to_syntax_r</span><span class="method-args">(stack, argDocs, rules, skip)</span>
817
+
818
+ </a>
819
+
820
+ </div>
821
+
822
+ <div class="method-description">
823
+
824
+ <p><a class="source-toggle" href="#"
825
+ onclick="toggleCode('M000476-source');return false;">[Source]</a></p>
826
+ <div class="method-source-code" id="M000476-source">
827
+ <pre>
828
+ <span class="ruby-comment cmt"># File lib/TextParser/Pattern.rb, line 172</span>
829
+ 172: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_syntax_r</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">argDocs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-identifier">skip</span>)
830
+ 173: <span class="ruby-comment cmt"># If we find ourself on the stack we hit a recursive pattern. This is used</span>
831
+ 174: <span class="ruby-comment cmt"># in repetitions.</span>
832
+ 175: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">stack</span>[<span class="ruby-keyword kw">self</span>]
833
+ 176: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">'[, ... ]'</span>
834
+ 177: <span class="ruby-keyword kw">end</span>
835
+ 178:
836
+ 179: <span class="ruby-comment cmt"># &quot;Push&quot; us on the stack.</span>
837
+ 180: <span class="ruby-identifier">stack</span>[<span class="ruby-keyword kw">self</span>] = <span class="ruby-keyword kw">true</span>
838
+ 181:
839
+ 182: <span class="ruby-identifier">str</span> = <span class="ruby-value str">''</span>
840
+ 183: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">true</span>
841
+ 184: <span class="ruby-comment cmt"># Analyze the tokens of the pattern skipping the first 'skip' tokens.</span>
842
+ 185: <span class="ruby-identifier">skip</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-ivar">@lastSyntaxToken</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
843
+ 186: <span class="ruby-identifier">token</span> = <span class="ruby-ivar">@tokens</span>[<span class="ruby-identifier">i</span>]
844
+ 187: <span class="ruby-comment cmt"># If the first token is a _{ the pattern describes optional attributes.</span>
845
+ 188: <span class="ruby-comment cmt"># They are represented by a standard idiom.</span>
846
+ 189: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">first</span>
847
+ 190: <span class="ruby-identifier">first</span> = <span class="ruby-keyword kw">false</span>
848
+ 191: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">'{ &lt;attributes&gt; }'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">token</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'_{'</span>
849
+ 192: <span class="ruby-keyword kw">else</span>
850
+ 193: <span class="ruby-comment cmt"># Separate the syntax elemens by a whitespace.</span>
851
+ 194: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">' '</span>
852
+ 195: <span class="ruby-keyword kw">end</span>
853
+ 196:
854
+ 197: <span class="ruby-identifier">typeId</span> = <span class="ruby-identifier">token</span>[<span class="ruby-value">0</span>]
855
+ 198: <span class="ruby-identifier">token</span> = <span class="ruby-identifier">token</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">token</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
856
+ 199:
857
+ 200: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>[<span class="ruby-identifier">i</span>]
858
+ 201: <span class="ruby-comment cmt"># The argument is documented in the syntax definition. We copy the</span>
859
+ 202: <span class="ruby-comment cmt"># entry as we need to modify it.</span>
860
+ 203: <span class="ruby-identifier">argDoc</span> = <span class="ruby-ivar">@args</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">clone</span>
861
+ 204:
862
+ 205: <span class="ruby-comment cmt"># A documented argument without a name is a terminal token. We use the</span>
863
+ 206: <span class="ruby-comment cmt"># terminal symbol as name.</span>
864
+ 207: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@args</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span>
865
+ 208: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{token}&quot;</span>
866
+ 209: <span class="ruby-identifier">argDoc</span>.<span class="ruby-identifier">name</span> = <span class="ruby-identifier">token</span>
867
+ 210: <span class="ruby-keyword kw">else</span>
868
+ 211: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;&lt;#{@args[i].name}&gt;&quot;</span>
869
+ 212: <span class="ruby-keyword kw">end</span>
870
+ 213: <span class="ruby-identifier">addArgDoc</span>(<span class="ruby-identifier">argDocs</span>, <span class="ruby-identifier">argDoc</span>)
871
+ 214:
872
+ 215: <span class="ruby-comment cmt"># Documented arguments don't have the type set yet. Use the token</span>
873
+ 216: <span class="ruby-comment cmt"># value for that.</span>
874
+ 217: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">typeId</span> <span class="ruby-operator">==</span> <span class="ruby-value">?$</span>
875
+ 218: <span class="ruby-identifier">argDoc</span>.<span class="ruby-identifier">typeSpec</span> = <span class="ruby-node">&quot;&lt;#{token}&gt;&quot;</span>
876
+ 219: <span class="ruby-keyword kw">end</span>
877
+ 220: <span class="ruby-keyword kw">else</span>
878
+ 221: <span class="ruby-comment cmt"># Undocumented tokens are recursively expanded.</span>
879
+ 222: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">typeId</span>
880
+ 223: <span class="ruby-keyword kw">when</span> <span class="ruby-value">?_</span>
881
+ 224: <span class="ruby-comment cmt"># Literals are shown as such.</span>
882
+ 225: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">token</span>
883
+ 226: <span class="ruby-keyword kw">when</span> <span class="ruby-value">?$</span>
884
+ 227: <span class="ruby-comment cmt"># Variables are enclosed by angle brackets.</span>
885
+ 228: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'&lt;'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">token</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'&gt;'</span>
886
+ 229: <span class="ruby-keyword kw">when</span> <span class="ruby-value">?!</span>
887
+ 230: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">patterns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">&amp;&amp;</span>
888
+ 231: <span class="ruby-operator">!</span><span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">patterns</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">nil?</span>
889
+ 232: <span class="ruby-identifier">addArgDoc</span>(<span class="ruby-identifier">argDocs</span>, <span class="ruby-constant">TokenDoc</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">patterns</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">keyword</span>,
890
+ 233: <span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">patterns</span>[<span class="ruby-value">0</span>]))
891
+ 234: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'&lt;'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">patterns</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">keyword</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'&gt;'</span>
892
+ 235: <span class="ruby-keyword kw">else</span>
893
+ 236: <span class="ruby-comment cmt"># References are followed recursively.</span>
894
+ 237: <span class="ruby-identifier">str</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">rules</span>[<span class="ruby-identifier">token</span>].<span class="ruby-identifier">to_syntax</span>(<span class="ruby-identifier">stack</span>, <span class="ruby-identifier">argDocs</span>, <span class="ruby-identifier">rules</span>, <span class="ruby-value">0</span>)
895
+ 238: <span class="ruby-keyword kw">end</span>
896
+ 239: <span class="ruby-keyword kw">end</span>
897
+ 240: <span class="ruby-keyword kw">end</span>
898
+ 241: <span class="ruby-keyword kw">end</span>
899
+ 242: <span class="ruby-comment cmt"># Remove us from the &quot;stack&quot; again.</span>
900
+ 243: <span class="ruby-identifier">stack</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword kw">self</span>)
901
+ 244: <span class="ruby-identifier">str</span>
902
+ 245: <span class="ruby-keyword kw">end</span>
903
+ </pre>
904
+ </div>
905
+
906
+ </div>
907
+ </div>
908
+
909
+
910
+
911
+ </div>
912
+
913
+
914
+
915
+
916
+ </div>
917
+
918
+ <div id="validator-badges">
919
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
920
+ </div>
921
+
922
+ </body>
923
+ </html>