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_2get">2@</a>  
\r
774 <a href="#p_2put">2!</a>  
\r
775 <a href="#p_put_plus">!+</a>  
\r
776 <a href="#p_get_n_increment">@n++</a>  
\r
777 <a href="#p_get_n_decrement">@n--</a>  
\r
778 <a href="#p_Ccomma">C,</a>  
\r
779 <a href="#p_literal_string">S"</a>  
\r
780 <a href="#p_gtR">>R</a>  
\r
781 <a href="#p_Rget">R@</a>  
\r
782 <a href="#p_Rgt">R></a>  
\r
783 <a href="#p_rsp">R[n]</a>  </p></div>
\r
784 <div class="paragraph"><p><a href="#data_stack">DATA-STACK</a>  
\r
785 <a href="#return_stack">RETURN-STACK</a>  
\r
787 <a href="#p_branch">BRANCH</a>  
\r
788 <a href="#p_0branch">0BRANCH</a>  
\r
789 <a href="#p_1branch">1BRANCH</a>  
\r
791 <a href="#p_2drop">2DROP</a>  
\r
792 <a href="#p_2dup">2DUP</a>  
\r
793 <a href="#p_2over">2OVER</a>  
\r
794 <a href="#p_2swap">2SWAP</a>  </p></div>
\r
795 <div class="paragraph"><p><a href="#p_abs">ABS</a>  
\r
796 <a href="#p_allot">ALLOT</a>  
\r
797 <a href="#p_and">AND</a>  
\r
798 <a href="#inline_code">[ASM]</a>  </p></div>
\r
799 <div class="paragraph"><p><a href="#p_base">BASE</a>  
\r
800 <a href="#p_begin">BEGIN</a>  
\r
801 <a href="#p_break">BREAK</a>  </p></div>
\r
802 <div class="paragraph"><p><a href="#p_cfa2flags_get">CFA>FLAGS@</a>  
\r
803 <a href="#p_clear_stream">CLEAR-STREAM</a>  
\r
804 <a href="#p_create">CREATE</a>  
\r
805 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>  </p></div>
\r
806 <div class="paragraph"><p><a href="#p_decimal">DECIMAL</a>  
\r
807 <a href="#p_depth">DEPTH</a>  
\r
808 <a href="#p_digits">DIGITS</a>  
\r
809 <a href="#p_divmod">/MOD</a>  
\r
810 <a href="#p_dfa2tfa">DFA>TFA</a>  
\r
811 <a href="#p_dodoes">doDOES</a>  
\r
812 <a href="#p_does">DOES></a>  
\r
813 <a href="#p_dofasm">doFASM</a>  
\r
814 <a href="#p_doforth">doFORTH</a>  
\r
815 <a href="#p_dostring">doSTRING</a>  
\r
816 <a href="#p_dovalue">doVALUE</a>  
\r
817 <a href="#p_dovariable">doVARIABLE</a>  
\r
818 <a href="#p_drop">DROP</a>  
\r
819 <a href="#p_dup">DUP</a>  </p></div>
\r
820 <div class="paragraph"><p><a href="#p_else">ELSE</a>  
\r
821 <a href="#p_emit">EMIT</a>  
\r
822 <a href="#p_end">END</a>  
\r
823 <a href="#p_erase">ERASE</a>  
\r
824 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>  
\r
825 <a href="#p_execute">EXECUTE</a>  
\r
826 <a href="#p_exit">EXIT</a>  </p></div>
\r
827 <div class="paragraph"><p><a href="#p_false">FALSE</a>  
\r
828 <a href="#p_find">FIND</a>  
\r
829 <a href="#p_forth">FORTH</a>  </p></div>
\r
830 <div class="paragraph"><p><a href="#p_here">HERE</a>  
\r
831 <a href="#p_hex">HEX</a>  </p></div>
\r
832 <div class="paragraph"><p><a href="#p_if">IF</a>  
\r
833 <a href="#p_ifagain">IFAGAIN</a>  
\r
834 <a href="#p_ifbreak">IFBREAK</a>  
\r
835 <a href="#p_immediate">IMMEDIATE</a>  </p></div>
\r
836 <div class="paragraph"><p><a href="#p_literal">LIT</a>  
\r
837 <a href="#p_load_file_quote">LOAD-FILE"</a>  </p></div>
\r
838 <div class="paragraph"><p><a href="#p_args">MAIN-ARGS</a>  
\r
839 <a href="#p_malloc">MALLOC</a>  </p></div>
\r
840 <div class="paragraph"><p><a href="#p_negate">NEGATE</a>  
\r
841 <a href="#p_nip">NIP</a>  
\r
842 <a href="#p_nl">NL</a>  
\r
843 <a href="#p_not">NOT</a>  
\r
844 <a href="#p_number">NUMBER</a>  </p></div>
\r
845 <div class="paragraph"><p><a href="#p_open_file_quote">OPEN-FILE"</a>  
\r
846 <a href="#p_or">OR</a>  
\r
847 <a href="#p_over">OVER</a>  </p></div>
\r
848 <div class="paragraph"><p><a href="#p_pad">PAD</a>  
\r
849 <a href="#p_pick">PICK</a>  
\r
850 <a href="#p_program_version">PROGRAM_VERSION</a>  </p></div>
\r
851 <div class="paragraph"><p><a href="#p_quit">QUIT</a>  </p></div>
\r
852 <div class="paragraph"><p><a href="#p_read_stream_char">READ-STREAM-CHAR</a>  
\r
853 <a href="#p_read_word">READ-WORD</a>  
\r
854 <a href="#p_realloc">REALLOC</a>  
\r
855 <a href="#p_roll">ROLL</a>  
\r
856 <a href="#p_rot">ROT</a>  </p></div>
\r
857 <div class="paragraph"><p><a href="#p_sp">SP</a>  
\r
858 <a href="#p_state">STATE</a>  
\r
859 <a href="#p_stdin">STDIN</a>  
\r
860 <a href="#p_stream">STREAM</a>  
\r
861 <a href="#p_stream_nchars">STREAM-NCHARS</a>  
\r
862 <a href="#p_strlen">STRLEN</a>  
\r
863 <a href="#p_strncmp">STRNCMP</a>  
\r
864 <a href="#p_strncpy">STRNCPY</a>  
\r
865 <a href="#p_swap">SWAP</a>  
\r
866 <a href="#p_system">SYSTEM</a>  </p></div>
\r
867 <div class="paragraph"><p><a href="#p_tell">TELL</a>  
\r
868 <a href="#p_terminate0">TERMINATE0</a>  
\r
869 <a href="#p_tfa2cfa">TFA>CFA</a>  
\r
870 <a href="#p_tfa2dfa">TFA>DFA</a>  
\r
871 <a href="#p_tfa2flags_get">TFA>FLAGS@</a>  
\r
872 <a href="#p_tfa2namez">TFA>NAMEZ</a>  
\r
873 <a href="#p_then">THEN</a>  
\r
874 <a href="#p_this_word">THIS-WORD</a>  
\r
875 <a href="#p_true">TRUE</a>  
\r
876 <a href="#p_tuck">TUCK</a>  </p></div>
\r
877 <div class="paragraph"><p><a href="#p_verboseQ">VERBOSE?</a>  </p></div>
\r
878 <div class="paragraph"><p><a href="#p_within">WITHIN</a>  
\r
879 <a href="#p_words">WORDS</a>  </p></div>
\r
880 <div class="paragraph"><p><a href="#p_xor">XOR</a>  </p></div>
\r
881 <div class="paragraph"><p><a href="#p_calltrace">[calltrace]</a>  
\r
882 <a href="#p_setup_signals">[setup_signals]</a>  </p></div>
\r
885 <div class="sect1">
\r
886 <h2 id="_word_descriptions">Word Descriptions</h2>
\r
887 <div class="sectionbody">
\r
888 <div class="paragraph"><p><a id="inline_code"></a></p></div>
\r
889 <div class="sect2">
\r
890 <h3 id="_word_asm">Word: [ASM]</h3>
\r
891 <div class="literalblock">
\r
892 <div class="content">
\r
893 <pre><code>data stack: ( -- )</code></pre>
\r
895 <div class="paragraph"><p>"[ASM]" is a function word that introduces inline assembly in an
\r
896 RRQFORTH definition. Such assembly code may return to subsequence
\r
897 RRQFORTH executon by means of the following instruction sequence:</p></div>
\r
898 <div class="exampleblock">
\r
899 <div class="content">
\r
900 <div class="listingblock">
\r
901 <div class="content">
\r
902 <pre><code> mov rsi,forthcode
\r
905 forthcode:</code></pre>
\r
908 <div class="paragraph"><p>Note that the FORTH compiler does not invoke an assembler so any
\r
909 inline assembly code must be provided in its binary form.</p></div>
\r
910 <div style="text-align:center">
\r
911 _______________________________________________________
\r
913 <div class="paragraph"><p><a id="p_0branch"></a></p></div>
\r
915 <div class="sect2">
\r
916 <h3 id="_word_0branch">Word: 0BRANCH</h3>
\r
917 <div class="literalblock">
\r
918 <div class="content">
\r
919 <pre><code>Data stack: ( v -- )</code></pre>
\r
921 <div class="paragraph"><p>"0BRANCH" is a function word that implements execution conditional by
\r
922 means of optionally adding the subsequent branch offset, or not, to
\r
923 the point of execution. If the value, v, is 0 then the branch offset
\r
924 is added, and otherwise execution continues with the cell following
\r
925 the branch offset in the definition.</p></div>
\r
926 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
927 definition take up a cell of 8 bytes. The offset is relative to the
\r
928 cell address immediately subsequent to the offset cell. In other
\r
929 words, offset 0 is not branching anywhere and an offset of -16 would
\r
930 make a tight loop back to the branch instruction itself. The latter
\r
931 would pull data stack values until and including the first non-zero
\r
933 <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
934 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
935 <div style="text-align:center">
\r
936 _______________________________________________________
\r
938 <div class="paragraph"><p><a id="p_0equal"></a></p></div>
\r
940 <div class="sect2">
\r
941 <h3 id="_word_0">Word: 0=</h3>
\r
942 <div class="literalblock">
\r
943 <div class="content">
\r
944 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
946 <div class="paragraph"><p>"0=" is a function word that replaces a value with its logical
\r
947 complement; the result is zero if the value non-zero, and the result
\r
948 is non-zero if the value is zero.</p></div>
\r
949 <div class="paragraph"><p>This is the same function as <a href="#p_not">NOT</a>.</p></div>
\r
950 <div style="text-align:center">
\r
951 _______________________________________________________
\r
953 <div class="paragraph"><p><a id="p_0less"></a></p></div>
\r
955 <div class="sect2">
\r
956 <h3 id="_word_0_lt">Word: 0<</h3>
\r
957 <div class="literalblock">
\r
958 <div class="content">
\r
959 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
961 <div class="paragraph"><p>"0<" is a function word that replaces a value with -1 if the value is
\r
962 less than 0, and 0 otherwise.</p></div>
\r
963 <div class="exampleblock">
\r
964 <div class="content">
\r
965 <div class="sidebarblock">
\r
966 <div class="content">
\r
967 <div class="title">Definition concept for 0<</div>
\r
968 <div class="paragraph"><p>( v — 0/1 ) : 0= 0 SWAP < ;</p></div>
\r
971 <div class="paragraph"><p>See also <a href="#p_swap">SWAP</a> and <a href="#p_lessthan"><</a>.</p></div>
\r
972 <div style="text-align:center">
\r
973 _______________________________________________________
\r
975 <div class="paragraph"><p><a id="p_1branch"></a></p></div>
\r
977 <div class="sect2">
\r
978 <h3 id="_word_1branch">Word: 1BRANCH</h3>
\r
979 <div class="literalblock">
\r
980 <div class="content">
\r
981 <pre><code>Data stack: ( v -- )</code></pre>
\r
983 <div class="paragraph"><p>"1BRANCH" is a function word that implements execution conditional by
\r
984 means of optionally adding the subsequent branch offset, or not, to
\r
985 the point of execution. If the value, v, is non-zero then the branch
\r
986 offset is added, and otherwise execution continues with the cell
\r
987 following the branch offset in the definition.</p></div>
\r
988 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
989 definition take up a cell of 8 bytes. The offset is relative to the
\r
990 cell address immediately subsequent to the offset cell. In other
\r
991 words, offset 0 is not branching anywhere and an offset of -16 would
\r
992 make a tight loop back to the branch instruction itself. The latter
\r
993 would pull data stack values until and including the first zero value.</p></div>
\r
994 <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
995 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
996 <div style="text-align:center">
\r
997 _______________________________________________________
\r
999 <div class="paragraph"><p><a id="p_2drop"></a></p></div>
\r
1001 <div class="sect2">
\r
1002 <h3 id="_word_2drop">Word: 2DROP</h3>
\r
1003 <div class="literalblock">
\r
1004 <div class="content">
\r
1005 <pre><code>Data stack: ( v1 v2 -- )</code></pre>
\r
1007 <div class="paragraph"><p>"2DROP" is a function word that plainly discards the top 2 cells from
\r
1008 the data stack.</p></div>
\r
1009 <div style="text-align:center">
\r
1010 _______________________________________________________
\r
1012 <div class="paragraph"><p><a id="p_2dup"></a></p></div>
\r
1014 <div class="sect2">
\r
1015 <h3 id="_word_2dup">Word: 2DUP</h3>
\r
1016 <div class="literalblock">
\r
1017 <div class="content">
\r
1018 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 v2 )</code></pre>
\r
1020 <div class="paragraph"><p>"2DUP" is a function word that duplicates the top 2 cells on the data
\r
1022 <div class="exampleblock">
\r
1023 <div class="content">
\r
1024 <div class="sidebarblock">
\r
1025 <div class="content">
\r
1026 <div class="title">Definition concept for 2DUP</div>
\r
1027 <div class="paragraph"><p>( v1 v2 — v1 v2 v1 v2 ) : 2DUP OVER OVER ;</p></div>
\r
1030 <div style="text-align:center">
\r
1031 _______________________________________________________
\r
1033 <div class="paragraph"><p><a id="p_2get"></a></p></div>
\r
1035 <div class="sect2">
\r
1036 <h3 id="_word_2">Word: 2@</h3>
\r
1037 <div class="literalblock">
\r
1038 <div class="content">
\r
1039 <pre><code>Data stack: ( a -- v2 v1 )</code></pre>
\r
1041 <div class="paragraph"><p>"2@" is a function word that pushes the two concecutive values v1 and
\r
1042 v2 from the address a onto the data stack. Value v1 is from address a
\r
1043 and value v2 is from address a + 8.</p></div>
\r
1044 <div style="text-align:center">
\r
1045 _______________________________________________________
\r
1047 <div class="paragraph"><p><a id="p_2over"></a></p></div>
\r
1049 <div class="sect2">
\r
1050 <h3 id="_word_2over">Word: 2OVER</h3>
\r
1051 <div class="literalblock">
\r
1052 <div class="content">
\r
1053 <pre><code>Data stack: ( v1 v2 v3 v4 -- v1 v2 v3 v4 v1 v2 )</code></pre>
\r
1055 <div class="paragraph"><p>"2OVER" is a function word that replicates the second duble-cell pair
\r
1056 onto the top of the data stack. This is similar to <a href="#p_over">OVER</a> but
\r
1057 working with cell pairs rather than single cells.</p></div>
\r
1058 <div class="exampleblock">
\r
1059 <div class="content">
\r
1060 <div class="sidebarblock">
\r
1061 <div class="content">
\r
1062 <div class="title">Definition concept for 2OVER</div>
\r
1063 <div class="paragraph"><p>( v1 v2 v3 v4 — v1 v2 v3 v4 v1 v2 ) : 2OVER 3 PICK 3 PICK ;</p></div>
\r
1066 <div style="text-align:center">
\r
1067 _______________________________________________________
\r
1069 <div class="paragraph"><p><a id="p_2put"></a></p></div>
\r
1071 <div class="sect2">
\r
1072 <h3 id="_word_2_2">Word: 2!</h3>
\r
1073 <div class="literalblock">
\r
1074 <div class="content">
\r
1075 <pre><code>Data stack: ( v2 v1 a -- )</code></pre>
\r
1077 <div class="paragraph"><p>"2!" is a function word that stors two concecutive values v1 and v2 to
\r
1078 the address a from the data stack. Value v1 is stored at address a and
\r
1079 value v2 is stored at address a + 8.</p></div>
\r
1080 <div style="text-align:center">
\r
1081 _______________________________________________________
\r
1083 <div class="paragraph"><p><a id="p_2swap"></a></p></div>
\r
1085 <div class="sect2">
\r
1086 <h3 id="_word_2swap">Word: 2SWAP</h3>
\r
1087 <div class="literalblock">
\r
1088 <div class="content">
\r
1089 <pre><code>Data stack: ( v1 v2 v3 v4 -- v3 v4 v1 v2 )</code></pre>
\r
1091 <div class="paragraph"><p>"2SWAP" is a function word the reorgnizes the top 4 cells swappping
\r
1092 the upper and lower pair. This is similar to <a href="#p_swap">SWAP</a> but
\r
1093 working with cell pairs rather than single cells.</p></div>
\r
1094 <div class="exampleblock">
\r
1095 <div class="content">
\r
1096 <div class="sidebarblock">
\r
1097 <div class="content">
\r
1098 <div class="title">Definition concept for 2SWAP</div>
\r
1099 <div class="paragraph"><p>( v1 v2 v3 v4 — v3 v4 v1 v2 ) : 2SWAP 3 ROLL 3 ROLL ;</p></div>
\r
1102 <div style="text-align:center">
\r
1103 _______________________________________________________
\r
1105 <div class="paragraph"><p><a id="p_Ccomma"></a></p></div>
\r
1107 <div class="sect2">
\r
1108 <h3 id="_word_c">Word: C,</h3>
\r
1109 <div class="literalblock">
\r
1110 <div class="content">
\r
1111 <pre><code>Data stack: ( v -- )</code></pre>
\r
1113 <div class="paragraph"><p>"C," (C-comma) is a function word that puts a byte on the
\r
1114 <a href="#p_here">HERE</a> heap. The least significant byte of the value is put
\r
1115 at the current free head address, which also is incremented.</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 C,</div>
\r
1121 <div class="paragraph"><p>: C, HERE @ 1 ALLOT C! ; ( v — ; Claim 1 byte and put lsb value there )</p></div>
\r
1124 <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
1125 <a href="#p_allot">ALLOT</a>, <a href="#p_Cput">C!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1126 <div style="text-align:center">
\r
1127 _______________________________________________________
\r
1129 <div class="paragraph"><p><a id="p_Cget"></a></p></div>
\r
1131 <div class="sect2">
\r
1132 <h3 id="_word_c_2">Word: C@</h3>
\r
1133 <div class="literalblock">
\r
1134 <div class="content">
\r
1135 <pre><code>Data stack: ( a -- v )</code></pre>
\r
1137 <div class="paragraph"><p>"C@" is a function word that pushes the byte value v from the address a.</p></div>
\r
1138 <div style="text-align:center">
\r
1139 _______________________________________________________
\r
1141 <div class="paragraph"><p><a id="p_Cput"></a></p></div>
\r
1143 <div class="sect2">
\r
1144 <h3 id="_word_c_3">Word: C!</h3>
\r
1145 <div class="literalblock">
\r
1146 <div class="content">
\r
1147 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1149 <div class="paragraph"><p>"C!" is a function word that stores the byte value v (the least
\r
1150 significant byte of the cell) at the address a.</p></div>
\r
1151 <div style="text-align:center">
\r
1152 _______________________________________________________
\r
1154 <div class="paragraph"><p><a id="p_Rget"></a></p></div>
\r
1156 <div class="sect2">
\r
1157 <h3 id="_word_r">Word: R@</h3>
\r
1158 <div class="literalblock">
\r
1159 <div class="content">
\r
1160 <pre><code>Data stack: ( -- v ) Return stack: ( v -- v )</code></pre>
\r
1162 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto
\r
1163 the data stack.</p></div>
\r
1164 <div style="text-align:center">
\r
1165 _______________________________________________________
\r
1167 <div class="paragraph"><p><a id="p_Rgt"></a></p></div>
\r
1169 <div class="sect2">
\r
1170 <h3 id="_word_r_gt">Word: R></h3>
\r
1171 <div class="literalblock">
\r
1172 <div class="content">
\r
1173 <pre><code>Data stack: ( -- v ) Return stack: ( v -- )</code></pre>
\r
1175 <div class="paragraph"><p>"R>" is a function word that "moves" the top return stack value onto
\r
1176 the data stack.</p></div>
\r
1177 <div style="text-align:center">
\r
1178 _______________________________________________________
\r
1180 <div class="paragraph"><p><a id="p_abs"></a></p></div>
\r
1182 <div class="sect2">
\r
1183 <h3 id="_word_abs">Word: ABS</h3>
\r
1184 <div class="literalblock">
\r
1185 <div class="content">
\r
1186 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
1188 <div class="paragraph"><p>"ABS" is a function word that replaces a value with its absolute
\r
1189 value. To that end, the values are 64-bit signed integers.</p></div>
\r
1190 <div style="text-align:center">
\r
1191 _______________________________________________________
\r
1193 <div class="paragraph"><p><a id="p_allot"></a></p></div>
\r
1195 <div class="sect2">
\r
1196 <h3 id="_word_allot">Word: ALLOT</h3>
\r
1197 <div class="literalblock">
\r
1198 <div class="content">
\r
1199 <pre><code>Data stack: ( n -- )</code></pre>
\r
1201 <div class="paragraph"><p>"ALLOT" is a function word that merely increments the <a href="#p_here">HERE</a>
\r
1202 variable with <code>n</code> so as to claim that amount of the heap.</p></div>
\r
1203 <div class="exampleblock">
\r
1204 <div class="content">
\r
1205 <div class="sidebarblock">
\r
1206 <div class="content">
\r
1207 <div class="title">Defintion concept for ALLOT</div>
\r
1208 <div class="paragraph"><p>( n — ) : ALLOT HERE @ + HERE ! ;</p></div>
\r
1211 <div class="exampleblock">
\r
1212 <div class="content">
\r
1213 <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
1215 <div style="text-align:center">
\r
1216 _______________________________________________________
\r
1218 <div class="paragraph"><p><a id="p_and"></a></p></div>
\r
1220 <div class="sect2">
\r
1221 <h3 id="_word_and">Word: AND</h3>
\r
1222 <div class="literalblock">
\r
1223 <div class="content">
\r
1224 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
1226 <div class="paragraph"><p>"AND" is a function word that replaces a value pair with their bitwise
\r
1227 conjunction; each bit is 1 if the corresponding bits of both operands
\r
1228 are 1 and 0 if not.</p></div>
\r
1229 <div style="text-align:center">
\r
1230 _______________________________________________________
\r
1232 <div class="paragraph"><p><a id="p_args"></a></p></div>
\r
1234 <div class="sect2">
\r
1235 <h3 id="_word_main_args">Word: MAIN-ARGS</h3>
\r
1236 <div class="literalblock">
\r
1237 <div class="content">
\r
1238 <pre><code>Data stack: ( -- p[argv** argc] )</code></pre>
\r
1240 <div class="paragraph"><p>"ARGS" is a value word that holds a pointer to the command line data
\r
1241 block which consists of a count cell followed by that many asciiz
\r
1242 pointers and then a 0 cell.</p></div>
\r
1243 <div class="exampleblock">
\r
1244 <div class="content">
\r
1245 <div class="listingblock">
\r
1246 <div class="title">Usage example 2: the command line argument block</div>
\r
1247 <div class="content">
\r
1248 <pre><code>ARGS -> 8 bytes: count of non-zero asciiz pointers following
\r
1249 8 bytes: command name string
\r
1250 8 bytes: first argument string
\r
1252 8 zero</code></pre>
\r
1255 <div style="text-align:center">
\r
1256 _______________________________________________________
\r
1258 <div class="paragraph"><p><a id="p_base"></a></p></div>
\r
1260 <div class="sect2">
\r
1261 <h3 id="_word_base">Word: BASE</h3>
\r
1262 <div class="literalblock">
\r
1263 <div class="content">
\r
1264 <pre><code>Data stack: ( -- a )</code></pre>
\r
1266 <div class="paragraph"><p>"BASE" is a variable word for the numerical base used by input and
\r
1267 output functions, <a href="#p_number">NUMBER</a> and <a href="#p_dot">[p_dot]</a>, when
\r
1268 translating numbers between cell value form and text form. The
\r
1269 numerical base is set to 10 or 16 by <a href="#p_decimal">DECIMAL</a> and
\r
1270 <a href="#p_hex">HEX</a> respectively, and those are the only two bases currently
\r
1271 supported.</p></div>
\r
1272 <div class="paragraph"><p>See also <a href="#p_digits">DIGITS</a>, which holds the mapping table from
\r
1273 digits to text.</p></div>
\r
1274 <div style="text-align:center">
\r
1275 _______________________________________________________
\r
1277 <div class="paragraph"><p><a id="p_begin"></a></p></div>
\r
1279 <div class="sect2">
\r
1280 <h3 id="_word_begin">Word: BEGIN</h3>
\r
1281 <div class="literalblock">
\r
1282 <div class="content">
\r
1283 <pre><code>Data stack: Compiling: ( -- a 0 )</code></pre>
\r
1285 <div class="paragraph"><p>"BEGIN" is an immediate function word that is used together with
\r
1286 <a href="#p_ifbreak">IFBREAK</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
1287 implement structured execution control. BEGIN simply places the
\r
1288 address for resolving branches back to this point during execution,
\r
1289 and then a 0 as a marker so as to allow for an unknown number of block
\r
1290 exit points.</p></div>
\r
1291 <div class="exampleblock">
\r
1292 <div class="content">
\r
1293 <div class="listingblock">
\r
1294 <div class="title">Usage example 3:</div>
\r
1295 <div class="content">
\r
1296 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1297 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1300 : WORDS ( wordlist -- ; Print all words of word list )
\r
1310 <div style="text-align:center">
\r
1311 _______________________________________________________
\r
1313 <div class="paragraph"><p><a id="p_bracketed_quote"></a></p></div>
\r
1315 <div class="sect2">
\r
1316 <h3 id="_word">Word: [']</h3>
\r
1317 <div class="literalblock">
\r
1318 <div class="content">
\r
1319 <pre><code>Data stack: ( -- cfa ) Input stream: word</code></pre>
\r
1321 <div class="paragraph"><p>"[']" is an immediate function word that reads the next word on the
\r
1322 input stream and pushes its cfa.</p></div>
\r
1323 <div class="exampleblock">
\r
1324 <div class="content">
\r
1325 <div class="sidebarblock">
\r
1326 <div class="content">
\r
1327 <div class="title">Definition concept for [']</div>
\r
1328 <div class="paragraph"><p>: ['] IMMEDIATE ' ;</p></div>
\r
1331 <div style="text-align:center">
\r
1332 _______________________________________________________
\r
1334 <div class="paragraph"><p><a id="p_branch"></a></p></div>
\r
1336 <div class="sect2">
\r
1337 <h3 id="_word_branch">Word: BRANCH</h3>
\r
1338 <div class="literalblock">
\r
1339 <div class="content">
\r
1340 <pre><code>Data stack: ( -- )</code></pre>
\r
1342 <div class="paragraph"><p>"BRANCH" is a function word that implements execution transfer by
\r
1343 means of adding the subsequent branch offset to the point of
\r
1344 execution.</p></div>
\r
1345 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
1346 definition take up a cell of 8 bytes. The offset is relative to the
\r
1347 cell address immediately subsequent to the offset cell. In other
\r
1348 words, offset 0 is not branching anywhere and an offset of -16 would
\r
1349 make a tight loop back to the branch instruction itself. The latter
\r
1350 would pull data stack values until and including the first zero value.</p></div>
\r
1351 <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
1352 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1353 <div style="text-align:center">
\r
1354 _______________________________________________________
\r
1356 <div class="paragraph"><p><a id="p_break"></a></p></div>
\r
1358 <div class="sect2">
\r
1359 <h3 id="_word_break">Word: BREAK</h3>
\r
1360 <div class="paragraph"><p>"BREAK" is an immediate function word that lays out an unconditional
\r
1361 branch out of an enclosing xef:p_begin[BEGIN]-<a href="#p_end">END</a> block.
\r
1362 Similar to <a href="#p_ifbreak">IFBREAK</a> it lays out the branch cell
\r
1363 followed by a reserved cell for the branch offset, and inserts the
\r
1364 resolution address just above the required 0 on the data stack.</p></div>
\r
1365 <div class="exampleblock">
\r
1366 <div class="content">
\r
1367 <div class="listingblock">
\r
1368 <div class="title">Usage example 4: unconditional break with a condition.</div>
\r
1369 <div class="content">
\r
1370 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1371 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1374 : WORDS ( wordlist -- ; Print all words of word list )
\r
1376 @ DUP IF DUP WTELL ELSE BREAK THEN
\r
1384 <div class="paragraph"><p>See also <a href="#p_branch">BRANCH</a>, <a href="#p_0branch">0BRANCH</a>,
\r
1385 <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>, <a href="#p_else">ELSE</a>,
\r
1386 <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1387 <div style="text-align:center">
\r
1388 _______________________________________________________
\r
1390 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>
\r
1392 <div class="sect2">
\r
1393 <h3 id="_word_calltrace">Word: [calltrace]</h3>
\r
1394 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly
\r
1395 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>
\r
1396 <div style="text-align:center">
\r
1397 _______________________________________________________
\r
1399 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>
\r
1401 <div class="sect2">
\r
1402 <h3 id="_word_cfa_gt_flags">Word: CFA>FLAGS@</h3>
\r
1403 <div class="literalblock">
\r
1404 <div class="content">
\r
1405 <pre><code>Data stack: ( cfa -- flags )</code></pre>
\r
1407 <div class="paragraph"><p>"CFA>FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>
\r
1408 <div class="exampleblock">
\r
1409 <div class="content">
\r
1410 <div class="sidebarblock">
\r
1411 <div class="content">
\r
1412 <div class="title">Defintion concept for CFA>FLAGS@</div>
\r
1413 <div class="paragraph"><p>: CFA>FLAGS@ 16 - @ 16 + ;</p></div>
\r
1416 <div style="text-align:center">
\r
1417 _______________________________________________________
\r
1419 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>
\r
1421 <div class="sect2">
\r
1422 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>
\r
1423 <div class="literalblock">
\r
1424 <div class="content">
\r
1425 <pre><code>Data stack: ( stream -- )</code></pre>
\r
1427 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently
\r
1428 remaining in the buffer for the stream, so that a subsequent read will
\r
1429 pull in more data from its source.</p></div>
\r
1430 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>
\r
1431 <div style="text-align:center">
\r
1432 _______________________________________________________
\r
1434 <div class="paragraph"><p><a id="p_colon"></a></p></div>
\r
1436 <div class="sect2">
\r
1437 <h3 id="_word_3">Word: :</h3>
\r
1438 <div class="literalblock">
\r
1439 <div class="content">
\r
1440 <pre><code>Data stack: ( -- ) Input stream: word</code></pre>
\r
1442 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.
\r
1443 This includes reading the next word for making a new dictionary entry
\r
1444 and setting evaluation state to compiling mode.</p></div>
\r
1445 <div class="exampleblock">
\r
1446 <div class="content">
\r
1447 <div class="sidebarblock">
\r
1448 <div class="content">
\r
1449 <div class="title">Definition concept for :</div>
\r
1450 <div class="paragraph"><p>: : doFORTH READ-WORD CREATE TFA>CFA ! ] ;</p></div>
\r
1453 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,
\r
1454 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA>CFA</a>, <a href="#p_put">!</a>,
\r
1455 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1456 <div style="text-align:center">
\r
1457 _______________________________________________________
\r
1459 <div class="paragraph"><p><a id="p_comma"></a></p></div>
\r
1461 <div class="sect2">
\r
1462 <h3 id="_word_4">Word: ,</h3>
\r
1463 <div class="literalblock">
\r
1464 <div class="content">
\r
1465 <pre><code>Data stack: ( v -- )</code></pre>
\r
1467 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the
\r
1468 <a href="#p_here">HERE</a> heap.</p></div>
\r
1469 <div class="exampleblock">
\r
1470 <div class="content">
\r
1471 <div class="sidebarblock">
\r
1472 <div class="content">
\r
1473 <div class="title">Definition concept for ,</div>
\r
1474 <div class="paragraph"><p>: , HERE @ 8 ALLOT ! ; ( v — ; Claim 8 bytes and put value there )</p></div>
\r
1477 <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
1478 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1479 <div style="text-align:center">
\r
1480 _______________________________________________________
\r
1482 <div class="paragraph"><p><a id="p_create"></a></p></div>
\r
1484 <div class="sect2">
\r
1485 <h3 id="_word_create">Word: CREATE</h3>
\r
1486 <div class="literalblock">
\r
1487 <div class="content">
\r
1488 <pre><code>Data stack: ( char* n -- tfa )</code></pre>
\r
1490 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the
\r
1491 indicated [n:char*] print name, and returns the "TFA" (Token Field
\r
1492 Address) of the word. The header memory layout is as follows:</p></div>
\r
1493 <div class="exampleblock">
\r
1494 <div class="content">
\r
1495 <div class="listingblock">
\r
1496 <div class="title">Layout 1: rrqforth word structure</div>
\r
1497 <div class="content">
\r
1498 <pre><code>struct WORD
\r
1499 TFA 8 link ; tfa of previous word
\r
1500 pCFA 8 cfap ; CFA = Code Field Address of this word
\r
1502 PFA 8 length ; length of pname representation
\r
1503 ? pname ; the pname bytes
\r
1504 1 nul ; a forced nul byte following the pname
\r
1505 pTFA 8 tfap ; TFA = Token Field Address of this word
\r
1506 OFF 8 doff ; entry offset for FORTH level execution
\r
1507 CFA 8 doer ; word execution semantics
\r
1508 DFA 0 content ; DFA = Data Field Address
\r
1509 end_struct</code></pre>
\r
1512 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content
\r
1513 as held in the memory space following the DFA (Data Field Address).</p></div>
\r
1514 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for
\r
1515 RRQFORTH execution, as holding a jump address to the assembly code
\r
1516 that implements the particular execution semantics for the word.
\r
1517 "CREATE" will assign this as "dovariable", which makes the word push
\r
1518 its DFA when executed. This is changed to "doforth" for RRQFORTH
\r
1519 function words initiated by ":" (aka "COLON") or changed to "dovalue"
\r
1520 for RRQFORTH constants created by "CONSTANT".</p></div>
\r
1521 <div class="exampleblock">
\r
1522 <div class="content">
\r
1523 <div class="sidebarblock">
\r
1524 <div class="content">
\r
1525 <div class="title">Definition concept for CREATE</div>
\r
1526 <div class="paragraph"><p>HERE @ R> ( save tfa on RS )
\r
1527 R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )
\r
1528 DUP 49 + R@ + , ( pCFA )
\r
1531 HERE @ ROT ROT MEMCPY 0 C, ( pname + NUL )
\r
1534 doVARIABLE ( CFA, default semantics )</p></div>
\r
1537 <div class="exampleblock">
\r
1538 <div class="content">
\r
1539 <div class="listingblock">
\r
1540 <div class="title">Usage example 5: a possible definition of CONSTANT</div>
\r
1541 <div class="content">
\r
1542 <pre><code>: CONSTANT READ-WORD CREATE TFA>DFA doVALUE OVER 8 - ! ! ;</code></pre>
\r
1545 <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
1546 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,
\r
1547 <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
1548 and <a href="#p_dovariable">doVARIABLE</a>,
\r
1549 as well as <a href="#p_execute">EXECUTE</a>
\r
1550 about the range of "doer" assignments and their meanings.</p></div>
\r
1551 <div style="text-align:center">
\r
1552 _______________________________________________________
\r
1554 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>
\r
1556 <div class="sect2">
\r
1557 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>
\r
1558 <div class="literalblock">
\r
1559 <div class="content">
\r
1560 <pre><code>Data stack: ( -- a )</code></pre>
\r
1562 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the
\r
1563 current word list word for <a href="#p_find">FIND</a> to use finding words. The
\r
1564 word list word content is as follows:</p></div>
\r
1565 <div class="exampleblock">
\r
1566 <div class="content">
\r
1567 <div class="listingblock">
\r
1568 <div class="title">Layout 2: word list word content</div>
\r
1569 <div class="content">
\r
1570 <pre><code> 8 TFA of latest word in the word list
\r
1571 8 DFA of the/a subsequent word list to search through</code></pre>
\r
1574 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends
\r
1575 with the <a href="#p_forth">FORTH</a> word list. Initially the
\r
1576 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>
\r
1577 <div style="text-align:center">
\r
1578 _______________________________________________________
\r
1580 <div class="paragraph"><p><a id="data_stack"></a></p></div>
\r
1582 <div class="sect2">
\r
1583 <h3 id="_word_data_stack">Word: DATA-STACK</h3>
\r
1584 <div class="literalblock">
\r
1585 <div class="content">
\r
1586 <pre><code>Data stack: ( -- a )</code></pre>
\r
1588 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>
\r
1589 <div style="text-align:center">
\r
1590 _______________________________________________________
\r
1592 <div class="paragraph"><p><a id="p_decimal"></a></p></div>
\r
1594 <div class="sect2">
\r
1595 <h3 id="_word_decimal">Word: DECIMAL</h3>
\r
1596 <div class="literalblock">
\r
1597 <div class="content">
\r
1598 <pre><code>Data stack: ( -- )</code></pre>
\r
1600 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>
\r
1601 <div class="exampleblock">
\r
1602 <div class="content">
\r
1603 <div class="sidebarblock">
\r
1604 <div class="content">
\r
1605 <div class="title">Definition concept for DECIMAL</div>
\r
1606 <div class="paragraph"><p>: DECIMAL 10 BASE ! ;</p></div>
\r
1609 <div style="text-align:center">
\r
1610 _______________________________________________________
\r
1612 <div class="paragraph"><p><a id="p_depth"></a></p></div>
\r
1614 <div class="sect2">
\r
1615 <h3 id="_word_depth">Word: DEPTH</h3>
\r
1616 <div class="literalblock">
\r
1617 <div class="content">
\r
1618 <pre><code>Data stack: ( -- v )</code></pre>
\r
1620 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells
\r
1621 onto the data stack.</p></div>
\r
1622 <div style="text-align:center">
\r
1623 _______________________________________________________
\r
1625 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>
\r
1627 <div class="sect2">
\r
1628 <h3 id="_word_dfa_gt_tfa">Word: DFA>TFA</h3>
\r
1629 <div class="literalblock">
\r
1630 <div class="content">
\r
1631 <pre><code>Data stack: ( dfa -- tfa )</code></pre>
\r
1633 <div class="paragraph"><p>"DFA>TFA" is a function word that pushes word tfa of the given dfa.</p></div>
\r
1634 <div class="exampleblock">
\r
1635 <div class="content">
\r
1636 <div class="sidebarblock">
\r
1637 <div class="content">
\r
1638 <div class="title">Definition concept for DFA>TFA</div>
\r
1639 <div class="paragraph"><p>: DFA>TFA 24 - @ ;</p></div>
\r
1642 <div style="text-align:center">
\r
1643 _______________________________________________________
\r
1645 <div class="paragraph"><p><a id="p_digits"></a></p></div>
\r
1647 <div class="sect2">
\r
1648 <h3 id="_word_digits">Word: DIGITS</h3>
\r
1649 <div class="literalblock">
\r
1650 <div class="content">
\r
1651 <pre><code>Data stack: ( -- a )</code></pre>
\r
1653 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping
\r
1654 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>
\r
1655 <div style="text-align:center">
\r
1656 _______________________________________________________
\r
1658 <div class="paragraph"><p><a id="p_div"></a></p></div>
\r
1660 <div class="sect2">
\r
1661 <h3 id="_word_5">Word: /</h3>
\r
1662 <div class="literalblock">
\r
1663 <div class="content">
\r
1664 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>
\r
1666 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the
\r
1667 results of signed integer division of the first, v1, divided by the
\r
1668 second, v2. To that end, the values are 64-bit signed integers. The
\r
1669 result is the integer quotient, q, and the discarded remainder, r,
\r
1670 where q and r are the respectively largest and smallest integers to
\r
1671 satisfy the formula:</p></div>
\r
1672 <div class="literalblock">
\r
1673 <div class="content">
\r
1674 <pre><code> v1 = q * v2 + r</code></pre>
\r
1676 <div style="text-align:center">
\r
1677 _______________________________________________________
\r
1679 <div class="paragraph"><p><a id="p_divmod"></a></p></div>
\r
1681 <div class="sect2">
\r
1682 <h3 id="_word_mod">Word: /MOD</h3>
\r
1683 <div class="literalblock">
\r
1684 <div class="content">
\r
1685 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>
\r
1687 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values
\r
1688 with the results of signed integer division of the first, v1, divided
\r
1689 by the second, v2. To that end, the values are 64-bit signed integers.
\r
1690 The result is the integer quotient, q, and the remainder, r, where q
\r
1691 and r are the respectively largest and smallest integers to satisfy
\r
1692 the formula:</p></div>
\r
1693 <div class="literalblock">
\r
1694 <div class="content">
\r
1695 <pre><code> v1 = q * v2 + r</code></pre>
\r
1697 <div style="text-align:center">
\r
1698 _______________________________________________________
\r
1700 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>
\r
1702 <div class="sect2">
\r
1703 <h3 id="_word_dodoes">Word: doDOES</h3>
\r
1704 <div class="literalblock">
\r
1705 <div class="content">
\r
1706 <pre><code>Data stack: ( -- a )</code></pre>
\r
1708 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the
\r
1709 <a href="#p_does">[p_does]</a> execution semantics. This is the same as
\r
1710 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word
\r
1711 concerned.</p></div>
\r
1712 <div style="text-align:center">
\r
1713 _______________________________________________________
\r
1715 <div class="paragraph"><p><a id="p_does"></a></p></div>
\r
1717 <div class="sect2">
\r
1718 <h3 id="_word_does_gt">WORD: DOES></h3>
\r
1719 <div class="literalblock">
\r
1720 <div class="content">
\r
1721 <pre><code>Data stack: ( -- )</code></pre>
\r
1723 <div class="paragraph"><p>"DOES>" is a function that in execution mode does nothing but in
\r
1724 compilation mode it changes the execution semantics assignments for
\r
1725 the most recent word to use the <code>dodoes</code> sematics with adjustment
\r
1726 offset to the current heap address. I.e., the word being defined will
\r
1727 have its execution start at whatever comes after "DOES>".</p></div>
\r
1728 <div class="exampleblock">
\r
1729 <div class="content">
\r
1730 <div class="sidebarblock">
\r
1731 <div class="content">
\r
1732 <div class="title">Defintion concept for DOES></div>
\r
1733 <div class="paragraph"><p>: DOES> IMMEDIATE
\r
1734 STATE @ != IF ( only for compilation mode )
\r
1735 CURRENT-WORDLIST @ @ TFA>CFA ( cfa of current word )
\r
1736 doDOES OVER ! ( set up doer )
\r
1737 HERE @ OVER 8 + - SWAP 8 - ! ( set up offset
\r
1742 <div class="paragraph"><p>See also
\r
1743 <a href="#p_put">!</a>,
\r
1744 <a href="#p_unequal">!⇒></a>,
\r
1745 <a href="#p_minus">→></a>,
\r
1746 <a href="#p_get">@</a>,
\r
1747 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
1748 <a href="#p_here">HERE</a>,
\r
1749 <a href="#p_if">IF</a>,
\r
1750 <a href="#p_immediate">IMMEDIATE</a>,
\r
1751 <a href="#p_over">OVER</a>,
\r
1752 <a href="#p_state">STATE</a>,
\r
1753 <a href="#p_swap">SWAP</a>,
\r
1754 <a href="#p_tfa2cfa">TFA>CFA</a>,
\r
1755 <a href="#p_then">THEN</a>,
\r
1756 <a href="#p_dodoes">doDOES</a>,
\r
1757 as well as <a href="#p_execute">EXECUTE</a>
\r
1758 about the range of "doer" assignments and their meanings.</p></div>
\r
1759 <div style="text-align:center">
\r
1760 _______________________________________________________
\r
1762 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>
\r
1764 <div class="sect2">
\r
1765 <h3 id="_word_dofasm">Word: doFASM</h3>
\r
1766 <div class="literalblock">
\r
1767 <div class="content">
\r
1768 <pre><code>Data stack: ( -- a )</code></pre>
\r
1770 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1771 execution semantics for assembly code content.</p></div>
\r
1772 <div style="text-align:center">
\r
1773 _______________________________________________________
\r
1775 <div class="paragraph"><p><a id="p_doforth"></a></p></div>
\r
1777 <div class="sect2">
\r
1778 <h3 id="_word_doforth">Word: doFORTH</h3>
\r
1779 <div class="literalblock">
\r
1780 <div class="content">
\r
1781 <pre><code>Data stack: ( -- a )</code></pre>
\r
1783 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the
\r
1784 RRQFORTH execution semantics.</p></div>
\r
1785 <div style="text-align:center">
\r
1786 _______________________________________________________
\r
1788 <div class="paragraph"><p><a id="p_dostring"></a></p></div>
\r
1790 <div class="sect2">
\r
1791 <h3 id="_word_dostring">Word: doSTRING</h3>
\r
1792 <div class="literalblock">
\r
1793 <div class="content">
\r
1794 <pre><code>Data stack: ( -- a )</code></pre>
\r
1796 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1797 execution semantics for assembly code implemented words. In those
\r
1798 cases the execution leads to the word content.</p></div>
\r
1799 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is
\r
1800 as follows:</p></div>
\r
1801 <div class="listingblock">
\r
1802 <div class="content">
\r
1803 <pre><code> rax = cfa* of word to execute
\r
1804 rsi = cell* in the calling definition, after calling cell
\r
1805 rsp = data stack pointer
\r
1806 rbp = return stack pointer</code></pre>
\r
1808 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>
\r
1809 and <code>rbp</code> are used according to their roles.</p></div>
\r
1810 <div style="text-align:center">
\r
1811 _______________________________________________________
\r
1813 <div class="paragraph"><p><a id="p_dot"></a></p></div>
\r
1815 <div class="sect2">
\r
1816 <h3 id="_word_6">Word: .</h3>
\r
1817 <div class="literalblock">
\r
1818 <div class="content">
\r
1819 <pre><code>Data stack: ( v -- )</code></pre>
\r
1821 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using
\r
1822 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or
\r
1823 <a href="#p_hex">HEX</a>).</p></div>
\r
1824 <div style="text-align:center">
\r
1825 _______________________________________________________
\r
1827 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>
\r
1829 <div class="sect2">
\r
1830 <h3 id="_word_7">Word: "</h3>
\r
1831 <div class="literalblock">
\r
1832 <div class="content">
\r
1833 <pre><code>data stack: ( -- char n ) Input stream: ...."</code></pre>
\r
1835 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream
\r
1836 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the
\r
1837 [n:char*] cell pair for that string.</p></div>
\r
1838 <div style="text-align:center">
\r
1839 _______________________________________________________
\r
1841 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>
\r
1843 <div class="sect2">
\r
1844 <h3 id="_word_dovalue">Word: doVALUE</h3>
\r
1845 <div class="literalblock">
\r
1846 <div class="content">
\r
1847 <pre><code>Data stack: ( -- a )</code></pre>
\r
1849 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the
\r
1850 execution semantics for cell values, which are variables with a single
\r
1851 64-bit cell holding the value.</p></div>
\r
1852 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>
\r
1853 <div class="literalblock">
\r
1854 <div class="content">
\r
1855 <pre><code>Resulting data stack: ( -- v )</code></pre>
\r
1857 <div style="text-align:center">
\r
1858 _______________________________________________________
\r
1860 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>
\r
1862 <div class="sect2">
\r
1863 <h3 id="_word_dovariable">Word: doVARIABLE</h3>
\r
1864 <div class="literalblock">
\r
1865 <div class="content">
\r
1866 <pre><code>Data stack: ( -- a )</code></pre>
\r
1868 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of
\r
1869 the execution semantics for "variables", which basically are markers
\r
1870 into the heap for some number block of memory.</p></div>
\r
1871 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>
\r
1872 <div class="literalblock">
\r
1873 <div class="content">
\r
1874 <pre><code>Resulting data stack: ( -- a )</code></pre>
\r
1876 <div style="text-align:center">
\r
1877 _______________________________________________________
\r
1879 <div class="paragraph"><p><a id="p_drop"></a></p></div>
\r
1881 <div class="sect2">
\r
1882 <h3 id="_word_drop">Word: DROP</h3>
\r
1883 <div class="literalblock">
\r
1884 <div class="content">
\r
1885 <pre><code>Data stack: ( v -- )</code></pre>
\r
1887 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>
\r
1888 <div style="text-align:center">
\r
1889 _______________________________________________________
\r
1891 <div class="paragraph"><p><a id="p_dup"></a></p></div>
\r
1893 <div class="sect2">
\r
1894 <h3 id="_word_dup">Word: DUP</h3>
\r
1895 <div class="literalblock">
\r
1896 <div class="content">
\r
1897 <pre><code>Data stack: ( v -- v v )</code></pre>
\r
1899 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>
\r
1900 <div style="text-align:center">
\r
1901 _______________________________________________________
\r
1903 <div class="paragraph"><p><a id="p_else"></a></p></div>
\r
1905 <div class="sect2">
\r
1906 <h3 id="_word_else">Word: ELSE</h3>
\r
1907 <div class="literalblock">
\r
1908 <div class="content">
\r
1909 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>
\r
1911 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with
\r
1912 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
1913 control. ELSE lays out an unresolved unconditional branch as an ending
\r
1914 for the "then-part" of the structured statement, and it then performs
\r
1915 the branch resolution for the "else-part". To that end it replaces the
\r
1916 stacked address which pin-points the foot address the branch offset to
\r
1917 resolve, so that at execution time there is an appropriate conditional
\r
1918 branch past the "then-part" and the "else-part" of the "structured
\r
1919 statement".</p></div>
\r
1920 <div style="text-align:center">
\r
1921 _______________________________________________________
\r
1923 <div class="paragraph"><p><a id="p_emit"></a></p></div>
\r
1925 <div class="sect2">
\r
1926 <h3 id="_word_emit">Word: EMIT</h3>
\r
1927 <div class="literalblock">
\r
1928 <div class="content">
\r
1929 <pre><code>Data stack: ( c -- )</code></pre>
\r
1931 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to
\r
1932 standard output (file descriptor 1). The character is the least
\r
1933 significant byte of the top cell.</p></div>
\r
1934 <div style="text-align:center">
\r
1935 _______________________________________________________
\r
1937 <div class="paragraph"><p><a id="p_end"></a></p></div>
\r
1939 <div class="sect2">
\r
1940 <h3 id="_word_end">Word: END</h3>
\r
1941 <div class="literalblock">
\r
1942 <div class="content">
\r
1943 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>
\r
1945 <div class="paragraph"><p>"END" is an immediate function word that is used together with
\r
1946 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to
\r
1947 implement structured execution control. END processes the data stack
\r
1948 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the
\r
1949 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>
\r
1950 <div style="text-align:center">
\r
1951 _______________________________________________________
\r
1953 <div class="paragraph"><p><a id="p_equal"></a></p></div>
\r
1955 <div class="sect2">
\r
1956 <h3 id="_word_8">Word: =</h3>
\r
1957 <div class="literalblock">
\r
1958 <div class="content">
\r
1959 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
1961 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the
\r
1962 values are equal, and 0 otherwise.</p></div>
\r
1963 <div style="text-align:center">
\r
1964 _______________________________________________________
\r
1966 <div class="paragraph"><p><a id="p_erase"></a></p></div>
\r
1968 <div class="sect2">
\r
1969 <h3 id="_word_erase">Word: ERASE</h3>
\r
1970 <div class="literalblock">
\r
1971 <div class="content">
\r
1972 <pre><code>Data stack: ( a n -- )</code></pre>
\r
1974 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>
\r
1975 <div style="text-align:center">
\r
1976 _______________________________________________________
\r
1978 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>
\r
1980 <div class="sect2">
\r
1981 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>
\r
1982 <div class="literalblock">
\r
1983 <div class="content">
\r
1984 <pre><code>Data stack: ( stream -- ??? 0/1 ) Input stream: ......</code></pre>
\r
1986 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by
\r
1987 whitespace from the stream until it discovers an unknown word, or the
\r
1988 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are
\r
1989 either executed or compiled, and all ther stack and heap effects are
\r
1990 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the
\r
1991 stack to respectively indicate that the last word was unkown, i.e. not
\r
1992 found (<a href="#p_find">FIND</a>) in the current word list
\r
1993 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a
\r
1994 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>
\r
1995 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known
\r
1996 words that are parsed into cell values. If interpreting, then the
\r
1997 value is left on the stack. If compiling, then the value is added to
\r
1998 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done
\r
1999 so as to make that value be push to the data stack upon a later
\r
2000 execution.</p></div>
\r
2001 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a
\r
2002 minus sign.</p></div>
\r
2003 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its
\r
2004 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word
\r
2005 or not, and whether the state at the time of execution indicates
\r
2006 "compiling" of "interpreting". Immediate words are executed in both
\r
2007 interpreting and compiling state, while other words have their CFA get
\r
2008 added to the heap so as to gain their execution effect upon a later
\r
2009 execution.</p></div>
\r
2010 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return
\r
2011 stack while reading, parsing and executing.</p></div>
\r
2012 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds
\r
2013 the [n:chars] reference of the offending word in the stream buffer.</p></div>
\r
2014 <div style="text-align:center">
\r
2015 _______________________________________________________
\r
2017 <div class="paragraph"><p><a id="p_execute"></a></p></div>
\r
2019 <div class="sect2">
\r
2020 <h3 id="_word_execute">Word: EXECUTE</h3>
\r
2021 <div class="literalblock">
\r
2022 <div class="content">
\r
2023 <pre><code>Data stack: ( cfa -- )</code></pre>
\r
2025 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the
\r
2026 indicated "Code Field Address", which typically is the CFA of an
\r
2027 RRQFORTH word with the CFA cell containing a jump address for the code
\r
2028 that implements the execution semnatics of the word.</p></div>
\r
2029 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>
\r
2030 <div class="ulist"><ul>
\r
2033 assembler implemented words constitute their own execution
\r
2039 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word
\r
2040 content as a succession of cells that hold the cfa pointers for the
\r
2041 words that make of the definition. As is customary in FORTH
\r
2042 machines, the advance through that succession is provided by each
\r
2043 word code ending making an explicit jump to its successor. The
\r
2044 <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking
\r
2045 the nesting of FORTH executions by saving the "addresses" of the
\r
2051 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH
\r
2052 execution somewhere within a definition rather than at the
\r
2058 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement
\r
2059 different common ways of using word content other the as FORTH
\r
2064 <div style="text-align:center">
\r
2065 _______________________________________________________
\r
2067 <div class="paragraph"><p><a id="p_exit"></a></p></div>
\r
2069 <div class="sect2">
\r
2070 <h3 id="_word_exit">Word: EXIT</h3>
\r
2071 <div class="literalblock">
\r
2072 <div class="content">
\r
2073 <pre><code>Data stack: ( -- )</code></pre>
\r
2075 <div class="paragraph"><p>"EXIT" is a function word that implements the ending of a FORTH
\r
2076 definition and its threading to the subsequent step of the calling
\r
2077 definition.</p></div>
\r
2078 <div style="text-align:center">
\r
2079 _______________________________________________________
\r
2081 <div class="paragraph"><p><a id="p_false"></a></p></div>
\r
2083 <div class="sect2">
\r
2084 <h3 id="_word_false">Word: FALSE</h3>
\r
2085 <div class="literalblock">
\r
2086 <div class="content">
\r
2087 <pre><code>Data stack: ( -- 0 )</code></pre>
\r
2089 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>
\r
2090 <div style="text-align:center">
\r
2091 _______________________________________________________
\r
2093 <div class="paragraph"><p><a id="p_find"></a></p></div>
\r
2095 <div class="sect2">
\r
2096 <h3 id="_word_find">Word: FIND</h3>
\r
2097 <div class="literalblock">
\r
2098 <div class="content">
\r
2099 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>
\r
2101 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search
\r
2102 path for the given [n:char*] word, and returns the TFA of the matching
\r
2103 word if any. Otherwise FIND preserves the initial data stack but adds
\r
2104 0 to it.</p></div>
\r
2105 <div class="paragraph"><p>The word is sought starting with the
\r
2106 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first
\r
2107 occurence of a match. If not found, the search continues with the
\r
2108 subsequent word list, and so on.</p></div>
\r
2109 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the
\r
2110 [n:char*] double cell string pointer and pushing (only) the TFA of the
\r
2111 matching word instead.</p></div>
\r
2112 <div style="text-align:center">
\r
2113 _______________________________________________________
\r
2115 <div class="paragraph"><p><a id="p_forth"></a></p></div>
\r
2117 <div class="sect2">
\r
2118 <h3 id="_word_forth">Word: FORTH</h3>
\r
2119 <div class="literalblock">
\r
2120 <div class="content">
\r
2121 <pre><code>data stack: ( -- a )</code></pre>
\r
2123 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not
\r
2124 have any subsequent word list.</p></div>
\r
2125 <div style="text-align:center">
\r
2126 _______________________________________________________
\r
2128 <div class="paragraph"><p><a id="p_get"></a></p></div>
\r
2130 <div class="sect2">
\r
2131 <h3 id="_word_9">Word: @</h3>
\r
2132 <div class="literalblock">
\r
2133 <div class="content">
\r
2134 <pre><code>Data stack: ( a -- v )</code></pre>
\r
2136 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>
\r
2137 <div style="text-align:center">
\r
2138 _______________________________________________________
\r
2140 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>
\r
2142 <div class="sect2">
\r
2143 <h3 id="_word_n">Word: @n--</h3>
\r
2144 <div class="literalblock">
\r
2145 <div class="content">
\r
2146 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2148 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,
\r
2149 then decrements the cell at that address by n.</p></div>
\r
2150 <div class="exampleblock">
\r
2151 <div class="content">
\r
2152 <div class="sidebarblock">
\r
2153 <div class="content">
\r
2154 <div class="title">Defintion concept for @n++</div>
\r
2155 <div class="paragraph"><p>: @n++ OVER @ DUP ROT - ROT ! ;</p></div>
\r
2158 <div style="text-align:center">
\r
2159 _______________________________________________________
\r
2161 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>
\r
2163 <div class="sect2">
\r
2164 <h3 id="_word_n_2">Word: @n++</h3>
\r
2165 <div class="literalblock">
\r
2166 <div class="content">
\r
2167 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2169 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,
\r
2170 then increments the cell at that address by n.</p></div>
\r
2171 <div class="exampleblock">
\r
2172 <div class="content">
\r
2173 <div class="sidebarblock">
\r
2174 <div class="content">
\r
2175 <div class="title">Defintion concept for @n++</div>
\r
2176 <div class="paragraph"><p>( a n — v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>
\r
2179 <div style="text-align:center">
\r
2180 _______________________________________________________
\r
2182 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>
\r
2184 <div class="sect2">
\r
2185 <h3 id="_word_gt">Word: >=</h3>
\r
2186 <div class="literalblock">
\r
2187 <div class="content">
\r
2188 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2190 <div class="paragraph"><p>">=" is a function word that replaces a pair of values with -1 if the
\r
2191 first, v1, is greater than or equal to the second, v1, otherwise 0. To
\r
2192 that end, the values are 64-bit signed integers.</p></div>
\r
2193 <div style="text-align:center">
\r
2194 _______________________________________________________
\r
2196 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>
\r
2198 <div class="sect2">
\r
2199 <h3 id="_word_gt_2">Word: ></h3>
\r
2200 <div class="literalblock">
\r
2201 <div class="content">
\r
2202 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2204 <div class="paragraph"><p>">" is a function word that replaces a pair of values with -1 if the
\r
2205 first, v1, is greater than the second, v1, otherwise 0. To that end,
\r
2206 the values are 64-bit signed integers.</p></div>
\r
2207 <div style="text-align:center">
\r
2208 _______________________________________________________
\r
2210 <div class="paragraph"><p><a id="p_gtR"></a></p></div>
\r
2212 <div class="sect2">
\r
2213 <h3 id="_word_gt_r">Word: >R</h3>
\r
2214 <div class="literalblock">
\r
2215 <div class="content">
\r
2216 <pre><code>Data stack: ( v -- ) Return stack: ( -- v )</code></pre>
\r
2218 <div class="paragraph"><p>">R" is a function word that "moves" the top data stack value onto the
\r
2219 return stack.</p></div>
\r
2220 <div style="text-align:center">
\r
2221 _______________________________________________________
\r
2223 <div class="paragraph"><p><a id="p_here"></a></p></div>
\r
2225 <div class="sect2">
\r
2226 <h3 id="_word_here">Word: HERE</h3>
\r
2227 <div class="literalblock">
\r
2228 <div class="content">
\r
2229 <pre><code>Data stack: ( -- a )</code></pre>
\r
2231 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free
\r
2232 allocation space. It get updated by all words that allocate memory.</p></div>
\r
2233 <div class="exampleblock">
\r
2234 <div class="content">
\r
2235 <div class="sidebarblock">
\r
2236 <div class="content">
\r
2237 <div class="title">allocate 1024 bytes on the heap</div>
\r
2238 <div class="paragraph"><p>1024 HEAP @ + HEAP !</p></div>
\r
2241 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>
\r
2242 <div style="text-align:center">
\r
2243 _______________________________________________________
\r
2245 <div class="paragraph"><p><a id="p_hex"></a></p></div>
\r
2247 <div class="sect2">
\r
2248 <h3 id="_word_hex">Word: HEX</h3>
\r
2249 <div class="literalblock">
\r
2250 <div class="content">
\r
2251 <pre><code>Data stack: ( -- )</code></pre>
\r
2253 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses
\r
2254 letters a-f as additional digits. (Uppercase letter are also accepted
\r
2255 on input).</p></div>
\r
2256 <div class="exampleblock">
\r
2257 <div class="content">
\r
2258 <div class="sidebarblock">
\r
2259 <div class="content">
\r
2260 <div class="title">Definition concept for HEX</div>
\r
2261 <div class="paragraph"><p>: HEX 16 BASE ! ;</p></div>
\r
2264 <div style="text-align:center">
\r
2265 _______________________________________________________
\r
2267 <div class="paragraph"><p><a id="p_if"></a></p></div>
\r
2269 <div class="sect2">
\r
2270 <h3 id="_word_if">Word: IF</h3>
\r
2271 <div class="literalblock">
\r
2272 <div class="content">
\r
2273 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2275 <div class="paragraph"><p>"IF" is an immediate function word that is used together with
\r
2276 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2277 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction
\r
2278 with an unresolved branch offset, and places the address for resolving
\r
2279 this instruction on the datastack. This address will then be resolved
\r
2280 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so
\r
2281 that at execution time there is an appropriate conditional branch past
\r
2282 the "then-part" of the "structured statement".</p></div>
\r
2283 <div style="text-align:center">
\r
2284 _______________________________________________________
\r
2286 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>
\r
2288 <div class="sect2">
\r
2289 <h3 id="_word_ifagain">Word: IFAGAIN</h3>
\r
2290 <div class="literalblock">
\r
2291 <div class="content">
\r
2292 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2294 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with
\r
2295 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement
\r
2296 structured execution control. IFAGAIN scans the datastack for the
\r
2297 nearest preceding BEGIN marker and lays out a branch from this point
\r
2298 the beginning of the block during execution.</p></div>
\r
2299 <div style="text-align:center">
\r
2300 _______________________________________________________
\r
2302 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>
\r
2304 <div class="sect2">
\r
2305 <h3 id="_word_ifbreak">Word: IFBREAK</h3>
\r
2306 <div class="literalblock">
\r
2307 <div class="content">
\r
2308 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2310 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with
\r
2311 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
2312 implement structured execution control. IFBREAK simply places the
\r
2313 address for resolving branches from this point the end of the block
\r
2314 during execution.</p></div>
\r
2315 <div style="text-align:center">
\r
2316 _______________________________________________________
\r
2318 <div class="paragraph"><p><a id="p_immediate"></a></p></div>
\r
2320 <div class="sect2">
\r
2321 <h3 id="_word_immediate">Word: IMMEDIATE</h3>
\r
2322 <div class="literalblock">
\r
2323 <div class="content">
\r
2324 <pre><code>Data stack: ( -- )</code></pre>
\r
2326 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of
\r
2327 the most recent word to 1, thereby making that word an immediate word.</p></div>
\r
2328 <div class="exampleblock">
\r
2329 <div class="content">
\r
2330 <div class="sidebarblock">
\r
2331 <div class="content">
\r
2332 <div class="title">Definition concept for IMMEDIATE</div>
\r
2333 <div class="paragraph"><p>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</p></div>
\r
2336 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
2337 <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
2338 <div style="text-align:center">
\r
2339 _______________________________________________________
\r
2341 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>
\r
2343 <div class="sect2">
\r
2344 <h3 id="_word_10">Word: [</h3>
\r
2345 <div class="literalblock">
\r
2346 <div class="content">
\r
2347 <pre><code>Data stack: ( -- )</code></pre>
\r
2349 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation
\r
2350 mode to be intepreting. In this mode, words are executed immediately
\r
2351 after parsing, by invoking their "doer".</p></div>
\r
2352 <div class="exampleblock">
\r
2353 <div class="content">
\r
2354 <div class="sidebarblock">
\r
2355 <div class="content">
\r
2356 <div class="title">Definition concept for [</div>
\r
2357 <div class="paragraph"><p>: [ IMMEDIATE 0 STATE ! ;</p></div>
\r
2360 <div style="text-align:center">
\r
2361 _______________________________________________________
\r
2363 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>
\r
2365 <div class="sect2">
\r
2366 <h3 id="_word_lt">Word: <=</h3>
\r
2367 <div class="literalblock">
\r
2368 <div class="content">
\r
2369 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2371 <div class="paragraph"><p>"<=" is a function word that replaces a pair of values with -1 if the
\r
2372 first, v1, is less than or equal to the second, v1, otherwise 0. To
\r
2373 that end, the values are 64-bit signed integers.</p></div>
\r
2374 <div style="text-align:center">
\r
2375 _______________________________________________________
\r
2377 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>
\r
2379 <div class="sect2">
\r
2380 <h3 id="_word_lt_2">Word: <</h3>
\r
2381 <div class="literalblock">
\r
2382 <div class="content">
\r
2383 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2385 <div class="paragraph"><p>"<" is a function word that replaces a pair of values with -1 if the
\r
2386 first, v1, is less than the second, v1, otherwise 0. To that end, the
\r
2387 values are 64-bit signed integers.</p></div>
\r
2388 <div style="text-align:center">
\r
2389 _______________________________________________________
\r
2391 <div class="paragraph"><p><a id="p_literal"></a></p></div>
\r
2393 <div class="sect2">
\r
2394 <h3 id="_word_lit">Word: LIT</h3>
\r
2395 <div class="literalblock">
\r
2396 <div class="content">
\r
2397 <pre><code>Data stack: ( -- v )</code></pre>
\r
2399 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves
\r
2400 excution past that. The literal value is thus layed out as if a
\r
2401 subsequent CFA pointer in the containing definition, and the LIT
\r
2402 execution will make the execution skip past that and instead contine
\r
2403 with the CFA pointer following the value.</p></div>
\r
2404 <div class="paragraph"><p>It’s not a good idea to use "LIT" interactively.</p></div>
\r
2405 <div class="exampleblock">
\r
2406 <div class="content">
\r
2407 <div class="sidebarblock">
\r
2408 <div class="content">
\r
2409 <div class="title">Definition concept for LIT</div>
\r
2410 <div class="paragraph"><p>: LIT R> DUP 8 + >R @ ;</p></div>
\r
2413 <div style="text-align:center">
\r
2414 _______________________________________________________
\r
2416 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>
\r
2418 <div class="sect2">
\r
2419 <h3 id="_word_s">Word: S"</h3>
\r
2420 <div class="literalblock">
\r
2421 <div class="content">
\r
2422 <pre><code>Data stack: ( -- chars* n )</code></pre>
\r
2424 <div class="paragraph"><p>"S"" is a function word that pushes the [n:char] pointer for a string
\r
2425 inlined subsequently to it in the containing definition. This is
\r
2426 similar to <a href="#p_lit">LIT</a> but for a string literal.</p></div>
\r
2427 <div class="exampleblock">
\r
2428 <div class="content">
\r
2429 <div class="sidebarblock">
\r
2430 <div class="content">
\r
2431 <div class="title">Definition concept for LIT</div>
\r
2432 <div class="paragraph"><p>: LIT R> DUP @ 2DUP + 8 + >R SWAP 8 + SWAP ;</p></div>
\r
2435 <div style="text-align:center">
\r
2436 _______________________________________________________
\r
2438 <div class="paragraph"><p><a id="p_load_file_quote"></a></p></div>
\r
2440 <div class="sect2">
\r
2441 <h3 id="_word_load_file">Word: LOAD-FILE"</h3>
\r
2442 <div class="literalblock">
\r
2443 <div class="content">
\r
2444 <pre><code>data stack: ( "name" -- )</code></pre>
\r
2446 <div class="paragraph"><p>"LOAD-FILE"" is a function word that opens a file via
\r
2447 <a href="#p_open_file_quote">OPEN-FILE"</a>, allocates a stream buffer of 15000
\r
2448 bytes for reading it, saves the stream pointer as value for the newly
\r
2449 created filename variable, and then it invokes
\r
2450 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing the file.</p></div>
\r
2451 <div style="text-align:center">
\r
2452 _______________________________________________________
\r
2454 <div class="paragraph"><p><a id="p_lparen"></a></p></div>
\r
2456 <div class="sect2">
\r
2457 <h3 id="_word_11">Word: (</h3>
\r
2458 <div class="literalblock">
\r
2459 <div class="content">
\r
2460 <pre><code>Data stack: ( -- )</code></pre>
\r
2462 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words
\r
2463 until the next right parenthesis, or the end of the stream. This is
\r
2464 used for comments in RRQFORTH code.</p></div>
\r
2465 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have
\r
2466 whitespace before and after it.</p></div>
\r
2467 <div style="text-align:center">
\r
2468 _______________________________________________________
\r
2470 <div class="paragraph"><p><a id="p_malloc"></a></p></div>
\r
2472 <div class="sect2">
\r
2473 <h3 id="_word_malloc">Word: MALLOC</h3>
\r
2474 <div class="literalblock">
\r
2475 <div class="content">
\r
2476 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2478 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n
\r
2479 bytes and returns the lowest address of the allocated block.</p></div>
\r
2480 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2481 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2482 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC
\r
2483 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man
\r
2484 page" of mmap for details.</p></div>
\r
2485 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>
\r
2486 <div style="text-align:center">
\r
2487 _______________________________________________________
\r
2489 <div class="paragraph"><p><a id="p_minus"></a></p></div>
\r
2491 <div class="sect2">
\r
2492 <h3 id="_word_12">Word: -</h3>
\r
2493 <div class="literalblock">
\r
2494 <div class="content">
\r
2495 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2497 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the
\r
2498 result of reducing the first, v1, with the second, v2. To that end,
\r
2499 the values are 64-bit signed integers.</p></div>
\r
2500 <div style="text-align:center">
\r
2501 _______________________________________________________
\r
2503 <div class="paragraph"><p><a id="p_mult"></a></p></div>
\r
2505 <div class="sect2">
\r
2506 <h3 id="_word_13">Word: *</h3>
\r
2507 <div class="literalblock">
\r
2508 <div class="content">
\r
2509 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2511 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result
\r
2512 of multiplying them. To that end, the values are 64-bit signed
\r
2513 integers, and clipping the result to the least signifcant 64 bits.</p></div>
\r
2514 <div style="text-align:center">
\r
2515 _______________________________________________________
\r
2517 <div class="paragraph"><p><a id="p_negate"></a></p></div>
\r
2519 <div class="sect2">
\r
2520 <h3 id="_word_negate">Word: NEGATE</h3>
\r
2521 <div class="literalblock">
\r
2522 <div class="content">
\r
2523 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2525 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its
\r
2526 2’s-complement negation. To that end, the values are 64-bit signed
\r
2527 integers.</p></div>
\r
2528 <div style="text-align:center">
\r
2529 _______________________________________________________
\r
2531 <div class="paragraph"><p><a id="p_nip"></a></p></div>
\r
2533 <div class="sect2">
\r
2534 <h3 id="_word_nip">Word: NIP</h3>
\r
2535 <div class="literalblock">
\r
2536 <div class="content">
\r
2537 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>
\r
2539 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells
\r
2540 on the data stack.</p></div>
\r
2541 <div class="exampleblock">
\r
2542 <div class="content">
\r
2543 <div class="sidebarblock">
\r
2544 <div class="content">
\r
2545 <div class="title">Definition concept for NIP</div>
\r
2546 <div class="paragraph"><p>: NIP SWAP DROP ;</p></div>
\r
2549 <div style="text-align:center">
\r
2550 _______________________________________________________
\r
2552 <div class="paragraph"><p><a id="p_nl"></a></p></div>
\r
2554 <div class="sect2">
\r
2555 <h3 id="_word_nl">Word: NL</h3>
\r
2556 <div class="literalblock">
\r
2557 <div class="content">
\r
2558 <pre><code>Data stack: ( -- v )</code></pre>
\r
2560 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>
\r
2561 <div style="text-align:center">
\r
2562 _______________________________________________________
\r
2564 <div class="paragraph"><p><a id="p_not"></a></p></div>
\r
2566 <div class="sect2">
\r
2567 <h3 id="_word_not">Word: NOT</h3>
\r
2568 <div class="literalblock">
\r
2569 <div class="content">
\r
2570 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2572 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise
\r
2573 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>
\r
2574 <div class="paragraph"><p>Compare with <<p_0equal,0⇒>.</p></div>
\r
2575 <div style="text-align:center">
\r
2576 _______________________________________________________
\r
2578 <div class="paragraph"><p><a id="p_number"></a></p></div>
\r
2580 <div class="sect2">
\r
2581 <h3 id="_word_number">Word: NUMBER</h3>
\r
2582 <div class="literalblock">
\r
2583 <div class="content">
\r
2584 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>
\r
2586 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using
\r
2587 <a href="#p_base">BASE</a> as numerical base, then returns the result number and
\r
2588 a 1 on top, or just a 0 if the word didn’t parse.</p></div>
\r
2589 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in
\r
2590 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>
\r
2591 base, letters a-f or A-F for values 10-15. I.e. the normal positive or
\r
2592 negative decimal integers or normal (positive only) hexadecimal
\r
2593 integers.</p></div>
\r
2594 <div style="text-align:center">
\r
2595 _______________________________________________________
\r
2597 <div class="paragraph"><p><a id="p_open_file_quote"></a></p></div>
\r
2599 <div class="sect2">
\r
2600 <h3 id="_word_open_file">Word: OPEN-FILE"</h3>
\r
2601 <div class="literalblock">
\r
2602 <div class="content">
\r
2603 <pre><code>Data stack: ( "name" -- fd )</code></pre>
\r
2605 <div class="paragraph"><p>"OPEN-FILE"" is a function word that reads the intputstream for a
\r
2606 filename, adds that to the dictionary as a no-content variable, opens
\r
2607 that file and returns the input file descriptor.</p></div>
\r
2608 <div style="text-align:center">
\r
2609 _______________________________________________________
\r
2611 <div class="paragraph"><p><a id="p_or"></a></p></div>
\r
2613 <div class="sect2">
\r
2614 <h3 id="_word_or">Word: OR</h3>
\r
2615 <div class="literalblock">
\r
2616 <div class="content">
\r
2617 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2619 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise
\r
2620 disjunction; each bit is 1 if the corresponding bits of any operand
\r
2621 is 1 and 0 if not.</p></div>
\r
2622 <div style="text-align:center">
\r
2623 _______________________________________________________
\r
2625 <div class="paragraph"><p><a id="p_over"></a></p></div>
\r
2627 <div class="sect2">
\r
2628 <h3 id="_word_over">Word: OVER</h3>
\r
2629 <div class="literalblock">
\r
2630 <div class="content">
\r
2631 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>
\r
2633 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on
\r
2634 the data stack.</p></div>
\r
2635 <div style="text-align:center">
\r
2636 _______________________________________________________
\r
2638 <div class="paragraph"><p><a id="p_pad"></a></p></div>
\r
2640 <div class="sect2">
\r
2641 <h3 id="_word_pad">Word: PAD</h3>
\r
2642 <div class="literalblock">
\r
2643 <div class="content">
\r
2644 <pre><code>Data stack: ( -- a )</code></pre>
\r
2646 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by
\r
2647 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>
\r
2648 <div style="text-align:center">
\r
2649 _______________________________________________________
\r
2651 <div class="paragraph"><p><a id="p_pick"></a></p></div>
\r
2653 <div class="sect2">
\r
2654 <h3 id="_word_pick">Word: PICK</h3>
\r
2655 <div class="literalblock">
\r
2656 <div class="content">
\r
2657 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>
\r
2659 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down
\r
2660 from top onto the data stack. 0 indicates the top cell making it the
\r
2661 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it
\r
2662 the same as <a href="#p_over">OVER</a>.</p></div>
\r
2663 <div style="text-align:center">
\r
2664 _______________________________________________________
\r
2666 <div class="paragraph"><p><a id="p_plus"></a></p></div>
\r
2668 <div class="sect2">
\r
2669 <h3 id="_word_43">Word: +</h3>
\r
2670 <div class="literalblock">
\r
2671 <div class="content">
\r
2672 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2674 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the
\r
2675 result of adding them. To that end, the values are 64-bit signed
\r
2676 integers.</p></div>
\r
2677 <div style="text-align:center">
\r
2678 _______________________________________________________
\r
2680 <div class="paragraph"><p><a id="p_program_version"></a></p></div>
\r
2682 <div class="sect2">
\r
2683 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>
\r
2684 <div class="literalblock">
\r
2685 <div class="content">
\r
2686 <pre><code>Data stack: ( -- char* length )</code></pre>
\r
2688 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>
\r
2689 <div style="text-align:center">
\r
2690 _______________________________________________________
\r
2692 <div class="paragraph"><p><a id="p_put"></a></p></div>
\r
2694 <div class="sect2">
\r
2695 <h3 id="_word_14">Word: !</h3>
\r
2696 <div class="literalblock">
\r
2697 <div class="content">
\r
2698 <pre><code>Data stack: ( v a -- )</code></pre>
\r
2700 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>
\r
2701 <div style="text-align:center">
\r
2702 _______________________________________________________
\r
2704 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>
\r
2706 <div class="sect2">
\r
2707 <h3 id="_word_15">Word: !+</h3>
\r
2708 <div class="literalblock">
\r
2709 <div class="content">
\r
2710 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2712 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>
\r
2713 <div class="exampleblock">
\r
2714 <div class="content">
\r
2715 <div class="sidebarblock">
\r
2716 <div class="content">
\r
2717 <div class="title">definition concept for !+</div>
\r
2718 <div class="paragraph"><p>( a n — ) : !+ OVER @ + SWAP ! ;</p></div>
\r
2721 <div style="text-align:center">
\r
2722 _______________________________________________________
\r
2724 <div class="paragraph"><p><a id="p_quit"></a></p></div>
\r
2726 <div class="sect2">
\r
2727 <h3 id="_word_quit">Word: QUIT</h3>
\r
2728 <div class="literalblock">
\r
2729 <div class="content">
\r
2730 <pre><code>Data stack: ??</code></pre>
\r
2732 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of
\r
2733 RRQFORTH. First it resets the stacks to their original settings, and
\r
2734 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and
\r
2735 executing them.</p></div>
\r
2736 <div style="text-align:center">
\r
2737 _______________________________________________________
\r
2739 <div class="paragraph"><p><a id="p_quote"></a></p></div>
\r
2741 <div class="sect2">
\r
2742 <h3 id="_word_16">Word: '</h3>
\r
2743 <div class="literalblock">
\r
2744 <div class="content">
\r
2745 <pre><code>data stack: ( -- cfa ) Input stream: word</code></pre>
\r
2747 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next
\r
2748 word on the input stream and pushes its cfa.</p></div>
\r
2749 <div style="text-align:center">
\r
2750 _______________________________________________________
\r
2752 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>
\r
2754 <div class="sect2">
\r
2755 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>
\r
2756 <div class="literalblock">
\r
2757 <div class="content">
\r
2758 <pre><code>Data stack: ( stream -- c )</code></pre>
\r
2760 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character
\r
2761 from the given stream buffer, possibly refilling the buffer if it is
\r
2762 backed by a file descriptor. The refill is done by a SYS_READ call
\r
2763 when more characters are needed. The next character is pushed on the
\r
2764 stack, unless the stream is exhausted in which case the -1 is pushed
\r
2765 instead.</p></div>
\r
2766 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>
\r
2767 <div style="text-align:center">
\r
2768 _______________________________________________________
\r
2770 <div class="paragraph"><p><a id="p_read_word"></a></p></div>
\r
2772 <div class="sect2">
\r
2773 <h3 id="_word_read_word">Word: READ-WORD</h3>
\r
2774 <div class="literalblock">
\r
2775 <div class="content">
\r
2776 <pre><code>Data stack: ( stream -- char* n )</code></pre>
\r
2778 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace
\r
2779 separated word from the given stream and returns the [n:char*] duoble
\r
2780 cell pointer for it. The characters of the word are copied to
\r
2781 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>
\r
2782 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>
\r
2783 <div style="text-align:center">
\r
2784 _______________________________________________________
\r
2786 <div class="paragraph"><p><a id="p_realloc"></a></p></div>
\r
2788 <div class="sect2">
\r
2789 <h3 id="_word_realloc">Word: REALLOC</h3>
\r
2790 <div class="literalblock">
\r
2791 <div class="content">
\r
2792 <pre><code>Data stack: ( a m n -- a )</code></pre>
\r
2794 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a
\r
2795 of size m to be size n bytes and returns the lowest address of the
\r
2796 allocated block.</p></div>
\r
2797 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2798 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2799 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>
\r
2800 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>
\r
2801 <div style="text-align:center">
\r
2802 _______________________________________________________
\r
2804 <div class="paragraph"><p>compile.asm: WORD p_right_bracket,<em>]</em>,fasm</p></div>
\r
2805 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>
\r
2807 <div class="sect2">
\r
2808 <h3 id="_word_17">Word: ]</h3>
\r
2809 <div class="literalblock">
\r
2810 <div class="content">
\r
2811 <pre><code>Data stack: ( -- )</code></pre>
\r
2813 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation
\r
2814 mode to be compiling. In this mode words parsed into CFA pointers
\r
2815 which are placed on the heap in the given order, unless the word is
\r
2816 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An
\r
2817 immediate word is executed immediately, and a number is parsed and
\r
2818 left on the stack.</p></div>
\r
2819 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the
\r
2820 wordlist; i.e., the word list may contain definitions for numbers.</p></div>
\r
2821 <div class="exampleblock">
\r
2822 <div class="content">
\r
2823 <div class="sidebarblock">
\r
2824 <div class="content">
\r
2825 <div class="title">Definition concept for ]</div>
\r
2826 <div class="paragraph"><p>: ] 1 STATE ! ;</p></div>
\r
2829 <div style="text-align:center">
\r
2830 _______________________________________________________
\r
2832 <div class="paragraph"><p><a id="p_roll"></a></p></div>
\r
2834 <div class="sect2">
\r
2835 <h3 id="_word_roll">Word: ROLL</h3>
\r
2836 <div class="literalblock">
\r
2837 <div class="content">
\r
2838 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>
\r
2840 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down
\r
2841 from top onto the data stack while discarding it. 0 indicates the top
\r
2842 cell; 1 indicates the second top cell making it the same as
\r
2843 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as
\r
2844 <a href="#p_rot">ROT</a>.</p></div>
\r
2845 <div style="text-align:center">
\r
2846 _______________________________________________________
\r
2848 <div class="paragraph"><p><a id="p_rot"></a></p></div>
\r
2850 <div class="sect2">
\r
2851 <h3 id="_word_rot">Word: ROT</h3>
\r
2852 <div class="literalblock">
\r
2853 <div class="content">
\r
2854 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>
\r
2856 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells
\r
2857 such that the third becomes the first while the second becomes third
\r
2858 and the first becomes the second.</p></div>
\r
2859 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>
\r
2860 <div style="text-align:center">
\r
2861 _______________________________________________________
\r
2863 <div class="paragraph"><p><a id="p_rsp"></a></p></div>
\r
2865 <div class="sect2">
\r
2866 <h3 id="_word_r_n">Word: R[n]</h3>
\r
2867 <div class="literalblock">
\r
2868 <div class="content">
\r
2869 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2871 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell on
\r
2872 the top return stack value onto the data stack.</p></div>
\r
2873 <div style="text-align:center">
\r
2874 _______________________________________________________
\r
2876 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>
\r
2878 <div class="sect2">
\r
2879 <h3 id="_word_18">Word: ;</h3>
\r
2880 <div class="literalblock">
\r
2881 <div class="content">
\r
2882 <pre><code>Data stack: ( -- )</code></pre>
\r
2884 <div class="paragraph"><p>";" (semi-colon) is a function word that ends a new forth definition
\r
2885 by means of adding an <a href="#p_exit">EXIT</a></p></div>
\r
2886 <div class="exampleblock">
\r
2887 <div class="content">
\r
2888 <div class="sidebarblock">
\r
2889 <div class="content">
\r
2890 <div class="title">Definition concept for ;</div>
\r
2891 <div class="paragraph"><p>: ; IMMEDIATE ' EXIT , ;</p></div>
\r
2894 <div style="text-align:center">
\r
2895 _______________________________________________________
\r
2897 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>
\r
2899 <div class="sect2">
\r
2900 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>
\r
2901 <div class="literalblock">
\r
2902 <div class="content">
\r
2903 <pre><code>Data stack: ( -- a )</code></pre>
\r
2905 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code
\r
2906 sniippet for setting up the signal handling. rrqforth handles SEGV by
\r
2907 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>
\r
2908 <div style="text-align:center">
\r
2909 _______________________________________________________
\r
2911 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>
\r
2913 <div class="sect2">
\r
2914 <h3 id="_word_lt_lt">Word: <<</h3>
\r
2915 <div class="literalblock">
\r
2916 <div class="content">
\r
2917 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2919 <div class="paragraph"><p>"<<" is a function word that shifts value v1 n steps left (i.e.
\r
2920 "moving" bits towards more significant bits) to form value v2.</p></div>
\r
2921 <div style="text-align:center">
\r
2922 _______________________________________________________
\r
2924 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>
\r
2926 <div class="sect2">
\r
2927 <h3 id="_word_gt_gt">Word: >></h3>
\r
2928 <div class="literalblock">
\r
2929 <div class="content">
\r
2930 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2932 <div class="paragraph"><p>">>" is a function word that shifts value v1 n steps right (i.e.
\r
2933 "moving" bits towards less significant bits) to form value v2.</p></div>
\r
2934 <div style="text-align:center">
\r
2935 _______________________________________________________
\r
2937 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>
\r
2939 <div class="sect2">
\r
2940 <h3 id="_word_s_gt_gt">Word: s>></h3>
\r
2941 <div class="literalblock">
\r
2942 <div class="content">
\r
2943 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2945 <div class="paragraph"><p>"s>>" is a function word that shifts value v1 n steps right (i.e.
\r
2946 "moving" bits towards less significant bits) to form value v2, but
\r
2947 preserving (and copying) the sign bit.</p></div>
\r
2948 <div style="text-align:center">
\r
2949 _______________________________________________________
\r
2951 <div class="paragraph"><p><a id="p_sp"></a></p></div>
\r
2953 <div class="sect2">
\r
2954 <h3 id="_word_sp">Word: SP</h3>
\r
2955 <div class="literalblock">
\r
2956 <div class="content">
\r
2957 <pre><code>Data stack: ( -- v )</code></pre>
\r
2959 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>
\r
2960 <div style="text-align:center">
\r
2961 _______________________________________________________
\r
2963 <div class="paragraph"><p><a id="p_state"></a></p></div>
\r
2965 <div class="sect2">
\r
2966 <h3 id="_word_state">Word: STATE</h3>
\r
2967 <div class="literalblock">
\r
2968 <div class="content">
\r
2969 <pre><code>Data stack: ( -- a )</code></pre>
\r
2971 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in
\r
2972 compiling mode (1) or interpreting (0) mode.</p></div>
\r
2973 <div style="text-align:center">
\r
2974 _______________________________________________________
\r
2976 <div class="paragraph"><p><a id="p_stdin"></a></p></div>
\r
2978 <div class="sect2">
\r
2979 <h3 id="_word_stdin">Word: STDIN</h3>
\r
2980 <div class="literalblock">
\r
2981 <div class="content">
\r
2982 <pre><code>Data stack: ( -- stream )</code></pre>
\r
2984 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the
\r
2985 standard input file descriptor.</p></div>
\r
2986 <div style="text-align:center">
\r
2987 _______________________________________________________
\r
2989 <div class="paragraph"><p><a id="p_stream"></a></p></div>
\r
2991 <div class="sect2">
\r
2992 <h3 id="_word_stream">Word: STREAM</h3>
\r
2993 <div class="literalblock">
\r
2994 <div class="content">
\r
2995 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>
\r
2997 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file
\r
2998 descriptor or for a memory block (of size+data).</p></div>
\r
2999 <div class="sect3">
\r
3000 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>
\r
3001 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size
\r
3002 prefixed by a 32 byte STREAM header of the following layout:</p></div>
\r
3003 <div class="exampleblock">
\r
3004 <div class="content">
\r
3005 <div class="listingblock">
\r
3006 <div class="title">Layout 3: file descriptor stream</div>
\r
3007 <div class="content">
\r
3008 <pre><code> 8 bytes = size of buffer (excluding the 32 byte header)
\r
3009 8 bytes source file descriptor
\r
3010 8 bytes current fill
\r
3011 8 current read position</code></pre>
\r
3015 <div class="sect3">
\r
3016 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>
\r
3017 <div class="paragraph"><p>A memory block stream is only the header (though allocated via
\r
3018 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the
\r
3019 following layout:</p></div>
\r
3020 <div class="exampleblock">
\r
3021 <div class="content">
\r
3022 <div class="listingblock">
\r
3023 <div class="title">Layout 4: memory block stream</div>
\r
3024 <div class="content">
\r
3025 <pre><code> 8 bytes = block address
\r
3026 8 -1 (indicates memory block)
\r
3027 8 size of block (taken from the block's first 8 bytes)
\r
3028 8 current read position</code></pre>
\r
3031 <div style="text-align:center">
\r
3032 _______________________________________________________
\r
3034 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>
\r
3037 <div class="sect2">
\r
3038 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>
\r
3039 <div class="literalblock">
\r
3040 <div class="content">
\r
3041 <pre><code>Data stack: ( stream -- n )</code></pre>
\r
3043 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream
\r
3044 buffer for the next non-whitespace character, and returns its position
\r
3045 relative to the end of the buffer. This is done without changing the
\r
3046 stream (or filling it by reading the backing file).</p></div>
\r
3047 <div style="text-align:center">
\r
3048 _______________________________________________________
\r
3050 <div class="paragraph"><p><a id="p_strlen"></a></p></div>
\r
3052 <div class="sect2">
\r
3053 <h3 id="_word_strlen">Word: STRLEN</h3>
\r
3054 <div class="literalblock">
\r
3055 <div class="content">
\r
3056 <pre><code>Data stack: ( s -- n )</code></pre>
\r
3058 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from
\r
3059 s to the first NUL byte and returns that count, n, not including the
\r
3060 NUL byte.</p></div>
\r
3061 <div style="text-align:center">
\r
3062 _______________________________________________________
\r
3064 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>
\r
3066 <div class="sect2">
\r
3067 <h3 id="_word_strncmp">Word: STRNCMP</h3>
\r
3068 <div class="literalblock">
\r
3069 <div class="content">
\r
3070 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>
\r
3072 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of
\r
3073 character sequences s1 and s2, and returns the difference of the first
\r
3074 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters
\r
3075 are the same.</p></div>
\r
3076 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically
\r
3078 v is greater than 0 if [n:s1] is greater than [n:s2],
\r
3079 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>
\r
3080 <div style="text-align:center">
\r
3081 _______________________________________________________
\r
3083 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>
\r
3085 <div class="sect2">
\r
3086 <h3 id="_word_strncpy">Word: STRNCPY</h3>
\r
3087 <div class="literalblock">
\r
3088 <div class="content">
\r
3089 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>
\r
3091 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1
\r
3093 <div style="text-align:center">
\r
3094 _______________________________________________________
\r
3096 <div class="paragraph"><p><a id="p_swap"></a></p></div>
\r
3098 <div class="sect2">
\r
3099 <h3 id="_word_swap">Word: SWAP</h3>
\r
3100 <div class="literalblock">
\r
3101 <div class="content">
\r
3102 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>
\r
3104 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>
\r
3105 <div style="text-align:center">
\r
3106 _______________________________________________________
\r
3108 <div class="paragraph"><p><a id="p_system"></a></p></div>
\r
3110 <div class="sect2">
\r
3111 <h3 id="_word_system">Word: SYSTEM</h3>
\r
3112 <div class="literalblock">
\r
3113 <div class="content">
\r
3114 <pre><code>Data value: ( -- a )</code></pre>
\r
3116 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system
\r
3117 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>
\r
3118 merely as a matter of segregation.</p></div>
\r
3119 <div style="text-align:center">
\r
3120 _______________________________________________________
\r
3122 <div class="paragraph"><p><a id="p_tell"></a></p></div>
\r
3124 <div class="sect2">
\r
3125 <h3 id="_word_tell">Word: TELL</h3>
\r
3126 <div class="literalblock">
\r
3127 <div class="content">
\r
3128 <pre><code>Data stack: ( char* n -- )</code></pre>
\r
3130 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file
\r
3131 descriptor 1).</p></div>
\r
3132 <div style="text-align:center">
\r
3133 _______________________________________________________
\r
3135 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>
\r
3137 <div class="sect2">
\r
3138 <h3 id="_word_terminate0">Word: TERMINATE0</h3>
\r
3139 <div class="literalblock">
\r
3140 <div class="content">
\r
3141 <pre><code>Data stack: ( -- )</code></pre>
\r
3143 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit
\r
3145 <div style="text-align:center">
\r
3146 _______________________________________________________
\r
3148 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>
\r
3150 <div class="sect2">
\r
3151 <h3 id="_word_tfa_gt_cfa">Word: TFA>CFA</h3>
\r
3152 <div class="literalblock">
\r
3153 <div class="content">
\r
3154 <pre><code>Data stack: ( tfa -- cfa )</code></pre>
\r
3156 <div class="paragraph"><p>"TFA>CFA" is a function word that pushes word cfa of the given tfa.</p></div>
\r
3157 <div class="exampleblock">
\r
3158 <div class="content">
\r
3159 <div class="sidebarblock">
\r
3160 <div class="content">
\r
3161 <div class="title">Definition concept for TFA>CFA</div>
\r
3162 <div class="paragraph"><p>: TFA>CFA 8 + @ ;</p></div>
\r
3165 <div style="text-align:center">
\r
3166 _______________________________________________________
\r
3168 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>
\r
3170 <div class="sect2">
\r
3171 <h3 id="_word_tfa_gt_dfa">Word: TFA>DFA</h3>
\r
3172 <div class="literalblock">
\r
3173 <div class="content">
\r
3174 <pre><code>Data stack: ( tfa -- dfa )</code></pre>
\r
3176 <div class="paragraph"><p>"TFA>DFA" is a function word that pushes word dfa of the given tfa.</p></div>
\r
3177 <div class="exampleblock">
\r
3178 <div class="content">
\r
3179 <div class="sidebarblock">
\r
3180 <div class="content">
\r
3181 <div class="title">Definition concept for TFA>DFA</div>
\r
3182 <div class="paragraph"><p>: TFA>DFA TFA>CFA 8 + ;</p></div>
\r
3185 <div style="text-align:center">
\r
3186 _______________________________________________________
\r
3188 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>
\r
3190 <div class="sect2">
\r
3191 <h3 id="_word_tfa_gt_flags">Word: TFA>FLAGS@</h3>
\r
3192 <div class="literalblock">
\r
3193 <div class="content">
\r
3194 <pre><code>Data stack: ( tfa -- flags )</code></pre>
\r
3196 <div class="paragraph"><p>"TFA>FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>
\r
3197 <div class="exampleblock">
\r
3198 <div class="content">
\r
3199 <div class="sidebarblock">
\r
3200 <div class="content">
\r
3201 <div class="title">Defintion concept for TFA>FLAGS@</div>
\r
3202 <div class="paragraph"><p>: TFA>FLAGS@ 16 + @ ;</p></div>
\r
3205 <div style="text-align:center">
\r
3206 _______________________________________________________
\r
3208 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>
\r
3210 <div class="sect2">
\r
3211 <h3 id="_word_tfa_gt_namez">Word: TFA>NAMEZ</h3>
\r
3212 <div class="literalblock">
\r
3213 <div class="content">
\r
3214 <pre><code>Data stack: ( tfa -- char* )</code></pre>
\r
3216 <div class="paragraph"><p>"TFA>NAMEZ" is a function word that pushes changes a tfa pointer to a
\r
3217 pointer to the word pname’s character sequence, which is zero
\r
3218 terminated as well as preceded by a length cell.</p></div>
\r
3219 <div class="exampleblock">
\r
3220 <div class="content">
\r
3221 <div class="sidebarblock">
\r
3222 <div class="content">
\r
3223 <div class="title">Defintion concept for TFA>NAMEZ</div>
\r
3224 <div class="paragraph"><p>: TFA>NAMEZ 32 + ;</p></div>
\r
3227 <div style="text-align:center">
\r
3228 _______________________________________________________
\r
3230 <div class="paragraph"><p><a id="p_then"></a></p></div>
\r
3232 <div class="sect2">
\r
3233 <h3 id="_word_then">Word: THEN</h3>
\r
3234 <div class="literalblock">
\r
3235 <div class="content">
\r
3236 <pre><code>Data stack: Compiling: ( a -- )</code></pre>
\r
3238 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with
\r
3239 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution
\r
3240 control. THEN performs the branch resolution for the stacked address
\r
3241 which pinpoints the foot address the branch offset to resolve, so that
\r
3242 at execution time there is an appropriate conditional branch past the
\r
3243 "then-part" or the "else-part" of the "structured statement".</p></div>
\r
3244 <div style="text-align:center">
\r
3245 _______________________________________________________
\r
3247 <div class="paragraph"><p><a id="p_this_word"></a></p></div>
\r
3249 <div class="sect2">
\r
3250 <h3 id="_word_this_word">Word: THIS-WORD</h3>
\r
3251 <div class="literalblock">
\r
3252 <div class="content">
\r
3253 <pre><code>Data stack: ( -- a )</code></pre>
\r
3255 <div class="paragraph"><p>"THIS-WORD" is a variable word used in
\r
3256 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]
\r
3257 values of the successive words being evaluated. This typically points
\r
3258 into the input stream buffer and remain valid until further stream
\r
3259 buffering functions are used.</p></div>
\r
3260 <div style="text-align:center">
\r
3261 _______________________________________________________
\r
3263 <div class="paragraph"><p><a id="p_true"></a></p></div>
\r
3265 <div class="sect2">
\r
3266 <h3 id="_word_true">Word: TRUE</h3>
\r
3267 <div class="literalblock">
\r
3268 <div class="content">
\r
3269 <pre><code>Data stack: ( -- -1 )</code></pre>
\r
3271 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>
\r
3272 <div style="text-align:center">
\r
3273 _______________________________________________________
\r
3275 <div class="paragraph"><p><a id="p_tuck"></a></p></div>
\r
3277 <div class="sect2">
\r
3278 <h3 id="_word_tuck">Word: TUCK</h3>
\r
3279 <div class="literalblock">
\r
3280 <div class="content">
\r
3281 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>
\r
3283 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second
\r
3284 cell on the data stack.</p></div>
\r
3285 <div class="exampleblock">
\r
3286 <div class="content">
\r
3287 <div class="sidebarblock">
\r
3288 <div class="content">
\r
3289 <div class="title">Definition concept for TUCK</div>
\r
3290 <div class="paragraph"><p>: TUCK SWAP OVER ;</p></div>
\r
3293 <div style="text-align:center">
\r
3294 _______________________________________________________
\r
3296 <div class="paragraph"><p><a id="p_unequal"></a></p></div>
\r
3298 <div class="sect2">
\r
3299 <h3 id="_word_19">Word: !=</h3>
\r
3300 <div class="literalblock">
\r
3301 <div class="content">
\r
3302 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
3304 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the
\r
3305 values are unequal, and 0 otherwise.</p></div>
\r
3306 <div style="text-align:center">
\r
3307 _______________________________________________________
\r
3309 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>
\r
3311 <div class="sect2">
\r
3312 <h3 id="_word_verbose">Word: VERBOSE?</h3>
\r
3313 <div class="literalblock">
\r
3314 <div class="content">
\r
3315 <pre><code>Data stack: ( -- a )</code></pre>
\r
3317 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0
\r
3318 signify whether or not the command line arguments includes "-v". When
\r
3319 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more
\r
3320 verbose.</p></div>
\r
3321 <div style="text-align:center">
\r
3322 _______________________________________________________
\r
3324 <div class="paragraph"><p><a id="p_within"></a></p></div>
\r
3326 <div class="sect2">
\r
3327 <h3 id="_word_within">Word: WITHIN</h3>
\r
3328 <div class="literalblock">
\r
3329 <div class="content">
\r
3330 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>
\r
3332 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1
\r
3333 of the the first, v, is within the value range spanned by the second,
\r
3334 lo, inclusive and third, hi, exclusive.</p></div>
\r
3335 <div class="exampleblock">
\r
3336 <div class="content">
\r
3337 <div class="sidebarblock">
\r
3338 <div class="content">
\r
3339 <div class="title">Definition concept for WITHIN</div>
\r
3340 <div class="paragraph"><p>: WITHIN 2 PICK > ROT ROT ⇐ AND ;</p></div>
\r
3343 <div style="text-align:center">
\r
3344 _______________________________________________________
\r
3346 <div class="paragraph"><p><a id="p_words"></a></p></div>
\r
3348 <div class="sect2">
\r
3349 <h3 id="_word_words">Word: WORDS</h3>
\r
3350 <div class="literalblock">
\r
3351 <div class="content">
\r
3352 <pre><code>Data stack: ( wl -- )</code></pre>
\r
3354 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word
\r
3355 list to stdout (file descriptor 1).</p></div>
\r
3356 <div style="text-align:center">
\r
3357 _______________________________________________________
\r
3359 <div class="paragraph"><p><a id="p_xor"></a></p></div>
\r
3361 <div class="sect2">
\r
3362 <h3 id="_word_xor">Word: XOR</h3>
\r
3363 <div class="literalblock">
\r
3364 <div class="content">
\r
3365 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
3367 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise
\r
3368 exclusion; each bit is 1 if the corresponding bits of the two operands
\r
3369 differ and 0 if not.</p></div>
\r
3370 <div style="text-align:center">
\r
3371 _______________________________________________________
\r
3373 <div class="paragraph"><p><a id="return_stack"></a></p></div>
\r
3375 <div class="sect2">
\r
3376 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>
\r
3377 <div class="literalblock">
\r
3378 <div class="content">
\r
3379 <pre><code>Data stack: ( -- a )</code></pre>
\r
3381 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>
\r
3385 <div class="sect1">
\r
3386 <h2 id="_system_calls">System calls</h2>
\r
3387 <div class="sectionbody">
\r
3388 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which
\r
3389 generally are described in their "man pages. This wrapping takes the
\r
3390 arguments fro the data stack in reverse order, i.e. the first argument
\r
3391 is deepest.</p></div>
\r
3392 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>
\r
3396 <div id="footnotes"><hr /></div>
\r
3398 <div id="footer-text">
\r
3400 2021-06-02 01:27:44 AEST
\r
projects / rrq / rrqforth.git / blob