reference.html

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   5 <head>\r
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
   7 <meta name="generator" content="AsciiDoc 8.6.10" />\r
   8 <title>RRQFORTH Reference Documentation</title>\r
   9 <style type="text/css">\r
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
  11 \r
  12 /* Default font. */\r
  13 body {\r
  14   font-family: Georgia,serif;\r
  15 }\r
  16 \r
  17 /* Title font. */\r
  18 h1, h2, h3, h4, h5, h6,\r
  19 div.title, caption.title,\r
  20 thead, p.table.header,\r
  21 #toctitle,\r
  22 #author, #revnumber, #revdate, #revremark,\r
  23 #footer {\r
  24   font-family: Arial,Helvetica,sans-serif;\r
  25 }\r
  26 \r
  27 body {\r
  28   margin: 1em 5% 1em 5%;\r
  29 }\r
  30 \r
  31 a {\r
  32   color: blue;\r
  33   text-decoration: underline;\r
  34 }\r
  35 a:visited {\r
  36   color: fuchsia;\r
  37 }\r
  38 \r
  39 em {\r
  40   font-style: italic;\r
  41   color: navy;\r
  42 }\r
  43 \r
  44 strong {\r
  45   font-weight: bold;\r
  46   color: #083194;\r
  47 }\r
  48 \r
  49 h1, h2, h3, h4, h5, h6 {\r
  50   color: #527bbd;\r
  51   margin-top: 1.2em;\r
  52   margin-bottom: 0.5em;\r
  53   line-height: 1.3;\r
  54 }\r
  55 \r
  56 h1, h2, h3 {\r
  57   border-bottom: 2px solid silver;\r
  58 }\r
  59 h2 {\r
  60   padding-top: 0.5em;\r
  61 }\r
  62 h3 {\r
  63   float: left;\r
  64 }\r
  65 h3 + * {\r
  66   clear: left;\r
  67 }\r
  68 h5 {\r
  69   font-size: 1.0em;\r
  70 }\r
  71 \r
  72 div.sectionbody {\r
  73   margin-left: 0;\r
  74 }\r
  75 \r
  76 hr {\r
  77   border: 1px solid silver;\r
  78 }\r
  79 \r
  80 p {\r
  81   margin-top: 0.5em;\r
  82   margin-bottom: 0.5em;\r
  83 }\r
  84 \r
  85 ul, ol, li > p {\r
  86   margin-top: 0;\r
  87 }\r
  88 ul > li     { color: #aaa; }\r
  89 ul > li > * { color: black; }\r
  90 \r
  91 .monospaced, code, pre {\r
  92   font-family: "Courier New", Courier, monospace;\r
  93   font-size: inherit;\r
  94   color: navy;\r
  95   padding: 0;\r
  96   margin: 0;\r
  97 }\r
  98 pre {\r
  99   white-space: pre-wrap;\r
 100 }\r
 101 \r
 102 #author {\r
 103   color: #527bbd;\r
 104   font-weight: bold;\r
 105   font-size: 1.1em;\r
 106 }\r
 107 #email {\r
 108 }\r
 109 #revnumber, #revdate, #revremark {\r
 110 }\r
 111 \r
 112 #footer {\r
 113   font-size: small;\r
 114   border-top: 2px solid silver;\r
 115   padding-top: 0.5em;\r
 116   margin-top: 4.0em;\r
 117 }\r
 118 #footer-text {\r
 119   float: left;\r
 120   padding-bottom: 0.5em;\r
 121 }\r
 122 #footer-badges {\r
 123   float: right;\r
 124   padding-bottom: 0.5em;\r
 125 }\r
 126 \r
 127 #preamble {\r
 128   margin-top: 1.5em;\r
 129   margin-bottom: 1.5em;\r
 130 }\r
 131 div.imageblock, div.exampleblock, div.verseblock,\r
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 133 div.admonitionblock {\r
 134   margin-top: 1.0em;\r
 135   margin-bottom: 1.5em;\r
 136 }\r
 137 div.admonitionblock {\r
 138   margin-top: 2.0em;\r
 139   margin-bottom: 2.0em;\r
 140   margin-right: 10%;\r
 141   color: #606060;\r
 142 }\r
 143 \r
 144 div.content { /* Block element content. */\r
 145   padding: 0;\r
 146 }\r
 147 \r
 148 /* Block element titles. */\r
 149 div.title, caption.title {\r
 150   color: #527bbd;\r
 151   font-weight: bold;\r
 152   text-align: left;\r
 153   margin-top: 1.0em;\r
 154   margin-bottom: 0.5em;\r
 155 }\r
 156 div.title + * {\r
 157   margin-top: 0;\r
 158 }\r
 159 \r
 160 td div.title:first-child {\r
 161   margin-top: 0.0em;\r
 162 }\r
 163 div.content div.title:first-child {\r
 164   margin-top: 0.0em;\r
 165 }\r
 166 div.content + div.title {\r
 167   margin-top: 0.0em;\r
 168 }\r
 169 \r
 170 div.sidebarblock > div.content {\r
 171   background: #ffffee;\r
 172   border: 1px solid #dddddd;\r
 173   border-left: 4px solid #f0f0f0;\r
 174   padding: 0.5em;\r
 175 }\r
 176 \r
 177 div.listingblock > div.content {\r
 178   border: 1px solid #dddddd;\r
 179   border-left: 5px solid #f0f0f0;\r
 180   background: #f8f8f8;\r
 181   padding: 0.5em;\r
 182 }\r
 183 \r
 184 div.quoteblock, div.verseblock {\r
 185   padding-left: 1.0em;\r
 186   margin-left: 1.0em;\r
 187   margin-right: 10%;\r
 188   border-left: 5px solid #f0f0f0;\r
 189   color: #888;\r
 190 }\r
 191 \r
 192 div.quoteblock > div.attribution {\r
 193   padding-top: 0.5em;\r
 194   text-align: right;\r
 195 }\r
 196 \r
 197 div.verseblock > pre.content {\r
 198   font-family: inherit;\r
 199   font-size: inherit;\r
 200 }\r
 201 div.verseblock > div.attribution {\r
 202   padding-top: 0.75em;\r
 203   text-align: left;\r
 204 }\r
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
 206 div.verseblock + div.attribution {\r
 207   text-align: left;\r
 208 }\r
 209 \r
 210 div.admonitionblock .icon {\r
 211   vertical-align: top;\r
 212   font-size: 1.1em;\r
 213   font-weight: bold;\r
 214   text-decoration: underline;\r
 215   color: #527bbd;\r
 216   padding-right: 0.5em;\r
 217 }\r
 218 div.admonitionblock td.content {\r
 219   padding-left: 0.5em;\r
 220   border-left: 3px solid #dddddd;\r
 221 }\r
 222 \r
 223 div.exampleblock > div.content {\r
 224   border-left: 3px solid #dddddd;\r
 225   padding-left: 0.5em;\r
 226 }\r
 227 \r
 228 div.imageblock div.content { padding-left: 0; }\r
 229 span.image img { border-style: none; vertical-align: text-bottom; }\r
 230 a.image:visited { color: white; }\r
 231 \r
 232 dl {\r
 233   margin-top: 0.8em;\r
 234   margin-bottom: 0.8em;\r
 235 }\r
 236 dt {\r
 237   margin-top: 0.5em;\r
 238   margin-bottom: 0;\r
 239   font-style: normal;\r
 240   color: navy;\r
 241 }\r
 242 dd > *:first-child {\r
 243   margin-top: 0.1em;\r
 244 }\r
 245 \r
 246 ul, ol {\r
 247     list-style-position: outside;\r
 248 }\r
 249 ol.arabic {\r
 250   list-style-type: decimal;\r
 251 }\r
 252 ol.loweralpha {\r
 253   list-style-type: lower-alpha;\r
 254 }\r
 255 ol.upperalpha {\r
 256   list-style-type: upper-alpha;\r
 257 }\r
 258 ol.lowerroman {\r
 259   list-style-type: lower-roman;\r
 260 }\r
 261 ol.upperroman {\r
 262   list-style-type: upper-roman;\r
 263 }\r
 264 \r
 265 div.compact ul, div.compact ol,\r
 266 div.compact p, div.compact p,\r
 267 div.compact div, div.compact div {\r
 268   margin-top: 0.1em;\r
 269   margin-bottom: 0.1em;\r
 270 }\r
 271 \r
 272 tfoot {\r
 273   font-weight: bold;\r
 274 }\r
 275 td > div.verse {\r
 276   white-space: pre;\r
 277 }\r
 278 \r
 279 div.hdlist {\r
 280   margin-top: 0.8em;\r
 281   margin-bottom: 0.8em;\r
 282 }\r
 283 div.hdlist tr {\r
 284   padding-bottom: 15px;\r
 285 }\r
 286 dt.hdlist1.strong, td.hdlist1.strong {\r
 287   font-weight: bold;\r
 288 }\r
 289 td.hdlist1 {\r
 290   vertical-align: top;\r
 291   font-style: normal;\r
 292   padding-right: 0.8em;\r
 293   color: navy;\r
 294 }\r
 295 td.hdlist2 {\r
 296   vertical-align: top;\r
 297 }\r
 298 div.hdlist.compact tr {\r
 299   margin: 0;\r
 300   padding-bottom: 0;\r
 301 }\r
 302 \r
 303 .comment {\r
 304   background: yellow;\r
 305 }\r
 306 \r
 307 .footnote, .footnoteref {\r
 308   font-size: 0.8em;\r
 309 }\r
 310 \r
 311 span.footnote, span.footnoteref {\r
 312   vertical-align: super;\r
 313 }\r
 314 \r
 315 #footnotes {\r
 316   margin: 20px 0 20px 0;\r
 317   padding: 7px 0 0 0;\r
 318 }\r
 319 \r
 320 #footnotes div.footnote {\r
 321   margin: 0 0 5px 0;\r
 322 }\r
 323 \r
 324 #footnotes hr {\r
 325   border: none;\r
 326   border-top: 1px solid silver;\r
 327   height: 1px;\r
 328   text-align: left;\r
 329   margin-left: 0;\r
 330   width: 20%;\r
 331   min-width: 100px;\r
 332 }\r
 333 \r
 334 div.colist td {\r
 335   padding-right: 0.5em;\r
 336   padding-bottom: 0.3em;\r
 337   vertical-align: top;\r
 338 }\r
 339 div.colist td img {\r
 340   margin-top: 0.3em;\r
 341 }\r
 342 \r
 343 @media print {\r
 344   #footer-badges { display: none; }\r
 345 }\r
 346 \r
 347 #toc {\r
 348   margin-bottom: 2.5em;\r
 349 }\r
 350 \r
 351 #toctitle {\r
 352   color: #527bbd;\r
 353   font-size: 1.1em;\r
 354   font-weight: bold;\r
 355   margin-top: 1.0em;\r
 356   margin-bottom: 0.1em;\r
 357 }\r
 358 \r
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
 360   margin-top: 0;\r
 361   margin-bottom: 0;\r
 362 }\r
 363 div.toclevel2 {\r
 364   margin-left: 2em;\r
 365   font-size: 0.9em;\r
 366 }\r
 367 div.toclevel3 {\r
 368   margin-left: 4em;\r
 369   font-size: 0.9em;\r
 370 }\r
 371 div.toclevel4 {\r
 372   margin-left: 6em;\r
 373   font-size: 0.9em;\r
 374 }\r
 375 \r
 376 span.aqua { color: aqua; }\r
 377 span.black { color: black; }\r
 378 span.blue { color: blue; }\r
 379 span.fuchsia { color: fuchsia; }\r
 380 span.gray { color: gray; }\r
 381 span.green { color: green; }\r
 382 span.lime { color: lime; }\r
 383 span.maroon { color: maroon; }\r
 384 span.navy { color: navy; }\r
 385 span.olive { color: olive; }\r
 386 span.purple { color: purple; }\r
 387 span.red { color: red; }\r
 388 span.silver { color: silver; }\r
 389 span.teal { color: teal; }\r
 390 span.white { color: white; }\r
 391 span.yellow { color: yellow; }\r
 392 \r
 393 span.aqua-background { background: aqua; }\r
 394 span.black-background { background: black; }\r
 395 span.blue-background { background: blue; }\r
 396 span.fuchsia-background { background: fuchsia; }\r
 397 span.gray-background { background: gray; }\r
 398 span.green-background { background: green; }\r
 399 span.lime-background { background: lime; }\r
 400 span.maroon-background { background: maroon; }\r
 401 span.navy-background { background: navy; }\r
 402 span.olive-background { background: olive; }\r
 403 span.purple-background { background: purple; }\r
 404 span.red-background { background: red; }\r
 405 span.silver-background { background: silver; }\r
 406 span.teal-background { background: teal; }\r
 407 span.white-background { background: white; }\r
 408 span.yellow-background { background: yellow; }\r
 409 \r
 410 span.big { font-size: 2em; }\r
 411 span.small { font-size: 0.6em; }\r
 412 \r
 413 span.underline { text-decoration: underline; }\r
 414 span.overline { text-decoration: overline; }\r
 415 span.line-through { text-decoration: line-through; }\r
 416 \r
 417 div.unbreakable { page-break-inside: avoid; }\r
 418 \r
 419 \r
 420 /*\r
 421  * xhtml11 specific\r
 422  *\r
 423  * */\r
 424 \r
 425 div.tableblock {\r
 426   margin-top: 1.0em;\r
 427   margin-bottom: 1.5em;\r
 428 }\r
 429 div.tableblock > table {\r
 430   border: 3px solid #527bbd;\r
 431 }\r
 432 thead, p.table.header {\r
 433   font-weight: bold;\r
 434   color: #527bbd;\r
 435 }\r
 436 p.table {\r
 437   margin-top: 0;\r
 438 }\r
 439 /* Because the table frame attribute is overriden by CSS in most browsers. */\r
 440 div.tableblock > table[frame="void"] {\r
 441   border-style: none;\r
 442 }\r
 443 div.tableblock > table[frame="hsides"] {\r
 444   border-left-style: none;\r
 445   border-right-style: none;\r
 446 }\r
 447 div.tableblock > table[frame="vsides"] {\r
 448   border-top-style: none;\r
 449   border-bottom-style: none;\r
 450 }\r
 451 \r
 452 \r
 453 /*\r
 454  * html5 specific\r
 455  *\r
 456  * */\r
 457 \r
 458 table.tableblock {\r
 459   margin-top: 1.0em;\r
 460   margin-bottom: 1.5em;\r
 461 }\r
 462 thead, p.tableblock.header {\r
 463   font-weight: bold;\r
 464   color: #527bbd;\r
 465 }\r
 466 p.tableblock {\r
 467   margin-top: 0;\r
 468 }\r
 469 table.tableblock {\r
 470   border-width: 3px;\r
 471   border-spacing: 0px;\r
 472   border-style: solid;\r
 473   border-color: #527bbd;\r
 474   border-collapse: collapse;\r
 475 }\r
 476 th.tableblock, td.tableblock {\r
 477   border-width: 1px;\r
 478   padding: 4px;\r
 479   border-style: solid;\r
 480   border-color: #527bbd;\r
 481 }\r
 482 \r
 483 table.tableblock.frame-topbot {\r
 484   border-left-style: hidden;\r
 485   border-right-style: hidden;\r
 486 }\r
 487 table.tableblock.frame-sides {\r
 488   border-top-style: hidden;\r
 489   border-bottom-style: hidden;\r
 490 }\r
 491 table.tableblock.frame-none {\r
 492   border-style: hidden;\r
 493 }\r
 494 \r
 495 th.tableblock.halign-left, td.tableblock.halign-left {\r
 496   text-align: left;\r
 497 }\r
 498 th.tableblock.halign-center, td.tableblock.halign-center {\r
 499   text-align: center;\r
 500 }\r
 501 th.tableblock.halign-right, td.tableblock.halign-right {\r
 502   text-align: right;\r
 503 }\r
 504 \r
 505 th.tableblock.valign-top, td.tableblock.valign-top {\r
 506   vertical-align: top;\r
 507 }\r
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {\r
 509   vertical-align: middle;\r
 510 }\r
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {\r
 512   vertical-align: bottom;\r
 513 }\r
 514 \r
 515 \r
 516 /*\r
 517  * manpage specific\r
 518  *\r
 519  * */\r
 520 \r
 521 body.manpage h1 {\r
 522   padding-top: 0.5em;\r
 523   padding-bottom: 0.5em;\r
 524   border-top: 2px solid silver;\r
 525   border-bottom: 2px solid silver;\r
 526 }\r
 527 body.manpage h2 {\r
 528   border-style: none;\r
 529 }\r
 530 body.manpage div.sectionbody {\r
 531   margin-left: 3em;\r
 532 }\r
 533 \r
 534 @media print {\r
 535   body.manpage div#toc { display: none; }\r
 536 }\r
 537 \r
 538 \r
 539 </style>\r
 540 <script type="text/javascript">\r
 541 /*<![CDATA[*/\r
 542 var asciidoc = {  // Namespace.\r
 543 \r
 544 /////////////////////////////////////////////////////////////////////\r
 545 // Table Of Contents generator\r
 546 /////////////////////////////////////////////////////////////////////\r
 547 \r
 548 /* Author: Mihai Bazon, September 2002\r
 549  * http://students.infoiasi.ro/~mishoo\r
 550  *\r
 551  * Table Of Content generator\r
 552  * Version: 0.4\r
 553  *\r
 554  * Feel free to use this script under the terms of the GNU General Public\r
 555  * License, as long as you do not remove or alter this notice.\r
 556  */\r
 557 \r
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */\r
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */\r
 560 \r
 561 // toclevels = 1..4.\r
 562 toc: function (toclevels) {\r
 563 \r
 564   function getText(el) {\r
 565     var text = "";\r
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.\r
 568         text += i.data;\r
 569       else if (i.firstChild != null)\r
 570         text += getText(i);\r
 571     }\r
 572     return text;\r
 573   }\r
 574 \r
 575   function TocEntry(el, text, toclevel) {\r
 576     this.element = el;\r
 577     this.text = text;\r
 578     this.toclevel = toclevel;\r
 579   }\r
 580 \r
 581   function tocEntries(el, toclevels) {\r
 582     var result = new Array;\r
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');\r
 584     // Function that scans the DOM tree for header elements (the DOM2\r
 585     // nodeIterator API would be a better technique but not supported by all\r
 586     // browsers).\r
 587     var iterate = function (el) {\r
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
 590           var mo = re.exec(i.tagName);\r
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
 593           }\r
 594           iterate(i);\r
 595         }\r
 596       }\r
 597     }\r
 598     iterate(el);\r
 599     return result;\r
 600   }\r
 601 \r
 602   var toc = document.getElementById("toc");\r
 603   if (!toc) {\r
 604     return;\r
 605   }\r
 606 \r
 607   // Delete existing TOC entries in case we're reloading the TOC.\r
 608   var tocEntriesToRemove = [];\r
 609   var i;\r
 610   for (i = 0; i < toc.childNodes.length; i++) {\r
 611     var entry = toc.childNodes[i];\r
 612     if (entry.nodeName.toLowerCase() == 'div'\r
 613      && entry.getAttribute("class")\r
 614      && entry.getAttribute("class").match(/^toclevel/))\r
 615       tocEntriesToRemove.push(entry);\r
 616   }\r
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {\r
 618     toc.removeChild(tocEntriesToRemove[i]);\r
 619   }\r
 620 \r
 621   // Rebuild TOC entries.\r
 622   var entries = tocEntries(document.getElementById("content"), toclevels);\r
 623   for (var i = 0; i < entries.length; ++i) {\r
 624     var entry = entries[i];\r
 625     if (entry.element.id == "")\r
 626       entry.element.id = "_toc_" + i;\r
 627     var a = document.createElement("a");\r
 628     a.href = "#" + entry.element.id;\r
 629     a.appendChild(document.createTextNode(entry.text));\r
 630     var div = document.createElement("div");\r
 631     div.appendChild(a);\r
 632     div.className = "toclevel" + entry.toclevel;\r
 633     toc.appendChild(div);\r
 634   }\r
 635   if (entries.length == 0)\r
 636     toc.parentNode.removeChild(toc);\r
 637 },\r
 638 \r
 639 \r
 640 /////////////////////////////////////////////////////////////////////\r
 641 // Footnotes generator\r
 642 /////////////////////////////////////////////////////////////////////\r
 643 \r
 644 /* Based on footnote generation code from:\r
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
 646  */\r
 647 \r
 648 footnotes: function () {\r
 649   // Delete existing footnote entries in case we're reloading the footnodes.\r
 650   var i;\r
 651   var noteholder = document.getElementById("footnotes");\r
 652   if (!noteholder) {\r
 653     return;\r
 654   }\r
 655   var entriesToRemove = [];\r
 656   for (i = 0; i < noteholder.childNodes.length; i++) {\r
 657     var entry = noteholder.childNodes[i];\r
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")\r
 659       entriesToRemove.push(entry);\r
 660   }\r
 661   for (i = 0; i < entriesToRemove.length; i++) {\r
 662     noteholder.removeChild(entriesToRemove[i]);\r
 663   }\r
 664 \r
 665   // Rebuild footnote entries.\r
 666   var cont = document.getElementById("content");\r
 667   var spans = cont.getElementsByTagName("span");\r
 668   var refs = {};\r
 669   var n = 0;\r
 670   for (i=0; i<spans.length; i++) {\r
 671     if (spans[i].className == "footnote") {\r
 672       n++;\r
 673       var note = spans[i].getAttribute("data-note");\r
 674       if (!note) {\r
 675         // Use [\s\S] in place of . so multi-line matches work.\r
 676         // Because JavaScript has no s (dotall) regex flag.\r
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
 678         spans[i].innerHTML =\r
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
 681         spans[i].setAttribute("data-note", note);\r
 682       }\r
 683       noteholder.innerHTML +=\r
 684         "<div class='footnote' id='_footnote_" + n + "'>" +\r
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
 686         n + "</a>. " + note + "</div>";\r
 687       var id =spans[i].getAttribute("id");\r
 688       if (id != null) refs["#"+id] = n;\r
 689     }\r
 690   }\r
 691   if (n == 0)\r
 692     noteholder.parentNode.removeChild(noteholder);\r
 693   else {\r
 694     // Process footnoterefs.\r
 695     for (i=0; i<spans.length; i++) {\r
 696       if (spans[i].className == "footnoteref") {\r
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.\r
 699         n = refs[href];\r
 700         spans[i].innerHTML =\r
 701           "[<a href='#_footnote_" + n +\r
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";\r
 703       }\r
 704     }\r
 705   }\r
 706 },\r
 707 \r
 708 install: function(toclevels) {\r
 709   var timerId;\r
 710 \r
 711   function reinstall() {\r
 712     asciidoc.footnotes();\r
 713     if (toclevels) {\r
 714       asciidoc.toc(toclevels);\r
 715     }\r
 716   }\r
 717 \r
 718   function reinstallAndRemoveTimer() {\r
 719     clearInterval(timerId);\r
 720     reinstall();\r
 721   }\r
 722 \r
 723   timerId = setInterval(reinstall, 500);\r
 724   if (document.addEventListener)\r
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);\r
 726   else\r
 727     window.onload = reinstallAndRemoveTimer;\r
 728 }\r
 729 \r
 730 }\r
 731 asciidoc.install();\r
 732 /*]]>*/\r
 733 </script>\r
 734 </head>\r
 735 <body class="article">\r
 736 <div id="header">\r
 737 <h1>RRQFORTH Reference Documentation</h1>\r
 738 <span id="author">Ralph Ronnquist &lt;ralph.ronnquist@gmail.com&gt;</span><br />\r
 739 </div>\r
 740 <div id="content">\r
 741 <div class="sect1">\r
 742 <h2 id="_word_index">Word Index</h2>\r
 743 <div class="sectionbody">\r
 744 <div class="paragraph"><p><a href="#p_lparen">( (left parenthesis)</a> &#160;\r
 745 <a href="#p_colon">: (colon)</a> &#160;\r
 746 <a href="#p_semicolon">: (semi-colon)</a> &#160;\r
 747 <a href="#p_comma">, (comma)</a> &#160;\r
 748 <a href="#p_dot">. (dot)</a> &#160;\r
 749 <a href="#p_double_quote">" (double-quote)</a> &#160;\r
 750 <a href="#p_quote">' (single-quote)</a> &#160;\r
 751 <a href="#p_left_bracket">[ (left bracket)</a> &#160;\r
 752 <a href="#p_right_bracket">] (right bracket)</a> &#160;</p></div>\r
 753 <div class="paragraph"><p><a href="#p_lessthan">&lt;</a> &#160;\r
 754 <a href="#p_lessequal">&lt;=</a> &#160;\r
 755 <a href="#p_equal">=</a> &#160;\r
 756 <a href="#p_unequal">!=</a> &#160;\r
 757 <a href="#p_greaterthan">&gt;</a> &#160;\r
 758 <a href="#p_greaterequal">&gt;= </a> &#160;\r
 759 <a href="#p_0equal">0=</a> &#160;\r
 760 <a href="#p_0less">0&lt;</a> &#160;\r
 761 <a href="#p_minus">-</a> &#160;\r
 762 <a href="#p_mult">*</a> &#160;\r
 763 <a href="#p_plus">&#43;</a> &#160;\r
 764 <a href="#p_div">/</a> &#160;\r
 765 <a href="#p_shift_left">&lt;&lt;</a> &#160;\r
 766 <a href="#p_shift_right">&gt;&gt;</a> &#160;\r
 767 <a href="#p_shift_signed_right">s&gt;&gt;</a> &#160;\r
 768 <a href="#p_bracketed_quote">[']</a> &#160;</p></div>\r
 769 <div class="paragraph"><p><a href="#p_get">@</a> &#160;\r
 770 <a href="#p_put">!</a> &#160;\r
 771 <a href="#p_Cget">C@</a> &#160;\r
 772 <a href="#p_Cput">C!</a> &#160;\r
 773 <a href="#p_Wget">W@</a> &#160;\r
 774 <a href="#p_Wput">W!</a> &#160;\r
 775 <a href="#p_Dget">D@</a> &#160;\r
 776 <a href="#p_Dput">D!</a> &#160;\r
 777 <a href="#p_2get">2@</a> &#160;\r
 778 <a href="#p_2put">2!</a> &#160;\r
 779 <a href="#p_put_plus">!&#43;</a> &#160;\r
 780 <a href="#p_get_n_increment">@n&#43;&#43;</a> &#160;\r
 781 <a href="#p_get_n_decrement">@n--</a> &#160;\r
 782 <a href="#p_Ccomma">C,</a> &#160;\r
 783 <a href="#p_Wcomma">W,</a> &#160;\r
 784 <a href="#p_Dcomma">D,</a> &#160;\r
 785 <a href="#p_literal_string_compile">S"</a> &#160;\r
 786 <a href="#p_gtR">&gt;R</a> &#160;\r
 787 <a href="#p_Rget">R@</a> &#160;\r
 788 <a href="#p_Rgt">R&gt;</a> &#160;\r
 789 <a href="#p_rbpn">R[n]</a> &#160;\r
 790 <a href="#p_dsp">D[n]</a> &#160;</p></div>\r
 791 <div class="paragraph"><p><a href="#data_stack">DATA-STACK</a> &#160;\r
 792 <a href="#return_stack">RETURN-STACK</a> &#160;\r
 793 &#160;\r
 794 <a href="#p_branch">BRANCH</a> &#160;\r
 795 <a href="#p_0branch">0BRANCH</a> &#160;\r
 796 <a href="#p_1branch">1BRANCH</a> &#160;\r
 797 &#160;\r
 798 <a href="#p_2drop">2DROP</a> &#160;\r
 799 <a href="#p_2dup">2DUP</a> &#160;\r
 800 <a href="#p_2over">2OVER</a> &#160;\r
 801 <a href="#p_2swap">2SWAP</a> &#160;</p></div>\r
 802 <div class="paragraph"><p><a href="#p_abs">ABS</a> &#160;\r
 803 <a href="#p_again">AGAIN</a> &#160;\r
 804 <a href="#p_allot">ALLOT</a> &#160;\r
 805 <a href="#p_and">AND</a> &#160;\r
 806 <a href="#inline_code">[ASM]</a> &#160;</p></div>\r
 807 <div class="paragraph"><p><a href="#p_base">BASE</a> &#160;\r
 808 <a href="#p_begin">BEGIN</a> &#160;\r
 809 <a href="#p_break">BREAK</a> &#160;</p></div>\r
 810 <div class="paragraph"><p><a href="#p_cfa2flags_get">CFA&gt;FLAGS@</a> &#160;\r
 811 <a href="#p_cfa2tfa">CFA&gt;TFA</a> &#160;\r
 812 <a href="#p_clear_stream">CLEAR-STREAM</a> &#160;\r
 813 <a href="#p_create">CREATE</a> &#160;\r
 814 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> &#160;</p></div>\r
 815 <div class="paragraph"><p><a href="#p_decimal">DECIMAL</a> &#160;\r
 816 <a href="#p_definitions">DEFINITIONS</a> &#160;\r
 817 <a href="#p_depth">DEPTH</a> &#160;\r
 818 <a href="#p_digits">DIGITS</a> &#160;\r
 819 <a href="#p_divmod">/MOD</a> &#160;\r
 820 <a href="#p_dfa2tfa">DFA&gt;TFA</a> &#160;\r
 821 <a href="#p_dodoes">doDOES</a> &#160;\r
 822 <a href="#p_does">DOES&gt;</a> &#160;\r
 823 <a href="#p_dofasm">doFASM</a> &#160;\r
 824 <a href="#p_doforth">doFORTH</a> &#160;\r
 825 <a href="#p_dostring">doSTRING</a> &#160;\r
 826 <a href="#p_dovalue">doVALUE</a> &#160;\r
 827 <a href="#p_dovariable">doVARIABLE</a> &#160;\r
 828 <a href="#p_drop">DROP</a> &#160;\r
 829 <a href="#p_dup">DUP</a> &#160;</p></div>\r
 830 <div class="paragraph"><p><a href="#p_else">ELSE</a> &#160;\r
 831 <a href="#p_emit">EMIT</a> &#160;\r
 832 <a href="#p_end">END</a> &#160;\r
 833 <a href="#p_erase">ERASE</a> &#160;\r
 834 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> &#160;\r
 835 <a href="#p_execute">EXECUTE</a> &#160;\r
 836 <a href="#p_exit">EXIT</a> &#160;</p></div>\r
 837 <div class="paragraph"><p><a href="#p_false">FALSE</a> &#160;\r
 838 <a href="#p_fdemit">FDEMIT</a> &#160;\r
 839 <a href="#p_fdtell">FDTELL</a> &#160;\r
 840 <a href="#p_find">FIND</a> &#160;\r
 841 <a href="#p_forth">FORTH</a> &#160;</p></div>\r
 842 <div class="paragraph"><p><a href="#p_here">HERE</a> &#160;\r
 843 <a href="#p_hex">HEX</a> &#160;</p></div>\r
 844 <div class="paragraph"><p><a href="#p_if">IF</a> &#160;\r
 845 <a href="#p_ifagain">IFAGAIN</a> &#160;\r
 846 <a href="#p_ifbreak">IFBREAK</a> &#160;\r
 847 <a href="#p_immediate">IMMEDIATE</a> &#160;\r
 848 <a href="#p_input">INPUT</a> &#160;</p></div>\r
 849 <div class="paragraph"><p><a href="#p_literal">LIT</a> &#160;\r
 850 <a href="#p_literal_string">LIT-STRING</a> &#160;\r
 851 <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a> &#160;\r
 852 <a href="#p_load_file">LOAD-FILE</a> &#160;</p></div>\r
 853 <div class="paragraph"><p><a href="#p_args">MAIN-ARGS</a> &#160;\r
 854 <a href="#p_malloc">MALLOC</a> &#160;</p></div>\r
 855 <div class="paragraph"><p><a href="#p_negate">NEGATE</a> &#160;\r
 856 <a href="#p_nip">NIP</a> &#160;\r
 857 <a href="#p_nl">NL</a> &#160;\r
 858 <a href="#p_not">NOT</a> &#160;\r
 859 <a href="#p_number">NUMBER</a> &#160;</p></div>\r
 860 <div class="paragraph"><p><a href="#p_open_file">OPEN-FILE</a> &#160;\r
 861 <a href="#p_or">OR</a> &#160;\r
 862 <a href="#p_over">OVER</a> &#160;</p></div>\r
 863 <div class="paragraph"><p><a href="#p_pad">PAD</a> &#160;\r
 864 <a href="#p_pick">PICK</a> &#160;\r
 865 <a href="#p_program_version">PROGRAM_VERSION</a> &#160;</p></div>\r
 866 <div class="paragraph"><p><a href="#p_quit">QUIT</a> &#160;</p></div>\r
 867 <div class="paragraph"><p><a href="#p_read_stream_char">READ-STREAM-CHAR</a> &#160;\r
 868 <a href="#p_read_stream_char">READ-STREAM-LINE</a> &#160;\r
 869 <a href="#p_read_word">READ-WORD</a> &#160;\r
 870 <a href="#p_realloc">REALLOC</a> &#160;\r
 871 <a href="#p_return">RETURN</a> &#160;\r
 872 <a href="#p_roll">ROLL</a> &#160;\r
 873 <a href="#p_rot">ROT</a> &#160;\r
 874 <a href="#p_rbp">RSP</a> &#160;</p></div>\r
 875 <div class="paragraph"><p><a href="#p_sp">SP</a> &#160;\r
 876 <a href="#p_state">STATE</a> &#160;\r
 877 <a href="#p_stdin">STDIN</a> &#160;\r
 878 <a href="#p_stream">STREAM</a> &#160;\r
 879 <a href="#p_stream_nchars">STREAM-NCHARS</a> &#160;\r
 880 <a href="#p_str2temp">STR&gt;TEMP</a> &#160;\r
 881 <a href="#p_strlen">STRLEN</a> &#160;\r
 882 <a href="#p_strncmp">STRNCMP</a> &#160;\r
 883 <a href="#p_strncpy">STRNCPY</a> &#160;\r
 884 <a href="#p_swap">SWAP</a> &#160;\r
 885 <a href="#p_system">SYSTEM</a> &#160;</p></div>\r
 886 <div class="paragraph"><p><a href="#p_tell">TELL</a> &#160;\r
 887 <a href="#p_dot_temp">.TEMP</a> &#160;\r
 888 <a href="#p_temp.adoc">TEMP</a> &#160;\r
 889 <a href="#p_tempheld.adoc">TEMPHELD</a> &#160;\r
 890 <a href="#p_tempspace">TEMPSPACE</a> &#160;\r
 891 <a href="#p_tempused.adoc">TEMPUSED</a> &#160;\r
 892 <a href="#p_terminate0">TERMINATE0</a> &#160;\r
 893 <a href="#p_tfa2cfa">TFA&gt;CFA</a> &#160;\r
 894 <a href="#p_tfa2dfa">TFA&gt;DFA</a> &#160;\r
 895 <a href="#p_tfa2flags_get">TFA&gt;FLAGS@</a> &#160;\r
 896 <a href="#p_tfa2namez">TFA&gt;NAMEZ</a> &#160;\r
 897 <a href="#p_then">THEN</a> &#160;\r
 898 <a href="#p_this_word">THIS-WORD</a> &#160;\r
 899 <a href="#p_true">TRUE</a> &#160;\r
 900 <a href="#p_tuck">TUCK</a> &#160;</p></div>\r
 901 <div class="paragraph"><p><a href="#p_unstream">UNSTREAM</a> &#160;\r
 902 <a href="#p_use">USE</a> &#160;</p></div>\r
 903 <div class="paragraph"><p><a href="#p_verboseQ">VERBOSE?</a> &#160;</p></div>\r
 904 <div class="paragraph"><p><a href="#p_within">WITHIN</a> &#160;\r
 905 <a href="#p_words">WORDS</a> &#160;</p></div>\r
 906 <div class="paragraph"><p><a href="#p_xor">XOR</a> &#160;</p></div>\r
 907 <div class="paragraph"><p><a href="#p_calltrace">[calltrace]</a> &#160;\r
 908 <a href="#p_setup_signals">[setup_signals]</a> &#160;</p></div>\r
 909 </div>\r
 910 </div>\r
 911 <div class="sect1">\r
 912 <h2 id="_word_descriptions">Word Descriptions</h2>\r
 913 <div class="sectionbody">\r
 914 <div class="paragraph"><p><a id="inline_code"></a></p></div>\r
 915 <div class="sect2">\r
 916 <h3 id="_word_asm">Word: [ASM]</h3>\r
 917 <div class="literalblock">\r
 918 <div class="content">\r
 919 <pre><code>data stack: ( -- )</code></pre>\r
 920 </div></div>\r
 921 <div class="paragraph"><p>"[ASM]" is a function word that introduces inline assembly in an\r
 922 RRQFORTH definition. Such assembly code may return to subsequence\r
 923 RRQFORTH executon by means of the following instruction sequence:</p></div>\r
 924 <div class="exampleblock">\r
 925 <div class="content">\r
 926 <div class="listingblock">\r
 927 <div class="content">\r
 928 <pre><code>        mov rsi,forthcode\r
 929         lodsq\r
 930         jmp qword [rax]\r
 931 forthcode:</code></pre>\r
 932 </div></div>\r
 933 </div></div>\r
 934 <div class="paragraph"><p>Note that the FORTH compiler does not invoke an assembler so any\r
 935 inline assembly code must be provided in its binary form.</p></div>\r
 936 <div style="text-align:center">\r
 937 _______________________________________________________\r
 938 </div>\r
 939 <div class="paragraph"><p><a id="p_0branch"></a></p></div>\r
 940 </div>\r
 941 <div class="sect2">\r
 942 <h3 id="_word_0branch">Word: 0BRANCH</h3>\r
 943 <div class="literalblock">\r
 944 <div class="content">\r
 945 <pre><code>Data stack: ( v -- )</code></pre>\r
 946 </div></div>\r
 947 <div class="paragraph"><p>"0BRANCH" is a function word that implements execution conditional by\r
 948 means of optionally adding the subsequent branch offset, or not, to\r
 949 the point of execution. If the value, v, is 0 then the branch offset\r
 950 is added, and otherwise execution continues with the cell following\r
 951 the branch offset in the definition.</p></div>\r
 952 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a\r
 953 definition take up a cell of 8 bytes. The offset is relative to the\r
 954 cell address immediately subsequent to the offset cell. In other\r
 955 words, offset 0 is not branching anywhere and an offset of -16 would\r
 956 make a tight loop back to the branch instruction itself. The latter\r
 957 would pull data stack values until and including the first non-zero\r
 958 value.</p></div>\r
 959 <div class="paragraph"><p>See also <a href="#p_1branch">1BRANCH</a>, <a href="#p_branch">BRANCH</a>, <a href="#p_if">IF</a>,\r
 960 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>\r
 961 <div style="text-align:center">\r
 962 _______________________________________________________\r
 963 </div>\r
 964 <div class="paragraph"><p><a id="p_0equal"></a></p></div>\r
 965 </div>\r
 966 <div class="sect2">\r
 967 <h3 id="_word_0">Word: 0=</h3>\r
 968 <div class="literalblock">\r
 969 <div class="content">\r
 970 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>\r
 971 </div></div>\r
 972 <div class="paragraph"><p>"0=" is a function word that replaces a value with its logical\r
 973 complement; the result is zero if the value non-zero, and the result\r
 974 is non-zero if the value is zero.</p></div>\r
 975 <div class="paragraph"><p>This is the same function as <a href="#p_not">NOT</a>.</p></div>\r
 976 <div style="text-align:center">\r
 977 _______________________________________________________\r
 978 </div>\r
 979 <div class="paragraph"><p><a id="p_0less"></a></p></div>\r
 980 </div>\r
 981 <div class="sect2">\r
 982 <h3 id="_word_0_lt">Word: 0&lt;</h3>\r
 983 <div class="literalblock">\r
 984 <div class="content">\r
 985 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>\r
 986 </div></div>\r
 987 <div class="paragraph"><p>"0&lt;" is a function word that replaces a value with -1 if the value is\r
 988 less than 0, and 0 otherwise.</p></div>\r
 989 <div class="exampleblock">\r
 990 <div class="content">\r
 991 <div class="sidebarblock">\r
 992 <div class="content">\r
 993 <div class="title">Definition concept for 0&lt;</div>\r
 994 <div class="paragraph"><p>( v&#8201;&#8212;&#8201;0/1 ) : 0= 0 SWAP &lt; ;</p></div>\r
 995 </div></div>\r
 996 </div></div>\r
 997 <div class="paragraph"><p>See also <a href="#p_swap">SWAP</a> and <a href="#p_lessthan">&lt;</a>.</p></div>\r
 998 <div style="text-align:center">\r
 999 _______________________________________________________\r
1000 </div>\r
1001 <div class="paragraph"><p><a id="p_1branch"></a></p></div>\r
1002 </div>\r
1003 <div class="sect2">\r
1004 <h3 id="_word_1branch">Word: 1BRANCH</h3>\r
1005 <div class="literalblock">\r
1006 <div class="content">\r
1007 <pre><code>Data stack: ( v -- )</code></pre>\r
1008 </div></div>\r
1009 <div class="paragraph"><p>"1BRANCH" is a function word that implements execution conditional by\r
1010 means of optionally adding the subsequent branch offset, or not, to\r
1011 the point of execution. If the value, v, is non-zero then the branch\r
1012 offset is added, and otherwise execution continues with the cell\r
1013 following the branch offset in the definition.</p></div>\r
1014 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a\r
1015 definition take up a cell of 8 bytes. The offset is relative to the\r
1016 cell address immediately subsequent to the offset cell. In other\r
1017 words, offset 0 is not branching anywhere and an offset of -16 would\r
1018 make a tight loop back to the branch instruction itself. The latter\r
1019 would pull data stack values until and including the first zero value.</p></div>\r
1020 <div class="paragraph"><p>See also <a href="#p_0branch">0BRANCH</a>, <a href="#p_branch">BRANCH</a>, <a href="#p_if">IF</a>,\r
1021 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>\r
1022 <div style="text-align:center">\r
1023 _______________________________________________________\r
1024 </div>\r
1025 <div class="paragraph"><p><a id="p_2drop"></a></p></div>\r
1026 </div>\r
1027 <div class="sect2">\r
1028 <h3 id="_word_2drop">Word: 2DROP</h3>\r
1029 <div class="literalblock">\r
1030 <div class="content">\r
1031 <pre><code>Data stack: ( v1 v2 -- )</code></pre>\r
1032 </div></div>\r
1033 <div class="paragraph"><p>"2DROP" is a function word that plainly discards the top 2 cells from\r
1034 the data stack.</p></div>\r
1035 <div style="text-align:center">\r
1036 _______________________________________________________\r
1037 </div>\r
1038 <div class="paragraph"><p><a id="p_2dup"></a></p></div>\r
1039 </div>\r
1040 <div class="sect2">\r
1041 <h3 id="_word_2dup">Word: 2DUP</h3>\r
1042 <div class="literalblock">\r
1043 <div class="content">\r
1044 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 v2 )</code></pre>\r
1045 </div></div>\r
1046 <div class="paragraph"><p>"2DUP" is a function word that duplicates the top 2 cells on the data\r
1047 stack.</p></div>\r
1048 <div class="exampleblock">\r
1049 <div class="content">\r
1050 <div class="sidebarblock">\r
1051 <div class="content">\r
1052 <div class="title">Definition concept for 2DUP</div>\r
1053 <div class="paragraph"><p>( v1 v2&#8201;&#8212;&#8201;v1 v2 v1 v2 ) : 2DUP OVER OVER ;</p></div>\r
1054 </div></div>\r
1055 </div></div>\r
1056 <div style="text-align:center">\r
1057 _______________________________________________________\r
1058 </div>\r
1059 <div class="paragraph"><p><a id="p_2get"></a></p></div>\r
1060 </div>\r
1061 <div class="sect2">\r
1062 <h3 id="_word_2">Word: 2@</h3>\r
1063 <div class="literalblock">\r
1064 <div class="content">\r
1065 <pre><code>Data stack: ( a -- v2 v1 )</code></pre>\r
1066 </div></div>\r
1067 <div class="paragraph"><p>"2@" is a function word that pushes the two concecutive values v1 and\r
1068 v2 from the address a onto the data stack. Value v1 is from address a\r
1069 and value v2 is from address a + 8.</p></div>\r
1070 <div style="text-align:center">\r
1071 _______________________________________________________\r
1072 </div>\r
1073 <div class="paragraph"><p><a id="p_2over"></a></p></div>\r
1074 </div>\r
1075 <div class="sect2">\r
1076 <h3 id="_word_2over">Word: 2OVER</h3>\r
1077 <div class="literalblock">\r
1078 <div class="content">\r
1079 <pre><code>Data stack: ( v1 v2 v3 v4 -- v1 v2 v3 v4 v1 v2 )</code></pre>\r
1080 </div></div>\r
1081 <div class="paragraph"><p>"2OVER" is a function word that replicates the second duble-cell pair\r
1082 onto the top of the data stack. This is similar to <a href="#p_over">OVER</a> but\r
1083 working with cell pairs rather than single cells.</p></div>\r
1084 <div class="exampleblock">\r
1085 <div class="content">\r
1086 <div class="sidebarblock">\r
1087 <div class="content">\r
1088 <div class="title">Definition concept for 2OVER</div>\r
1089 <div class="paragraph"><p>( v1 v2 v3 v4&#8201;&#8212;&#8201;v1 v2 v3 v4 v1 v2 ) : 2OVER 3 PICK 3 PICK ;</p></div>\r
1090 </div></div>\r
1091 </div></div>\r
1092 <div style="text-align:center">\r
1093 _______________________________________________________\r
1094 </div>\r
1095 <div class="paragraph"><p><a id="p_2put"></a></p></div>\r
1096 </div>\r
1097 <div class="sect2">\r
1098 <h3 id="_word_2_2">Word: 2!</h3>\r
1099 <div class="literalblock">\r
1100 <div class="content">\r
1101 <pre><code>Data stack: ( v2 v1 a -- )</code></pre>\r
1102 </div></div>\r
1103 <div class="paragraph"><p>"2!" is a function word that stors two concecutive values v1 and v2 to\r
1104 the address a from the data stack. Value v1 is stored at address a and\r
1105 value v2 is stored at address a + 8.</p></div>\r
1106 <div style="text-align:center">\r
1107 _______________________________________________________\r
1108 </div>\r
1109 <div class="paragraph"><p><a id="p_2swap"></a></p></div>\r
1110 </div>\r
1111 <div class="sect2">\r
1112 <h3 id="_word_2swap">Word: 2SWAP</h3>\r
1113 <div class="literalblock">\r
1114 <div class="content">\r
1115 <pre><code>Data stack: ( v1 v2 v3 v4 -- v3 v4 v1 v2 )</code></pre>\r
1116 </div></div>\r
1117 <div class="paragraph"><p>"2SWAP" is a function word the reorgnizes the top 4 cells swappping\r
1118 the upper and lower pair. This is similar to <a href="#p_swap">SWAP</a> but\r
1119 working with cell pairs rather than single cells.</p></div>\r
1120 <div class="exampleblock">\r
1121 <div class="content">\r
1122 <div class="sidebarblock">\r
1123 <div class="content">\r
1124 <div class="title">Definition concept for 2SWAP</div>\r
1125 <div class="paragraph"><p>( v1 v2 v3 v4&#8201;&#8212;&#8201;v3 v4 v1 v2 ) : 2SWAP 3 ROLL 3 ROLL ;</p></div>\r
1126 </div></div>\r
1127 </div></div>\r
1128 <div style="text-align:center">\r
1129 _______________________________________________________\r
1130 </div>\r
1131 <div class="paragraph"><p><a id="p_Ccomma"></a></p></div>\r
1132 </div>\r
1133 <div class="sect2">\r
1134 <h3 id="_word_c">Word: C,</h3>\r
1135 <div class="literalblock">\r
1136 <div class="content">\r
1137 <pre><code>Data stack: ( v -- )</code></pre>\r
1138 </div></div>\r
1139 <div class="paragraph"><p>"C," (C-comma) is a function word that puts a byte on the\r
1140 <a href="#p_here">HERE</a> heap. The least significant byte of the value is put\r
1141 at the current free head address, which also is incremented.</p></div>\r
1142 <div class="exampleblock">\r
1143 <div class="content">\r
1144 <div class="sidebarblock">\r
1145 <div class="content">\r
1146 <div class="title">Definition concept for C,</div>\r
1147 <div class="paragraph"><p>: C, HERE @ 1 ALLOT C! ;  ( v&#8201;&#8212;&#8201;; Claim 1 byte and put lsb value there )</p></div>\r
1148 </div></div>\r
1149 </div></div>\r
1150 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_comma">[p_comma]</a>. <a href="#p_here">HERE</a>, <a href="#p_get">@</a>,\r
1151 <a href="#p_allot">ALLOT</a>, <a href="#p_Cput">C!</a> and <a href="#p_semicolon">;</a>.</p></div>\r
1152 <div style="text-align:center">\r
1153 _______________________________________________________\r
1154 </div>\r
1155 <div class="paragraph"><p><a id="p_Wcomma"></a></p></div>\r
1156 </div>\r
1157 <div class="sect2">\r
1158 <h3 id="_word_w">Word: W,</h3>\r
1159 <div class="literalblock">\r
1160 <div class="content">\r
1161 <pre><code>Data stack: ( v -- )</code></pre>\r
1162 </div></div>\r
1163 <div class="paragraph"><p>"W," (W-comma) is a function word that puts a "word" (double-byte) on\r
1164 the <a href="#p_here">HERE</a> heap. The two least significant bytes of the value\r
1165 are put at the current free head address, which also is incremented\r
1166 accordingly.</p></div>\r
1167 <div class="exampleblock">\r
1168 <div class="content">\r
1169 <div class="sidebarblock">\r
1170 <div class="content">\r
1171 <div class="title">Definition concept for W,</div>\r
1172 <div class="paragraph"><p>: W, HERE @ 2 ALLOT W! ;</p></div>\r
1173 </div></div>\r
1174 </div></div>\r
1175 <div style="text-align:center">\r
1176 _______________________________________________________\r
1177 </div>\r
1178 <div class="paragraph"><p><a id="p_Dcomma"></a></p></div>\r
1179 </div>\r
1180 <div class="sect2">\r
1181 <h3 id="_word_d">Word: D,</h3>\r
1182 <div class="literalblock">\r
1183 <div class="content">\r
1184 <pre><code>Data stack: ( v -- )</code></pre>\r
1185 </div></div>\r
1186 <div class="paragraph"><p>"D," (D-comma) is a function word that puts a "double word"\r
1187 (double-byte) on the <a href="#p_here">HERE</a> heap. The four least significant\r
1188 bytes of the value are put at the current free head address, which\r
1189 also is incremented accordingly.</p></div>\r
1190 <div class="exampleblock">\r
1191 <div class="content">\r
1192 <div class="sidebarblock">\r
1193 <div class="content">\r
1194 <div class="title">Definition concept for D,</div>\r
1195 <div class="paragraph"><p>: D, HERE @ 4 ALLOT D! ;</p></div>\r
1196 </div></div>\r
1197 </div></div>\r
1198 <div style="text-align:center">\r
1199 _______________________________________________________\r
1200 </div>\r
1201 <div class="paragraph"><p><a id="p_dsp"></a></p></div>\r
1202 </div>\r
1203 <div class="sect2">\r
1204 <h3 id="_word_d_n">Word: D[n]</h3>\r
1205 <div class="literalblock">\r
1206 <div class="content">\r
1207 <pre><code>Data stack: ( n -- a )</code></pre>\r
1208 </div></div>\r
1209 <div class="paragraph"><p>"D[n]" is a function word that pushes the address for the n:th cell of\r
1210 the data stack onto the data stack.</p></div>\r
1211 <div style="text-align:center">\r
1212 _______________________________________________________\r
1213 </div>\r
1214 <div class="paragraph"><p><a id="p_cfa2tfa"></a></p></div>\r
1215 </div>\r
1216 <div class="sect2">\r
1217 <h3 id="_word_cfa_gt_tfa">Word: CFA&gt;TFA</h3>\r
1218 <div class="literalblock">\r
1219 <div class="content">\r
1220 <pre><code>Data stack: ( cfa -- tfa )</code></pre>\r
1221 </div></div>\r
1222 <div class="paragraph"><p>"CFA&gt;TFA" is a function word that pushes word tfa of the given cfa.</p></div>\r
1223 <div class="exampleblock">\r
1224 <div class="content">\r
1225 <div class="sidebarblock">\r
1226 <div class="content">\r
1227 <div class="title">Definition concept for CFA&gt;TFA</div>\r
1228 <div class="paragraph"><p>: CFA&gt;TFA 14 - @ ;</p></div>\r
1229 </div></div>\r
1230 </div></div>\r
1231 <div style="text-align:center">\r
1232 _______________________________________________________\r
1233 </div>\r
1234 <div class="paragraph"><p><a id="p_Cget"></a></p></div>\r
1235 </div>\r
1236 <div class="sect2">\r
1237 <h3 id="_word_c_2">Word: C@</h3>\r
1238 <div class="literalblock">\r
1239 <div class="content">\r
1240 <pre><code>Data stack: ( a -- v )</code></pre>\r
1241 </div></div>\r
1242 <div class="paragraph"><p>"C@" is a function word that pushes the byte value v from the address a.</p></div>\r
1243 <div style="text-align:center">\r
1244 _______________________________________________________\r
1245 </div>\r
1246 <div class="paragraph"><p><a id="p_Wget"></a></p></div>\r
1247 </div>\r
1248 <div class="sect2">\r
1249 <h3 id="_word_w_2">Word: W@</h3>\r
1250 <div class="literalblock">\r
1251 <div class="content">\r
1252 <pre><code>Data stack: ( a -- v )</code></pre>\r
1253 </div></div>\r
1254 <div class="paragraph"><p>"W@" is a function word that pushes the "word" (double-byte) value v\r
1255 from the address a.</p></div>\r
1256 <div style="text-align:center">\r
1257 _______________________________________________________\r
1258 </div>\r
1259 <div class="paragraph"><p><a id="p_Rget"></a></p></div>\r
1260 </div>\r
1261 <div class="sect2">\r
1262 <h3 id="_word_r">Word: R@</h3>\r
1263 <div class="literalblock">\r
1264 <div class="content">\r
1265 <pre><code>Data stack: ( -- v )   Return stack: ( v -- v )</code></pre>\r
1266 </div></div>\r
1267 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto\r
1268 the data stack.</p></div>\r
1269 <div style="text-align:center">\r
1270 _______________________________________________________\r
1271 </div>\r
1272 <div class="paragraph"><p><a id="p_Cput"></a></p></div>\r
1273 </div>\r
1274 <div class="sect2">\r
1275 <h3 id="_word_c_3">Word: C!</h3>\r
1276 <div class="literalblock">\r
1277 <div class="content">\r
1278 <pre><code>Data stack: ( v a -- )</code></pre>\r
1279 </div></div>\r
1280 <div class="paragraph"><p>"C!" is a function word that stores the byte value v (the least\r
1281 significant byte of the cell) at the address a.</p></div>\r
1282 <div style="text-align:center">\r
1283 _______________________________________________________\r
1284 </div>\r
1285 <div class="paragraph"><p><a id="p_Wput"></a></p></div>\r
1286 </div>\r
1287 <div class="sect2">\r
1288 <h3 id="_word_w_3">Word: W!</h3>\r
1289 <div class="literalblock">\r
1290 <div class="content">\r
1291 <pre><code>Data stack: ( v a -- )</code></pre>\r
1292 </div></div>\r
1293 <div class="paragraph"><p>"W!" is a function word that stores the "word" (2-byte) value v (the\r
1294 two least significant bytes of the cell) at the address a.</p></div>\r
1295 <div style="text-align:center">\r
1296 _______________________________________________________\r
1297 </div>\r
1298 <div class="paragraph"><p><a id="p_Dput"></a></p></div>\r
1299 </div>\r
1300 <div class="sect2">\r
1301 <h3 id="_word_d_2">Word: D!</h3>\r
1302 <div class="literalblock">\r
1303 <div class="content">\r
1304 <pre><code>Data stack: ( v a -- )</code></pre>\r
1305 </div></div>\r
1306 <div class="paragraph"><p>"D!" is a function word that stores the "doublw word" (4-byte) value v\r
1307 (the four least significant bytes of the cell) at the address a.</p></div>\r
1308 <div style="text-align:center">\r
1309 _______________________________________________________\r
1310 </div>\r
1311 <div class="paragraph"><p><a id="p_Rget"></a></p></div>\r
1312 </div>\r
1313 <div class="sect2">\r
1314 <h3 id="_word_r_2">Word: R@</h3>\r
1315 <div class="literalblock">\r
1316 <div class="content">\r
1317 <pre><code>Data stack: ( -- v )   Return stack: ( v -- v )</code></pre>\r
1318 </div></div>\r
1319 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto\r
1320 the data stack.</p></div>\r
1321 <div style="text-align:center">\r
1322 _______________________________________________________\r
1323 </div>\r
1324 <div class="paragraph"><p><a id="p_Rgt"></a></p></div>\r
1325 </div>\r
1326 <div class="sect2">\r
1327 <h3 id="_word_r_gt">Word: R&gt;</h3>\r
1328 <div class="literalblock">\r
1329 <div class="content">\r
1330 <pre><code>Data stack: ( -- v )   Return stack: ( v -- )</code></pre>\r
1331 </div></div>\r
1332 <div class="paragraph"><p>"R&gt;" is a function word that "moves" the top return stack value onto\r
1333 the data stack.</p></div>\r
1334 <div style="text-align:center">\r
1335 _______________________________________________________\r
1336 </div>\r
1337 <div class="paragraph"><p><a id="p_abs"></a></p></div>\r
1338 </div>\r
1339 <div class="sect2">\r
1340 <h3 id="_word_abs">Word: ABS</h3>\r
1341 <div class="literalblock">\r
1342 <div class="content">\r
1343 <pre><code>Data stack: ( v1 -- v2 )</code></pre>\r
1344 </div></div>\r
1345 <div class="paragraph"><p>"ABS" is a function word that replaces a value with its absolute\r
1346 value. To that end, the values are 64-bit signed integers.</p></div>\r
1347 <div style="text-align:center">\r
1348 _______________________________________________________\r
1349 </div>\r
1350 <div class="paragraph"><p><a id="p_again"></a></p></div>\r
1351 </div>\r
1352 <div class="sect2">\r
1353 <h3 id="_word_again">Word: AGAIN</h3>\r
1354 <div class="literalblock">\r
1355 <div class="content">\r
1356 <pre><code>Data stack: Compiling: ( -- a )</code></pre>\r
1357 </div></div>\r
1358 <div class="paragraph"><p>"AGAIN" is an immediate function word that is used together with\r
1359 <a href="#p_begin">BEGIN</a> and instead of <a href="#p_end">END</a> to implement structured\r
1360 execution control. AGAIN scans the datastack for the nearest preceding\r
1361 BEGIN marker and lays out an unconditional branch from this point the\r
1362 beginning of the block during execution. It thereafter performs the\r
1363 <a href="#p_end">END</a> compile action to end the block.</p></div>\r
1364 <div style="text-align:center">\r
1365 _______________________________________________________\r
1366 </div>\r
1367 <div class="paragraph"><p><a id="p_allot"></a></p></div>\r
1368 </div>\r
1369 <div class="sect2">\r
1370 <h3 id="_word_allot">Word: ALLOT</h3>\r
1371 <div class="literalblock">\r
1372 <div class="content">\r
1373 <pre><code>Data stack: ( n -- )</code></pre>\r
1374 </div></div>\r
1375 <div class="paragraph"><p>"ALLOT" is a function word that merely increments the <a href="#p_here">HERE</a>\r
1376 variable with <code>n</code> so as to claim that amount of the heap.</p></div>\r
1377 <div class="exampleblock">\r
1378 <div class="content">\r
1379 <div class="sidebarblock">\r
1380 <div class="content">\r
1381 <div class="title">Defintion concept for ALLOT</div>\r
1382 <div class="paragraph"><p>( n&#8201;&#8212;&#8201;) : ALLOT HERE @ + HERE ! ;</p></div>\r
1383 </div></div>\r
1384 </div></div>\r
1385 <div class="exampleblock">\r
1386 <div class="content">\r
1387 <div class="paragraph"><div class="title">Usage example 1: claim 16 bytes for variable FOO</div><p>CREATE FOO DROP HERE @ 16 ALLOT</p></div>\r
1388 </div></div>\r
1389 <div style="text-align:center">\r
1390 _______________________________________________________\r
1391 </div>\r
1392 <div class="paragraph"><p><a id="p_and"></a></p></div>\r
1393 </div>\r
1394 <div class="sect2">\r
1395 <h3 id="_word_and">Word: AND</h3>\r
1396 <div class="literalblock">\r
1397 <div class="content">\r
1398 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
1399 </div></div>\r
1400 <div class="paragraph"><p>"AND" is a function word that replaces a value pair with their bitwise\r
1401 conjunction; each bit is 1 if the corresponding bits of both operands\r
1402 are 1 and 0 if not.</p></div>\r
1403 <div style="text-align:center">\r
1404 _______________________________________________________\r
1405 </div>\r
1406 <div class="paragraph"><p><a id="p_args"></a></p></div>\r
1407 </div>\r
1408 <div class="sect2">\r
1409 <h3 id="_word_main_args">Word: MAIN-ARGS</h3>\r
1410 <div class="literalblock">\r
1411 <div class="content">\r
1412 <pre><code>Data stack: ( -- p[argv** argc] )</code></pre>\r
1413 </div></div>\r
1414 <div class="paragraph"><p>"ARGS" is a value word that holds a pointer to the command line data\r
1415 block which consists of a count cell followed by that many asciiz\r
1416 pointers and then a 0 cell. That is next followed by the environment\r
1417 as a number of asciiz pointers and a 0 cell.</p></div>\r
1418 <div class="exampleblock">\r
1419 <div class="content">\r
1420 <div class="listingblock">\r
1421 <div class="title">Usage example 2: the command line argument block</div>\r
1422 <div class="content">\r
1423 <pre><code>ARGS -&gt; 8 bytes: count of non-zero asciiz pointers following\r
1424         8 bytes: command name string\r
1425         8* bytes: argument strings\r
1426         8 bytes: zero cell\r
1427         8* bytes: envirnment strings\r
1428         8 bytes: zero cell</code></pre>\r
1429 </div></div>\r
1430 </div></div>\r
1431 <div style="text-align:center">\r
1432 _______________________________________________________\r
1433 </div>\r
1434 <div class="paragraph"><p><a id="p_base"></a></p></div>\r
1435 </div>\r
1436 <div class="sect2">\r
1437 <h3 id="_word_base">Word: BASE</h3>\r
1438 <div class="literalblock">\r
1439 <div class="content">\r
1440 <pre><code>Data stack: ( -- a )</code></pre>\r
1441 </div></div>\r
1442 <div class="paragraph"><p>"BASE" is a variable word for the numerical base used by input and\r
1443 output functions, <a href="#p_number">NUMBER</a> and <a href="#p_dot">[p_dot]</a>, when\r
1444 translating numbers between cell value form and text form. The\r
1445 numerical base is set to 10 or 16 by <a href="#p_decimal">DECIMAL</a> and\r
1446 <a href="#p_hex">HEX</a> respectively, and those are the only two bases currently\r
1447 supported.</p></div>\r
1448 <div class="paragraph"><p>See also <a href="#p_digits">DIGITS</a>, which holds the mapping table from\r
1449 digits to text.</p></div>\r
1450 <div style="text-align:center">\r
1451 _______________________________________________________\r
1452 </div>\r
1453 <div class="paragraph"><p><a id="p_begin"></a></p></div>\r
1454 </div>\r
1455 <div class="sect2">\r
1456 <h3 id="_word_begin">Word: BEGIN</h3>\r
1457 <div class="literalblock">\r
1458 <div class="content">\r
1459 <pre><code>Data stack: Compiling: ( -- a 0 )</code></pre>\r
1460 </div></div>\r
1461 <div class="paragraph"><p>"BEGIN" is an immediate function word that is used together with\r
1462 <a href="#p_ifbreak">IFBREAK</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to\r
1463 implement structured execution control. BEGIN simply places the\r
1464 address for resolving branches back to this point during execution,\r
1465 and then a 0 as a marker so as to allow for an unknown number of block\r
1466 exit points.</p></div>\r
1467 <div class="exampleblock">\r
1468 <div class="content">\r
1469 <div class="listingblock">\r
1470 <div class="title">Usage example 3:</div>\r
1471 <div class="content">\r
1472 <pre><code>: WTELL ( tfa -- ; Print word pname )\r
1473   24 + DUP 8 + SWAP @ TELL SP EMIT\r
1474 ;\r
1475 \r
1476 : WORDS ( wordlist -- ; Print all words of word list )\r
1477   BEGIN\r
1478     @ DUP 0= IFBREAK\r
1479     DUP WTELL\r
1480   END\r
1481   DROP\r
1482   NL EMIT\r
1483 ;</code></pre>\r
1484 </div></div>\r
1485 </div></div>\r
1486 <div style="text-align:center">\r
1487 _______________________________________________________\r
1488 </div>\r
1489 <div class="paragraph"><p><a id="p_bracketed_quote"></a></p></div>\r
1490 </div>\r
1491 <div class="sect2">\r
1492 <h3 id="_word">Word: [']</h3>\r
1493 <div class="literalblock">\r
1494 <div class="content">\r
1495 <pre><code>Data stack: ( -- cfa )   Input stream: word</code></pre>\r
1496 </div></div>\r
1497 <div class="paragraph"><p>"[']" is an immediate function word that reads the next word on the\r
1498 input stream and pushes its cfa.</p></div>\r
1499 <div class="exampleblock">\r
1500 <div class="content">\r
1501 <div class="sidebarblock">\r
1502 <div class="content">\r
1503 <div class="title">Definition concept for [']</div>\r
1504 <div class="paragraph"><p>: ['] IMMEDIATE ' ;</p></div>\r
1505 </div></div>\r
1506 </div></div>\r
1507 <div style="text-align:center">\r
1508 _______________________________________________________\r
1509 </div>\r
1510 <div class="paragraph"><p><a id="p_branch"></a></p></div>\r
1511 </div>\r
1512 <div class="sect2">\r
1513 <h3 id="_word_branch">Word: BRANCH</h3>\r
1514 <div class="literalblock">\r
1515 <div class="content">\r
1516 <pre><code>Data stack: ( -- )</code></pre>\r
1517 </div></div>\r
1518 <div class="paragraph"><p>"BRANCH" is a function word that implements execution transfer by\r
1519 means of adding the subsequent branch offset to the point of\r
1520 execution.</p></div>\r
1521 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a\r
1522 definition take up a cell of 8 bytes. The offset is relative to the\r
1523 cell address immediately subsequent to the offset cell. In other\r
1524 words, offset 0 is not branching anywhere and an offset of -16 would\r
1525 make a tight loop back to the branch instruction itself. The latter\r
1526 would pull data stack values until and including the first zero value.</p></div>\r
1527 <div class="paragraph"><p>See also <a href="#p_0branch">0BRANCH</a>, <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>,\r
1528 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>\r
1529 <div style="text-align:center">\r
1530 _______________________________________________________\r
1531 </div>\r
1532 <div class="paragraph"><p><a id="p_break"></a></p></div>\r
1533 </div>\r
1534 <div class="sect2">\r
1535 <h3 id="_word_break">Word: BREAK</h3>\r
1536 <div class="paragraph"><p>"BREAK" is an immediate function word that lays out an unconditional\r
1537 branch out of an enclosing xef:p_begin[BEGIN]-<a href="#p_end">END</a> block.\r
1538 Similar to <a href="#p_ifbreak">IFBREAK</a> it lays out the branch cell\r
1539 followed by a reserved cell for the branch offset, and inserts the\r
1540 resolution address just above the required 0 on the data stack.</p></div>\r
1541 <div class="exampleblock">\r
1542 <div class="content">\r
1543 <div class="listingblock">\r
1544 <div class="title">Usage example 4: unconditional break with a condition.</div>\r
1545 <div class="content">\r
1546 <pre><code>: WTELL ( tfa -- ; Print word pname )\r
1547   24 + DUP 8 + SWAP @ TELL SP EMIT\r
1548 ;\r
1549 \r
1550 : WORDS ( wordlist -- ; Print all words of word list )\r
1551   BEGIN\r
1552     @ DUP IF DUP WTELL ELSE BREAK THEN\r
1553     1 IFAGAIN\r
1554   END\r
1555   DROP\r
1556   NL EMIT\r
1557 ;</code></pre>\r
1558 </div></div>\r
1559 </div></div>\r
1560 <div class="paragraph"><p>See also <a href="#p_branch">BRANCH</a>, <a href="#p_0branch">0BRANCH</a>,\r
1561 <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>, <a href="#p_else">ELSE</a>,\r
1562 <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>\r
1563 <div style="text-align:center">\r
1564 _______________________________________________________\r
1565 </div>\r
1566 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>\r
1567 </div>\r
1568 <div class="sect2">\r
1569 <h3 id="_word_calltrace">Word: [calltrace]</h3>\r
1570 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly\r
1571 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>\r
1572 <div style="text-align:center">\r
1573 _______________________________________________________\r
1574 </div>\r
1575 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>\r
1576 </div>\r
1577 <div class="sect2">\r
1578 <h3 id="_word_cfa_gt_flags">Word: CFA&gt;FLAGS@</h3>\r
1579 <div class="literalblock">\r
1580 <div class="content">\r
1581 <pre><code>Data stack: ( cfa -- flags )</code></pre>\r
1582 </div></div>\r
1583 <div class="paragraph"><p>"CFA&gt;FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>\r
1584 <div class="exampleblock">\r
1585 <div class="content">\r
1586 <div class="sidebarblock">\r
1587 <div class="content">\r
1588 <div class="title">Defintion concept for CFA&gt;FLAGS@</div>\r
1589 <div class="paragraph"><p>: CFA&gt;FLAGS@ 16 - @ 16 + ;</p></div>\r
1590 </div></div>\r
1591 </div></div>\r
1592 <div style="text-align:center">\r
1593 _______________________________________________________\r
1594 </div>\r
1595 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>\r
1596 </div>\r
1597 <div class="sect2">\r
1598 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>\r
1599 <div class="literalblock">\r
1600 <div class="content">\r
1601 <pre><code>Data stack: ( stream -- )</code></pre>\r
1602 </div></div>\r
1603 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently\r
1604 remaining in the buffer for the stream, so that a subsequent read will\r
1605 pull in more data from its source.</p></div>\r
1606 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>\r
1607 <div style="text-align:center">\r
1608 _______________________________________________________\r
1609 </div>\r
1610 <div class="paragraph"><p><a id="p_colon"></a></p></div>\r
1611 </div>\r
1612 <div class="sect2">\r
1613 <h3 id="_word_3">Word: :</h3>\r
1614 <div class="literalblock">\r
1615 <div class="content">\r
1616 <pre><code>Data stack: ( -- )    Input stream: word</code></pre>\r
1617 </div></div>\r
1618 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.\r
1619 This includes reading the next word for making a new dictionary entry\r
1620 and setting evaluation state to compiling mode.</p></div>\r
1621 <div class="exampleblock">\r
1622 <div class="content">\r
1623 <div class="sidebarblock">\r
1624 <div class="content">\r
1625 <div class="title">Definition concept for :</div>\r
1626 <div class="paragraph"><p>: : doFORTH READ-WORD CREATE TFA&gt;CFA ! ] ;</p></div>\r
1627 </div></div>\r
1628 </div></div>\r
1629 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,\r
1630 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA&gt;CFA</a>, <a href="#p_put">!</a>,\r
1631 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>\r
1632 <div style="text-align:center">\r
1633 _______________________________________________________\r
1634 </div>\r
1635 <div class="paragraph"><p><a id="p_comma"></a></p></div>\r
1636 </div>\r
1637 <div class="sect2">\r
1638 <h3 id="_word_4">Word: ,</h3>\r
1639 <div class="literalblock">\r
1640 <div class="content">\r
1641 <pre><code>Data stack: ( v -- )</code></pre>\r
1642 </div></div>\r
1643 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the\r
1644 <a href="#p_here">HERE</a> heap.</p></div>\r
1645 <div class="exampleblock">\r
1646 <div class="content">\r
1647 <div class="sidebarblock">\r
1648 <div class="content">\r
1649 <div class="title">Definition concept for ,</div>\r
1650 <div class="paragraph"><p>: , HERE @ 8 ALLOT ! ; ( v&#8201;&#8212;&#8201;; Claim 8 bytes and put value there )</p></div>\r
1651 </div></div>\r
1652 </div></div>\r
1653 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_Ccomma">[p_Ccomma]</a>. <a href="#p_here">HERE</a>, <a href="#p_get">@</a>,\r
1654 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>\r
1655 <div style="text-align:center">\r
1656 _______________________________________________________\r
1657 </div>\r
1658 <div class="paragraph"><p><a id="p_create"></a></p></div>\r
1659 </div>\r
1660 <div class="sect2">\r
1661 <h3 id="_word_create">Word: CREATE</h3>\r
1662 <div class="literalblock">\r
1663 <div class="content">\r
1664 <pre><code>Data stack: ( char* n -- tfa )</code></pre>\r
1665 </div></div>\r
1666 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the\r
1667 indicated [n:char*] print name, and returns the "TFA" (Token Field\r
1668 Address) of the word. The header memory layout is as follows:</p></div>\r
1669 <div class="exampleblock">\r
1670 <div class="content">\r
1671 <div class="listingblock">\r
1672 <div class="title">Layout 1: rrqforth word structure</div>\r
1673 <div class="content">\r
1674 <pre><code>struct WORD\r
1675 TFA  8 link ; tfa of previous word\r
1676 pCFA 8 cfap ; CFA = Code Field Address of this word\r
1677      8 flags ;\r
1678 PFA  8 length ; length of pname representation\r
1679      ? pname ; the pname bytes\r
1680      1 nul ; a forced nul byte following the pname\r
1681 pTFA 8 tfap ; TFA = Token Field Address of this word\r
1682 OFF  8 doff ; entry offset for FORTH level execution\r
1683 CFA  8 doer ; word execution semantics\r
1684 DFA  0 content ; DFA = Data Field Address\r
1685 end_struct</code></pre>\r
1686 </div></div>\r
1687 </div></div>\r
1688 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content\r
1689 as held in the memory space following the DFA (Data Field Address).</p></div>\r
1690 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for\r
1691 RRQFORTH execution, as holding a jump address to the assembly code\r
1692 that implements the particular execution semantics for the word.\r
1693 "CREATE" will assign this as "dovariable", which makes the word push\r
1694 its DFA when executed. This is changed to "doforth" for RRQFORTH\r
1695 function words initiated by ":" (aka "COLON") or changed to "dovalue"\r
1696 for RRQFORTH constants created by "CONSTANT".</p></div>\r
1697 <div class="exampleblock">\r
1698 <div class="content">\r
1699 <div class="sidebarblock">\r
1700 <div class="content">\r
1701 <div class="title">Definition concept for CREATE</div>\r
1702 <div class="paragraph"><p>HERE @ R&gt; ( save tfa on RS )\r
1703   R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )\r
1704   DUP 49 + R@ + ,             ( pCFA )\r
1705   0 ,                         ( flags )\r
1706   DUP , ( length )\r
1707   HERE @ ROT ROT MEMCPY 0 C,  ( pname + NUL )\r
1708   R@ ,                        ( pTFA )\r
1709   0 ,                         ( OFF )\r
1710   doVARIABLE                  ( CFA, default semantics )</p></div>\r
1711 </div></div>\r
1712 </div></div>\r
1713 <div class="exampleblock">\r
1714 <div class="content">\r
1715 <div class="listingblock">\r
1716 <div class="title">Usage example 5: a possible definition of CONSTANT</div>\r
1717 <div class="content">\r
1718 <pre><code>: CONSTANT READ-WORD CREATE TFA&gt;DFA doVALUE OVER 8 - ! ! ;</code></pre>\r
1719 </div></div>\r
1720 </div></div>\r
1721 <div class="paragraph"><p>See also <a href="#p_put">!</a>, <a href="#p_plus">+</a>, <a href="#p_comma">[p_comma]</a>, <a href="#p_get">@</a>,\r
1722 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,\r
1723 <a href="#p_here">HERE</a>, <a href="#p_herememcpy">HERE</a>, <a href="#p_Rget">R@</a>, <a href="#p_rot">ROT</a>,\r
1724 and <a href="#p_dovariable">doVARIABLE</a>,\r
1725 as well as <a href="#p_execute">EXECUTE</a>\r
1726 about the range of "doer" assignments and their meanings.</p></div>\r
1727 <div style="text-align:center">\r
1728 _______________________________________________________\r
1729 </div>\r
1730 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>\r
1731 </div>\r
1732 <div class="sect2">\r
1733 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>\r
1734 <div class="literalblock">\r
1735 <div class="content">\r
1736 <pre><code>Data stack: ( -- a )</code></pre>\r
1737 </div></div>\r
1738 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the\r
1739 current word list word for <a href="#p_find">FIND</a> to use finding words. The\r
1740 word list word content is as follows:</p></div>\r
1741 <div class="exampleblock">\r
1742 <div class="content">\r
1743 <div class="listingblock">\r
1744 <div class="title">Layout 2: word list word content</div>\r
1745 <div class="content">\r
1746 <pre><code>  8 TFA of latest word in the word list\r
1747   8 DFA of the/a subsequent word list to search through</code></pre>\r
1748 </div></div>\r
1749 </div></div>\r
1750 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends\r
1751 with the <a href="#p_forth">FORTH</a> word list. Initially the\r
1752 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>\r
1753 <div style="text-align:center">\r
1754 _______________________________________________________\r
1755 </div>\r
1756 <div class="paragraph"><p><a id="data_stack"></a></p></div>\r
1757 </div>\r
1758 <div class="sect2">\r
1759 <h3 id="_word_data_stack">Word: DATA-STACK</h3>\r
1760 <div class="literalblock">\r
1761 <div class="content">\r
1762 <pre><code>Data stack: ( -- a )</code></pre>\r
1763 </div></div>\r
1764 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>\r
1765 <div style="text-align:center">\r
1766 _______________________________________________________\r
1767 </div>\r
1768 <div class="paragraph"><p><a id="p_decimal"></a></p></div>\r
1769 </div>\r
1770 <div class="sect2">\r
1771 <h3 id="_word_decimal">Word: DECIMAL</h3>\r
1772 <div class="literalblock">\r
1773 <div class="content">\r
1774 <pre><code>Data stack: ( -- )</code></pre>\r
1775 </div></div>\r
1776 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>\r
1777 <div class="exampleblock">\r
1778 <div class="content">\r
1779 <div class="sidebarblock">\r
1780 <div class="content">\r
1781 <div class="title">Definition concept for DECIMAL</div>\r
1782 <div class="paragraph"><p>: DECIMAL 10 BASE ! ;</p></div>\r
1783 </div></div>\r
1784 </div></div>\r
1785 <div style="text-align:center">\r
1786 _______________________________________________________\r
1787 </div>\r
1788 <div class="paragraph"><p><a id="p_definitions"></a></p></div>\r
1789 </div>\r
1790 <div class="sect2">\r
1791 <h3 id="_word_definitions">Word: DEFINITIONS</h3>\r
1792 <div class="literalblock">\r
1793 <div class="content">\r
1794 <pre><code>Data stack: ( wordlist -- )</code></pre>\r
1795 </div></div>\r
1796 <div class="paragraph"><p>"DEFINITIONS" is a function word that installs the given wordlist as\r
1797 the <a href="#p_current_wordlist">CURRENT-WORDLIST</a> one.</p></div>\r
1798 <div class="exampleblock">\r
1799 <div class="content">\r
1800 <div class="sidebarblock">\r
1801 <div class="content">\r
1802 <div class="title">Definition concept for DEFINITIONS</div>\r
1803 <div class="paragraph"><p>: DEFINITIONS CURRENT-WORDLIST ! ;</p></div>\r
1804 </div></div>\r
1805 </div></div>\r
1806 <div style="text-align:center">\r
1807 _______________________________________________________\r
1808 </div>\r
1809 <div class="paragraph"><p><a id="p_depth"></a></p></div>\r
1810 </div>\r
1811 <div class="sect2">\r
1812 <h3 id="_word_depth">Word: DEPTH</h3>\r
1813 <div class="literalblock">\r
1814 <div class="content">\r
1815 <pre><code>Data stack: ( -- v )</code></pre>\r
1816 </div></div>\r
1817 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells\r
1818 onto the data stack.</p></div>\r
1819 <div style="text-align:center">\r
1820 _______________________________________________________\r
1821 </div>\r
1822 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>\r
1823 </div>\r
1824 <div class="sect2">\r
1825 <h3 id="_word_dfa_gt_tfa">Word: DFA&gt;TFA</h3>\r
1826 <div class="literalblock">\r
1827 <div class="content">\r
1828 <pre><code>Data stack: ( dfa -- tfa )</code></pre>\r
1829 </div></div>\r
1830 <div class="paragraph"><p>"DFA&gt;TFA" is a function word that pushes word tfa of the given dfa.</p></div>\r
1831 <div class="exampleblock">\r
1832 <div class="content">\r
1833 <div class="sidebarblock">\r
1834 <div class="content">\r
1835 <div class="title">Definition concept for DFA&gt;TFA</div>\r
1836 <div class="paragraph"><p>: DFA&gt;TFA 24 - @ ;</p></div>\r
1837 </div></div>\r
1838 </div></div>\r
1839 <div style="text-align:center">\r
1840 _______________________________________________________\r
1841 </div>\r
1842 <div class="paragraph"><p><a id="p_digits"></a></p></div>\r
1843 </div>\r
1844 <div class="sect2">\r
1845 <h3 id="_word_digits">Word: DIGITS</h3>\r
1846 <div class="literalblock">\r
1847 <div class="content">\r
1848 <pre><code>Data stack: ( -- a )</code></pre>\r
1849 </div></div>\r
1850 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping\r
1851 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>\r
1852 <div style="text-align:center">\r
1853 _______________________________________________________\r
1854 </div>\r
1855 <div class="paragraph"><p><a id="p_div"></a></p></div>\r
1856 </div>\r
1857 <div class="sect2">\r
1858 <h3 id="_word_5">Word: /</h3>\r
1859 <div class="literalblock">\r
1860 <div class="content">\r
1861 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>\r
1862 </div></div>\r
1863 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the\r
1864 results of signed integer division of the first, v1, divided by the\r
1865 second, v2. To that end, the values are 64-bit signed integers. The\r
1866 result is the integer quotient, q, and the discarded remainder, r,\r
1867 where q and r are the respectively largest and smallest integers to\r
1868 satisfy the formula:</p></div>\r
1869 <div class="literalblock">\r
1870 <div class="content">\r
1871 <pre><code>       v1 = q * v2 + r</code></pre>\r
1872 </div></div>\r
1873 <div style="text-align:center">\r
1874 _______________________________________________________\r
1875 </div>\r
1876 <div class="paragraph"><p><a id="p_divmod"></a></p></div>\r
1877 </div>\r
1878 <div class="sect2">\r
1879 <h3 id="_word_mod">Word: /MOD</h3>\r
1880 <div class="literalblock">\r
1881 <div class="content">\r
1882 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>\r
1883 </div></div>\r
1884 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values\r
1885 with the results of signed integer division of the first, v1, divided\r
1886 by the second, v2. To that end, the values are 64-bit signed integers.\r
1887 The result is the integer quotient, q, and the remainder, r, where q\r
1888 and r are the respectively largest and smallest integers to satisfy\r
1889 the formula:</p></div>\r
1890 <div class="literalblock">\r
1891 <div class="content">\r
1892 <pre><code>       v1 = q * v2 + r</code></pre>\r
1893 </div></div>\r
1894 <div style="text-align:center">\r
1895 _______________________________________________________\r
1896 </div>\r
1897 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>\r
1898 </div>\r
1899 <div class="sect2">\r
1900 <h3 id="_word_dodoes">Word: doDOES</h3>\r
1901 <div class="literalblock">\r
1902 <div class="content">\r
1903 <pre><code>Data stack: ( -- a )</code></pre>\r
1904 </div></div>\r
1905 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the\r
1906 <a href="#p_does">[p_does]</a> execution semantics. This is the same as\r
1907 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word\r
1908 concerned.</p></div>\r
1909 <div style="text-align:center">\r
1910 _______________________________________________________\r
1911 </div>\r
1912 <div class="paragraph"><p><a id="p_does"></a></p></div>\r
1913 </div>\r
1914 <div class="sect2">\r
1915 <h3 id="_word_does_gt">WORD: DOES&gt;</h3>\r
1916 <div class="literalblock">\r
1917 <div class="content">\r
1918 <pre><code>Data stack: ( -- )</code></pre>\r
1919 </div></div>\r
1920 <div class="paragraph"><p>"DOES&gt;" is a function that in execution mode does nothing but in\r
1921 compilation mode it changes the execution semantics assignments for\r
1922 the most recent word to use the <code>dodoes</code> sematics with adjustment\r
1923 offset to the current heap address. I.e., the word being defined will\r
1924 have its execution start at whatever comes after "DOES&gt;".</p></div>\r
1925 <div class="exampleblock">\r
1926 <div class="content">\r
1927 <div class="sidebarblock">\r
1928 <div class="content">\r
1929 <div class="title">Defintion concept for DOES&gt;</div>\r
1930 <div class="paragraph"><p>: DOES&gt; IMMEDIATE\r
1931 STATE @ != IF ( only for compilation mode )\r
1932   CURRENT-WORDLIST @ @ TFA&gt;CFA    ( cfa of current word )\r
1933     doDOES OVER !                 ( set up doer )\r
1934     HERE @ OVER 8 + - SWAP 8 - !  ( set up offset\r
1935   THEN\r
1936 ;</p></div>\r
1937 </div></div>\r
1938 </div></div>\r
1939 <div class="paragraph"><p>See also\r
1940 <a href="#p_put">!</a>,\r
1941 <a href="#p_unequal">!&#8658;&gt;</a>,\r
1942 <a href="#p_minus">&#8594;&gt;</a>,\r
1943 <a href="#p_get">@</a>,\r
1944 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,\r
1945 <a href="#p_here">HERE</a>,\r
1946 <a href="#p_if">IF</a>,\r
1947 <a href="#p_immediate">IMMEDIATE</a>,\r
1948 <a href="#p_over">OVER</a>,\r
1949 <a href="#p_state">STATE</a>,\r
1950 <a href="#p_swap">SWAP</a>,\r
1951 <a href="#p_tfa2cfa">TFA&gt;CFA</a>,\r
1952 <a href="#p_then">THEN</a>,\r
1953 <a href="#p_dodoes">doDOES</a>,\r
1954 as well as  <a href="#p_execute">EXECUTE</a>\r
1955 about the range of "doer" assignments and their meanings.</p></div>\r
1956 <div style="text-align:center">\r
1957 _______________________________________________________\r
1958 </div>\r
1959 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>\r
1960 </div>\r
1961 <div class="sect2">\r
1962 <h3 id="_word_dofasm">Word: doFASM</h3>\r
1963 <div class="literalblock">\r
1964 <div class="content">\r
1965 <pre><code>Data stack: ( -- a )</code></pre>\r
1966 </div></div>\r
1967 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the\r
1968 execution semantics for assembly code content.</p></div>\r
1969 <div style="text-align:center">\r
1970 _______________________________________________________\r
1971 </div>\r
1972 <div class="paragraph"><p><a id="p_doforth"></a></p></div>\r
1973 </div>\r
1974 <div class="sect2">\r
1975 <h3 id="_word_doforth">Word: doFORTH</h3>\r
1976 <div class="literalblock">\r
1977 <div class="content">\r
1978 <pre><code>Data stack: ( -- a )</code></pre>\r
1979 </div></div>\r
1980 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the\r
1981 RRQFORTH execution semantics.</p></div>\r
1982 <div style="text-align:center">\r
1983 _______________________________________________________\r
1984 </div>\r
1985 <div class="paragraph"><p><a id="p_dostring"></a></p></div>\r
1986 </div>\r
1987 <div class="sect2">\r
1988 <h3 id="_word_dostring">Word: doSTRING</h3>\r
1989 <div class="literalblock">\r
1990 <div class="content">\r
1991 <pre><code>Data stack: ( -- a )</code></pre>\r
1992 </div></div>\r
1993 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the\r
1994 execution semantics for assembly code implemented words. In those\r
1995 cases the execution leads to the word content.</p></div>\r
1996 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is\r
1997 as follows:</p></div>\r
1998 <div class="listingblock">\r
1999 <div class="content">\r
2000 <pre><code>    rax = cfa* of word to execute\r
2001     rsi = cell* in the calling definition, after calling cell\r
2002     rsp = data stack pointer\r
2003     rbp = return stack pointer</code></pre>\r
2004 </div></div>\r
2005 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>\r
2006 and <code>rbp</code> are used according to their roles.</p></div>\r
2007 <div style="text-align:center">\r
2008 _______________________________________________________\r
2009 </div>\r
2010 <div class="paragraph"><p><a id="p_dot"></a></p></div>\r
2011 </div>\r
2012 <div class="sect2">\r
2013 <h3 id="_word_6">Word: .</h3>\r
2014 <div class="literalblock">\r
2015 <div class="content">\r
2016 <pre><code>Data stack: ( v -- )</code></pre>\r
2017 </div></div>\r
2018 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using\r
2019 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or\r
2020 <a href="#p_hex">HEX</a>).</p></div>\r
2021 <div style="text-align:center">\r
2022 _______________________________________________________\r
2023 </div>\r
2024 <div class="paragraph"><p><a id="p_dot_temp"></a></p></div>\r
2025 </div>\r
2026 <div class="sect2">\r
2027 <h3 id="_word_temp">Word: .TEMP</h3>\r
2028 <div class="literalblock">\r
2029 <div class="content">\r
2030 <pre><code>Data stack: ( v -- char* n )</code></pre>\r
2031 </div></div>\r
2032 <div class="paragraph"><p>".TEMP" is a function word that renders a cell value as an integer\r
2033 using the current <a href="#p_base">BASE</a>, which is either\r
2034 <a href="#p_decimal">DECIMAL</a> or <a href="#p_hex">HEX</a>. In <a href="#p_decimal">DECIMAL</a>\r
2035 <a href="#p_base">BASE</a>, a negative value is rendered as such with a leading\r
2036 minus sign, whereas <a href="#p_hex">HEX</a> <a href="#p_base">BASE</a> rendering is\r
2037 unsigned.</p></div>\r
2038 <div style="text-align:center">\r
2039 _______________________________________________________\r
2040 </div>\r
2041 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>\r
2042 </div>\r
2043 <div class="sect2">\r
2044 <h3 id="_word_7">Word: "</h3>\r
2045 <div class="literalblock">\r
2046 <div class="content">\r
2047 <pre><code>data stack: ( -- char n )    Input stream: ...."</code></pre>\r
2048 </div></div>\r
2049 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream\r
2050 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the\r
2051 [n:char*] cell pair for that string.</p></div>\r
2052 <div style="text-align:center">\r
2053 _______________________________________________________\r
2054 </div>\r
2055 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>\r
2056 </div>\r
2057 <div class="sect2">\r
2058 <h3 id="_word_dovalue">Word: doVALUE</h3>\r
2059 <div class="literalblock">\r
2060 <div class="content">\r
2061 <pre><code>Data stack: ( -- a )</code></pre>\r
2062 </div></div>\r
2063 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the\r
2064 execution semantics for cell values, which are variables with a single\r
2065 64-bit cell holding the value.</p></div>\r
2066 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>\r
2067 <div class="literalblock">\r
2068 <div class="content">\r
2069 <pre><code>Resulting data stack: ( -- v )</code></pre>\r
2070 </div></div>\r
2071 <div style="text-align:center">\r
2072 _______________________________________________________\r
2073 </div>\r
2074 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>\r
2075 </div>\r
2076 <div class="sect2">\r
2077 <h3 id="_word_dovariable">Word: doVARIABLE</h3>\r
2078 <div class="literalblock">\r
2079 <div class="content">\r
2080 <pre><code>Data stack: ( -- a )</code></pre>\r
2081 </div></div>\r
2082 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of\r
2083 the execution semantics for "variables", which basically are markers\r
2084 into the heap for some number block of memory.</p></div>\r
2085 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>\r
2086 <div class="literalblock">\r
2087 <div class="content">\r
2088 <pre><code>Resulting data stack: ( -- a )</code></pre>\r
2089 </div></div>\r
2090 <div style="text-align:center">\r
2091 _______________________________________________________\r
2092 </div>\r
2093 <div class="paragraph"><p><a id="p_drop"></a></p></div>\r
2094 </div>\r
2095 <div class="sect2">\r
2096 <h3 id="_word_drop">Word: DROP</h3>\r
2097 <div class="literalblock">\r
2098 <div class="content">\r
2099 <pre><code>Data stack: ( v -- )</code></pre>\r
2100 </div></div>\r
2101 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>\r
2102 <div style="text-align:center">\r
2103 _______________________________________________________\r
2104 </div>\r
2105 <div class="paragraph"><p><a id="p_dup"></a></p></div>\r
2106 </div>\r
2107 <div class="sect2">\r
2108 <h3 id="_word_dup">Word: DUP</h3>\r
2109 <div class="literalblock">\r
2110 <div class="content">\r
2111 <pre><code>Data stack: ( v -- v v )</code></pre>\r
2112 </div></div>\r
2113 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>\r
2114 <div style="text-align:center">\r
2115 _______________________________________________________\r
2116 </div>\r
2117 <div class="paragraph"><p><a id="p_else"></a></p></div>\r
2118 </div>\r
2119 <div class="sect2">\r
2120 <h3 id="_word_else">Word: ELSE</h3>\r
2121 <div class="literalblock">\r
2122 <div class="content">\r
2123 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>\r
2124 </div></div>\r
2125 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with\r
2126 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution\r
2127 control. ELSE lays out an unresolved unconditional branch as an ending\r
2128 for the "then-part" of the structured statement, and it then performs\r
2129 the branch resolution for the "else-part". To that end it replaces the\r
2130 stacked address which pin-points the foot address the branch offset to\r
2131 resolve, so that at execution time there is an appropriate conditional\r
2132 branch past the "then-part" and the "else-part" of the "structured\r
2133 statement".</p></div>\r
2134 <div style="text-align:center">\r
2135 _______________________________________________________\r
2136 </div>\r
2137 <div class="paragraph"><p><a id="p_emit"></a></p></div>\r
2138 </div>\r
2139 <div class="sect2">\r
2140 <h3 id="_word_emit">Word: EMIT</h3>\r
2141 <div class="literalblock">\r
2142 <div class="content">\r
2143 <pre><code>Data stack: ( c -- )</code></pre>\r
2144 </div></div>\r
2145 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to\r
2146 standard output (file descriptor 1). The character is the least\r
2147 significant byte of the top cell.</p></div>\r
2148 <div style="text-align:center">\r
2149 _______________________________________________________\r
2150 </div>\r
2151 <div class="paragraph"><p><a id="p_end"></a></p></div>\r
2152 </div>\r
2153 <div class="sect2">\r
2154 <h3 id="_word_end">Word: END</h3>\r
2155 <div class="literalblock">\r
2156 <div class="content">\r
2157 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>\r
2158 </div></div>\r
2159 <div class="paragraph"><p>"END" is an immediate function word that is used together with\r
2160 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to\r
2161 implement structured execution control. END processes the data stack\r
2162 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the\r
2163 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>\r
2164 <div style="text-align:center">\r
2165 _______________________________________________________\r
2166 </div>\r
2167 <div class="paragraph"><p><a id="p_equal"></a></p></div>\r
2168 </div>\r
2169 <div class="sect2">\r
2170 <h3 id="_word_8">Word: =</h3>\r
2171 <div class="literalblock">\r
2172 <div class="content">\r
2173 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
2174 </div></div>\r
2175 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the\r
2176 values are equal, and 0 otherwise.</p></div>\r
2177 <div style="text-align:center">\r
2178 _______________________________________________________\r
2179 </div>\r
2180 <div class="paragraph"><p><a id="p_erase"></a></p></div>\r
2181 </div>\r
2182 <div class="sect2">\r
2183 <h3 id="_word_erase">Word: ERASE</h3>\r
2184 <div class="literalblock">\r
2185 <div class="content">\r
2186 <pre><code>Data stack: ( a n -- )</code></pre>\r
2187 </div></div>\r
2188 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>\r
2189 <div style="text-align:center">\r
2190 _______________________________________________________\r
2191 </div>\r
2192 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>\r
2193 </div>\r
2194 <div class="sect2">\r
2195 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>\r
2196 <div class="literalblock">\r
2197 <div class="content">\r
2198 <pre><code>Data stack: ( stream -- ??? 0/1 )     Input stream: ......</code></pre>\r
2199 </div></div>\r
2200 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by\r
2201 whitespace from the stream until it discovers an unknown word, or the\r
2202 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are\r
2203 either executed or compiled, and all ther stack and heap effects are\r
2204 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the\r
2205 stack to respectively indicate that the last word was unkown, i.e. not\r
2206 found (<a href="#p_find">FIND</a>) in the current word list\r
2207 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a\r
2208 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>\r
2209 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known\r
2210 words that are parsed into cell values. If interpreting, then the\r
2211 value is left on the stack. If compiling, then the value is added to\r
2212 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done\r
2213 so as to make that value be push to the data stack upon a later\r
2214 execution.</p></div>\r
2215 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a\r
2216 minus sign.</p></div>\r
2217 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its\r
2218 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word\r
2219 or not, and whether the state at the time of execution indicates\r
2220 "compiling" of "interpreting". Immediate words are executed in both\r
2221 interpreting and compiling state, while other words have their CFA get\r
2222 added to the heap so as to gain their execution effect upon a later\r
2223 execution.</p></div>\r
2224 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return\r
2225 stack while reading, parsing and executing.</p></div>\r
2226 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds\r
2227 the [n:chars] reference of the offending word in the stream buffer.</p></div>\r
2228 <div style="text-align:center">\r
2229 _______________________________________________________\r
2230 </div>\r
2231 <div class="paragraph"><p><a id="p_execute"></a></p></div>\r
2232 </div>\r
2233 <div class="sect2">\r
2234 <h3 id="_word_execute">Word: EXECUTE</h3>\r
2235 <div class="literalblock">\r
2236 <div class="content">\r
2237 <pre><code>Data stack: ( cfa -- )</code></pre>\r
2238 </div></div>\r
2239 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the\r
2240 indicated "Code Field Address", which typically is the CFA of an\r
2241 RRQFORTH word with the CFA cell containing a jump address for the code\r
2242 that implements the execution semnatics of the word.</p></div>\r
2243 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>\r
2244 <div class="ulist"><ul>\r
2245 <li>\r
2246 <p>\r
2247 assembler implemented words constitute their own execution\r
2248    semantics;\r
2249 </p>\r
2250 </li>\r
2251 <li>\r
2252 <p>\r
2253 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word\r
2254    content as a succession of cells that hold the cfa pointers for the\r
2255    words that make of the definition. As is customary in FORTH\r
2256    machines, the advance through that succession is provided by each\r
2257    word code ending making an explicit jump to its successor. The\r
2258    <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking\r
2259    the nesting of FORTH executions by saving the "addresses" of the\r
2260    successor cells.\r
2261 </p>\r
2262 </li>\r
2263 <li>\r
2264 <p>\r
2265 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH\r
2266    execution somewhere within a definition rather than at the\r
2267    beginning.\r
2268 </p>\r
2269 </li>\r
2270 <li>\r
2271 <p>\r
2272 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement\r
2273    different common ways of using word content other the as FORTH\r
2274    definitions.\r
2275 </p>\r
2276 </li>\r
2277 </ul></div>\r
2278 <div style="text-align:center">\r
2279 _______________________________________________________\r
2280 </div>\r
2281 <div class="paragraph"><p><a id="p_exit"></a></p></div>\r
2282 </div>\r
2283 <div class="sect2">\r
2284 <h3 id="_word_exit">Word: EXIT</h3>\r
2285 <div class="literalblock">\r
2286 <div class="content">\r
2287 <pre><code>Data stack: ( v -- )</code></pre>\r
2288 </div></div>\r
2289 <div class="paragraph"><p>"EXIT" is a function word that terminates the <code>rrqforth</code> process\r
2290 immediately with the given exit code.</p></div>\r
2291 <div style="text-align:center">\r
2292 _______________________________________________________\r
2293 </div>\r
2294 <div class="paragraph"><p><a id="p_false"></a></p></div>\r
2295 </div>\r
2296 <div class="sect2">\r
2297 <h3 id="_word_false">Word: FALSE</h3>\r
2298 <div class="literalblock">\r
2299 <div class="content">\r
2300 <pre><code>Data stack: ( -- 0 )</code></pre>\r
2301 </div></div>\r
2302 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>\r
2303 <div style="text-align:center">\r
2304 _______________________________________________________\r
2305 </div>\r
2306 <div class="paragraph"><p><a id="p_fdemit"></a></p></div>\r
2307 </div>\r
2308 <div class="sect2">\r
2309 <h3 id="_word_fdemit">Word: FDEMIT</h3>\r
2310 <div class="literalblock">\r
2311 <div class="content">\r
2312 <pre><code>Data stack: ( c fd -- )</code></pre>\r
2313 </div></div>\r
2314 <div class="paragraph"><p>"FDEMIT" is a function word that puts the given character code to the\r
2315 given file descriptor. The character is the least significant byte of\r
2316 the data stack cell.</p></div>\r
2317 <div style="text-align:center">\r
2318 _______________________________________________________\r
2319 </div>\r
2320 <div class="paragraph"><p><a id="p_fdtell"></a></p></div>\r
2321 </div>\r
2322 <div class="sect2">\r
2323 <h3 id="_word_fdtell">Word: FDTELL</h3>\r
2324 <div class="literalblock">\r
2325 <div class="content">\r
2326 <pre><code>Data stack: ( char* n fd -- )</code></pre>\r
2327 </div></div>\r
2328 <div class="paragraph"><p>"FDTELL" is a function word that prints a string to the given file\r
2329 descriptor.</p></div>\r
2330 <div style="text-align:center">\r
2331 _______________________________________________________\r
2332 </div>\r
2333 <div class="paragraph"><p><a id="p_find"></a></p></div>\r
2334 </div>\r
2335 <div class="sect2">\r
2336 <h3 id="_word_find">Word: FIND</h3>\r
2337 <div class="literalblock">\r
2338 <div class="content">\r
2339 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>\r
2340 </div></div>\r
2341 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search\r
2342 path for the given [n:char*] word, and returns the TFA of the matching\r
2343 word if any. Otherwise FIND preserves the initial data stack but adds\r
2344 0 to it.</p></div>\r
2345 <div class="paragraph"><p>The word is sought starting with the\r
2346 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first\r
2347 occurence of a match. If not found, the search continues with the\r
2348 subsequent word list, and so on.</p></div>\r
2349 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the\r
2350 [n:char*] double cell string pointer and pushing (only) the TFA of the\r
2351 matching word instead.</p></div>\r
2352 <div style="text-align:center">\r
2353 _______________________________________________________\r
2354 </div>\r
2355 <div class="paragraph"><p><a id="p_forth"></a></p></div>\r
2356 </div>\r
2357 <div class="sect2">\r
2358 <h3 id="_word_forth">Word: FORTH</h3>\r
2359 <div class="literalblock">\r
2360 <div class="content">\r
2361 <pre><code>data stack: ( -- a )</code></pre>\r
2362 </div></div>\r
2363 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not\r
2364 have any subsequent word list.</p></div>\r
2365 <div style="text-align:center">\r
2366 _______________________________________________________\r
2367 </div>\r
2368 <div class="paragraph"><p><a id="p_get"></a></p></div>\r
2369 </div>\r
2370 <div class="sect2">\r
2371 <h3 id="_word_9">Word: @</h3>\r
2372 <div class="literalblock">\r
2373 <div class="content">\r
2374 <pre><code>Data stack: ( a -- v )</code></pre>\r
2375 </div></div>\r
2376 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>\r
2377 <div style="text-align:center">\r
2378 _______________________________________________________\r
2379 </div>\r
2380 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>\r
2381 </div>\r
2382 <div class="sect2">\r
2383 <h3 id="_word_n">Word: @n--</h3>\r
2384 <div class="literalblock">\r
2385 <div class="content">\r
2386 <pre><code>Data stack: ( a n -- v )</code></pre>\r
2387 </div></div>\r
2388 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,\r
2389 then decrements the cell at that address by n.</p></div>\r
2390 <div class="exampleblock">\r
2391 <div class="content">\r
2392 <div class="sidebarblock">\r
2393 <div class="content">\r
2394 <div class="title">Defintion concept for @n++</div>\r
2395 <div class="paragraph"><p>: @n++ OVER @ DUP ROT - ROT ! ;</p></div>\r
2396 </div></div>\r
2397 </div></div>\r
2398 <div style="text-align:center">\r
2399 _______________________________________________________\r
2400 </div>\r
2401 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>\r
2402 </div>\r
2403 <div class="sect2">\r
2404 <h3 id="_word_n_2">Word: @n++</h3>\r
2405 <div class="literalblock">\r
2406 <div class="content">\r
2407 <pre><code>Data stack: ( a n -- v )</code></pre>\r
2408 </div></div>\r
2409 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,\r
2410 then increments the cell at that address by n.</p></div>\r
2411 <div class="exampleblock">\r
2412 <div class="content">\r
2413 <div class="sidebarblock">\r
2414 <div class="content">\r
2415 <div class="title">Defintion concept for @n++</div>\r
2416 <div class="paragraph"><p>( a n&#8201;&#8212;&#8201;v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>\r
2417 </div></div>\r
2418 </div></div>\r
2419 <div style="text-align:center">\r
2420 _______________________________________________________\r
2421 </div>\r
2422 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>\r
2423 </div>\r
2424 <div class="sect2">\r
2425 <h3 id="_word_gt">Word: &gt;=</h3>\r
2426 <div class="literalblock">\r
2427 <div class="content">\r
2428 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
2429 </div></div>\r
2430 <div class="paragraph"><p>"&gt;=" is a function word that replaces a pair of values with -1 if the\r
2431 first, v1, is greater than or equal to the second, v1, otherwise 0. To\r
2432 that end, the values are 64-bit signed integers.</p></div>\r
2433 <div style="text-align:center">\r
2434 _______________________________________________________\r
2435 </div>\r
2436 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>\r
2437 </div>\r
2438 <div class="sect2">\r
2439 <h3 id="_word_gt_2">Word: &gt;</h3>\r
2440 <div class="literalblock">\r
2441 <div class="content">\r
2442 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
2443 </div></div>\r
2444 <div class="paragraph"><p>"&gt;" is a function word that replaces a pair of values with -1 if the\r
2445 first, v1, is greater than the second, v1, otherwise 0. To that end,\r
2446 the values are 64-bit signed integers.</p></div>\r
2447 <div style="text-align:center">\r
2448 _______________________________________________________\r
2449 </div>\r
2450 <div class="paragraph"><p><a id="p_gtR"></a></p></div>\r
2451 </div>\r
2452 <div class="sect2">\r
2453 <h3 id="_word_gt_r">Word: &gt;R</h3>\r
2454 <div class="literalblock">\r
2455 <div class="content">\r
2456 <pre><code>Data stack: ( v -- )   Return stack: ( -- v )</code></pre>\r
2457 </div></div>\r
2458 <div class="paragraph"><p>"&gt;R" is a function word that "moves" the top data stack value onto the\r
2459 return stack.</p></div>\r
2460 <div style="text-align:center">\r
2461 _______________________________________________________\r
2462 </div>\r
2463 <div class="paragraph"><p><a id="p_here"></a></p></div>\r
2464 </div>\r
2465 <div class="sect2">\r
2466 <h3 id="_word_here">Word: HERE</h3>\r
2467 <div class="literalblock">\r
2468 <div class="content">\r
2469 <pre><code>Data stack: ( -- a )</code></pre>\r
2470 </div></div>\r
2471 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free\r
2472 allocation space. It get updated by all words that allocate memory.</p></div>\r
2473 <div class="exampleblock">\r
2474 <div class="content">\r
2475 <div class="sidebarblock">\r
2476 <div class="content">\r
2477 <div class="title">allocate 1024 bytes on the heap</div>\r
2478 <div class="paragraph"><p>1024 HEAP @ + HEAP !</p></div>\r
2479 </div></div>\r
2480 </div></div>\r
2481 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>\r
2482 <div style="text-align:center">\r
2483 _______________________________________________________\r
2484 </div>\r
2485 <div class="paragraph"><p><a id="p_hex"></a></p></div>\r
2486 </div>\r
2487 <div class="sect2">\r
2488 <h3 id="_word_hex">Word: HEX</h3>\r
2489 <div class="literalblock">\r
2490 <div class="content">\r
2491 <pre><code>Data stack: ( -- )</code></pre>\r
2492 </div></div>\r
2493 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses\r
2494 letters a-f as additional digits. (Uppercase letter are also accepted\r
2495 on input).</p></div>\r
2496 <div class="exampleblock">\r
2497 <div class="content">\r
2498 <div class="sidebarblock">\r
2499 <div class="content">\r
2500 <div class="title">Definition concept for HEX</div>\r
2501 <div class="paragraph"><p>: HEX 16 BASE ! ;</p></div>\r
2502 </div></div>\r
2503 </div></div>\r
2504 <div style="text-align:center">\r
2505 _______________________________________________________\r
2506 </div>\r
2507 <div class="paragraph"><p><a id="p_if"></a></p></div>\r
2508 </div>\r
2509 <div class="sect2">\r
2510 <h3 id="_word_if">Word: IF</h3>\r
2511 <div class="literalblock">\r
2512 <div class="content">\r
2513 <pre><code>Data stack: Compiling: ( -- a )</code></pre>\r
2514 </div></div>\r
2515 <div class="paragraph"><p>"IF" is an immediate function word that is used together with\r
2516 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution\r
2517 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction\r
2518 with an unresolved branch offset, and places the address for resolving\r
2519 this instruction on the datastack. This address will then be resolved\r
2520 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so\r
2521 that at execution time there is an appropriate conditional branch past\r
2522 the "then-part" of the "structured statement".</p></div>\r
2523 <div style="text-align:center">\r
2524 _______________________________________________________\r
2525 </div>\r
2526 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>\r
2527 </div>\r
2528 <div class="sect2">\r
2529 <h3 id="_word_ifagain">Word: IFAGAIN</h3>\r
2530 <div class="literalblock">\r
2531 <div class="content">\r
2532 <pre><code>Data stack: Compiling: ( -- a )</code></pre>\r
2533 </div></div>\r
2534 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with\r
2535 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement\r
2536 structured execution control. IFAGAIN scans the datastack for the\r
2537 nearest preceding BEGIN marker and lays out a branch from this point\r
2538 the beginning of the block during execution.</p></div>\r
2539 <div style="text-align:center">\r
2540 _______________________________________________________\r
2541 </div>\r
2542 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>\r
2543 </div>\r
2544 <div class="sect2">\r
2545 <h3 id="_word_ifbreak">Word: IFBREAK</h3>\r
2546 <div class="literalblock">\r
2547 <div class="content">\r
2548 <pre><code>Data stack: Compiling: ( -- a )</code></pre>\r
2549 </div></div>\r
2550 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with\r
2551 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to\r
2552 implement structured execution control. IFBREAK simply places the\r
2553 address for resolving branches from this point the end of the block\r
2554 during execution.</p></div>\r
2555 <div style="text-align:center">\r
2556 _______________________________________________________\r
2557 </div>\r
2558 <div class="paragraph"><p><a id="p_immediate"></a></p></div>\r
2559 </div>\r
2560 <div class="sect2">\r
2561 <h3 id="_word_immediate">Word: IMMEDIATE</h3>\r
2562 <div class="literalblock">\r
2563 <div class="content">\r
2564 <pre><code>Data stack: ( -- )</code></pre>\r
2565 </div></div>\r
2566 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of\r
2567 the most recent word to 1, thereby making that word an immediate word.</p></div>\r
2568 <div class="exampleblock">\r
2569 <div class="content">\r
2570 <div class="sidebarblock">\r
2571 <div class="content">\r
2572 <div class="title">Definition concept for IMMEDIATE</div>\r
2573 <div class="paragraph"><p>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</p></div>\r
2574 </div></div>\r
2575 </div></div>\r
2576 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,\r
2577 <a href="#p_get">@</a>, <a href="#p_plus">+</a>, <a href="#p_put">!</a>, and <a href="#p_semicolon;">[p_semicolon;]</a>.</p></div>\r
2578 <div style="text-align:center">\r
2579 _______________________________________________________\r
2580 </div>\r
2581 <div class="paragraph"><p><a id="p_input"></a></p></div>\r
2582 </div>\r
2583 <div class="sect2">\r
2584 <h3 id="_word_input">Word: INPUT</h3>\r
2585 <div class="literalblock">\r
2586 <div class="content">\r
2587 <pre><code>Data stack: ( -- a )</code></pre>\r
2588 </div></div>\r
2589 <div class="paragraph"><p>"INPUT" is a variable word for the input stream buffer used by\r
2590 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>.</p></div>\r
2591 <div style="text-align:center">\r
2592 _______________________________________________________\r
2593 </div>\r
2594 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>\r
2595 </div>\r
2596 <div class="sect2">\r
2597 <h3 id="_word_10">Word: [</h3>\r
2598 <div class="literalblock">\r
2599 <div class="content">\r
2600 <pre><code>Data stack: ( -- )</code></pre>\r
2601 </div></div>\r
2602 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation\r
2603 mode to be intepreting. In this mode, words are executed immediately\r
2604 after parsing, by invoking their "doer".</p></div>\r
2605 <div class="exampleblock">\r
2606 <div class="content">\r
2607 <div class="sidebarblock">\r
2608 <div class="content">\r
2609 <div class="title">Definition concept for [</div>\r
2610 <div class="paragraph"><p>: [ IMMEDIATE 0 STATE ! ;</p></div>\r
2611 </div></div>\r
2612 </div></div>\r
2613 <div style="text-align:center">\r
2614 _______________________________________________________\r
2615 </div>\r
2616 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>\r
2617 </div>\r
2618 <div class="sect2">\r
2619 <h3 id="_word_lt">Word: &lt;=</h3>\r
2620 <div class="literalblock">\r
2621 <div class="content">\r
2622 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
2623 </div></div>\r
2624 <div class="paragraph"><p>"&lt;=" is a function word that replaces a pair of values with -1 if the\r
2625 first, v1, is less than or equal to the second, v1, otherwise 0. To\r
2626 that end, the values are 64-bit signed integers.</p></div>\r
2627 <div style="text-align:center">\r
2628 _______________________________________________________\r
2629 </div>\r
2630 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>\r
2631 </div>\r
2632 <div class="sect2">\r
2633 <h3 id="_word_lt_2">Word: &lt;</h3>\r
2634 <div class="literalblock">\r
2635 <div class="content">\r
2636 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
2637 </div></div>\r
2638 <div class="paragraph"><p>"&lt;" is a function word that replaces a pair of values with -1 if the\r
2639 first, v1, is less than the second, v1, otherwise 0. To that end, the\r
2640 values are 64-bit signed integers.</p></div>\r
2641 <div style="text-align:center">\r
2642 _______________________________________________________\r
2643 </div>\r
2644 <div class="paragraph"><p><a id="p_literal"></a></p></div>\r
2645 </div>\r
2646 <div class="sect2">\r
2647 <h3 id="_word_lit">Word: LIT</h3>\r
2648 <div class="literalblock">\r
2649 <div class="content">\r
2650 <pre><code>Data stack: ( -- v )</code></pre>\r
2651 </div></div>\r
2652 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves\r
2653 excution past that. The literal value is thus layed out as if a\r
2654 subsequent CFA pointer in the containing definition, and the LIT\r
2655 execution will make the execution skip past that and instead contine\r
2656 with the CFA pointer following the value.</p></div>\r
2657 <div class="paragraph"><p>It&#8217;s not a good idea to use "LIT" interactively.</p></div>\r
2658 <div class="exampleblock">\r
2659 <div class="content">\r
2660 <div class="sidebarblock">\r
2661 <div class="content">\r
2662 <div class="title">Definition concept for LIT</div>\r
2663 <div class="paragraph"><p>: LIT R&gt; DUP 8 + &gt;R @ ;</p></div>\r
2664 </div></div>\r
2665 </div></div>\r
2666 <div style="text-align:center">\r
2667 _______________________________________________________\r
2668 </div>\r
2669 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>\r
2670 </div>\r
2671 <div class="sect2">\r
2672 <h3 id="_word_lit_string">Word: LIT-STRING</h3>\r
2673 <div class="literalblock">\r
2674 <div class="content">\r
2675 <pre><code>Data stack: ( -- chars* n )</code></pre>\r
2676 </div></div>\r
2677 <div class="paragraph"><p>"LIT-STRING" is a function word that pushes the char* and length n of\r
2678 a subsequent inline string, then advances execution to continue after\r
2679 the string. This is similar to <a href="#p_lit">LIT</a> but for a block literal.</p></div>\r
2680 <div class="paragraph"><p>Note that the inlined byte count includes the terminating NUL byte.</p></div>\r
2681 <div class="exampleblock">\r
2682 <div class="content">\r
2683 <div class="sidebarblock">\r
2684 <div class="content">\r
2685 <div class="title">Definition concept for LIT-STRING</div>\r
2686 <div class="paragraph"><p>: LIT-STRING  R@ DUP @ 8 +  R@ @  2DUP + R&gt; + &gt;R  1 - ;</p></div>\r
2687 </div></div>\r
2688 </div></div>\r
2689 <div style="text-align:center">\r
2690 _______________________________________________________\r
2691 </div>\r
2692 <div class="paragraph"><p><a id="p_literal_string_compile"></a></p></div>\r
2693 </div>\r
2694 <div class="sect2">\r
2695 <h3 id="_word_s">Word: S"</h3>\r
2696 <div class="literalblock">\r
2697 <div class="content">\r
2698 <pre><code>Data stack: ( -- )  Input stream: " chars"</code></pre>\r
2699 </div></div>\r
2700 <div class="paragraph"><p>"S"" is an immediate function word that compiles the subseqent\r
2701 characters up to terminating double-quote into the current definition,\r
2702 preceded by a <a href="#p_literal_string">LIT-STRING</a> cell, and the count of\r
2703 bytes scanned. The inline text includes a terminating NUL character\r
2704 which also is included in the inlined count.</p></div>\r
2705 <div class="paragraph"><p>Note that "S"" uses <a href="#p_double_quote">"</a> for reading the string.</p></div>\r
2706 <div style="text-align:center">\r
2707 _______________________________________________________\r
2708 </div>\r
2709 <div class="paragraph"><p><a id="p_load_buffer_size"></a></p></div>\r
2710 </div>\r
2711 <div class="sect2">\r
2712 <h3 id="_word_load_buffer_size">Word: LOAD-BUFFER-SIZE</h3>\r
2713 <div class="literalblock">\r
2714 <div class="content">\r
2715 <pre><code>data stack: ( -- a )</code></pre>\r
2716 </div></div>\r
2717 <div class="paragraph"><p>"LOAD-BUFFER-SIZE" is a variable word telling the buffer size in bytes\r
2718 that <a href="#p_load_file">LOAD-FILE</a> should use.</p></div>\r
2719 <div style="text-align:center">\r
2720 _______________________________________________________\r
2721 </div>\r
2722 <div class="paragraph"><p><a id="p_load_file"></a></p></div>\r
2723 </div>\r
2724 <div class="sect2">\r
2725 <h3 id="_word_load_file">Word: LOAD-FILE</h3>\r
2726 <div class="literalblock">\r
2727 <div class="content">\r
2728 <pre><code>data stack: ( chaz* -- * 0/1 )</code></pre>\r
2729 </div></div>\r
2730 <div class="paragraph"><p>"LOAD-FILE" is a function word that evaluates a text file. It opens a\r
2731 file via <a href="#p_open_file">OPEN-FILE</a> and sets up a stream with a\r
2732 buffer of <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a> bytes for\r
2733 reading it. The stream is passed to\r
2734 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing its words. Upon\r
2735 its return the file is closed and the stream memory is reclaimed, and\r
2736 then the function returns whatever\r
2737 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> returns.</p></div>\r
2738 <div style="text-align:center">\r
2739 _______________________________________________________\r
2740 </div>\r
2741 <div class="paragraph"><p><a id="p_lparen"></a></p></div>\r
2742 </div>\r
2743 <div class="sect2">\r
2744 <h3 id="_word_11">Word: (</h3>\r
2745 <div class="literalblock">\r
2746 <div class="content">\r
2747 <pre><code>Data stack: ( -- )</code></pre>\r
2748 </div></div>\r
2749 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words\r
2750 until the next right parenthesis, or the end of the stream. This is\r
2751 used for comments in RRQFORTH code.</p></div>\r
2752 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have\r
2753 whitespace before and after it.</p></div>\r
2754 <div style="text-align:center">\r
2755 _______________________________________________________\r
2756 </div>\r
2757 <div class="paragraph"><p><a id="p_malloc"></a></p></div>\r
2758 </div>\r
2759 <div class="sect2">\r
2760 <h3 id="_word_malloc">Word: MALLOC</h3>\r
2761 <div class="literalblock">\r
2762 <div class="content">\r
2763 <pre><code>Data stack: ( n -- a )</code></pre>\r
2764 </div></div>\r
2765 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n\r
2766 bytes and returns the lowest address of the allocated block.</p></div>\r
2767 <div class="paragraph"><p>Note that this makes new page allocations for the process from the\r
2768 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>\r
2769 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC\r
2770 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man\r
2771 page" of mmap for details.</p></div>\r
2772 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>\r
2773 <div style="text-align:center">\r
2774 _______________________________________________________\r
2775 </div>\r
2776 <div class="paragraph"><p><a id="p_minus"></a></p></div>\r
2777 </div>\r
2778 <div class="sect2">\r
2779 <h3 id="_word_12">Word: -</h3>\r
2780 <div class="literalblock">\r
2781 <div class="content">\r
2782 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
2783 </div></div>\r
2784 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the\r
2785 result of reducing the first, v1, with the second, v2. To that end,\r
2786 the values are 64-bit signed integers.</p></div>\r
2787 <div style="text-align:center">\r
2788 _______________________________________________________\r
2789 </div>\r
2790 <div class="paragraph"><p><a id="p_mult"></a></p></div>\r
2791 </div>\r
2792 <div class="sect2">\r
2793 <h3 id="_word_13">Word: *</h3>\r
2794 <div class="literalblock">\r
2795 <div class="content">\r
2796 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
2797 </div></div>\r
2798 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result\r
2799 of multiplying them. To that end, the values are 64-bit signed\r
2800 integers, and clipping the result to the least signifcant 64 bits.</p></div>\r
2801 <div style="text-align:center">\r
2802 _______________________________________________________\r
2803 </div>\r
2804 <div class="paragraph"><p><a id="p_negate"></a></p></div>\r
2805 </div>\r
2806 <div class="sect2">\r
2807 <h3 id="_word_negate">Word: NEGATE</h3>\r
2808 <div class="literalblock">\r
2809 <div class="content">\r
2810 <pre><code>Data stack: ( v1 -- v2 )</code></pre>\r
2811 </div></div>\r
2812 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its\r
2813 2&#8217;s-complement negation. To that end, the values are 64-bit signed\r
2814 integers.</p></div>\r
2815 <div style="text-align:center">\r
2816 _______________________________________________________\r
2817 </div>\r
2818 <div class="paragraph"><p><a id="p_nip"></a></p></div>\r
2819 </div>\r
2820 <div class="sect2">\r
2821 <h3 id="_word_nip">Word: NIP</h3>\r
2822 <div class="literalblock">\r
2823 <div class="content">\r
2824 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>\r
2825 </div></div>\r
2826 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells\r
2827 on the data stack.</p></div>\r
2828 <div class="exampleblock">\r
2829 <div class="content">\r
2830 <div class="sidebarblock">\r
2831 <div class="content">\r
2832 <div class="title">Definition concept for NIP</div>\r
2833 <div class="paragraph"><p>: NIP SWAP DROP ;</p></div>\r
2834 </div></div>\r
2835 </div></div>\r
2836 <div style="text-align:center">\r
2837 _______________________________________________________\r
2838 </div>\r
2839 <div class="paragraph"><p><a id="p_nl"></a></p></div>\r
2840 </div>\r
2841 <div class="sect2">\r
2842 <h3 id="_word_nl">Word: NL</h3>\r
2843 <div class="literalblock">\r
2844 <div class="content">\r
2845 <pre><code>Data stack: ( -- v )</code></pre>\r
2846 </div></div>\r
2847 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>\r
2848 <div style="text-align:center">\r
2849 _______________________________________________________\r
2850 </div>\r
2851 <div class="paragraph"><p><a id="p_not"></a></p></div>\r
2852 </div>\r
2853 <div class="sect2">\r
2854 <h3 id="_word_not">Word: NOT</h3>\r
2855 <div class="literalblock">\r
2856 <div class="content">\r
2857 <pre><code>Data stack: ( v1 -- v2 )</code></pre>\r
2858 </div></div>\r
2859 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise\r
2860 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>\r
2861 <div class="paragraph"><p>Compare with &lt;&lt;p_0equal,0&#8658;&gt;.</p></div>\r
2862 <div style="text-align:center">\r
2863 _______________________________________________________\r
2864 </div>\r
2865 <div class="paragraph"><p><a id="p_number"></a></p></div>\r
2866 </div>\r
2867 <div class="sect2">\r
2868 <h3 id="_word_number">Word: NUMBER</h3>\r
2869 <div class="literalblock">\r
2870 <div class="content">\r
2871 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>\r
2872 </div></div>\r
2873 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using\r
2874 <a href="#p_base">BASE</a> as numerical base, then returns the result number and\r
2875 a 1 on top, or just a 0 if the word didn&#8217;t parse.</p></div>\r
2876 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in\r
2877 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>\r
2878 base, letters a-f or A-F for values 10-15. I.e. the normal positive or\r
2879 negative decimal integers or normal (positive only) hexadecimal\r
2880 integers.</p></div>\r
2881 <div style="text-align:center">\r
2882 _______________________________________________________\r
2883 </div>\r
2884 <div class="paragraph"><p><a id="p_open_file"></a></p></div>\r
2885 </div>\r
2886 <div class="sect2">\r
2887 <h3 id="_word_open_file">Word: OPEN-FILE</h3>\r
2888 <div class="literalblock">\r
2889 <div class="content">\r
2890 <pre><code>Data stack: ( chaz* -- fd )</code></pre>\r
2891 </div></div>\r
2892 <div class="paragraph"><p>"OPEN-FILE" is a function word that opens the file named by the zero\r
2893 terminated character string and returns the file descriptor, or if\r
2894 less than 0, the system call error code.</p></div>\r
2895 <div style="text-align:center">\r
2896 _______________________________________________________\r
2897 </div>\r
2898 <div class="paragraph"><p><a id="p_or"></a></p></div>\r
2899 </div>\r
2900 <div class="sect2">\r
2901 <h3 id="_word_or">Word: OR</h3>\r
2902 <div class="literalblock">\r
2903 <div class="content">\r
2904 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
2905 </div></div>\r
2906 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise\r
2907 disjunction; each bit is 1 if the corresponding bits of any operand\r
2908 is 1 and 0 if not.</p></div>\r
2909 <div style="text-align:center">\r
2910 _______________________________________________________\r
2911 </div>\r
2912 <div class="paragraph"><p><a id="p_over"></a></p></div>\r
2913 </div>\r
2914 <div class="sect2">\r
2915 <h3 id="_word_over">Word: OVER</h3>\r
2916 <div class="literalblock">\r
2917 <div class="content">\r
2918 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>\r
2919 </div></div>\r
2920 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on\r
2921 the data stack.</p></div>\r
2922 <div style="text-align:center">\r
2923 _______________________________________________________\r
2924 </div>\r
2925 <div class="paragraph"><p><a id="p_pad"></a></p></div>\r
2926 </div>\r
2927 <div class="sect2">\r
2928 <h3 id="_word_pad">Word: PAD</h3>\r
2929 <div class="literalblock">\r
2930 <div class="content">\r
2931 <pre><code>Data stack: ( -- a )</code></pre>\r
2932 </div></div>\r
2933 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by\r
2934 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>\r
2935 <div style="text-align:center">\r
2936 _______________________________________________________\r
2937 </div>\r
2938 <div class="paragraph"><p><a id="p_pick"></a></p></div>\r
2939 </div>\r
2940 <div class="sect2">\r
2941 <h3 id="_word_pick">Word: PICK</h3>\r
2942 <div class="literalblock">\r
2943 <div class="content">\r
2944 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>\r
2945 </div></div>\r
2946 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down\r
2947 from top onto the data stack. 0 indicates the top cell making it the\r
2948 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it\r
2949 the same as <a href="#p_over">OVER</a>.</p></div>\r
2950 <div style="text-align:center">\r
2951 _______________________________________________________\r
2952 </div>\r
2953 <div class="paragraph"><p><a id="p_plus"></a></p></div>\r
2954 </div>\r
2955 <div class="sect2">\r
2956 <h3 id="_word_43">Word: &#43;</h3>\r
2957 <div class="literalblock">\r
2958 <div class="content">\r
2959 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
2960 </div></div>\r
2961 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the\r
2962 result of adding them. To that end, the values are 64-bit signed\r
2963 integers.</p></div>\r
2964 <div style="text-align:center">\r
2965 _______________________________________________________\r
2966 </div>\r
2967 <div class="paragraph"><p><a id="p_program_version"></a></p></div>\r
2968 </div>\r
2969 <div class="sect2">\r
2970 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>\r
2971 <div class="literalblock">\r
2972 <div class="content">\r
2973 <pre><code>Data stack: ( -- char* length )</code></pre>\r
2974 </div></div>\r
2975 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>\r
2976 <div style="text-align:center">\r
2977 _______________________________________________________\r
2978 </div>\r
2979 <div class="paragraph"><p><a id="p_put"></a></p></div>\r
2980 </div>\r
2981 <div class="sect2">\r
2982 <h3 id="_word_14">Word: !</h3>\r
2983 <div class="literalblock">\r
2984 <div class="content">\r
2985 <pre><code>Data stack: ( v a -- )</code></pre>\r
2986 </div></div>\r
2987 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>\r
2988 <div style="text-align:center">\r
2989 _______________________________________________________\r
2990 </div>\r
2991 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>\r
2992 </div>\r
2993 <div class="sect2">\r
2994 <h3 id="_word_15">Word: !+</h3>\r
2995 <div class="literalblock">\r
2996 <div class="content">\r
2997 <pre><code>Data stack: ( a n -- )</code></pre>\r
2998 </div></div>\r
2999 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>\r
3000 <div class="exampleblock">\r
3001 <div class="content">\r
3002 <div class="sidebarblock">\r
3003 <div class="content">\r
3004 <div class="title">definition concept for !+</div>\r
3005 <div class="paragraph"><p>( a n&#8201;&#8212;&#8201;) : !+ OVER @ + SWAP ! ;</p></div>\r
3006 </div></div>\r
3007 </div></div>\r
3008 <div style="text-align:center">\r
3009 _______________________________________________________\r
3010 </div>\r
3011 <div class="paragraph"><p><a id="p_quit"></a></p></div>\r
3012 </div>\r
3013 <div class="sect2">\r
3014 <h3 id="_word_quit">Word: QUIT</h3>\r
3015 <div class="literalblock">\r
3016 <div class="content">\r
3017 <pre><code>Data stack: ??</code></pre>\r
3018 </div></div>\r
3019 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of\r
3020 RRQFORTH. First it resets the stacks to their original settings, and\r
3021 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and\r
3022 executing them.</p></div>\r
3023 <div style="text-align:center">\r
3024 _______________________________________________________\r
3025 </div>\r
3026 <div class="paragraph"><p><a id="p_quote"></a></p></div>\r
3027 </div>\r
3028 <div class="sect2">\r
3029 <h3 id="_word_16">Word: '</h3>\r
3030 <div class="literalblock">\r
3031 <div class="content">\r
3032 <pre><code>data stack: ( -- cfa )    Input stream: word</code></pre>\r
3033 </div></div>\r
3034 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next\r
3035 word on the input stream and pushes its cfa.</p></div>\r
3036 <div style="text-align:center">\r
3037 _______________________________________________________\r
3038 </div>\r
3039 <div class="paragraph"><p><a id="p_rbp"></a></p></div>\r
3040 </div>\r
3041 <div class="sect2">\r
3042 <h3 id="_word_rsp">Word: RSP</h3>\r
3043 <div class="literalblock">\r
3044 <div class="content">\r
3045 <pre><code>Data stack: ( -- a )</code></pre>\r
3046 </div></div>\r
3047 <div class="paragraph"><p>"RSP" is a function word that pushes the return stack pointer value\r
3048 onto the data stack.</p></div>\r
3049 <div style="text-align:center">\r
3050 _______________________________________________________\r
3051 </div>\r
3052 <div class="paragraph"><p><a id="p_rbpn"></a></p></div>\r
3053 </div>\r
3054 <div class="sect2">\r
3055 <h3 id="_word_r_n">Word: R[n]</h3>\r
3056 <div class="literalblock">\r
3057 <div class="content">\r
3058 <pre><code>Data stack: ( n -- a )</code></pre>\r
3059 </div></div>\r
3060 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell of\r
3061 the return stack onto the data stack.</p></div>\r
3062 <div class="exampleblock">\r
3063 <div class="content">\r
3064 <div class="sidebarblock">\r
3065 <div class="content">\r
3066 <div class="title">Defintion concept for R[n]</div>\r
3067 <div class="paragraph"><p>( n&#8201;&#8212;&#8201;a ) : R[n] 8 * RSP + ;</p></div>\r
3068 </div></div>\r
3069 </div></div>\r
3070 <div style="text-align:center">\r
3071 _______________________________________________________\r
3072 </div>\r
3073 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>\r
3074 </div>\r
3075 <div class="sect2">\r
3076 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>\r
3077 <div class="literalblock">\r
3078 <div class="content">\r
3079 <pre><code>Data stack: ( stream -- c )</code></pre>\r
3080 </div></div>\r
3081 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character\r
3082 from the given stream buffer, possibly refilling the buffer if it is\r
3083 backed by a file descriptor. The refill is done by a SYS_READ call\r
3084 when more characters are needed. The next character is pushed on the\r
3085 stack, unless the stream is exhausted in which case the -1 is pushed\r
3086 instead.</p></div>\r
3087 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>\r
3088 <div style="text-align:center">\r
3089 _______________________________________________________\r
3090 </div>\r
3091 <div class="paragraph"><p><a id="p_read_stream_line"></a></p></div>\r
3092 </div>\r
3093 <div class="sect2">\r
3094 <h3 id="_word_read_stream_line">Word: READ-STREAM-LINE</h3>\r
3095 <div class="literalblock">\r
3096 <div class="content">\r
3097 <pre><code>Data stack: ( stream -- n )</code></pre>\r
3098 </div></div>\r
3099 <div class="paragraph"><p>"READ-STREAM-LINE" is a function word that gets the next line from the\r
3100 given stream buffer into PAD and returns number of characters. If the\r
3101 stream is backed by a file descriptor, the stream buffer is refilled\r
3102 from there as needed, by a SYS_READ call when more characters are\r
3103 needed.</p></div>\r
3104 <div style="text-align:center">\r
3105 _______________________________________________________\r
3106 </div>\r
3107 <div class="paragraph"><p><a id="p_read_word"></a></p></div>\r
3108 </div>\r
3109 <div class="sect2">\r
3110 <h3 id="_word_read_word">Word: READ-WORD</h3>\r
3111 <div class="literalblock">\r
3112 <div class="content">\r
3113 <pre><code>Data stack: ( stream -- char* n )</code></pre>\r
3114 </div></div>\r
3115 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace\r
3116 separated word from the given stream and returns the [n:char*] duoble\r
3117 cell pointer for it. The characters of the word are copied to\r
3118 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>\r
3119 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>\r
3120 <div class="exampleblock">\r
3121 <div class="title">Special syntax 1: Whitespace</div>\r
3122 <div class="content">\r
3123 <div class="paragraph"><p>All character codes less or equal to 32 are regarded as "whitespace".</p></div>\r
3124 </div></div>\r
3125 <div class="exampleblock">\r
3126 <div class="title">Special syntax 2: Rest-of-line comment</div>\r
3127 <div class="content">\r
3128 <div class="paragraph"><p>The "#" character following whitespace starts a line comment and the\r
3129 rest of the line is ignored. Note that this is also recognised with\r
3130 <a href="#p_lparen">parethesis commenting</a>.</p></div>\r
3131 </div></div>\r
3132 <div style="text-align:center">\r
3133 _______________________________________________________\r
3134 </div>\r
3135 <div class="paragraph"><p><a id="p_realloc"></a></p></div>\r
3136 </div>\r
3137 <div class="sect2">\r
3138 <h3 id="_word_realloc">Word: REALLOC</h3>\r
3139 <div class="literalblock">\r
3140 <div class="content">\r
3141 <pre><code>Data stack: ( a m n -- a )</code></pre>\r
3142 </div></div>\r
3143 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a\r
3144 of size m to be size n bytes and returns the lowest address of the\r
3145 allocated block.</p></div>\r
3146 <div class="paragraph"><p>Note that this makes new page allocations for the process from the\r
3147 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>\r
3148 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>\r
3149 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>\r
3150 <div style="text-align:center">\r
3151 _______________________________________________________\r
3152 </div>\r
3153 <div class="paragraph"><p><a id="p_return"></a></p></div>\r
3154 </div>\r
3155 <div class="sect2">\r
3156 <h3 id="_word_return">Word: RETURN</h3>\r
3157 <div class="literalblock">\r
3158 <div class="content">\r
3159 <pre><code>Data stack: ( -- )</code></pre>\r
3160 </div></div>\r
3161 <div class="paragraph"><p>"RETURN" is a function word that implements the ending of a FORTH\r
3162 definition and make execution return to the next step in the calling\r
3163 definition.</p></div>\r
3164 <div style="text-align:center">\r
3165 _______________________________________________________\r
3166 </div>\r
3167 <div class="paragraph"><p>compile.asm:    WORD p_right_bracket,<em>]</em>,fasm</p></div>\r
3168 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>\r
3169 </div>\r
3170 <div class="sect2">\r
3171 <h3 id="_word_17">Word: ]</h3>\r
3172 <div class="literalblock">\r
3173 <div class="content">\r
3174 <pre><code>Data stack: ( -- )</code></pre>\r
3175 </div></div>\r
3176 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation\r
3177 mode to be compiling. In this mode words parsed into CFA pointers\r
3178 which are placed on the heap in the given order, unless the word is\r
3179 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An\r
3180 immediate word is executed immediately, and a number is parsed and\r
3181 left on the stack.</p></div>\r
3182 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the\r
3183 wordlist; i.e., the word list may contain definitions for numbers.</p></div>\r
3184 <div class="exampleblock">\r
3185 <div class="content">\r
3186 <div class="sidebarblock">\r
3187 <div class="content">\r
3188 <div class="title">Definition concept for ]</div>\r
3189 <div class="paragraph"><p>: ] 1 STATE ! ;</p></div>\r
3190 </div></div>\r
3191 </div></div>\r
3192 <div style="text-align:center">\r
3193 _______________________________________________________\r
3194 </div>\r
3195 <div class="paragraph"><p><a id="p_roll"></a></p></div>\r
3196 </div>\r
3197 <div class="sect2">\r
3198 <h3 id="_word_roll">Word: ROLL</h3>\r
3199 <div class="literalblock">\r
3200 <div class="content">\r
3201 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>\r
3202 </div></div>\r
3203 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down\r
3204 from top onto the data stack while discarding it. 0 indicates the top\r
3205 cell; 1 indicates the second top cell making it the same as\r
3206 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as\r
3207 <a href="#p_rot">ROT</a>.</p></div>\r
3208 <div style="text-align:center">\r
3209 _______________________________________________________\r
3210 </div>\r
3211 <div class="paragraph"><p><a id="p_rot"></a></p></div>\r
3212 </div>\r
3213 <div class="sect2">\r
3214 <h3 id="_word_rot">Word: ROT</h3>\r
3215 <div class="literalblock">\r
3216 <div class="content">\r
3217 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>\r
3218 </div></div>\r
3219 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells\r
3220 such that the third becomes the first while the second becomes third\r
3221 and the first becomes the second.</p></div>\r
3222 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>\r
3223 <div style="text-align:center">\r
3224 _______________________________________________________\r
3225 </div>\r
3226 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>\r
3227 </div>\r
3228 <div class="sect2">\r
3229 <h3 id="_word_18">Word: ;</h3>\r
3230 <div class="literalblock">\r
3231 <div class="content">\r
3232 <pre><code>Data stack: ( -- )</code></pre>\r
3233 </div></div>\r
3234 <div class="paragraph"><p>";" (semi-colon) is an immediate function word that ends a new forth\r
3235 definition by means of adding an <a href="#p_exit">EXIT</a> cell, then changing\r
3236 &lt;&lt;p_state,STATE&gt; to interpreting.</p></div>\r
3237 <div class="exampleblock">\r
3238 <div class="content">\r
3239 <div class="sidebarblock">\r
3240 <div class="content">\r
3241 <div class="title">Definition concept for ;</div>\r
3242 <div class="paragraph"><p>: ; IMMEDIATE ' EXIT , ;</p></div>\r
3243 </div></div>\r
3244 </div></div>\r
3245 <div style="text-align:center">\r
3246 _______________________________________________________\r
3247 </div>\r
3248 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>\r
3249 </div>\r
3250 <div class="sect2">\r
3251 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>\r
3252 <div class="literalblock">\r
3253 <div class="content">\r
3254 <pre><code>Data stack: ( -- a )</code></pre>\r
3255 </div></div>\r
3256 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code\r
3257 sniippet for setting up the signal handling. rrqforth handles SEGV by\r
3258 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>\r
3259 <div style="text-align:center">\r
3260 _______________________________________________________\r
3261 </div>\r
3262 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>\r
3263 </div>\r
3264 <div class="sect2">\r
3265 <h3 id="_word_lt_lt">Word: &lt;&lt;</h3>\r
3266 <div class="literalblock">\r
3267 <div class="content">\r
3268 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>\r
3269 </div></div>\r
3270 <div class="paragraph"><p>"&lt;&lt;" is a function word that shifts value v1 n steps left (i.e.\r
3271 "moving" bits towards more significant bits) to form value v2.</p></div>\r
3272 <div style="text-align:center">\r
3273 _______________________________________________________\r
3274 </div>\r
3275 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>\r
3276 </div>\r
3277 <div class="sect2">\r
3278 <h3 id="_word_gt_gt">Word: &gt;&gt;</h3>\r
3279 <div class="literalblock">\r
3280 <div class="content">\r
3281 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>\r
3282 </div></div>\r
3283 <div class="paragraph"><p>"&gt;&gt;" is a function word that shifts value v1 n steps right (i.e.\r
3284 "moving" bits towards less significant bits) to form value v2.</p></div>\r
3285 <div style="text-align:center">\r
3286 _______________________________________________________\r
3287 </div>\r
3288 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>\r
3289 </div>\r
3290 <div class="sect2">\r
3291 <h3 id="_word_s_gt_gt">Word: s&gt;&gt;</h3>\r
3292 <div class="literalblock">\r
3293 <div class="content">\r
3294 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>\r
3295 </div></div>\r
3296 <div class="paragraph"><p>"s&gt;&gt;" is a function word that shifts value v1 n steps right (i.e.\r
3297 "moving" bits towards less significant bits) to form value v2, but\r
3298 preserving (and copying) the sign bit.</p></div>\r
3299 <div style="text-align:center">\r
3300 _______________________________________________________\r
3301 </div>\r
3302 <div class="paragraph"><p><a id="p_sp"></a></p></div>\r
3303 </div>\r
3304 <div class="sect2">\r
3305 <h3 id="_word_sp">Word: SP</h3>\r
3306 <div class="literalblock">\r
3307 <div class="content">\r
3308 <pre><code>Data stack: ( -- v )</code></pre>\r
3309 </div></div>\r
3310 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>\r
3311 <div style="text-align:center">\r
3312 _______________________________________________________\r
3313 </div>\r
3314 <div class="paragraph"><p><a id="p_state"></a></p></div>\r
3315 </div>\r
3316 <div class="sect2">\r
3317 <h3 id="_word_state">Word: STATE</h3>\r
3318 <div class="literalblock">\r
3319 <div class="content">\r
3320 <pre><code>Data stack: ( -- a )</code></pre>\r
3321 </div></div>\r
3322 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in\r
3323 compiling mode (1) or interpreting (0) mode.</p></div>\r
3324 <div style="text-align:center">\r
3325 _______________________________________________________\r
3326 </div>\r
3327 <div class="paragraph"><p><a id="p_stdin"></a></p></div>\r
3328 </div>\r
3329 <div class="sect2">\r
3330 <h3 id="_word_stdin">Word: STDIN</h3>\r
3331 <div class="literalblock">\r
3332 <div class="content">\r
3333 <pre><code>Data stack: ( -- stream )</code></pre>\r
3334 </div></div>\r
3335 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the\r
3336 standard input file descriptor.</p></div>\r
3337 <div style="text-align:center">\r
3338 _______________________________________________________\r
3339 </div>\r
3340 <div class="paragraph"><p><a id="p_stream"></a></p></div>\r
3341 </div>\r
3342 <div class="sect2">\r
3343 <h3 id="_word_stream">Word: STREAM</h3>\r
3344 <div class="literalblock">\r
3345 <div class="content">\r
3346 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>\r
3347 </div></div>\r
3348 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file\r
3349 descriptor or for a memory block (of size+data).</p></div>\r
3350 <div class="sect3">\r
3351 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>\r
3352 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size\r
3353 prefixed by a 32 byte STREAM header of the following layout:</p></div>\r
3354 <div class="exampleblock">\r
3355 <div class="content">\r
3356 <div class="listingblock">\r
3357 <div class="title">Layout 3: file descriptor stream</div>\r
3358 <div class="content">\r
3359 <pre><code>  8 bytes = size of buffer (excluding the 32 byte header)\r
3360   8 bytes source file descriptor\r
3361   8 bytes current fill\r
3362   8 current read position</code></pre>\r
3363 </div></div>\r
3364 </div></div>\r
3365 </div>\r
3366 <div class="sect3">\r
3367 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>\r
3368 <div class="paragraph"><p>A memory block stream is only the header (though allocated via\r
3369 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the\r
3370 following layout:</p></div>\r
3371 <div class="exampleblock">\r
3372 <div class="content">\r
3373 <div class="listingblock">\r
3374 <div class="title">Layout 4: memory block stream</div>\r
3375 <div class="content">\r
3376 <pre><code>  8 bytes = block address\r
3377   8 -1 (indicates memory block)\r
3378   8 size of block (taken from the block's first 8 bytes)\r
3379   8 current read position</code></pre>\r
3380 </div></div>\r
3381 </div></div>\r
3382 <div style="text-align:center">\r
3383 _______________________________________________________\r
3384 </div>\r
3385 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>\r
3386 </div>\r
3387 </div>\r
3388 <div class="sect2">\r
3389 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>\r
3390 <div class="literalblock">\r
3391 <div class="content">\r
3392 <pre><code>Data stack: ( stream -- n )</code></pre>\r
3393 </div></div>\r
3394 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream\r
3395 buffer for the next non-whitespace character, and returns its position\r
3396 relative to the end of the buffer. This is done without changing the\r
3397 stream (or filling it by reading the backing file).</p></div>\r
3398 <div style="text-align:center">\r
3399 _______________________________________________________\r
3400 </div>\r
3401 <div class="paragraph"><p><a id="p_str2temp"></a></p></div>\r
3402 </div>\r
3403 <div class="sect2">\r
3404 <h3 id="_word_str_gt_temp">Word: STR&gt;TEMP</h3>\r
3405 <div class="sidebarblock">\r
3406 <div class="content">\r
3407 <div class="paragraph"><p>Data stack: ( char* n&#8201;&#8212;&#8201;char* n )</p></div>\r
3408 </div></div>\r
3409 <div class="paragraph"><p>"STR&gt;TEMP" is a function word that copies a given string plus a\r
3410 terminating NUL character into a <a href="#p_tempspace">TEMPSPACE</a> snippet,\r
3411 all preceded by a length cell. It returns a pointer for to the text in\r
3412 the snippet and its length, excluding the NUL character at end and the\r
3413 length cell before tie text.</p></div>\r
3414 <div class="listingblock">\r
3415 <div class="title">Layout for copied string</div>\r
3416 <div class="content">\r
3417 <pre><code>        length: 8 bytes\r
3418 returned char*: n bytes\r
3419            nul: 1 byte</code></pre>\r
3420 </div></div>\r
3421 <div style="text-align:center">\r
3422 _______________________________________________________\r
3423 </div>\r
3424 <div class="paragraph"><p><a id="p_strlen"></a></p></div>\r
3425 </div>\r
3426 <div class="sect2">\r
3427 <h3 id="_word_strlen">Word: STRLEN</h3>\r
3428 <div class="literalblock">\r
3429 <div class="content">\r
3430 <pre><code>Data stack: ( s -- n )</code></pre>\r
3431 </div></div>\r
3432 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from\r
3433 s to the first NUL byte and returns that count, n, not including the\r
3434 NUL byte.</p></div>\r
3435 <div style="text-align:center">\r
3436 _______________________________________________________\r
3437 </div>\r
3438 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>\r
3439 </div>\r
3440 <div class="sect2">\r
3441 <h3 id="_word_strncmp">Word: STRNCMP</h3>\r
3442 <div class="literalblock">\r
3443 <div class="content">\r
3444 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>\r
3445 </div></div>\r
3446 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of\r
3447 character sequences s1 and s2, and returns the difference of the first\r
3448 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters\r
3449 are the same.</p></div>\r
3450 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically\r
3451 less than [n:s2],\r
3452 v is greater than 0 if [n:s1] is greater than [n:s2],\r
3453 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>\r
3454 <div style="text-align:center">\r
3455 _______________________________________________________\r
3456 </div>\r
3457 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>\r
3458 </div>\r
3459 <div class="sect2">\r
3460 <h3 id="_word_strncpy">Word: STRNCPY</h3>\r
3461 <div class="literalblock">\r
3462 <div class="content">\r
3463 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>\r
3464 </div></div>\r
3465 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1\r
3466 to s2.</p></div>\r
3467 <div style="text-align:center">\r
3468 _______________________________________________________\r
3469 </div>\r
3470 <div class="paragraph"><p><a id="p_swap"></a></p></div>\r
3471 </div>\r
3472 <div class="sect2">\r
3473 <h3 id="_word_swap">Word: SWAP</h3>\r
3474 <div class="literalblock">\r
3475 <div class="content">\r
3476 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>\r
3477 </div></div>\r
3478 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>\r
3479 <div style="text-align:center">\r
3480 _______________________________________________________\r
3481 </div>\r
3482 <div class="paragraph"><p><a id="p_system"></a></p></div>\r
3483 </div>\r
3484 <div class="sect2">\r
3485 <h3 id="_word_system">Word: SYSTEM</h3>\r
3486 <div class="literalblock">\r
3487 <div class="content">\r
3488 <pre><code>Data value: ( -- a )</code></pre>\r
3489 </div></div>\r
3490 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system\r
3491 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>\r
3492 merely as a matter of segregation.</p></div>\r
3493 <div style="text-align:center">\r
3494 _______________________________________________________\r
3495 </div>\r
3496 <div class="paragraph"><p><a id="p_tell"></a></p></div>\r
3497 </div>\r
3498 <div class="sect2">\r
3499 <h3 id="_word_tell">Word: TELL</h3>\r
3500 <div class="literalblock">\r
3501 <div class="content">\r
3502 <pre><code>Data stack: ( char* n -- )</code></pre>\r
3503 </div></div>\r
3504 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file\r
3505 descriptor 1).</p></div>\r
3506 <div style="text-align:center">\r
3507 _______________________________________________________\r
3508 </div>\r
3509 <div class="paragraph"><p><a id="p_temp"></a></p></div>\r
3510 </div>\r
3511 <div class="sect2">\r
3512 <h3 id="_word_temp_2">Word: TEMP</h3>\r
3513 <div class="sidebarblock">\r
3514 <div class="content">\r
3515 <div class="paragraph"><p>Data stack: ( size&#8201;&#8212;&#8201;addr )</p></div>\r
3516 </div></div>\r
3517 <div class="paragraph"><p>"TEMP" is a function word that "allocates" a <a href="#p_tempspace">TEMPSPACE</a>\r
3518 area of given size and returns its base address. The allocation is\r
3519 temporary and only valid until there is a later allocation that\r
3520 overruns this area.</p></div>\r
3521 <div class="paragraph"><p>Allocations are done in succession until the requested size overruns\r
3522 the <a href="#p_tempspace">TEMPSPACE</a>. If so, the allocation pointer is reset\r
3523 and the space is allocated from start again. This is all intended for\r
3524 small and short-lived data areas.</p></div>\r
3525 <div style="text-align:center">\r
3526 _______________________________________________________\r
3527 </div>\r
3528 <div class="paragraph"><p><a id="p_tempheld"></a></p></div>\r
3529 </div>\r
3530 <div class="sect2">\r
3531 <h3 id="_word_tempheld">Word: TEMPHELD</h3>\r
3532 <div class="literalblock">\r
3533 <div class="content">\r
3534 <pre><code>Data stack: ( -- a )</code></pre>\r
3535 </div></div>\r
3536 <div class="paragraph"><p>"TEMPHELD" is a variable word that keeps the lowest offset of the\r
3537 <a href="#p__tempspace">TEMPSPACE</a> space to reuse upon cycling. The space\r
3538 below TEMPHELD is "held" in the sense of not being reused upon\r
3539 cycling. An application may change the TEMPSPACE offset as needed to\r
3540 dynamically preserve memory longer term.</p></div>\r
3541 <div style="text-align:center">\r
3542 _______________________________________________________\r
3543 </div>\r
3544 <div class="paragraph"><p><a id="p_tempspace"></a></p></div>\r
3545 </div>\r
3546 <div class="sect2">\r
3547 <h3 id="_word_tempspace">Word: TEMPSPACE</h3>\r
3548 <div class="literalblock">\r
3549 <div class="content">\r
3550 <pre><code>Data stack: ( -- a )</code></pre>\r
3551 </div></div>\r
3552 <div class="paragraph"><p>"TEMPSPACE" is a variable word that holds three cells the for managing\r
3553 "temporary memory":</p></div>\r
3554 <div class="ulist"><ul>\r
3555 <li>\r
3556 <p>\r
3557 the size of the temporary memory space (default 104857600 bytes)\r
3558 </p>\r
3559 </li>\r
3560 <li>\r
3561 <p>\r
3562 the base address for whole temporary memory area\r
3563 </p>\r
3564 </li>\r
3565 <li>\r
3566 <p>\r
3567 the amount currently used\r
3568 </p>\r
3569 </li>\r
3570 </ul></div>\r
3571 <div class="paragraph"><p>This memory is intended to be used by requesting snippets of memory in\r
3572 a cyclic fashion via <a href="#p_temp">TEMP</a> without concern about it possibly\r
3573 overlapping a prior request.</p></div>\r
3574 <div style="text-align:center">\r
3575 _______________________________________________________\r
3576 </div>\r
3577 <div class="paragraph"><p><a id="p_tempused"></a></p></div>\r
3578 </div>\r
3579 <div class="sect2">\r
3580 <h3 id="_word_tempused">Word: TEMPUSED</h3>\r
3581 <div class="literalblock">\r
3582 <div class="content">\r
3583 <pre><code>Data stack: ( -- a )</code></pre>\r
3584 </div></div>\r
3585 <div class="paragraph"><p>"TEMPUSED" is a variable word that keeps the lowest offset of the\r
3586 <a href="#p__tempspace">TEMPSPACE</a> space to use next as temporary space. This\r
3587 is advance upon each allocation via <a href="#p_temp">TEMP</a>, and recycled back\r
3588 to <a href="#p_tempheld">TEMPHELD</a> when next allocation otherwise would exceed\r
3589 the space size.</p></div>\r
3590 <div style="text-align:center">\r
3591 _______________________________________________________\r
3592 </div>\r
3593 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>\r
3594 </div>\r
3595 <div class="sect2">\r
3596 <h3 id="_word_terminate0">Word: TERMINATE0</h3>\r
3597 <div class="literalblock">\r
3598 <div class="content">\r
3599 <pre><code>Data stack: ( -- )</code></pre>\r
3600 </div></div>\r
3601 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit\r
3602 code 0.</p></div>\r
3603 <div style="text-align:center">\r
3604 _______________________________________________________\r
3605 </div>\r
3606 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>\r
3607 </div>\r
3608 <div class="sect2">\r
3609 <h3 id="_word_tfa_gt_cfa">Word: TFA&gt;CFA</h3>\r
3610 <div class="literalblock">\r
3611 <div class="content">\r
3612 <pre><code>Data stack: ( tfa -- cfa )</code></pre>\r
3613 </div></div>\r
3614 <div class="paragraph"><p>"TFA&gt;CFA" is a function word that pushes word cfa of the given tfa.</p></div>\r
3615 <div class="exampleblock">\r
3616 <div class="content">\r
3617 <div class="sidebarblock">\r
3618 <div class="content">\r
3619 <div class="title">Definition concept for TFA&gt;CFA</div>\r
3620 <div class="paragraph"><p>: TFA&gt;CFA 8 + @ ;</p></div>\r
3621 </div></div>\r
3622 </div></div>\r
3623 <div style="text-align:center">\r
3624 _______________________________________________________\r
3625 </div>\r
3626 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>\r
3627 </div>\r
3628 <div class="sect2">\r
3629 <h3 id="_word_tfa_gt_dfa">Word: TFA&gt;DFA</h3>\r
3630 <div class="literalblock">\r
3631 <div class="content">\r
3632 <pre><code>Data stack: ( tfa -- dfa )</code></pre>\r
3633 </div></div>\r
3634 <div class="paragraph"><p>"TFA&gt;DFA" is a function word that pushes word dfa of the given tfa.</p></div>\r
3635 <div class="exampleblock">\r
3636 <div class="content">\r
3637 <div class="sidebarblock">\r
3638 <div class="content">\r
3639 <div class="title">Definition concept for TFA&gt;DFA</div>\r
3640 <div class="paragraph"><p>: TFA&gt;DFA TFA&gt;CFA 8 + ;</p></div>\r
3641 </div></div>\r
3642 </div></div>\r
3643 <div style="text-align:center">\r
3644 _______________________________________________________\r
3645 </div>\r
3646 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>\r
3647 </div>\r
3648 <div class="sect2">\r
3649 <h3 id="_word_tfa_gt_flags">Word: TFA&gt;FLAGS@</h3>\r
3650 <div class="literalblock">\r
3651 <div class="content">\r
3652 <pre><code>Data stack: ( tfa -- flags )</code></pre>\r
3653 </div></div>\r
3654 <div class="paragraph"><p>"TFA&gt;FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>\r
3655 <div class="exampleblock">\r
3656 <div class="content">\r
3657 <div class="sidebarblock">\r
3658 <div class="content">\r
3659 <div class="title">Defintion concept for TFA&gt;FLAGS@</div>\r
3660 <div class="paragraph"><p>: TFA&gt;FLAGS@ 16 + @ ;</p></div>\r
3661 </div></div>\r
3662 </div></div>\r
3663 <div style="text-align:center">\r
3664 _______________________________________________________\r
3665 </div>\r
3666 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>\r
3667 </div>\r
3668 <div class="sect2">\r
3669 <h3 id="_word_tfa_gt_namez">Word: TFA&gt;NAMEZ</h3>\r
3670 <div class="literalblock">\r
3671 <div class="content">\r
3672 <pre><code>Data stack: ( tfa -- char* )</code></pre>\r
3673 </div></div>\r
3674 <div class="paragraph"><p>"TFA&gt;NAMEZ" is a function word that pushes changes a tfa pointer to a\r
3675 pointer to the word pname&#8217;s character sequence, which is zero\r
3676 terminated as well as preceded by a length cell.</p></div>\r
3677 <div class="exampleblock">\r
3678 <div class="content">\r
3679 <div class="sidebarblock">\r
3680 <div class="content">\r
3681 <div class="title">Defintion concept for TFA&gt;NAMEZ</div>\r
3682 <div class="paragraph"><p>: TFA&gt;NAMEZ 32 + ;</p></div>\r
3683 </div></div>\r
3684 </div></div>\r
3685 <div style="text-align:center">\r
3686 _______________________________________________________\r
3687 </div>\r
3688 <div class="paragraph"><p><a id="p_then"></a></p></div>\r
3689 </div>\r
3690 <div class="sect2">\r
3691 <h3 id="_word_then">Word: THEN</h3>\r
3692 <div class="literalblock">\r
3693 <div class="content">\r
3694 <pre><code>Data stack: Compiling: ( a -- )</code></pre>\r
3695 </div></div>\r
3696 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with\r
3697 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution\r
3698 control. THEN performs the branch resolution for the stacked address\r
3699 which pinpoints the foot address the branch offset to resolve, so that\r
3700 at execution time there is an appropriate conditional branch past the\r
3701 "then-part" or the "else-part" of the "structured statement".</p></div>\r
3702 <div style="text-align:center">\r
3703 _______________________________________________________\r
3704 </div>\r
3705 <div class="paragraph"><p><a id="p_this_word"></a></p></div>\r
3706 </div>\r
3707 <div class="sect2">\r
3708 <h3 id="_word_this_word">Word: THIS-WORD</h3>\r
3709 <div class="literalblock">\r
3710 <div class="content">\r
3711 <pre><code>Data stack: ( -- a )</code></pre>\r
3712 </div></div>\r
3713 <div class="paragraph"><p>"THIS-WORD" is a variable word used in\r
3714 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]\r
3715 values of the successive words being evaluated. This typically points\r
3716 into the input stream buffer and remain valid until further stream\r
3717 buffering functions are used.</p></div>\r
3718 <div style="text-align:center">\r
3719 _______________________________________________________\r
3720 </div>\r
3721 <div class="paragraph"><p><a id="p_true"></a></p></div>\r
3722 </div>\r
3723 <div class="sect2">\r
3724 <h3 id="_word_true">Word: TRUE</h3>\r
3725 <div class="literalblock">\r
3726 <div class="content">\r
3727 <pre><code>Data stack: ( -- -1 )</code></pre>\r
3728 </div></div>\r
3729 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>\r
3730 <div style="text-align:center">\r
3731 _______________________________________________________\r
3732 </div>\r
3733 <div class="paragraph"><p><a id="p_tuck"></a></p></div>\r
3734 </div>\r
3735 <div class="sect2">\r
3736 <h3 id="_word_tuck">Word: TUCK</h3>\r
3737 <div class="literalblock">\r
3738 <div class="content">\r
3739 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>\r
3740 </div></div>\r
3741 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second\r
3742 cell on the data stack.</p></div>\r
3743 <div class="exampleblock">\r
3744 <div class="content">\r
3745 <div class="sidebarblock">\r
3746 <div class="content">\r
3747 <div class="title">Definition concept for TUCK</div>\r
3748 <div class="paragraph"><p>: TUCK SWAP OVER ;</p></div>\r
3749 </div></div>\r
3750 </div></div>\r
3751 <div style="text-align:center">\r
3752 _______________________________________________________\r
3753 </div>\r
3754 <div class="paragraph"><p><a id="p_unequal"></a></p></div>\r
3755 </div>\r
3756 <div class="sect2">\r
3757 <h3 id="_word_19">Word: !=</h3>\r
3758 <div class="literalblock">\r
3759 <div class="content">\r
3760 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>\r
3761 </div></div>\r
3762 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the\r
3763 values are unequal, and 0 otherwise.</p></div>\r
3764 <div style="text-align:center">\r
3765 _______________________________________________________\r
3766 </div>\r
3767 <div class="paragraph"><p><a id="p_unstream"></a></p></div>\r
3768 </div>\r
3769 <div class="sect2">\r
3770 <h3 id="_word_unstream">Word: UNSTREAM</h3>\r
3771 <div class="literalblock">\r
3772 <div class="content">\r
3773 <pre><code>Data stack: ( stream* -- )</code></pre>\r
3774 </div></div>\r
3775 <div class="paragraph"><p>"UNSTREAM" is a function word that releases the memory allocated for a\r
3776 stream, and closes the associated file if it&#8217;s a file stream.</p></div>\r
3777 <div class="sect3">\r
3778 <h4 id="_file_descriptor_backed_stream_2">File descriptor backed stream</h4>\r
3779 <div class="paragraph"><p>This kind of stream has the stream header as a prefix within the\r
3780 allocated memory. Thus, stream* is the base address for the memory to\r
3781 reclaim, and the size of this is determined from the cell at (stream*\r
3782 + 16) plus the 32 bytes head itself.</p></div>\r
3783 </div>\r
3784 <div class="sect3">\r
3785 <h4 id="_memory_block_backed_stream_2">Memory block backed STREAM</h4>\r
3786 <div class="paragraph"><p>This kind of stream has a separate header which points at the memory\r
3787 area to reclaim. The cell at stream* is the base address, and the cell\r
3788 at (stream* + 16) is its size.</p></div>\r
3789 <div style="text-align:center">\r
3790 _______________________________________________________\r
3791 </div>\r
3792 <div class="paragraph"><p><a id="p_use"></a></p></div>\r
3793 </div>\r
3794 </div>\r
3795 <div class="sect2">\r
3796 <h3 id="_word_use">Word: USE</h3>\r
3797 <div class="literalblock">\r
3798 <div class="content">\r
3799 <pre><code>Data value: ( wordlist -- )  Input stream: word</code></pre>\r
3800 </div></div>\r
3801 <div class="paragraph"><p>"USE" is a function word that looks up next word given the wordlist.\r
3802 It reads next word on <a href="#p_input">INPUT</a> via <a href="#p_read_word">READ-WORD</a>,\r
3803 then temporarily changes <a href="#p_current_wordlist">CURRENT-WORDLIST</a> to\r
3804 <a href="#p_find">FIND</a> the word via the given wordlist, and returns the TFA\r
3805 of that word, or just 0 if the word coudn&#8217;t be found.</p></div>\r
3806 <div style="text-align:center">\r
3807 _______________________________________________________\r
3808 </div>\r
3809 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>\r
3810 </div>\r
3811 <div class="sect2">\r
3812 <h3 id="_word_verbose">Word: VERBOSE?</h3>\r
3813 <div class="literalblock">\r
3814 <div class="content">\r
3815 <pre><code>Data stack: ( -- a )</code></pre>\r
3816 </div></div>\r
3817 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0\r
3818 signify whether or not the command line arguments includes "-v". When\r
3819 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more\r
3820 verbose.</p></div>\r
3821 <div style="text-align:center">\r
3822 _______________________________________________________\r
3823 </div>\r
3824 <div class="paragraph"><p><a id="p_within"></a></p></div>\r
3825 </div>\r
3826 <div class="sect2">\r
3827 <h3 id="_word_within">Word: WITHIN</h3>\r
3828 <div class="literalblock">\r
3829 <div class="content">\r
3830 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>\r
3831 </div></div>\r
3832 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1\r
3833 of the the first, v, is within the value range spanned by the second,\r
3834 lo, inclusive and third, hi, exclusive.</p></div>\r
3835 <div class="exampleblock">\r
3836 <div class="content">\r
3837 <div class="sidebarblock">\r
3838 <div class="content">\r
3839 <div class="title">Definition concept for WITHIN</div>\r
3840 <div class="paragraph"><p>: WITHIN 2 PICK &gt; ROT ROT &#8656; AND ;</p></div>\r
3841 </div></div>\r
3842 </div></div>\r
3843 <div style="text-align:center">\r
3844 _______________________________________________________\r
3845 </div>\r
3846 <div class="paragraph"><p><a id="p_words"></a></p></div>\r
3847 </div>\r
3848 <div class="sect2">\r
3849 <h3 id="_word_words">Word: WORDS</h3>\r
3850 <div class="literalblock">\r
3851 <div class="content">\r
3852 <pre><code>Data stack: ( wl -- )</code></pre>\r
3853 </div></div>\r
3854 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word\r
3855 list to stdout (file descriptor 1).</p></div>\r
3856 <div style="text-align:center">\r
3857 _______________________________________________________\r
3858 </div>\r
3859 <div class="paragraph"><p><a id="p_xor"></a></p></div>\r
3860 </div>\r
3861 <div class="sect2">\r
3862 <h3 id="_word_xor">Word: XOR</h3>\r
3863 <div class="literalblock">\r
3864 <div class="content">\r
3865 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>\r
3866 </div></div>\r
3867 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise\r
3868 exclusion; each bit is 1 if the corresponding bits of the two operands\r
3869 differ and 0 if not.</p></div>\r
3870 <div style="text-align:center">\r
3871 _______________________________________________________\r
3872 </div>\r
3873 <div class="paragraph"><p><a id="return_stack"></a></p></div>\r
3874 </div>\r
3875 <div class="sect2">\r
3876 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>\r
3877 <div class="literalblock">\r
3878 <div class="content">\r
3879 <pre><code>Data stack: ( -- a )</code></pre>\r
3880 </div></div>\r
3881 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>\r
3882 </div>\r
3883 </div>\r
3884 </div>\r
3885 <div class="sect1">\r
3886 <h2 id="_system_calls">System calls</h2>\r
3887 <div class="sectionbody">\r
3888 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which\r
3889 generally are described in their "man pages. This wrapping takes the\r
3890 arguments fro the data stack in reverse order, i.e. the first argument\r
3891 is deepest.</p></div>\r
3892 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>\r
3893 </div>\r
3894 </div>\r
3895 </div>\r
3896 <div id="footnotes"><hr /></div>\r
3897 <div id="footer">\r
3898 <div id="footer-text">\r
3899 Last updated\r
3900  2021-06-15 15:44:03 AEST\r
3901 </div>\r
3902 </div>\r
3903 </body>\r
3904 </html>\r