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 style="text-align:center">
\r
909 _______________________________________________________
\r
911 <div class="paragraph"><p><a id="p_0branch"></a></p></div>
\r
913 <div class="sect2">
\r
914 <h3 id="_word_0branch">Word: 0BRANCH</h3>
\r
915 <div class="literalblock">
\r
916 <div class="content">
\r
917 <pre><code>Data stack: ( v -- )</code></pre>
\r
919 <div class="paragraph"><p>"0BRANCH" is a function word that implements execution conditional by
\r
920 means of optionally adding the subsequent branch offset, or not, to
\r
921 the point of execution. If the value, v, is 0 then the branch offset
\r
922 is added, and otherwise execution continues with the cell following
\r
923 the branch offset in the definition.</p></div>
\r
924 <div style="text-align:center">
\r
925 _______________________________________________________
\r
927 <div class="paragraph"><p><a id="p_0equal"></a></p></div>
\r
929 <div class="sect2">
\r
930 <h3 id="_word_0">Word: 0=</h3>
\r
931 <div class="literalblock">
\r
932 <div class="content">
\r
933 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
935 <div class="paragraph"><p>"0=" is a function word that replaces a value with its logical
\r
936 complement; the result is zero if the value non-zero, and the result
\r
937 is non-zero if the value is zero.</p></div>
\r
938 <div class="paragraph"><p>Compare with <a href="#p_not">NOT</a>.</p></div>
\r
939 <div style="text-align:center">
\r
940 _______________________________________________________
\r
942 <div class="paragraph"><p><a id="p_0less"></a></p></div>
\r
944 <div class="sect2">
\r
945 <h3 id="_word_0_lt">Word: 0<</h3>
\r
946 <div class="literalblock">
\r
947 <div class="content">
\r
948 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
950 <div class="paragraph"><p>"0<" is a function word that replaces a value with -1 if the value is
\r
951 less than 0, and 0 otherwise.</p></div>
\r
952 <div class="exampleblock">
\r
953 <div class="content">
\r
954 <div class="listingblock">
\r
955 <div class="title">Definition concept 1: Word: 0<</div>
\r
956 <div class="content">
\r
957 <pre><code>: 0= 0 SWAP < ;</code></pre>
\r
960 <div class="paragraph"><p>See also <a href="#p_swap">SWAP</a> and
\r
961 <a href="#p_lessthan"><</a>.</p></div>
\r
962 <div style="text-align:center">
\r
963 _______________________________________________________
\r
965 <div class="paragraph"><p><a id="p_1branch"></a></p></div>
\r
967 <div class="sect2">
\r
968 <h3 id="_word_1branch">Word: 1BRANCH</h3>
\r
969 <div class="literalblock">
\r
970 <div class="content">
\r
971 <pre><code>Data stack: ( v -- )</code></pre>
\r
973 <div class="paragraph"><p>"1BRANCH" is a function word that implements execution conditional by
\r
974 means of optionally adding the subsequent branch offset, or not, to
\r
975 the point of execution. If the value, v, is non-zero then the branch
\r
976 offset is added, and otherwise execution continues with the cell
\r
977 following the branch offset in the definition.</p></div>
\r
978 <div style="text-align:center">
\r
979 _______________________________________________________
\r
981 <div class="paragraph"><p><a id="p_2drop"></a></p></div>
\r
983 <div class="sect2">
\r
984 <h3 id="_word_2drop">Word: 2DROP</h3>
\r
985 <div class="literalblock">
\r
986 <div class="content">
\r
987 <pre><code>Data stack: ( v1 v2 -- )</code></pre>
\r
989 <div class="paragraph"><p>"2DROP" is a function word that plainly discards the top 2 cells from
\r
990 the data stack.</p></div>
\r
991 <div style="text-align:center">
\r
992 _______________________________________________________
\r
994 <div class="paragraph"><p><a id="p_2dup"></a></p></div>
\r
996 <div class="sect2">
\r
997 <h3 id="_word_2dup">Word: 2DUP</h3>
\r
998 <div class="literalblock">
\r
999 <div class="content">
\r
1000 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 v2 )</code></pre>
\r
1002 <div class="paragraph"><p>"2DUP" is a function word that duplicates the top 2 cells on the data
\r
1004 <div class="exampleblock">
\r
1005 <div class="content">
\r
1006 <div class="listingblock">
\r
1007 <div class="title">Definition concept 2: Word: 2DUP</div>
\r
1008 <div class="content">
\r
1009 <pre><code>: 2DUP OVER OVER ;</code></pre>
\r
1012 <div style="text-align:center">
\r
1013 _______________________________________________________
\r
1015 <div class="paragraph"><p><a id="p_2get"></a></p></div>
\r
1017 <div class="sect2">
\r
1018 <h3 id="_word_2">Word: 2@</h3>
\r
1019 <div class="literalblock">
\r
1020 <div class="content">
\r
1021 <pre><code>Data stack: ( a -- v2 v1 )</code></pre>
\r
1023 <div class="paragraph"><p>"2@" is a function word that pushes the two concecutive values v1 and
\r
1024 v2 from the address a onto the data stack. Value v1 is from address a
\r
1025 and value v2 is from address a + 8.</p></div>
\r
1026 <div style="text-align:center">
\r
1027 _______________________________________________________
\r
1029 <div class="paragraph"><p><a id="p_2over"></a></p></div>
\r
1031 <div class="sect2">
\r
1032 <h3 id="_word_2over">Word: 2OVER</h3>
\r
1033 <div class="literalblock">
\r
1034 <div class="content">
\r
1035 <pre><code>Data stack: ( v1 v2 v3 v4 -- v1 v2 v3 v4 v1 v2 )</code></pre>
\r
1037 <div class="paragraph"><p>"2OVER" is a function word that replicates the second duble-cell pair
\r
1038 onto the top of the data stack. This is similar to <a href="#p_over">OVER</a> but
\r
1039 working with cell pairs rather than single cells.</p></div>
\r
1040 <div class="exampleblock">
\r
1041 <div class="content">
\r
1042 <div class="listingblock">
\r
1043 <div class="title">Definition concept 3: Word: 2OVER</div>
\r
1044 <div class="content">
\r
1045 <pre><code>: 2OVER 3 PICK 3 PICK ;</code></pre>
\r
1048 <div style="text-align:center">
\r
1049 _______________________________________________________
\r
1051 <div class="paragraph"><p><a id="p_2put"></a></p></div>
\r
1053 <div class="sect2">
\r
1054 <h3 id="_word_2_2">Word: 2!</h3>
\r
1055 <div class="literalblock">
\r
1056 <div class="content">
\r
1057 <pre><code>Data stack: ( v2 v1 a -- )</code></pre>
\r
1059 <div class="paragraph"><p>"2!" is a function word that stors two concecutive values v1 and v2 to
\r
1060 the address a from the data stack. Value v1 is stored at address a and
\r
1061 value v2 is stored at address a + 8.</p></div>
\r
1062 <div style="text-align:center">
\r
1063 _______________________________________________________
\r
1065 <div class="paragraph"><p><a id="p_2swap"></a></p></div>
\r
1067 <div class="sect2">
\r
1068 <h3 id="_word_2swap">Word: 2SWAP</h3>
\r
1069 <div class="literalblock">
\r
1070 <div class="content">
\r
1071 <pre><code>Data stack: ( v1 v2 v3 v4 -- v3 v4 v1 v2 )</code></pre>
\r
1073 <div class="paragraph"><p>"2SWAP" is a function word the reorgnizes the top 4 cells swappping
\r
1074 the upper and lower pair. This is similar to <a href="#p_swap">SWAP</a> but
\r
1075 working with cell pairs rather than single cells.</p></div>
\r
1076 <div class="exampleblock">
\r
1077 <div class="content">
\r
1078 <div class="listingblock">
\r
1079 <div class="title">Definition concept 4: Word: 2SWAP</div>
\r
1080 <div class="content">
\r
1081 <pre><code>: 2SWAP 3 ROLL 3 ROOL ;</code></pre>
\r
1084 <div style="text-align:center">
\r
1085 _______________________________________________________
\r
1087 <div class="paragraph"><p><a id="p_Ccomma"></a></p></div>
\r
1089 <div class="sect2">
\r
1090 <h3 id="_word_c">Word: C,</h3>
\r
1091 <div class="literalblock">
\r
1092 <div class="content">
\r
1093 <pre><code>Data stack: ( v -- )</code></pre>
\r
1095 <div class="paragraph"><p>"C," (C-comma) is a function word that puts a byte on the
\r
1096 <a href="#p_here">HERE</a> heap. The least significant byte of the value is put
\r
1097 at the current free head address, which also is incremented.</p></div>
\r
1098 <div class="exampleblock">
\r
1099 <div class="content">
\r
1100 <div class="listingblock">
\r
1101 <div class="title">Definition concept 5: Word: C,</div>
\r
1102 <div class="content">
\r
1103 <pre><code>: C, HERE @ 1 ALLOT C! ; ( v -- ; Claim 1 byte and put lsb value there )</code></pre>
\r
1106 <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
1107 <a href="#p_allot">ALLOT</a>, <a href="#p_Cput">C!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1108 <div style="text-align:center">
\r
1109 _______________________________________________________
\r
1111 <div class="paragraph"><p><a id="p_Cget"></a></p></div>
\r
1113 <div class="sect2">
\r
1114 <h3 id="_word_c_2">Word: C@</h3>
\r
1115 <div class="literalblock">
\r
1116 <div class="content">
\r
1117 <pre><code>Data stack: ( a -- v )</code></pre>
\r
1119 <div class="paragraph"><p>"C@" is a function word that pushes the byte value v from the address a.</p></div>
\r
1120 <div style="text-align:center">
\r
1121 _______________________________________________________
\r
1123 <div class="paragraph"><p><a id="p_Cput"></a></p></div>
\r
1125 <div class="sect2">
\r
1126 <h3 id="_word_c_3">Word: C!</h3>
\r
1127 <div class="literalblock">
\r
1128 <div class="content">
\r
1129 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1131 <div class="paragraph"><p>"C!" is a function word that stores the byte value v (the least
\r
1132 significant byte of the cell) at the address a.</p></div>
\r
1133 <div style="text-align:center">
\r
1134 _______________________________________________________
\r
1136 <div class="paragraph"><p><a id="p_Rget"></a></p></div>
\r
1138 <div class="sect2">
\r
1139 <h3 id="_word_r">Word: R@</h3>
\r
1140 <div class="literalblock">
\r
1141 <div class="content">
\r
1142 <pre><code>Data stack: ( -- v ) Return stack: ( v -- v )</code></pre>
\r
1144 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto
\r
1145 the data stack.</p></div>
\r
1146 <div style="text-align:center">
\r
1147 _______________________________________________________
\r
1149 <div class="paragraph"><p><a id="p_Rgt"></a></p></div>
\r
1151 <div class="sect2">
\r
1152 <h3 id="_word_r_gt">Word: R></h3>
\r
1153 <div class="literalblock">
\r
1154 <div class="content">
\r
1155 <pre><code>Data stack: ( -- v ) Return stack: ( v -- )</code></pre>
\r
1157 <div class="paragraph"><p>"R>" is a function word that "moves" the top return stack value onto
\r
1158 the data stack.</p></div>
\r
1159 <div style="text-align:center">
\r
1160 _______________________________________________________
\r
1162 <div class="paragraph"><p><a id="p_abs"></a></p></div>
\r
1164 <div class="sect2">
\r
1165 <h3 id="_word_abs">Word: ABS</h3>
\r
1166 <div class="literalblock">
\r
1167 <div class="content">
\r
1168 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
1170 <div class="paragraph"><p>"ABS" is a function word that replaces a value with its absolute
\r
1171 value. To that end, the values are 64-bit signed integers.</p></div>
\r
1172 <div style="text-align:center">
\r
1173 _______________________________________________________
\r
1175 <div class="paragraph"><p><a id="p_allot"></a></p></div>
\r
1177 <div class="sect2">
\r
1178 <h3 id="_word_allot">Word: ALLOT</h3>
\r
1179 <div class="literalblock">
\r
1180 <div class="content">
\r
1181 <pre><code>Data stack: ( n -- )</code></pre>
\r
1183 <div class="paragraph"><p>"ALLOT" is a function word that merely increments the <a href="#p_here">HERE</a>
\r
1184 variable with <code>n</code> so as to claim that amount of the heap.</p></div>
\r
1185 <div class="exampleblock">
\r
1186 <div class="content">
\r
1187 <div class="sidebarblock">
\r
1188 <div class="content">
\r
1189 <div class="title">Defintion concept for ALLOT</div>
\r
1190 <div class="paragraph"><p>( n — ) : ALLOT HERE @ + HERE ! ;</p></div>
\r
1193 <div class="exampleblock">
\r
1194 <div class="content">
\r
1195 <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
1197 <div style="text-align:center">
\r
1198 _______________________________________________________
\r
1200 <div class="paragraph"><p><a id="p_and"></a></p></div>
\r
1202 <div class="sect2">
\r
1203 <h3 id="_word_and">Word: AND</h3>
\r
1204 <div class="literalblock">
\r
1205 <div class="content">
\r
1206 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
1208 <div class="paragraph"><p>"AND" is a function word that replaces a value pair with their bitwise
\r
1209 conjunction; each bit is 1 if the corresponding bits of both operands
\r
1210 are 1 and 0 if not.</p></div>
\r
1211 <div style="text-align:center">
\r
1212 _______________________________________________________
\r
1214 <div class="paragraph"><p><a id="p_args"></a></p></div>
\r
1216 <div class="sect2">
\r
1217 <h3 id="_word_main_args">Word: MAIN-ARGS</h3>
\r
1218 <div class="literalblock">
\r
1219 <div class="content">
\r
1220 <pre><code>Data stack: ( -- p[argv** argc] )</code></pre>
\r
1222 <div class="paragraph"><p>"ARGS" is a value word that holds a pointer to the command line data
\r
1223 block which consists of a count cell followed by that many asciiz
\r
1224 pointers and then a 0 cell.</p></div>
\r
1225 <div class="exampleblock">
\r
1226 <div class="content">
\r
1227 <div class="listingblock">
\r
1228 <div class="title">Usage example 2: the command line argument block</div>
\r
1229 <div class="content">
\r
1230 <pre><code>ARGS -> 8 bytes: count of non-zero asciiz pointers following
\r
1231 8 bytes: command name string
\r
1232 8 bytes: first argument string
\r
1234 8 zero</code></pre>
\r
1237 <div style="text-align:center">
\r
1238 _______________________________________________________
\r
1240 <div class="paragraph"><p><a id="p_base"></a></p></div>
\r
1242 <div class="sect2">
\r
1243 <h3 id="_word_base">Word: BASE</h3>
\r
1244 <div class="literalblock">
\r
1245 <div class="content">
\r
1246 <pre><code>Data stack: ( -- a )</code></pre>
\r
1248 <div class="paragraph"><p>"BASE" is a variable word for the numerical base used by input and
\r
1249 output functions, <a href="#p_number">NUMBER</a> and <a href="#p_dot">[p_dot]</a>, when
\r
1250 translating numbers between cell value form and text form. The
\r
1251 numerical base is set to 10 or 16 by <a href="#p_decimal">DECIMAL</a> and
\r
1252 <a href="#p_hex">HEX</a> respectively, and those are the only two bases currently
\r
1253 supported.</p></div>
\r
1254 <div class="paragraph"><p>See also <a href="#p_digits">DIGITS</a>, which holds the mapping table from
\r
1255 digits to text.</p></div>
\r
1256 <div class="exampleblock">
\r
1257 <div class="content">
\r
1258 <div class="paragraph"><div class="title">Usage example 3: claim 16 bytes for variable FOO</div><p>CREATE FOO BASE</p></div>
\r
1260 <div style="text-align:center">
\r
1261 _______________________________________________________
\r
1263 <div class="paragraph"><p><a id="p_begin"></a></p></div>
\r
1265 <div class="sect2">
\r
1266 <h3 id="_word_begin">Word: BEGIN</h3>
\r
1267 <div class="literalblock">
\r
1268 <div class="content">
\r
1269 <pre><code>Data stack: Compiling: ( -- a 0 )</code></pre>
\r
1271 <div class="paragraph"><p>"BEGIN" is an immediate function word that is used together with
\r
1272 <a href="#p_ifbreak">IFBREAK</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
1273 implement structured execution control. BEGIN simply places the
\r
1274 address for resolving branches back to this point during execution,
\r
1275 and then a 0 as a marker so as to allow for an unknown number of block
\r
1276 exit points.</p></div>
\r
1277 <div style="text-align:center">
\r
1278 _______________________________________________________
\r
1280 <div class="paragraph"><p><a id="p_bracketed_quote"></a></p></div>
\r
1282 <div class="sect2">
\r
1283 <h3 id="_word">Word: [']</h3>
\r
1284 <div class="literalblock">
\r
1285 <div class="content">
\r
1286 <pre><code>Data stack: ( -- cfa ) Input stream: word</code></pre>
\r
1288 <div class="paragraph"><p>"[']" is an immediate function word that reads the next word on the
\r
1289 input stream and pushes its cfa.</p></div>
\r
1290 <div style="text-align:center">
\r
1291 _______________________________________________________
\r
1293 <div class="paragraph"><p><a id="p_branch"></a></p></div>
\r
1295 <div class="sect2">
\r
1296 <h3 id="_word_branch">Word: BRANCH</h3>
\r
1297 <div class="literalblock">
\r
1298 <div class="content">
\r
1299 <pre><code>Data stack: ( -- )</code></pre>
\r
1301 <div class="paragraph"><p>"BRANCH" is a function word that implements execution transfer by
\r
1302 means of adding the subsequent branch offset to the point of
\r
1303 execution.</p></div>
\r
1304 <div style="text-align:center">
\r
1305 _______________________________________________________
\r
1307 <div class="paragraph"><p><a id="p_break"></a></p></div>
\r
1309 <div class="sect2">
\r
1310 <h3 id="_word_break">Word: BREAK</h3>
\r
1311 <div class="paragraph"><p>"BREAK" is an immediate function word that lays out an unconditional
\r
1312 branch out of an enclosing xef:p_begin[BEGIN]-<a href="#p_end">END</a> block.
\r
1313 Similar to <a href="#p_ifbreak">IFBREAK</a> it lays out the branch cell
\r
1314 followed by a reserved cell for the branch offset, and inserts the
\r
1315 resolution address just above the required 0 on the data stack.</p></div>
\r
1316 <div style="text-align:center">
\r
1317 _______________________________________________________
\r
1319 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>
\r
1321 <div class="sect2">
\r
1322 <h3 id="_word_calltrace">Word: [calltrace]</h3>
\r
1323 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly
\r
1324 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>
\r
1325 <div style="text-align:center">
\r
1326 _______________________________________________________
\r
1328 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>
\r
1330 <div class="sect2">
\r
1331 <h3 id="_word_cfa_gt_flags">Word: CFA>FLAGS@</h3>
\r
1332 <div class="literalblock">
\r
1333 <div class="content">
\r
1334 <pre><code>Data stack: ( cfa -- flags )</code></pre>
\r
1336 <div class="paragraph"><p>"CFA>FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>
\r
1337 <div class="exampleblock">
\r
1338 <div class="content">
\r
1339 <div class="sidebarblock">
\r
1340 <div class="content">
\r
1341 <div class="title">Defintion concept for CFA>FLAGS@</div>
\r
1342 <div class="paragraph"><p>: CFA>FLAGS@ 16 - @ 16 + ;</p></div>
\r
1345 <div style="text-align:center">
\r
1346 _______________________________________________________
\r
1348 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>
\r
1350 <div class="sect2">
\r
1351 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>
\r
1352 <div class="literalblock">
\r
1353 <div class="content">
\r
1354 <pre><code>Data stack: ( stream -- )</code></pre>
\r
1356 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently
\r
1357 remaining in the buffer for the stream, so that a subsequent read will
\r
1358 pull in more data from its source.</p></div>
\r
1359 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>
\r
1360 <div style="text-align:center">
\r
1361 _______________________________________________________
\r
1363 <div class="paragraph"><p><a id="p_colon"></a></p></div>
\r
1365 <div class="sect2">
\r
1366 <h3 id="_word_3">Word: :</h3>
\r
1367 <div class="literalblock">
\r
1368 <div class="content">
\r
1369 <pre><code>Data stack: ( -- ) Input stream: word</code></pre>
\r
1371 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.
\r
1372 This includes reading the next word for making a new dictionary entry
\r
1373 and setting evaluation state to compiling mode.</p></div>
\r
1374 <div class="exampleblock">
\r
1375 <div class="content">
\r
1376 <div class="listingblock">
\r
1377 <div class="title">Definition concept 6: Word: :</div>
\r
1378 <div class="content">
\r
1379 <pre><code>: : doFORTH READ-WORD CREATE TFA>CFA ! ] ;</code></pre>
\r
1382 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,
\r
1383 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA>CFA</a>, <a href="#p_put">!</a>,
\r
1384 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1385 <div style="text-align:center">
\r
1386 _______________________________________________________
\r
1388 <div class="paragraph"><p><a id="p_comma"></a></p></div>
\r
1390 <div class="sect2">
\r
1391 <h3 id="_word_4">Word: ,</h3>
\r
1392 <div class="literalblock">
\r
1393 <div class="content">
\r
1394 <pre><code>Data stack: ( v -- )</code></pre>
\r
1396 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the
\r
1397 <a href="#p_here">HERE</a> heap.</p></div>
\r
1398 <div class="exampleblock">
\r
1399 <div class="content">
\r
1400 <div class="listingblock">
\r
1401 <div class="title">Definition concept7: Word: ,</div>
\r
1402 <div class="content">
\r
1403 <pre><code>: , HERE @ 8 ALLOT ! ; ( v -- ; Claim 8 bytes and put value there )</code></pre>
\r
1406 <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
1407 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1408 <div style="text-align:center">
\r
1409 _______________________________________________________
\r
1411 <div class="paragraph"><p><a id="p_create"></a></p></div>
\r
1413 <div class="sect2">
\r
1414 <h3 id="_word_create">Word: CREATE</h3>
\r
1415 <div class="literalblock">
\r
1416 <div class="content">
\r
1417 <pre><code>Data stack: ( char* n -- tfa )</code></pre>
\r
1419 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the
\r
1420 indicated [n:char*] print name, and returns the "TFA" (Token Field
\r
1421 Address) of the word. The header memory layout is as follows:</p></div>
\r
1422 <div class="exampleblock">
\r
1423 <div class="content">
\r
1424 <div class="listingblock">
\r
1425 <div class="content">
\r
1426 <pre><code>struct WORD
\r
1427 TFA 8 link ; tfa of previous word
\r
1428 pCFA 8 cfap ; CFA = Code Field Address of this word
\r
1430 PFA 8 length ; length of pname representation
\r
1431 ? pname ; the pname bytes
\r
1432 1 nul ; a forced nul byte following the pname
\r
1433 pTFA 8 tfap ; TFA = Token Field Address of this word
\r
1434 OFF 8 doff ; entry offset for FORTH level execution
\r
1435 CFA 8 doer ; word execution semantics
\r
1436 DFA 0 content ; DFA = Data Field Address
\r
1437 end_struct</code></pre>
\r
1440 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content
\r
1441 as held in the memory space following the DFA (Data Field Address).</p></div>
\r
1442 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for
\r
1443 RRQFORTH execution, as holding a jump address to the assembly code
\r
1444 that implements the particular execution semantics for the word.
\r
1445 "CREATE" will assign this as "dovariable", which makes the word push
\r
1446 its DFA when executed. This is changed to "doforth" for RRQFORTH
\r
1447 function words initiated by ":" (aka "COLON") or changed to "dovalue"
\r
1448 for RRQFORTH constants created by "CONSTANT".</p></div>
\r
1449 <div class="exampleblock">
\r
1450 <div class="content">
\r
1451 <div class="listingblock">
\r
1452 <div class="title">Definition concept 8: Word: CREATE</div>
\r
1453 <div class="content">
\r
1454 <pre><code>HERE @ R> ( save tfa on RS )
\r
1455 R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )
\r
1456 DUP 49 + R@ + , ( pCFA )
\r
1459 HERE @ ROT ROT MEMCPY 0 C, ( pname + NUL )
\r
1462 doVARIABLE ( CFA, default semantics )</code></pre>
\r
1465 <div class="sidebarblock">
\r
1466 <div class="content">
\r
1467 <div class="title">Usage example: a possible definition of CONSTANT</div>
\r
1468 <div class="paragraph"><p>: CONSTANT READ-WORD CREATE TFA>DFA doVALUE OVER 8 - ! ! ;</p></div>
\r
1470 <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
1471 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,
\r
1472 <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
1473 and <a href="#p_dovariable">doVARIABLE</a>,
\r
1474 as well as <a href="#p_execute">EXECUTE</a>
\r
1475 about the range of "doer" assignments and their meanings.</p></div>
\r
1476 <div style="text-align:center">
\r
1477 _______________________________________________________
\r
1479 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>
\r
1481 <div class="sect2">
\r
1482 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>
\r
1483 <div class="literalblock">
\r
1484 <div class="content">
\r
1485 <pre><code>Data stack: ( -- a )</code></pre>
\r
1487 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the
\r
1488 current word list word for <a href="#p_find">FIND</a> to use finding words. The
\r
1489 word list word content is as follows:</p></div>
\r
1490 <div class="exampleblock">
\r
1491 <div class="content">
\r
1492 <div class="listingblock">
\r
1493 <div class="title">Layout 1: word list word content</div>
\r
1494 <div class="content">
\r
1495 <pre><code> 8 TFA of latest word in the word list
\r
1496 8 DFA of the/a subsequent word list to search through</code></pre>
\r
1499 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends
\r
1500 with the <a href="#p_forth">FORTH</a> word list. Initially the
\r
1501 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>
\r
1502 <div style="text-align:center">
\r
1503 _______________________________________________________
\r
1505 <div class="paragraph"><p><a id="data_stack"></a></p></div>
\r
1507 <div class="sect2">
\r
1508 <h3 id="_word_data_stack">Word: DATA-STACK</h3>
\r
1509 <div class="literalblock">
\r
1510 <div class="content">
\r
1511 <pre><code>Data stack: ( -- a )</code></pre>
\r
1513 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>
\r
1514 <div style="text-align:center">
\r
1515 _______________________________________________________
\r
1517 <div class="paragraph"><p><a id="p_decimal"></a></p></div>
\r
1519 <div class="sect2">
\r
1520 <h3 id="_word_decimal">Word: DECIMAL</h3>
\r
1521 <div class="literalblock">
\r
1522 <div class="content">
\r
1523 <pre><code>Data stack: ( -- )</code></pre>
\r
1525 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>
\r
1526 <div class="exampleblock">
\r
1527 <div class="content">
\r
1528 <div class="listingblock">
\r
1529 <div class="title">Definition concept 9: Word: DECIMAL</div>
\r
1530 <div class="content">
\r
1531 <pre><code>: DECIMAL 10 BASE ! ;</code></pre>
\r
1534 <div style="text-align:center">
\r
1535 _______________________________________________________
\r
1537 <div class="paragraph"><p><a id="p_depth"></a></p></div>
\r
1539 <div class="sect2">
\r
1540 <h3 id="_word_depth">Word: DEPTH</h3>
\r
1541 <div class="literalblock">
\r
1542 <div class="content">
\r
1543 <pre><code>Data stack: ( -- v )</code></pre>
\r
1545 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells
\r
1546 onto the data stack.</p></div>
\r
1547 <div style="text-align:center">
\r
1548 _______________________________________________________
\r
1550 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>
\r
1552 <div class="sect2">
\r
1553 <h3 id="_word_dfa_gt_tfa">Word: DFA>TFA</h3>
\r
1554 <div class="literalblock">
\r
1555 <div class="content">
\r
1556 <pre><code>Data stack: ( dfa -- tfa )</code></pre>
\r
1558 <div class="paragraph"><p>"DFA>TFA" is a function word that pushes word tfa of the given dfa.</p></div>
\r
1559 <div class="exampleblock">
\r
1560 <div class="content">
\r
1561 <div class="sidebarblock">
\r
1562 <div class="content">
\r
1563 <div class="title">Definition concept for DFA>TFA</div>
\r
1564 <div class="paragraph"><p>: DFA>TFA 24 - @ ;</p></div>
\r
1567 <div style="text-align:center">
\r
1568 _______________________________________________________
\r
1570 <div class="paragraph"><p><a id="p_digits"></a></p></div>
\r
1572 <div class="sect2">
\r
1573 <h3 id="_word_digits">Word: DIGITS</h3>
\r
1574 <div class="literalblock">
\r
1575 <div class="content">
\r
1576 <pre><code>Data stack: ( -- a )</code></pre>
\r
1578 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping
\r
1579 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>
\r
1580 <div style="text-align:center">
\r
1581 _______________________________________________________
\r
1583 <div class="paragraph"><p><a id="p_div"></a></p></div>
\r
1585 <div class="sect2">
\r
1586 <h3 id="_word_5">Word: /</h3>
\r
1587 <div class="literalblock">
\r
1588 <div class="content">
\r
1589 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>
\r
1591 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the
\r
1592 results of signed integer division of the first, v1, divided by the
\r
1593 second, v2. To that end, the values are 64-bit signed integers. The
\r
1594 result is the integer quotient, q, and the discarded remainder, r,
\r
1595 where q and r are the respectively largest and smallest integers to
\r
1596 satisfy the formula:</p></div>
\r
1597 <div class="literalblock">
\r
1598 <div class="content">
\r
1599 <pre><code> v1 = q * v2 + r</code></pre>
\r
1601 <div style="text-align:center">
\r
1602 _______________________________________________________
\r
1604 <div class="paragraph"><p><a id="p_divmod"></a></p></div>
\r
1606 <div class="sect2">
\r
1607 <h3 id="_word_mod">Word: /MOD</h3>
\r
1608 <div class="literalblock">
\r
1609 <div class="content">
\r
1610 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>
\r
1612 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values
\r
1613 with the results of signed integer division of the first, v1, divided
\r
1614 by the second, v2. To that end, the values are 64-bit signed integers.
\r
1615 The result is the integer quotient, q, and the remainder, r, where q
\r
1616 and r are the respectively largest and smallest integers to satisfy
\r
1617 the formula:</p></div>
\r
1618 <div class="literalblock">
\r
1619 <div class="content">
\r
1620 <pre><code> v1 = q * v2 + r</code></pre>
\r
1622 <div style="text-align:center">
\r
1623 _______________________________________________________
\r
1625 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>
\r
1627 <div class="sect2">
\r
1628 <h3 id="_word_dodoes">Word: doDOES</h3>
\r
1629 <div class="literalblock">
\r
1630 <div class="content">
\r
1631 <pre><code>Data stack: ( -- a )</code></pre>
\r
1633 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the
\r
1634 <a href="#p_does">[p_does]</a> execution semantics. This is the same as
\r
1635 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word
\r
1636 concerned.</p></div>
\r
1637 <div style="text-align:center">
\r
1638 _______________________________________________________
\r
1640 <div class="paragraph"><p><a id="p_does"></a></p></div>
\r
1642 <div class="sect2">
\r
1643 <h3 id="_word_does_gt">WORD: DOES></h3>
\r
1644 <div class="literalblock">
\r
1645 <div class="content">
\r
1646 <pre><code>Data stack: ( -- )</code></pre>
\r
1648 <div class="paragraph"><p>"DOES>" is a function that in execution mode does nothing but in
\r
1649 compilation mode it changes the execution semantics assignments for
\r
1650 the most recent word to use the <code>dodoes</code> sematics with adjustment
\r
1651 offset to the current heap address. I.e., the word being defined will
\r
1652 have its execution start at whatever comes after "DOES>".</p></div>
\r
1653 <div class="exampleblock">
\r
1654 <div class="content">
\r
1655 <div class="listingblock">
\r
1656 <div class="title">Word: DOES></div>
\r
1657 <div class="content">
\r
1658 <pre><code>: DOES> IMMEDIATE
\r
1659 STATE @ != IF ( only for compilation mode )
\r
1660 CURRENT-WORDLIST @ @ TFA>CFA ( cfa of current word )
\r
1661 doDOES OVER ! ( set up doer )
\r
1662 HERE @ OVER 8 + - SWAP 8 - ! ( set up offset
\r
1667 <div class="paragraph"><p>See also
\r
1668 <a href="#p_put">!</a>,
\r
1669 <a href="#p_unequal">!⇒></a>,
\r
1670 <a href="#p_minus">→></a>,
\r
1671 <a href="#p_get">@</a>,
\r
1672 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
1673 <a href="#p_here">HERE</a>,
\r
1674 <a href="#p_if">IF</a>,
\r
1675 <a href="#p_immediate">IMMEDIATE</a>,
\r
1676 <a href="#p_over">OVER</a>,
\r
1677 <a href="#p_state">STATE</a>,
\r
1678 <a href="#p_swap">SWAP</a>,
\r
1679 <a href="#p_tfa2cfa">TFA>CFA</a>,
\r
1680 <a href="#p_then">THEN</a>,
\r
1681 <a href="#p_dodoes">doDOES</a>,
\r
1682 as well as <a href="#p_execute">EXECUTE</a>
\r
1683 about the range of "doer" assignments and their meanings.</p></div>
\r
1684 <div style="text-align:center">
\r
1685 _______________________________________________________
\r
1687 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>
\r
1689 <div class="sect2">
\r
1690 <h3 id="_word_dofasm">Word: doFASM</h3>
\r
1691 <div class="literalblock">
\r
1692 <div class="content">
\r
1693 <pre><code>Data stack: ( -- a )</code></pre>
\r
1695 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1696 execution semantics for assembly code content.</p></div>
\r
1697 <div style="text-align:center">
\r
1698 _______________________________________________________
\r
1700 <div class="paragraph"><p><a id="p_doforth"></a></p></div>
\r
1702 <div class="sect2">
\r
1703 <h3 id="_word_doforth">Word: doFORTH</h3>
\r
1704 <div class="literalblock">
\r
1705 <div class="content">
\r
1706 <pre><code>Data stack: ( -- a )</code></pre>
\r
1708 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the
\r
1709 RRQFORTH execution semantics.</p></div>
\r
1710 <div style="text-align:center">
\r
1711 _______________________________________________________
\r
1713 <div class="paragraph"><p><a id="p_dostring"></a></p></div>
\r
1715 <div class="sect2">
\r
1716 <h3 id="_word_dostring">Word: doSTRING</h3>
\r
1717 <div class="literalblock">
\r
1718 <div class="content">
\r
1719 <pre><code>Data stack: ( -- a )</code></pre>
\r
1721 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1722 execution semantics for assembly code implemented words. In those
\r
1723 cases the execution leads to the word content.</p></div>
\r
1724 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is
\r
1725 as follows:</p></div>
\r
1726 <div class="listingblock">
\r
1727 <div class="content">
\r
1728 <pre><code> rax = cfa* of word to execute
\r
1729 rsi = cell* in the calling definition, after calling cell
\r
1730 rsp = data stack pointer
\r
1731 rbp = return stack pointer</code></pre>
\r
1733 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>
\r
1734 and <code>rbp</code> are used according to their roles.</p></div>
\r
1735 <div style="text-align:center">
\r
1736 _______________________________________________________
\r
1738 <div class="paragraph"><p><a id="p_dot"></a></p></div>
\r
1740 <div class="sect2">
\r
1741 <h3 id="_word_6">Word: .</h3>
\r
1742 <div class="literalblock">
\r
1743 <div class="content">
\r
1744 <pre><code>Data stack: ( v -- )</code></pre>
\r
1746 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using
\r
1747 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or
\r
1748 <a href="#p_hex">HEX</a>).</p></div>
\r
1749 <div style="text-align:center">
\r
1750 _______________________________________________________
\r
1752 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>
\r
1754 <div class="sect2">
\r
1755 <h3 id="_word_7">Word: "</h3>
\r
1756 <div class="literalblock">
\r
1757 <div class="content">
\r
1758 <pre><code>data stack: ( -- char n ) Input stream: ...."</code></pre>
\r
1760 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream
\r
1761 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the
\r
1762 [n:char*] cell pair for that string.</p></div>
\r
1763 <div style="text-align:center">
\r
1764 _______________________________________________________
\r
1766 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>
\r
1768 <div class="sect2">
\r
1769 <h3 id="_word_dovalue">Word: doVALUE</h3>
\r
1770 <div class="literalblock">
\r
1771 <div class="content">
\r
1772 <pre><code>Data stack: ( -- a )</code></pre>
\r
1774 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the
\r
1775 execution semantics for cell values, which are variables with a single
\r
1776 64-bit cell holding the value.</p></div>
\r
1777 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>
\r
1778 <div class="literalblock">
\r
1779 <div class="content">
\r
1780 <pre><code>Resulting data stack: ( -- v )</code></pre>
\r
1782 <div style="text-align:center">
\r
1783 _______________________________________________________
\r
1785 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>
\r
1787 <div class="sect2">
\r
1788 <h3 id="_word_dovariable">Word: doVARIABLE</h3>
\r
1789 <div class="literalblock">
\r
1790 <div class="content">
\r
1791 <pre><code>Data stack: ( -- a )</code></pre>
\r
1793 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of
\r
1794 the execution semantics for "variables", which basically are markers
\r
1795 into the heap for some number block of memory.</p></div>
\r
1796 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>
\r
1797 <div class="literalblock">
\r
1798 <div class="content">
\r
1799 <pre><code>Resulting data stack: ( -- a )</code></pre>
\r
1801 <div style="text-align:center">
\r
1802 _______________________________________________________
\r
1804 <div class="paragraph"><p><a id="p_drop"></a></p></div>
\r
1806 <div class="sect2">
\r
1807 <h3 id="_word_drop">Word: DROP</h3>
\r
1808 <div class="literalblock">
\r
1809 <div class="content">
\r
1810 <pre><code>Data stack: ( v -- )</code></pre>
\r
1812 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>
\r
1813 <div style="text-align:center">
\r
1814 _______________________________________________________
\r
1816 <div class="paragraph"><p><a id="p_dup"></a></p></div>
\r
1818 <div class="sect2">
\r
1819 <h3 id="_word_dup">Word: DUP</h3>
\r
1820 <div class="literalblock">
\r
1821 <div class="content">
\r
1822 <pre><code>Data stack: ( v -- v v )</code></pre>
\r
1824 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>
\r
1825 <div style="text-align:center">
\r
1826 _______________________________________________________
\r
1828 <div class="paragraph"><p><a id="p_else"></a></p></div>
\r
1830 <div class="sect2">
\r
1831 <h3 id="_word_else">Word: ELSE</h3>
\r
1832 <div class="literalblock">
\r
1833 <div class="content">
\r
1834 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>
\r
1836 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with
\r
1837 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
1838 control. ELSE lays out an unresolved unconditional branch as an ending
\r
1839 for the "then-part" of the structured statement, and it then performs
\r
1840 the branch resolution for the "else-part". To that end it replaces the
\r
1841 stacked address which pin-points the foot address the branch offset to
\r
1842 resolve, so that at execution time there is an appropriate conditional
\r
1843 branch past the "then-part" and the "else-part" of the "structured
\r
1844 statement".</p></div>
\r
1845 <div style="text-align:center">
\r
1846 _______________________________________________________
\r
1848 <div class="paragraph"><p><a id="p_emit"></a></p></div>
\r
1850 <div class="sect2">
\r
1851 <h3 id="_word_emit">Word: EMIT</h3>
\r
1852 <div class="literalblock">
\r
1853 <div class="content">
\r
1854 <pre><code>Data stack: ( c -- )</code></pre>
\r
1856 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to
\r
1857 standard output (file descriptor 1). The character is the least
\r
1858 significant byte of the top cell.</p></div>
\r
1859 <div style="text-align:center">
\r
1860 _______________________________________________________
\r
1862 <div class="paragraph"><p><a id="p_end"></a></p></div>
\r
1864 <div class="sect2">
\r
1865 <h3 id="_word_end">Word: END</h3>
\r
1866 <div class="literalblock">
\r
1867 <div class="content">
\r
1868 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>
\r
1870 <div class="paragraph"><p>"END" is an immediate function word that is used together with
\r
1871 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to
\r
1872 implement structured execution control. END processes the data stack
\r
1873 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the
\r
1874 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>
\r
1875 <div style="text-align:center">
\r
1876 _______________________________________________________
\r
1878 <div class="paragraph"><p><a id="p_equal"></a></p></div>
\r
1880 <div class="sect2">
\r
1881 <h3 id="_word_8">Word: =</h3>
\r
1882 <div class="literalblock">
\r
1883 <div class="content">
\r
1884 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
1886 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the
\r
1887 values are equal, and 0 otherwise.</p></div>
\r
1888 <div style="text-align:center">
\r
1889 _______________________________________________________
\r
1891 <div class="paragraph"><p><a id="p_erase"></a></p></div>
\r
1893 <div class="sect2">
\r
1894 <h3 id="_word_erase">Word: ERASE</h3>
\r
1895 <div class="literalblock">
\r
1896 <div class="content">
\r
1897 <pre><code>Data stack: ( a n -- )</code></pre>
\r
1899 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>
\r
1900 <div style="text-align:center">
\r
1901 _______________________________________________________
\r
1903 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>
\r
1905 <div class="sect2">
\r
1906 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>
\r
1907 <div class="literalblock">
\r
1908 <div class="content">
\r
1909 <pre><code>Data stack: ( stream -- ??? 0/1 ) Input stream: ......</code></pre>
\r
1911 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by
\r
1912 whitespace from the stream until it discovers an unknown word, or the
\r
1913 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are
\r
1914 either executed or compiled, and all ther stack and heap effects are
\r
1915 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the
\r
1916 stack to respectively indicate that the last word was unkown, i.e. not
\r
1917 found (<a href="#p_find">FIND</a>) in the current word list
\r
1918 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a
\r
1919 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>
\r
1920 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known
\r
1921 words that are parsed into cell values. If interpreting, then the
\r
1922 value is left on the stack. If compiling, then the value is added to
\r
1923 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done
\r
1924 so as to make that value be push to the data stack upon a later
\r
1925 execution.</p></div>
\r
1926 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a
\r
1927 minus sign.</p></div>
\r
1928 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its
\r
1929 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word
\r
1930 or not, and whether the state at the time of execution indicates
\r
1931 "compiling" of "interpreting". Immediate words are executed in both
\r
1932 interpreting and compiling state, while other words have their CFA get
\r
1933 added to the heap so as to gain their execution effect upon a later
\r
1934 execution.</p></div>
\r
1935 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return
\r
1936 stack while reading, parsing and executing.</p></div>
\r
1937 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds
\r
1938 the [n:chars] reference of the offending word in the stream buffer.</p></div>
\r
1939 <div class="exampleblock">
\r
1940 <div class="content">
\r
1941 <div class="listingblock">
\r
1942 <div class="title">Definition concept 10: Word: EVALUATE-STREAM</div>
\r
1943 <div class="content">
\r
1944 <pre><code>( too complex to include here )</code></pre>
\r
1947 <div style="text-align:center">
\r
1948 _______________________________________________________
\r
1950 <div class="paragraph"><p><a id="p_execute"></a></p></div>
\r
1952 <div class="sect2">
\r
1953 <h3 id="_word_execute">Word: EXECUTE</h3>
\r
1954 <div class="literalblock">
\r
1955 <div class="content">
\r
1956 <pre><code>Data stack: ( cfa -- )</code></pre>
\r
1958 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the
\r
1959 indicated "Code Field Address", which typically is the CFA of an
\r
1960 RRQFORTH word with the CFA cell containing a jump address for the code
\r
1961 that implements the execution semnatics of the word.</p></div>
\r
1962 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>
\r
1963 <div class="ulist"><ul>
\r
1966 assembler implemented words constitute their own execution
\r
1972 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word
\r
1973 content as a succession of cells that hold the cfa pointers for the
\r
1974 words that make of the definition. As is customary in FORTH
\r
1975 machines, the advance through that succession is provided by each
\r
1976 word code ending making an explicit jump to its successor. The
\r
1977 <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking
\r
1978 the nesting of FORTH executions by saving the "addresses" of the
\r
1984 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH
\r
1985 execution somewhere within a definition rather than at the
\r
1991 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement
\r
1992 different common ways of using word content other the as FORTH
\r
1997 <div style="text-align:center">
\r
1998 _______________________________________________________
\r
2000 <div class="paragraph"><p><a id="p_exit"></a></p></div>
\r
2002 <div class="sect2">
\r
2003 <h3 id="_word_exit">Word: EXIT</h3>
\r
2004 <div class="literalblock">
\r
2005 <div class="content">
\r
2006 <pre><code>Data stack: ( -- )</code></pre>
\r
2008 <div class="paragraph"><p>"EXIT" is a function word that implements the ending of a FORTH
\r
2009 definition and its threading to the subsequent step of the calling
\r
2010 definition.</p></div>
\r
2011 <div style="text-align:center">
\r
2012 _______________________________________________________
\r
2014 <div class="paragraph"><p><a id="p_false"></a></p></div>
\r
2016 <div class="sect2">
\r
2017 <h3 id="_word_false">Word: FALSE</h3>
\r
2018 <div class="literalblock">
\r
2019 <div class="content">
\r
2020 <pre><code>Data stack: ( -- 0 )</code></pre>
\r
2022 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>
\r
2023 <div style="text-align:center">
\r
2024 _______________________________________________________
\r
2026 <div class="paragraph"><p><a id="p_find"></a></p></div>
\r
2028 <div class="sect2">
\r
2029 <h3 id="_word_find">Word: FIND</h3>
\r
2030 <div class="literalblock">
\r
2031 <div class="content">
\r
2032 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>
\r
2034 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search
\r
2035 path for the given [n:char*] word, and returns the TFA of the matching
\r
2036 word if any. Otherwise FIND preserves the initial data stack but adds
\r
2037 0 to it.</p></div>
\r
2038 <div class="paragraph"><p>The word is sought starting with the
\r
2039 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first
\r
2040 occurence of a match. If not found, the search continues with the
\r
2041 subsequent word list, and so on.</p></div>
\r
2042 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the
\r
2043 [n:char*] double cell string pointer and pushing (only) the TFA of the
\r
2044 matching word instead.</p></div>
\r
2045 <div style="text-align:center">
\r
2046 _______________________________________________________
\r
2048 <div class="paragraph"><p><a id="p_forth"></a></p></div>
\r
2050 <div class="sect2">
\r
2051 <h3 id="_word_forth">Word: FORTH</h3>
\r
2052 <div class="literalblock">
\r
2053 <div class="content">
\r
2054 <pre><code>data stack: ( -- a )</code></pre>
\r
2056 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not
\r
2057 have any subsequent word list.</p></div>
\r
2058 <div style="text-align:center">
\r
2059 _______________________________________________________
\r
2061 <div class="paragraph"><p><a id="p_get"></a></p></div>
\r
2063 <div class="sect2">
\r
2064 <h3 id="_word_9">Word: @</h3>
\r
2065 <div class="literalblock">
\r
2066 <div class="content">
\r
2067 <pre><code>Data stack: ( a -- v )</code></pre>
\r
2069 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>
\r
2070 <div style="text-align:center">
\r
2071 _______________________________________________________
\r
2073 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>
\r
2075 <div class="sect2">
\r
2076 <h3 id="_word_n">Word: @n--</h3>
\r
2077 <div class="literalblock">
\r
2078 <div class="content">
\r
2079 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2081 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,
\r
2082 then decrements the cell at that address by n.</p></div>
\r
2083 <div class="exampleblock">
\r
2084 <div class="content">
\r
2085 <div class="listingblock">
\r
2086 <div class="title">Defintion concept 11Word: @n++</div>
\r
2087 <div class="content">
\r
2088 <pre><code>: @n++ OVER @ DUP ROT - ROT ! ;</code></pre>
\r
2091 <div style="text-align:center">
\r
2092 _______________________________________________________
\r
2094 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>
\r
2096 <div class="sect2">
\r
2097 <h3 id="_word_n_2">Word: @n++</h3>
\r
2098 <div class="literalblock">
\r
2099 <div class="content">
\r
2100 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2102 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,
\r
2103 then increments the cell at that address by n.</p></div>
\r
2104 <div class="exampleblock">
\r
2105 <div class="content">
\r
2106 <div class="sidebarblock">
\r
2107 <div class="content">
\r
2108 <div class="title">Defintion concept for @n++</div>
\r
2109 <div class="paragraph"><p>( a n — v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>
\r
2112 <div style="text-align:center">
\r
2113 _______________________________________________________
\r
2115 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>
\r
2117 <div class="sect2">
\r
2118 <h3 id="_word_gt">Word: >=</h3>
\r
2119 <div class="literalblock">
\r
2120 <div class="content">
\r
2121 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2123 <div class="paragraph"><p>">=" is a function word that replaces a pair of values with -1 if the
\r
2124 first, v1, is greater than or equal to the second, v1, otherwise 0. To
\r
2125 that end, the values are 64-bit signed integers.</p></div>
\r
2126 <div style="text-align:center">
\r
2127 _______________________________________________________
\r
2129 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>
\r
2131 <div class="sect2">
\r
2132 <h3 id="_word_gt_2">Word: ></h3>
\r
2133 <div class="literalblock">
\r
2134 <div class="content">
\r
2135 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2137 <div class="paragraph"><p>">" is a function word that replaces a pair of values with -1 if the
\r
2138 first, v1, is greater than the second, v1, otherwise 0. To that end,
\r
2139 the values are 64-bit signed integers.</p></div>
\r
2140 <div style="text-align:center">
\r
2141 _______________________________________________________
\r
2143 <div class="paragraph"><p><a id="p_gtR"></a></p></div>
\r
2145 <div class="sect2">
\r
2146 <h3 id="_word_gt_r">Word: >R</h3>
\r
2147 <div class="literalblock">
\r
2148 <div class="content">
\r
2149 <pre><code>Data stack: ( v -- ) Return stack: ( -- v )</code></pre>
\r
2151 <div class="paragraph"><p>">R" is a function word that "moves" the top data stack value onto the
\r
2152 return stack.</p></div>
\r
2153 <div style="text-align:center">
\r
2154 _______________________________________________________
\r
2156 <div class="paragraph"><p><a id="p_here"></a></p></div>
\r
2158 <div class="sect2">
\r
2159 <h3 id="_word_here">Word: HERE</h3>
\r
2160 <div class="literalblock">
\r
2161 <div class="content">
\r
2162 <pre><code>Data stack: ( -- a )</code></pre>
\r
2164 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free
\r
2165 allocation space. It get updated by all words that allocate memory.</p></div>
\r
2166 <div class="sidebarblock">
\r
2167 <div class="content">
\r
2168 <div class="title">Usage example</div>
\r
2169 <div class="paragraph"><p>1024 HEAP @ + HEAP ! ( allocate 1024 bytes on the heap )</p></div>
\r
2171 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>
\r
2172 <div style="text-align:center">
\r
2173 _______________________________________________________
\r
2175 <div class="paragraph"><p><a id="p_hex"></a></p></div>
\r
2177 <div class="sect2">
\r
2178 <h3 id="_word_hex">Word: HEX</h3>
\r
2179 <div class="literalblock">
\r
2180 <div class="content">
\r
2181 <pre><code>Data stack: ( -- )</code></pre>
\r
2183 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses
\r
2184 letters a-f as additional digits. (Uppercase letter are also accepted
\r
2185 on input).</p></div>
\r
2186 <div class="exampleblock">
\r
2187 <div class="content">
\r
2188 <div class="listingblock">
\r
2189 <div class="title">Definition concept 12: Word: HEX</div>
\r
2190 <div class="content">
\r
2191 <pre><code>: HEX 16 BASE ! ;</code></pre>
\r
2194 <div style="text-align:center">
\r
2195 _______________________________________________________
\r
2197 <div class="paragraph"><p><a id="p_if"></a></p></div>
\r
2199 <div class="sect2">
\r
2200 <h3 id="_word_if">Word: IF</h3>
\r
2201 <div class="literalblock">
\r
2202 <div class="content">
\r
2203 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2205 <div class="paragraph"><p>"IF" is an immediate function word that is used together with
\r
2206 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2207 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction
\r
2208 with an unresolved branch offset, and places the address for resolving
\r
2209 this instruction on the datastack. This address will then be resolved
\r
2210 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so
\r
2211 that at execution time there is an appropriate conditional branch past
\r
2212 the "then-part" of the "structured statement".</p></div>
\r
2213 <div style="text-align:center">
\r
2214 _______________________________________________________
\r
2216 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>
\r
2218 <div class="sect2">
\r
2219 <h3 id="_word_ifagain">Word: IFAGAIN</h3>
\r
2220 <div class="literalblock">
\r
2221 <div class="content">
\r
2222 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2224 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with
\r
2225 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement
\r
2226 structured execution control. IFAGAIN scans the datastack for the
\r
2227 nearest preceding BEGIN marker and lays out a branch from this point
\r
2228 the beginning of the block during execution.</p></div>
\r
2229 <div style="text-align:center">
\r
2230 _______________________________________________________
\r
2232 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>
\r
2234 <div class="sect2">
\r
2235 <h3 id="_word_ifbreak">Word: IFBREAK</h3>
\r
2236 <div class="literalblock">
\r
2237 <div class="content">
\r
2238 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2240 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with
\r
2241 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
2242 implement structured execution control. IFBREAK simply places the
\r
2243 address for resolving branches from this point the end of the block
\r
2244 during execution.</p></div>
\r
2245 <div style="text-align:center">
\r
2246 _______________________________________________________
\r
2248 <div class="paragraph"><p><a id="p_immediate"></a></p></div>
\r
2250 <div class="sect2">
\r
2251 <h3 id="_word_immediate">Word: IMMEDIATE</h3>
\r
2252 <div class="literalblock">
\r
2253 <div class="content">
\r
2254 <pre><code>Data stack: ( -- )</code></pre>
\r
2256 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of
\r
2257 the most recent word to 1, thereby making that word an immediate word.</p></div>
\r
2258 <div class="exampleblock">
\r
2259 <div class="content">
\r
2260 <div class="listingblock">
\r
2261 <div class="title">Definition concept 13:Word: IMMEDIATE</div>
\r
2262 <div class="content">
\r
2263 <pre><code>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</code></pre>
\r
2266 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
2267 <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
2268 <div style="text-align:center">
\r
2269 _______________________________________________________
\r
2271 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>
\r
2273 <div class="sect2">
\r
2274 <h3 id="_word_10">Word: [</h3>
\r
2275 <div class="literalblock">
\r
2276 <div class="content">
\r
2277 <pre><code>Data stack: ( -- )</code></pre>
\r
2279 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation
\r
2280 mode to be intepreting. In this mode, words are executed immediately
\r
2281 after parsing, by invoking their "doer".</p></div>
\r
2282 <div class="exampleblock">
\r
2283 <div class="content">
\r
2284 <div class="listingblock">
\r
2285 <div class="title">Definition concept 14: Word: [</div>
\r
2286 <div class="content">
\r
2287 <pre><code>: [ IMMEDIATE 0 STATE ! ;</code></pre>
\r
2290 <div style="text-align:center">
\r
2291 _______________________________________________________
\r
2293 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>
\r
2295 <div class="sect2">
\r
2296 <h3 id="_word_lt">Word: <=</h3>
\r
2297 <div class="literalblock">
\r
2298 <div class="content">
\r
2299 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2301 <div class="paragraph"><p>"<=" is a function word that replaces a pair of values with -1 if the
\r
2302 first, v1, is less than or equal to the second, v1, otherwise 0. To
\r
2303 that end, the values are 64-bit signed integers.</p></div>
\r
2304 <div style="text-align:center">
\r
2305 _______________________________________________________
\r
2307 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>
\r
2309 <div class="sect2">
\r
2310 <h3 id="_word_lt_2">Word: <</h3>
\r
2311 <div class="literalblock">
\r
2312 <div class="content">
\r
2313 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2315 <div class="paragraph"><p>"<" is a function word that replaces a pair of values with -1 if the
\r
2316 first, v1, is less than the second, v1, otherwise 0. To that end, the
\r
2317 values are 64-bit signed integers.</p></div>
\r
2318 <div style="text-align:center">
\r
2319 _______________________________________________________
\r
2321 <div class="paragraph"><p><a id="p_literal"></a></p></div>
\r
2323 <div class="sect2">
\r
2324 <h3 id="_word_lit">Word: LIT</h3>
\r
2325 <div class="literalblock">
\r
2326 <div class="content">
\r
2327 <pre><code>Data stack: ( -- v )</code></pre>
\r
2329 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves
\r
2330 excution past that. The literal value is thus layed out as if a
\r
2331 subsequent CFA pointer in the containing definition, and the LIT
\r
2332 execution will make the execution skip past that and instead contine
\r
2333 with the CFA pointer following the value.</p></div>
\r
2334 <div class="paragraph"><p>It’s not a good idea to use "LIT" interactively.</p></div>
\r
2335 <div class="exampleblock">
\r
2336 <div class="content">
\r
2337 <div class="listingblock">
\r
2338 <div class="title">Definition concept 15: Word: LIT</div>
\r
2339 <div class="content">
\r
2340 <pre><code>: LIT R> DUP 8 + >R @ ;</code></pre>
\r
2343 <div style="text-align:center">
\r
2344 _______________________________________________________
\r
2346 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>
\r
2348 <div class="sect2">
\r
2349 <h3 id="_word_s">Word: S"</h3>
\r
2350 <div class="literalblock">
\r
2351 <div class="content">
\r
2352 <pre><code>Data stack: ( -- chars* n )</code></pre>
\r
2354 <div class="paragraph"><p>"S"" is a function word that pushes the [n:char] pointer for a string
\r
2355 inlined subsequently to it in the containing definition. This is
\r
2356 similar to <a href="#p_lit">LIT</a> but for a string literal.</p></div>
\r
2357 <div class="exampleblock">
\r
2358 <div class="content">
\r
2359 <div class="listingblock">
\r
2360 <div class="title">Definition concept 16: Word: LIT</div>
\r
2361 <div class="content">
\r
2362 <pre><code>: LIT R> DUP @ 2DUP + 8 + >R SWAP 8 + SWAP ;</code></pre>
\r
2365 <div style="text-align:center">
\r
2366 _______________________________________________________
\r
2368 <div class="paragraph"><p><a id="p_load_file_quote"></a></p></div>
\r
2370 <div class="sect2">
\r
2371 <h3 id="_word_load_file">Word: LOAD-FILE"</h3>
\r
2372 <div class="literalblock">
\r
2373 <div class="content">
\r
2374 <pre><code>data stack: ( "name" -- )</code></pre>
\r
2376 <div class="paragraph"><p>"LOAD-FILE"" is a function word that opens a file via
\r
2377 <a href="#p_open_file_quote">OPEN-FILE"</a>, allocates a stream buffer of 15000
\r
2378 bytes for reading it, saves the stream pointer as value for the newly
\r
2379 created filename variable, and then it invokes
\r
2380 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing the file.</p></div>
\r
2381 <div style="text-align:center">
\r
2382 _______________________________________________________
\r
2384 <div class="paragraph"><p><a id="p_lparen"></a></p></div>
\r
2386 <div class="sect2">
\r
2387 <h3 id="_word_11">Word: (</h3>
\r
2388 <div class="literalblock">
\r
2389 <div class="content">
\r
2390 <pre><code>Data stack: ( -- )</code></pre>
\r
2392 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words
\r
2393 until the next right parenthesis, or the end of the stream. This is
\r
2394 used for comments in RRQFORTH code.</p></div>
\r
2395 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have
\r
2396 whitespace before and after it.</p></div>
\r
2397 <div style="text-align:center">
\r
2398 _______________________________________________________
\r
2400 <div class="paragraph"><p><a id="p_malloc"></a></p></div>
\r
2402 <div class="sect2">
\r
2403 <h3 id="_word_malloc">Word: MALLOC</h3>
\r
2404 <div class="literalblock">
\r
2405 <div class="content">
\r
2406 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2408 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n
\r
2409 bytes and returns the lowest address of the allocated block.</p></div>
\r
2410 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2411 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2412 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC
\r
2413 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man
\r
2414 page" of mmap for details.</p></div>
\r
2415 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>
\r
2416 <div style="text-align:center">
\r
2417 _______________________________________________________
\r
2419 <div class="paragraph"><p><a id="p_minus"></a></p></div>
\r
2421 <div class="sect2">
\r
2422 <h3 id="_word_12">Word: -</h3>
\r
2423 <div class="literalblock">
\r
2424 <div class="content">
\r
2425 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2427 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the
\r
2428 result of reducing the first, v1, with the second, v2. To that end,
\r
2429 the values are 64-bit signed integers.</p></div>
\r
2430 <div style="text-align:center">
\r
2431 _______________________________________________________
\r
2433 <div class="paragraph"><p><a id="p_mult"></a></p></div>
\r
2435 <div class="sect2">
\r
2436 <h3 id="_word_13">Word: *</h3>
\r
2437 <div class="literalblock">
\r
2438 <div class="content">
\r
2439 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2441 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result
\r
2442 of multiplying them. To that end, the values are 64-bit signed
\r
2443 integers, and clipping the result to the least signifcant 64 bits.</p></div>
\r
2444 <div style="text-align:center">
\r
2445 _______________________________________________________
\r
2447 <div class="paragraph"><p><a id="p_negate"></a></p></div>
\r
2449 <div class="sect2">
\r
2450 <h3 id="_word_negate">Word: NEGATE</h3>
\r
2451 <div class="literalblock">
\r
2452 <div class="content">
\r
2453 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2455 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its
\r
2456 2’s-complement negation. To that end, the values are 64-bit signed
\r
2457 integers.</p></div>
\r
2458 <div style="text-align:center">
\r
2459 _______________________________________________________
\r
2461 <div class="paragraph"><p><a id="p_nip"></a></p></div>
\r
2463 <div class="sect2">
\r
2464 <h3 id="_word_nip">Word: NIP</h3>
\r
2465 <div class="literalblock">
\r
2466 <div class="content">
\r
2467 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>
\r
2469 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells
\r
2470 on the data stack.</p></div>
\r
2471 <div class="exampleblock">
\r
2472 <div class="content">
\r
2473 <div class="listingblock">
\r
2474 <div class="title">Definition concept 17: Word: NIP</div>
\r
2475 <div class="content">
\r
2476 <pre><code>: NIP SWAP DROP ;</code></pre>
\r
2479 <div style="text-align:center">
\r
2480 _______________________________________________________
\r
2482 <div class="paragraph"><p><a id="p_nl"></a></p></div>
\r
2484 <div class="sect2">
\r
2485 <h3 id="_word_nl">Word: NL</h3>
\r
2486 <div class="literalblock">
\r
2487 <div class="content">
\r
2488 <pre><code>Data stack: ( -- v )</code></pre>
\r
2490 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>
\r
2491 <div style="text-align:center">
\r
2492 _______________________________________________________
\r
2494 <div class="paragraph"><p><a id="p_not"></a></p></div>
\r
2496 <div class="sect2">
\r
2497 <h3 id="_word_not">Word: NOT</h3>
\r
2498 <div class="literalblock">
\r
2499 <div class="content">
\r
2500 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2502 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise
\r
2503 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>
\r
2504 <div class="paragraph"><p>Compare with <<p_0equal,0⇒>.</p></div>
\r
2505 <div style="text-align:center">
\r
2506 _______________________________________________________
\r
2508 <div class="paragraph"><p><a id="p_number"></a></p></div>
\r
2510 <div class="sect2">
\r
2511 <h3 id="_word_number">Word: NUMBER</h3>
\r
2512 <div class="literalblock">
\r
2513 <div class="content">
\r
2514 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>
\r
2516 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using
\r
2517 <a href="#p_base">BASE</a> as numerical base, then returns the result number and
\r
2518 a 1 on top, or just a 0 if the word didn’t parse.</p></div>
\r
2519 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in
\r
2520 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>
\r
2521 base, letters a-f or A-F for values 10-15. I.e. the normal positive or
\r
2522 negative decimal integers or normal (positive only) hexadecimal
\r
2523 integers.</p></div>
\r
2524 <div class="exampleblock">
\r
2525 <div class="content">
\r
2526 <div class="listingblock">
\r
2527 <div class="title">Definition concept 18: Word: NUMBER</div>
\r
2528 <div class="content">
\r
2529 <pre><code>( too complex to include here )</code></pre>
\r
2532 <div style="text-align:center">
\r
2533 _______________________________________________________
\r
2535 <div class="paragraph"><p><a id="p_open_file_quote"></a></p></div>
\r
2537 <div class="sect2">
\r
2538 <h3 id="_word_open_file">Word: OPEN-FILE"</h3>
\r
2539 <div class="literalblock">
\r
2540 <div class="content">
\r
2541 <pre><code>Data stack: ( "name" -- fd )</code></pre>
\r
2543 <div class="paragraph"><p>"OPEN-FILE"" is a function word that reads the intputstream for a
\r
2544 filename, adds that to the dictionary as a no-content variable, opens
\r
2545 that file and returns the input file descriptor.</p></div>
\r
2546 <div style="text-align:center">
\r
2547 _______________________________________________________
\r
2549 <div class="paragraph"><p><a id="p_or"></a></p></div>
\r
2551 <div class="sect2">
\r
2552 <h3 id="_word_or">Word: OR</h3>
\r
2553 <div class="literalblock">
\r
2554 <div class="content">
\r
2555 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2557 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise
\r
2558 disjunction; each bit is 1 if the corresponding bits of any operand
\r
2559 is 1 and 0 if not.</p></div>
\r
2560 <div style="text-align:center">
\r
2561 _______________________________________________________
\r
2563 <div class="paragraph"><p><a id="p_over"></a></p></div>
\r
2565 <div class="sect2">
\r
2566 <h3 id="_word_over">Word: OVER</h3>
\r
2567 <div class="literalblock">
\r
2568 <div class="content">
\r
2569 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>
\r
2571 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on
\r
2572 the data stack.</p></div>
\r
2573 <div style="text-align:center">
\r
2574 _______________________________________________________
\r
2576 <div class="paragraph"><p><a id="p_pad"></a></p></div>
\r
2578 <div class="sect2">
\r
2579 <h3 id="_word_pad">Word: PAD</h3>
\r
2580 <div class="literalblock">
\r
2581 <div class="content">
\r
2582 <pre><code>Data stack: ( -- a )</code></pre>
\r
2584 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by
\r
2585 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>
\r
2586 <div style="text-align:center">
\r
2587 _______________________________________________________
\r
2589 <div class="paragraph"><p><a id="p_pick"></a></p></div>
\r
2591 <div class="sect2">
\r
2592 <h3 id="_word_pick">Word: PICK</h3>
\r
2593 <div class="literalblock">
\r
2594 <div class="content">
\r
2595 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>
\r
2597 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down
\r
2598 from top onto the data stack. 0 indicates the top cell making it the
\r
2599 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it
\r
2600 the same as <a href="#p_over">OVER</a>.</p></div>
\r
2601 <div style="text-align:center">
\r
2602 _______________________________________________________
\r
2604 <div class="paragraph"><p><a id="p_plus"></a></p></div>
\r
2606 <div class="sect2">
\r
2607 <h3 id="_word_43">Word: +</h3>
\r
2608 <div class="literalblock">
\r
2609 <div class="content">
\r
2610 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2612 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the
\r
2613 result of adding them. To that end, the values are 64-bit signed
\r
2614 integers.</p></div>
\r
2615 <div style="text-align:center">
\r
2616 _______________________________________________________
\r
2618 <div class="paragraph"><p><a id="p_program_version"></a></p></div>
\r
2620 <div class="sect2">
\r
2621 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>
\r
2622 <div class="literalblock">
\r
2623 <div class="content">
\r
2624 <pre><code>Data stack: ( -- char* length )</code></pre>
\r
2626 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>
\r
2627 <div style="text-align:center">
\r
2628 _______________________________________________________
\r
2630 <div class="paragraph"><p><a id="p_put"></a></p></div>
\r
2632 <div class="sect2">
\r
2633 <h3 id="_word_14">Word: !</h3>
\r
2634 <div class="literalblock">
\r
2635 <div class="content">
\r
2636 <pre><code>Data stack: ( v a -- )</code></pre>
\r
2638 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>
\r
2639 <div style="text-align:center">
\r
2640 _______________________________________________________
\r
2642 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>
\r
2644 <div class="sect2">
\r
2645 <h3 id="_word_15">Word: !+</h3>
\r
2646 <div class="literalblock">
\r
2647 <div class="content">
\r
2648 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2650 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>
\r
2651 <div class="exampleblock">
\r
2652 <div class="content">
\r
2653 <div class="sidebarblock">
\r
2654 <div class="content">
\r
2655 <div class="title">definition concept for !+</div>
\r
2656 <div class="paragraph"><p>( a n — ) : !+ OVER @ + SWAP ! ;</p></div>
\r
2659 <div style="text-align:center">
\r
2660 _______________________________________________________
\r
2662 <div class="paragraph"><p><a id="p_quit"></a></p></div>
\r
2664 <div class="sect2">
\r
2665 <h3 id="_word_quit">Word: QUIT</h3>
\r
2666 <div class="literalblock">
\r
2667 <div class="content">
\r
2668 <pre><code>Data stack: ??</code></pre>
\r
2670 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of
\r
2671 RRQFORTH. First it resets the stacks to their original settings, and
\r
2672 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and
\r
2673 executing them.</p></div>
\r
2674 <div style="text-align:center">
\r
2675 _______________________________________________________
\r
2677 <div class="paragraph"><p><a id="p_quote"></a></p></div>
\r
2679 <div class="sect2">
\r
2680 <h3 id="_word_16">Word: '</h3>
\r
2681 <div class="literalblock">
\r
2682 <div class="content">
\r
2683 <pre><code>data stack: ( -- cfa ) Input stream: word</code></pre>
\r
2685 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next
\r
2686 word on the input stream and pushes its cfa.</p></div>
\r
2687 <div style="text-align:center">
\r
2688 _______________________________________________________
\r
2690 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>
\r
2692 <div class="sect2">
\r
2693 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>
\r
2694 <div class="literalblock">
\r
2695 <div class="content">
\r
2696 <pre><code>Data stack: ( stream -- c )</code></pre>
\r
2698 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character
\r
2699 from the given stream buffer, possibly refilling the buffer if it is
\r
2700 backed by a file descriptor. The refill is done by a SYS_READ call
\r
2701 when more characters are needed. The next character is pushed on the
\r
2702 stack, unless the stream is exhausted in which case the -1 is pushed
\r
2703 instead.</p></div>
\r
2704 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>
\r
2705 <div style="text-align:center">
\r
2706 _______________________________________________________
\r
2708 <div class="paragraph"><p><a id="p_read_word"></a></p></div>
\r
2710 <div class="sect2">
\r
2711 <h3 id="_word_read_word">Word: READ-WORD</h3>
\r
2712 <div class="literalblock">
\r
2713 <div class="content">
\r
2714 <pre><code>Data stack: ( stream -- char* n )</code></pre>
\r
2716 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace
\r
2717 separated word from the given stream and returns the [n:char*] duoble
\r
2718 cell pointer for it. The characters of the word are copied to
\r
2719 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>
\r
2720 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>
\r
2721 <div style="text-align:center">
\r
2722 _______________________________________________________
\r
2724 <div class="paragraph"><p><a id="p_realloc"></a></p></div>
\r
2726 <div class="sect2">
\r
2727 <h3 id="_word_realloc">Word: REALLOC</h3>
\r
2728 <div class="literalblock">
\r
2729 <div class="content">
\r
2730 <pre><code>Data stack: ( a m n -- a )</code></pre>
\r
2732 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a
\r
2733 of size m to be size n bytes and returns the lowest address of the
\r
2734 allocated block.</p></div>
\r
2735 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2736 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2737 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>
\r
2738 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>
\r
2739 <div style="text-align:center">
\r
2740 _______________________________________________________
\r
2742 <div class="paragraph"><p>compile.asm: WORD p_right_bracket,<em>]</em>,fasm</p></div>
\r
2743 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>
\r
2745 <div class="sect2">
\r
2746 <h3 id="_word_17">Word: ]</h3>
\r
2747 <div class="literalblock">
\r
2748 <div class="content">
\r
2749 <pre><code>Data stack: ( -- )</code></pre>
\r
2751 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation
\r
2752 mode to be compiling. In this mode words parsed into CFA pointers
\r
2753 which are placed on the heap in the given order, unless the word is
\r
2754 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An
\r
2755 immediate word is executed immediately, and a number is parsed and
\r
2756 left on the stack.</p></div>
\r
2757 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the
\r
2758 wordlist; i.e., the word list may contain definitions for numbers.</p></div>
\r
2759 <div class="exampleblock">
\r
2760 <div class="content">
\r
2761 <div class="listingblock">
\r
2762 <div class="title">Definition concept 19: Word: ]</div>
\r
2763 <div class="content">
\r
2764 <pre><code>: ] 1 STATE ! ;</code></pre>
\r
2767 <div style="text-align:center">
\r
2768 _______________________________________________________
\r
2770 <div class="paragraph"><p><a id="p_roll"></a></p></div>
\r
2772 <div class="sect2">
\r
2773 <h3 id="_word_roll">Word: ROLL</h3>
\r
2774 <div class="literalblock">
\r
2775 <div class="content">
\r
2776 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>
\r
2778 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down
\r
2779 from top onto the data stack while discarding it. 0 indicates the top
\r
2780 cell; 1 indicates the second top cell making it the same as
\r
2781 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as
\r
2782 <a href="#p_rot">ROT</a>.</p></div>
\r
2783 <div style="text-align:center">
\r
2784 _______________________________________________________
\r
2786 <div class="paragraph"><p><a id="p_rot"></a></p></div>
\r
2788 <div class="sect2">
\r
2789 <h3 id="_word_rot">Word: ROT</h3>
\r
2790 <div class="literalblock">
\r
2791 <div class="content">
\r
2792 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>
\r
2794 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells
\r
2795 such that the third becomes the first while the second becomes third
\r
2796 and the first becomes the second.</p></div>
\r
2797 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>
\r
2798 <div style="text-align:center">
\r
2799 _______________________________________________________
\r
2801 <div class="paragraph"><p><a id="p_rsp"></a></p></div>
\r
2803 <div class="sect2">
\r
2804 <h3 id="_word_r_n">Word: R[n]</h3>
\r
2805 <div class="literalblock">
\r
2806 <div class="content">
\r
2807 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2809 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell on
\r
2810 the top return stack value onto the data stack.</p></div>
\r
2811 <div style="text-align:center">
\r
2812 _______________________________________________________
\r
2814 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>
\r
2816 <div class="sect2">
\r
2817 <h3 id="_word_18">Word: ;</h3>
\r
2818 <div class="literalblock">
\r
2819 <div class="content">
\r
2820 <pre><code>Data stack: ( -- )</code></pre>
\r
2822 <div class="paragraph"><p>";" (semi-colon) is a function word that ends a new forth definition
\r
2823 by means of adding an <a href="#p_exit">EXIT</a></p></div>
\r
2824 <div class="exampleblock">
\r
2825 <div class="content">
\r
2826 <div class="listingblock">
\r
2827 <div class="title">Definition concept 20: Word: :</div>
\r
2828 <div class="content">
\r
2829 <pre><code>: ; IMMEDIATE ' EXIT , ;</code></pre>
\r
2832 <div style="text-align:center">
\r
2833 _______________________________________________________
\r
2835 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>
\r
2837 <div class="sect2">
\r
2838 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>
\r
2839 <div class="literalblock">
\r
2840 <div class="content">
\r
2841 <pre><code>Data stack: ( -- a )</code></pre>
\r
2843 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code
\r
2844 sniippet for setting up the signal handling. rrqforth handles SEGV by
\r
2845 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>
\r
2846 <div style="text-align:center">
\r
2847 _______________________________________________________
\r
2849 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>
\r
2851 <div class="sect2">
\r
2852 <h3 id="_word_lt_lt">Word: <<</h3>
\r
2853 <div class="literalblock">
\r
2854 <div class="content">
\r
2855 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2857 <div class="paragraph"><p>"<<" is a function word that shifts value v1 n steps left (i.e.
\r
2858 "moving" bits towards more significant bits) to form value v2.</p></div>
\r
2859 <div style="text-align:center">
\r
2860 _______________________________________________________
\r
2862 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>
\r
2864 <div class="sect2">
\r
2865 <h3 id="_word_gt_gt">Word: >></h3>
\r
2866 <div class="literalblock">
\r
2867 <div class="content">
\r
2868 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2870 <div class="paragraph"><p>">>" is a function word that shifts value v1 n steps right (i.e.
\r
2871 "moving" bits towards less significant bits) to form value v2.</p></div>
\r
2872 <div style="text-align:center">
\r
2873 _______________________________________________________
\r
2875 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>
\r
2877 <div class="sect2">
\r
2878 <h3 id="_word_s_gt_gt">Word: s>></h3>
\r
2879 <div class="literalblock">
\r
2880 <div class="content">
\r
2881 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
2883 <div class="paragraph"><p>"s>>" is a function word that shifts value v1 n steps right (i.e.
\r
2884 "moving" bits towards less significant bits) to form value v2, but
\r
2885 preserving (and copying) the sign bit.</p></div>
\r
2886 <div style="text-align:center">
\r
2887 _______________________________________________________
\r
2889 <div class="paragraph"><p><a id="p_sp"></a></p></div>
\r
2891 <div class="sect2">
\r
2892 <h3 id="_word_sp">Word: SP</h3>
\r
2893 <div class="literalblock">
\r
2894 <div class="content">
\r
2895 <pre><code>Data stack: ( -- v )</code></pre>
\r
2897 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>
\r
2898 <div style="text-align:center">
\r
2899 _______________________________________________________
\r
2901 <div class="paragraph"><p><a id="p_state"></a></p></div>
\r
2903 <div class="sect2">
\r
2904 <h3 id="_word_state">Word: STATE</h3>
\r
2905 <div class="literalblock">
\r
2906 <div class="content">
\r
2907 <pre><code>Data stack: ( -- a )</code></pre>
\r
2909 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in
\r
2910 compiling mode (1) or interpreting (0) mode.</p></div>
\r
2911 <div style="text-align:center">
\r
2912 _______________________________________________________
\r
2914 <div class="paragraph"><p><a id="p_stdin"></a></p></div>
\r
2916 <div class="sect2">
\r
2917 <h3 id="_word_stdin">Word: STDIN</h3>
\r
2918 <div class="literalblock">
\r
2919 <div class="content">
\r
2920 <pre><code>Data stack: ( -- stream )</code></pre>
\r
2922 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the
\r
2923 standard input file descriptor.</p></div>
\r
2924 <div style="text-align:center">
\r
2925 _______________________________________________________
\r
2927 <div class="paragraph"><p><a id="p_stream"></a></p></div>
\r
2929 <div class="sect2">
\r
2930 <h3 id="_word_stream">Word: STREAM</h3>
\r
2931 <div class="literalblock">
\r
2932 <div class="content">
\r
2933 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>
\r
2935 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file
\r
2936 descriptor or for a memory block (of size+data).</p></div>
\r
2937 <div class="sect3">
\r
2938 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>
\r
2939 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size
\r
2940 prefixed by a 32 byte STREAM header of the following layout:</p></div>
\r
2941 <div class="exampleblock">
\r
2942 <div class="content">
\r
2943 <div class="listingblock">
\r
2944 <div class="title">Stream layout 2, for file descriptor</div>
\r
2945 <div class="content">
\r
2946 <pre><code> 8 bytes = size of buffer (excluding the 32 byte header)
\r
2947 8 bytes source file descriptor
\r
2948 8 bytes current fill
\r
2949 8 current read position</code></pre>
\r
2953 <div class="sect3">
\r
2954 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>
\r
2955 <div class="paragraph"><p>A memory block stream is only the header (though allocated via
\r
2956 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the
\r
2957 following layout:</p></div>
\r
2958 <div class="exampleblock">
\r
2959 <div class="content">
\r
2960 <div class="listingblock">
\r
2961 <div class="title">Stream layout 3, for memory block</div>
\r
2962 <div class="content">
\r
2963 <pre><code> 8 bytes = block address
\r
2964 8 -1 (indicates memory block)
\r
2965 8 size of block (taken from the block's first 8 bytes)
\r
2966 8 current read position</code></pre>
\r
2969 <div style="text-align:center">
\r
2970 _______________________________________________________
\r
2972 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>
\r
2975 <div class="sect2">
\r
2976 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>
\r
2977 <div class="literalblock">
\r
2978 <div class="content">
\r
2979 <pre><code>Data stack: ( stream -- n )</code></pre>
\r
2981 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream
\r
2982 buffer for the next non-whitespace character, and returns its position
\r
2983 relative to the end of the buffer. This is done without changing the
\r
2984 stream (or filling it by reading the backing file).</p></div>
\r
2985 <div style="text-align:center">
\r
2986 _______________________________________________________
\r
2988 <div class="paragraph"><p><a id="p_strlen"></a></p></div>
\r
2990 <div class="sect2">
\r
2991 <h3 id="_word_strlen">Word: STRLEN</h3>
\r
2992 <div class="literalblock">
\r
2993 <div class="content">
\r
2994 <pre><code>Data stack: ( s -- n )</code></pre>
\r
2996 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from
\r
2997 s to the first NUL byte and returns that count, n, not including the
\r
2998 NUL byte.</p></div>
\r
2999 <div style="text-align:center">
\r
3000 _______________________________________________________
\r
3002 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>
\r
3004 <div class="sect2">
\r
3005 <h3 id="_word_strncmp">Word: STRNCMP</h3>
\r
3006 <div class="literalblock">
\r
3007 <div class="content">
\r
3008 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>
\r
3010 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of
\r
3011 character sequences s1 and s2, and returns the difference of the first
\r
3012 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters
\r
3013 are the same.</p></div>
\r
3014 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically
\r
3016 v is greater than 0 if [n:s1] is greater than [n:s2],
\r
3017 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>
\r
3018 <div style="text-align:center">
\r
3019 _______________________________________________________
\r
3021 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>
\r
3023 <div class="sect2">
\r
3024 <h3 id="_word_strncpy">Word: STRNCPY</h3>
\r
3025 <div class="literalblock">
\r
3026 <div class="content">
\r
3027 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>
\r
3029 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1
\r
3031 <div style="text-align:center">
\r
3032 _______________________________________________________
\r
3034 <div class="paragraph"><p><a id="p_swap"></a></p></div>
\r
3036 <div class="sect2">
\r
3037 <h3 id="_word_swap">Word: SWAP</h3>
\r
3038 <div class="literalblock">
\r
3039 <div class="content">
\r
3040 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>
\r
3042 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>
\r
3043 <div style="text-align:center">
\r
3044 _______________________________________________________
\r
3046 <div class="paragraph"><p><a id="p_system"></a></p></div>
\r
3048 <div class="sect2">
\r
3049 <h3 id="_word_system">Word: SYSTEM</h3>
\r
3050 <div class="literalblock">
\r
3051 <div class="content">
\r
3052 <pre><code>Data value: ( -- a )</code></pre>
\r
3054 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system
\r
3055 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>
\r
3056 merely as a matter of segregation.</p></div>
\r
3057 <div style="text-align:center">
\r
3058 _______________________________________________________
\r
3060 <div class="paragraph"><p><a id="p_tell"></a></p></div>
\r
3062 <div class="sect2">
\r
3063 <h3 id="_word_tell">Word: TELL</h3>
\r
3064 <div class="literalblock">
\r
3065 <div class="content">
\r
3066 <pre><code>Data stack: ( char* n -- )</code></pre>
\r
3068 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file
\r
3069 descriptor 1).</p></div>
\r
3070 <div style="text-align:center">
\r
3071 _______________________________________________________
\r
3073 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>
\r
3075 <div class="sect2">
\r
3076 <h3 id="_word_terminate0">Word: TERMINATE0</h3>
\r
3077 <div class="literalblock">
\r
3078 <div class="content">
\r
3079 <pre><code>Data stack: ( -- )</code></pre>
\r
3081 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit
\r
3083 <div style="text-align:center">
\r
3084 _______________________________________________________
\r
3086 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>
\r
3088 <div class="sect2">
\r
3089 <h3 id="_word_tfa_gt_cfa">Word: TFA>CFA</h3>
\r
3090 <div class="literalblock">
\r
3091 <div class="content">
\r
3092 <pre><code>Data stack: ( tfa -- cfa )</code></pre>
\r
3094 <div class="paragraph"><p>"TFA>CFA" is a function word that pushes word cfa of the given tfa.</p></div>
\r
3095 <div class="exampleblock">
\r
3096 <div class="content">
\r
3097 <div class="sidebarblock">
\r
3098 <div class="content">
\r
3099 <div class="title">Definition concept for TFA>CFA</div>
\r
3100 <div class="paragraph"><p>: TFA>CFA 8 + @ ;</p></div>
\r
3103 <div style="text-align:center">
\r
3104 _______________________________________________________
\r
3106 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>
\r
3108 <div class="sect2">
\r
3109 <h3 id="_word_tfa_gt_dfa">Word: TFA>DFA</h3>
\r
3110 <div class="literalblock">
\r
3111 <div class="content">
\r
3112 <pre><code>Data stack: ( tfa -- dfa )</code></pre>
\r
3114 <div class="paragraph"><p>"TFA>DFA" is a function word that pushes word dfa of the given tfa.</p></div>
\r
3115 <div class="exampleblock">
\r
3116 <div class="content">
\r
3117 <div class="sidebarblock">
\r
3118 <div class="content">
\r
3119 <div class="title">Definition concept for TFA>DFA</div>
\r
3120 <div class="paragraph"><p>: TFA>DFA TFA>CFA 8 + ;</p></div>
\r
3123 <div style="text-align:center">
\r
3124 _______________________________________________________
\r
3126 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>
\r
3128 <div class="sect2">
\r
3129 <h3 id="_word_tfa_gt_flags">Word: TFA>FLAGS@</h3>
\r
3130 <div class="literalblock">
\r
3131 <div class="content">
\r
3132 <pre><code>Data stack: ( tfa -- flags )</code></pre>
\r
3134 <div class="paragraph"><p>"TFA>FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>
\r
3135 <div class="exampleblock">
\r
3136 <div class="content">
\r
3137 <div class="listingblock">
\r
3138 <div class="title">Defintion concept 21Word: TFA>FLAGS@</div>
\r
3139 <div class="content">
\r
3140 <pre><code>: TFA>FLAGS@ 16 + @ ;</code></pre>
\r
3143 <div style="text-align:center">
\r
3144 _______________________________________________________
\r
3146 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>
\r
3148 <div class="sect2">
\r
3149 <h3 id="_word_tfa_gt_namez">Word: TFA>NAMEZ</h3>
\r
3150 <div class="literalblock">
\r
3151 <div class="content">
\r
3152 <pre><code>Data stack: ( tfa -- char* )</code></pre>
\r
3154 <div class="paragraph"><p>"TFA>NAMEZ" is a function word that pushes changes a tfa pointer to a
\r
3155 pointer to the word pname’s character sequence, which is zero
\r
3156 terminated as well as preceded by a length cell.</p></div>
\r
3157 <div class="exampleblock">
\r
3158 <div class="content">
\r
3159 <div class="listingblock">
\r
3160 <div class="title">Defintion concept for TFA>NAMEZ</div>
\r
3161 <div class="content">
\r
3162 <pre><code>: TFA>NAMEZ 32 + ;</code></pre>
\r
3165 <div style="text-align:center">
\r
3166 _______________________________________________________
\r
3168 <div class="paragraph"><p><a id="p_then"></a></p></div>
\r
3170 <div class="sect2">
\r
3171 <h3 id="_word_then">Word: THEN</h3>
\r
3172 <div class="literalblock">
\r
3173 <div class="content">
\r
3174 <pre><code>Data stack: Compiling: ( a -- )</code></pre>
\r
3176 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with
\r
3177 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution
\r
3178 control. THEN performs the branch resolution for the stacked address
\r
3179 which pinpoints the foot address the branch offset to resolve, so that
\r
3180 at execution time there is an appropriate conditional branch past the
\r
3181 "then-part" or the "else-part" of the "structured statement".</p></div>
\r
3182 <div style="text-align:center">
\r
3183 _______________________________________________________
\r
3185 <div class="paragraph"><p><a id="p_this_word"></a></p></div>
\r
3187 <div class="sect2">
\r
3188 <h3 id="_word_this_word">Word: THIS-WORD</h3>
\r
3189 <div class="literalblock">
\r
3190 <div class="content">
\r
3191 <pre><code>Data stack: ( -- a )</code></pre>
\r
3193 <div class="paragraph"><p>"THIS-WORD" is a variable word used in
\r
3194 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]
\r
3195 values of the successive words being evaluated. This typically points
\r
3196 into the input stream buffer and remain valid until further stream
\r
3197 buffering functions are used.</p></div>
\r
3198 <div style="text-align:center">
\r
3199 _______________________________________________________
\r
3201 <div class="paragraph"><p><a id="p_true"></a></p></div>
\r
3203 <div class="sect2">
\r
3204 <h3 id="_word_true">Word: TRUE</h3>
\r
3205 <div class="literalblock">
\r
3206 <div class="content">
\r
3207 <pre><code>Data stack: ( -- -1 )</code></pre>
\r
3209 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>
\r
3210 <div style="text-align:center">
\r
3211 _______________________________________________________
\r
3213 <div class="paragraph"><p><a id="p_tuck"></a></p></div>
\r
3215 <div class="sect2">
\r
3216 <h3 id="_word_tuck">Word: TUCK</h3>
\r
3217 <div class="literalblock">
\r
3218 <div class="content">
\r
3219 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>
\r
3221 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second
\r
3222 cell on the data stack.</p></div>
\r
3223 <div class="exampleblock">
\r
3224 <div class="content">
\r
3225 <div class="listingblock">
\r
3226 <div class="title">Definition concept 22: Word: TUCK</div>
\r
3227 <div class="content">
\r
3228 <pre><code>: TUCK SWAP OVER ;</code></pre>
\r
3231 <div style="text-align:center">
\r
3232 _______________________________________________________
\r
3234 <div class="paragraph"><p><a id="p_unequal"></a></p></div>
\r
3236 <div class="sect2">
\r
3237 <h3 id="_word_19">Word: !=</h3>
\r
3238 <div class="literalblock">
\r
3239 <div class="content">
\r
3240 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
3242 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the
\r
3243 values are unequal, and 0 otherwise.</p></div>
\r
3244 <div style="text-align:center">
\r
3245 _______________________________________________________
\r
3247 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>
\r
3249 <div class="sect2">
\r
3250 <h3 id="_word_verbose">Word: VERBOSE?</h3>
\r
3251 <div class="literalblock">
\r
3252 <div class="content">
\r
3253 <pre><code>Data stack: ( -- a )</code></pre>
\r
3255 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0
\r
3256 signify whether or not the command line arguments includes "-v". When
\r
3257 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more
\r
3258 verbose.</p></div>
\r
3259 <div style="text-align:center">
\r
3260 _______________________________________________________
\r
3262 <div class="paragraph"><p><a id="p_within"></a></p></div>
\r
3264 <div class="sect2">
\r
3265 <h3 id="_word_within">Word: WITHIN</h3>
\r
3266 <div class="literalblock">
\r
3267 <div class="content">
\r
3268 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>
\r
3270 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1
\r
3271 of the the first, v, is within the value range spanned by the second,
\r
3272 lo, inclusive and third, hi, exclusive.</p></div>
\r
3273 <div class="exampleblock">
\r
3274 <div class="content">
\r
3275 <div class="listingblock">
\r
3276 <div class="title">Definition concept 23: Word: WITHIN</div>
\r
3277 <div class="content">
\r
3278 <pre><code>: WITHIN 2 PICK > ROT ROT <= AND ;</code></pre>
\r
3281 <div style="text-align:center">
\r
3282 _______________________________________________________
\r
3284 <div class="paragraph"><p><a id="p_words"></a></p></div>
\r
3286 <div class="sect2">
\r
3287 <h3 id="_word_words">Word: WORDS</h3>
\r
3288 <div class="literalblock">
\r
3289 <div class="content">
\r
3290 <pre><code>Data stack: ( wl -- )</code></pre>
\r
3292 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word
\r
3293 list to stdout (file descriptor 1).</p></div>
\r
3294 <div style="text-align:center">
\r
3295 _______________________________________________________
\r
3297 <div class="paragraph"><p><a id="p_xor"></a></p></div>
\r
3299 <div class="sect2">
\r
3300 <h3 id="_word_xor">Word: XOR</h3>
\r
3301 <div class="literalblock">
\r
3302 <div class="content">
\r
3303 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
3305 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise
\r
3306 exclusion; each bit is 1 if the corresponding bits of the two operands
\r
3307 differ and 0 if not.</p></div>
\r
3308 <div style="text-align:center">
\r
3309 _______________________________________________________
\r
3311 <div class="paragraph"><p><a id="return_stack"></a></p></div>
\r
3313 <div class="sect2">
\r
3314 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>
\r
3315 <div class="literalblock">
\r
3316 <div class="content">
\r
3317 <pre><code>Data stack: ( -- a )</code></pre>
\r
3319 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>
\r
3323 <div class="sect1">
\r
3324 <h2 id="_system_calls">System calls</h2>
\r
3325 <div class="sectionbody">
\r
3326 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which
\r
3327 generally are described in their "man pages. This wrapping takes the
\r
3328 arguments fro the data stack in reverse order, i.e. the first argument
\r
3329 is deepest.</p></div>
\r
3330 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>
\r
3334 <div id="footnotes"><hr /></div>
\r
3336 <div id="footer-text">
\r
3338 2021-06-02 01:27:44 AEST
\r
projects / rrq / rrqforth.git / blob