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
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
14 font-family: Georgia,serif;
\r
18 h1, h2, h3, h4, h5, h6,
\r
19 div.title, caption.title,
\r
20 thead, p.table.header,
\r
22 #author, #revnumber, #revdate, #revremark,
\r
24 font-family: Arial,Helvetica,sans-serif;
\r
28 margin: 1em 5% 1em 5%;
\r
33 text-decoration: underline;
\r
49 h1, h2, h3, h4, h5, h6 {
\r
52 margin-bottom: 0.5em;
\r
57 border-bottom: 2px solid silver;
\r
77 border: 1px solid silver;
\r
82 margin-bottom: 0.5em;
\r
88 ul > li { color: #aaa; }
\r
89 ul > li > * { color: black; }
\r
91 .monospaced, code, pre {
\r
92 font-family: "Courier New", Courier, monospace;
\r
99 white-space: pre-wrap;
\r
109 #revnumber, #revdate, #revremark {
\r
114 border-top: 2px solid silver;
\r
115 padding-top: 0.5em;
\r
120 padding-bottom: 0.5em;
\r
124 padding-bottom: 0.5em;
\r
129 margin-bottom: 1.5em;
\r
131 div.imageblock, div.exampleblock, div.verseblock,
\r
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
\r
133 div.admonitionblock {
\r
135 margin-bottom: 1.5em;
\r
137 div.admonitionblock {
\r
139 margin-bottom: 2.0em;
\r
144 div.content { /* Block element content. */
\r
148 /* Block element titles. */
\r
149 div.title, caption.title {
\r
154 margin-bottom: 0.5em;
\r
160 td div.title:first-child {
\r
163 div.content div.title:first-child {
\r
166 div.content + div.title {
\r
170 div.sidebarblock > div.content {
\r
171 background: #ffffee;
\r
172 border: 1px solid #dddddd;
\r
173 border-left: 4px solid #f0f0f0;
\r
177 div.listingblock > div.content {
\r
178 border: 1px solid #dddddd;
\r
179 border-left: 5px solid #f0f0f0;
\r
180 background: #f8f8f8;
\r
184 div.quoteblock, div.verseblock {
\r
185 padding-left: 1.0em;
\r
186 margin-left: 1.0em;
\r
188 border-left: 5px solid #f0f0f0;
\r
192 div.quoteblock > div.attribution {
\r
193 padding-top: 0.5em;
\r
197 div.verseblock > pre.content {
\r
198 font-family: inherit;
\r
199 font-size: inherit;
\r
201 div.verseblock > div.attribution {
\r
202 padding-top: 0.75em;
\r
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
\r
206 div.verseblock + div.attribution {
\r
210 div.admonitionblock .icon {
\r
211 vertical-align: top;
\r
214 text-decoration: underline;
\r
216 padding-right: 0.5em;
\r
218 div.admonitionblock td.content {
\r
219 padding-left: 0.5em;
\r
220 border-left: 3px solid #dddddd;
\r
223 div.exampleblock > div.content {
\r
224 border-left: 3px solid #dddddd;
\r
225 padding-left: 0.5em;
\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
234 margin-bottom: 0.8em;
\r
239 font-style: normal;
\r
242 dd > *:first-child {
\r
247 list-style-position: outside;
\r
250 list-style-type: decimal;
\r
253 list-style-type: lower-alpha;
\r
256 list-style-type: upper-alpha;
\r
259 list-style-type: lower-roman;
\r
262 list-style-type: upper-roman;
\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
269 margin-bottom: 0.1em;
\r
281 margin-bottom: 0.8em;
\r
284 padding-bottom: 15px;
\r
286 dt.hdlist1.strong, td.hdlist1.strong {
\r
290 vertical-align: top;
\r
291 font-style: normal;
\r
292 padding-right: 0.8em;
\r
296 vertical-align: top;
\r
298 div.hdlist.compact tr {
\r
304 background: yellow;
\r
307 .footnote, .footnoteref {
\r
311 span.footnote, span.footnoteref {
\r
312 vertical-align: super;
\r
316 margin: 20px 0 20px 0;
\r
317 padding: 7px 0 0 0;
\r
320 #footnotes div.footnote {
\r
326 border-top: 1px solid silver;
\r
335 padding-right: 0.5em;
\r
336 padding-bottom: 0.3em;
\r
337 vertical-align: top;
\r
339 div.colist td img {
\r
344 #footer-badges { display: none; }
\r
348 margin-bottom: 2.5em;
\r
356 margin-bottom: 0.1em;
\r
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
\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
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
410 span.big { font-size: 2em; }
\r
411 span.small { font-size: 0.6em; }
\r
413 span.underline { text-decoration: underline; }
\r
414 span.overline { text-decoration: overline; }
\r
415 span.line-through { text-decoration: line-through; }
\r
417 div.unbreakable { page-break-inside: avoid; }
\r
427 margin-bottom: 1.5em;
\r
429 div.tableblock > table {
\r
430 border: 3px solid #527bbd;
\r
432 thead, p.table.header {
\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
443 div.tableblock > table[frame="hsides"] {
\r
444 border-left-style: none;
\r
445 border-right-style: none;
\r
447 div.tableblock > table[frame="vsides"] {
\r
448 border-top-style: none;
\r
449 border-bottom-style: none;
\r
460 margin-bottom: 1.5em;
\r
462 thead, p.tableblock.header {
\r
471 border-spacing: 0px;
\r
472 border-style: solid;
\r
473 border-color: #527bbd;
\r
474 border-collapse: collapse;
\r
476 th.tableblock, td.tableblock {
\r
479 border-style: solid;
\r
480 border-color: #527bbd;
\r
483 table.tableblock.frame-topbot {
\r
484 border-left-style: hidden;
\r
485 border-right-style: hidden;
\r
487 table.tableblock.frame-sides {
\r
488 border-top-style: hidden;
\r
489 border-bottom-style: hidden;
\r
491 table.tableblock.frame-none {
\r
492 border-style: hidden;
\r
495 th.tableblock.halign-left, td.tableblock.halign-left {
\r
498 th.tableblock.halign-center, td.tableblock.halign-center {
\r
499 text-align: center;
\r
501 th.tableblock.halign-right, td.tableblock.halign-right {
\r
505 th.tableblock.valign-top, td.tableblock.valign-top {
\r
506 vertical-align: top;
\r
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
\r
509 vertical-align: middle;
\r
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
\r
512 vertical-align: bottom;
\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
528 border-style: none;
\r
530 body.manpage div.sectionbody {
\r
535 body.manpage div#toc { display: none; }
\r
540 <script type="text/javascript">
\r
542 var asciidoc = { // Namespace.
\r
544 /////////////////////////////////////////////////////////////////////
\r
545 // Table Of Contents generator
\r
546 /////////////////////////////////////////////////////////////////////
\r
548 /* Author: Mihai Bazon, September 2002
\r
549 * http://students.infoiasi.ro/~mishoo
\r
551 * Table Of Content generator
\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
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
\r
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
\r
561 // toclevels = 1..4.
\r
562 toc: function (toclevels) {
\r
564 function getText(el) {
\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
569 else if (i.firstChild != null)
\r
570 text += getText(i);
\r
575 function TocEntry(el, text, toclevel) {
\r
578 this.toclevel = toclevel;
\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
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
602 var toc = document.getElementById("toc");
\r
607 // Delete existing TOC entries in case we're reloading the TOC.
\r
608 var tocEntriesToRemove = [];
\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
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
\r
618 toc.removeChild(tocEntriesToRemove[i]);
\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
635 if (entries.length == 0)
\r
636 toc.parentNode.removeChild(toc);
\r
640 /////////////////////////////////////////////////////////////////////
\r
641 // Footnotes generator
\r
642 /////////////////////////////////////////////////////////////////////
\r
644 /* Based on footnote generation code from:
\r
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
\r
648 footnotes: function () {
\r
649 // Delete existing footnote entries in case we're reloading the footnodes.
\r
651 var noteholder = document.getElementById("footnotes");
\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
661 for (i = 0; i < entriesToRemove.length; i++) {
\r
662 noteholder.removeChild(entriesToRemove[i]);
\r
665 // Rebuild footnote entries.
\r
666 var cont = document.getElementById("content");
\r
667 var spans = cont.getElementsByTagName("span");
\r
670 for (i=0; i<spans.length; i++) {
\r
671 if (spans[i].className == "footnote") {
\r
673 var note = spans[i].getAttribute("data-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
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
692 noteholder.parentNode.removeChild(noteholder);
\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
700 spans[i].innerHTML =
\r
701 "[<a href='#_footnote_" + n +
\r
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
\r
708 install: function(toclevels) {
\r
711 function reinstall() {
\r
712 asciidoc.footnotes();
\r
714 asciidoc.toc(toclevels);
\r
718 function reinstallAndRemoveTimer() {
\r
719 clearInterval(timerId);
\r
723 timerId = setInterval(reinstall, 500);
\r
724 if (document.addEventListener)
\r
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
\r
727 window.onload = reinstallAndRemoveTimer;
\r
731 asciidoc.install();
\r
735 <body class="article">
\r
737 <h1>RRQFORTH Reference Documentation</h1>
\r
738 <span id="author">Ralph Ronnquist <ralph.ronnquist@gmail.com></span><br />
\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>  
\r
745 <a href="#p_colon">: (colon)</a>  
\r
746 <a href="#p_semicolon">: (semi-colon)</a>  
\r
747 <a href="#p_comma">, (comma)</a>  
\r
748 <a href="#p_dot">. (dot)</a>  
\r
749 <a href="#p_double_quote">" (double-quote)</a>  
\r
750 <a href="#p_quote">' (single-quote)</a>  
\r
751 <a href="#p_left_bracket">[ (left bracket)</a>  
\r
752 <a href="#p_right_bracket">] (right bracket)</a>  </p></div>
\r
753 <div class="paragraph"><p><a href="#p_lessthan"><</a>  
\r
754 <a href="#p_lessequal"><=</a>  
\r
755 <a href="#p_equal">=</a>  
\r
756 <a href="#p_unequal">!=</a>  
\r
757 <a href="#p_greaterthan">></a>  
\r
758 <a href="#p_greaterequal">>= </a>  
\r
759 <a href="#p_0equal">0=</a>  
\r
760 <a href="#p_0less">0<</a>  
\r
761 <a href="#p_minus">-</a>  
\r
762 <a href="#p_mult">*</a>  
\r
763 <a href="#p_plus">+</a>  
\r
764 <a href="#p_div">/</a>  
\r
765 <a href="#p_shift_left"><<</a>  
\r
766 <a href="#p_shift_right">>></a>  
\r
767 <a href="#p_shift_signed_right">s>></a>  
\r
768 <a href="#p_bracketed_quote">[']</a>  </p></div>
\r
769 <div class="paragraph"><p><a href="#p_get">@</a>  
\r
770 <a href="#p_put">!</a>  
\r
771 <a href="#p_Cget">C@</a>  
\r
772 <a href="#p_Cput">C!</a>  
\r
773 <a href="#p_Wget">W@</a>  
\r
774 <a href="#p_Wput">W!</a>  
\r
775 <a href="#p_Dget">D@</a>  
\r
776 <a href="#p_Dput">D!</a>  
\r
777 <a href="#p_2get">2@</a>  
\r
778 <a href="#p_2put">2!</a>  
\r
779 <a href="#p_put_plus">!+</a>  
\r
780 <a href="#p_get_n_increment">@n++</a>  
\r
781 <a href="#p_get_n_decrement">@n--</a>  
\r
782 <a href="#p_Ccomma">C,</a>  
\r
783 <a href="#p_Wcomma">W,</a>  
\r
784 <a href="#p_Dcomma">D,</a>  
\r
785 <a href="#p_literal_string_compile">S"</a>  
\r
786 <a href="#p_gtR">>R</a>  
\r
787 <a href="#p_Rget">R@</a>  
\r
788 <a href="#p_Rgt">R></a>  
\r
789 <a href="#p_rbpn">R[n]</a>  </p></div>
\r
790 <div class="paragraph"><p><a href="#data_stack">DATA-STACK</a>  
\r
791 <a href="#return_stack">RETURN-STACK</a>  
\r
793 <a href="#p_branch">BRANCH</a>  
\r
794 <a href="#p_0branch">0BRANCH</a>  
\r
795 <a href="#p_1branch">1BRANCH</a>  
\r
797 <a href="#p_2drop">2DROP</a>  
\r
798 <a href="#p_2dup">2DUP</a>  
\r
799 <a href="#p_2over">2OVER</a>  
\r
800 <a href="#p_2swap">2SWAP</a>  </p></div>
\r
801 <div class="paragraph"><p><a href="#p_abs">ABS</a>  
\r
802 <a href="#p_again">AGAIN</a>  
\r
803 <a href="#p_allot">ALLOT</a>  
\r
804 <a href="#p_and">AND</a>  
\r
805 <a href="#inline_code">[ASM]</a>  </p></div>
\r
806 <div class="paragraph"><p><a href="#p_base">BASE</a>  
\r
807 <a href="#p_begin">BEGIN</a>  
\r
808 <a href="#p_break">BREAK</a>  </p></div>
\r
809 <div class="paragraph"><p><a href="#p_cfa2flags_get">CFA>FLAGS@</a>  
\r
810 <a href="#p_cfa2tfa">CFA>TFA</a>  
\r
811 <a href="#p_clear_stream">CLEAR-STREAM</a>  
\r
812 <a href="#p_create">CREATE</a>  
\r
813 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>  </p></div>
\r
814 <div class="paragraph"><p><a href="#p_decimal">DECIMAL</a>  
\r
815 <a href="#p_definitions">DEFINITIONS</a>  
\r
816 <a href="#p_depth">DEPTH</a>  
\r
817 <a href="#p_digits">DIGITS</a>  
\r
818 <a href="#p_divmod">/MOD</a>  
\r
819 <a href="#p_dfa2tfa">DFA>TFA</a>  
\r
820 <a href="#p_dodoes">doDOES</a>  
\r
821 <a href="#p_does">DOES></a>  
\r
822 <a href="#p_dofasm">doFASM</a>  
\r
823 <a href="#p_doforth">doFORTH</a>  
\r
824 <a href="#p_dostring">doSTRING</a>  
\r
825 <a href="#p_dovalue">doVALUE</a>  
\r
826 <a href="#p_dovariable">doVARIABLE</a>  
\r
827 <a href="#p_drop">DROP</a>  
\r
828 <a href="#p_dup">DUP</a>  </p></div>
\r
829 <div class="paragraph"><p><a href="#p_else">ELSE</a>  
\r
830 <a href="#p_emit">EMIT</a>  
\r
831 <a href="#p_end">END</a>  
\r
832 <a href="#p_erase">ERASE</a>  
\r
833 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>  
\r
834 <a href="#p_execute">EXECUTE</a>  
\r
835 <a href="#p_exit">EXIT</a>  </p></div>
\r
836 <div class="paragraph"><p><a href="#p_false">FALSE</a>  
\r
837 <a href="#p_fdemit">FDEMIT</a>  
\r
838 <a href="#p_fdtell">FDTELL</a>  
\r
839 <a href="#p_find">FIND</a>  
\r
840 <a href="#p_forth">FORTH</a>  </p></div>
\r
841 <div class="paragraph"><p><a href="#p_here">HERE</a>  
\r
842 <a href="#p_hex">HEX</a>  </p></div>
\r
843 <div class="paragraph"><p><a href="#p_if">IF</a>  
\r
844 <a href="#p_ifagain">IFAGAIN</a>  
\r
845 <a href="#p_ifbreak">IFBREAK</a>  
\r
846 <a href="#p_immediate">IMMEDIATE</a>  
\r
847 <a href="#p_input">INPUT</a>  </p></div>
\r
848 <div class="paragraph"><p><a href="#p_literal">LIT</a>  
\r
849 <a href="#p_literal_string">LIT-STRING</a>  
\r
850 <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a>  
\r
851 <a href="#p_load_file">LOAD-FILE</a>  </p></div>
\r
852 <div class="paragraph"><p><a href="#p_args">MAIN-ARGS</a>  
\r
853 <a href="#p_malloc">MALLOC</a>  </p></div>
\r
854 <div class="paragraph"><p><a href="#p_negate">NEGATE</a>  
\r
855 <a href="#p_nip">NIP</a>  
\r
856 <a href="#p_nl">NL</a>  
\r
857 <a href="#p_not">NOT</a>  
\r
858 <a href="#p_number">NUMBER</a>  </p></div>
\r
859 <div class="paragraph"><p><a href="#p_open_file">OPEN-FILE</a>  
\r
860 <a href="#p_or">OR</a>  
\r
861 <a href="#p_over">OVER</a>  </p></div>
\r
862 <div class="paragraph"><p><a href="#p_pad">PAD</a>  
\r
863 <a href="#p_pick">PICK</a>  
\r
864 <a href="#p_program_version">PROGRAM_VERSION</a>  </p></div>
\r
865 <div class="paragraph"><p><a href="#p_quit">QUIT</a>  </p></div>
\r
866 <div class="paragraph"><p><a href="#p_read_stream_char">READ-STREAM-CHAR</a>  
\r
867 <a href="#p_read_word">READ-WORD</a>  
\r
868 <a href="#p_realloc">REALLOC</a>  
\r
869 <a href="#p_return">RETURN</a>  
\r
870 <a href="#p_roll">ROLL</a>  
\r
871 <a href="#p_rot">ROT</a>  
\r
872 <a href="#p_rbp">RSP</a>  </p></div>
\r
873 <div class="paragraph"><p><a href="#p_sp">SP</a>  
\r
874 <a href="#p_state">STATE</a>  
\r
875 <a href="#p_stdin">STDIN</a>  
\r
876 <a href="#p_stream">STREAM</a>  
\r
877 <a href="#p_stream_nchars">STREAM-NCHARS</a>  
\r
878 <a href="#p_str2temp">STR>TEMP</a>  
\r
879 <a href="#p_strlen">STRLEN</a>  
\r
880 <a href="#p_strncmp">STRNCMP</a>  
\r
881 <a href="#p_strncpy">STRNCPY</a>  
\r
882 <a href="#p_swap">SWAP</a>  
\r
883 <a href="#p_system">SYSTEM</a>  </p></div>
\r
884 <div class="paragraph"><p><a href="#p_tell">TELL</a>  
\r
885 <a href="#p_dot_temp">.TEMP</a>  
\r
886 <a href="#p_temp.adoc">TEMP</a>  
\r
887 <a href="#p_tempspace">TEMPSPACE</a>  
\r
888 <a href="#p_terminate0">TERMINATE0</a>  
\r
889 <a href="#p_tfa2cfa">TFA>CFA</a>  
\r
890 <a href="#p_tfa2dfa">TFA>DFA</a>  
\r
891 <a href="#p_tfa2flags_get">TFA>FLAGS@</a>  
\r
892 <a href="#p_tfa2namez">TFA>NAMEZ</a>  
\r
893 <a href="#p_then">THEN</a>  
\r
894 <a href="#p_this_word">THIS-WORD</a>  
\r
895 <a href="#p_true">TRUE</a>  
\r
896 <a href="#p_tuck">TUCK</a>  </p></div>
\r
897 <div class="paragraph"><p><a href="#p_unstream">UNSTREAM</a>  
\r
898 <a href="#p_use">USE</a>  </p></div>
\r
899 <div class="paragraph"><p><a href="#p_verboseQ">VERBOSE?</a>  </p></div>
\r
900 <div class="paragraph"><p><a href="#p_within">WITHIN</a>  
\r
901 <a href="#p_words">WORDS</a>  </p></div>
\r
902 <div class="paragraph"><p><a href="#p_xor">XOR</a>  </p></div>
\r
903 <div class="paragraph"><p><a href="#p_calltrace">[calltrace]</a>  
\r
904 <a href="#p_setup_signals">[setup_signals]</a>  </p></div>
\r
907 <div class="sect1">
\r
908 <h2 id="_word_descriptions">Word Descriptions</h2>
\r
909 <div class="sectionbody">
\r
910 <div class="paragraph"><p><a id="inline_code"></a></p></div>
\r
911 <div class="sect2">
\r
912 <h3 id="_word_asm">Word: [ASM]</h3>
\r
913 <div class="literalblock">
\r
914 <div class="content">
\r
915 <pre><code>data stack: ( -- )</code></pre>
\r
917 <div class="paragraph"><p>"[ASM]" is a function word that introduces inline assembly in an
\r
918 RRQFORTH definition. Such assembly code may return to subsequence
\r
919 RRQFORTH executon by means of the following instruction sequence:</p></div>
\r
920 <div class="exampleblock">
\r
921 <div class="content">
\r
922 <div class="listingblock">
\r
923 <div class="content">
\r
924 <pre><code> mov rsi,forthcode
\r
927 forthcode:</code></pre>
\r
930 <div class="paragraph"><p>Note that the FORTH compiler does not invoke an assembler so any
\r
931 inline assembly code must be provided in its binary form.</p></div>
\r
932 <div style="text-align:center">
\r
933 _______________________________________________________
\r
935 <div class="paragraph"><p><a id="p_0branch"></a></p></div>
\r
937 <div class="sect2">
\r
938 <h3 id="_word_0branch">Word: 0BRANCH</h3>
\r
939 <div class="literalblock">
\r
940 <div class="content">
\r
941 <pre><code>Data stack: ( v -- )</code></pre>
\r
943 <div class="paragraph"><p>"0BRANCH" is a function word that implements execution conditional by
\r
944 means of optionally adding the subsequent branch offset, or not, to
\r
945 the point of execution. If the value, v, is 0 then the branch offset
\r
946 is added, and otherwise execution continues with the cell following
\r
947 the branch offset in the definition.</p></div>
\r
948 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
949 definition take up a cell of 8 bytes. The offset is relative to the
\r
950 cell address immediately subsequent to the offset cell. In other
\r
951 words, offset 0 is not branching anywhere and an offset of -16 would
\r
952 make a tight loop back to the branch instruction itself. The latter
\r
953 would pull data stack values until and including the first non-zero
\r
955 <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
956 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
957 <div style="text-align:center">
\r
958 _______________________________________________________
\r
960 <div class="paragraph"><p><a id="p_0equal"></a></p></div>
\r
962 <div class="sect2">
\r
963 <h3 id="_word_0">Word: 0=</h3>
\r
964 <div class="literalblock">
\r
965 <div class="content">
\r
966 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
968 <div class="paragraph"><p>"0=" is a function word that replaces a value with its logical
\r
969 complement; the result is zero if the value non-zero, and the result
\r
970 is non-zero if the value is zero.</p></div>
\r
971 <div class="paragraph"><p>This is the same function as <a href="#p_not">NOT</a>.</p></div>
\r
972 <div style="text-align:center">
\r
973 _______________________________________________________
\r
975 <div class="paragraph"><p><a id="p_0less"></a></p></div>
\r
977 <div class="sect2">
\r
978 <h3 id="_word_0_lt">Word: 0<</h3>
\r
979 <div class="literalblock">
\r
980 <div class="content">
\r
981 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
983 <div class="paragraph"><p>"0<" is a function word that replaces a value with -1 if the value is
\r
984 less than 0, and 0 otherwise.</p></div>
\r
985 <div class="exampleblock">
\r
986 <div class="content">
\r
987 <div class="sidebarblock">
\r
988 <div class="content">
\r
989 <div class="title">Definition concept for 0<</div>
\r
990 <div class="paragraph"><p>( v — 0/1 ) : 0= 0 SWAP < ;</p></div>
\r
993 <div class="paragraph"><p>See also <a href="#p_swap">SWAP</a> and <a href="#p_lessthan"><</a>.</p></div>
\r
994 <div style="text-align:center">
\r
995 _______________________________________________________
\r
997 <div class="paragraph"><p><a id="p_1branch"></a></p></div>
\r
999 <div class="sect2">
\r
1000 <h3 id="_word_1branch">Word: 1BRANCH</h3>
\r
1001 <div class="literalblock">
\r
1002 <div class="content">
\r
1003 <pre><code>Data stack: ( v -- )</code></pre>
\r
1005 <div class="paragraph"><p>"1BRANCH" is a function word that implements execution conditional by
\r
1006 means of optionally adding the subsequent branch offset, or not, to
\r
1007 the point of execution. If the value, v, is non-zero then the branch
\r
1008 offset is added, and otherwise execution continues with the cell
\r
1009 following the branch offset in the definition.</p></div>
\r
1010 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
1011 definition take up a cell of 8 bytes. The offset is relative to the
\r
1012 cell address immediately subsequent to the offset cell. In other
\r
1013 words, offset 0 is not branching anywhere and an offset of -16 would
\r
1014 make a tight loop back to the branch instruction itself. The latter
\r
1015 would pull data stack values until and including the first zero value.</p></div>
\r
1016 <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
1017 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1018 <div style="text-align:center">
\r
1019 _______________________________________________________
\r
1021 <div class="paragraph"><p><a id="p_2drop"></a></p></div>
\r
1023 <div class="sect2">
\r
1024 <h3 id="_word_2drop">Word: 2DROP</h3>
\r
1025 <div class="literalblock">
\r
1026 <div class="content">
\r
1027 <pre><code>Data stack: ( v1 v2 -- )</code></pre>
\r
1029 <div class="paragraph"><p>"2DROP" is a function word that plainly discards the top 2 cells from
\r
1030 the data stack.</p></div>
\r
1031 <div style="text-align:center">
\r
1032 _______________________________________________________
\r
1034 <div class="paragraph"><p><a id="p_2dup"></a></p></div>
\r
1036 <div class="sect2">
\r
1037 <h3 id="_word_2dup">Word: 2DUP</h3>
\r
1038 <div class="literalblock">
\r
1039 <div class="content">
\r
1040 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 v2 )</code></pre>
\r
1042 <div class="paragraph"><p>"2DUP" is a function word that duplicates the top 2 cells on the data
\r
1044 <div class="exampleblock">
\r
1045 <div class="content">
\r
1046 <div class="sidebarblock">
\r
1047 <div class="content">
\r
1048 <div class="title">Definition concept for 2DUP</div>
\r
1049 <div class="paragraph"><p>( v1 v2 — v1 v2 v1 v2 ) : 2DUP OVER OVER ;</p></div>
\r
1052 <div style="text-align:center">
\r
1053 _______________________________________________________
\r
1055 <div class="paragraph"><p><a id="p_2get"></a></p></div>
\r
1057 <div class="sect2">
\r
1058 <h3 id="_word_2">Word: 2@</h3>
\r
1059 <div class="literalblock">
\r
1060 <div class="content">
\r
1061 <pre><code>Data stack: ( a -- v2 v1 )</code></pre>
\r
1063 <div class="paragraph"><p>"2@" is a function word that pushes the two concecutive values v1 and
\r
1064 v2 from the address a onto the data stack. Value v1 is from address a
\r
1065 and value v2 is from address a + 8.</p></div>
\r
1066 <div style="text-align:center">
\r
1067 _______________________________________________________
\r
1069 <div class="paragraph"><p><a id="p_2over"></a></p></div>
\r
1071 <div class="sect2">
\r
1072 <h3 id="_word_2over">Word: 2OVER</h3>
\r
1073 <div class="literalblock">
\r
1074 <div class="content">
\r
1075 <pre><code>Data stack: ( v1 v2 v3 v4 -- v1 v2 v3 v4 v1 v2 )</code></pre>
\r
1077 <div class="paragraph"><p>"2OVER" is a function word that replicates the second duble-cell pair
\r
1078 onto the top of the data stack. This is similar to <a href="#p_over">OVER</a> but
\r
1079 working with cell pairs rather than single cells.</p></div>
\r
1080 <div class="exampleblock">
\r
1081 <div class="content">
\r
1082 <div class="sidebarblock">
\r
1083 <div class="content">
\r
1084 <div class="title">Definition concept for 2OVER</div>
\r
1085 <div class="paragraph"><p>( v1 v2 v3 v4 — v1 v2 v3 v4 v1 v2 ) : 2OVER 3 PICK 3 PICK ;</p></div>
\r
1088 <div style="text-align:center">
\r
1089 _______________________________________________________
\r
1091 <div class="paragraph"><p><a id="p_2put"></a></p></div>
\r
1093 <div class="sect2">
\r
1094 <h3 id="_word_2_2">Word: 2!</h3>
\r
1095 <div class="literalblock">
\r
1096 <div class="content">
\r
1097 <pre><code>Data stack: ( v2 v1 a -- )</code></pre>
\r
1099 <div class="paragraph"><p>"2!" is a function word that stors two concecutive values v1 and v2 to
\r
1100 the address a from the data stack. Value v1 is stored at address a and
\r
1101 value v2 is stored at address a + 8.</p></div>
\r
1102 <div style="text-align:center">
\r
1103 _______________________________________________________
\r
1105 <div class="paragraph"><p><a id="p_2swap"></a></p></div>
\r
1107 <div class="sect2">
\r
1108 <h3 id="_word_2swap">Word: 2SWAP</h3>
\r
1109 <div class="literalblock">
\r
1110 <div class="content">
\r
1111 <pre><code>Data stack: ( v1 v2 v3 v4 -- v3 v4 v1 v2 )</code></pre>
\r
1113 <div class="paragraph"><p>"2SWAP" is a function word the reorgnizes the top 4 cells swappping
\r
1114 the upper and lower pair. This is similar to <a href="#p_swap">SWAP</a> but
\r
1115 working with cell pairs rather than single cells.</p></div>
\r
1116 <div class="exampleblock">
\r
1117 <div class="content">
\r
1118 <div class="sidebarblock">
\r
1119 <div class="content">
\r
1120 <div class="title">Definition concept for 2SWAP</div>
\r
1121 <div class="paragraph"><p>( v1 v2 v3 v4 — v3 v4 v1 v2 ) : 2SWAP 3 ROLL 3 ROLL ;</p></div>
\r
1124 <div style="text-align:center">
\r
1125 _______________________________________________________
\r
1127 <div class="paragraph"><p><a id="p_Ccomma"></a></p></div>
\r
1129 <div class="sect2">
\r
1130 <h3 id="_word_c">Word: C,</h3>
\r
1131 <div class="literalblock">
\r
1132 <div class="content">
\r
1133 <pre><code>Data stack: ( v -- )</code></pre>
\r
1135 <div class="paragraph"><p>"C," (C-comma) is a function word that puts a byte on the
\r
1136 <a href="#p_here">HERE</a> heap. The least significant byte of the value is put
\r
1137 at the current free head address, which also is incremented.</p></div>
\r
1138 <div class="exampleblock">
\r
1139 <div class="content">
\r
1140 <div class="sidebarblock">
\r
1141 <div class="content">
\r
1142 <div class="title">Definition concept for C,</div>
\r
1143 <div class="paragraph"><p>: C, HERE @ 1 ALLOT C! ; ( v — ; Claim 1 byte and put lsb value there )</p></div>
\r
1146 <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
1147 <a href="#p_allot">ALLOT</a>, <a href="#p_Cput">C!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1148 <div style="text-align:center">
\r
1149 _______________________________________________________
\r
1151 <div class="paragraph"><p><a id="p_Wcomma"></a></p></div>
\r
1153 <div class="sect2">
\r
1154 <h3 id="_word_w">Word: W,</h3>
\r
1155 <div class="literalblock">
\r
1156 <div class="content">
\r
1157 <pre><code>Data stack: ( v -- )</code></pre>
\r
1159 <div class="paragraph"><p>"W," (W-comma) is a function word that puts a "word" (double-byte) on
\r
1160 the <a href="#p_here">HERE</a> heap. The two least significant bytes of the value
\r
1161 are put at the current free head address, which also is incremented
\r
1162 accordingly.</p></div>
\r
1163 <div class="exampleblock">
\r
1164 <div class="content">
\r
1165 <div class="sidebarblock">
\r
1166 <div class="content">
\r
1167 <div class="title">Definition concept for W,</div>
\r
1168 <div class="paragraph"><p>: W, HERE @ 2 ALLOT W! ;</p></div>
\r
1171 <div style="text-align:center">
\r
1172 _______________________________________________________
\r
1174 <div class="paragraph"><p><a id="p_Dcomma"></a></p></div>
\r
1176 <div class="sect2">
\r
1177 <h3 id="_word_d">Word: D,</h3>
\r
1178 <div class="literalblock">
\r
1179 <div class="content">
\r
1180 <pre><code>Data stack: ( v -- )</code></pre>
\r
1182 <div class="paragraph"><p>"D," (D-comma) is a function word that puts a "double word"
\r
1183 (double-byte) on the <a href="#p_here">HERE</a> heap. The four least significant
\r
1184 bytes of the value are put at the current free head address, which
\r
1185 also is incremented accordingly.</p></div>
\r
1186 <div class="exampleblock">
\r
1187 <div class="content">
\r
1188 <div class="sidebarblock">
\r
1189 <div class="content">
\r
1190 <div class="title">Definition concept for D,</div>
\r
1191 <div class="paragraph"><p>: D, HERE @ 4 ALLOT D! ;</p></div>
\r
1194 <div style="text-align:center">
\r
1195 _______________________________________________________
\r
1197 <div class="paragraph"><p><a id="p_cfa2tfa"></a></p></div>
\r
1199 <div class="sect2">
\r
1200 <h3 id="_word_cfa_gt_tfa">Word: CFA>TFA</h3>
\r
1201 <div class="literalblock">
\r
1202 <div class="content">
\r
1203 <pre><code>Data stack: ( cfa -- tfa )</code></pre>
\r
1205 <div class="paragraph"><p>"CFA>TFA" is a function word that pushes word tfa of the given cfa.</p></div>
\r
1206 <div class="exampleblock">
\r
1207 <div class="content">
\r
1208 <div class="sidebarblock">
\r
1209 <div class="content">
\r
1210 <div class="title">Definition concept for CFA>TFA</div>
\r
1211 <div class="paragraph"><p>: CFA>TFA 14 - @ ;</p></div>
\r
1214 <div style="text-align:center">
\r
1215 _______________________________________________________
\r
1217 <div class="paragraph"><p><a id="p_Cget"></a></p></div>
\r
1219 <div class="sect2">
\r
1220 <h3 id="_word_c_2">Word: C@</h3>
\r
1221 <div class="literalblock">
\r
1222 <div class="content">
\r
1223 <pre><code>Data stack: ( a -- v )</code></pre>
\r
1225 <div class="paragraph"><p>"C@" is a function word that pushes the byte value v from the address a.</p></div>
\r
1226 <div style="text-align:center">
\r
1227 _______________________________________________________
\r
1229 <div class="paragraph"><p><a id="p_Wget"></a></p></div>
\r
1231 <div class="sect2">
\r
1232 <h3 id="_word_w_2">Word: W@</h3>
\r
1233 <div class="literalblock">
\r
1234 <div class="content">
\r
1235 <pre><code>Data stack: ( a -- v )</code></pre>
\r
1237 <div class="paragraph"><p>"W@" is a function word that pushes the "word" (double-byte) value v
\r
1238 from the address a.</p></div>
\r
1239 <div style="text-align:center">
\r
1240 _______________________________________________________
\r
1242 <div class="paragraph"><p><a id="p_Rget"></a></p></div>
\r
1244 <div class="sect2">
\r
1245 <h3 id="_word_r">Word: R@</h3>
\r
1246 <div class="literalblock">
\r
1247 <div class="content">
\r
1248 <pre><code>Data stack: ( -- v ) Return stack: ( v -- v )</code></pre>
\r
1250 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto
\r
1251 the data stack.</p></div>
\r
1252 <div style="text-align:center">
\r
1253 _______________________________________________________
\r
1255 <div class="paragraph"><p><a id="p_Cput"></a></p></div>
\r
1257 <div class="sect2">
\r
1258 <h3 id="_word_c_3">Word: C!</h3>
\r
1259 <div class="literalblock">
\r
1260 <div class="content">
\r
1261 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1263 <div class="paragraph"><p>"C!" is a function word that stores the byte value v (the least
\r
1264 significant byte of the cell) at the address a.</p></div>
\r
1265 <div style="text-align:center">
\r
1266 _______________________________________________________
\r
1268 <div class="paragraph"><p><a id="p_Wput"></a></p></div>
\r
1270 <div class="sect2">
\r
1271 <h3 id="_word_w_3">Word: W!</h3>
\r
1272 <div class="literalblock">
\r
1273 <div class="content">
\r
1274 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1276 <div class="paragraph"><p>"W!" is a function word that stores the "word" (2-byte) value v (the
\r
1277 two least significant bytes of the cell) at the address a.</p></div>
\r
1278 <div style="text-align:center">
\r
1279 _______________________________________________________
\r
1281 <div class="paragraph"><p><a id="p_Dput"></a></p></div>
\r
1283 <div class="sect2">
\r
1284 <h3 id="_word_d_2">Word: D!</h3>
\r
1285 <div class="literalblock">
\r
1286 <div class="content">
\r
1287 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1289 <div class="paragraph"><p>"D!" is a function word that stores the "doublw word" (4-byte) value v
\r
1290 (the four least significant bytes of the cell) at the address a.</p></div>
\r
1291 <div style="text-align:center">
\r
1292 _______________________________________________________
\r
1294 <div class="paragraph"><p><a id="p_Rget"></a></p></div>
\r
1296 <div class="sect2">
\r
1297 <h3 id="_word_r_2">Word: R@</h3>
\r
1298 <div class="literalblock">
\r
1299 <div class="content">
\r
1300 <pre><code>Data stack: ( -- v ) Return stack: ( v -- v )</code></pre>
\r
1302 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto
\r
1303 the data stack.</p></div>
\r
1304 <div style="text-align:center">
\r
1305 _______________________________________________________
\r
1307 <div class="paragraph"><p><a id="p_Rgt"></a></p></div>
\r
1309 <div class="sect2">
\r
1310 <h3 id="_word_r_gt">Word: R></h3>
\r
1311 <div class="literalblock">
\r
1312 <div class="content">
\r
1313 <pre><code>Data stack: ( -- v ) Return stack: ( v -- )</code></pre>
\r
1315 <div class="paragraph"><p>"R>" is a function word that "moves" the top return stack value onto
\r
1316 the data stack.</p></div>
\r
1317 <div style="text-align:center">
\r
1318 _______________________________________________________
\r
1320 <div class="paragraph"><p><a id="p_abs"></a></p></div>
\r
1322 <div class="sect2">
\r
1323 <h3 id="_word_abs">Word: ABS</h3>
\r
1324 <div class="literalblock">
\r
1325 <div class="content">
\r
1326 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
1328 <div class="paragraph"><p>"ABS" is a function word that replaces a value with its absolute
\r
1329 value. To that end, the values are 64-bit signed integers.</p></div>
\r
1330 <div style="text-align:center">
\r
1331 _______________________________________________________
\r
1333 <div class="paragraph"><p><a id="p_again"></a></p></div>
\r
1335 <div class="sect2">
\r
1336 <h3 id="_word_again">Word: AGAIN</h3>
\r
1337 <div class="literalblock">
\r
1338 <div class="content">
\r
1339 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
1341 <div class="paragraph"><p>"AGAIN" is an immediate function word that is used together with
\r
1342 <a href="#p_begin">BEGIN</a> and instead of <a href="#p_end">END</a> to implement structured
\r
1343 execution control. AGAIN scans the datastack for the nearest preceding
\r
1344 BEGIN marker and lays out an unconditional branch from this point the
\r
1345 beginning of the block during execution. It thereafter performs the
\r
1346 <a href="#p_end">END</a> compile action to end the block.</p></div>
\r
1347 <div style="text-align:center">
\r
1348 _______________________________________________________
\r
1350 <div class="paragraph"><p><a id="p_allot"></a></p></div>
\r
1352 <div class="sect2">
\r
1353 <h3 id="_word_allot">Word: ALLOT</h3>
\r
1354 <div class="literalblock">
\r
1355 <div class="content">
\r
1356 <pre><code>Data stack: ( n -- )</code></pre>
\r
1358 <div class="paragraph"><p>"ALLOT" is a function word that merely increments the <a href="#p_here">HERE</a>
\r
1359 variable with <code>n</code> so as to claim that amount of the heap.</p></div>
\r
1360 <div class="exampleblock">
\r
1361 <div class="content">
\r
1362 <div class="sidebarblock">
\r
1363 <div class="content">
\r
1364 <div class="title">Defintion concept for ALLOT</div>
\r
1365 <div class="paragraph"><p>( n — ) : ALLOT HERE @ + HERE ! ;</p></div>
\r
1368 <div class="exampleblock">
\r
1369 <div class="content">
\r
1370 <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
1372 <div style="text-align:center">
\r
1373 _______________________________________________________
\r
1375 <div class="paragraph"><p><a id="p_and"></a></p></div>
\r
1377 <div class="sect2">
\r
1378 <h3 id="_word_and">Word: AND</h3>
\r
1379 <div class="literalblock">
\r
1380 <div class="content">
\r
1381 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
1383 <div class="paragraph"><p>"AND" is a function word that replaces a value pair with their bitwise
\r
1384 conjunction; each bit is 1 if the corresponding bits of both operands
\r
1385 are 1 and 0 if not.</p></div>
\r
1386 <div style="text-align:center">
\r
1387 _______________________________________________________
\r
1389 <div class="paragraph"><p><a id="p_args"></a></p></div>
\r
1391 <div class="sect2">
\r
1392 <h3 id="_word_main_args">Word: MAIN-ARGS</h3>
\r
1393 <div class="literalblock">
\r
1394 <div class="content">
\r
1395 <pre><code>Data stack: ( -- p[argv** argc] )</code></pre>
\r
1397 <div class="paragraph"><p>"ARGS" is a value word that holds a pointer to the command line data
\r
1398 block which consists of a count cell followed by that many asciiz
\r
1399 pointers and then a 0 cell.</p></div>
\r
1400 <div class="exampleblock">
\r
1401 <div class="content">
\r
1402 <div class="listingblock">
\r
1403 <div class="title">Usage example 2: the command line argument block</div>
\r
1404 <div class="content">
\r
1405 <pre><code>ARGS -> 8 bytes: count of non-zero asciiz pointers following
\r
1406 8 bytes: command name string
\r
1407 8 bytes: first argument string
\r
1409 8 zero</code></pre>
\r
1412 <div style="text-align:center">
\r
1413 _______________________________________________________
\r
1415 <div class="paragraph"><p><a id="p_base"></a></p></div>
\r
1417 <div class="sect2">
\r
1418 <h3 id="_word_base">Word: BASE</h3>
\r
1419 <div class="literalblock">
\r
1420 <div class="content">
\r
1421 <pre><code>Data stack: ( -- a )</code></pre>
\r
1423 <div class="paragraph"><p>"BASE" is a variable word for the numerical base used by input and
\r
1424 output functions, <a href="#p_number">NUMBER</a> and <a href="#p_dot">[p_dot]</a>, when
\r
1425 translating numbers between cell value form and text form. The
\r
1426 numerical base is set to 10 or 16 by <a href="#p_decimal">DECIMAL</a> and
\r
1427 <a href="#p_hex">HEX</a> respectively, and those are the only two bases currently
\r
1428 supported.</p></div>
\r
1429 <div class="paragraph"><p>See also <a href="#p_digits">DIGITS</a>, which holds the mapping table from
\r
1430 digits to text.</p></div>
\r
1431 <div style="text-align:center">
\r
1432 _______________________________________________________
\r
1434 <div class="paragraph"><p><a id="p_begin"></a></p></div>
\r
1436 <div class="sect2">
\r
1437 <h3 id="_word_begin">Word: BEGIN</h3>
\r
1438 <div class="literalblock">
\r
1439 <div class="content">
\r
1440 <pre><code>Data stack: Compiling: ( -- a 0 )</code></pre>
\r
1442 <div class="paragraph"><p>"BEGIN" is an immediate function word that is used together with
\r
1443 <a href="#p_ifbreak">IFBREAK</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
1444 implement structured execution control. BEGIN simply places the
\r
1445 address for resolving branches back to this point during execution,
\r
1446 and then a 0 as a marker so as to allow for an unknown number of block
\r
1447 exit points.</p></div>
\r
1448 <div class="exampleblock">
\r
1449 <div class="content">
\r
1450 <div class="listingblock">
\r
1451 <div class="title">Usage example 3:</div>
\r
1452 <div class="content">
\r
1453 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1454 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1457 : WORDS ( wordlist -- ; Print all words of word list )
\r
1467 <div style="text-align:center">
\r
1468 _______________________________________________________
\r
1470 <div class="paragraph"><p><a id="p_bracketed_quote"></a></p></div>
\r
1472 <div class="sect2">
\r
1473 <h3 id="_word">Word: [']</h3>
\r
1474 <div class="literalblock">
\r
1475 <div class="content">
\r
1476 <pre><code>Data stack: ( -- cfa ) Input stream: word</code></pre>
\r
1478 <div class="paragraph"><p>"[']" is an immediate function word that reads the next word on the
\r
1479 input stream and pushes its cfa.</p></div>
\r
1480 <div class="exampleblock">
\r
1481 <div class="content">
\r
1482 <div class="sidebarblock">
\r
1483 <div class="content">
\r
1484 <div class="title">Definition concept for [']</div>
\r
1485 <div class="paragraph"><p>: ['] IMMEDIATE ' ;</p></div>
\r
1488 <div style="text-align:center">
\r
1489 _______________________________________________________
\r
1491 <div class="paragraph"><p><a id="p_branch"></a></p></div>
\r
1493 <div class="sect2">
\r
1494 <h3 id="_word_branch">Word: BRANCH</h3>
\r
1495 <div class="literalblock">
\r
1496 <div class="content">
\r
1497 <pre><code>Data stack: ( -- )</code></pre>
\r
1499 <div class="paragraph"><p>"BRANCH" is a function word that implements execution transfer by
\r
1500 means of adding the subsequent branch offset to the point of
\r
1501 execution.</p></div>
\r
1502 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
1503 definition take up a cell of 8 bytes. The offset is relative to the
\r
1504 cell address immediately subsequent to the offset cell. In other
\r
1505 words, offset 0 is not branching anywhere and an offset of -16 would
\r
1506 make a tight loop back to the branch instruction itself. The latter
\r
1507 would pull data stack values until and including the first zero value.</p></div>
\r
1508 <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
1509 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1510 <div style="text-align:center">
\r
1511 _______________________________________________________
\r
1513 <div class="paragraph"><p><a id="p_break"></a></p></div>
\r
1515 <div class="sect2">
\r
1516 <h3 id="_word_break">Word: BREAK</h3>
\r
1517 <div class="paragraph"><p>"BREAK" is an immediate function word that lays out an unconditional
\r
1518 branch out of an enclosing xef:p_begin[BEGIN]-<a href="#p_end">END</a> block.
\r
1519 Similar to <a href="#p_ifbreak">IFBREAK</a> it lays out the branch cell
\r
1520 followed by a reserved cell for the branch offset, and inserts the
\r
1521 resolution address just above the required 0 on the data stack.</p></div>
\r
1522 <div class="exampleblock">
\r
1523 <div class="content">
\r
1524 <div class="listingblock">
\r
1525 <div class="title">Usage example 4: unconditional break with a condition.</div>
\r
1526 <div class="content">
\r
1527 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1528 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1531 : WORDS ( wordlist -- ; Print all words of word list )
\r
1533 @ DUP IF DUP WTELL ELSE BREAK THEN
\r
1541 <div class="paragraph"><p>See also <a href="#p_branch">BRANCH</a>, <a href="#p_0branch">0BRANCH</a>,
\r
1542 <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>, <a href="#p_else">ELSE</a>,
\r
1543 <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1544 <div style="text-align:center">
\r
1545 _______________________________________________________
\r
1547 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>
\r
1549 <div class="sect2">
\r
1550 <h3 id="_word_calltrace">Word: [calltrace]</h3>
\r
1551 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly
\r
1552 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>
\r
1553 <div style="text-align:center">
\r
1554 _______________________________________________________
\r
1556 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>
\r
1558 <div class="sect2">
\r
1559 <h3 id="_word_cfa_gt_flags">Word: CFA>FLAGS@</h3>
\r
1560 <div class="literalblock">
\r
1561 <div class="content">
\r
1562 <pre><code>Data stack: ( cfa -- flags )</code></pre>
\r
1564 <div class="paragraph"><p>"CFA>FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>
\r
1565 <div class="exampleblock">
\r
1566 <div class="content">
\r
1567 <div class="sidebarblock">
\r
1568 <div class="content">
\r
1569 <div class="title">Defintion concept for CFA>FLAGS@</div>
\r
1570 <div class="paragraph"><p>: CFA>FLAGS@ 16 - @ 16 + ;</p></div>
\r
1573 <div style="text-align:center">
\r
1574 _______________________________________________________
\r
1576 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>
\r
1578 <div class="sect2">
\r
1579 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>
\r
1580 <div class="literalblock">
\r
1581 <div class="content">
\r
1582 <pre><code>Data stack: ( stream -- )</code></pre>
\r
1584 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently
\r
1585 remaining in the buffer for the stream, so that a subsequent read will
\r
1586 pull in more data from its source.</p></div>
\r
1587 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>
\r
1588 <div style="text-align:center">
\r
1589 _______________________________________________________
\r
1591 <div class="paragraph"><p><a id="p_colon"></a></p></div>
\r
1593 <div class="sect2">
\r
1594 <h3 id="_word_3">Word: :</h3>
\r
1595 <div class="literalblock">
\r
1596 <div class="content">
\r
1597 <pre><code>Data stack: ( -- ) Input stream: word</code></pre>
\r
1599 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.
\r
1600 This includes reading the next word for making a new dictionary entry
\r
1601 and setting evaluation state to compiling mode.</p></div>
\r
1602 <div class="exampleblock">
\r
1603 <div class="content">
\r
1604 <div class="sidebarblock">
\r
1605 <div class="content">
\r
1606 <div class="title">Definition concept for :</div>
\r
1607 <div class="paragraph"><p>: : doFORTH READ-WORD CREATE TFA>CFA ! ] ;</p></div>
\r
1610 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,
\r
1611 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA>CFA</a>, <a href="#p_put">!</a>,
\r
1612 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1613 <div style="text-align:center">
\r
1614 _______________________________________________________
\r
1616 <div class="paragraph"><p><a id="p_comma"></a></p></div>
\r
1618 <div class="sect2">
\r
1619 <h3 id="_word_4">Word: ,</h3>
\r
1620 <div class="literalblock">
\r
1621 <div class="content">
\r
1622 <pre><code>Data stack: ( v -- )</code></pre>
\r
1624 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the
\r
1625 <a href="#p_here">HERE</a> heap.</p></div>
\r
1626 <div class="exampleblock">
\r
1627 <div class="content">
\r
1628 <div class="sidebarblock">
\r
1629 <div class="content">
\r
1630 <div class="title">Definition concept for ,</div>
\r
1631 <div class="paragraph"><p>: , HERE @ 8 ALLOT ! ; ( v — ; Claim 8 bytes and put value there )</p></div>
\r
1634 <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
1635 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1636 <div style="text-align:center">
\r
1637 _______________________________________________________
\r
1639 <div class="paragraph"><p><a id="p_create"></a></p></div>
\r
1641 <div class="sect2">
\r
1642 <h3 id="_word_create">Word: CREATE</h3>
\r
1643 <div class="literalblock">
\r
1644 <div class="content">
\r
1645 <pre><code>Data stack: ( char* n -- tfa )</code></pre>
\r
1647 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the
\r
1648 indicated [n:char*] print name, and returns the "TFA" (Token Field
\r
1649 Address) of the word. The header memory layout is as follows:</p></div>
\r
1650 <div class="exampleblock">
\r
1651 <div class="content">
\r
1652 <div class="listingblock">
\r
1653 <div class="title">Layout 1: rrqforth word structure</div>
\r
1654 <div class="content">
\r
1655 <pre><code>struct WORD
\r
1656 TFA 8 link ; tfa of previous word
\r
1657 pCFA 8 cfap ; CFA = Code Field Address of this word
\r
1659 PFA 8 length ; length of pname representation
\r
1660 ? pname ; the pname bytes
\r
1661 1 nul ; a forced nul byte following the pname
\r
1662 pTFA 8 tfap ; TFA = Token Field Address of this word
\r
1663 OFF 8 doff ; entry offset for FORTH level execution
\r
1664 CFA 8 doer ; word execution semantics
\r
1665 DFA 0 content ; DFA = Data Field Address
\r
1666 end_struct</code></pre>
\r
1669 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content
\r
1670 as held in the memory space following the DFA (Data Field Address).</p></div>
\r
1671 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for
\r
1672 RRQFORTH execution, as holding a jump address to the assembly code
\r
1673 that implements the particular execution semantics for the word.
\r
1674 "CREATE" will assign this as "dovariable", which makes the word push
\r
1675 its DFA when executed. This is changed to "doforth" for RRQFORTH
\r
1676 function words initiated by ":" (aka "COLON") or changed to "dovalue"
\r
1677 for RRQFORTH constants created by "CONSTANT".</p></div>
\r
1678 <div class="exampleblock">
\r
1679 <div class="content">
\r
1680 <div class="sidebarblock">
\r
1681 <div class="content">
\r
1682 <div class="title">Definition concept for CREATE</div>
\r
1683 <div class="paragraph"><p>HERE @ R> ( save tfa on RS )
\r
1684 R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )
\r
1685 DUP 49 + R@ + , ( pCFA )
\r
1688 HERE @ ROT ROT MEMCPY 0 C, ( pname + NUL )
\r
1691 doVARIABLE ( CFA, default semantics )</p></div>
\r
1694 <div class="exampleblock">
\r
1695 <div class="content">
\r
1696 <div class="listingblock">
\r
1697 <div class="title">Usage example 5: a possible definition of CONSTANT</div>
\r
1698 <div class="content">
\r
1699 <pre><code>: CONSTANT READ-WORD CREATE TFA>DFA doVALUE OVER 8 - ! ! ;</code></pre>
\r
1702 <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
1703 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,
\r
1704 <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
1705 and <a href="#p_dovariable">doVARIABLE</a>,
\r
1706 as well as <a href="#p_execute">EXECUTE</a>
\r
1707 about the range of "doer" assignments and their meanings.</p></div>
\r
1708 <div style="text-align:center">
\r
1709 _______________________________________________________
\r
1711 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>
\r
1713 <div class="sect2">
\r
1714 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>
\r
1715 <div class="literalblock">
\r
1716 <div class="content">
\r
1717 <pre><code>Data stack: ( -- a )</code></pre>
\r
1719 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the
\r
1720 current word list word for <a href="#p_find">FIND</a> to use finding words. The
\r
1721 word list word content is as follows:</p></div>
\r
1722 <div class="exampleblock">
\r
1723 <div class="content">
\r
1724 <div class="listingblock">
\r
1725 <div class="title">Layout 2: word list word content</div>
\r
1726 <div class="content">
\r
1727 <pre><code> 8 TFA of latest word in the word list
\r
1728 8 DFA of the/a subsequent word list to search through</code></pre>
\r
1731 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends
\r
1732 with the <a href="#p_forth">FORTH</a> word list. Initially the
\r
1733 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>
\r
1734 <div style="text-align:center">
\r
1735 _______________________________________________________
\r
1737 <div class="paragraph"><p><a id="data_stack"></a></p></div>
\r
1739 <div class="sect2">
\r
1740 <h3 id="_word_data_stack">Word: DATA-STACK</h3>
\r
1741 <div class="literalblock">
\r
1742 <div class="content">
\r
1743 <pre><code>Data stack: ( -- a )</code></pre>
\r
1745 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>
\r
1746 <div style="text-align:center">
\r
1747 _______________________________________________________
\r
1749 <div class="paragraph"><p><a id="p_decimal"></a></p></div>
\r
1751 <div class="sect2">
\r
1752 <h3 id="_word_decimal">Word: DECIMAL</h3>
\r
1753 <div class="literalblock">
\r
1754 <div class="content">
\r
1755 <pre><code>Data stack: ( -- )</code></pre>
\r
1757 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>
\r
1758 <div class="exampleblock">
\r
1759 <div class="content">
\r
1760 <div class="sidebarblock">
\r
1761 <div class="content">
\r
1762 <div class="title">Definition concept for DECIMAL</div>
\r
1763 <div class="paragraph"><p>: DECIMAL 10 BASE ! ;</p></div>
\r
1766 <div style="text-align:center">
\r
1767 _______________________________________________________
\r
1769 <div class="paragraph"><p><a id="p_definitions"></a></p></div>
\r
1771 <div class="sect2">
\r
1772 <h3 id="_word_definitions">Word: DEFINITIONS</h3>
\r
1773 <div class="literalblock">
\r
1774 <div class="content">
\r
1775 <pre><code>Data stack: ( wordlist -- )</code></pre>
\r
1777 <div class="paragraph"><p>"DEFINITIONS" is a function word that installs the given wordlist as
\r
1778 the <a href="#p_current_wordlist">CURRENT-WORDLIST</a> one.</p></div>
\r
1779 <div class="exampleblock">
\r
1780 <div class="content">
\r
1781 <div class="sidebarblock">
\r
1782 <div class="content">
\r
1783 <div class="title">Definition concept for DEFINITIONS</div>
\r
1784 <div class="paragraph"><p>: DEFINITIONS CURRENT-WORDLIST ! ;</p></div>
\r
1787 <div style="text-align:center">
\r
1788 _______________________________________________________
\r
1790 <div class="paragraph"><p><a id="p_depth"></a></p></div>
\r
1792 <div class="sect2">
\r
1793 <h3 id="_word_depth">Word: DEPTH</h3>
\r
1794 <div class="literalblock">
\r
1795 <div class="content">
\r
1796 <pre><code>Data stack: ( -- v )</code></pre>
\r
1798 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells
\r
1799 onto the data stack.</p></div>
\r
1800 <div style="text-align:center">
\r
1801 _______________________________________________________
\r
1803 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>
\r
1805 <div class="sect2">
\r
1806 <h3 id="_word_dfa_gt_tfa">Word: DFA>TFA</h3>
\r
1807 <div class="literalblock">
\r
1808 <div class="content">
\r
1809 <pre><code>Data stack: ( dfa -- tfa )</code></pre>
\r
1811 <div class="paragraph"><p>"DFA>TFA" is a function word that pushes word tfa of the given dfa.</p></div>
\r
1812 <div class="exampleblock">
\r
1813 <div class="content">
\r
1814 <div class="sidebarblock">
\r
1815 <div class="content">
\r
1816 <div class="title">Definition concept for DFA>TFA</div>
\r
1817 <div class="paragraph"><p>: DFA>TFA 24 - @ ;</p></div>
\r
1820 <div style="text-align:center">
\r
1821 _______________________________________________________
\r
1823 <div class="paragraph"><p><a id="p_digits"></a></p></div>
\r
1825 <div class="sect2">
\r
1826 <h3 id="_word_digits">Word: DIGITS</h3>
\r
1827 <div class="literalblock">
\r
1828 <div class="content">
\r
1829 <pre><code>Data stack: ( -- a )</code></pre>
\r
1831 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping
\r
1832 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>
\r
1833 <div style="text-align:center">
\r
1834 _______________________________________________________
\r
1836 <div class="paragraph"><p><a id="p_div"></a></p></div>
\r
1838 <div class="sect2">
\r
1839 <h3 id="_word_5">Word: /</h3>
\r
1840 <div class="literalblock">
\r
1841 <div class="content">
\r
1842 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>
\r
1844 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the
\r
1845 results of signed integer division of the first, v1, divided by the
\r
1846 second, v2. To that end, the values are 64-bit signed integers. The
\r
1847 result is the integer quotient, q, and the discarded remainder, r,
\r
1848 where q and r are the respectively largest and smallest integers to
\r
1849 satisfy the formula:</p></div>
\r
1850 <div class="literalblock">
\r
1851 <div class="content">
\r
1852 <pre><code> v1 = q * v2 + r</code></pre>
\r
1854 <div style="text-align:center">
\r
1855 _______________________________________________________
\r
1857 <div class="paragraph"><p><a id="p_divmod"></a></p></div>
\r
1859 <div class="sect2">
\r
1860 <h3 id="_word_mod">Word: /MOD</h3>
\r
1861 <div class="literalblock">
\r
1862 <div class="content">
\r
1863 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>
\r
1865 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values
\r
1866 with the results of signed integer division of the first, v1, divided
\r
1867 by the second, v2. To that end, the values are 64-bit signed integers.
\r
1868 The result is the integer quotient, q, and the remainder, r, where q
\r
1869 and r are the respectively largest and smallest integers to satisfy
\r
1870 the formula:</p></div>
\r
1871 <div class="literalblock">
\r
1872 <div class="content">
\r
1873 <pre><code> v1 = q * v2 + r</code></pre>
\r
1875 <div style="text-align:center">
\r
1876 _______________________________________________________
\r
1878 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>
\r
1880 <div class="sect2">
\r
1881 <h3 id="_word_dodoes">Word: doDOES</h3>
\r
1882 <div class="literalblock">
\r
1883 <div class="content">
\r
1884 <pre><code>Data stack: ( -- a )</code></pre>
\r
1886 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the
\r
1887 <a href="#p_does">[p_does]</a> execution semantics. This is the same as
\r
1888 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word
\r
1889 concerned.</p></div>
\r
1890 <div style="text-align:center">
\r
1891 _______________________________________________________
\r
1893 <div class="paragraph"><p><a id="p_does"></a></p></div>
\r
1895 <div class="sect2">
\r
1896 <h3 id="_word_does_gt">WORD: DOES></h3>
\r
1897 <div class="literalblock">
\r
1898 <div class="content">
\r
1899 <pre><code>Data stack: ( -- )</code></pre>
\r
1901 <div class="paragraph"><p>"DOES>" is a function that in execution mode does nothing but in
\r
1902 compilation mode it changes the execution semantics assignments for
\r
1903 the most recent word to use the <code>dodoes</code> sematics with adjustment
\r
1904 offset to the current heap address. I.e., the word being defined will
\r
1905 have its execution start at whatever comes after "DOES>".</p></div>
\r
1906 <div class="exampleblock">
\r
1907 <div class="content">
\r
1908 <div class="sidebarblock">
\r
1909 <div class="content">
\r
1910 <div class="title">Defintion concept for DOES></div>
\r
1911 <div class="paragraph"><p>: DOES> IMMEDIATE
\r
1912 STATE @ != IF ( only for compilation mode )
\r
1913 CURRENT-WORDLIST @ @ TFA>CFA ( cfa of current word )
\r
1914 doDOES OVER ! ( set up doer )
\r
1915 HERE @ OVER 8 + - SWAP 8 - ! ( set up offset
\r
1920 <div class="paragraph"><p>See also
\r
1921 <a href="#p_put">!</a>,
\r
1922 <a href="#p_unequal">!⇒></a>,
\r
1923 <a href="#p_minus">→></a>,
\r
1924 <a href="#p_get">@</a>,
\r
1925 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
1926 <a href="#p_here">HERE</a>,
\r
1927 <a href="#p_if">IF</a>,
\r
1928 <a href="#p_immediate">IMMEDIATE</a>,
\r
1929 <a href="#p_over">OVER</a>,
\r
1930 <a href="#p_state">STATE</a>,
\r
1931 <a href="#p_swap">SWAP</a>,
\r
1932 <a href="#p_tfa2cfa">TFA>CFA</a>,
\r
1933 <a href="#p_then">THEN</a>,
\r
1934 <a href="#p_dodoes">doDOES</a>,
\r
1935 as well as <a href="#p_execute">EXECUTE</a>
\r
1936 about the range of "doer" assignments and their meanings.</p></div>
\r
1937 <div style="text-align:center">
\r
1938 _______________________________________________________
\r
1940 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>
\r
1942 <div class="sect2">
\r
1943 <h3 id="_word_dofasm">Word: doFASM</h3>
\r
1944 <div class="literalblock">
\r
1945 <div class="content">
\r
1946 <pre><code>Data stack: ( -- a )</code></pre>
\r
1948 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1949 execution semantics for assembly code content.</p></div>
\r
1950 <div style="text-align:center">
\r
1951 _______________________________________________________
\r
1953 <div class="paragraph"><p><a id="p_doforth"></a></p></div>
\r
1955 <div class="sect2">
\r
1956 <h3 id="_word_doforth">Word: doFORTH</h3>
\r
1957 <div class="literalblock">
\r
1958 <div class="content">
\r
1959 <pre><code>Data stack: ( -- a )</code></pre>
\r
1961 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the
\r
1962 RRQFORTH execution semantics.</p></div>
\r
1963 <div style="text-align:center">
\r
1964 _______________________________________________________
\r
1966 <div class="paragraph"><p><a id="p_dostring"></a></p></div>
\r
1968 <div class="sect2">
\r
1969 <h3 id="_word_dostring">Word: doSTRING</h3>
\r
1970 <div class="literalblock">
\r
1971 <div class="content">
\r
1972 <pre><code>Data stack: ( -- a )</code></pre>
\r
1974 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1975 execution semantics for assembly code implemented words. In those
\r
1976 cases the execution leads to the word content.</p></div>
\r
1977 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is
\r
1978 as follows:</p></div>
\r
1979 <div class="listingblock">
\r
1980 <div class="content">
\r
1981 <pre><code> rax = cfa* of word to execute
\r
1982 rsi = cell* in the calling definition, after calling cell
\r
1983 rsp = data stack pointer
\r
1984 rbp = return stack pointer</code></pre>
\r
1986 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>
\r
1987 and <code>rbp</code> are used according to their roles.</p></div>
\r
1988 <div style="text-align:center">
\r
1989 _______________________________________________________
\r
1991 <div class="paragraph"><p><a id="p_dot"></a></p></div>
\r
1993 <div class="sect2">
\r
1994 <h3 id="_word_6">Word: .</h3>
\r
1995 <div class="literalblock">
\r
1996 <div class="content">
\r
1997 <pre><code>Data stack: ( v -- )</code></pre>
\r
1999 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using
\r
2000 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or
\r
2001 <a href="#p_hex">HEX</a>).</p></div>
\r
2002 <div style="text-align:center">
\r
2003 _______________________________________________________
\r
2005 <div class="paragraph"><p><a id="p_dot_temp"></a></p></div>
\r
2007 <div class="sect2">
\r
2008 <h3 id="_word_temp">Word: .TEMP</h3>
\r
2009 <div class="literalblock">
\r
2010 <div class="content">
\r
2011 <pre><code>Data stack: ( v -- char* n )</code></pre>
\r
2013 <div class="paragraph"><p>".TEMP" is a function word that renders a cell value as an integer
\r
2014 using the current <a href="#p_base">BASE</a>, which is either
\r
2015 <a href="#p_decimal">DECIMAL</a> or <a href="#p_hex">HEX</a>. In <a href="#p_decimal">DECIMAL</a>
\r
2016 <a href="#p_base">BASE</a>, a negative value is rendered as such with a leading
\r
2017 minus sign, whereas <a href="#p_hex">HEX</a> <a href="#p_base">BASE</a> rendering is
\r
2018 unsigned.</p></div>
\r
2019 <div style="text-align:center">
\r
2020 _______________________________________________________
\r
2022 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>
\r
2024 <div class="sect2">
\r
2025 <h3 id="_word_7">Word: "</h3>
\r
2026 <div class="literalblock">
\r
2027 <div class="content">
\r
2028 <pre><code>data stack: ( -- char n ) Input stream: ...."</code></pre>
\r
2030 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream
\r
2031 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the
\r
2032 [n:char*] cell pair for that string.</p></div>
\r
2033 <div style="text-align:center">
\r
2034 _______________________________________________________
\r
2036 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>
\r
2038 <div class="sect2">
\r
2039 <h3 id="_word_dovalue">Word: doVALUE</h3>
\r
2040 <div class="literalblock">
\r
2041 <div class="content">
\r
2042 <pre><code>Data stack: ( -- a )</code></pre>
\r
2044 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the
\r
2045 execution semantics for cell values, which are variables with a single
\r
2046 64-bit cell holding the value.</p></div>
\r
2047 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>
\r
2048 <div class="literalblock">
\r
2049 <div class="content">
\r
2050 <pre><code>Resulting data stack: ( -- v )</code></pre>
\r
2052 <div style="text-align:center">
\r
2053 _______________________________________________________
\r
2055 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>
\r
2057 <div class="sect2">
\r
2058 <h3 id="_word_dovariable">Word: doVARIABLE</h3>
\r
2059 <div class="literalblock">
\r
2060 <div class="content">
\r
2061 <pre><code>Data stack: ( -- a )</code></pre>
\r
2063 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of
\r
2064 the execution semantics for "variables", which basically are markers
\r
2065 into the heap for some number block of memory.</p></div>
\r
2066 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>
\r
2067 <div class="literalblock">
\r
2068 <div class="content">
\r
2069 <pre><code>Resulting data stack: ( -- a )</code></pre>
\r
2071 <div style="text-align:center">
\r
2072 _______________________________________________________
\r
2074 <div class="paragraph"><p><a id="p_drop"></a></p></div>
\r
2076 <div class="sect2">
\r
2077 <h3 id="_word_drop">Word: DROP</h3>
\r
2078 <div class="literalblock">
\r
2079 <div class="content">
\r
2080 <pre><code>Data stack: ( v -- )</code></pre>
\r
2082 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>
\r
2083 <div style="text-align:center">
\r
2084 _______________________________________________________
\r
2086 <div class="paragraph"><p><a id="p_dup"></a></p></div>
\r
2088 <div class="sect2">
\r
2089 <h3 id="_word_dup">Word: DUP</h3>
\r
2090 <div class="literalblock">
\r
2091 <div class="content">
\r
2092 <pre><code>Data stack: ( v -- v v )</code></pre>
\r
2094 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>
\r
2095 <div style="text-align:center">
\r
2096 _______________________________________________________
\r
2098 <div class="paragraph"><p><a id="p_else"></a></p></div>
\r
2100 <div class="sect2">
\r
2101 <h3 id="_word_else">Word: ELSE</h3>
\r
2102 <div class="literalblock">
\r
2103 <div class="content">
\r
2104 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>
\r
2106 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with
\r
2107 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2108 control. ELSE lays out an unresolved unconditional branch as an ending
\r
2109 for the "then-part" of the structured statement, and it then performs
\r
2110 the branch resolution for the "else-part". To that end it replaces the
\r
2111 stacked address which pin-points the foot address the branch offset to
\r
2112 resolve, so that at execution time there is an appropriate conditional
\r
2113 branch past the "then-part" and the "else-part" of the "structured
\r
2114 statement".</p></div>
\r
2115 <div style="text-align:center">
\r
2116 _______________________________________________________
\r
2118 <div class="paragraph"><p><a id="p_emit"></a></p></div>
\r
2120 <div class="sect2">
\r
2121 <h3 id="_word_emit">Word: EMIT</h3>
\r
2122 <div class="literalblock">
\r
2123 <div class="content">
\r
2124 <pre><code>Data stack: ( c -- )</code></pre>
\r
2126 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to
\r
2127 standard output (file descriptor 1). The character is the least
\r
2128 significant byte of the top cell.</p></div>
\r
2129 <div style="text-align:center">
\r
2130 _______________________________________________________
\r
2132 <div class="paragraph"><p><a id="p_end"></a></p></div>
\r
2134 <div class="sect2">
\r
2135 <h3 id="_word_end">Word: END</h3>
\r
2136 <div class="literalblock">
\r
2137 <div class="content">
\r
2138 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>
\r
2140 <div class="paragraph"><p>"END" is an immediate function word that is used together with
\r
2141 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to
\r
2142 implement structured execution control. END processes the data stack
\r
2143 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the
\r
2144 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>
\r
2145 <div style="text-align:center">
\r
2146 _______________________________________________________
\r
2148 <div class="paragraph"><p><a id="p_equal"></a></p></div>
\r
2150 <div class="sect2">
\r
2151 <h3 id="_word_8">Word: =</h3>
\r
2152 <div class="literalblock">
\r
2153 <div class="content">
\r
2154 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2156 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the
\r
2157 values are equal, and 0 otherwise.</p></div>
\r
2158 <div style="text-align:center">
\r
2159 _______________________________________________________
\r
2161 <div class="paragraph"><p><a id="p_erase"></a></p></div>
\r
2163 <div class="sect2">
\r
2164 <h3 id="_word_erase">Word: ERASE</h3>
\r
2165 <div class="literalblock">
\r
2166 <div class="content">
\r
2167 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2169 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>
\r
2170 <div style="text-align:center">
\r
2171 _______________________________________________________
\r
2173 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>
\r
2175 <div class="sect2">
\r
2176 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>
\r
2177 <div class="literalblock">
\r
2178 <div class="content">
\r
2179 <pre><code>Data stack: ( stream -- ??? 0/1 ) Input stream: ......</code></pre>
\r
2181 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by
\r
2182 whitespace from the stream until it discovers an unknown word, or the
\r
2183 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are
\r
2184 either executed or compiled, and all ther stack and heap effects are
\r
2185 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the
\r
2186 stack to respectively indicate that the last word was unkown, i.e. not
\r
2187 found (<a href="#p_find">FIND</a>) in the current word list
\r
2188 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a
\r
2189 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>
\r
2190 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known
\r
2191 words that are parsed into cell values. If interpreting, then the
\r
2192 value is left on the stack. If compiling, then the value is added to
\r
2193 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done
\r
2194 so as to make that value be push to the data stack upon a later
\r
2195 execution.</p></div>
\r
2196 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a
\r
2197 minus sign.</p></div>
\r
2198 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its
\r
2199 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word
\r
2200 or not, and whether the state at the time of execution indicates
\r
2201 "compiling" of "interpreting". Immediate words are executed in both
\r
2202 interpreting and compiling state, while other words have their CFA get
\r
2203 added to the heap so as to gain their execution effect upon a later
\r
2204 execution.</p></div>
\r
2205 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return
\r
2206 stack while reading, parsing and executing.</p></div>
\r
2207 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds
\r
2208 the [n:chars] reference of the offending word in the stream buffer.</p></div>
\r
2209 <div style="text-align:center">
\r
2210 _______________________________________________________
\r
2212 <div class="paragraph"><p><a id="p_execute"></a></p></div>
\r
2214 <div class="sect2">
\r
2215 <h3 id="_word_execute">Word: EXECUTE</h3>
\r
2216 <div class="literalblock">
\r
2217 <div class="content">
\r
2218 <pre><code>Data stack: ( cfa -- )</code></pre>
\r
2220 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the
\r
2221 indicated "Code Field Address", which typically is the CFA of an
\r
2222 RRQFORTH word with the CFA cell containing a jump address for the code
\r
2223 that implements the execution semnatics of the word.</p></div>
\r
2224 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>
\r
2225 <div class="ulist"><ul>
\r
2228 assembler implemented words constitute their own execution
\r
2234 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word
\r
2235 content as a succession of cells that hold the cfa pointers for the
\r
2236 words that make of the definition. As is customary in FORTH
\r
2237 machines, the advance through that succession is provided by each
\r
2238 word code ending making an explicit jump to its successor. The
\r
2239 <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking
\r
2240 the nesting of FORTH executions by saving the "addresses" of the
\r
2246 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH
\r
2247 execution somewhere within a definition rather than at the
\r
2253 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement
\r
2254 different common ways of using word content other the as FORTH
\r
2259 <div style="text-align:center">
\r
2260 _______________________________________________________
\r
2262 <div class="paragraph"><p><a id="p_exit"></a></p></div>
\r
2264 <div class="sect2">
\r
2265 <h3 id="_word_exit">Word: EXIT</h3>
\r
2266 <div class="literalblock">
\r
2267 <div class="content">
\r
2268 <pre><code>Data stack: ( v -- )</code></pre>
\r
2270 <div class="paragraph"><p>"EXIT" is a function word that terminates the <code>rrqforth</code> process
\r
2271 immediately with the given exit code.</p></div>
\r
2272 <div style="text-align:center">
\r
2273 _______________________________________________________
\r
2275 <div class="paragraph"><p><a id="p_false"></a></p></div>
\r
2277 <div class="sect2">
\r
2278 <h3 id="_word_false">Word: FALSE</h3>
\r
2279 <div class="literalblock">
\r
2280 <div class="content">
\r
2281 <pre><code>Data stack: ( -- 0 )</code></pre>
\r
2283 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>
\r
2284 <div style="text-align:center">
\r
2285 _______________________________________________________
\r
2287 <div class="paragraph"><p><a id="p_fdemit"></a></p></div>
\r
2289 <div class="sect2">
\r
2290 <h3 id="_word_fdemit">Word: FDEMIT</h3>
\r
2291 <div class="literalblock">
\r
2292 <div class="content">
\r
2293 <pre><code>Data stack: ( c fd -- )</code></pre>
\r
2295 <div class="paragraph"><p>"FDEMIT" is a function word that puts the given character code to the
\r
2296 given file descriptor. The character is the least significant byte of
\r
2297 the data stack cell.</p></div>
\r
2298 <div style="text-align:center">
\r
2299 _______________________________________________________
\r
2301 <div class="paragraph"><p><a id="p_fdtell"></a></p></div>
\r
2303 <div class="sect2">
\r
2304 <h3 id="_word_fdtell">Word: FDTELL</h3>
\r
2305 <div class="literalblock">
\r
2306 <div class="content">
\r
2307 <pre><code>Data stack: ( char* n fd -- )</code></pre>
\r
2309 <div class="paragraph"><p>"FDTELL" is a function word that prints a string to the given file
\r
2310 descriptor.</p></div>
\r
2311 <div style="text-align:center">
\r
2312 _______________________________________________________
\r
2314 <div class="paragraph"><p><a id="p_find"></a></p></div>
\r
2316 <div class="sect2">
\r
2317 <h3 id="_word_find">Word: FIND</h3>
\r
2318 <div class="literalblock">
\r
2319 <div class="content">
\r
2320 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>
\r
2322 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search
\r
2323 path for the given [n:char*] word, and returns the TFA of the matching
\r
2324 word if any. Otherwise FIND preserves the initial data stack but adds
\r
2325 0 to it.</p></div>
\r
2326 <div class="paragraph"><p>The word is sought starting with the
\r
2327 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first
\r
2328 occurence of a match. If not found, the search continues with the
\r
2329 subsequent word list, and so on.</p></div>
\r
2330 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the
\r
2331 [n:char*] double cell string pointer and pushing (only) the TFA of the
\r
2332 matching word instead.</p></div>
\r
2333 <div style="text-align:center">
\r
2334 _______________________________________________________
\r
2336 <div class="paragraph"><p><a id="p_forth"></a></p></div>
\r
2338 <div class="sect2">
\r
2339 <h3 id="_word_forth">Word: FORTH</h3>
\r
2340 <div class="literalblock">
\r
2341 <div class="content">
\r
2342 <pre><code>data stack: ( -- a )</code></pre>
\r
2344 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not
\r
2345 have any subsequent word list.</p></div>
\r
2346 <div style="text-align:center">
\r
2347 _______________________________________________________
\r
2349 <div class="paragraph"><p><a id="p_get"></a></p></div>
\r
2351 <div class="sect2">
\r
2352 <h3 id="_word_9">Word: @</h3>
\r
2353 <div class="literalblock">
\r
2354 <div class="content">
\r
2355 <pre><code>Data stack: ( a -- v )</code></pre>
\r
2357 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>
\r
2358 <div style="text-align:center">
\r
2359 _______________________________________________________
\r
2361 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>
\r
2363 <div class="sect2">
\r
2364 <h3 id="_word_n">Word: @n--</h3>
\r
2365 <div class="literalblock">
\r
2366 <div class="content">
\r
2367 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2369 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,
\r
2370 then decrements the cell at that address by n.</p></div>
\r
2371 <div class="exampleblock">
\r
2372 <div class="content">
\r
2373 <div class="sidebarblock">
\r
2374 <div class="content">
\r
2375 <div class="title">Defintion concept for @n++</div>
\r
2376 <div class="paragraph"><p>: @n++ OVER @ DUP ROT - ROT ! ;</p></div>
\r
2379 <div style="text-align:center">
\r
2380 _______________________________________________________
\r
2382 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>
\r
2384 <div class="sect2">
\r
2385 <h3 id="_word_n_2">Word: @n++</h3>
\r
2386 <div class="literalblock">
\r
2387 <div class="content">
\r
2388 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2390 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,
\r
2391 then increments the cell at that address by n.</p></div>
\r
2392 <div class="exampleblock">
\r
2393 <div class="content">
\r
2394 <div class="sidebarblock">
\r
2395 <div class="content">
\r
2396 <div class="title">Defintion concept for @n++</div>
\r
2397 <div class="paragraph"><p>( a n — v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>
\r
2400 <div style="text-align:center">
\r
2401 _______________________________________________________
\r
2403 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>
\r
2405 <div class="sect2">
\r
2406 <h3 id="_word_gt">Word: >=</h3>
\r
2407 <div class="literalblock">
\r
2408 <div class="content">
\r
2409 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2411 <div class="paragraph"><p>">=" is a function word that replaces a pair of values with -1 if the
\r
2412 first, v1, is greater than or equal to the second, v1, otherwise 0. To
\r
2413 that end, the values are 64-bit signed integers.</p></div>
\r
2414 <div style="text-align:center">
\r
2415 _______________________________________________________
\r
2417 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>
\r
2419 <div class="sect2">
\r
2420 <h3 id="_word_gt_2">Word: ></h3>
\r
2421 <div class="literalblock">
\r
2422 <div class="content">
\r
2423 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2425 <div class="paragraph"><p>">" is a function word that replaces a pair of values with -1 if the
\r
2426 first, v1, is greater than the second, v1, otherwise 0. To that end,
\r
2427 the values are 64-bit signed integers.</p></div>
\r
2428 <div style="text-align:center">
\r
2429 _______________________________________________________
\r
2431 <div class="paragraph"><p><a id="p_gtR"></a></p></div>
\r
2433 <div class="sect2">
\r
2434 <h3 id="_word_gt_r">Word: >R</h3>
\r
2435 <div class="literalblock">
\r
2436 <div class="content">
\r
2437 <pre><code>Data stack: ( v -- ) Return stack: ( -- v )</code></pre>
\r
2439 <div class="paragraph"><p>">R" is a function word that "moves" the top data stack value onto the
\r
2440 return stack.</p></div>
\r
2441 <div style="text-align:center">
\r
2442 _______________________________________________________
\r
2444 <div class="paragraph"><p><a id="p_here"></a></p></div>
\r
2446 <div class="sect2">
\r
2447 <h3 id="_word_here">Word: HERE</h3>
\r
2448 <div class="literalblock">
\r
2449 <div class="content">
\r
2450 <pre><code>Data stack: ( -- a )</code></pre>
\r
2452 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free
\r
2453 allocation space. It get updated by all words that allocate memory.</p></div>
\r
2454 <div class="exampleblock">
\r
2455 <div class="content">
\r
2456 <div class="sidebarblock">
\r
2457 <div class="content">
\r
2458 <div class="title">allocate 1024 bytes on the heap</div>
\r
2459 <div class="paragraph"><p>1024 HEAP @ + HEAP !</p></div>
\r
2462 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>
\r
2463 <div style="text-align:center">
\r
2464 _______________________________________________________
\r
2466 <div class="paragraph"><p><a id="p_hex"></a></p></div>
\r
2468 <div class="sect2">
\r
2469 <h3 id="_word_hex">Word: HEX</h3>
\r
2470 <div class="literalblock">
\r
2471 <div class="content">
\r
2472 <pre><code>Data stack: ( -- )</code></pre>
\r
2474 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses
\r
2475 letters a-f as additional digits. (Uppercase letter are also accepted
\r
2476 on input).</p></div>
\r
2477 <div class="exampleblock">
\r
2478 <div class="content">
\r
2479 <div class="sidebarblock">
\r
2480 <div class="content">
\r
2481 <div class="title">Definition concept for HEX</div>
\r
2482 <div class="paragraph"><p>: HEX 16 BASE ! ;</p></div>
\r
2485 <div style="text-align:center">
\r
2486 _______________________________________________________
\r
2488 <div class="paragraph"><p><a id="p_if"></a></p></div>
\r
2490 <div class="sect2">
\r
2491 <h3 id="_word_if">Word: IF</h3>
\r
2492 <div class="literalblock">
\r
2493 <div class="content">
\r
2494 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2496 <div class="paragraph"><p>"IF" is an immediate function word that is used together with
\r
2497 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2498 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction
\r
2499 with an unresolved branch offset, and places the address for resolving
\r
2500 this instruction on the datastack. This address will then be resolved
\r
2501 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so
\r
2502 that at execution time there is an appropriate conditional branch past
\r
2503 the "then-part" of the "structured statement".</p></div>
\r
2504 <div style="text-align:center">
\r
2505 _______________________________________________________
\r
2507 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>
\r
2509 <div class="sect2">
\r
2510 <h3 id="_word_ifagain">Word: IFAGAIN</h3>
\r
2511 <div class="literalblock">
\r
2512 <div class="content">
\r
2513 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2515 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with
\r
2516 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement
\r
2517 structured execution control. IFAGAIN scans the datastack for the
\r
2518 nearest preceding BEGIN marker and lays out a branch from this point
\r
2519 the beginning of the block during execution.</p></div>
\r
2520 <div style="text-align:center">
\r
2521 _______________________________________________________
\r
2523 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>
\r
2525 <div class="sect2">
\r
2526 <h3 id="_word_ifbreak">Word: IFBREAK</h3>
\r
2527 <div class="literalblock">
\r
2528 <div class="content">
\r
2529 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2531 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with
\r
2532 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
2533 implement structured execution control. IFBREAK simply places the
\r
2534 address for resolving branches from this point the end of the block
\r
2535 during execution.</p></div>
\r
2536 <div style="text-align:center">
\r
2537 _______________________________________________________
\r
2539 <div class="paragraph"><p><a id="p_immediate"></a></p></div>
\r
2541 <div class="sect2">
\r
2542 <h3 id="_word_immediate">Word: IMMEDIATE</h3>
\r
2543 <div class="literalblock">
\r
2544 <div class="content">
\r
2545 <pre><code>Data stack: ( -- )</code></pre>
\r
2547 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of
\r
2548 the most recent word to 1, thereby making that word an immediate word.</p></div>
\r
2549 <div class="exampleblock">
\r
2550 <div class="content">
\r
2551 <div class="sidebarblock">
\r
2552 <div class="content">
\r
2553 <div class="title">Definition concept for IMMEDIATE</div>
\r
2554 <div class="paragraph"><p>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</p></div>
\r
2557 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
2558 <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
2559 <div style="text-align:center">
\r
2560 _______________________________________________________
\r
2562 <div class="paragraph"><p><a id="p_input"></a></p></div>
\r
2564 <div class="sect2">
\r
2565 <h3 id="_word_input">Word: INPUT</h3>
\r
2566 <div class="literalblock">
\r
2567 <div class="content">
\r
2568 <pre><code>Data stack: ( -- a )</code></pre>
\r
2570 <div class="paragraph"><p>"INPUT" is a variable word for the input stream buffer used by
\r
2571 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>.</p></div>
\r
2572 <div style="text-align:center">
\r
2573 _______________________________________________________
\r
2575 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>
\r
2577 <div class="sect2">
\r
2578 <h3 id="_word_10">Word: [</h3>
\r
2579 <div class="literalblock">
\r
2580 <div class="content">
\r
2581 <pre><code>Data stack: ( -- )</code></pre>
\r
2583 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation
\r
2584 mode to be intepreting. In this mode, words are executed immediately
\r
2585 after parsing, by invoking their "doer".</p></div>
\r
2586 <div class="exampleblock">
\r
2587 <div class="content">
\r
2588 <div class="sidebarblock">
\r
2589 <div class="content">
\r
2590 <div class="title">Definition concept for [</div>
\r
2591 <div class="paragraph"><p>: [ IMMEDIATE 0 STATE ! ;</p></div>
\r
2594 <div style="text-align:center">
\r
2595 _______________________________________________________
\r
2597 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>
\r
2599 <div class="sect2">
\r
2600 <h3 id="_word_lt">Word: <=</h3>
\r
2601 <div class="literalblock">
\r
2602 <div class="content">
\r
2603 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2605 <div class="paragraph"><p>"<=" is a function word that replaces a pair of values with -1 if the
\r
2606 first, v1, is less than or equal to the second, v1, otherwise 0. To
\r
2607 that end, the values are 64-bit signed integers.</p></div>
\r
2608 <div style="text-align:center">
\r
2609 _______________________________________________________
\r
2611 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>
\r
2613 <div class="sect2">
\r
2614 <h3 id="_word_lt_2">Word: <</h3>
\r
2615 <div class="literalblock">
\r
2616 <div class="content">
\r
2617 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2619 <div class="paragraph"><p>"<" is a function word that replaces a pair of values with -1 if the
\r
2620 first, v1, is less than the second, v1, otherwise 0. To that end, the
\r
2621 values are 64-bit signed integers.</p></div>
\r
2622 <div style="text-align:center">
\r
2623 _______________________________________________________
\r
2625 <div class="paragraph"><p><a id="p_literal"></a></p></div>
\r
2627 <div class="sect2">
\r
2628 <h3 id="_word_lit">Word: LIT</h3>
\r
2629 <div class="literalblock">
\r
2630 <div class="content">
\r
2631 <pre><code>Data stack: ( -- v )</code></pre>
\r
2633 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves
\r
2634 excution past that. The literal value is thus layed out as if a
\r
2635 subsequent CFA pointer in the containing definition, and the LIT
\r
2636 execution will make the execution skip past that and instead contine
\r
2637 with the CFA pointer following the value.</p></div>
\r
2638 <div class="paragraph"><p>It’s not a good idea to use "LIT" interactively.</p></div>
\r
2639 <div class="exampleblock">
\r
2640 <div class="content">
\r
2641 <div class="sidebarblock">
\r
2642 <div class="content">
\r
2643 <div class="title">Definition concept for LIT</div>
\r
2644 <div class="paragraph"><p>: LIT R> DUP 8 + >R @ ;</p></div>
\r
2647 <div style="text-align:center">
\r
2648 _______________________________________________________
\r
2650 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>
\r
2652 <div class="sect2">
\r
2653 <h3 id="_word_lit_string">Word: LIT-STRING</h3>
\r
2654 <div class="literalblock">
\r
2655 <div class="content">
\r
2656 <pre><code>Data stack: ( -- chars* n )</code></pre>
\r
2658 <div class="paragraph"><p>"LIT-STRING" is a function word that pushes the char* and length n of
\r
2659 a subsequent inline string, then advances execution to continue after
\r
2660 the string. This is similar to <a href="#p_lit">LIT</a> but for a block literal.</p></div>
\r
2661 <div class="paragraph"><p>Note that the inlined byte count includes the terminating NUL byte.</p></div>
\r
2662 <div class="exampleblock">
\r
2663 <div class="content">
\r
2664 <div class="sidebarblock">
\r
2665 <div class="content">
\r
2666 <div class="title">Definition concept for LIT-STRING</div>
\r
2667 <div class="paragraph"><p>: LIT-STRING R@ DUP @ 8 + R@ @ 2DUP + R> + >R 1 - ;</p></div>
\r
2670 <div style="text-align:center">
\r
2671 _______________________________________________________
\r
2673 <div class="paragraph"><p><a id="p_literal_string_compile"></a></p></div>
\r
2675 <div class="sect2">
\r
2676 <h3 id="_word_s">Word: S"</h3>
\r
2677 <div class="literalblock">
\r
2678 <div class="content">
\r
2679 <pre><code>Data stack: ( -- ) Input stream: " chars"</code></pre>
\r
2681 <div class="paragraph"><p>"S"" is an immediate function word that compiles the subseqent
\r
2682 characters up to terminating double-quote into the current definition,
\r
2683 preceded by a <a href="#p_literal_string">LIT-STRING</a> cell, and the count of
\r
2684 bytes scanned. The inline text includes a terminating NUL character
\r
2685 which also is included in the inlined count.</p></div>
\r
2686 <div class="paragraph"><p>Note that "S"" uses <a href="#p_double_quote">"</a> for reading the string.</p></div>
\r
2687 <div style="text-align:center">
\r
2688 _______________________________________________________
\r
2690 <div class="paragraph"><p><a id="p_load_buffer_size"></a></p></div>
\r
2692 <div class="sect2">
\r
2693 <h3 id="_word_load_buffer_size">Word: LOAD-BUFFER-SIZE</h3>
\r
2694 <div class="literalblock">
\r
2695 <div class="content">
\r
2696 <pre><code>data stack: ( -- a )</code></pre>
\r
2698 <div class="paragraph"><p>"LOAD-BUFFER-SIZE" is a variable word telling the buffer size in bytes
\r
2699 that <a href="#p_load_file">LOAD-FILE</a> should use.</p></div>
\r
2700 <div style="text-align:center">
\r
2701 _______________________________________________________
\r
2703 <div class="paragraph"><p><a id="p_load_file"></a></p></div>
\r
2705 <div class="sect2">
\r
2706 <h3 id="_word_load_file">Word: LOAD-FILE</h3>
\r
2707 <div class="literalblock">
\r
2708 <div class="content">
\r
2709 <pre><code>data stack: ( chaz* -- * 0/1 )</code></pre>
\r
2711 <div class="paragraph"><p>"LOAD-FILE" is a function word that evaluates a text file. It opens a
\r
2712 file via <a href="#p_open_file">OPEN-FILE</a> and sets up a stream with a
\r
2713 buffer of <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a> bytes for
\r
2714 reading it. The stream is passed to
\r
2715 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing its words. Upon
\r
2716 its return the file is closed and the stream memory is reclaimed, and
\r
2717 then the function returns whatever
\r
2718 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> returns.</p></div>
\r
2719 <div style="text-align:center">
\r
2720 _______________________________________________________
\r
2722 <div class="paragraph"><p><a id="p_lparen"></a></p></div>
\r
2724 <div class="sect2">
\r
2725 <h3 id="_word_11">Word: (</h3>
\r
2726 <div class="literalblock">
\r
2727 <div class="content">
\r
2728 <pre><code>Data stack: ( -- )</code></pre>
\r
2730 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words
\r
2731 until the next right parenthesis, or the end of the stream. This is
\r
2732 used for comments in RRQFORTH code.</p></div>
\r
2733 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have
\r
2734 whitespace before and after it.</p></div>
\r
2735 <div style="text-align:center">
\r
2736 _______________________________________________________
\r
2738 <div class="paragraph"><p><a id="p_malloc"></a></p></div>
\r
2740 <div class="sect2">
\r
2741 <h3 id="_word_malloc">Word: MALLOC</h3>
\r
2742 <div class="literalblock">
\r
2743 <div class="content">
\r
2744 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2746 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n
\r
2747 bytes and returns the lowest address of the allocated block.</p></div>
\r
2748 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2749 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2750 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC
\r
2751 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man
\r
2752 page" of mmap for details.</p></div>
\r
2753 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>
\r
2754 <div style="text-align:center">
\r
2755 _______________________________________________________
\r
2757 <div class="paragraph"><p><a id="p_minus"></a></p></div>
\r
2759 <div class="sect2">
\r
2760 <h3 id="_word_12">Word: -</h3>
\r
2761 <div class="literalblock">
\r
2762 <div class="content">
\r
2763 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2765 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the
\r
2766 result of reducing the first, v1, with the second, v2. To that end,
\r
2767 the values are 64-bit signed integers.</p></div>
\r
2768 <div style="text-align:center">
\r
2769 _______________________________________________________
\r
2771 <div class="paragraph"><p><a id="p_mult"></a></p></div>
\r
2773 <div class="sect2">
\r
2774 <h3 id="_word_13">Word: *</h3>
\r
2775 <div class="literalblock">
\r
2776 <div class="content">
\r
2777 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2779 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result
\r
2780 of multiplying them. To that end, the values are 64-bit signed
\r
2781 integers, and clipping the result to the least signifcant 64 bits.</p></div>
\r
2782 <div style="text-align:center">
\r
2783 _______________________________________________________
\r
2785 <div class="paragraph"><p><a id="p_negate"></a></p></div>
\r
2787 <div class="sect2">
\r
2788 <h3 id="_word_negate">Word: NEGATE</h3>
\r
2789 <div class="literalblock">
\r
2790 <div class="content">
\r
2791 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2793 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its
\r
2794 2’s-complement negation. To that end, the values are 64-bit signed
\r
2795 integers.</p></div>
\r
2796 <div style="text-align:center">
\r
2797 _______________________________________________________
\r
2799 <div class="paragraph"><p><a id="p_nip"></a></p></div>
\r
2801 <div class="sect2">
\r
2802 <h3 id="_word_nip">Word: NIP</h3>
\r
2803 <div class="literalblock">
\r
2804 <div class="content">
\r
2805 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>
\r
2807 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells
\r
2808 on the data stack.</p></div>
\r
2809 <div class="exampleblock">
\r
2810 <div class="content">
\r
2811 <div class="sidebarblock">
\r
2812 <div class="content">
\r
2813 <div class="title">Definition concept for NIP</div>
\r
2814 <div class="paragraph"><p>: NIP SWAP DROP ;</p></div>
\r
2817 <div style="text-align:center">
\r
2818 _______________________________________________________
\r
2820 <div class="paragraph"><p><a id="p_nl"></a></p></div>
\r
2822 <div class="sect2">
\r
2823 <h3 id="_word_nl">Word: NL</h3>
\r
2824 <div class="literalblock">
\r
2825 <div class="content">
\r
2826 <pre><code>Data stack: ( -- v )</code></pre>
\r
2828 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>
\r
2829 <div style="text-align:center">
\r
2830 _______________________________________________________
\r
2832 <div class="paragraph"><p><a id="p_not"></a></p></div>
\r
2834 <div class="sect2">
\r
2835 <h3 id="_word_not">Word: NOT</h3>
\r
2836 <div class="literalblock">
\r
2837 <div class="content">
\r
2838 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2840 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise
\r
2841 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>
\r
2842 <div class="paragraph"><p>Compare with <<p_0equal,0⇒>.</p></div>
\r
2843 <div style="text-align:center">
\r
2844 _______________________________________________________
\r
2846 <div class="paragraph"><p><a id="p_number"></a></p></div>
\r
2848 <div class="sect2">
\r
2849 <h3 id="_word_number">Word: NUMBER</h3>
\r
2850 <div class="literalblock">
\r
2851 <div class="content">
\r
2852 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>
\r
2854 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using
\r
2855 <a href="#p_base">BASE</a> as numerical base, then returns the result number and
\r
2856 a 1 on top, or just a 0 if the word didn’t parse.</p></div>
\r
2857 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in
\r
2858 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>
\r
2859 base, letters a-f or A-F for values 10-15. I.e. the normal positive or
\r
2860 negative decimal integers or normal (positive only) hexadecimal
\r
2861 integers.</p></div>
\r
2862 <div style="text-align:center">
\r
2863 _______________________________________________________
\r
2865 <div class="paragraph"><p><a id="p_open_file"></a></p></div>
\r
2867 <div class="sect2">
\r
2868 <h3 id="_word_open_file">Word: OPEN-FILE</h3>
\r
2869 <div class="literalblock">
\r
2870 <div class="content">
\r
2871 <pre><code>Data stack: ( chaz* -- fd )</code></pre>
\r
2873 <div class="paragraph"><p>"OPEN-FILE" is a function word that opens the file named by the zero
\r
2874 terminated character string and returns the file descriptor, or if
\r
2875 less than 0, the system call error code.</p></div>
\r
2876 <div style="text-align:center">
\r
2877 _______________________________________________________
\r
2879 <div class="paragraph"><p><a id="p_or"></a></p></div>
\r
2881 <div class="sect2">
\r
2882 <h3 id="_word_or">Word: OR</h3>
\r
2883 <div class="literalblock">
\r
2884 <div class="content">
\r
2885 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2887 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise
\r
2888 disjunction; each bit is 1 if the corresponding bits of any operand
\r
2889 is 1 and 0 if not.</p></div>
\r
2890 <div style="text-align:center">
\r
2891 _______________________________________________________
\r
2893 <div class="paragraph"><p><a id="p_over"></a></p></div>
\r
2895 <div class="sect2">
\r
2896 <h3 id="_word_over">Word: OVER</h3>
\r
2897 <div class="literalblock">
\r
2898 <div class="content">
\r
2899 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>
\r
2901 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on
\r
2902 the data stack.</p></div>
\r
2903 <div style="text-align:center">
\r
2904 _______________________________________________________
\r
2906 <div class="paragraph"><p><a id="p_pad"></a></p></div>
\r
2908 <div class="sect2">
\r
2909 <h3 id="_word_pad">Word: PAD</h3>
\r
2910 <div class="literalblock">
\r
2911 <div class="content">
\r
2912 <pre><code>Data stack: ( -- a )</code></pre>
\r
2914 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by
\r
2915 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>
\r
2916 <div style="text-align:center">
\r
2917 _______________________________________________________
\r
2919 <div class="paragraph"><p><a id="p_pick"></a></p></div>
\r
2921 <div class="sect2">
\r
2922 <h3 id="_word_pick">Word: PICK</h3>
\r
2923 <div class="literalblock">
\r
2924 <div class="content">
\r
2925 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>
\r
2927 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down
\r
2928 from top onto the data stack. 0 indicates the top cell making it the
\r
2929 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it
\r
2930 the same as <a href="#p_over">OVER</a>.</p></div>
\r
2931 <div style="text-align:center">
\r
2932 _______________________________________________________
\r
2934 <div class="paragraph"><p><a id="p_plus"></a></p></div>
\r
2936 <div class="sect2">
\r
2937 <h3 id="_word_43">Word: +</h3>
\r
2938 <div class="literalblock">
\r
2939 <div class="content">
\r
2940 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2942 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the
\r
2943 result of adding them. To that end, the values are 64-bit signed
\r
2944 integers.</p></div>
\r
2945 <div style="text-align:center">
\r
2946 _______________________________________________________
\r
2948 <div class="paragraph"><p><a id="p_program_version"></a></p></div>
\r
2950 <div class="sect2">
\r
2951 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>
\r
2952 <div class="literalblock">
\r
2953 <div class="content">
\r
2954 <pre><code>Data stack: ( -- char* length )</code></pre>
\r
2956 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>
\r
2957 <div style="text-align:center">
\r
2958 _______________________________________________________
\r
2960 <div class="paragraph"><p><a id="p_put"></a></p></div>
\r
2962 <div class="sect2">
\r
2963 <h3 id="_word_14">Word: !</h3>
\r
2964 <div class="literalblock">
\r
2965 <div class="content">
\r
2966 <pre><code>Data stack: ( v a -- )</code></pre>
\r
2968 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>
\r
2969 <div style="text-align:center">
\r
2970 _______________________________________________________
\r
2972 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>
\r
2974 <div class="sect2">
\r
2975 <h3 id="_word_15">Word: !+</h3>
\r
2976 <div class="literalblock">
\r
2977 <div class="content">
\r
2978 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2980 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>
\r
2981 <div class="exampleblock">
\r
2982 <div class="content">
\r
2983 <div class="sidebarblock">
\r
2984 <div class="content">
\r
2985 <div class="title">definition concept for !+</div>
\r
2986 <div class="paragraph"><p>( a n — ) : !+ OVER @ + SWAP ! ;</p></div>
\r
2989 <div style="text-align:center">
\r
2990 _______________________________________________________
\r
2992 <div class="paragraph"><p><a id="p_quit"></a></p></div>
\r
2994 <div class="sect2">
\r
2995 <h3 id="_word_quit">Word: QUIT</h3>
\r
2996 <div class="literalblock">
\r
2997 <div class="content">
\r
2998 <pre><code>Data stack: ??</code></pre>
\r
3000 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of
\r
3001 RRQFORTH. First it resets the stacks to their original settings, and
\r
3002 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and
\r
3003 executing them.</p></div>
\r
3004 <div style="text-align:center">
\r
3005 _______________________________________________________
\r
3007 <div class="paragraph"><p><a id="p_quote"></a></p></div>
\r
3009 <div class="sect2">
\r
3010 <h3 id="_word_16">Word: '</h3>
\r
3011 <div class="literalblock">
\r
3012 <div class="content">
\r
3013 <pre><code>data stack: ( -- cfa ) Input stream: word</code></pre>
\r
3015 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next
\r
3016 word on the input stream and pushes its cfa.</p></div>
\r
3017 <div style="text-align:center">
\r
3018 _______________________________________________________
\r
3020 <div class="paragraph"><p><a id="p_rbp"></a></p></div>
\r
3022 <div class="sect2">
\r
3023 <h3 id="_word_rsp">Word: RSP</h3>
\r
3024 <div class="literalblock">
\r
3025 <div class="content">
\r
3026 <pre><code>Data stack: ( -- a )</code></pre>
\r
3028 <div class="paragraph"><p>"RSP" is a function word that pushes the return stack pointer value
\r
3029 onto the data stack.</p></div>
\r
3030 <div style="text-align:center">
\r
3031 _______________________________________________________
\r
3033 <div class="paragraph"><p><a id="p_rbpn"></a></p></div>
\r
3035 <div class="sect2">
\r
3036 <h3 id="_word_r_n">Word: R[n]</h3>
\r
3037 <div class="literalblock">
\r
3038 <div class="content">
\r
3039 <pre><code>Data stack: ( n -- a )</code></pre>
\r
3041 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell on
\r
3042 the top return stack value onto the data stack.</p></div>
\r
3043 <div class="exampleblock">
\r
3044 <div class="content">
\r
3045 <div class="sidebarblock">
\r
3046 <div class="content">
\r
3047 <div class="title">Defintion concept for R[n]</div>
\r
3048 <div class="paragraph"><p>( n — a ) : R[n] 8 * RSP + ;</p></div>
\r
3051 <div style="text-align:center">
\r
3052 _______________________________________________________
\r
3054 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>
\r
3056 <div class="sect2">
\r
3057 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>
\r
3058 <div class="literalblock">
\r
3059 <div class="content">
\r
3060 <pre><code>Data stack: ( stream -- c )</code></pre>
\r
3062 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character
\r
3063 from the given stream buffer, possibly refilling the buffer if it is
\r
3064 backed by a file descriptor. The refill is done by a SYS_READ call
\r
3065 when more characters are needed. The next character is pushed on the
\r
3066 stack, unless the stream is exhausted in which case the -1 is pushed
\r
3067 instead.</p></div>
\r
3068 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>
\r
3069 <div style="text-align:center">
\r
3070 _______________________________________________________
\r
3072 <div class="paragraph"><p><a id="p_read_word"></a></p></div>
\r
3074 <div class="sect2">
\r
3075 <h3 id="_word_read_word">Word: READ-WORD</h3>
\r
3076 <div class="literalblock">
\r
3077 <div class="content">
\r
3078 <pre><code>Data stack: ( stream -- char* n )</code></pre>
\r
3080 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace
\r
3081 separated word from the given stream and returns the [n:char*] duoble
\r
3082 cell pointer for it. The characters of the word are copied to
\r
3083 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>
\r
3084 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>
\r
3085 <div class="exampleblock">
\r
3086 <div class="title">Special syntax 1: Whitespace</div>
\r
3087 <div class="content">
\r
3088 <div class="paragraph"><p>All character codes less or equal to 32 are regarded as "whitespace".</p></div>
\r
3090 <div class="exampleblock">
\r
3091 <div class="title">Special syntax 2: Rest-of-line comment</div>
\r
3092 <div class="content">
\r
3093 <div class="paragraph"><p>The "#" character following whitespace starts a line comment and the
\r
3094 rest of the line is ignored. Note that this is also recognised with
\r
3095 <a href="#p_lparen">parethesis commenting</a>.</p></div>
\r
3097 <div style="text-align:center">
\r
3098 _______________________________________________________
\r
3100 <div class="paragraph"><p><a id="p_realloc"></a></p></div>
\r
3102 <div class="sect2">
\r
3103 <h3 id="_word_realloc">Word: REALLOC</h3>
\r
3104 <div class="literalblock">
\r
3105 <div class="content">
\r
3106 <pre><code>Data stack: ( a m n -- a )</code></pre>
\r
3108 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a
\r
3109 of size m to be size n bytes and returns the lowest address of the
\r
3110 allocated block.</p></div>
\r
3111 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
3112 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
3113 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>
\r
3114 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>
\r
3115 <div style="text-align:center">
\r
3116 _______________________________________________________
\r
3118 <div class="paragraph"><p><a id="p_return"></a></p></div>
\r
3120 <div class="sect2">
\r
3121 <h3 id="_word_return">Word: RETURN</h3>
\r
3122 <div class="literalblock">
\r
3123 <div class="content">
\r
3124 <pre><code>Data stack: ( -- )</code></pre>
\r
3126 <div class="paragraph"><p>"RETURN" is a function word that implements the ending of a FORTH
\r
3127 definition and make execution return to the next step in the calling
\r
3128 definition.</p></div>
\r
3129 <div style="text-align:center">
\r
3130 _______________________________________________________
\r
3132 <div class="paragraph"><p>compile.asm: WORD p_right_bracket,<em>]</em>,fasm</p></div>
\r
3133 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>
\r
3135 <div class="sect2">
\r
3136 <h3 id="_word_17">Word: ]</h3>
\r
3137 <div class="literalblock">
\r
3138 <div class="content">
\r
3139 <pre><code>Data stack: ( -- )</code></pre>
\r
3141 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation
\r
3142 mode to be compiling. In this mode words parsed into CFA pointers
\r
3143 which are placed on the heap in the given order, unless the word is
\r
3144 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An
\r
3145 immediate word is executed immediately, and a number is parsed and
\r
3146 left on the stack.</p></div>
\r
3147 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the
\r
3148 wordlist; i.e., the word list may contain definitions for numbers.</p></div>
\r
3149 <div class="exampleblock">
\r
3150 <div class="content">
\r
3151 <div class="sidebarblock">
\r
3152 <div class="content">
\r
3153 <div class="title">Definition concept for ]</div>
\r
3154 <div class="paragraph"><p>: ] 1 STATE ! ;</p></div>
\r
3157 <div style="text-align:center">
\r
3158 _______________________________________________________
\r
3160 <div class="paragraph"><p><a id="p_roll"></a></p></div>
\r
3162 <div class="sect2">
\r
3163 <h3 id="_word_roll">Word: ROLL</h3>
\r
3164 <div class="literalblock">
\r
3165 <div class="content">
\r
3166 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>
\r
3168 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down
\r
3169 from top onto the data stack while discarding it. 0 indicates the top
\r
3170 cell; 1 indicates the second top cell making it the same as
\r
3171 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as
\r
3172 <a href="#p_rot">ROT</a>.</p></div>
\r
3173 <div style="text-align:center">
\r
3174 _______________________________________________________
\r
3176 <div class="paragraph"><p><a id="p_rot"></a></p></div>
\r
3178 <div class="sect2">
\r
3179 <h3 id="_word_rot">Word: ROT</h3>
\r
3180 <div class="literalblock">
\r
3181 <div class="content">
\r
3182 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>
\r
3184 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells
\r
3185 such that the third becomes the first while the second becomes third
\r
3186 and the first becomes the second.</p></div>
\r
3187 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>
\r
3188 <div style="text-align:center">
\r
3189 _______________________________________________________
\r
3191 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>
\r
3193 <div class="sect2">
\r
3194 <h3 id="_word_18">Word: ;</h3>
\r
3195 <div class="literalblock">
\r
3196 <div class="content">
\r
3197 <pre><code>Data stack: ( -- )</code></pre>
\r
3199 <div class="paragraph"><p>";" (semi-colon) is an immediate function word that ends a new forth
\r
3200 definition by means of adding an <a href="#p_exit">EXIT</a> cell, then changing
\r
3201 <<p_state,STATE> to interpreting.</p></div>
\r
3202 <div class="exampleblock">
\r
3203 <div class="content">
\r
3204 <div class="sidebarblock">
\r
3205 <div class="content">
\r
3206 <div class="title">Definition concept for ;</div>
\r
3207 <div class="paragraph"><p>: ; IMMEDIATE ' EXIT , ;</p></div>
\r
3210 <div style="text-align:center">
\r
3211 _______________________________________________________
\r
3213 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>
\r
3215 <div class="sect2">
\r
3216 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>
\r
3217 <div class="literalblock">
\r
3218 <div class="content">
\r
3219 <pre><code>Data stack: ( -- a )</code></pre>
\r
3221 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code
\r
3222 sniippet for setting up the signal handling. rrqforth handles SEGV by
\r
3223 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>
\r
3224 <div style="text-align:center">
\r
3225 _______________________________________________________
\r
3227 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>
\r
3229 <div class="sect2">
\r
3230 <h3 id="_word_lt_lt">Word: <<</h3>
\r
3231 <div class="literalblock">
\r
3232 <div class="content">
\r
3233 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3235 <div class="paragraph"><p>"<<" is a function word that shifts value v1 n steps left (i.e.
\r
3236 "moving" bits towards more significant bits) to form value v2.</p></div>
\r
3237 <div style="text-align:center">
\r
3238 _______________________________________________________
\r
3240 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>
\r
3242 <div class="sect2">
\r
3243 <h3 id="_word_gt_gt">Word: >></h3>
\r
3244 <div class="literalblock">
\r
3245 <div class="content">
\r
3246 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3248 <div class="paragraph"><p>">>" is a function word that shifts value v1 n steps right (i.e.
\r
3249 "moving" bits towards less significant bits) to form value v2.</p></div>
\r
3250 <div style="text-align:center">
\r
3251 _______________________________________________________
\r
3253 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>
\r
3255 <div class="sect2">
\r
3256 <h3 id="_word_s_gt_gt">Word: s>></h3>
\r
3257 <div class="literalblock">
\r
3258 <div class="content">
\r
3259 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3261 <div class="paragraph"><p>"s>>" is a function word that shifts value v1 n steps right (i.e.
\r
3262 "moving" bits towards less significant bits) to form value v2, but
\r
3263 preserving (and copying) the sign bit.</p></div>
\r
3264 <div style="text-align:center">
\r
3265 _______________________________________________________
\r
3267 <div class="paragraph"><p><a id="p_sp"></a></p></div>
\r
3269 <div class="sect2">
\r
3270 <h3 id="_word_sp">Word: SP</h3>
\r
3271 <div class="literalblock">
\r
3272 <div class="content">
\r
3273 <pre><code>Data stack: ( -- v )</code></pre>
\r
3275 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>
\r
3276 <div style="text-align:center">
\r
3277 _______________________________________________________
\r
3279 <div class="paragraph"><p><a id="p_state"></a></p></div>
\r
3281 <div class="sect2">
\r
3282 <h3 id="_word_state">Word: STATE</h3>
\r
3283 <div class="literalblock">
\r
3284 <div class="content">
\r
3285 <pre><code>Data stack: ( -- a )</code></pre>
\r
3287 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in
\r
3288 compiling mode (1) or interpreting (0) mode.</p></div>
\r
3289 <div style="text-align:center">
\r
3290 _______________________________________________________
\r
3292 <div class="paragraph"><p><a id="p_stdin"></a></p></div>
\r
3294 <div class="sect2">
\r
3295 <h3 id="_word_stdin">Word: STDIN</h3>
\r
3296 <div class="literalblock">
\r
3297 <div class="content">
\r
3298 <pre><code>Data stack: ( -- stream )</code></pre>
\r
3300 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the
\r
3301 standard input file descriptor.</p></div>
\r
3302 <div style="text-align:center">
\r
3303 _______________________________________________________
\r
3305 <div class="paragraph"><p><a id="p_stream"></a></p></div>
\r
3307 <div class="sect2">
\r
3308 <h3 id="_word_stream">Word: STREAM</h3>
\r
3309 <div class="literalblock">
\r
3310 <div class="content">
\r
3311 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>
\r
3313 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file
\r
3314 descriptor or for a memory block (of size+data).</p></div>
\r
3315 <div class="sect3">
\r
3316 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>
\r
3317 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size
\r
3318 prefixed by a 32 byte STREAM header of the following layout:</p></div>
\r
3319 <div class="exampleblock">
\r
3320 <div class="content">
\r
3321 <div class="listingblock">
\r
3322 <div class="title">Layout 3: file descriptor stream</div>
\r
3323 <div class="content">
\r
3324 <pre><code> 8 bytes = size of buffer (excluding the 32 byte header)
\r
3325 8 bytes source file descriptor
\r
3326 8 bytes current fill
\r
3327 8 current read position</code></pre>
\r
3331 <div class="sect3">
\r
3332 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>
\r
3333 <div class="paragraph"><p>A memory block stream is only the header (though allocated via
\r
3334 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the
\r
3335 following layout:</p></div>
\r
3336 <div class="exampleblock">
\r
3337 <div class="content">
\r
3338 <div class="listingblock">
\r
3339 <div class="title">Layout 4: memory block stream</div>
\r
3340 <div class="content">
\r
3341 <pre><code> 8 bytes = block address
\r
3342 8 -1 (indicates memory block)
\r
3343 8 size of block (taken from the block's first 8 bytes)
\r
3344 8 current read position</code></pre>
\r
3347 <div style="text-align:center">
\r
3348 _______________________________________________________
\r
3350 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>
\r
3353 <div class="sect2">
\r
3354 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>
\r
3355 <div class="literalblock">
\r
3356 <div class="content">
\r
3357 <pre><code>Data stack: ( stream -- n )</code></pre>
\r
3359 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream
\r
3360 buffer for the next non-whitespace character, and returns its position
\r
3361 relative to the end of the buffer. This is done without changing the
\r
3362 stream (or filling it by reading the backing file).</p></div>
\r
3363 <div style="text-align:center">
\r
3364 _______________________________________________________
\r
3366 <div class="paragraph"><p><a id="p_str2temp"></a></p></div>
\r
3368 <div class="sect2">
\r
3369 <h3 id="_word_str_gt_temp">Word: STR>TEMP</h3>
\r
3370 <div class="sidebarblock">
\r
3371 <div class="content">
\r
3372 <div class="paragraph"><p>Data stack: ( char* n — char* n )</p></div>
\r
3374 <div class="paragraph"><p>"STR>TEMP" is a function word that copies a given string plus a
\r
3375 terminating NUL character into a <a href="#p_tempspace">TEMPSPACE</a> snippet,
\r
3376 all preceded by a length cell. It returns a pointer for to the text in
\r
3377 the snippet and its length, excluding the NUL character at end and the
\r
3378 length cell before tie text.</p></div>
\r
3379 <div class="listingblock">
\r
3380 <div class="title">Layout for copied string</div>
\r
3381 <div class="content">
\r
3382 <pre><code> length: 8 bytes
\r
3383 returned char*: n bytes
\r
3384 nul: 1 byte</code></pre>
\r
3386 <div style="text-align:center">
\r
3387 _______________________________________________________
\r
3389 <div class="paragraph"><p><a id="p_strlen"></a></p></div>
\r
3391 <div class="sect2">
\r
3392 <h3 id="_word_strlen">Word: STRLEN</h3>
\r
3393 <div class="literalblock">
\r
3394 <div class="content">
\r
3395 <pre><code>Data stack: ( s -- n )</code></pre>
\r
3397 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from
\r
3398 s to the first NUL byte and returns that count, n, not including the
\r
3399 NUL byte.</p></div>
\r
3400 <div style="text-align:center">
\r
3401 _______________________________________________________
\r
3403 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>
\r
3405 <div class="sect2">
\r
3406 <h3 id="_word_strncmp">Word: STRNCMP</h3>
\r
3407 <div class="literalblock">
\r
3408 <div class="content">
\r
3409 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>
\r
3411 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of
\r
3412 character sequences s1 and s2, and returns the difference of the first
\r
3413 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters
\r
3414 are the same.</p></div>
\r
3415 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically
\r
3417 v is greater than 0 if [n:s1] is greater than [n:s2],
\r
3418 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>
\r
3419 <div style="text-align:center">
\r
3420 _______________________________________________________
\r
3422 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>
\r
3424 <div class="sect2">
\r
3425 <h3 id="_word_strncpy">Word: STRNCPY</h3>
\r
3426 <div class="literalblock">
\r
3427 <div class="content">
\r
3428 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>
\r
3430 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1
\r
3432 <div style="text-align:center">
\r
3433 _______________________________________________________
\r
3435 <div class="paragraph"><p><a id="p_swap"></a></p></div>
\r
3437 <div class="sect2">
\r
3438 <h3 id="_word_swap">Word: SWAP</h3>
\r
3439 <div class="literalblock">
\r
3440 <div class="content">
\r
3441 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>
\r
3443 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>
\r
3444 <div style="text-align:center">
\r
3445 _______________________________________________________
\r
3447 <div class="paragraph"><p><a id="p_system"></a></p></div>
\r
3449 <div class="sect2">
\r
3450 <h3 id="_word_system">Word: SYSTEM</h3>
\r
3451 <div class="literalblock">
\r
3452 <div class="content">
\r
3453 <pre><code>Data value: ( -- a )</code></pre>
\r
3455 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system
\r
3456 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>
\r
3457 merely as a matter of segregation.</p></div>
\r
3458 <div style="text-align:center">
\r
3459 _______________________________________________________
\r
3461 <div class="paragraph"><p><a id="p_tell"></a></p></div>
\r
3463 <div class="sect2">
\r
3464 <h3 id="_word_tell">Word: TELL</h3>
\r
3465 <div class="literalblock">
\r
3466 <div class="content">
\r
3467 <pre><code>Data stack: ( char* n -- )</code></pre>
\r
3469 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file
\r
3470 descriptor 1).</p></div>
\r
3471 <div style="text-align:center">
\r
3472 _______________________________________________________
\r
3474 <div class="paragraph"><p><a id="p_temp"></a></p></div>
\r
3476 <div class="sect2">
\r
3477 <h3 id="_word_temp_2">Word: TEMP</h3>
\r
3478 <div class="sidebarblock">
\r
3479 <div class="content">
\r
3480 <div class="paragraph"><p>Data stack: ( size — addr )</p></div>
\r
3482 <div class="paragraph"><p>"TEMP" is a function word that "allocates" a <a href="#p_tempspace">TEMPSPACE</a>
\r
3483 area of given size and returns its base address. The allocation is
\r
3484 temporary and only valid until there is a later allocation that
\r
3485 overruns this area.</p></div>
\r
3486 <div class="paragraph"><p>Allocations are done in succession until the requested size overruns
\r
3487 the <a href="#p_tempspace">TEMPSPACE</a>. If so, the allocation pointer is reset
\r
3488 and the space is allocated from start again. This is all intended for
\r
3489 small and short-lived data areas.</p></div>
\r
3490 <div style="text-align:center">
\r
3491 _______________________________________________________
\r
3493 <div class="paragraph"><p><a id="p_tempspace"></a></p></div>
\r
3495 <div class="sect2">
\r
3496 <h3 id="_word_tempspace">Word: TEMPSPACE</h3>
\r
3497 <div class="literalblock">
\r
3498 <div class="content">
\r
3499 <pre><code>Data stack: ( -- a )</code></pre>
\r
3501 <div class="paragraph"><p>"TEMPSPACE" is a variable word that holds three cells the for managing
\r
3502 "temporary memory":</p></div>
\r
3503 <div class="ulist"><ul>
\r
3506 the size of the temporary memory space (default 104857600 bytes)
\r
3511 the base address for whole temporary memory area
\r
3516 the amount currently used
\r
3520 <div class="paragraph"><p>This memory is intended to be used by requesting snippets of memory in
\r
3521 a cyclic fashion via <a href="#p_temp">TEMP</a> without concern about it possibly
\r
3522 overlapping a prior request.</p></div>
\r
3523 <div style="text-align:center">
\r
3524 _______________________________________________________
\r
3526 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>
\r
3528 <div class="sect2">
\r
3529 <h3 id="_word_terminate0">Word: TERMINATE0</h3>
\r
3530 <div class="literalblock">
\r
3531 <div class="content">
\r
3532 <pre><code>Data stack: ( -- )</code></pre>
\r
3534 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit
\r
3536 <div style="text-align:center">
\r
3537 _______________________________________________________
\r
3539 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>
\r
3541 <div class="sect2">
\r
3542 <h3 id="_word_tfa_gt_cfa">Word: TFA>CFA</h3>
\r
3543 <div class="literalblock">
\r
3544 <div class="content">
\r
3545 <pre><code>Data stack: ( tfa -- cfa )</code></pre>
\r
3547 <div class="paragraph"><p>"TFA>CFA" is a function word that pushes word cfa of the given tfa.</p></div>
\r
3548 <div class="exampleblock">
\r
3549 <div class="content">
\r
3550 <div class="sidebarblock">
\r
3551 <div class="content">
\r
3552 <div class="title">Definition concept for TFA>CFA</div>
\r
3553 <div class="paragraph"><p>: TFA>CFA 8 + @ ;</p></div>
\r
3556 <div style="text-align:center">
\r
3557 _______________________________________________________
\r
3559 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>
\r
3561 <div class="sect2">
\r
3562 <h3 id="_word_tfa_gt_dfa">Word: TFA>DFA</h3>
\r
3563 <div class="literalblock">
\r
3564 <div class="content">
\r
3565 <pre><code>Data stack: ( tfa -- dfa )</code></pre>
\r
3567 <div class="paragraph"><p>"TFA>DFA" is a function word that pushes word dfa of the given tfa.</p></div>
\r
3568 <div class="exampleblock">
\r
3569 <div class="content">
\r
3570 <div class="sidebarblock">
\r
3571 <div class="content">
\r
3572 <div class="title">Definition concept for TFA>DFA</div>
\r
3573 <div class="paragraph"><p>: TFA>DFA TFA>CFA 8 + ;</p></div>
\r
3576 <div style="text-align:center">
\r
3577 _______________________________________________________
\r
3579 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>
\r
3581 <div class="sect2">
\r
3582 <h3 id="_word_tfa_gt_flags">Word: TFA>FLAGS@</h3>
\r
3583 <div class="literalblock">
\r
3584 <div class="content">
\r
3585 <pre><code>Data stack: ( tfa -- flags )</code></pre>
\r
3587 <div class="paragraph"><p>"TFA>FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>
\r
3588 <div class="exampleblock">
\r
3589 <div class="content">
\r
3590 <div class="sidebarblock">
\r
3591 <div class="content">
\r
3592 <div class="title">Defintion concept for TFA>FLAGS@</div>
\r
3593 <div class="paragraph"><p>: TFA>FLAGS@ 16 + @ ;</p></div>
\r
3596 <div style="text-align:center">
\r
3597 _______________________________________________________
\r
3599 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>
\r
3601 <div class="sect2">
\r
3602 <h3 id="_word_tfa_gt_namez">Word: TFA>NAMEZ</h3>
\r
3603 <div class="literalblock">
\r
3604 <div class="content">
\r
3605 <pre><code>Data stack: ( tfa -- char* )</code></pre>
\r
3607 <div class="paragraph"><p>"TFA>NAMEZ" is a function word that pushes changes a tfa pointer to a
\r
3608 pointer to the word pname’s character sequence, which is zero
\r
3609 terminated as well as preceded by a length cell.</p></div>
\r
3610 <div class="exampleblock">
\r
3611 <div class="content">
\r
3612 <div class="sidebarblock">
\r
3613 <div class="content">
\r
3614 <div class="title">Defintion concept for TFA>NAMEZ</div>
\r
3615 <div class="paragraph"><p>: TFA>NAMEZ 32 + ;</p></div>
\r
3618 <div style="text-align:center">
\r
3619 _______________________________________________________
\r
3621 <div class="paragraph"><p><a id="p_then"></a></p></div>
\r
3623 <div class="sect2">
\r
3624 <h3 id="_word_then">Word: THEN</h3>
\r
3625 <div class="literalblock">
\r
3626 <div class="content">
\r
3627 <pre><code>Data stack: Compiling: ( a -- )</code></pre>
\r
3629 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with
\r
3630 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution
\r
3631 control. THEN performs the branch resolution for the stacked address
\r
3632 which pinpoints the foot address the branch offset to resolve, so that
\r
3633 at execution time there is an appropriate conditional branch past the
\r
3634 "then-part" or the "else-part" of the "structured statement".</p></div>
\r
3635 <div style="text-align:center">
\r
3636 _______________________________________________________
\r
3638 <div class="paragraph"><p><a id="p_this_word"></a></p></div>
\r
3640 <div class="sect2">
\r
3641 <h3 id="_word_this_word">Word: THIS-WORD</h3>
\r
3642 <div class="literalblock">
\r
3643 <div class="content">
\r
3644 <pre><code>Data stack: ( -- a )</code></pre>
\r
3646 <div class="paragraph"><p>"THIS-WORD" is a variable word used in
\r
3647 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]
\r
3648 values of the successive words being evaluated. This typically points
\r
3649 into the input stream buffer and remain valid until further stream
\r
3650 buffering functions are used.</p></div>
\r
3651 <div style="text-align:center">
\r
3652 _______________________________________________________
\r
3654 <div class="paragraph"><p><a id="p_true"></a></p></div>
\r
3656 <div class="sect2">
\r
3657 <h3 id="_word_true">Word: TRUE</h3>
\r
3658 <div class="literalblock">
\r
3659 <div class="content">
\r
3660 <pre><code>Data stack: ( -- -1 )</code></pre>
\r
3662 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>
\r
3663 <div style="text-align:center">
\r
3664 _______________________________________________________
\r
3666 <div class="paragraph"><p><a id="p_tuck"></a></p></div>
\r
3668 <div class="sect2">
\r
3669 <h3 id="_word_tuck">Word: TUCK</h3>
\r
3670 <div class="literalblock">
\r
3671 <div class="content">
\r
3672 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>
\r
3674 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second
\r
3675 cell on the data stack.</p></div>
\r
3676 <div class="exampleblock">
\r
3677 <div class="content">
\r
3678 <div class="sidebarblock">
\r
3679 <div class="content">
\r
3680 <div class="title">Definition concept for TUCK</div>
\r
3681 <div class="paragraph"><p>: TUCK SWAP OVER ;</p></div>
\r
3684 <div style="text-align:center">
\r
3685 _______________________________________________________
\r
3687 <div class="paragraph"><p><a id="p_unequal"></a></p></div>
\r
3689 <div class="sect2">
\r
3690 <h3 id="_word_19">Word: !=</h3>
\r
3691 <div class="literalblock">
\r
3692 <div class="content">
\r
3693 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
3695 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the
\r
3696 values are unequal, and 0 otherwise.</p></div>
\r
3697 <div style="text-align:center">
\r
3698 _______________________________________________________
\r
3700 <div class="paragraph"><p><a id="p_unstream"></a></p></div>
\r
3702 <div class="sect2">
\r
3703 <h3 id="_word_unstream">Word: UNSTREAM</h3>
\r
3704 <div class="literalblock">
\r
3705 <div class="content">
\r
3706 <pre><code>Data stack: ( stream* -- )</code></pre>
\r
3708 <div class="paragraph"><p>"UNSTREAM" is a function word that releases the memory allocated for a
\r
3709 stream, and closes the associated file if it’s a file stream.</p></div>
\r
3710 <div class="sect3">
\r
3711 <h4 id="_file_descriptor_backed_stream_2">File descriptor backed stream</h4>
\r
3712 <div class="paragraph"><p>This kind of stream has the stream header as a prefix within the
\r
3713 allocated memory. Thus, stream* is the base address for the memory to
\r
3714 reclaim, and the size of this is determined from the cell at (stream*
\r
3715 + 16) plus the 32 bytes head itself.</p></div>
\r
3717 <div class="sect3">
\r
3718 <h4 id="_memory_block_backed_stream_2">Memory block backed STREAM</h4>
\r
3719 <div class="paragraph"><p>This kind of stream has a separate header which points at the memory
\r
3720 area to reclaim. The cell at stream* is the base address, and the cell
\r
3721 at (stream* + 16) is its size.</p></div>
\r
3722 <div style="text-align:center">
\r
3723 _______________________________________________________
\r
3725 <div class="paragraph"><p><a id="p_use"></a></p></div>
\r
3728 <div class="sect2">
\r
3729 <h3 id="_word_use">Word: USE</h3>
\r
3730 <div class="literalblock">
\r
3731 <div class="content">
\r
3732 <pre><code>Data value: ( wordlist -- ) Input stream: word</code></pre>
\r
3734 <div class="paragraph"><p>"USE" is a function word that looks up next word given the wordlist.
\r
3735 It reads next word on <a href="#p_input">INPUT</a> via <a href="#p_read_word">READ-WORD</a>,
\r
3736 then temporarily changes <a href="#p_current_wordlist">CURRENT-WORDLIST</a> to
\r
3737 <a href="#p_find">FIND</a> the word via the given wordlist, and returns the TFA
\r
3738 of that word, or just 0 if the word coudn’t be found.</p></div>
\r
3739 <div style="text-align:center">
\r
3740 _______________________________________________________
\r
3742 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>
\r
3744 <div class="sect2">
\r
3745 <h3 id="_word_verbose">Word: VERBOSE?</h3>
\r
3746 <div class="literalblock">
\r
3747 <div class="content">
\r
3748 <pre><code>Data stack: ( -- a )</code></pre>
\r
3750 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0
\r
3751 signify whether or not the command line arguments includes "-v". When
\r
3752 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more
\r
3753 verbose.</p></div>
\r
3754 <div style="text-align:center">
\r
3755 _______________________________________________________
\r
3757 <div class="paragraph"><p><a id="p_within"></a></p></div>
\r
3759 <div class="sect2">
\r
3760 <h3 id="_word_within">Word: WITHIN</h3>
\r
3761 <div class="literalblock">
\r
3762 <div class="content">
\r
3763 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>
\r
3765 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1
\r
3766 of the the first, v, is within the value range spanned by the second,
\r
3767 lo, inclusive and third, hi, exclusive.</p></div>
\r
3768 <div class="exampleblock">
\r
3769 <div class="content">
\r
3770 <div class="sidebarblock">
\r
3771 <div class="content">
\r
3772 <div class="title">Definition concept for WITHIN</div>
\r
3773 <div class="paragraph"><p>: WITHIN 2 PICK > ROT ROT ⇐ AND ;</p></div>
\r
3776 <div style="text-align:center">
\r
3777 _______________________________________________________
\r
3779 <div class="paragraph"><p><a id="p_words"></a></p></div>
\r
3781 <div class="sect2">
\r
3782 <h3 id="_word_words">Word: WORDS</h3>
\r
3783 <div class="literalblock">
\r
3784 <div class="content">
\r
3785 <pre><code>Data stack: ( wl -- )</code></pre>
\r
3787 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word
\r
3788 list to stdout (file descriptor 1).</p></div>
\r
3789 <div style="text-align:center">
\r
3790 _______________________________________________________
\r
3792 <div class="paragraph"><p><a id="p_xor"></a></p></div>
\r
3794 <div class="sect2">
\r
3795 <h3 id="_word_xor">Word: XOR</h3>
\r
3796 <div class="literalblock">
\r
3797 <div class="content">
\r
3798 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
3800 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise
\r
3801 exclusion; each bit is 1 if the corresponding bits of the two operands
\r
3802 differ and 0 if not.</p></div>
\r
3803 <div style="text-align:center">
\r
3804 _______________________________________________________
\r
3806 <div class="paragraph"><p><a id="return_stack"></a></p></div>
\r
3808 <div class="sect2">
\r
3809 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>
\r
3810 <div class="literalblock">
\r
3811 <div class="content">
\r
3812 <pre><code>Data stack: ( -- a )</code></pre>
\r
3814 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>
\r
3818 <div class="sect1">
\r
3819 <h2 id="_system_calls">System calls</h2>
\r
3820 <div class="sectionbody">
\r
3821 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which
\r
3822 generally are described in their "man pages. This wrapping takes the
\r
3823 arguments fro the data stack in reverse order, i.e. the first argument
\r
3824 is deepest.</p></div>
\r
3825 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>
\r
3829 <div id="footnotes"><hr /></div>
\r
3831 <div id="footer-text">
\r
3833 2021-06-12 22:46:13 AEST
\r
projects / rrq / rrqforth.git / blob