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
1383 <div class="paragraph"><p>See also <a href="#p_branch">BRANCH</a>, <a href="#p_0branch">0BRANCH</a>,
\r
1384 <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>, <a href="#p_else">ELSE</a>,
\r
1385 <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1386 <div style="text-align:center">
\r
1387 _______________________________________________________
\r
1389 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>
\r
1391 <div class="sect2">
\r
1392 <h3 id="_word_calltrace">Word: [calltrace]</h3>
\r
1393 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly
\r
1394 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>
\r
1395 <div style="text-align:center">
\r
1396 _______________________________________________________
\r
1398 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>
\r
1400 <div class="sect2">
\r
1401 <h3 id="_word_cfa_gt_flags">Word: CFA>FLAGS@</h3>
\r
1402 <div class="literalblock">
\r
1403 <div class="content">
\r
1404 <pre><code>Data stack: ( cfa -- flags )</code></pre>
\r
1406 <div class="paragraph"><p>"CFA>FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>
\r
1407 <div class="exampleblock">
\r
1408 <div class="content">
\r
1409 <div class="sidebarblock">
\r
1410 <div class="content">
\r
1411 <div class="title">Defintion concept for CFA>FLAGS@</div>
\r
1412 <div class="paragraph"><p>: CFA>FLAGS@ 16 - @ 16 + ;</p></div>
\r
1415 <div style="text-align:center">
\r
1416 _______________________________________________________
\r
1418 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>
\r
1420 <div class="sect2">
\r
1421 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>
\r
1422 <div class="literalblock">
\r
1423 <div class="content">
\r
1424 <pre><code>Data stack: ( stream -- )</code></pre>
\r
1426 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently
\r
1427 remaining in the buffer for the stream, so that a subsequent read will
\r
1428 pull in more data from its source.</p></div>
\r
1429 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>
\r
1430 <div style="text-align:center">
\r
1431 _______________________________________________________
\r
1433 <div class="paragraph"><p><a id="p_colon"></a></p></div>
\r
1435 <div class="sect2">
\r
1436 <h3 id="_word_3">Word: :</h3>
\r
1437 <div class="literalblock">
\r
1438 <div class="content">
\r
1439 <pre><code>Data stack: ( -- ) Input stream: word</code></pre>
\r
1441 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.
\r
1442 This includes reading the next word for making a new dictionary entry
\r
1443 and setting evaluation state to compiling mode.</p></div>
\r
1444 <div class="exampleblock">
\r
1445 <div class="content">
\r
1446 <div class="sidebarblock">
\r
1447 <div class="content">
\r
1448 <div class="title">Definition concept for :</div>
\r
1449 <div class="paragraph"><p>: : doFORTH READ-WORD CREATE TFA>CFA ! ] ;</p></div>
\r
1452 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,
\r
1453 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA>CFA</a>, <a href="#p_put">!</a>,
\r
1454 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1455 <div style="text-align:center">
\r
1456 _______________________________________________________
\r
1458 <div class="paragraph"><p><a id="p_comma"></a></p></div>
\r
1460 <div class="sect2">
\r
1461 <h3 id="_word_4">Word: ,</h3>
\r
1462 <div class="literalblock">
\r
1463 <div class="content">
\r
1464 <pre><code>Data stack: ( v -- )</code></pre>
\r
1466 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the
\r
1467 <a href="#p_here">HERE</a> heap.</p></div>
\r
1468 <div class="exampleblock">
\r
1469 <div class="content">
\r
1470 <div class="sidebarblock">
\r
1471 <div class="content">
\r
1472 <div class="title">Definition concept for ,</div>
\r
1473 <div class="paragraph"><p>: , HERE @ 8 ALLOT ! ; ( v — ; Claim 8 bytes and put value there )</p></div>
\r
1476 <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
1477 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1478 <div style="text-align:center">
\r
1479 _______________________________________________________
\r
1481 <div class="paragraph"><p><a id="p_create"></a></p></div>
\r
1483 <div class="sect2">
\r
1484 <h3 id="_word_create">Word: CREATE</h3>
\r
1485 <div class="literalblock">
\r
1486 <div class="content">
\r
1487 <pre><code>Data stack: ( char* n -- tfa )</code></pre>
\r
1489 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the
\r
1490 indicated [n:char*] print name, and returns the "TFA" (Token Field
\r
1491 Address) of the word. The header memory layout is as follows:</p></div>
\r
1492 <div class="exampleblock">
\r
1493 <div class="content">
\r
1494 <div class="listingblock">
\r
1495 <div class="title">Layout 1: rrqforth word structure</div>
\r
1496 <div class="content">
\r
1497 <pre><code>struct WORD
\r
1498 TFA 8 link ; tfa of previous word
\r
1499 pCFA 8 cfap ; CFA = Code Field Address of this word
\r
1501 PFA 8 length ; length of pname representation
\r
1502 ? pname ; the pname bytes
\r
1503 1 nul ; a forced nul byte following the pname
\r
1504 pTFA 8 tfap ; TFA = Token Field Address of this word
\r
1505 OFF 8 doff ; entry offset for FORTH level execution
\r
1506 CFA 8 doer ; word execution semantics
\r
1507 DFA 0 content ; DFA = Data Field Address
\r
1508 end_struct</code></pre>
\r
1511 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content
\r
1512 as held in the memory space following the DFA (Data Field Address).</p></div>
\r
1513 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for
\r
1514 RRQFORTH execution, as holding a jump address to the assembly code
\r
1515 that implements the particular execution semantics for the word.
\r
1516 "CREATE" will assign this as "dovariable", which makes the word push
\r
1517 its DFA when executed. This is changed to "doforth" for RRQFORTH
\r
1518 function words initiated by ":" (aka "COLON") or changed to "dovalue"
\r
1519 for RRQFORTH constants created by "CONSTANT".</p></div>
\r
1520 <div class="exampleblock">
\r
1521 <div class="content">
\r
1522 <div class="sidebarblock">
\r
1523 <div class="content">
\r
1524 <div class="title">Definition concept for CREATE</div>
\r
1525 <div class="paragraph"><p>HERE @ R> ( save tfa on RS )
\r
1526 R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )
\r
1527 DUP 49 + R@ + , ( pCFA )
\r
1530 HERE @ ROT ROT MEMCPY 0 C, ( pname + NUL )
\r
1533 doVARIABLE ( CFA, default semantics )</p></div>
\r
1536 <div class="exampleblock">
\r
1537 <div class="content">
\r
1538 <div class="listingblock">
\r
1539 <div class="title">Usage example 5: a possible definition of CONSTANT</div>
\r
1540 <div class="content">
\r
1541 <pre><code>: CONSTANT READ-WORD CREATE TFA>DFA doVALUE OVER 8 - ! ! ;</code></pre>
\r
1544 <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
1545 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,
\r
1546 <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
1547 and <a href="#p_dovariable">doVARIABLE</a>,
\r
1548 as well as <a href="#p_execute">EXECUTE</a>
\r
1549 about the range of "doer" assignments and their meanings.</p></div>
\r
1550 <div style="text-align:center">
\r
1551 _______________________________________________________
\r
1553 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>
\r
1555 <div class="sect2">
\r
1556 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>
\r
1557 <div class="literalblock">
\r
1558 <div class="content">
\r
1559 <pre><code>Data stack: ( -- a )</code></pre>
\r
1561 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the
\r
1562 current word list word for <a href="#p_find">FIND</a> to use finding words. The
\r
1563 word list word content is as follows:</p></div>
\r
1564 <div class="exampleblock">
\r
1565 <div class="content">
\r
1566 <div class="listingblock">
\r
1567 <div class="title">Layout 2: word list word content</div>
\r
1568 <div class="content">
\r
1569 <pre><code> 8 TFA of latest word in the word list
\r
1570 8 DFA of the/a subsequent word list to search through</code></pre>
\r
1573 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends
\r
1574 with the <a href="#p_forth">FORTH</a> word list. Initially the
\r
1575 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>
\r
1576 <div style="text-align:center">
\r
1577 _______________________________________________________
\r
1579 <div class="paragraph"><p><a id="data_stack"></a></p></div>
\r
1581 <div class="sect2">
\r
1582 <h3 id="_word_data_stack">Word: DATA-STACK</h3>
\r
1583 <div class="literalblock">
\r
1584 <div class="content">
\r
1585 <pre><code>Data stack: ( -- a )</code></pre>
\r
1587 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>
\r
1588 <div style="text-align:center">
\r
1589 _______________________________________________________
\r
1591 <div class="paragraph"><p><a id="p_decimal"></a></p></div>
\r
1593 <div class="sect2">
\r
1594 <h3 id="_word_decimal">Word: DECIMAL</h3>
\r
1595 <div class="literalblock">
\r
1596 <div class="content">
\r
1597 <pre><code>Data stack: ( -- )</code></pre>
\r
1599 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>
\r
1600 <div class="exampleblock">
\r
1601 <div class="content">
\r
1602 <div class="sidebarblock">
\r
1603 <div class="content">
\r
1604 <div class="title">Definition concept for DECIMAL</div>
\r
1605 <div class="paragraph"><p>: DECIMAL 10 BASE ! ;</p></div>
\r
1608 <div style="text-align:center">
\r
1609 _______________________________________________________
\r
1611 <div class="paragraph"><p><a id="p_depth"></a></p></div>
\r
1613 <div class="sect2">
\r
1614 <h3 id="_word_depth">Word: DEPTH</h3>
\r
1615 <div class="literalblock">
\r
1616 <div class="content">
\r
1617 <pre><code>Data stack: ( -- v )</code></pre>
\r
1619 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells
\r
1620 onto the data stack.</p></div>
\r
1621 <div style="text-align:center">
\r
1622 _______________________________________________________
\r
1624 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>
\r
1626 <div class="sect2">
\r
1627 <h3 id="_word_dfa_gt_tfa">Word: DFA>TFA</h3>
\r
1628 <div class="literalblock">
\r
1629 <div class="content">
\r
1630 <pre><code>Data stack: ( dfa -- tfa )</code></pre>
\r
1632 <div class="paragraph"><p>"DFA>TFA" is a function word that pushes word tfa of the given dfa.</p></div>
\r
1633 <div class="exampleblock">
\r
1634 <div class="content">
\r
1635 <div class="sidebarblock">
\r
1636 <div class="content">
\r
1637 <div class="title">Definition concept for DFA>TFA</div>
\r
1638 <div class="paragraph"><p>: DFA>TFA 24 - @ ;</p></div>
\r
1641 <div style="text-align:center">
\r
1642 _______________________________________________________
\r
1644 <div class="paragraph"><p><a id="p_digits"></a></p></div>
\r
1646 <div class="sect2">
\r
1647 <h3 id="_word_digits">Word: DIGITS</h3>
\r
1648 <div class="literalblock">
\r
1649 <div class="content">
\r
1650 <pre><code>Data stack: ( -- a )</code></pre>
\r
1652 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping
\r
1653 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>
\r
1654 <div style="text-align:center">
\r
1655 _______________________________________________________
\r
1657 <div class="paragraph"><p><a id="p_div"></a></p></div>
\r
1659 <div class="sect2">
\r
1660 <h3 id="_word_5">Word: /</h3>
\r
1661 <div class="literalblock">
\r
1662 <div class="content">
\r
1663 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>
\r
1665 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the
\r
1666 results of signed integer division of the first, v1, divided by the
\r
1667 second, v2. To that end, the values are 64-bit signed integers. The
\r
1668 result is the integer quotient, q, and the discarded remainder, r,
\r
1669 where q and r are the respectively largest and smallest integers to
\r
1670 satisfy the formula:</p></div>
\r
1671 <div class="literalblock">
\r
1672 <div class="content">
\r
1673 <pre><code> v1 = q * v2 + r</code></pre>
\r
1675 <div style="text-align:center">
\r
1676 _______________________________________________________
\r
1678 <div class="paragraph"><p><a id="p_divmod"></a></p></div>
\r
1680 <div class="sect2">
\r
1681 <h3 id="_word_mod">Word: /MOD</h3>
\r
1682 <div class="literalblock">
\r
1683 <div class="content">
\r
1684 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>
\r
1686 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values
\r
1687 with the results of signed integer division of the first, v1, divided
\r
1688 by the second, v2. To that end, the values are 64-bit signed integers.
\r
1689 The result is the integer quotient, q, and the remainder, r, where q
\r
1690 and r are the respectively largest and smallest integers to satisfy
\r
1691 the formula:</p></div>
\r
1692 <div class="literalblock">
\r
1693 <div class="content">
\r
1694 <pre><code> v1 = q * v2 + r</code></pre>
\r
1696 <div style="text-align:center">
\r
1697 _______________________________________________________
\r
1699 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>
\r
1701 <div class="sect2">
\r
1702 <h3 id="_word_dodoes">Word: doDOES</h3>
\r
1703 <div class="literalblock">
\r
1704 <div class="content">
\r
1705 <pre><code>Data stack: ( -- a )</code></pre>
\r
1707 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the
\r
1708 <a href="#p_does">[p_does]</a> execution semantics. This is the same as
\r
1709 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word
\r
1710 concerned.</p></div>
\r
1711 <div style="text-align:center">
\r
1712 _______________________________________________________
\r
1714 <div class="paragraph"><p><a id="p_does"></a></p></div>
\r
1716 <div class="sect2">
\r
1717 <h3 id="_word_does_gt">WORD: DOES></h3>
\r
1718 <div class="literalblock">
\r
1719 <div class="content">
\r
1720 <pre><code>Data stack: ( -- )</code></pre>
\r
1722 <div class="paragraph"><p>"DOES>" is a function that in execution mode does nothing but in
\r
1723 compilation mode it changes the execution semantics assignments for
\r
1724 the most recent word to use the <code>dodoes</code> sematics with adjustment
\r
1725 offset to the current heap address. I.e., the word being defined will
\r
1726 have its execution start at whatever comes after "DOES>".</p></div>
\r
1727 <div class="exampleblock">
\r
1728 <div class="content">
\r
1729 <div class="sidebarblock">
\r
1730 <div class="content">
\r
1731 <div class="title">Defintion concept for DOES></div>
\r
1732 <div class="paragraph"><p>: DOES> IMMEDIATE
\r
1733 STATE @ != IF ( only for compilation mode )
\r
1734 CURRENT-WORDLIST @ @ TFA>CFA ( cfa of current word )
\r
1735 doDOES OVER ! ( set up doer )
\r
1736 HERE @ OVER 8 + - SWAP 8 - ! ( set up offset
\r
1741 <div class="paragraph"><p>See also
\r
1742 <a href="#p_put">!</a>,
\r
1743 <a href="#p_unequal">!⇒></a>,
\r
1744 <a href="#p_minus">→></a>,
\r
1745 <a href="#p_get">@</a>,
\r
1746 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
1747 <a href="#p_here">HERE</a>,
\r
1748 <a href="#p_if">IF</a>,
\r
1749 <a href="#p_immediate">IMMEDIATE</a>,
\r
1750 <a href="#p_over">OVER</a>,
\r
1751 <a href="#p_state">STATE</a>,
\r
1752 <a href="#p_swap">SWAP</a>,
\r
1753 <a href="#p_tfa2cfa">TFA>CFA</a>,
\r
1754 <a href="#p_then">THEN</a>,
\r
1755 <a href="#p_dodoes">doDOES</a>,
\r
1756 as well as <a href="#p_execute">EXECUTE</a>
\r
1757 about the range of "doer" assignments and their meanings.</p></div>
\r
1758 <div style="text-align:center">
\r
1759 _______________________________________________________
\r
1761 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>
\r
1763 <div class="sect2">
\r
1764 <h3 id="_word_dofasm">Word: doFASM</h3>
\r
1765 <div class="literalblock">
\r
1766 <div class="content">
\r
1767 <pre><code>Data stack: ( -- a )</code></pre>
\r
1769 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1770 execution semantics for assembly code content.</p></div>
\r
1771 <div style="text-align:center">
\r
1772 _______________________________________________________
\r
1774 <div class="paragraph"><p><a id="p_doforth"></a></p></div>
\r
1776 <div class="sect2">
\r
1777 <h3 id="_word_doforth">Word: doFORTH</h3>
\r
1778 <div class="literalblock">
\r
1779 <div class="content">
\r
1780 <pre><code>Data stack: ( -- a )</code></pre>
\r
1782 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the
\r
1783 RRQFORTH execution semantics.</p></div>
\r
1784 <div style="text-align:center">
\r
1785 _______________________________________________________
\r
1787 <div class="paragraph"><p><a id="p_dostring"></a></p></div>
\r
1789 <div class="sect2">
\r
1790 <h3 id="_word_dostring">Word: doSTRING</h3>
\r
1791 <div class="literalblock">
\r
1792 <div class="content">
\r
1793 <pre><code>Data stack: ( -- a )</code></pre>
\r
1795 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1796 execution semantics for assembly code implemented words. In those
\r
1797 cases the execution leads to the word content.</p></div>
\r
1798 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is
\r
1799 as follows:</p></div>
\r
1800 <div class="listingblock">
\r
1801 <div class="content">
\r
1802 <pre><code> rax = cfa* of word to execute
\r
1803 rsi = cell* in the calling definition, after calling cell
\r
1804 rsp = data stack pointer
\r
1805 rbp = return stack pointer</code></pre>
\r
1807 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>
\r
1808 and <code>rbp</code> are used according to their roles.</p></div>
\r
1809 <div style="text-align:center">
\r
1810 _______________________________________________________
\r
1812 <div class="paragraph"><p><a id="p_dot"></a></p></div>
\r
1814 <div class="sect2">
\r
1815 <h3 id="_word_6">Word: .</h3>
\r
1816 <div class="literalblock">
\r
1817 <div class="content">
\r
1818 <pre><code>Data stack: ( v -- )</code></pre>
\r
1820 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using
\r
1821 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or
\r
1822 <a href="#p_hex">HEX</a>).</p></div>
\r
1823 <div style="text-align:center">
\r
1824 _______________________________________________________
\r
1826 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>
\r
1828 <div class="sect2">
\r
1829 <h3 id="_word_7">Word: "</h3>
\r
1830 <div class="literalblock">
\r
1831 <div class="content">
\r
1832 <pre><code>data stack: ( -- char n ) Input stream: ...."</code></pre>
\r
1834 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream
\r
1835 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the
\r
1836 [n:char*] cell pair for that string.</p></div>
\r
1837 <div style="text-align:center">
\r
1838 _______________________________________________________
\r
1840 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>
\r
1842 <div class="sect2">
\r
1843 <h3 id="_word_dovalue">Word: doVALUE</h3>
\r
1844 <div class="literalblock">
\r
1845 <div class="content">
\r
1846 <pre><code>Data stack: ( -- a )</code></pre>
\r
1848 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the
\r
1849 execution semantics for cell values, which are variables with a single
\r
1850 64-bit cell holding the value.</p></div>
\r
1851 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>
\r
1852 <div class="literalblock">
\r
1853 <div class="content">
\r
1854 <pre><code>Resulting data stack: ( -- v )</code></pre>
\r
1856 <div style="text-align:center">
\r
1857 _______________________________________________________
\r
1859 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>
\r
1861 <div class="sect2">
\r
1862 <h3 id="_word_dovariable">Word: doVARIABLE</h3>
\r
1863 <div class="literalblock">
\r
1864 <div class="content">
\r
1865 <pre><code>Data stack: ( -- a )</code></pre>
\r
1867 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of
\r
1868 the execution semantics for "variables", which basically are markers
\r
1869 into the heap for some number block of memory.</p></div>
\r
1870 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>
\r
1871 <div class="literalblock">
\r
1872 <div class="content">
\r
1873 <pre><code>Resulting data stack: ( -- a )</code></pre>
\r
1875 <div style="text-align:center">
\r
1876 _______________________________________________________
\r
1878 <div class="paragraph"><p><a id="p_drop"></a></p></div>
\r
1880 <div class="sect2">
\r
1881 <h3 id="_word_drop">Word: DROP</h3>
\r
1882 <div class="literalblock">
\r
1883 <div class="content">
\r
1884 <pre><code>Data stack: ( v -- )</code></pre>
\r
1886 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>
\r
1887 <div style="text-align:center">
\r
1888 _______________________________________________________
\r
1890 <div class="paragraph"><p><a id="p_dup"></a></p></div>
\r
1892 <div class="sect2">
\r
1893 <h3 id="_word_dup">Word: DUP</h3>
\r
1894 <div class="literalblock">
\r
1895 <div class="content">
\r
1896 <pre><code>Data stack: ( v -- v v )</code></pre>
\r
1898 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>
\r
1899 <div style="text-align:center">
\r
1900 _______________________________________________________
\r
1902 <div class="paragraph"><p><a id="p_else"></a></p></div>
\r
1904 <div class="sect2">
\r
1905 <h3 id="_word_else">Word: ELSE</h3>
\r
1906 <div class="literalblock">
\r
1907 <div class="content">
\r
1908 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>
\r
1910 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with
\r
1911 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
1912 control. ELSE lays out an unresolved unconditional branch as an ending
\r
1913 for the "then-part" of the structured statement, and it then performs
\r
1914 the branch resolution for the "else-part". To that end it replaces the
\r
1915 stacked address which pin-points the foot address the branch offset to
\r
1916 resolve, so that at execution time there is an appropriate conditional
\r
1917 branch past the "then-part" and the "else-part" of the "structured
\r
1918 statement".</p></div>
\r
1919 <div style="text-align:center">
\r
1920 _______________________________________________________
\r
1922 <div class="paragraph"><p><a id="p_emit"></a></p></div>
\r
1924 <div class="sect2">
\r
1925 <h3 id="_word_emit">Word: EMIT</h3>
\r
1926 <div class="literalblock">
\r
1927 <div class="content">
\r
1928 <pre><code>Data stack: ( c -- )</code></pre>
\r
1930 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to
\r
1931 standard output (file descriptor 1). The character is the least
\r
1932 significant byte of the top cell.</p></div>
\r
1933 <div style="text-align:center">
\r
1934 _______________________________________________________
\r
1936 <div class="paragraph"><p><a id="p_end"></a></p></div>
\r
1938 <div class="sect2">
\r
1939 <h3 id="_word_end">Word: END</h3>
\r
1940 <div class="literalblock">
\r
1941 <div class="content">
\r
1942 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>
\r
1944 <div class="paragraph"><p>"END" is an immediate function word that is used together with
\r
1945 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to
\r
1946 implement structured execution control. END processes the data stack
\r
1947 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the
\r
1948 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>
\r
1949 <div style="text-align:center">
\r
1950 _______________________________________________________
\r
1952 <div class="paragraph"><p><a id="p_equal"></a></p></div>
\r
1954 <div class="sect2">
\r
1955 <h3 id="_word_8">Word: =</h3>
\r
1956 <div class="literalblock">
\r
1957 <div class="content">
\r
1958 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
1960 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the
\r
1961 values are equal, and 0 otherwise.</p></div>
\r
1962 <div style="text-align:center">
\r
1963 _______________________________________________________
\r
1965 <div class="paragraph"><p><a id="p_erase"></a></p></div>
\r
1967 <div class="sect2">
\r
1968 <h3 id="_word_erase">Word: ERASE</h3>
\r
1969 <div class="literalblock">
\r
1970 <div class="content">
\r
1971 <pre><code>Data stack: ( a n -- )</code></pre>
\r
1973 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>
\r
1974 <div style="text-align:center">
\r
1975 _______________________________________________________
\r
1977 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>
\r
1979 <div class="sect2">
\r
1980 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>
\r
1981 <div class="literalblock">
\r
1982 <div class="content">
\r
1983 <pre><code>Data stack: ( stream -- ??? 0/1 ) Input stream: ......</code></pre>
\r
1985 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by
\r
1986 whitespace from the stream until it discovers an unknown word, or the
\r
1987 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are
\r
1988 either executed or compiled, and all ther stack and heap effects are
\r
1989 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the
\r
1990 stack to respectively indicate that the last word was unkown, i.e. not
\r
1991 found (<a href="#p_find">FIND</a>) in the current word list
\r
1992 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a
\r
1993 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>
\r
1994 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known
\r
1995 words that are parsed into cell values. If interpreting, then the
\r
1996 value is left on the stack. If compiling, then the value is added to
\r
1997 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done
\r
1998 so as to make that value be push to the data stack upon a later
\r
1999 execution.</p></div>
\r
2000 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a
\r
2001 minus sign.</p></div>
\r
2002 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its
\r
2003 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word
\r
2004 or not, and whether the state at the time of execution indicates
\r
2005 "compiling" of "interpreting". Immediate words are executed in both
\r
2006 interpreting and compiling state, while other words have their CFA get
\r
2007 added to the heap so as to gain their execution effect upon a later
\r
2008 execution.</p></div>
\r
2009 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return
\r
2010 stack while reading, parsing and executing.</p></div>
\r
2011 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds
\r
2012 the [n:chars] reference of the offending word in the stream buffer.</p></div>
\r
2013 <div style="text-align:center">
\r
2014 _______________________________________________________
\r
2016 <div class="paragraph"><p><a id="p_execute"></a></p></div>
\r
2018 <div class="sect2">
\r
2019 <h3 id="_word_execute">Word: EXECUTE</h3>
\r
2020 <div class="literalblock">
\r
2021 <div class="content">
\r
2022 <pre><code>Data stack: ( cfa -- )</code></pre>
\r
2024 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the
\r
2025 indicated "Code Field Address", which typically is the CFA of an
\r
2026 RRQFORTH word with the CFA cell containing a jump address for the code
\r
2027 that implements the execution semnatics of the word.</p></div>
\r
2028 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>
\r
2029 <div class="ulist"><ul>
\r
2032 assembler implemented words constitute their own execution
\r
2038 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word
\r
2039 content as a succession of cells that hold the cfa pointers for the
\r
2040 words that make of the definition. As is customary in FORTH
\r
2041 machines, the advance through that succession is provided by each
\r
2042 word code ending making an explicit jump to its successor. The
\r
2043 <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking
\r
2044 the nesting of FORTH executions by saving the "addresses" of the
\r
2050 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH
\r
2051 execution somewhere within a definition rather than at the
\r
2057 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement
\r
2058 different common ways of using word content other the as FORTH
\r
2063 <div style="text-align:center">
\r
2064 _______________________________________________________
\r
2066 <div class="paragraph"><p><a id="p_exit"></a></p></div>
\r
2068 <div class="sect2">
\r
2069 <h3 id="_word_exit">Word: EXIT</h3>
\r
2070 <div class="literalblock">
\r
2071 <div class="content">
\r
2072 <pre><code>Data stack: ( -- )</code></pre>
\r
2074 <div class="paragraph"><p>"EXIT" is a function word that implements the ending of a FORTH
\r
2075 definition and its threading to the subsequent step of the calling
\r
2076 definition.</p></div>
\r
2077 <div style="text-align:center">
\r
2078 _______________________________________________________
\r
2080 <div class="paragraph"><p><a id="p_false"></a></p></div>
\r
2082 <div class="sect2">
\r
2083 <h3 id="_word_false">Word: FALSE</h3>
\r
2084 <div class="literalblock">
\r
2085 <div class="content">
\r
2086 <pre><code>Data stack: ( -- 0 )</code></pre>
\r
2088 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>
\r
2089 <div style="text-align:center">
\r
2090 _______________________________________________________
\r
2092 <div class="paragraph"><p><a id="p_find"></a></p></div>
\r
2094 <div class="sect2">
\r
2095 <h3 id="_word_find">Word: FIND</h3>
\r
2096 <div class="literalblock">
\r
2097 <div class="content">
\r
2098 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>
\r
2100 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search
\r
2101 path for the given [n:char*] word, and returns the TFA of the matching
\r
2102 word if any. Otherwise FIND preserves the initial data stack but adds
\r
2103 0 to it.</p></div>
\r
2104 <div class="paragraph"><p>The word is sought starting with the
\r
2105 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first
\r
2106 occurence of a match. If not found, the search continues with the
\r
2107 subsequent word list, and so on.</p></div>
\r
2108 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the
\r
2109 [n:char*] double cell string pointer and pushing (only) the TFA of the
\r
2110 matching word instead.</p></div>
\r
2111 <div style="text-align:center">
\r
2112 _______________________________________________________
\r
2114 <div class="paragraph"><p><a id="p_forth"></a></p></div>
\r
2116 <div class="sect2">
\r
2117 <h3 id="_word_forth">Word: FORTH</h3>
\r
2118 <div class="literalblock">
\r
2119 <div class="content">
\r
2120 <pre><code>data stack: ( -- a )</code></pre>
\r
2122 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not
\r
2123 have any subsequent word list.</p></div>
\r
2124 <div style="text-align:center">
\r
2125 _______________________________________________________
\r
2127 <div class="paragraph"><p><a id="p_get"></a></p></div>
\r
2129 <div class="sect2">
\r
2130 <h3 id="_word_9">Word: @</h3>
\r
2131 <div class="literalblock">
\r
2132 <div class="content">
\r
2133 <pre><code>Data stack: ( a -- v )</code></pre>
\r
2135 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>
\r
2136 <div style="text-align:center">
\r
2137 _______________________________________________________
\r
2139 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>
\r
2141 <div class="sect2">
\r
2142 <h3 id="_word_n">Word: @n--</h3>
\r
2143 <div class="literalblock">
\r
2144 <div class="content">
\r
2145 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2147 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,
\r
2148 then decrements the cell at that address by n.</p></div>
\r
2149 <div class="exampleblock">
\r
2150 <div class="content">
\r
2151 <div class="sidebarblock">
\r
2152 <div class="content">
\r
2153 <div class="title">Defintion concept for @n++</div>
\r
2154 <div class="paragraph"><p>: @n++ OVER @ DUP ROT - ROT ! ;</p></div>
\r
2157 <div style="text-align:center">
\r
2158 _______________________________________________________
\r
2160 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>
\r
2162 <div class="sect2">
\r
2163 <h3 id="_word_n_2">Word: @n++</h3>
\r
2164 <div class="literalblock">
\r
2165 <div class="content">
\r
2166 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2168 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,
\r
2169 then increments the cell at that address by n.</p></div>
\r
2170 <div class="exampleblock">
\r
2171 <div class="content">
\r
2172 <div class="sidebarblock">
\r
2173 <div class="content">
\r
2174 <div class="title">Defintion concept for @n++</div>
\r
2175 <div class="paragraph"><p>( a n — v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>
\r
2178 <div style="text-align:center">
\r
2179 _______________________________________________________
\r
2181 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>
\r
2183 <div class="sect2">
\r
2184 <h3 id="_word_gt">Word: >=</h3>
\r
2185 <div class="literalblock">
\r
2186 <div class="content">
\r
2187 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2189 <div class="paragraph"><p>">=" is a function word that replaces a pair of values with -1 if the
\r
2190 first, v1, is greater than or equal to the second, v1, otherwise 0. To
\r
2191 that end, the values are 64-bit signed integers.</p></div>
\r
2192 <div style="text-align:center">
\r
2193 _______________________________________________________
\r
2195 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>
\r
2197 <div class="sect2">
\r
2198 <h3 id="_word_gt_2">Word: ></h3>
\r
2199 <div class="literalblock">
\r
2200 <div class="content">
\r
2201 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2203 <div class="paragraph"><p>">" is a function word that replaces a pair of values with -1 if the
\r
2204 first, v1, is greater than the second, v1, otherwise 0. To that end,
\r
2205 the values are 64-bit signed integers.</p></div>
\r
2206 <div style="text-align:center">
\r
2207 _______________________________________________________
\r
2209 <div class="paragraph"><p><a id="p_gtR"></a></p></div>
\r
2211 <div class="sect2">
\r
2212 <h3 id="_word_gt_r">Word: >R</h3>
\r
2213 <div class="literalblock">
\r
2214 <div class="content">
\r
2215 <pre><code>Data stack: ( v -- ) Return stack: ( -- v )</code></pre>
\r
2217 <div class="paragraph"><p>">R" is a function word that "moves" the top data stack value onto the
\r
2218 return stack.</p></div>
\r
2219 <div style="text-align:center">
\r
2220 _______________________________________________________
\r
2222 <div class="paragraph"><p><a id="p_here"></a></p></div>
\r
2224 <div class="sect2">
\r
2225 <h3 id="_word_here">Word: HERE</h3>
\r
2226 <div class="literalblock">
\r
2227 <div class="content">
\r
2228 <pre><code>Data stack: ( -- a )</code></pre>
\r
2230 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free
\r
2231 allocation space. It get updated by all words that allocate memory.</p></div>
\r
2232 <div class="exampleblock">
\r
2233 <div class="content">
\r
2234 <div class="sidebarblock">
\r
2235 <div class="content">
\r
2236 <div class="title">allocate 1024 bytes on the heap</div>
\r
2237 <div class="paragraph"><p>1024 HEAP @ + HEAP !</p></div>
\r
2240 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>
\r
2241 <div style="text-align:center">
\r
2242 _______________________________________________________
\r
2244 <div class="paragraph"><p><a id="p_hex"></a></p></div>
\r
2246 <div class="sect2">
\r
2247 <h3 id="_word_hex">Word: HEX</h3>
\r
2248 <div class="literalblock">
\r
2249 <div class="content">
\r
2250 <pre><code>Data stack: ( -- )</code></pre>
\r
2252 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses
\r
2253 letters a-f as additional digits. (Uppercase letter are also accepted
\r
2254 on input).</p></div>
\r
2255 <div class="exampleblock">
\r
2256 <div class="content">
\r
2257 <div class="sidebarblock">
\r
2258 <div class="content">
\r
2259 <div class="title">Definition concept for HEX</div>
\r
2260 <div class="paragraph"><p>: HEX 16 BASE ! ;</p></div>
\r
2263 <div style="text-align:center">
\r
2264 _______________________________________________________
\r
2266 <div class="paragraph"><p><a id="p_if"></a></p></div>
\r
2268 <div class="sect2">
\r
2269 <h3 id="_word_if">Word: IF</h3>
\r
2270 <div class="literalblock">
\r
2271 <div class="content">
\r
2272 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2274 <div class="paragraph"><p>"IF" is an immediate function word that is used together with
\r
2275 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2276 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction
\r
2277 with an unresolved branch offset, and places the address for resolving
\r
2278 this instruction on the datastack. This address will then be resolved
\r
2279 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so
\r
2280 that at execution time there is an appropriate conditional branch past
\r
2281 the "then-part" of the "structured statement".</p></div>
\r
2282 <div style="text-align:center">
\r
2283 _______________________________________________________
\r
2285 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>
\r
2287 <div class="sect2">
\r
2288 <h3 id="_word_ifagain">Word: IFAGAIN</h3>
\r
2289 <div class="literalblock">
\r
2290 <div class="content">
\r
2291 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2293 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with
\r
2294 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement
\r
2295 structured execution control. IFAGAIN scans the datastack for the
\r
2296 nearest preceding BEGIN marker and lays out a branch from this point
\r
2297 the beginning of the block during execution.</p></div>
\r
2298 <div style="text-align:center">
\r
2299 _______________________________________________________
\r
2301 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>
\r
2303 <div class="sect2">
\r
2304 <h3 id="_word_ifbreak">Word: IFBREAK</h3>
\r
2305 <div class="literalblock">
\r
2306 <div class="content">
\r
2307 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2309 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with
\r
2310 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
2311 implement structured execution control. IFBREAK simply places the
\r
2312 address for resolving branches from this point the end of the block
\r
2313 during execution.</p></div>
\r
2314 <div style="text-align:center">
\r
2315 _______________________________________________________
\r
2317 <div class="paragraph"><p><a id="p_immediate"></a></p></div>
\r
2319 <div class="sect2">
\r
2320 <h3 id="_word_immediate">Word: IMMEDIATE</h3>
\r
2321 <div class="literalblock">
\r
2322 <div class="content">
\r
2323 <pre><code>Data stack: ( -- )</code></pre>
\r
2325 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of
\r
2326 the most recent word to 1, thereby making that word an immediate word.</p></div>
\r
2327 <div class="exampleblock">
\r
2328 <div class="content">
\r
2329 <div class="sidebarblock">
\r
2330 <div class="content">
\r
2331 <div class="title">Definition concept for IMMEDIATE</div>
\r
2332 <div class="paragraph"><p>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</p></div>
\r
2335 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
2336 <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
2337 <div style="text-align:center">
\r
2338 _______________________________________________________
\r
2340 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>
\r
2342 <div class="sect2">
\r
2343 <h3 id="_word_10">Word: [</h3>
\r
2344 <div class="literalblock">
\r
2345 <div class="content">
\r
2346 <pre><code>Data stack: ( -- )</code></pre>
\r
2348 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation
\r
2349 mode to be intepreting. In this mode, words are executed immediately
\r
2350 after parsing, by invoking their "doer".</p></div>
\r
2351 <div class="exampleblock">
\r
2352 <div class="content">
\r
2353 <div class="sidebarblock">
\r
2354 <div class="content">
\r
2355 <div class="title">Definition concept for [</div>
\r
2356 <div class="paragraph"><p>: [ IMMEDIATE 0 STATE ! ;</p></div>
\r
2359 <div style="text-align:center">
\r
2360 _______________________________________________________
\r
2362 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>
\r
2364 <div class="sect2">
\r
2365 <h3 id="_word_lt">Word: <=</h3>
\r
2366 <div class="literalblock">
\r
2367 <div class="content">
\r
2368 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2370 <div class="paragraph"><p>"<=" is a function word that replaces a pair of values with -1 if the
\r
2371 first, v1, is less than or equal to the second, v1, otherwise 0. To
\r
2372 that end, the values are 64-bit signed integers.</p></div>
\r
2373 <div style="text-align:center">
\r
2374 _______________________________________________________
\r
2376 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>
\r
2378 <div class="sect2">
\r
2379 <h3 id="_word_lt_2">Word: <</h3>
\r
2380 <div class="literalblock">
\r
2381 <div class="content">
\r
2382 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2384 <div class="paragraph"><p>"<" is a function word that replaces a pair of values with -1 if the
\r
2385 first, v1, is less than the second, v1, otherwise 0. To that end, the
\r
2386 values are 64-bit signed integers.</p></div>
\r
2387 <div style="text-align:center">
\r
2388 _______________________________________________________
\r
2390 <div class="paragraph"><p><a id="p_literal"></a></p></div>
\r
2392 <div class="sect2">
\r
2393 <h3 id="_word_lit">Word: LIT</h3>
\r
2394 <div class="literalblock">
\r
2395 <div class="content">
\r
2396 <pre><code>Data stack: ( -- v )</code></pre>
\r
2398 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves
\r
2399 excution past that. The literal value is thus layed out as if a
\r
2400 subsequent CFA pointer in the containing definition, and the LIT
\r
2401 execution will make the execution skip past that and instead contine
\r
2402 with the CFA pointer following the value.</p></div>
\r
2403 <div class="paragraph"><p>It’s not a good idea to use "LIT" interactively.</p></div>
\r
2404 <div class="exampleblock">
\r
2405 <div class="content">
\r
2406 <div class="sidebarblock">
\r
2407 <div class="content">
\r
2408 <div class="title">Definition concept for LIT</div>
\r
2409 <div class="paragraph"><p>: LIT R> DUP 8 + >R @ ;</p></div>
\r
2412 <div style="text-align:center">
\r
2413 _______________________________________________________
\r
2415 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>
\r
2417 <div class="sect2">
\r
2418 <h3 id="_word_s">Word: S"</h3>
\r
2419 <div class="literalblock">
\r
2420 <div class="content">
\r
2421 <pre><code>Data stack: ( -- chars* n )</code></pre>
\r
2423 <div class="paragraph"><p>"S"" is a function word that pushes the [n:char] pointer for a string
\r
2424 inlined subsequently to it in the containing definition. This is
\r
2425 similar to <a href="#p_lit">LIT</a> but for a string literal.</p></div>
\r
2426 <div class="exampleblock">
\r
2427 <div class="content">
\r
2428 <div class="sidebarblock">
\r
2429 <div class="content">
\r
2430 <div class="title">Definition concept for LIT</div>
\r
2431 <div class="paragraph"><p>: LIT R> DUP @ 2DUP + 8 + >R SWAP 8 + SWAP ;</p></div>
\r
2434 <div style="text-align:center">
\r
2435 _______________________________________________________
\r
2437 <div class="paragraph"><p><a id="p_load_file_quote"></a></p></div>
\r
2439 <div class="sect2">
\r
2440 <h3 id="_word_load_file">Word: LOAD-FILE"</h3>
\r
2441 <div class="literalblock">
\r
2442 <div class="content">
\r
2443 <pre><code>data stack: ( "name" -- )</code></pre>
\r
2445 <div class="paragraph"><p>"LOAD-FILE"" is a function word that opens a file via
\r
2446 <a href="#p_open_file_quote">OPEN-FILE"</a>, allocates a stream buffer of 15000
\r
2447 bytes for reading it, saves the stream pointer as value for the newly
\r
2448 created filename variable, and then it invokes
\r
2449 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing the file.</p></div>
\r
2450 <div style="text-align:center">
\r
2451 _______________________________________________________
\r
2453 <div class="paragraph"><p><a id="p_lparen"></a></p></div>
\r
2455 <div class="sect2">
\r
2456 <h3 id="_word_11">Word: (</h3>
\r
2457 <div class="literalblock">
\r
2458 <div class="content">
\r
2459 <pre><code>Data stack: ( -- )</code></pre>
\r
2461 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words
\r
2462 until the next right parenthesis, or the end of the stream. This is
\r
2463 used for comments in RRQFORTH code.</p></div>
\r
2464 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have
\r
2465 whitespace before and after it.</p></div>
\r
2466 <div style="text-align:center">
\r
2467 _______________________________________________________
\r
2469 <div class="paragraph"><p><a id="p_malloc"></a></p></div>
\r
2471 <div class="sect2">
\r
2472 <h3 id="_word_malloc">Word: MALLOC</h3>
\r
2473 <div class="literalblock">
\r
2474 <div class="content">
\r
2475 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2477 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n
\r
2478 bytes and returns the lowest address of the allocated block.</p></div>
\r
2479 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2480 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2481 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC
\r
2482 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man
\r
2483 page" of mmap for details.</p></div>
\r
2484 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>
\r
2485 <div style="text-align:center">
\r
2486 _______________________________________________________
\r
2488 <div class="paragraph"><p><a id="p_minus"></a></p></div>
\r
2490 <div class="sect2">
\r
2491 <h3 id="_word_12">Word: -</h3>
\r
2492 <div class="literalblock">
\r
2493 <div class="content">
\r
2494 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2496 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the
\r
2497 result of reducing the first, v1, with the second, v2. To that end,
\r
2498 the values are 64-bit signed integers.</p></div>
\r
2499 <div style="text-align:center">
\r
2500 _______________________________________________________
\r
2502 <div class="paragraph"><p><a id="p_mult"></a></p></div>
\r
2504 <div class="sect2">
\r
2505 <h3 id="_word_13">Word: *</h3>
\r
2506 <div class="literalblock">
\r
2507 <div class="content">
\r
2508 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2510 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result
\r
2511 of multiplying them. To that end, the values are 64-bit signed
\r
2512 integers, and clipping the result to the least signifcant 64 bits.</p></div>
\r
2513 <div style="text-align:center">
\r
2514 _______________________________________________________
\r
2516 <div class="paragraph"><p><a id="p_negate"></a></p></div>
\r
2518 <div class="sect2">
\r
2519 <h3 id="_word_negate">Word: NEGATE</h3>
\r
2520 <div class="literalblock">
\r
2521 <div class="content">
\r
2522 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2524 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its
\r
2525 2’s-complement negation. To that end, the values are 64-bit signed
\r
2526 integers.</p></div>
\r
2527 <div style="text-align:center">
\r
2528 _______________________________________________________
\r
2530 <div class="paragraph"><p><a id="p_nip"></a></p></div>
\r
2532 <div class="sect2">
\r
2533 <h3 id="_word_nip">Word: NIP</h3>
\r
2534 <div class="literalblock">
\r
2535 <div class="content">
\r
2536 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>
\r
2538 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells
\r
2539 on the data stack.</p></div>
\r
2540 <div class="exampleblock">
\r
2541 <div class="content">
\r
2542 <div class="sidebarblock">
\r
2543 <div class="content">
\r
2544 <div class="title">Definition concept for NIP</div>
\r
2545 <div class="paragraph"><p>: NIP SWAP DROP ;</p></div>
\r
2548 <div style="text-align:center">
\r
2549 _______________________________________________________
\r
2551 <div class="paragraph"><p><a id="p_nl"></a></p></div>
\r
2553 <div class="sect2">
\r
2554 <h3 id="_word_nl">Word: NL</h3>
\r
2555 <div class="literalblock">
\r
2556 <div class="content">
\r
2557 <pre><code>Data stack: ( -- v )</code></pre>
\r
2559 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>
\r
2560 <div style="text-align:center">
\r
2561 _______________________________________________________
\r
2563 <div class="paragraph"><p><a id="p_not"></a></p></div>
\r
2565 <div class="sect2">
\r
2566 <h3 id="_word_not">Word: NOT</h3>
\r
2567 <div class="literalblock">
\r
2568 <div class="content">
\r
2569 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2571 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise
\r
2572 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>
\r
2573 <div class="paragraph"><p>Compare with <<p_0equal,0⇒>.</p></div>
\r
2574 <div style="text-align:center">
\r
2575 _______________________________________________________
\r
2577 <div class="paragraph"><p><a id="p_number"></a></p></div>
\r
2579 <div class="sect2">
\r
2580 <h3 id="_word_number">Word: NUMBER</h3>
\r
2581 <div class="literalblock">
\r
2582 <div class="content">
\r
2583 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>
\r
2585 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using
\r
2586 <a href="#p_base">BASE</a> as numerical base, then returns the result number and
\r
2587 a 1 on top, or just a 0 if the word didn’t parse.</p></div>
\r
2588 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in
\r
2589 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>
\r
2590 base, letters a-f or A-F for values 10-15. I.e. the normal positive or
\r
2591 negative decimal integers or normal (positive only) hexadecimal
\r
2592 integers.</p></div>
\r
2593 <div style="text-align:center">
\r
2594 _______________________________________________________
\r
2596 <div class="paragraph"><p><a id="p_open_file_quote"></a></p></div>
\r
2598 <div class="sect2">
\r
2599 <h3 id="_word_open_file">Word: OPEN-FILE"</h3>
\r
2600 <div class="literalblock">
\r
2601 <div class="content">
\r
2602 <pre><code>Data stack: ( "name" -- fd )</code></pre>
\r
2604 <div class="paragraph"><p>"OPEN-FILE"" is a function word that reads the intputstream for a
\r
2605 filename, adds that to the dictionary as a no-content variable, opens
\r
2606 that file and returns the input file descriptor.</p></div>
\r
2607 <div style="text-align:center">
\r
2608 _______________________________________________________
\r
2610 <div class="paragraph"><p><a id="p_or"></a></p></div>
\r
2612 <div class="sect2">
\r
2613 <h3 id="_word_or">Word: OR</h3>
\r
2614 <div class="literalblock">
\r
2615 <div class="content">
\r
2616 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2618 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise
\r
2619 disjunction; each bit is 1 if the corresponding bits of any operand
\r
2620 is 1 and 0 if not.</p></div>
\r
2621 <div style="text-align:center">
\r
2622 _______________________________________________________
\r
2624 <div class="paragraph"><p><a id="p_over"></a></p></div>
\r
2626 <div class="sect2">
\r
2627 <h3 id="_word_over">Word: OVER</h3>
\r
2628 <div class="literalblock">
\r
2629 <div class="content">
\r
2630 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>
\r
2632 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on
\r
2633 the data stack.</p></div>
\r
2634 <div style="text-align:center">
\r
2635 _______________________________________________________
\r
2637 <div class="paragraph"><p><a id="p_pad"></a></p></div>
\r
2639 <div class="sect2">
\r
2640 <h3 id="_word_pad">Word: PAD</h3>
\r
2641 <div class="literalblock">
\r
2642 <div class="content">
\r
2643 <pre><code>Data stack: ( -- a )</code></pre>
\r
2645 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by
\r
2646 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>
\r
2647 <div style="text-align:center">
\r
2648 _______________________________________________________
\r
2650 <div class="paragraph"><p><a id="p_pick"></a></p></div>
\r
2652 <div class="sect2">
\r
2653 <h3 id="_word_pick">Word: PICK</h3>
\r
2654 <div class="literalblock">
\r
2655 <div class="content">
\r
2656 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>
\r
2658 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down
\r
2659 from top onto the data stack. 0 indicates the top cell making it the
\r
2660 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it
\r
2661 the same as <a href="#p_over">OVER</a>.</p></div>
\r
2662 <div style="text-align:center">
\r
2663 _______________________________________________________
\r
2665 <div class="paragraph"><p><a id="p_plus"></a></p></div>
\r
2667 <div class="sect2">
\r
2668 <h3 id="_word_43">Word: +</h3>
\r
2669 <div class="literalblock">
\r
2670 <div class="content">
\r
2671 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2673 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the
\r
2674 result of adding them. To that end, the values are 64-bit signed
\r
2675 integers.</p></div>
\r
2676 <div style="text-align:center">
\r
2677 _______________________________________________________
\r
2679 <div class="paragraph"><p><a id="p_program_version"></a></p></div>
\r
2681 <div class="sect2">
\r
2682 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>
\r
2683 <div class="literalblock">
\r
2684 <div class="content">
\r
2685 <pre><code>Data stack: ( -- char* length )</code></pre>
\r
2687 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>
\r
2688 <div style="text-align:center">
\r
2689 _______________________________________________________
\r
2691 <div class="paragraph"><p><a id="p_put"></a></p></div>
\r
2693 <div class="sect2">
\r
2694 <h3 id="_word_14">Word: !</h3>
\r
2695 <div class="literalblock">
\r
2696 <div class="content">
\r
2697 <pre><code>Data stack: ( v a -- )</code></pre>
\r
2699 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>
\r
2700 <div style="text-align:center">
\r
2701 _______________________________________________________
\r
2703 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>
\r
2705 <div class="sect2">
\r
2706 <h3 id="_word_15">Word: !+</h3>
\r
2707 <div class="literalblock">
\r
2708 <div class="content">
\r
2709 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2711 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>
\r
2712 <div class="exampleblock">
\r
2713 <div class="content">
\r
2714 <div class="sidebarblock">
\r
2715 <div class="content">
\r
2716 <div class="title">definition concept for !+</div>
\r
2717 <div class="paragraph"><p>( a n — ) : !+ OVER @ + SWAP ! ;</p></div>
\r
2720 <div style="text-align:center">
\r
2721 _______________________________________________________
\r
2723 <div class="paragraph"><p><a id="p_quit"></a></p></div>
\r
2725 <div class="sect2">
\r
2726 <h3 id="_word_quit">Word: QUIT</h3>
\r
2727 <div class="literalblock">
\r
2728 <div class="content">
\r
2729 <pre><code>Data stack: ??</code></pre>
\r
2731 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of
\r
2732 RRQFORTH. First it resets the stacks to their original settings, and
\r
2733 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and
\r
2734 executing them.</p></div>
\r
2735 <div style="text-align:center">
\r
2736 _______________________________________________________
\r
2738 <div class="paragraph"><p><a id="p_quote"></a></p></div>
\r
2740 <div class="sect2">
\r
2741 <h3 id="_word_16">Word: '</h3>
\r
2742 <div class="literalblock">
\r
2743 <div class="content">
\r
2744 <pre><code>data stack: ( -- cfa ) Input stream: word</code></pre>
\r
2746 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next
\r
2747 word on the input stream and pushes its cfa.</p></div>
\r
2748 <div style="text-align:center">
\r
2749 _______________________________________________________
\r
2751 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>
\r
2753 <div class="sect2">
\r
2754 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>
\r
2755 <div class="literalblock">
\r
2756 <div class="content">
\r
2757 <pre><code>Data stack: ( stream -- c )</code></pre>
\r
2759 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character
\r
2760 from the given stream buffer, possibly refilling the buffer if it is
\r
2761 backed by a file descriptor. The refill is done by a SYS_READ call
\r
2762 when more characters are needed. The next character is pushed on the
\r
2763 stack, unless the stream is exhausted in which case the -1 is pushed
\r
2764 instead.</p></div>
\r
2765 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>
\r
2766 <div style="text-align:center">
\r
2767 _______________________________________________________
\r
2769 <div class="paragraph"><p><a id="p_read_word"></a></p></div>
\r
2771 <div class="sect2">
\r
2772 <h3 id="_word_read_word">Word: READ-WORD</h3>
\r
2773 <div class="literalblock">
\r
2774 <div class="content">
\r
2775 <pre><code>Data stack: ( stream -- char* n )</code></pre>
\r
2777 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace
\r
2778 separated word from the given stream and returns the [n:char*] duoble
\r
2779 cell pointer for it. The characters of the word are copied to
\r
2780 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>
\r
2781 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>
\r
2782 <div style="text-align:center">
\r
2783 _______________________________________________________
\r
2785 <div class="paragraph"><p><a id="p_realloc"></a></p></div>
\r
2787 <div class="sect2">
\r
2788 <h3 id="_word_realloc">Word: REALLOC</h3>
\r
2789 <div class="literalblock">
\r
2790 <div class="content">
\r
2791 <pre><code>Data stack: ( a m n -- a )</code></pre>
\r
2793 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a
\r
2794 of size m to be size n bytes and returns the lowest address of the
\r
2795 allocated block.</p></div>
\r
2796 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2797 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2798 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>
\r
2799 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>
\r
2800 <div style="text-align:center">
\r
2801 _______________________________________________________
\r
2803 <div class="paragraph"><p>compile.asm: WORD p_right_bracket,<em>]</em>,fasm</p></div>
\r
2804 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>
\r
2806 <div class="sect2">
\r
2807 <h3 id="_word_17">Word: ]</h3>
\r
2808 <div class="literalblock">
\r
2809 <div class="content">
\r
2810 <pre><code>Data stack: ( -- )</code></pre>
\r
2812 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation
\r
2813 mode to be compiling. In this mode words parsed into CFA pointers
\r
2814 which are placed on the heap in the given order, unless the word is
\r
2815 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An
\r
2816 immediate word is executed immediately, and a number is parsed and
\r
2817 left on the stack.</p></div>
\r
2818 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the
\r
2819 wordlist; i.e., the word list may contain definitions for numbers.</p></div>
\r
2820 <div class="exampleblock">
\r
2821 <div class="content">
\r
2822 <div class="sidebarblock">
\r
2823 <div class="content">
\r
2824 <div class="title">Definition concept for ]</div>
\r
2825 <div class="paragraph"><p>: ] 1 STATE ! ;</p></div>
\r
2828 <div style="text-align:center">
\r
2829 _______________________________________________________
\r
2831 <div class="paragraph"><p><a id="p_roll"></a></p></div>
\r
2833 <div class="sect2">
\r
2834 <h3 id="_word_roll">Word: ROLL</h3>
\r
2835 <div class="literalblock">
\r
2836 <div class="content">
\r
2837 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>
\r
2839 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down
\r
2840 from top onto the data stack while discarding it. 0 indicates the top
\r
2841 cell; 1 indicates the second top cell making it the same as
\r
2842 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as
\r
2843 <a href="#p_rot">ROT</a>.</p></div>
\r
2844 <div style="text-align:center">
\r
2845 _______________________________________________________
\r
2847 <div class="paragraph"><p><a id="p_rot"></a></p></div>
\r
2849 <div class="sect2">
\r
2850 <h3 id="_word_rot">Word: ROT</h3>
\r
2851 <div class="literalblock">
\r
2852 <div class="content">
\r
2853 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>
\r
2855 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells
\r
2856 such that the third becomes the first while the second becomes third
\r
2857 and the first becomes the second.</p></div>
\r
2858 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>
\r
2859 <div style="text-align:center">
\r
2860 _______________________________________________________
\r
2862 <div class="paragraph"><p><a id="p_rsp"></a></p></div>
\r
2864 <div class="sect2">
\r
2865 <h3 id="_word_r_n">Word: R[n]</h3>
\r
2866 <div class="literalblock">
\r
2867 <div class="content">
\r
2868 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2870 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell on
\r
2871 the top return stack value onto the data stack.</p></div>
\r
2872 <div style="text-align:center">
\r
2873 _______________________________________________________
\r
2875 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>
\r
2877 <div class="sect2">
\r
2878 <h3 id="_word_18">Word: ;</h3>
\r
2879 <div class="literalblock">
\r
2880 <div class="content">
\r
2881 <pre><code>Data stack: ( -- )</code></pre>
\r
2883 <div class="paragraph"><p>";" (semi-colon) is a function word that ends a new forth definition
\r
2884 by means of adding an <a href="#p_exit">EXIT</a></p></div>
\r
2885 <div class="exampleblock">
\r
2886 <div class="content">
\r
2887 <div class="sidebarblock">
\r
2888 <div class="content">
\r
2889 <div class="title">Definition concept for ;</div>
\r
2890 <div class="paragraph"><p>: ; IMMEDIATE ' EXIT , ;</p></div>
\r
2893 <div style="text-align:center">
\r
2894 _______________________________________________________
\r
2896 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>
\r
2898 <div class="sect2">
\r
2899 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>
\r
2900 <div class="literalblock">
\r
2901 <div class="content">
\r
2902 <pre><code>Data stack: ( -- a )</code></pre>
\r
2904 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code
\r
2905 sniippet for setting up the signal handling. rrqforth handles SEGV by
\r
2906 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>
\r
2907 <div style="text-align:center">
\r
2908 _______________________________________________________
\r
2910 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>
\r
2912 <div class="sect2">
\r
2913 <h3 id="_word_lt_lt">Word: <<</h3>
\r
2914 <div class="literalblock">
\r
2915 <div class="content">
\r
2916 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2918 <div class="paragraph"><p>"<<" is a function word that shifts value v1 n steps left (i.e.
\r
2919 "moving" bits towards more significant bits) to form value v2.</p></div>
\r
2920 <div style="text-align:center">
\r
2921 _______________________________________________________
\r
2923 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>
\r
2925 <div class="sect2">
\r
2926 <h3 id="_word_gt_gt">Word: >></h3>
\r
2927 <div class="literalblock">
\r
2928 <div class="content">
\r
2929 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2931 <div class="paragraph"><p>">>" is a function word that shifts value v1 n steps right (i.e.
\r
2932 "moving" bits towards less significant bits) to form value v2.</p></div>
\r
2933 <div style="text-align:center">
\r
2934 _______________________________________________________
\r
2936 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>
\r
2938 <div class="sect2">
\r
2939 <h3 id="_word_s_gt_gt">Word: s>></h3>
\r
2940 <div class="literalblock">
\r
2941 <div class="content">
\r
2942 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2944 <div class="paragraph"><p>"s>>" is a function word that shifts value v1 n steps right (i.e.
\r
2945 "moving" bits towards less significant bits) to form value v2, but
\r
2946 preserving (and copying) the sign bit.</p></div>
\r
2947 <div style="text-align:center">
\r
2948 _______________________________________________________
\r
2950 <div class="paragraph"><p><a id="p_sp"></a></p></div>
\r
2952 <div class="sect2">
\r
2953 <h3 id="_word_sp">Word: SP</h3>
\r
2954 <div class="literalblock">
\r
2955 <div class="content">
\r
2956 <pre><code>Data stack: ( -- v )</code></pre>
\r
2958 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>
\r
2959 <div style="text-align:center">
\r
2960 _______________________________________________________
\r
2962 <div class="paragraph"><p><a id="p_state"></a></p></div>
\r
2964 <div class="sect2">
\r
2965 <h3 id="_word_state">Word: STATE</h3>
\r
2966 <div class="literalblock">
\r
2967 <div class="content">
\r
2968 <pre><code>Data stack: ( -- a )</code></pre>
\r
2970 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in
\r
2971 compiling mode (1) or interpreting (0) mode.</p></div>
\r
2972 <div style="text-align:center">
\r
2973 _______________________________________________________
\r
2975 <div class="paragraph"><p><a id="p_stdin"></a></p></div>
\r
2977 <div class="sect2">
\r
2978 <h3 id="_word_stdin">Word: STDIN</h3>
\r
2979 <div class="literalblock">
\r
2980 <div class="content">
\r
2981 <pre><code>Data stack: ( -- stream )</code></pre>
\r
2983 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the
\r
2984 standard input file descriptor.</p></div>
\r
2985 <div style="text-align:center">
\r
2986 _______________________________________________________
\r
2988 <div class="paragraph"><p><a id="p_stream"></a></p></div>
\r
2990 <div class="sect2">
\r
2991 <h3 id="_word_stream">Word: STREAM</h3>
\r
2992 <div class="literalblock">
\r
2993 <div class="content">
\r
2994 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>
\r
2996 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file
\r
2997 descriptor or for a memory block (of size+data).</p></div>
\r
2998 <div class="sect3">
\r
2999 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>
\r
3000 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size
\r
3001 prefixed by a 32 byte STREAM header of the following layout:</p></div>
\r
3002 <div class="exampleblock">
\r
3003 <div class="content">
\r
3004 <div class="listingblock">
\r
3005 <div class="title">Layout 3: file descriptor stream</div>
\r
3006 <div class="content">
\r
3007 <pre><code> 8 bytes = size of buffer (excluding the 32 byte header)
\r
3008 8 bytes source file descriptor
\r
3009 8 bytes current fill
\r
3010 8 current read position</code></pre>
\r
3014 <div class="sect3">
\r
3015 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>
\r
3016 <div class="paragraph"><p>A memory block stream is only the header (though allocated via
\r
3017 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the
\r
3018 following layout:</p></div>
\r
3019 <div class="exampleblock">
\r
3020 <div class="content">
\r
3021 <div class="listingblock">
\r
3022 <div class="title">Layout 4: memory block stream</div>
\r
3023 <div class="content">
\r
3024 <pre><code> 8 bytes = block address
\r
3025 8 -1 (indicates memory block)
\r
3026 8 size of block (taken from the block's first 8 bytes)
\r
3027 8 current read position</code></pre>
\r
3030 <div style="text-align:center">
\r
3031 _______________________________________________________
\r
3033 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>
\r
3036 <div class="sect2">
\r
3037 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>
\r
3038 <div class="literalblock">
\r
3039 <div class="content">
\r
3040 <pre><code>Data stack: ( stream -- n )</code></pre>
\r
3042 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream
\r
3043 buffer for the next non-whitespace character, and returns its position
\r
3044 relative to the end of the buffer. This is done without changing the
\r
3045 stream (or filling it by reading the backing file).</p></div>
\r
3046 <div style="text-align:center">
\r
3047 _______________________________________________________
\r
3049 <div class="paragraph"><p><a id="p_strlen"></a></p></div>
\r
3051 <div class="sect2">
\r
3052 <h3 id="_word_strlen">Word: STRLEN</h3>
\r
3053 <div class="literalblock">
\r
3054 <div class="content">
\r
3055 <pre><code>Data stack: ( s -- n )</code></pre>
\r
3057 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from
\r
3058 s to the first NUL byte and returns that count, n, not including the
\r
3059 NUL byte.</p></div>
\r
3060 <div style="text-align:center">
\r
3061 _______________________________________________________
\r
3063 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>
\r
3065 <div class="sect2">
\r
3066 <h3 id="_word_strncmp">Word: STRNCMP</h3>
\r
3067 <div class="literalblock">
\r
3068 <div class="content">
\r
3069 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>
\r
3071 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of
\r
3072 character sequences s1 and s2, and returns the difference of the first
\r
3073 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters
\r
3074 are the same.</p></div>
\r
3075 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically
\r
3077 v is greater than 0 if [n:s1] is greater than [n:s2],
\r
3078 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>
\r
3079 <div style="text-align:center">
\r
3080 _______________________________________________________
\r
3082 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>
\r
3084 <div class="sect2">
\r
3085 <h3 id="_word_strncpy">Word: STRNCPY</h3>
\r
3086 <div class="literalblock">
\r
3087 <div class="content">
\r
3088 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>
\r
3090 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1
\r
3092 <div style="text-align:center">
\r
3093 _______________________________________________________
\r
3095 <div class="paragraph"><p><a id="p_swap"></a></p></div>
\r
3097 <div class="sect2">
\r
3098 <h3 id="_word_swap">Word: SWAP</h3>
\r
3099 <div class="literalblock">
\r
3100 <div class="content">
\r
3101 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>
\r
3103 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>
\r
3104 <div style="text-align:center">
\r
3105 _______________________________________________________
\r
3107 <div class="paragraph"><p><a id="p_system"></a></p></div>
\r
3109 <div class="sect2">
\r
3110 <h3 id="_word_system">Word: SYSTEM</h3>
\r
3111 <div class="literalblock">
\r
3112 <div class="content">
\r
3113 <pre><code>Data value: ( -- a )</code></pre>
\r
3115 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system
\r
3116 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>
\r
3117 merely as a matter of segregation.</p></div>
\r
3118 <div style="text-align:center">
\r
3119 _______________________________________________________
\r
3121 <div class="paragraph"><p><a id="p_tell"></a></p></div>
\r
3123 <div class="sect2">
\r
3124 <h3 id="_word_tell">Word: TELL</h3>
\r
3125 <div class="literalblock">
\r
3126 <div class="content">
\r
3127 <pre><code>Data stack: ( char* n -- )</code></pre>
\r
3129 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file
\r
3130 descriptor 1).</p></div>
\r
3131 <div style="text-align:center">
\r
3132 _______________________________________________________
\r
3134 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>
\r
3136 <div class="sect2">
\r
3137 <h3 id="_word_terminate0">Word: TERMINATE0</h3>
\r
3138 <div class="literalblock">
\r
3139 <div class="content">
\r
3140 <pre><code>Data stack: ( -- )</code></pre>
\r
3142 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit
\r
3144 <div style="text-align:center">
\r
3145 _______________________________________________________
\r
3147 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>
\r
3149 <div class="sect2">
\r
3150 <h3 id="_word_tfa_gt_cfa">Word: TFA>CFA</h3>
\r
3151 <div class="literalblock">
\r
3152 <div class="content">
\r
3153 <pre><code>Data stack: ( tfa -- cfa )</code></pre>
\r
3155 <div class="paragraph"><p>"TFA>CFA" is a function word that pushes word cfa of the given tfa.</p></div>
\r
3156 <div class="exampleblock">
\r
3157 <div class="content">
\r
3158 <div class="sidebarblock">
\r
3159 <div class="content">
\r
3160 <div class="title">Definition concept for TFA>CFA</div>
\r
3161 <div class="paragraph"><p>: TFA>CFA 8 + @ ;</p></div>
\r
3164 <div style="text-align:center">
\r
3165 _______________________________________________________
\r
3167 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>
\r
3169 <div class="sect2">
\r
3170 <h3 id="_word_tfa_gt_dfa">Word: TFA>DFA</h3>
\r
3171 <div class="literalblock">
\r
3172 <div class="content">
\r
3173 <pre><code>Data stack: ( tfa -- dfa )</code></pre>
\r
3175 <div class="paragraph"><p>"TFA>DFA" is a function word that pushes word dfa of the given tfa.</p></div>
\r
3176 <div class="exampleblock">
\r
3177 <div class="content">
\r
3178 <div class="sidebarblock">
\r
3179 <div class="content">
\r
3180 <div class="title">Definition concept for TFA>DFA</div>
\r
3181 <div class="paragraph"><p>: TFA>DFA TFA>CFA 8 + ;</p></div>
\r
3184 <div style="text-align:center">
\r
3185 _______________________________________________________
\r
3187 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>
\r
3189 <div class="sect2">
\r
3190 <h3 id="_word_tfa_gt_flags">Word: TFA>FLAGS@</h3>
\r
3191 <div class="literalblock">
\r
3192 <div class="content">
\r
3193 <pre><code>Data stack: ( tfa -- flags )</code></pre>
\r
3195 <div class="paragraph"><p>"TFA>FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>
\r
3196 <div class="exampleblock">
\r
3197 <div class="content">
\r
3198 <div class="sidebarblock">
\r
3199 <div class="content">
\r
3200 <div class="title">Defintion concept for TFA>FLAGS@</div>
\r
3201 <div class="paragraph"><p>: TFA>FLAGS@ 16 + @ ;</p></div>
\r
3204 <div style="text-align:center">
\r
3205 _______________________________________________________
\r
3207 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>
\r
3209 <div class="sect2">
\r
3210 <h3 id="_word_tfa_gt_namez">Word: TFA>NAMEZ</h3>
\r
3211 <div class="literalblock">
\r
3212 <div class="content">
\r
3213 <pre><code>Data stack: ( tfa -- char* )</code></pre>
\r
3215 <div class="paragraph"><p>"TFA>NAMEZ" is a function word that pushes changes a tfa pointer to a
\r
3216 pointer to the word pname’s character sequence, which is zero
\r
3217 terminated as well as preceded by a length cell.</p></div>
\r
3218 <div class="exampleblock">
\r
3219 <div class="content">
\r
3220 <div class="sidebarblock">
\r
3221 <div class="content">
\r
3222 <div class="title">Defintion concept for TFA>NAMEZ</div>
\r
3223 <div class="paragraph"><p>: TFA>NAMEZ 32 + ;</p></div>
\r
3226 <div style="text-align:center">
\r
3227 _______________________________________________________
\r
3229 <div class="paragraph"><p><a id="p_then"></a></p></div>
\r
3231 <div class="sect2">
\r
3232 <h3 id="_word_then">Word: THEN</h3>
\r
3233 <div class="literalblock">
\r
3234 <div class="content">
\r
3235 <pre><code>Data stack: Compiling: ( a -- )</code></pre>
\r
3237 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with
\r
3238 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution
\r
3239 control. THEN performs the branch resolution for the stacked address
\r
3240 which pinpoints the foot address the branch offset to resolve, so that
\r
3241 at execution time there is an appropriate conditional branch past the
\r
3242 "then-part" or the "else-part" of the "structured statement".</p></div>
\r
3243 <div style="text-align:center">
\r
3244 _______________________________________________________
\r
3246 <div class="paragraph"><p><a id="p_this_word"></a></p></div>
\r
3248 <div class="sect2">
\r
3249 <h3 id="_word_this_word">Word: THIS-WORD</h3>
\r
3250 <div class="literalblock">
\r
3251 <div class="content">
\r
3252 <pre><code>Data stack: ( -- a )</code></pre>
\r
3254 <div class="paragraph"><p>"THIS-WORD" is a variable word used in
\r
3255 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]
\r
3256 values of the successive words being evaluated. This typically points
\r
3257 into the input stream buffer and remain valid until further stream
\r
3258 buffering functions are used.</p></div>
\r
3259 <div style="text-align:center">
\r
3260 _______________________________________________________
\r
3262 <div class="paragraph"><p><a id="p_true"></a></p></div>
\r
3264 <div class="sect2">
\r
3265 <h3 id="_word_true">Word: TRUE</h3>
\r
3266 <div class="literalblock">
\r
3267 <div class="content">
\r
3268 <pre><code>Data stack: ( -- -1 )</code></pre>
\r
3270 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>
\r
3271 <div style="text-align:center">
\r
3272 _______________________________________________________
\r
3274 <div class="paragraph"><p><a id="p_tuck"></a></p></div>
\r
3276 <div class="sect2">
\r
3277 <h3 id="_word_tuck">Word: TUCK</h3>
\r
3278 <div class="literalblock">
\r
3279 <div class="content">
\r
3280 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>
\r
3282 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second
\r
3283 cell on the data stack.</p></div>
\r
3284 <div class="exampleblock">
\r
3285 <div class="content">
\r
3286 <div class="sidebarblock">
\r
3287 <div class="content">
\r
3288 <div class="title">Definition concept for TUCK</div>
\r
3289 <div class="paragraph"><p>: TUCK SWAP OVER ;</p></div>
\r
3292 <div style="text-align:center">
\r
3293 _______________________________________________________
\r
3295 <div class="paragraph"><p><a id="p_unequal"></a></p></div>
\r
3297 <div class="sect2">
\r
3298 <h3 id="_word_19">Word: !=</h3>
\r
3299 <div class="literalblock">
\r
3300 <div class="content">
\r
3301 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
3303 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the
\r
3304 values are unequal, and 0 otherwise.</p></div>
\r
3305 <div style="text-align:center">
\r
3306 _______________________________________________________
\r
3308 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>
\r
3310 <div class="sect2">
\r
3311 <h3 id="_word_verbose">Word: VERBOSE?</h3>
\r
3312 <div class="literalblock">
\r
3313 <div class="content">
\r
3314 <pre><code>Data stack: ( -- a )</code></pre>
\r
3316 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0
\r
3317 signify whether or not the command line arguments includes "-v". When
\r
3318 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more
\r
3319 verbose.</p></div>
\r
3320 <div style="text-align:center">
\r
3321 _______________________________________________________
\r
3323 <div class="paragraph"><p><a id="p_within"></a></p></div>
\r
3325 <div class="sect2">
\r
3326 <h3 id="_word_within">Word: WITHIN</h3>
\r
3327 <div class="literalblock">
\r
3328 <div class="content">
\r
3329 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>
\r
3331 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1
\r
3332 of the the first, v, is within the value range spanned by the second,
\r
3333 lo, inclusive and third, hi, exclusive.</p></div>
\r
3334 <div class="exampleblock">
\r
3335 <div class="content">
\r
3336 <div class="sidebarblock">
\r
3337 <div class="content">
\r
3338 <div class="title">Definition concept for WITHIN</div>
\r
3339 <div class="paragraph"><p>: WITHIN 2 PICK > ROT ROT ⇐ AND ;</p></div>
\r
3342 <div style="text-align:center">
\r
3343 _______________________________________________________
\r
3345 <div class="paragraph"><p><a id="p_words"></a></p></div>
\r
3347 <div class="sect2">
\r
3348 <h3 id="_word_words">Word: WORDS</h3>
\r
3349 <div class="literalblock">
\r
3350 <div class="content">
\r
3351 <pre><code>Data stack: ( wl -- )</code></pre>
\r
3353 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word
\r
3354 list to stdout (file descriptor 1).</p></div>
\r
3355 <div style="text-align:center">
\r
3356 _______________________________________________________
\r
3358 <div class="paragraph"><p><a id="p_xor"></a></p></div>
\r
3360 <div class="sect2">
\r
3361 <h3 id="_word_xor">Word: XOR</h3>
\r
3362 <div class="literalblock">
\r
3363 <div class="content">
\r
3364 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
3366 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise
\r
3367 exclusion; each bit is 1 if the corresponding bits of the two operands
\r
3368 differ and 0 if not.</p></div>
\r
3369 <div style="text-align:center">
\r
3370 _______________________________________________________
\r
3372 <div class="paragraph"><p><a id="return_stack"></a></p></div>
\r
3374 <div class="sect2">
\r
3375 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>
\r
3376 <div class="literalblock">
\r
3377 <div class="content">
\r
3378 <pre><code>Data stack: ( -- a )</code></pre>
\r
3380 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>
\r
3384 <div class="sect1">
\r
3385 <h2 id="_system_calls">System calls</h2>
\r
3386 <div class="sectionbody">
\r
3387 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which
\r
3388 generally are described in their "man pages. This wrapping takes the
\r
3389 arguments fro the data stack in reverse order, i.e. the first argument
\r
3390 is deepest.</p></div>
\r
3391 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>
\r
3395 <div id="footnotes"><hr /></div>
\r
3397 <div id="footer-text">
\r
3399 2021-06-02 01:27:44 AEST
\r
projects / rrq / rrqforth.git / blob