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_compile">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_rbpn">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_again">AGAIN</a>  
\r
797 <a href="#p_allot">ALLOT</a>  
\r
798 <a href="#p_and">AND</a>  
\r
799 <a href="#inline_code">[ASM]</a>  </p></div>
\r
800 <div class="paragraph"><p><a href="#p_base">BASE</a>  
\r
801 <a href="#p_begin">BEGIN</a>  
\r
802 <a href="#p_break">BREAK</a>  </p></div>
\r
803 <div class="paragraph"><p><a href="#p_cfa2flags_get">CFA>FLAGS@</a>  
\r
804 <a href="#p_cfa2tfa">CFA>TFA</a>  
\r
805 <a href="#p_clear_stream">CLEAR-STREAM</a>  
\r
806 <a href="#p_create">CREATE</a>  
\r
807 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>  </p></div>
\r
808 <div class="paragraph"><p><a href="#p_decimal">DECIMAL</a>  
\r
809 <a href="#p_definitions">DEFINITIONS</a>  
\r
810 <a href="#p_depth">DEPTH</a>  
\r
811 <a href="#p_digits">DIGITS</a>  
\r
812 <a href="#p_divmod">/MOD</a>  
\r
813 <a href="#p_dfa2tfa">DFA>TFA</a>  
\r
814 <a href="#p_dodoes">doDOES</a>  
\r
815 <a href="#p_does">DOES></a>  
\r
816 <a href="#p_dofasm">doFASM</a>  
\r
817 <a href="#p_doforth">doFORTH</a>  
\r
818 <a href="#p_dostring">doSTRING</a>  
\r
819 <a href="#p_dovalue">doVALUE</a>  
\r
820 <a href="#p_dovariable">doVARIABLE</a>  
\r
821 <a href="#p_drop">DROP</a>  
\r
822 <a href="#p_dup">DUP</a>  </p></div>
\r
823 <div class="paragraph"><p><a href="#p_else">ELSE</a>  
\r
824 <a href="#p_emit">EMIT</a>  
\r
825 <a href="#p_end">END</a>  
\r
826 <a href="#p_erase">ERASE</a>  
\r
827 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>  
\r
828 <a href="#p_execute">EXECUTE</a>  
\r
829 <a href="#p_exit">EXIT</a>  </p></div>
\r
830 <div class="paragraph"><p><a href="#p_false">FALSE</a>  
\r
831 <a href="#p_fdemit">FDEMIT</a>  
\r
832 <a href="#p_fdtell">FDTELL</a>  
\r
833 <a href="#p_find">FIND</a>  
\r
834 <a href="#p_forth">FORTH</a>  </p></div>
\r
835 <div class="paragraph"><p><a href="#p_here">HERE</a>  
\r
836 <a href="#p_hex">HEX</a>  </p></div>
\r
837 <div class="paragraph"><p><a href="#p_if">IF</a>  
\r
838 <a href="#p_ifagain">IFAGAIN</a>  
\r
839 <a href="#p_ifbreak">IFBREAK</a>  
\r
840 <a href="#p_immediate">IMMEDIATE</a>  
\r
841 <a href="#p_input">INPUT</a>  </p></div>
\r
842 <div class="paragraph"><p><a href="#p_literal">LIT</a>  
\r
843 <a href="#p_literal_string">LIT-STRING</a>  
\r
844 <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a>  
\r
845 <a href="#p_load_file">LOAD-FILE</a>  </p></div>
\r
846 <div class="paragraph"><p><a href="#p_args">MAIN-ARGS</a>  
\r
847 <a href="#p_malloc">MALLOC</a>  </p></div>
\r
848 <div class="paragraph"><p><a href="#p_negate">NEGATE</a>  
\r
849 <a href="#p_nip">NIP</a>  
\r
850 <a href="#p_nl">NL</a>  
\r
851 <a href="#p_not">NOT</a>  
\r
852 <a href="#p_number">NUMBER</a>  </p></div>
\r
853 <div class="paragraph"><p><a href="#p_open_file">OPEN-FILE</a>  
\r
854 <a href="#p_or">OR</a>  
\r
855 <a href="#p_over">OVER</a>  </p></div>
\r
856 <div class="paragraph"><p><a href="#p_pad">PAD</a>  
\r
857 <a href="#p_pick">PICK</a>  
\r
858 <a href="#p_program_version">PROGRAM_VERSION</a>  </p></div>
\r
859 <div class="paragraph"><p><a href="#p_quit">QUIT</a>  </p></div>
\r
860 <div class="paragraph"><p><a href="#p_read_stream_char">READ-STREAM-CHAR</a>  
\r
861 <a href="#p_read_word">READ-WORD</a>  
\r
862 <a href="#p_realloc">REALLOC</a>  
\r
863 <a href="#p_return">RETURN</a>  
\r
864 <a href="#p_roll">ROLL</a>  
\r
865 <a href="#p_rot">ROT</a>  
\r
866 <a href="#p_rbp">RSP</a>  </p></div>
\r
867 <div class="paragraph"><p><a href="#p_sp">SP</a>  
\r
868 <a href="#p_state">STATE</a>  
\r
869 <a href="#p_stdin">STDIN</a>  
\r
870 <a href="#p_stream">STREAM</a>  
\r
871 <a href="#p_stream_nchars">STREAM-NCHARS</a>  
\r
872 <a href="#p_str2temp">STR>TEMP</a>  
\r
873 <a href="#p_strlen">STRLEN</a>  
\r
874 <a href="#p_strncmp">STRNCMP</a>  
\r
875 <a href="#p_strncpy">STRNCPY</a>  
\r
876 <a href="#p_swap">SWAP</a>  
\r
877 <a href="#p_system">SYSTEM</a>  </p></div>
\r
878 <div class="paragraph"><p><a href="#p_tell">TELL</a>  
\r
879 <a href="#p_dot_temp">.TEMP</a>  
\r
880 <a href="#p_temp.adoc">TEMP</a>  
\r
881 <a href="#p_tempspace">TEMPSPACE</a>  
\r
882 <a href="#p_terminate0">TERMINATE0</a>  
\r
883 <a href="#p_tfa2cfa">TFA>CFA</a>  
\r
884 <a href="#p_tfa2dfa">TFA>DFA</a>  
\r
885 <a href="#p_tfa2flags_get">TFA>FLAGS@</a>  
\r
886 <a href="#p_tfa2namez">TFA>NAMEZ</a>  
\r
887 <a href="#p_then">THEN</a>  
\r
888 <a href="#p_this_word">THIS-WORD</a>  
\r
889 <a href="#p_true">TRUE</a>  
\r
890 <a href="#p_tuck">TUCK</a>  </p></div>
\r
891 <div class="paragraph"><p><a href="#p_unstream">UNSTREAM</a>  
\r
892 <a href="#p_use">USE</a>  </p></div>
\r
893 <div class="paragraph"><p><a href="#p_verboseQ">VERBOSE?</a>  </p></div>
\r
894 <div class="paragraph"><p><a href="#p_within">WITHIN</a>  
\r
895 <a href="#p_words">WORDS</a>  </p></div>
\r
896 <div class="paragraph"><p><a href="#p_xor">XOR</a>  </p></div>
\r
897 <div class="paragraph"><p><a href="#p_calltrace">[calltrace]</a>  
\r
898 <a href="#p_setup_signals">[setup_signals]</a>  </p></div>
\r
901 <div class="sect1">
\r
902 <h2 id="_word_descriptions">Word Descriptions</h2>
\r
903 <div class="sectionbody">
\r
904 <div class="paragraph"><p><a id="inline_code"></a></p></div>
\r
905 <div class="sect2">
\r
906 <h3 id="_word_asm">Word: [ASM]</h3>
\r
907 <div class="literalblock">
\r
908 <div class="content">
\r
909 <pre><code>data stack: ( -- )</code></pre>
\r
911 <div class="paragraph"><p>"[ASM]" is a function word that introduces inline assembly in an
\r
912 RRQFORTH definition. Such assembly code may return to subsequence
\r
913 RRQFORTH executon by means of the following instruction sequence:</p></div>
\r
914 <div class="exampleblock">
\r
915 <div class="content">
\r
916 <div class="listingblock">
\r
917 <div class="content">
\r
918 <pre><code> mov rsi,forthcode
\r
921 forthcode:</code></pre>
\r
924 <div class="paragraph"><p>Note that the FORTH compiler does not invoke an assembler so any
\r
925 inline assembly code must be provided in its binary form.</p></div>
\r
926 <div style="text-align:center">
\r
927 _______________________________________________________
\r
929 <div class="paragraph"><p><a id="p_0branch"></a></p></div>
\r
931 <div class="sect2">
\r
932 <h3 id="_word_0branch">Word: 0BRANCH</h3>
\r
933 <div class="literalblock">
\r
934 <div class="content">
\r
935 <pre><code>Data stack: ( v -- )</code></pre>
\r
937 <div class="paragraph"><p>"0BRANCH" is a function word that implements execution conditional by
\r
938 means of optionally adding the subsequent branch offset, or not, to
\r
939 the point of execution. If the value, v, is 0 then the branch offset
\r
940 is added, and otherwise execution continues with the cell following
\r
941 the branch offset in the definition.</p></div>
\r
942 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
943 definition take up a cell of 8 bytes. The offset is relative to the
\r
944 cell address immediately subsequent to the offset cell. In other
\r
945 words, offset 0 is not branching anywhere and an offset of -16 would
\r
946 make a tight loop back to the branch instruction itself. The latter
\r
947 would pull data stack values until and including the first non-zero
\r
949 <div class="paragraph"><p>See also <a href="#p_1branch">1BRANCH</a>, <a href="#p_branch">BRANCH</a>, <a href="#p_if">IF</a>,
\r
950 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
951 <div style="text-align:center">
\r
952 _______________________________________________________
\r
954 <div class="paragraph"><p><a id="p_0equal"></a></p></div>
\r
956 <div class="sect2">
\r
957 <h3 id="_word_0">Word: 0=</h3>
\r
958 <div class="literalblock">
\r
959 <div class="content">
\r
960 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
962 <div class="paragraph"><p>"0=" is a function word that replaces a value with its logical
\r
963 complement; the result is zero if the value non-zero, and the result
\r
964 is non-zero if the value is zero.</p></div>
\r
965 <div class="paragraph"><p>This is the same function as <a href="#p_not">NOT</a>.</p></div>
\r
966 <div style="text-align:center">
\r
967 _______________________________________________________
\r
969 <div class="paragraph"><p><a id="p_0less"></a></p></div>
\r
971 <div class="sect2">
\r
972 <h3 id="_word_0_lt">Word: 0<</h3>
\r
973 <div class="literalblock">
\r
974 <div class="content">
\r
975 <pre><code>Data stack: ( v -- 0/-1 )</code></pre>
\r
977 <div class="paragraph"><p>"0<" is a function word that replaces a value with -1 if the value is
\r
978 less than 0, and 0 otherwise.</p></div>
\r
979 <div class="exampleblock">
\r
980 <div class="content">
\r
981 <div class="sidebarblock">
\r
982 <div class="content">
\r
983 <div class="title">Definition concept for 0<</div>
\r
984 <div class="paragraph"><p>( v — 0/1 ) : 0= 0 SWAP < ;</p></div>
\r
987 <div class="paragraph"><p>See also <a href="#p_swap">SWAP</a> and <a href="#p_lessthan"><</a>.</p></div>
\r
988 <div style="text-align:center">
\r
989 _______________________________________________________
\r
991 <div class="paragraph"><p><a id="p_1branch"></a></p></div>
\r
993 <div class="sect2">
\r
994 <h3 id="_word_1branch">Word: 1BRANCH</h3>
\r
995 <div class="literalblock">
\r
996 <div class="content">
\r
997 <pre><code>Data stack: ( v -- )</code></pre>
\r
999 <div class="paragraph"><p>"1BRANCH" is a function word that implements execution conditional by
\r
1000 means of optionally adding the subsequent branch offset, or not, to
\r
1001 the point of execution. If the value, v, is non-zero then the branch
\r
1002 offset is added, and otherwise execution continues with the cell
\r
1003 following the branch offset in the definition.</p></div>
\r
1004 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
1005 definition take up a cell of 8 bytes. The offset is relative to the
\r
1006 cell address immediately subsequent to the offset cell. In other
\r
1007 words, offset 0 is not branching anywhere and an offset of -16 would
\r
1008 make a tight loop back to the branch instruction itself. The latter
\r
1009 would pull data stack values until and including the first zero value.</p></div>
\r
1010 <div class="paragraph"><p>See also <a href="#p_0branch">0BRANCH</a>, <a href="#p_branch">BRANCH</a>, <a href="#p_if">IF</a>,
\r
1011 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1012 <div style="text-align:center">
\r
1013 _______________________________________________________
\r
1015 <div class="paragraph"><p><a id="p_2drop"></a></p></div>
\r
1017 <div class="sect2">
\r
1018 <h3 id="_word_2drop">Word: 2DROP</h3>
\r
1019 <div class="literalblock">
\r
1020 <div class="content">
\r
1021 <pre><code>Data stack: ( v1 v2 -- )</code></pre>
\r
1023 <div class="paragraph"><p>"2DROP" is a function word that plainly discards the top 2 cells from
\r
1024 the data stack.</p></div>
\r
1025 <div style="text-align:center">
\r
1026 _______________________________________________________
\r
1028 <div class="paragraph"><p><a id="p_2dup"></a></p></div>
\r
1030 <div class="sect2">
\r
1031 <h3 id="_word_2dup">Word: 2DUP</h3>
\r
1032 <div class="literalblock">
\r
1033 <div class="content">
\r
1034 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 v2 )</code></pre>
\r
1036 <div class="paragraph"><p>"2DUP" is a function word that duplicates the top 2 cells on the data
\r
1038 <div class="exampleblock">
\r
1039 <div class="content">
\r
1040 <div class="sidebarblock">
\r
1041 <div class="content">
\r
1042 <div class="title">Definition concept for 2DUP</div>
\r
1043 <div class="paragraph"><p>( v1 v2 — v1 v2 v1 v2 ) : 2DUP OVER OVER ;</p></div>
\r
1046 <div style="text-align:center">
\r
1047 _______________________________________________________
\r
1049 <div class="paragraph"><p><a id="p_2get"></a></p></div>
\r
1051 <div class="sect2">
\r
1052 <h3 id="_word_2">Word: 2@</h3>
\r
1053 <div class="literalblock">
\r
1054 <div class="content">
\r
1055 <pre><code>Data stack: ( a -- v2 v1 )</code></pre>
\r
1057 <div class="paragraph"><p>"2@" is a function word that pushes the two concecutive values v1 and
\r
1058 v2 from the address a onto the data stack. Value v1 is from address a
\r
1059 and value v2 is from address a + 8.</p></div>
\r
1060 <div style="text-align:center">
\r
1061 _______________________________________________________
\r
1063 <div class="paragraph"><p><a id="p_2over"></a></p></div>
\r
1065 <div class="sect2">
\r
1066 <h3 id="_word_2over">Word: 2OVER</h3>
\r
1067 <div class="literalblock">
\r
1068 <div class="content">
\r
1069 <pre><code>Data stack: ( v1 v2 v3 v4 -- v1 v2 v3 v4 v1 v2 )</code></pre>
\r
1071 <div class="paragraph"><p>"2OVER" is a function word that replicates the second duble-cell pair
\r
1072 onto the top of the data stack. This is similar to <a href="#p_over">OVER</a> but
\r
1073 working with cell pairs rather than single cells.</p></div>
\r
1074 <div class="exampleblock">
\r
1075 <div class="content">
\r
1076 <div class="sidebarblock">
\r
1077 <div class="content">
\r
1078 <div class="title">Definition concept for 2OVER</div>
\r
1079 <div class="paragraph"><p>( v1 v2 v3 v4 — v1 v2 v3 v4 v1 v2 ) : 2OVER 3 PICK 3 PICK ;</p></div>
\r
1082 <div style="text-align:center">
\r
1083 _______________________________________________________
\r
1085 <div class="paragraph"><p><a id="p_2put"></a></p></div>
\r
1087 <div class="sect2">
\r
1088 <h3 id="_word_2_2">Word: 2!</h3>
\r
1089 <div class="literalblock">
\r
1090 <div class="content">
\r
1091 <pre><code>Data stack: ( v2 v1 a -- )</code></pre>
\r
1093 <div class="paragraph"><p>"2!" is a function word that stors two concecutive values v1 and v2 to
\r
1094 the address a from the data stack. Value v1 is stored at address a and
\r
1095 value v2 is stored at address a + 8.</p></div>
\r
1096 <div style="text-align:center">
\r
1097 _______________________________________________________
\r
1099 <div class="paragraph"><p><a id="p_2swap"></a></p></div>
\r
1101 <div class="sect2">
\r
1102 <h3 id="_word_2swap">Word: 2SWAP</h3>
\r
1103 <div class="literalblock">
\r
1104 <div class="content">
\r
1105 <pre><code>Data stack: ( v1 v2 v3 v4 -- v3 v4 v1 v2 )</code></pre>
\r
1107 <div class="paragraph"><p>"2SWAP" is a function word the reorgnizes the top 4 cells swappping
\r
1108 the upper and lower pair. This is similar to <a href="#p_swap">SWAP</a> but
\r
1109 working with cell pairs rather than single cells.</p></div>
\r
1110 <div class="exampleblock">
\r
1111 <div class="content">
\r
1112 <div class="sidebarblock">
\r
1113 <div class="content">
\r
1114 <div class="title">Definition concept for 2SWAP</div>
\r
1115 <div class="paragraph"><p>( v1 v2 v3 v4 — v3 v4 v1 v2 ) : 2SWAP 3 ROLL 3 ROLL ;</p></div>
\r
1118 <div style="text-align:center">
\r
1119 _______________________________________________________
\r
1121 <div class="paragraph"><p><a id="p_Ccomma"></a></p></div>
\r
1123 <div class="sect2">
\r
1124 <h3 id="_word_c">Word: C,</h3>
\r
1125 <div class="literalblock">
\r
1126 <div class="content">
\r
1127 <pre><code>Data stack: ( v -- )</code></pre>
\r
1129 <div class="paragraph"><p>"C," (C-comma) is a function word that puts a byte on the
\r
1130 <a href="#p_here">HERE</a> heap. The least significant byte of the value is put
\r
1131 at the current free head address, which also is incremented.</p></div>
\r
1132 <div class="exampleblock">
\r
1133 <div class="content">
\r
1134 <div class="sidebarblock">
\r
1135 <div class="content">
\r
1136 <div class="title">Definition concept for C,</div>
\r
1137 <div class="paragraph"><p>: C, HERE @ 1 ALLOT C! ; ( v — ; Claim 1 byte and put lsb value there )</p></div>
\r
1140 <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
1141 <a href="#p_allot">ALLOT</a>, <a href="#p_Cput">C!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1142 <div style="text-align:center">
\r
1143 _______________________________________________________
\r
1145 <div class="paragraph"><p><a id="p_cfa2tfa"></a></p></div>
\r
1147 <div class="sect2">
\r
1148 <h3 id="_word_cfa_gt_tfa">Word: CFA>TFA</h3>
\r
1149 <div class="literalblock">
\r
1150 <div class="content">
\r
1151 <pre><code>Data stack: ( cfa -- tfa )</code></pre>
\r
1153 <div class="paragraph"><p>"CFA>TFA" is a function word that pushes word tfa of the given cfa.</p></div>
\r
1154 <div class="exampleblock">
\r
1155 <div class="content">
\r
1156 <div class="sidebarblock">
\r
1157 <div class="content">
\r
1158 <div class="title">Definition concept for CFA>TFA</div>
\r
1159 <div class="paragraph"><p>: CFA>TFA 14 - @ ;</p></div>
\r
1162 <div style="text-align:center">
\r
1163 _______________________________________________________
\r
1165 <div class="paragraph"><p><a id="p_Cget"></a></p></div>
\r
1167 <div class="sect2">
\r
1168 <h3 id="_word_c_2">Word: C@</h3>
\r
1169 <div class="literalblock">
\r
1170 <div class="content">
\r
1171 <pre><code>Data stack: ( a -- v )</code></pre>
\r
1173 <div class="paragraph"><p>"C@" is a function word that pushes the byte value v from the address a.</p></div>
\r
1174 <div style="text-align:center">
\r
1175 _______________________________________________________
\r
1177 <div class="paragraph"><p><a id="p_Cput"></a></p></div>
\r
1179 <div class="sect2">
\r
1180 <h3 id="_word_c_3">Word: C!</h3>
\r
1181 <div class="literalblock">
\r
1182 <div class="content">
\r
1183 <pre><code>Data stack: ( v a -- )</code></pre>
\r
1185 <div class="paragraph"><p>"C!" is a function word that stores the byte value v (the least
\r
1186 significant byte of the cell) at the address a.</p></div>
\r
1187 <div style="text-align:center">
\r
1188 _______________________________________________________
\r
1190 <div class="paragraph"><p><a id="p_Rget"></a></p></div>
\r
1192 <div class="sect2">
\r
1193 <h3 id="_word_r">Word: R@</h3>
\r
1194 <div class="literalblock">
\r
1195 <div class="content">
\r
1196 <pre><code>Data stack: ( -- v ) Return stack: ( v -- v )</code></pre>
\r
1198 <div class="paragraph"><p>"R@" is a function word that "copies" the top return stack value onto
\r
1199 the data stack.</p></div>
\r
1200 <div style="text-align:center">
\r
1201 _______________________________________________________
\r
1203 <div class="paragraph"><p><a id="p_Rgt"></a></p></div>
\r
1205 <div class="sect2">
\r
1206 <h3 id="_word_r_gt">Word: R></h3>
\r
1207 <div class="literalblock">
\r
1208 <div class="content">
\r
1209 <pre><code>Data stack: ( -- v ) Return stack: ( v -- )</code></pre>
\r
1211 <div class="paragraph"><p>"R>" is a function word that "moves" the top return stack value onto
\r
1212 the data stack.</p></div>
\r
1213 <div style="text-align:center">
\r
1214 _______________________________________________________
\r
1216 <div class="paragraph"><p><a id="p_abs"></a></p></div>
\r
1218 <div class="sect2">
\r
1219 <h3 id="_word_abs">Word: ABS</h3>
\r
1220 <div class="literalblock">
\r
1221 <div class="content">
\r
1222 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
1224 <div class="paragraph"><p>"ABS" is a function word that replaces a value with its absolute
\r
1225 value. To that end, the values are 64-bit signed integers.</p></div>
\r
1226 <div style="text-align:center">
\r
1227 _______________________________________________________
\r
1229 <div class="paragraph"><p><a id="p_again"></a></p></div>
\r
1231 <div class="sect2">
\r
1232 <h3 id="_word_again">Word: AGAIN</h3>
\r
1233 <div class="literalblock">
\r
1234 <div class="content">
\r
1235 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
1237 <div class="paragraph"><p>"AGAIN" is an immediate function word that is used together with
\r
1238 <a href="#p_begin">BEGIN</a> and instead of <a href="#p_end">END</a> to implement structured
\r
1239 execution control. AGAIN scans the datastack for the nearest preceding
\r
1240 BEGIN marker and lays out an unconditional branch from this point the
\r
1241 beginning of the block during execution. It thereafter performs the
\r
1242 <a href="#p_end">END</a> compile action to end the block.</p></div>
\r
1243 <div style="text-align:center">
\r
1244 _______________________________________________________
\r
1246 <div class="paragraph"><p><a id="p_allot"></a></p></div>
\r
1248 <div class="sect2">
\r
1249 <h3 id="_word_allot">Word: ALLOT</h3>
\r
1250 <div class="literalblock">
\r
1251 <div class="content">
\r
1252 <pre><code>Data stack: ( n -- )</code></pre>
\r
1254 <div class="paragraph"><p>"ALLOT" is a function word that merely increments the <a href="#p_here">HERE</a>
\r
1255 variable with <code>n</code> so as to claim that amount of the heap.</p></div>
\r
1256 <div class="exampleblock">
\r
1257 <div class="content">
\r
1258 <div class="sidebarblock">
\r
1259 <div class="content">
\r
1260 <div class="title">Defintion concept for ALLOT</div>
\r
1261 <div class="paragraph"><p>( n — ) : ALLOT HERE @ + HERE ! ;</p></div>
\r
1264 <div class="exampleblock">
\r
1265 <div class="content">
\r
1266 <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
1268 <div style="text-align:center">
\r
1269 _______________________________________________________
\r
1271 <div class="paragraph"><p><a id="p_and"></a></p></div>
\r
1273 <div class="sect2">
\r
1274 <h3 id="_word_and">Word: AND</h3>
\r
1275 <div class="literalblock">
\r
1276 <div class="content">
\r
1277 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
1279 <div class="paragraph"><p>"AND" is a function word that replaces a value pair with their bitwise
\r
1280 conjunction; each bit is 1 if the corresponding bits of both operands
\r
1281 are 1 and 0 if not.</p></div>
\r
1282 <div style="text-align:center">
\r
1283 _______________________________________________________
\r
1285 <div class="paragraph"><p><a id="p_args"></a></p></div>
\r
1287 <div class="sect2">
\r
1288 <h3 id="_word_main_args">Word: MAIN-ARGS</h3>
\r
1289 <div class="literalblock">
\r
1290 <div class="content">
\r
1291 <pre><code>Data stack: ( -- p[argv** argc] )</code></pre>
\r
1293 <div class="paragraph"><p>"ARGS" is a value word that holds a pointer to the command line data
\r
1294 block which consists of a count cell followed by that many asciiz
\r
1295 pointers and then a 0 cell.</p></div>
\r
1296 <div class="exampleblock">
\r
1297 <div class="content">
\r
1298 <div class="listingblock">
\r
1299 <div class="title">Usage example 2: the command line argument block</div>
\r
1300 <div class="content">
\r
1301 <pre><code>ARGS -> 8 bytes: count of non-zero asciiz pointers following
\r
1302 8 bytes: command name string
\r
1303 8 bytes: first argument string
\r
1305 8 zero</code></pre>
\r
1308 <div style="text-align:center">
\r
1309 _______________________________________________________
\r
1311 <div class="paragraph"><p><a id="p_base"></a></p></div>
\r
1313 <div class="sect2">
\r
1314 <h3 id="_word_base">Word: BASE</h3>
\r
1315 <div class="literalblock">
\r
1316 <div class="content">
\r
1317 <pre><code>Data stack: ( -- a )</code></pre>
\r
1319 <div class="paragraph"><p>"BASE" is a variable word for the numerical base used by input and
\r
1320 output functions, <a href="#p_number">NUMBER</a> and <a href="#p_dot">[p_dot]</a>, when
\r
1321 translating numbers between cell value form and text form. The
\r
1322 numerical base is set to 10 or 16 by <a href="#p_decimal">DECIMAL</a> and
\r
1323 <a href="#p_hex">HEX</a> respectively, and those are the only two bases currently
\r
1324 supported.</p></div>
\r
1325 <div class="paragraph"><p>See also <a href="#p_digits">DIGITS</a>, which holds the mapping table from
\r
1326 digits to text.</p></div>
\r
1327 <div style="text-align:center">
\r
1328 _______________________________________________________
\r
1330 <div class="paragraph"><p><a id="p_begin"></a></p></div>
\r
1332 <div class="sect2">
\r
1333 <h3 id="_word_begin">Word: BEGIN</h3>
\r
1334 <div class="literalblock">
\r
1335 <div class="content">
\r
1336 <pre><code>Data stack: Compiling: ( -- a 0 )</code></pre>
\r
1338 <div class="paragraph"><p>"BEGIN" is an immediate function word that is used together with
\r
1339 <a href="#p_ifbreak">IFBREAK</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
1340 implement structured execution control. BEGIN simply places the
\r
1341 address for resolving branches back to this point during execution,
\r
1342 and then a 0 as a marker so as to allow for an unknown number of block
\r
1343 exit points.</p></div>
\r
1344 <div class="exampleblock">
\r
1345 <div class="content">
\r
1346 <div class="listingblock">
\r
1347 <div class="title">Usage example 3:</div>
\r
1348 <div class="content">
\r
1349 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1350 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1353 : WORDS ( wordlist -- ; Print all words of word list )
\r
1363 <div style="text-align:center">
\r
1364 _______________________________________________________
\r
1366 <div class="paragraph"><p><a id="p_bracketed_quote"></a></p></div>
\r
1368 <div class="sect2">
\r
1369 <h3 id="_word">Word: [']</h3>
\r
1370 <div class="literalblock">
\r
1371 <div class="content">
\r
1372 <pre><code>Data stack: ( -- cfa ) Input stream: word</code></pre>
\r
1374 <div class="paragraph"><p>"[']" is an immediate function word that reads the next word on the
\r
1375 input stream and pushes its cfa.</p></div>
\r
1376 <div class="exampleblock">
\r
1377 <div class="content">
\r
1378 <div class="sidebarblock">
\r
1379 <div class="content">
\r
1380 <div class="title">Definition concept for [']</div>
\r
1381 <div class="paragraph"><p>: ['] IMMEDIATE ' ;</p></div>
\r
1384 <div style="text-align:center">
\r
1385 _______________________________________________________
\r
1387 <div class="paragraph"><p><a id="p_branch"></a></p></div>
\r
1389 <div class="sect2">
\r
1390 <h3 id="_word_branch">Word: BRANCH</h3>
\r
1391 <div class="literalblock">
\r
1392 <div class="content">
\r
1393 <pre><code>Data stack: ( -- )</code></pre>
\r
1395 <div class="paragraph"><p>"BRANCH" is a function word that implements execution transfer by
\r
1396 means of adding the subsequent branch offset to the point of
\r
1397 execution.</p></div>
\r
1398 <div class="paragraph"><p>Note that the branch offset is a byte count and each FORTH word of a
\r
1399 definition take up a cell of 8 bytes. The offset is relative to the
\r
1400 cell address immediately subsequent to the offset cell. In other
\r
1401 words, offset 0 is not branching anywhere and an offset of -16 would
\r
1402 make a tight loop back to the branch instruction itself. The latter
\r
1403 would pull data stack values until and including the first zero value.</p></div>
\r
1404 <div class="paragraph"><p>See also <a href="#p_0branch">0BRANCH</a>, <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>,
\r
1405 <a href="#p_else">ELSE</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1406 <div style="text-align:center">
\r
1407 _______________________________________________________
\r
1409 <div class="paragraph"><p><a id="p_break"></a></p></div>
\r
1411 <div class="sect2">
\r
1412 <h3 id="_word_break">Word: BREAK</h3>
\r
1413 <div class="paragraph"><p>"BREAK" is an immediate function word that lays out an unconditional
\r
1414 branch out of an enclosing xef:p_begin[BEGIN]-<a href="#p_end">END</a> block.
\r
1415 Similar to <a href="#p_ifbreak">IFBREAK</a> it lays out the branch cell
\r
1416 followed by a reserved cell for the branch offset, and inserts the
\r
1417 resolution address just above the required 0 on the data stack.</p></div>
\r
1418 <div class="exampleblock">
\r
1419 <div class="content">
\r
1420 <div class="listingblock">
\r
1421 <div class="title">Usage example 4: unconditional break with a condition.</div>
\r
1422 <div class="content">
\r
1423 <pre><code>: WTELL ( tfa -- ; Print word pname )
\r
1424 24 + DUP 8 + SWAP @ TELL SP EMIT
\r
1427 : WORDS ( wordlist -- ; Print all words of word list )
\r
1429 @ DUP IF DUP WTELL ELSE BREAK THEN
\r
1437 <div class="paragraph"><p>See also <a href="#p_branch">BRANCH</a>, <a href="#p_0branch">0BRANCH</a>,
\r
1438 <a href="#p_1branch">1BRANCH</a>, <a href="#p_if">IF</a>, <a href="#p_else">ELSE</a>,
\r
1439 <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a>.</p></div>
\r
1440 <div style="text-align:center">
\r
1441 _______________________________________________________
\r
1443 <div class="paragraph"><p><a id="p_calltrace"></a></p></div>
\r
1445 <div class="sect2">
\r
1446 <h3 id="_word_calltrace">Word: [calltrace]</h3>
\r
1447 <div class="paragraph"><p>"[calltrace]" is a variable word that ccontains a small assembly
\r
1448 snippet that may be used for debugging when running under <code>gdb</code>.</p></div>
\r
1449 <div style="text-align:center">
\r
1450 _______________________________________________________
\r
1452 <div class="paragraph"><p><a id="p_cfa2flags_get"></a></p></div>
\r
1454 <div class="sect2">
\r
1455 <h3 id="_word_cfa_gt_flags">Word: CFA>FLAGS@</h3>
\r
1456 <div class="literalblock">
\r
1457 <div class="content">
\r
1458 <pre><code>Data stack: ( cfa -- flags )</code></pre>
\r
1460 <div class="paragraph"><p>"CFA>FLAGS@" is a function word that pushes word flags of the given cfa.</p></div>
\r
1461 <div class="exampleblock">
\r
1462 <div class="content">
\r
1463 <div class="sidebarblock">
\r
1464 <div class="content">
\r
1465 <div class="title">Defintion concept for CFA>FLAGS@</div>
\r
1466 <div class="paragraph"><p>: CFA>FLAGS@ 16 - @ 16 + ;</p></div>
\r
1469 <div style="text-align:center">
\r
1470 _______________________________________________________
\r
1472 <div class="paragraph"><p><a id="p_clear_stream"></a></p></div>
\r
1474 <div class="sect2">
\r
1475 <h3 id="_word_clear_stream">Word: CLEAR-STREAM</h3>
\r
1476 <div class="literalblock">
\r
1477 <div class="content">
\r
1478 <pre><code>Data stack: ( stream -- )</code></pre>
\r
1480 <div class="paragraph"><p>"CLEAR-STREAM" is a function word that discards whatever is currently
\r
1481 remaining in the buffer for the stream, so that a subsequent read will
\r
1482 pull in more data from its source.</p></div>
\r
1483 <div class="paragraph"><p>See also <a href="#p_read_stream_char">READ-STREAM-CHAR</a>.</p></div>
\r
1484 <div style="text-align:center">
\r
1485 _______________________________________________________
\r
1487 <div class="paragraph"><p><a id="p_colon"></a></p></div>
\r
1489 <div class="sect2">
\r
1490 <h3 id="_word_3">Word: :</h3>
\r
1491 <div class="literalblock">
\r
1492 <div class="content">
\r
1493 <pre><code>Data stack: ( -- ) Input stream: word</code></pre>
\r
1495 <div class="paragraph"><p>":" (colon) is a function word that starts a new forth definition.
\r
1496 This includes reading the next word for making a new dictionary entry
\r
1497 and setting evaluation state to compiling mode.</p></div>
\r
1498 <div class="exampleblock">
\r
1499 <div class="content">
\r
1500 <div class="sidebarblock">
\r
1501 <div class="content">
\r
1502 <div class="title">Definition concept for :</div>
\r
1503 <div class="paragraph"><p>: : doFORTH READ-WORD CREATE TFA>CFA ! ] ;</p></div>
\r
1506 <div class="paragraph"><p>See also <a href="#p_doforth">doFORTH</a>, <a href="#p_read_word">READ-WORD</a>,
\r
1507 <a href="#p_create">CREATE</a>, <a href="#p_tfa2cfa">TFA>CFA</a>, <a href="#p_put">!</a>,
\r
1508 <a href="#p_left_bracket">]</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1509 <div style="text-align:center">
\r
1510 _______________________________________________________
\r
1512 <div class="paragraph"><p><a id="p_comma"></a></p></div>
\r
1514 <div class="sect2">
\r
1515 <h3 id="_word_4">Word: ,</h3>
\r
1516 <div class="literalblock">
\r
1517 <div class="content">
\r
1518 <pre><code>Data stack: ( v -- )</code></pre>
\r
1520 <div class="paragraph"><p>"," (comma) is a function word that puts a cell value on the
\r
1521 <a href="#p_here">HERE</a> heap.</p></div>
\r
1522 <div class="exampleblock">
\r
1523 <div class="content">
\r
1524 <div class="sidebarblock">
\r
1525 <div class="content">
\r
1526 <div class="title">Definition concept for ,</div>
\r
1527 <div class="paragraph"><p>: , HERE @ 8 ALLOT ! ; ( v — ; Claim 8 bytes and put value there )</p></div>
\r
1530 <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
1531 <a href="#p_allot">ALLOT</a>, <a href="#p_put">!</a> and <a href="#p_semicolon">;</a>.</p></div>
\r
1532 <div style="text-align:center">
\r
1533 _______________________________________________________
\r
1535 <div class="paragraph"><p><a id="p_create"></a></p></div>
\r
1537 <div class="sect2">
\r
1538 <h3 id="_word_create">Word: CREATE</h3>
\r
1539 <div class="literalblock">
\r
1540 <div class="content">
\r
1541 <pre><code>Data stack: ( char* n -- tfa )</code></pre>
\r
1543 <div class="paragraph"><p>"CREATE" is a function word that allocates a "word header" with the
\r
1544 indicated [n:char*] print name, and returns the "TFA" (Token Field
\r
1545 Address) of the word. The header memory layout is as follows:</p></div>
\r
1546 <div class="exampleblock">
\r
1547 <div class="content">
\r
1548 <div class="listingblock">
\r
1549 <div class="title">Layout 1: rrqforth word structure</div>
\r
1550 <div class="content">
\r
1551 <pre><code>struct WORD
\r
1552 TFA 8 link ; tfa of previous word
\r
1553 pCFA 8 cfap ; CFA = Code Field Address of this word
\r
1555 PFA 8 length ; length of pname representation
\r
1556 ? pname ; the pname bytes
\r
1557 1 nul ; a forced nul byte following the pname
\r
1558 pTFA 8 tfap ; TFA = Token Field Address of this word
\r
1559 OFF 8 doff ; entry offset for FORTH level execution
\r
1560 CFA 8 doer ; word execution semantics
\r
1561 DFA 0 content ; DFA = Data Field Address
\r
1562 end_struct</code></pre>
\r
1565 <div class="paragraph"><p>A "word" is generally understod as a marker in memory for some content
\r
1566 as held in the memory space following the DFA (Data Field Address).</p></div>
\r
1567 <div class="paragraph"><p>The words CFA (Code Field Address) is the most important field for
\r
1568 RRQFORTH execution, as holding a jump address to the assembly code
\r
1569 that implements the particular execution semantics for the word.
\r
1570 "CREATE" will assign this as "dovariable", which makes the word push
\r
1571 its DFA when executed. This is changed to "doforth" for RRQFORTH
\r
1572 function words initiated by ":" (aka "COLON") or changed to "dovalue"
\r
1573 for RRQFORTH constants created by "CONSTANT".</p></div>
\r
1574 <div class="exampleblock">
\r
1575 <div class="content">
\r
1576 <div class="sidebarblock">
\r
1577 <div class="content">
\r
1578 <div class="title">Definition concept for CREATE</div>
\r
1579 <div class="paragraph"><p>HERE @ R> ( save tfa on RS )
\r
1580 R@ CURRENT-WORD @ DUP @ , ! ( link in a new word )
\r
1581 DUP 49 + R@ + , ( pCFA )
\r
1584 HERE @ ROT ROT MEMCPY 0 C, ( pname + NUL )
\r
1587 doVARIABLE ( CFA, default semantics )</p></div>
\r
1590 <div class="exampleblock">
\r
1591 <div class="content">
\r
1592 <div class="listingblock">
\r
1593 <div class="title">Usage example 5: a possible definition of CONSTANT</div>
\r
1594 <div class="content">
\r
1595 <pre><code>: CONSTANT READ-WORD CREATE TFA>DFA doVALUE OVER 8 - ! ! ;</code></pre>
\r
1598 <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
1599 <a href="#p_Ccomma">[p_Ccomma]</a>, <a href="#p_current_word">CURRENT-WORD</a>, <a href="#p_dup">DUP</a>,
\r
1600 <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
1601 and <a href="#p_dovariable">doVARIABLE</a>,
\r
1602 as well as <a href="#p_execute">EXECUTE</a>
\r
1603 about the range of "doer" assignments and their meanings.</p></div>
\r
1604 <div style="text-align:center">
\r
1605 _______________________________________________________
\r
1607 <div class="paragraph"><p><a id="p_current_wordlist"></a></p></div>
\r
1609 <div class="sect2">
\r
1610 <h3 id="_word_current_wordlist">Word: CURRENT-WORDLIST</h3>
\r
1611 <div class="literalblock">
\r
1612 <div class="content">
\r
1613 <pre><code>Data stack: ( -- a )</code></pre>
\r
1615 <div class="paragraph"><p>"CURRENT-WORDLIST" is a variable word that points out the DFA of the
\r
1616 current word list word for <a href="#p_find">FIND</a> to use finding words. The
\r
1617 word list word content is as follows:</p></div>
\r
1618 <div class="exampleblock">
\r
1619 <div class="content">
\r
1620 <div class="listingblock">
\r
1621 <div class="title">Layout 2: word list word content</div>
\r
1622 <div class="content">
\r
1623 <pre><code> 8 TFA of latest word in the word list
\r
1624 8 DFA of the/a subsequent word list to search through</code></pre>
\r
1627 <div class="paragraph"><p>Note that word lists are chained by "extension" and in general it ends
\r
1628 with the <a href="#p_forth">FORTH</a> word list. Initially the
\r
1629 <a href="#p_system">SYSTEM</a> word list is the only other word list.</p></div>
\r
1630 <div style="text-align:center">
\r
1631 _______________________________________________________
\r
1633 <div class="paragraph"><p><a id="data_stack"></a></p></div>
\r
1635 <div class="sect2">
\r
1636 <h3 id="_word_data_stack">Word: DATA-STACK</h3>
\r
1637 <div class="literalblock">
\r
1638 <div class="content">
\r
1639 <pre><code>Data stack: ( -- a )</code></pre>
\r
1641 <div class="paragraph"><p>"DATA-STACK" is a variable word that harbours the data stack.</p></div>
\r
1642 <div style="text-align:center">
\r
1643 _______________________________________________________
\r
1645 <div class="paragraph"><p><a id="p_decimal"></a></p></div>
\r
1647 <div class="sect2">
\r
1648 <h3 id="_word_decimal">Word: DECIMAL</h3>
\r
1649 <div class="literalblock">
\r
1650 <div class="content">
\r
1651 <pre><code>Data stack: ( -- )</code></pre>
\r
1653 <div class="paragraph"><p>"DECIMAL" is a function word that sets <a href="#p_base">BASE</a> to 10.</p></div>
\r
1654 <div class="exampleblock">
\r
1655 <div class="content">
\r
1656 <div class="sidebarblock">
\r
1657 <div class="content">
\r
1658 <div class="title">Definition concept for DECIMAL</div>
\r
1659 <div class="paragraph"><p>: DECIMAL 10 BASE ! ;</p></div>
\r
1662 <div style="text-align:center">
\r
1663 _______________________________________________________
\r
1665 <div class="paragraph"><p><a id="p_definitions"></a></p></div>
\r
1667 <div class="sect2">
\r
1668 <h3 id="_word_definitions">Word: DEFINITIONS</h3>
\r
1669 <div class="literalblock">
\r
1670 <div class="content">
\r
1671 <pre><code>Data stack: ( wordlist -- )</code></pre>
\r
1673 <div class="paragraph"><p>"DEFINITIONS" is a function word that installs the given wordlist as
\r
1674 the <a href="#p_current_wordlist">CURRENT-WORDLIST</a> one.</p></div>
\r
1675 <div class="exampleblock">
\r
1676 <div class="content">
\r
1677 <div class="sidebarblock">
\r
1678 <div class="content">
\r
1679 <div class="title">Definition concept for DEFINITIONS</div>
\r
1680 <div class="paragraph"><p>: DEFINITIONS CURRENT-WORDLIST ! ;</p></div>
\r
1683 <div style="text-align:center">
\r
1684 _______________________________________________________
\r
1686 <div class="paragraph"><p><a id="p_depth"></a></p></div>
\r
1688 <div class="sect2">
\r
1689 <h3 id="_word_depth">Word: DEPTH</h3>
\r
1690 <div class="literalblock">
\r
1691 <div class="content">
\r
1692 <pre><code>Data stack: ( -- v )</code></pre>
\r
1694 <div class="paragraph"><p>"DEPTH" is a function word that pushes the count of data stack cells
\r
1695 onto the data stack.</p></div>
\r
1696 <div style="text-align:center">
\r
1697 _______________________________________________________
\r
1699 <div class="paragraph"><p><a id="p_dfa2tfa"></a></p></div>
\r
1701 <div class="sect2">
\r
1702 <h3 id="_word_dfa_gt_tfa">Word: DFA>TFA</h3>
\r
1703 <div class="literalblock">
\r
1704 <div class="content">
\r
1705 <pre><code>Data stack: ( dfa -- tfa )</code></pre>
\r
1707 <div class="paragraph"><p>"DFA>TFA" is a function word that pushes word tfa of the given dfa.</p></div>
\r
1708 <div class="exampleblock">
\r
1709 <div class="content">
\r
1710 <div class="sidebarblock">
\r
1711 <div class="content">
\r
1712 <div class="title">Definition concept for DFA>TFA</div>
\r
1713 <div class="paragraph"><p>: DFA>TFA 24 - @ ;</p></div>
\r
1716 <div style="text-align:center">
\r
1717 _______________________________________________________
\r
1719 <div class="paragraph"><p><a id="p_digits"></a></p></div>
\r
1721 <div class="sect2">
\r
1722 <h3 id="_word_digits">Word: DIGITS</h3>
\r
1723 <div class="literalblock">
\r
1724 <div class="content">
\r
1725 <pre><code>Data stack: ( -- a )</code></pre>
\r
1727 <div class="paragraph"><p>"DIGITS" is a variable word that holds the character array for mapping
\r
1728 digit values to characters. It contains the 16 characters 0-9 and a-f.</p></div>
\r
1729 <div style="text-align:center">
\r
1730 _______________________________________________________
\r
1732 <div class="paragraph"><p><a id="p_div"></a></p></div>
\r
1734 <div class="sect2">
\r
1735 <h3 id="_word_5">Word: /</h3>
\r
1736 <div class="literalblock">
\r
1737 <div class="content">
\r
1738 <pre><code>Data stack: ( v1 v2 -- q )</code></pre>
\r
1740 <div class="paragraph"><p>"/" (div) is a function word that replaces a pair of values with the
\r
1741 results of signed integer division of the first, v1, divided by the
\r
1742 second, v2. To that end, the values are 64-bit signed integers. The
\r
1743 result is the integer quotient, q, and the discarded remainder, r,
\r
1744 where q and r are the respectively largest and smallest integers to
\r
1745 satisfy the formula:</p></div>
\r
1746 <div class="literalblock">
\r
1747 <div class="content">
\r
1748 <pre><code> v1 = q * v2 + r</code></pre>
\r
1750 <div style="text-align:center">
\r
1751 _______________________________________________________
\r
1753 <div class="paragraph"><p><a id="p_divmod"></a></p></div>
\r
1755 <div class="sect2">
\r
1756 <h3 id="_word_mod">Word: /MOD</h3>
\r
1757 <div class="literalblock">
\r
1758 <div class="content">
\r
1759 <pre><code>Data stack: ( v1 v2 -- q r )</code></pre>
\r
1761 <div class="paragraph"><p>"/MOD" (div-mod) is a function word that replaces a pair of values
\r
1762 with the results of signed integer division of the first, v1, divided
\r
1763 by the second, v2. To that end, the values are 64-bit signed integers.
\r
1764 The result is the integer quotient, q, and the remainder, r, where q
\r
1765 and r are the respectively largest and smallest integers to satisfy
\r
1766 the formula:</p></div>
\r
1767 <div class="literalblock">
\r
1768 <div class="content">
\r
1769 <pre><code> v1 = q * v2 + r</code></pre>
\r
1771 <div style="text-align:center">
\r
1772 _______________________________________________________
\r
1774 <div class="paragraph"><p><a id="p_dodoes"></a></p></div>
\r
1776 <div class="sect2">
\r
1777 <h3 id="_word_dodoes">Word: doDOES</h3>
\r
1778 <div class="literalblock">
\r
1779 <div class="content">
\r
1780 <pre><code>Data stack: ( -- a )</code></pre>
\r
1782 <div class="paragraph"><p>"doDOES" is a variable word whose value is the implementation of the
\r
1783 <a href="#p_does">[p_does]</a> execution semantics. This is the same as
\r
1784 <a href="#p_doforth">doFORTH</a> but it starts at an offset into the word
\r
1785 concerned.</p></div>
\r
1786 <div style="text-align:center">
\r
1787 _______________________________________________________
\r
1789 <div class="paragraph"><p><a id="p_does"></a></p></div>
\r
1791 <div class="sect2">
\r
1792 <h3 id="_word_does_gt">WORD: DOES></h3>
\r
1793 <div class="literalblock">
\r
1794 <div class="content">
\r
1795 <pre><code>Data stack: ( -- )</code></pre>
\r
1797 <div class="paragraph"><p>"DOES>" is a function that in execution mode does nothing but in
\r
1798 compilation mode it changes the execution semantics assignments for
\r
1799 the most recent word to use the <code>dodoes</code> sematics with adjustment
\r
1800 offset to the current heap address. I.e., the word being defined will
\r
1801 have its execution start at whatever comes after "DOES>".</p></div>
\r
1802 <div class="exampleblock">
\r
1803 <div class="content">
\r
1804 <div class="sidebarblock">
\r
1805 <div class="content">
\r
1806 <div class="title">Defintion concept for DOES></div>
\r
1807 <div class="paragraph"><p>: DOES> IMMEDIATE
\r
1808 STATE @ != IF ( only for compilation mode )
\r
1809 CURRENT-WORDLIST @ @ TFA>CFA ( cfa of current word )
\r
1810 doDOES OVER ! ( set up doer )
\r
1811 HERE @ OVER 8 + - SWAP 8 - ! ( set up offset
\r
1816 <div class="paragraph"><p>See also
\r
1817 <a href="#p_put">!</a>,
\r
1818 <a href="#p_unequal">!⇒></a>,
\r
1819 <a href="#p_minus">→></a>,
\r
1820 <a href="#p_get">@</a>,
\r
1821 <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
1822 <a href="#p_here">HERE</a>,
\r
1823 <a href="#p_if">IF</a>,
\r
1824 <a href="#p_immediate">IMMEDIATE</a>,
\r
1825 <a href="#p_over">OVER</a>,
\r
1826 <a href="#p_state">STATE</a>,
\r
1827 <a href="#p_swap">SWAP</a>,
\r
1828 <a href="#p_tfa2cfa">TFA>CFA</a>,
\r
1829 <a href="#p_then">THEN</a>,
\r
1830 <a href="#p_dodoes">doDOES</a>,
\r
1831 as well as <a href="#p_execute">EXECUTE</a>
\r
1832 about the range of "doer" assignments and their meanings.</p></div>
\r
1833 <div style="text-align:center">
\r
1834 _______________________________________________________
\r
1836 <div class="paragraph"><p><a id="p_dofasm"></a></p></div>
\r
1838 <div class="sect2">
\r
1839 <h3 id="_word_dofasm">Word: doFASM</h3>
\r
1840 <div class="literalblock">
\r
1841 <div class="content">
\r
1842 <pre><code>Data stack: ( -- a )</code></pre>
\r
1844 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1845 execution semantics for assembly code content.</p></div>
\r
1846 <div style="text-align:center">
\r
1847 _______________________________________________________
\r
1849 <div class="paragraph"><p><a id="p_doforth"></a></p></div>
\r
1851 <div class="sect2">
\r
1852 <h3 id="_word_doforth">Word: doFORTH</h3>
\r
1853 <div class="literalblock">
\r
1854 <div class="content">
\r
1855 <pre><code>Data stack: ( -- a )</code></pre>
\r
1857 <div class="paragraph"><p>"doFORTH" is a variable word whose value is the implementation of the
\r
1858 RRQFORTH execution semantics.</p></div>
\r
1859 <div style="text-align:center">
\r
1860 _______________________________________________________
\r
1862 <div class="paragraph"><p><a id="p_dostring"></a></p></div>
\r
1864 <div class="sect2">
\r
1865 <h3 id="_word_dostring">Word: doSTRING</h3>
\r
1866 <div class="literalblock">
\r
1867 <div class="content">
\r
1868 <pre><code>Data stack: ( -- a )</code></pre>
\r
1870 <div class="paragraph"><p>"doFASM" is a variable word whose value is the implementation of the
\r
1871 execution semantics for assembly code implemented words. In those
\r
1872 cases the execution leads to the word content.</p></div>
\r
1873 <div class="paragraph"><p>The register context at entry to an assembly code implemented word is
\r
1874 as follows:</p></div>
\r
1875 <div class="listingblock">
\r
1876 <div class="content">
\r
1877 <pre><code> rax = cfa* of word to execute
\r
1878 rsi = cell* in the calling definition, after calling cell
\r
1879 rsp = data stack pointer
\r
1880 rbp = return stack pointer</code></pre>
\r
1882 <div class="paragraph"><p>The assembly code must ensure that <code>rsi</code> is preserved and that <code>rsp</code>
\r
1883 and <code>rbp</code> are used according to their roles.</p></div>
\r
1884 <div style="text-align:center">
\r
1885 _______________________________________________________
\r
1887 <div class="paragraph"><p><a id="p_dot"></a></p></div>
\r
1889 <div class="sect2">
\r
1890 <h3 id="_word_6">Word: .</h3>
\r
1891 <div class="literalblock">
\r
1892 <div class="content">
\r
1893 <pre><code>Data stack: ( v -- )</code></pre>
\r
1895 <div class="paragraph"><p>"." is a function word that prints the top stack value to stdout using
\r
1896 the current <a href="#p_base">BASE</a> (either <a href="#p_decimal">DECIMAL</a> or
\r
1897 <a href="#p_hex">HEX</a>).</p></div>
\r
1898 <div style="text-align:center">
\r
1899 _______________________________________________________
\r
1901 <div class="paragraph"><p><a id="p_dot_temp"></a></p></div>
\r
1903 <div class="sect2">
\r
1904 <h3 id="_word_temp">Word: .TEMP</h3>
\r
1905 <div class="literalblock">
\r
1906 <div class="content">
\r
1907 <pre><code>Data stack: ( v -- char* n )</code></pre>
\r
1909 <div class="paragraph"><p>".TEMP" is a function word that renders a cell value as an integer
\r
1910 using the current <a href="#p_base">BASE</a>, which is either
\r
1911 <a href="#p_decimal">DECIMAL</a> or <a href="#p_hex">HEX</a>. In <a href="#p_decimal">DECIMAL</a>
\r
1912 <a href="#p_base">BASE</a>, a negative value is rendered as such with a leading
\r
1913 minus sign, whereas <a href="#p_hex">HEX</a> <a href="#p_base">BASE</a> rendering is
\r
1914 unsigned.</p></div>
\r
1915 <div style="text-align:center">
\r
1916 _______________________________________________________
\r
1918 <div class="paragraph"><p><a id="p_double_quote"></a></p></div>
\r
1920 <div class="sect2">
\r
1921 <h3 id="_word_7">Word: "</h3>
\r
1922 <div class="literalblock">
\r
1923 <div class="content">
\r
1924 <pre><code>data stack: ( -- char n ) Input stream: ...."</code></pre>
\r
1926 <div class="paragraph"><p>""" (double quote) is a function word that copies the input stream
\r
1927 text up to next double quote to <a href="#p_pad">PAD</a>, and returns the
\r
1928 [n:char*] cell pair for that string.</p></div>
\r
1929 <div style="text-align:center">
\r
1930 _______________________________________________________
\r
1932 <div class="paragraph"><p><a id="p_dovalue"></a></p></div>
\r
1934 <div class="sect2">
\r
1935 <h3 id="_word_dovalue">Word: doVALUE</h3>
\r
1936 <div class="literalblock">
\r
1937 <div class="content">
\r
1938 <pre><code>Data stack: ( -- a )</code></pre>
\r
1940 <div class="paragraph"><p>"doVALUE" is a variable word whose value is the implementation of the
\r
1941 execution semantics for cell values, which are variables with a single
\r
1942 64-bit cell holding the value.</p></div>
\r
1943 <div class="paragraph"><p>The execution of this result in pushing the value:</p></div>
\r
1944 <div class="literalblock">
\r
1945 <div class="content">
\r
1946 <pre><code>Resulting data stack: ( -- v )</code></pre>
\r
1948 <div style="text-align:center">
\r
1949 _______________________________________________________
\r
1951 <div class="paragraph"><p><a id="p_dovariable"></a></p></div>
\r
1953 <div class="sect2">
\r
1954 <h3 id="_word_dovariable">Word: doVARIABLE</h3>
\r
1955 <div class="literalblock">
\r
1956 <div class="content">
\r
1957 <pre><code>Data stack: ( -- a )</code></pre>
\r
1959 <div class="paragraph"><p>"doVARIABLE" is a variable word whose value is the implementation of
\r
1960 the execution semantics for "variables", which basically are markers
\r
1961 into the heap for some number block of memory.</p></div>
\r
1962 <div class="paragraph"><p>The execution of a variable results in pushing its content address:</p></div>
\r
1963 <div class="literalblock">
\r
1964 <div class="content">
\r
1965 <pre><code>Resulting data stack: ( -- a )</code></pre>
\r
1967 <div style="text-align:center">
\r
1968 _______________________________________________________
\r
1970 <div class="paragraph"><p><a id="p_drop"></a></p></div>
\r
1972 <div class="sect2">
\r
1973 <h3 id="_word_drop">Word: DROP</h3>
\r
1974 <div class="literalblock">
\r
1975 <div class="content">
\r
1976 <pre><code>Data stack: ( v -- )</code></pre>
\r
1978 <div class="paragraph"><p>"DROP" is a function word that discards the top stack cell.</p></div>
\r
1979 <div style="text-align:center">
\r
1980 _______________________________________________________
\r
1982 <div class="paragraph"><p><a id="p_dup"></a></p></div>
\r
1984 <div class="sect2">
\r
1985 <h3 id="_word_dup">Word: DUP</h3>
\r
1986 <div class="literalblock">
\r
1987 <div class="content">
\r
1988 <pre><code>Data stack: ( v -- v v )</code></pre>
\r
1990 <div class="paragraph"><p>"DUP" is a function word that duplicates the top stack cell.</p></div>
\r
1991 <div style="text-align:center">
\r
1992 _______________________________________________________
\r
1994 <div class="paragraph"><p><a id="p_else"></a></p></div>
\r
1996 <div class="sect2">
\r
1997 <h3 id="_word_else">Word: ELSE</h3>
\r
1998 <div class="literalblock">
\r
1999 <div class="content">
\r
2000 <pre><code>Data stack: Compiling: ( a -- a )</code></pre>
\r
2002 <div class="paragraph"><p>"ELSE" is an immediate function word that is used together with
\r
2003 <a href="#p_if">IF</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2004 control. ELSE lays out an unresolved unconditional branch as an ending
\r
2005 for the "then-part" of the structured statement, and it then performs
\r
2006 the branch resolution for the "else-part". To that end it replaces the
\r
2007 stacked address which pin-points the foot address the branch offset to
\r
2008 resolve, so that at execution time there is an appropriate conditional
\r
2009 branch past the "then-part" and the "else-part" of the "structured
\r
2010 statement".</p></div>
\r
2011 <div style="text-align:center">
\r
2012 _______________________________________________________
\r
2014 <div class="paragraph"><p><a id="p_emit"></a></p></div>
\r
2016 <div class="sect2">
\r
2017 <h3 id="_word_emit">Word: EMIT</h3>
\r
2018 <div class="literalblock">
\r
2019 <div class="content">
\r
2020 <pre><code>Data stack: ( c -- )</code></pre>
\r
2022 <div class="paragraph"><p>"EMIT" is a function word that puts the given character code to
\r
2023 standard output (file descriptor 1). The character is the least
\r
2024 significant byte of the top cell.</p></div>
\r
2025 <div style="text-align:center">
\r
2026 _______________________________________________________
\r
2028 <div class="paragraph"><p><a id="p_end"></a></p></div>
\r
2030 <div class="sect2">
\r
2031 <h3 id="_word_end">Word: END</h3>
\r
2032 <div class="literalblock">
\r
2033 <div class="content">
\r
2034 <pre><code>Data stack: Compiling: ( a 0 * -- )</code></pre>
\r
2036 <div class="paragraph"><p>"END" is an immediate function word that is used together with
\r
2037 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">IFBREAK</a> and <a href="#p_ifagain">IFAGAIN</a> to
\r
2038 implement structured execution control. END processes the data stack
\r
2039 to resolve any dangling <a href="#p_ifbreak">IFBREAK</a> branch offset for the
\r
2040 block of the matching <a href="#p_begin">BEGIN</a>.</p></div>
\r
2041 <div style="text-align:center">
\r
2042 _______________________________________________________
\r
2044 <div class="paragraph"><p><a id="p_equal"></a></p></div>
\r
2046 <div class="sect2">
\r
2047 <h3 id="_word_8">Word: =</h3>
\r
2048 <div class="literalblock">
\r
2049 <div class="content">
\r
2050 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2052 <div class="paragraph"><p>"=" is a function word that replaces a pair of values with -1 of the
\r
2053 values are equal, and 0 otherwise.</p></div>
\r
2054 <div style="text-align:center">
\r
2055 _______________________________________________________
\r
2057 <div class="paragraph"><p><a id="p_erase"></a></p></div>
\r
2059 <div class="sect2">
\r
2060 <h3 id="_word_erase">Word: ERASE</h3>
\r
2061 <div class="literalblock">
\r
2062 <div class="content">
\r
2063 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2065 <div class="paragraph"><p>"ERASE" is a function word that stores n NUL bytes at address a an up.</p></div>
\r
2066 <div style="text-align:center">
\r
2067 _______________________________________________________
\r
2069 <div class="paragraph"><p><a id="p_evaluate_stream"></a></p></div>
\r
2071 <div class="sect2">
\r
2072 <h3 id="_word_evaluate_stream">Word: EVALUATE-STREAM</h3>
\r
2073 <div class="literalblock">
\r
2074 <div class="content">
\r
2075 <pre><code>Data stack: ( stream -- ??? 0/1 ) Input stream: ......</code></pre>
\r
2077 <div class="paragraph"><p>"EVALUATE-STREAM" is a function word that reads words separated by
\r
2078 whitespace from the stream until it discovers an unknown word, or the
\r
2079 stream is exhausted. Depending on <a href="#p_state">STATE</a>, the words are
\r
2080 either executed or compiled, and all ther stack and heap effects are
\r
2081 preserved. "EVALUATE-STREAM" returns with an additional 0 or 1 on the
\r
2082 stack to respectively indicate that the last word was unkown, i.e. not
\r
2083 found (<a href="#p_find">FIND</a>) in the current word list
\r
2084 (<a href="#p_current_wordlist">CURRENT-WORDLIST</a>) and not a
\r
2085 <a href="#p_number">NUMBER</a> of the current <a href="#p_base">BASE</a>.</p></div>
\r
2086 <div class="paragraph"><p>Note that numbers in the current <a href="#p_base">BASE</a> are treated as known
\r
2087 words that are parsed into cell values. If interpreting, then the
\r
2088 value is left on the stack. If compiling, then the value is added to
\r
2089 the heap subsequent to first adding <a href="#p_literal">LIT</a>, which is done
\r
2090 so as to make that value be push to the data stack upon a later
\r
2091 execution.</p></div>
\r
2092 <div class="paragraph"><p>In the <a href="#p_decimal">DECIMAL</a> base, the number word may begin with a
\r
2093 minus sign.</p></div>
\r
2094 <div class="paragraph"><p>The words are read and executed one by one, accounting for whether its
\r
2095 a number word or not, whether it is an <a href="#p_immediate">IMMEDIATE</a> word
\r
2096 or not, and whether the state at the time of execution indicates
\r
2097 "compiling" of "interpreting". Immediate words are executed in both
\r
2098 interpreting and compiling state, while other words have their CFA get
\r
2099 added to the heap so as to gain their execution effect upon a later
\r
2100 execution.</p></div>
\r
2101 <div class="paragraph"><p>Note that "EVALUATE-STREAM" keeps the stream (pointer) on the return
\r
2102 stack while reading, parsing and executing.</p></div>
\r
2103 <div class="paragraph"><p>If "EVALUATE-STREAM" ends with 0, then <a href="#p_this_word">THIS-WORD</a> holds
\r
2104 the [n:chars] reference of the offending word in the stream buffer.</p></div>
\r
2105 <div style="text-align:center">
\r
2106 _______________________________________________________
\r
2108 <div class="paragraph"><p><a id="p_execute"></a></p></div>
\r
2110 <div class="sect2">
\r
2111 <h3 id="_word_execute">Word: EXECUTE</h3>
\r
2112 <div class="literalblock">
\r
2113 <div class="content">
\r
2114 <pre><code>Data stack: ( cfa -- )</code></pre>
\r
2116 <div class="paragraph"><p>"EXECUTE" is a function word that transfers the execution to the
\r
2117 indicated "Code Field Address", which typically is the CFA of an
\r
2118 RRQFORTH word with the CFA cell containing a jump address for the code
\r
2119 that implements the execution semnatics of the word.</p></div>
\r
2120 <div class="paragraph"><p>The following execution semantics are predefined:</p></div>
\r
2121 <div class="ulist"><ul>
\r
2124 assembler implemented words constitute their own execution
\r
2130 <a href="#p_doforth">[p_doforth]</a> implements the FORTH machine. This treats the word
\r
2131 content as a succession of cells that hold the cfa pointers for the
\r
2132 words that make of the definition. As is customary in FORTH
\r
2133 machines, the advance through that succession is provided by each
\r
2134 word code ending making an explicit jump to its successor. The
\r
2135 <a href="#p_return_stack">RETURN-STACK</a> serves as a call stack for tracking
\r
2136 the nesting of FORTH executions by saving the "addresses" of the
\r
2142 <a href="#p_dodoes">[p_dodoes]</a> implements the variation of starting the FORTH
\r
2143 execution somewhere within a definition rather than at the
\r
2149 <a href="#p_dostring">[p_dostring]</a>, <a href="#p_dovalue">[p_dovalue]</a> and <a href="#p_dovariable">[p_dovariable]</a> implement
\r
2150 different common ways of using word content other the as FORTH
\r
2155 <div style="text-align:center">
\r
2156 _______________________________________________________
\r
2158 <div class="paragraph"><p><a id="p_exit"></a></p></div>
\r
2160 <div class="sect2">
\r
2161 <h3 id="_word_exit">Word: EXIT</h3>
\r
2162 <div class="literalblock">
\r
2163 <div class="content">
\r
2164 <pre><code>Data stack: ( v -- )</code></pre>
\r
2166 <div class="paragraph"><p>"EXIT" is a function word that terminates the <code>rrqforth</code> process
\r
2167 immediately with the given exit code.</p></div>
\r
2168 <div style="text-align:center">
\r
2169 _______________________________________________________
\r
2171 <div class="paragraph"><p><a id="p_false"></a></p></div>
\r
2173 <div class="sect2">
\r
2174 <h3 id="_word_false">Word: FALSE</h3>
\r
2175 <div class="literalblock">
\r
2176 <div class="content">
\r
2177 <pre><code>Data stack: ( -- 0 )</code></pre>
\r
2179 <div class="paragraph"><p>"FALSE" is a value word representing logical false.</p></div>
\r
2180 <div style="text-align:center">
\r
2181 _______________________________________________________
\r
2183 <div class="paragraph"><p><a id="p_fdemit"></a></p></div>
\r
2185 <div class="sect2">
\r
2186 <h3 id="_word_fdemit">Word: FDEMIT</h3>
\r
2187 <div class="literalblock">
\r
2188 <div class="content">
\r
2189 <pre><code>Data stack: ( c fd -- )</code></pre>
\r
2191 <div class="paragraph"><p>"FDEMIT" is a function word that puts the given character code to the
\r
2192 given file descriptor. The character is the least significant byte of
\r
2193 the data stack cell.</p></div>
\r
2194 <div style="text-align:center">
\r
2195 _______________________________________________________
\r
2197 <div class="paragraph"><p><a id="p_fdtell"></a></p></div>
\r
2199 <div class="sect2">
\r
2200 <h3 id="_word_fdtell">Word: FDTELL</h3>
\r
2201 <div class="literalblock">
\r
2202 <div class="content">
\r
2203 <pre><code>Data stack: ( char* n fd -- )</code></pre>
\r
2205 <div class="paragraph"><p>"FDTELL" is a function word that prints a string to the given file
\r
2206 descriptor.</p></div>
\r
2207 <div style="text-align:center">
\r
2208 _______________________________________________________
\r
2210 <div class="paragraph"><p><a id="p_find"></a></p></div>
\r
2212 <div class="sect2">
\r
2213 <h3 id="_word_find">Word: FIND</h3>
\r
2214 <div class="literalblock">
\r
2215 <div class="content">
\r
2216 <pre><code>Data stack: ( char* n -- [ char* n 0 ]/[ tfa ] )</code></pre>
\r
2218 <div class="paragraph"><p>"FIND" is a function word that searches the current word list search
\r
2219 path for the given [n:char*] word, and returns the TFA of the matching
\r
2220 word if any. Otherwise FIND preserves the initial data stack but adds
\r
2221 0 to it.</p></div>
\r
2222 <div class="paragraph"><p>The word is sought starting with the
\r
2223 <a href="#p_current_wordlist">CURRENT-WORDLIST</a> word list, for the first
\r
2224 occurence of a match. If not found, the search continues with the
\r
2225 subsequent word list, and so on.</p></div>
\r
2226 <div class="paragraph"><p>When a word is found, then the data stack is changed by discarding the
\r
2227 [n:char*] double cell string pointer and pushing (only) the TFA of the
\r
2228 matching word instead.</p></div>
\r
2229 <div style="text-align:center">
\r
2230 _______________________________________________________
\r
2232 <div class="paragraph"><p><a id="p_forth"></a></p></div>
\r
2234 <div class="sect2">
\r
2235 <h3 id="_word_forth">Word: FORTH</h3>
\r
2236 <div class="literalblock">
\r
2237 <div class="content">
\r
2238 <pre><code>data stack: ( -- a )</code></pre>
\r
2240 <div class="paragraph"><p>"FORTH" is a variable word for the FORTH word list, which does not
\r
2241 have any subsequent word list.</p></div>
\r
2242 <div style="text-align:center">
\r
2243 _______________________________________________________
\r
2245 <div class="paragraph"><p><a id="p_get"></a></p></div>
\r
2247 <div class="sect2">
\r
2248 <h3 id="_word_9">Word: @</h3>
\r
2249 <div class="literalblock">
\r
2250 <div class="content">
\r
2251 <pre><code>Data stack: ( a -- v )</code></pre>
\r
2253 <div class="paragraph"><p>"@" is a function word that pushes the value v from the address a.</p></div>
\r
2254 <div style="text-align:center">
\r
2255 _______________________________________________________
\r
2257 <div class="paragraph"><p><a id="p_get_n_decrement"></a></p></div>
\r
2259 <div class="sect2">
\r
2260 <h3 id="_word_n">Word: @n--</h3>
\r
2261 <div class="literalblock">
\r
2262 <div class="content">
\r
2263 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2265 <div class="paragraph"><p>"@n--" is a function word that pushes the value from the address, a,
\r
2266 then decrements the cell at that address by n.</p></div>
\r
2267 <div class="exampleblock">
\r
2268 <div class="content">
\r
2269 <div class="sidebarblock">
\r
2270 <div class="content">
\r
2271 <div class="title">Defintion concept for @n++</div>
\r
2272 <div class="paragraph"><p>: @n++ OVER @ DUP ROT - ROT ! ;</p></div>
\r
2275 <div style="text-align:center">
\r
2276 _______________________________________________________
\r
2278 <div class="paragraph"><p><a id="p_get_n_increment"></a></p></div>
\r
2280 <div class="sect2">
\r
2281 <h3 id="_word_n_2">Word: @n++</h3>
\r
2282 <div class="literalblock">
\r
2283 <div class="content">
\r
2284 <pre><code>Data stack: ( a n -- v )</code></pre>
\r
2286 <div class="paragraph"><p>"@n++" is a function word that pushes the value from the address, a,
\r
2287 then increments the cell at that address by n.</p></div>
\r
2288 <div class="exampleblock">
\r
2289 <div class="content">
\r
2290 <div class="sidebarblock">
\r
2291 <div class="content">
\r
2292 <div class="title">Defintion concept for @n++</div>
\r
2293 <div class="paragraph"><p>( a n — v ) : @n++ OVER @ DUP ROT + ROT ! ;</p></div>
\r
2296 <div style="text-align:center">
\r
2297 _______________________________________________________
\r
2299 <div class="paragraph"><p><a id="p_greaterequal"></a></p></div>
\r
2301 <div class="sect2">
\r
2302 <h3 id="_word_gt">Word: >=</h3>
\r
2303 <div class="literalblock">
\r
2304 <div class="content">
\r
2305 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2307 <div class="paragraph"><p>">=" is a function word that replaces a pair of values with -1 if the
\r
2308 first, v1, is greater than or equal to the second, v1, otherwise 0. To
\r
2309 that end, the values are 64-bit signed integers.</p></div>
\r
2310 <div style="text-align:center">
\r
2311 _______________________________________________________
\r
2313 <div class="paragraph"><p><a id="p_greaterthan"></a></p></div>
\r
2315 <div class="sect2">
\r
2316 <h3 id="_word_gt_2">Word: ></h3>
\r
2317 <div class="literalblock">
\r
2318 <div class="content">
\r
2319 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2321 <div class="paragraph"><p>">" is a function word that replaces a pair of values with -1 if the
\r
2322 first, v1, is greater than the second, v1, otherwise 0. To that end,
\r
2323 the values are 64-bit signed integers.</p></div>
\r
2324 <div style="text-align:center">
\r
2325 _______________________________________________________
\r
2327 <div class="paragraph"><p><a id="p_gtR"></a></p></div>
\r
2329 <div class="sect2">
\r
2330 <h3 id="_word_gt_r">Word: >R</h3>
\r
2331 <div class="literalblock">
\r
2332 <div class="content">
\r
2333 <pre><code>Data stack: ( v -- ) Return stack: ( -- v )</code></pre>
\r
2335 <div class="paragraph"><p>">R" is a function word that "moves" the top data stack value onto the
\r
2336 return stack.</p></div>
\r
2337 <div style="text-align:center">
\r
2338 _______________________________________________________
\r
2340 <div class="paragraph"><p><a id="p_here"></a></p></div>
\r
2342 <div class="sect2">
\r
2343 <h3 id="_word_here">Word: HERE</h3>
\r
2344 <div class="literalblock">
\r
2345 <div class="content">
\r
2346 <pre><code>Data stack: ( -- a )</code></pre>
\r
2348 <div class="paragraph"><p>"HERE" is a variable word that keeps the lowest address of the free
\r
2349 allocation space. It get updated by all words that allocate memory.</p></div>
\r
2350 <div class="exampleblock">
\r
2351 <div class="content">
\r
2352 <div class="sidebarblock">
\r
2353 <div class="content">
\r
2354 <div class="title">allocate 1024 bytes on the heap</div>
\r
2355 <div class="paragraph"><p>1024 HEAP @ + HEAP !</p></div>
\r
2358 <div class="paragraph"><p>See also <a href="#p_allot">ALLOT</a>.</p></div>
\r
2359 <div style="text-align:center">
\r
2360 _______________________________________________________
\r
2362 <div class="paragraph"><p><a id="p_hex"></a></p></div>
\r
2364 <div class="sect2">
\r
2365 <h3 id="_word_hex">Word: HEX</h3>
\r
2366 <div class="literalblock">
\r
2367 <div class="content">
\r
2368 <pre><code>Data stack: ( -- )</code></pre>
\r
2370 <div class="paragraph"><p>"HEX" is a function word that sets <a href="#p_base">BASE</a> to 16, which uses
\r
2371 letters a-f as additional digits. (Uppercase letter are also accepted
\r
2372 on input).</p></div>
\r
2373 <div class="exampleblock">
\r
2374 <div class="content">
\r
2375 <div class="sidebarblock">
\r
2376 <div class="content">
\r
2377 <div class="title">Definition concept for HEX</div>
\r
2378 <div class="paragraph"><p>: HEX 16 BASE ! ;</p></div>
\r
2381 <div style="text-align:center">
\r
2382 _______________________________________________________
\r
2384 <div class="paragraph"><p><a id="p_if"></a></p></div>
\r
2386 <div class="sect2">
\r
2387 <h3 id="_word_if">Word: IF</h3>
\r
2388 <div class="literalblock">
\r
2389 <div class="content">
\r
2390 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2392 <div class="paragraph"><p>"IF" is an immediate function word that is used together with
\r
2393 <a href="#p_else">ELSE</a> and <a href="#p_then">THEN</a> to implement structured execution
\r
2394 control. IF results in layout of a <a href="#p_0branch">0BRANCH</a> instruction
\r
2395 with an unresolved branch offset, and places the address for resolving
\r
2396 this instruction on the datastack. This address will then be resolved
\r
2397 and asssigned by a subsequent <a href="#p_else">ELSE</a> or <a href="#p_then">THEN</a> so
\r
2398 that at execution time there is an appropriate conditional branch past
\r
2399 the "then-part" of the "structured statement".</p></div>
\r
2400 <div style="text-align:center">
\r
2401 _______________________________________________________
\r
2403 <div class="paragraph"><p><a id="p_ifagain"></a></p></div>
\r
2405 <div class="sect2">
\r
2406 <h3 id="_word_ifagain">Word: IFAGAIN</h3>
\r
2407 <div class="literalblock">
\r
2408 <div class="content">
\r
2409 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2411 <div class="paragraph"><p>"IFAGAIN" is an immediate function word that is used together with
\r
2412 <a href="#p_begin">BEGIN</a>, <a href="#p_ifbreak">BREAK</a> and <a href="#p_end">END</a> to implement
\r
2413 structured execution control. IFAGAIN scans the datastack for the
\r
2414 nearest preceding BEGIN marker and lays out a branch from this point
\r
2415 the beginning of the block during execution.</p></div>
\r
2416 <div style="text-align:center">
\r
2417 _______________________________________________________
\r
2419 <div class="paragraph"><p><a id="p_ifbreak"></a></p></div>
\r
2421 <div class="sect2">
\r
2422 <h3 id="_word_ifbreak">Word: IFBREAK</h3>
\r
2423 <div class="literalblock">
\r
2424 <div class="content">
\r
2425 <pre><code>Data stack: Compiling: ( -- a )</code></pre>
\r
2427 <div class="paragraph"><p>"IFBREAK" is an immediate function word that is used together with
\r
2428 <a href="#p_begin">BEGIN</a>, <a href="#p_ifagain">IFAGAIN</a> and <a href="#p_end">END</a> to
\r
2429 implement structured execution control. IFBREAK simply places the
\r
2430 address for resolving branches from this point the end of the block
\r
2431 during execution.</p></div>
\r
2432 <div style="text-align:center">
\r
2433 _______________________________________________________
\r
2435 <div class="paragraph"><p><a id="p_immediate"></a></p></div>
\r
2437 <div class="sect2">
\r
2438 <h3 id="_word_immediate">Word: IMMEDIATE</h3>
\r
2439 <div class="literalblock">
\r
2440 <div class="content">
\r
2441 <pre><code>Data stack: ( -- )</code></pre>
\r
2443 <div class="paragraph"><p>"IMMEDIATE" is an immediate function word that sets the flags field of
\r
2444 the most recent word to 1, thereby making that word an immediate word.</p></div>
\r
2445 <div class="exampleblock">
\r
2446 <div class="content">
\r
2447 <div class="sidebarblock">
\r
2448 <div class="content">
\r
2449 <div class="title">Definition concept for IMMEDIATE</div>
\r
2450 <div class="paragraph"><p>: IMMEDIATE IMMEDIATE 1 CURRENT-WORDLIST @ @ 16 + ! ;</p></div>
\r
2453 <div class="paragraph"><p>See also <a href="#p_colon">:</a>, <a href="#p_current_wordlist">CURRENT-WORDLIST</a>,
\r
2454 <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
2455 <div style="text-align:center">
\r
2456 _______________________________________________________
\r
2458 <div class="paragraph"><p><a id="p_input"></a></p></div>
\r
2460 <div class="sect2">
\r
2461 <h3 id="_word_input">Word: INPUT</h3>
\r
2462 <div class="literalblock">
\r
2463 <div class="content">
\r
2464 <pre><code>Data stack: ( -- a )</code></pre>
\r
2466 <div class="paragraph"><p>"INPUT" is a variable word for the input stream buffer used by
\r
2467 <a href="#p_evaluate_stream">EVALUATE-STREAM</a>.</p></div>
\r
2468 <div style="text-align:center">
\r
2469 _______________________________________________________
\r
2471 <div class="paragraph"><p><a id="p_left_bracket"></a></p></div>
\r
2473 <div class="sect2">
\r
2474 <h3 id="_word_10">Word: [</h3>
\r
2475 <div class="literalblock">
\r
2476 <div class="content">
\r
2477 <pre><code>Data stack: ( -- )</code></pre>
\r
2479 <div class="paragraph"><p>"[" (left bracket) is a function word that sets the stream evaluation
\r
2480 mode to be intepreting. In this mode, words are executed immediately
\r
2481 after parsing, by invoking their "doer".</p></div>
\r
2482 <div class="exampleblock">
\r
2483 <div class="content">
\r
2484 <div class="sidebarblock">
\r
2485 <div class="content">
\r
2486 <div class="title">Definition concept for [</div>
\r
2487 <div class="paragraph"><p>: [ IMMEDIATE 0 STATE ! ;</p></div>
\r
2490 <div style="text-align:center">
\r
2491 _______________________________________________________
\r
2493 <div class="paragraph"><p><a id="p_lessequal"></a></p></div>
\r
2495 <div class="sect2">
\r
2496 <h3 id="_word_lt">Word: <=</h3>
\r
2497 <div class="literalblock">
\r
2498 <div class="content">
\r
2499 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2501 <div class="paragraph"><p>"<=" is a function word that replaces a pair of values with -1 if the
\r
2502 first, v1, is less than or equal to the second, v1, otherwise 0. To
\r
2503 that end, the values are 64-bit signed integers.</p></div>
\r
2504 <div style="text-align:center">
\r
2505 _______________________________________________________
\r
2507 <div class="paragraph"><p><a id="p_lessthan"></a></p></div>
\r
2509 <div class="sect2">
\r
2510 <h3 id="_word_lt_2">Word: <</h3>
\r
2511 <div class="literalblock">
\r
2512 <div class="content">
\r
2513 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
2515 <div class="paragraph"><p>"<" is a function word that replaces a pair of values with -1 if the
\r
2516 first, v1, is less than the second, v1, otherwise 0. To that end, the
\r
2517 values are 64-bit signed integers.</p></div>
\r
2518 <div style="text-align:center">
\r
2519 _______________________________________________________
\r
2521 <div class="paragraph"><p><a id="p_literal"></a></p></div>
\r
2523 <div class="sect2">
\r
2524 <h3 id="_word_lit">Word: LIT</h3>
\r
2525 <div class="literalblock">
\r
2526 <div class="content">
\r
2527 <pre><code>Data stack: ( -- v )</code></pre>
\r
2529 <div class="paragraph"><p>"LIT" is a function word that pushes the cell subsequent and moves
\r
2530 excution past that. The literal value is thus layed out as if a
\r
2531 subsequent CFA pointer in the containing definition, and the LIT
\r
2532 execution will make the execution skip past that and instead contine
\r
2533 with the CFA pointer following the value.</p></div>
\r
2534 <div class="paragraph"><p>It’s not a good idea to use "LIT" interactively.</p></div>
\r
2535 <div class="exampleblock">
\r
2536 <div class="content">
\r
2537 <div class="sidebarblock">
\r
2538 <div class="content">
\r
2539 <div class="title">Definition concept for LIT</div>
\r
2540 <div class="paragraph"><p>: LIT R> DUP 8 + >R @ ;</p></div>
\r
2543 <div style="text-align:center">
\r
2544 _______________________________________________________
\r
2546 <div class="paragraph"><p><a id="p_literal_string"></a></p></div>
\r
2548 <div class="sect2">
\r
2549 <h3 id="_word_lit_string">Word: LIT-STRING</h3>
\r
2550 <div class="literalblock">
\r
2551 <div class="content">
\r
2552 <pre><code>Data stack: ( -- chars* n )</code></pre>
\r
2554 <div class="paragraph"><p>"LIT-STRING" is a function word that pushes the char* and length n of
\r
2555 a subsequent inline string, then advances execution to continue after
\r
2556 the string. This is similar to <a href="#p_lit">LIT</a> but for a block literal.</p></div>
\r
2557 <div class="paragraph"><p>Note that the inlined byte count includes the terminating NUL byte.</p></div>
\r
2558 <div class="exampleblock">
\r
2559 <div class="content">
\r
2560 <div class="sidebarblock">
\r
2561 <div class="content">
\r
2562 <div class="title">Definition concept for LIT-STRING</div>
\r
2563 <div class="paragraph"><p>: LIT-STRING R@ DUP @ 8 + R@ @ 2DUP + R> + >R 1 - ;</p></div>
\r
2566 <div style="text-align:center">
\r
2567 _______________________________________________________
\r
2569 <div class="paragraph"><p><a id="p_literal_string_compile"></a></p></div>
\r
2571 <div class="sect2">
\r
2572 <h3 id="_word_s">Word: S"</h3>
\r
2573 <div class="literalblock">
\r
2574 <div class="content">
\r
2575 <pre><code>Data stack: ( -- ) Input stream: " chars"</code></pre>
\r
2577 <div class="paragraph"><p>"S"" is an immediate function word that compiles the subseqent
\r
2578 characters up to terminating double-quote into the current definition,
\r
2579 preceded by a <a href="#p_literal_string">LIT-STRING</a> cell, and the count of
\r
2580 bytes scanned. The inline text includes a terminating NUL character
\r
2581 which also is included in the inlined count.</p></div>
\r
2582 <div class="paragraph"><p>Note that "S"" uses <a href="#p_double_quote">"</a> for reading the string.</p></div>
\r
2583 <div style="text-align:center">
\r
2584 _______________________________________________________
\r
2586 <div class="paragraph"><p><a id="p_load_buffer_size"></a></p></div>
\r
2588 <div class="sect2">
\r
2589 <h3 id="_word_load_buffer_size">Word: LOAD-BUFFER-SIZE</h3>
\r
2590 <div class="literalblock">
\r
2591 <div class="content">
\r
2592 <pre><code>data stack: ( -- a )</code></pre>
\r
2594 <div class="paragraph"><p>"LOAD-BUFFER-SIZE" is a variable word telling the buffer size in bytes
\r
2595 that <a href="#p_load_file">LOAD-FILE</a> should use.</p></div>
\r
2596 <div style="text-align:center">
\r
2597 _______________________________________________________
\r
2599 <div class="paragraph"><p><a id="p_load_file"></a></p></div>
\r
2601 <div class="sect2">
\r
2602 <h3 id="_word_load_file">Word: LOAD-FILE</h3>
\r
2603 <div class="literalblock">
\r
2604 <div class="content">
\r
2605 <pre><code>data stack: ( chaz* -- * 0/1 )</code></pre>
\r
2607 <div class="paragraph"><p>"LOAD-FILE" is a function word that evaluates a text file. It opens a
\r
2608 file via <a href="#p_open_file">OPEN-FILE</a> and sets up a stream with a
\r
2609 buffer of <a href="#p_load_buffer_size">LOAD-BUFFER-SIZE</a> bytes for
\r
2610 reading it. The stream is passed to
\r
2611 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> for processing its words. Upon
\r
2612 its return the file is closed and the stream memory is reclaimed, and
\r
2613 then the function returns whatever
\r
2614 <a href="#p_evaluate_stream">EVALUATE-STREAM</a> returns.</p></div>
\r
2615 <div style="text-align:center">
\r
2616 _______________________________________________________
\r
2618 <div class="paragraph"><p><a id="p_lparen"></a></p></div>
\r
2620 <div class="sect2">
\r
2621 <h3 id="_word_11">Word: (</h3>
\r
2622 <div class="literalblock">
\r
2623 <div class="content">
\r
2624 <pre><code>Data stack: ( -- )</code></pre>
\r
2626 <div class="paragraph"><p>"(" (left parenthesis) is a function word that scans and ignores words
\r
2627 until the next right parenthesis, or the end of the stream. This is
\r
2628 used for comments in RRQFORTH code.</p></div>
\r
2629 <div class="paragraph"><p>Note that the terminating right parenthesis is a word, i.e. must have
\r
2630 whitespace before and after it.</p></div>
\r
2631 <div style="text-align:center">
\r
2632 _______________________________________________________
\r
2634 <div class="paragraph"><p><a id="p_malloc"></a></p></div>
\r
2636 <div class="sect2">
\r
2637 <h3 id="_word_malloc">Word: MALLOC</h3>
\r
2638 <div class="literalblock">
\r
2639 <div class="content">
\r
2640 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2642 <div class="paragraph"><p>"MALLOC" is a word that allocates memory using mmap of at least n
\r
2643 bytes and returns the lowest address of the allocated block.</p></div>
\r
2644 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
2645 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
2646 <div class="paragraph"><p>The memory is allocated with READ and WRITE access but not EXEC
\r
2647 access, and flagged as PRIVATE, ANONYMOUS and LOCKED. See the "man
\r
2648 page" of mmap for details.</p></div>
\r
2649 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a></p></div>
\r
2650 <div style="text-align:center">
\r
2651 _______________________________________________________
\r
2653 <div class="paragraph"><p><a id="p_minus"></a></p></div>
\r
2655 <div class="sect2">
\r
2656 <h3 id="_word_12">Word: -</h3>
\r
2657 <div class="literalblock">
\r
2658 <div class="content">
\r
2659 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2661 <div class="paragraph"><p>"-" (minus) is a function word that replaces a pair of values with the
\r
2662 result of reducing the first, v1, with the second, v2. To that end,
\r
2663 the values are 64-bit signed integers.</p></div>
\r
2664 <div style="text-align:center">
\r
2665 _______________________________________________________
\r
2667 <div class="paragraph"><p><a id="p_mult"></a></p></div>
\r
2669 <div class="sect2">
\r
2670 <h3 id="_word_13">Word: *</h3>
\r
2671 <div class="literalblock">
\r
2672 <div class="content">
\r
2673 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2675 <div class="paragraph"><p>"*" is a function word that replaces a pair of values with the result
\r
2676 of multiplying them. To that end, the values are 64-bit signed
\r
2677 integers, and clipping the result to the least signifcant 64 bits.</p></div>
\r
2678 <div style="text-align:center">
\r
2679 _______________________________________________________
\r
2681 <div class="paragraph"><p><a id="p_negate"></a></p></div>
\r
2683 <div class="sect2">
\r
2684 <h3 id="_word_negate">Word: NEGATE</h3>
\r
2685 <div class="literalblock">
\r
2686 <div class="content">
\r
2687 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2689 <div class="paragraph"><p>"NEGATE" is a function word that replaces a value with its
\r
2690 2’s-complement negation. To that end, the values are 64-bit signed
\r
2691 integers.</p></div>
\r
2692 <div style="text-align:center">
\r
2693 _______________________________________________________
\r
2695 <div class="paragraph"><p><a id="p_nip"></a></p></div>
\r
2697 <div class="sect2">
\r
2698 <h3 id="_word_nip">Word: NIP</h3>
\r
2699 <div class="literalblock">
\r
2700 <div class="content">
\r
2701 <pre><code>Data stack: ( v1 v2 -- v2 )</code></pre>
\r
2703 <div class="paragraph"><p>"NIP" is a function word that discards the second of the top two cells
\r
2704 on the data stack.</p></div>
\r
2705 <div class="exampleblock">
\r
2706 <div class="content">
\r
2707 <div class="sidebarblock">
\r
2708 <div class="content">
\r
2709 <div class="title">Definition concept for NIP</div>
\r
2710 <div class="paragraph"><p>: NIP SWAP DROP ;</p></div>
\r
2713 <div style="text-align:center">
\r
2714 _______________________________________________________
\r
2716 <div class="paragraph"><p><a id="p_nl"></a></p></div>
\r
2718 <div class="sect2">
\r
2719 <h3 id="_word_nl">Word: NL</h3>
\r
2720 <div class="literalblock">
\r
2721 <div class="content">
\r
2722 <pre><code>Data stack: ( -- v )</code></pre>
\r
2724 <div class="paragraph"><p>"NL" is a value word pushing a newline character onto the data stack.</p></div>
\r
2725 <div style="text-align:center">
\r
2726 _______________________________________________________
\r
2728 <div class="paragraph"><p><a id="p_not"></a></p></div>
\r
2730 <div class="sect2">
\r
2731 <h3 id="_word_not">Word: NOT</h3>
\r
2732 <div class="literalblock">
\r
2733 <div class="content">
\r
2734 <pre><code>Data stack: ( v1 -- v2 )</code></pre>
\r
2736 <div class="paragraph"><p>"NOT" is a function word that replaces a value with its bitwise
\r
2737 complement; each bit is zero if non-zero, and non-zero if zero.</p></div>
\r
2738 <div class="paragraph"><p>Compare with <<p_0equal,0⇒>.</p></div>
\r
2739 <div style="text-align:center">
\r
2740 _______________________________________________________
\r
2742 <div class="paragraph"><p><a id="p_number"></a></p></div>
\r
2744 <div class="sect2">
\r
2745 <h3 id="_word_number">Word: NUMBER</h3>
\r
2746 <div class="literalblock">
\r
2747 <div class="content">
\r
2748 <pre><code>Data stack: ( char n -- [ 0 ]/[ v 1 ] )</code></pre>
\r
2750 <div class="paragraph"><p>"NUMBER" is a function word that parses a text number using
\r
2751 <a href="#p_base">BASE</a> as numerical base, then returns the result number and
\r
2752 a 1 on top, or just a 0 if the word didn’t parse.</p></div>
\r
2753 <div class="paragraph"><p>A number consists of, first an optional minus sign, if in
\r
2754 <a href="#p_decimal">DECIMAL</a> base, then digits 0-9 and, if in <a href="#p_hex">HEX</a>
\r
2755 base, letters a-f or A-F for values 10-15. I.e. the normal positive or
\r
2756 negative decimal integers or normal (positive only) hexadecimal
\r
2757 integers.</p></div>
\r
2758 <div style="text-align:center">
\r
2759 _______________________________________________________
\r
2761 <div class="paragraph"><p><a id="p_open_file"></a></p></div>
\r
2763 <div class="sect2">
\r
2764 <h3 id="_word_open_file">Word: OPEN-FILE</h3>
\r
2765 <div class="literalblock">
\r
2766 <div class="content">
\r
2767 <pre><code>Data stack: ( chaz* -- fd )</code></pre>
\r
2769 <div class="paragraph"><p>"OPEN-FILE" is a function word that opens the file named by the zero
\r
2770 terminated character string and returns the file descriptor, or if
\r
2771 less than 0, the system call error code.</p></div>
\r
2772 <div style="text-align:center">
\r
2773 _______________________________________________________
\r
2775 <div class="paragraph"><p><a id="p_or"></a></p></div>
\r
2777 <div class="sect2">
\r
2778 <h3 id="_word_or">Word: OR</h3>
\r
2779 <div class="literalblock">
\r
2780 <div class="content">
\r
2781 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2783 <div class="paragraph"><p>"OR" is a function word that replaces a value pair with their bitwise
\r
2784 disjunction; each bit is 1 if the corresponding bits of any operand
\r
2785 is 1 and 0 if not.</p></div>
\r
2786 <div style="text-align:center">
\r
2787 _______________________________________________________
\r
2789 <div class="paragraph"><p><a id="p_over"></a></p></div>
\r
2791 <div class="sect2">
\r
2792 <h3 id="_word_over">Word: OVER</h3>
\r
2793 <div class="literalblock">
\r
2794 <div class="content">
\r
2795 <pre><code>Data stack: ( v1 v2 -- v1 v2 v1 )</code></pre>
\r
2797 <div class="paragraph"><p>"OVER" is a function word that duplicates the second top stack cell on
\r
2798 the data stack.</p></div>
\r
2799 <div style="text-align:center">
\r
2800 _______________________________________________________
\r
2802 <div class="paragraph"><p><a id="p_pad"></a></p></div>
\r
2804 <div class="sect2">
\r
2805 <h3 id="_word_pad">Word: PAD</h3>
\r
2806 <div class="literalblock">
\r
2807 <div class="content">
\r
2808 <pre><code>Data stack: ( -- a )</code></pre>
\r
2810 <div class="paragraph"><p>"PAD" is a variable word for a 1 kb data space that is used by
\r
2811 <a href="#p_double_quote">[p_double_quote]</a> (only), and otherwise free for temporary use.</p></div>
\r
2812 <div style="text-align:center">
\r
2813 _______________________________________________________
\r
2815 <div class="paragraph"><p><a id="p_pick"></a></p></div>
\r
2817 <div class="sect2">
\r
2818 <h3 id="_word_pick">Word: PICK</h3>
\r
2819 <div class="literalblock">
\r
2820 <div class="content">
\r
2821 <pre><code>Data stack: ( vu...v1 v0 u -- vu...v1 v0 vu )</code></pre>
\r
2823 <div class="paragraph"><p>"PICK" is a function word that pushes the u:th data stack cell down
\r
2824 from top onto the data stack. 0 indicates the top cell making it the
\r
2825 same as <a href="#p_dup">DUP</a>, and 1 indicates the second top cell making it
\r
2826 the same as <a href="#p_over">OVER</a>.</p></div>
\r
2827 <div style="text-align:center">
\r
2828 _______________________________________________________
\r
2830 <div class="paragraph"><p><a id="p_plus"></a></p></div>
\r
2832 <div class="sect2">
\r
2833 <h3 id="_word_43">Word: +</h3>
\r
2834 <div class="literalblock">
\r
2835 <div class="content">
\r
2836 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
2838 <div class="paragraph"><p>"+" (plus) is a function word that replaces a pair of values with the
\r
2839 result of adding them. To that end, the values are 64-bit signed
\r
2840 integers.</p></div>
\r
2841 <div style="text-align:center">
\r
2842 _______________________________________________________
\r
2844 <div class="paragraph"><p><a id="p_program_version"></a></p></div>
\r
2846 <div class="sect2">
\r
2847 <h3 id="_word_program_version">Word: PROGRAM_VERSION</h3>
\r
2848 <div class="literalblock">
\r
2849 <div class="content">
\r
2850 <pre><code>Data stack: ( -- char* length )</code></pre>
\r
2852 <div class="paragraph"><p>"PROGRAM_VERSION" is a string variable hilding the version string.</p></div>
\r
2853 <div style="text-align:center">
\r
2854 _______________________________________________________
\r
2856 <div class="paragraph"><p><a id="p_put"></a></p></div>
\r
2858 <div class="sect2">
\r
2859 <h3 id="_word_14">Word: !</h3>
\r
2860 <div class="literalblock">
\r
2861 <div class="content">
\r
2862 <pre><code>Data stack: ( v a -- )</code></pre>
\r
2864 <div class="paragraph"><p>"!" is a function word that stores the cell value v at the address a.</p></div>
\r
2865 <div style="text-align:center">
\r
2866 _______________________________________________________
\r
2868 <div class="paragraph"><p><a id="p_put_plus"></a></p></div>
\r
2870 <div class="sect2">
\r
2871 <h3 id="_word_15">Word: !+</h3>
\r
2872 <div class="literalblock">
\r
2873 <div class="content">
\r
2874 <pre><code>Data stack: ( a n -- )</code></pre>
\r
2876 <div class="paragraph"><p>"!+" is a function word that adds n to the cell value at a.</p></div>
\r
2877 <div class="exampleblock">
\r
2878 <div class="content">
\r
2879 <div class="sidebarblock">
\r
2880 <div class="content">
\r
2881 <div class="title">definition concept for !+</div>
\r
2882 <div class="paragraph"><p>( a n — ) : !+ OVER @ + SWAP ! ;</p></div>
\r
2885 <div style="text-align:center">
\r
2886 _______________________________________________________
\r
2888 <div class="paragraph"><p><a id="p_quit"></a></p></div>
\r
2890 <div class="sect2">
\r
2891 <h3 id="_word_quit">Word: QUIT</h3>
\r
2892 <div class="literalblock">
\r
2893 <div class="content">
\r
2894 <pre><code>Data stack: ??</code></pre>
\r
2896 <div class="paragraph"><p>"QUIT" is a function word that implements the root execution loop of
\r
2897 RRQFORTH. First it resets the stacks to their original settings, and
\r
2898 thereafter it enters loop of reading words from <a href="#p_stdin">STDIN</a> and
\r
2899 executing them.</p></div>
\r
2900 <div style="text-align:center">
\r
2901 _______________________________________________________
\r
2903 <div class="paragraph"><p><a id="p_quote"></a></p></div>
\r
2905 <div class="sect2">
\r
2906 <h3 id="_word_16">Word: '</h3>
\r
2907 <div class="literalblock">
\r
2908 <div class="content">
\r
2909 <pre><code>data stack: ( -- cfa ) Input stream: word</code></pre>
\r
2911 <div class="paragraph"><p>"'" (single quote) is a function word that reads and find the next
\r
2912 word on the input stream and pushes its cfa.</p></div>
\r
2913 <div style="text-align:center">
\r
2914 _______________________________________________________
\r
2916 <div class="paragraph"><p><a id="p_rbp"></a></p></div>
\r
2918 <div class="sect2">
\r
2919 <h3 id="_word_rsp">Word: RSP</h3>
\r
2920 <div class="literalblock">
\r
2921 <div class="content">
\r
2922 <pre><code>Data stack: ( -- a )</code></pre>
\r
2924 <div class="paragraph"><p>"RSP" is a function word that pushes the return stack pointer value
\r
2925 onto the data stack.</p></div>
\r
2926 <div style="text-align:center">
\r
2927 _______________________________________________________
\r
2929 <div class="paragraph"><p><a id="p_rbpn"></a></p></div>
\r
2931 <div class="sect2">
\r
2932 <h3 id="_word_r_n">Word: R[n]</h3>
\r
2933 <div class="literalblock">
\r
2934 <div class="content">
\r
2935 <pre><code>Data stack: ( n -- a )</code></pre>
\r
2937 <div class="paragraph"><p>"R[n]" is a function word that pushes the address for the n:th cell on
\r
2938 the top return stack value onto the data stack.</p></div>
\r
2939 <div class="exampleblock">
\r
2940 <div class="content">
\r
2941 <div class="sidebarblock">
\r
2942 <div class="content">
\r
2943 <div class="title">Defintion concept for R[n]</div>
\r
2944 <div class="paragraph"><p>( n — a ) : R[n] 8 * RSP + ;</p></div>
\r
2947 <div style="text-align:center">
\r
2948 _______________________________________________________
\r
2950 <div class="paragraph"><p><a id="p_read_stream_char"></a></p></div>
\r
2952 <div class="sect2">
\r
2953 <h3 id="_word_read_stream_char">Word: READ-STREAM-CHAR</h3>
\r
2954 <div class="literalblock">
\r
2955 <div class="content">
\r
2956 <pre><code>Data stack: ( stream -- c )</code></pre>
\r
2958 <div class="paragraph"><p>"READ-STREAM-CHAR" is a function word that gets the next character
\r
2959 from the given stream buffer, possibly refilling the buffer if it is
\r
2960 backed by a file descriptor. The refill is done by a SYS_READ call
\r
2961 when more characters are needed. The next character is pushed on the
\r
2962 stack, unless the stream is exhausted in which case the -1 is pushed
\r
2963 instead.</p></div>
\r
2964 <div class="paragraph"><p>See also <a href="#p_stream">STREAM</a>.</p></div>
\r
2965 <div style="text-align:center">
\r
2966 _______________________________________________________
\r
2968 <div class="paragraph"><p><a id="p_read_word"></a></p></div>
\r
2970 <div class="sect2">
\r
2971 <h3 id="_word_read_word">Word: READ-WORD</h3>
\r
2972 <div class="literalblock">
\r
2973 <div class="content">
\r
2974 <pre><code>Data stack: ( stream -- char* n )</code></pre>
\r
2976 <div class="paragraph"><p>"READ-WORD" is a function word that "reads" the next whitespace
\r
2977 separated word from the given stream and returns the [n:char*] duoble
\r
2978 cell pointer for it. The characters of the word are copied to
\r
2979 <a href="#p_pad">PAD</a>, and there is a limit of 1024 characters.</p></div>
\r
2980 <div class="paragraph"><p>At the end of the stream READ-WORD returns 0 length.</p></div>
\r
2981 <div class="exampleblock">
\r
2982 <div class="title">Special syntax 1: Whitespace</div>
\r
2983 <div class="content">
\r
2984 <div class="paragraph"><p>All character codes less or equal to 32 are regarded as "whitespace".</p></div>
\r
2986 <div class="exampleblock">
\r
2987 <div class="title">Special syntax 2: Rest-of-line comment</div>
\r
2988 <div class="content">
\r
2989 <div class="paragraph"><p>The "#" character following whitespace starts a line comment and the
\r
2990 rest of the line is ignored. Note that this is also recognised with
\r
2991 <a href="#p_lparen">parethesis commenting</a>.</p></div>
\r
2993 <div style="text-align:center">
\r
2994 _______________________________________________________
\r
2996 <div class="paragraph"><p><a id="p_realloc"></a></p></div>
\r
2998 <div class="sect2">
\r
2999 <h3 id="_word_realloc">Word: REALLOC</h3>
\r
3000 <div class="literalblock">
\r
3001 <div class="content">
\r
3002 <pre><code>Data stack: ( a m n -- a )</code></pre>
\r
3004 <div class="paragraph"><p>"REALLOC" is a word that reallocates memory using mremap of address a
\r
3005 of size m to be size n bytes and returns the lowest address of the
\r
3006 allocated block.</p></div>
\r
3007 <div class="paragraph"><p>Note that this makes new page allocations for the process from the
\r
3008 kernel, and the granularity is in pages, i.e. a multiple of 4 kb.</p></div>
\r
3009 <div class="paragraph"><p>The memory is reampped using the MREMAP_MAYMOVE flag,</p></div>
\r
3010 <div class="paragraph"><p>See also <a href="#p_malloc">MALLOC</a></p></div>
\r
3011 <div style="text-align:center">
\r
3012 _______________________________________________________
\r
3014 <div class="paragraph"><p><a id="p_return"></a></p></div>
\r
3016 <div class="sect2">
\r
3017 <h3 id="_word_return">Word: RETURN</h3>
\r
3018 <div class="literalblock">
\r
3019 <div class="content">
\r
3020 <pre><code>Data stack: ( -- )</code></pre>
\r
3022 <div class="paragraph"><p>"RETURN" is a function word that implements the ending of a FORTH
\r
3023 definition and make execution return to the next step in the calling
\r
3024 definition.</p></div>
\r
3025 <div style="text-align:center">
\r
3026 _______________________________________________________
\r
3028 <div class="paragraph"><p>compile.asm: WORD p_right_bracket,<em>]</em>,fasm</p></div>
\r
3029 <div class="paragraph"><p><a id="p_right_bracket"></a></p></div>
\r
3031 <div class="sect2">
\r
3032 <h3 id="_word_17">Word: ]</h3>
\r
3033 <div class="literalblock">
\r
3034 <div class="content">
\r
3035 <pre><code>Data stack: ( -- )</code></pre>
\r
3037 <div class="paragraph"><p>"]" (right bracket) is a function word that sets the stream evaluation
\r
3038 mode to be compiling. In this mode words parsed into CFA pointers
\r
3039 which are placed on the heap in the given order, unless the word is
\r
3040 flagged as <a href="#p_immediate">IMMEDIATE</a> or a <a href="#p_number">NUMBER</a>. An
\r
3041 immediate word is executed immediately, and a number is parsed and
\r
3042 left on the stack.</p></div>
\r
3043 <div class="paragraph"><p>Note that a word is parsed as a number only if it is not found in the
\r
3044 wordlist; i.e., the word list may contain definitions for numbers.</p></div>
\r
3045 <div class="exampleblock">
\r
3046 <div class="content">
\r
3047 <div class="sidebarblock">
\r
3048 <div class="content">
\r
3049 <div class="title">Definition concept for ]</div>
\r
3050 <div class="paragraph"><p>: ] 1 STATE ! ;</p></div>
\r
3053 <div style="text-align:center">
\r
3054 _______________________________________________________
\r
3056 <div class="paragraph"><p><a id="p_roll"></a></p></div>
\r
3058 <div class="sect2">
\r
3059 <h3 id="_word_roll">Word: ROLL</h3>
\r
3060 <div class="literalblock">
\r
3061 <div class="content">
\r
3062 <pre><code>Data stack: ( vu...v1 v0 u -- ...v1 v0 vu )</code></pre>
\r
3064 <div class="paragraph"><p>"ROLL" is a function word that "moves" the u:th data stack cell down
\r
3065 from top onto the data stack while discarding it. 0 indicates the top
\r
3066 cell; 1 indicates the second top cell making it the same as
\r
3067 <a href="#p_swap">SWAP</a>; 2 indicates the third top cell making it the same as
\r
3068 <a href="#p_rot">ROT</a>.</p></div>
\r
3069 <div style="text-align:center">
\r
3070 _______________________________________________________
\r
3072 <div class="paragraph"><p><a id="p_rot"></a></p></div>
\r
3074 <div class="sect2">
\r
3075 <h3 id="_word_rot">Word: ROT</h3>
\r
3076 <div class="literalblock">
\r
3077 <div class="content">
\r
3078 <pre><code>Data stack: ( v1 v2 v3 -- v2 v3 v1 )</code></pre>
\r
3080 <div class="paragraph"><p>"ROT" is a function word that "rotates" the top three data stack cells
\r
3081 such that the third becomes the first while the second becomes third
\r
3082 and the first becomes the second.</p></div>
\r
3083 <div class="paragraph"><p>See also <a href="#p_roll">ROLL</a>.</p></div>
\r
3084 <div style="text-align:center">
\r
3085 _______________________________________________________
\r
3087 <div class="paragraph"><p><a id="p_semicolon"></a></p></div>
\r
3089 <div class="sect2">
\r
3090 <h3 id="_word_18">Word: ;</h3>
\r
3091 <div class="literalblock">
\r
3092 <div class="content">
\r
3093 <pre><code>Data stack: ( -- )</code></pre>
\r
3095 <div class="paragraph"><p>";" (semi-colon) is an immediate function word that ends a new forth
\r
3096 definition by means of adding an <a href="#p_exit">EXIT</a> cell, then changing
\r
3097 <<p_state,STATE> to interpreting.</p></div>
\r
3098 <div class="exampleblock">
\r
3099 <div class="content">
\r
3100 <div class="sidebarblock">
\r
3101 <div class="content">
\r
3102 <div class="title">Definition concept for ;</div>
\r
3103 <div class="paragraph"><p>: ; IMMEDIATE ' EXIT , ;</p></div>
\r
3106 <div style="text-align:center">
\r
3107 _______________________________________________________
\r
3109 <div class="paragraph"><p><a id="p_setup_signals"></a></p></div>
\r
3111 <div class="sect2">
\r
3112 <h3 id="_word_p_setup_signals">Word: [p_setup_signals]</h3>
\r
3113 <div class="literalblock">
\r
3114 <div class="content">
\r
3115 <pre><code>Data stack: ( -- a )</code></pre>
\r
3117 <div class="paragraph"><p>"[p_setup_signals]" is a variable word that contains the assembly code
\r
3118 sniippet for setting up the signal handling. rrqforth handles SEGV by
\r
3119 restarting the interpreter loop on <a href="#p_stdin">STDIN</a>.</p></div>
\r
3120 <div style="text-align:center">
\r
3121 _______________________________________________________
\r
3123 <div class="paragraph"><p><a id="p_shift_left"></a></p></div>
\r
3125 <div class="sect2">
\r
3126 <h3 id="_word_lt_lt">Word: <<</h3>
\r
3127 <div class="literalblock">
\r
3128 <div class="content">
\r
3129 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3131 <div class="paragraph"><p>"<<" is a function word that shifts value v1 n steps left (i.e.
\r
3132 "moving" bits towards more significant bits) to form value v2.</p></div>
\r
3133 <div style="text-align:center">
\r
3134 _______________________________________________________
\r
3136 <div class="paragraph"><p><a id="p_shift_right"></a></p></div>
\r
3138 <div class="sect2">
\r
3139 <h3 id="_word_gt_gt">Word: >></h3>
\r
3140 <div class="literalblock">
\r
3141 <div class="content">
\r
3142 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3144 <div class="paragraph"><p>">>" is a function word that shifts value v1 n steps right (i.e.
\r
3145 "moving" bits towards less significant bits) to form value v2.</p></div>
\r
3146 <div style="text-align:center">
\r
3147 _______________________________________________________
\r
3149 <div class="paragraph"><p><a id="p_shift_signed_right"></a></p></div>
\r
3151 <div class="sect2">
\r
3152 <h3 id="_word_s_gt_gt">Word: s>></h3>
\r
3153 <div class="literalblock">
\r
3154 <div class="content">
\r
3155 <pre><code>Data stack: ( v1 n -- v2 )</code></pre>
\r
3157 <div class="paragraph"><p>"s>>" is a function word that shifts value v1 n steps right (i.e.
\r
3158 "moving" bits towards less significant bits) to form value v2, but
\r
3159 preserving (and copying) the sign bit.</p></div>
\r
3160 <div style="text-align:center">
\r
3161 _______________________________________________________
\r
3163 <div class="paragraph"><p><a id="p_sp"></a></p></div>
\r
3165 <div class="sect2">
\r
3166 <h3 id="_word_sp">Word: SP</h3>
\r
3167 <div class="literalblock">
\r
3168 <div class="content">
\r
3169 <pre><code>Data stack: ( -- v )</code></pre>
\r
3171 <div class="paragraph"><p>"SP" is a value word pushing a space character onto the data stack.</p></div>
\r
3172 <div style="text-align:center">
\r
3173 _______________________________________________________
\r
3175 <div class="paragraph"><p><a id="p_state"></a></p></div>
\r
3177 <div class="sect2">
\r
3178 <h3 id="_word_state">Word: STATE</h3>
\r
3179 <div class="literalblock">
\r
3180 <div class="content">
\r
3181 <pre><code>Data stack: ( -- a )</code></pre>
\r
3183 <div class="paragraph"><p>"STATE" is a variable word marking whether the stream evaluator is in
\r
3184 compiling mode (1) or interpreting (0) mode.</p></div>
\r
3185 <div style="text-align:center">
\r
3186 _______________________________________________________
\r
3188 <div class="paragraph"><p><a id="p_stdin"></a></p></div>
\r
3190 <div class="sect2">
\r
3191 <h3 id="_word_stdin">Word: STDIN</h3>
\r
3192 <div class="literalblock">
\r
3193 <div class="content">
\r
3194 <pre><code>Data stack: ( -- stream )</code></pre>
\r
3196 <div class="paragraph"><p>"STDIN" is a value word referring to the stream buffer for the
\r
3197 standard input file descriptor.</p></div>
\r
3198 <div style="text-align:center">
\r
3199 _______________________________________________________
\r
3201 <div class="paragraph"><p><a id="p_stream"></a></p></div>
\r
3203 <div class="sect2">
\r
3204 <h3 id="_word_stream">Word: STREAM</h3>
\r
3205 <div class="literalblock">
\r
3206 <div class="content">
\r
3207 <pre><code>Data stack: ( fd size -- addr ) or ( block -1 -- addr )</code></pre>
\r
3209 <div class="paragraph"><p>"STREAM" is a function word that sets up a buffer for an input file
\r
3210 descriptor or for a memory block (of size+data).</p></div>
\r
3211 <div class="sect3">
\r
3212 <h4 id="_file_descriptor_backed_stream">File descriptor backed STREAM</h4>
\r
3213 <div class="paragraph"><p>A file descriptor backed STREAM gains a buffer of the given size
\r
3214 prefixed by a 32 byte STREAM header of the following layout:</p></div>
\r
3215 <div class="exampleblock">
\r
3216 <div class="content">
\r
3217 <div class="listingblock">
\r
3218 <div class="title">Layout 3: file descriptor stream</div>
\r
3219 <div class="content">
\r
3220 <pre><code> 8 bytes = size of buffer (excluding the 32 byte header)
\r
3221 8 bytes source file descriptor
\r
3222 8 bytes current fill
\r
3223 8 current read position</code></pre>
\r
3227 <div class="sect3">
\r
3228 <h4 id="_memory_block_backed_stream">Memory block backed STREAM</h4>
\r
3229 <div class="paragraph"><p>A memory block stream is only the header (though allocated via
\r
3230 <a href="#p_malloc">MALLOC</a> which reserves a full kernel page) with the
\r
3231 following layout:</p></div>
\r
3232 <div class="exampleblock">
\r
3233 <div class="content">
\r
3234 <div class="listingblock">
\r
3235 <div class="title">Layout 4: memory block stream</div>
\r
3236 <div class="content">
\r
3237 <pre><code> 8 bytes = block address
\r
3238 8 -1 (indicates memory block)
\r
3239 8 size of block (taken from the block's first 8 bytes)
\r
3240 8 current read position</code></pre>
\r
3243 <div style="text-align:center">
\r
3244 _______________________________________________________
\r
3246 <div class="paragraph"><p><a id="p_stream_nchars"></a></p></div>
\r
3249 <div class="sect2">
\r
3250 <h3 id="_word_stream_nchars">Word: STREAM-NCHARS</h3>
\r
3251 <div class="literalblock">
\r
3252 <div class="content">
\r
3253 <pre><code>Data stack: ( stream -- n )</code></pre>
\r
3255 <div class="paragraph"><p>"STREAM-NCHARS" is a function word that scans ahead in the stream
\r
3256 buffer for the next non-whitespace character, and returns its position
\r
3257 relative to the end of the buffer. This is done without changing the
\r
3258 stream (or filling it by reading the backing file).</p></div>
\r
3259 <div style="text-align:center">
\r
3260 _______________________________________________________
\r
3262 <div class="paragraph"><p><a id="p_str2temp"></a></p></div>
\r
3264 <div class="sect2">
\r
3265 <h3 id="_word_str_gt_temp">Word: STR>TEMP</h3>
\r
3266 <div class="sidebarblock">
\r
3267 <div class="content">
\r
3268 <div class="paragraph"><p>Data stack: ( char* n — char* n )</p></div>
\r
3270 <div class="paragraph"><p>"STR>TEMP" is a function word that copies a given string plus a
\r
3271 terminating NUL character into a <a href="#p_tempspace">TEMPSPACE</a> snippet,
\r
3272 all preceded by a length cell. It returns a pointer for to the text in
\r
3273 the snippet and its length, excluding the NUL character at end and the
\r
3274 length cell before tie text.</p></div>
\r
3275 <div class="listingblock">
\r
3276 <div class="title">Layout for copied string</div>
\r
3277 <div class="content">
\r
3278 <pre><code> length: 8 bytes
\r
3279 returned char*: n bytes
\r
3280 nul: 1 byte</code></pre>
\r
3282 <div style="text-align:center">
\r
3283 _______________________________________________________
\r
3285 <div class="paragraph"><p><a id="p_strlen"></a></p></div>
\r
3287 <div class="sect2">
\r
3288 <h3 id="_word_strlen">Word: STRLEN</h3>
\r
3289 <div class="literalblock">
\r
3290 <div class="content">
\r
3291 <pre><code>Data stack: ( s -- n )</code></pre>
\r
3293 <div class="paragraph"><p>"STRLEN" is a function words that counts how many bytes there are from
\r
3294 s to the first NUL byte and returns that count, n, not including the
\r
3295 NUL byte.</p></div>
\r
3296 <div style="text-align:center">
\r
3297 _______________________________________________________
\r
3299 <div class="paragraph"><p><a id="p_strncmp"></a></p></div>
\r
3301 <div class="sect2">
\r
3302 <h3 id="_word_strncmp">Word: STRNCMP</h3>
\r
3303 <div class="literalblock">
\r
3304 <div class="content">
\r
3305 <pre><code>Data stack: ( s1 s2 n -- v )</code></pre>
\r
3307 <div class="paragraph"><p>"STRNCMP" is a function words that compares up to n characters of
\r
3308 character sequences s1 and s2, and returns the difference of the first
\r
3309 differing characters, as in <code>s2[i] - s1[i]</code>, or 0 if all n characters
\r
3310 are the same.</p></div>
\r
3311 <div class="paragraph"><p>I.e., the value v is less than 0 if string [n:s1] is alpha-numerically
\r
3313 v is greater than 0 if [n:s1] is greater than [n:s2],
\r
3314 and v is 0 if [n:s1] and [n:s2] are equal.</p></div>
\r
3315 <div style="text-align:center">
\r
3316 _______________________________________________________
\r
3318 <div class="paragraph"><p><a id="p_strncpy"></a></p></div>
\r
3320 <div class="sect2">
\r
3321 <h3 id="_word_strncpy">Word: STRNCPY</h3>
\r
3322 <div class="literalblock">
\r
3323 <div class="content">
\r
3324 <pre><code>Data stack: ( s1 s2 n -- )</code></pre>
\r
3326 <div class="paragraph"><p>"STRNCPY" is a function words that copies n bytes of byte sequence s1
\r
3328 <div style="text-align:center">
\r
3329 _______________________________________________________
\r
3331 <div class="paragraph"><p><a id="p_swap"></a></p></div>
\r
3333 <div class="sect2">
\r
3334 <h3 id="_word_swap">Word: SWAP</h3>
\r
3335 <div class="literalblock">
\r
3336 <div class="content">
\r
3337 <pre><code>Data stack: ( v1 v2 -- v2 v1 )</code></pre>
\r
3339 <div class="paragraph"><p>"SWAP" is a function word the swaps the top two data stack cells.</p></div>
\r
3340 <div style="text-align:center">
\r
3341 _______________________________________________________
\r
3343 <div class="paragraph"><p><a id="p_system"></a></p></div>
\r
3345 <div class="sect2">
\r
3346 <h3 id="_word_system">Word: SYSTEM</h3>
\r
3347 <div class="literalblock">
\r
3348 <div class="content">
\r
3349 <pre><code>Data value: ( -- a )</code></pre>
\r
3351 <div class="paragraph"><p>"SYSTEM" is a variable that holds the word list data for the system
\r
3352 calls. This is set up as separate word list from <a href="#p_forth">FORTH</a>
\r
3353 merely as a matter of segregation.</p></div>
\r
3354 <div style="text-align:center">
\r
3355 _______________________________________________________
\r
3357 <div class="paragraph"><p><a id="p_tell"></a></p></div>
\r
3359 <div class="sect2">
\r
3360 <h3 id="_word_tell">Word: TELL</h3>
\r
3361 <div class="literalblock">
\r
3362 <div class="content">
\r
3363 <pre><code>Data stack: ( char* n -- )</code></pre>
\r
3365 <div class="paragraph"><p>"TELL" is a function word that prints a string to stdout (file
\r
3366 descriptor 1).</p></div>
\r
3367 <div style="text-align:center">
\r
3368 _______________________________________________________
\r
3370 <div class="paragraph"><p><a id="p_temp"></a></p></div>
\r
3372 <div class="sect2">
\r
3373 <h3 id="_word_temp_2">Word: TEMP</h3>
\r
3374 <div class="sidebarblock">
\r
3375 <div class="content">
\r
3376 <div class="paragraph"><p>Data stack: ( size — addr )</p></div>
\r
3378 <div class="paragraph"><p>"TEMP" is a function word that "allocates" a <a href="#p_tempspace">TEMPSPACE</a>
\r
3379 area of given size and returns its base address. The allocation is
\r
3380 temporary and only valid until there is a later allocation that
\r
3381 overruns this area.</p></div>
\r
3382 <div class="paragraph"><p>Allocations are done in succession until the requested size overruns
\r
3383 the <a href="#p_tempspace">TEMPSPACE</a>. If so, the allocation pointer is reset
\r
3384 and the space is allocated from start again. This is all intended for
\r
3385 small and short-lived data areas.</p></div>
\r
3386 <div style="text-align:center">
\r
3387 _______________________________________________________
\r
3389 <div class="paragraph"><p><a id="p_tempspace"></a></p></div>
\r
3391 <div class="sect2">
\r
3392 <h3 id="_word_tempspace">Word: TEMPSPACE</h3>
\r
3393 <div class="literalblock">
\r
3394 <div class="content">
\r
3395 <pre><code>Data stack: ( -- a )</code></pre>
\r
3397 <div class="paragraph"><p>"TEMPSPACE" is a variable word that holds three cells the for managing
\r
3398 "temporary memory":</p></div>
\r
3399 <div class="ulist"><ul>
\r
3402 the size of the temporary memory space (default 104857600 bytes)
\r
3407 the base address for whole temporary memory area
\r
3412 the amount currently used
\r
3416 <div class="paragraph"><p>This memory is intended to be used by requesting snippets of memory in
\r
3417 a cyclic fashion via <a href="#p_temp">TEMP</a> without concern about it possibly
\r
3418 overlapping a prior request.</p></div>
\r
3419 <div style="text-align:center">
\r
3420 _______________________________________________________
\r
3422 <div class="paragraph"><p><a id="p_terminate0"></a></p></div>
\r
3424 <div class="sect2">
\r
3425 <h3 id="_word_terminate0">Word: TERMINATE0</h3>
\r
3426 <div class="literalblock">
\r
3427 <div class="content">
\r
3428 <pre><code>Data stack: ( -- )</code></pre>
\r
3430 <div class="paragraph"><p>"TERMINATE0" is a function word that terminates the program with exit
\r
3432 <div style="text-align:center">
\r
3433 _______________________________________________________
\r
3435 <div class="paragraph"><p><a id="p_tfa2cfa"></a></p></div>
\r
3437 <div class="sect2">
\r
3438 <h3 id="_word_tfa_gt_cfa">Word: TFA>CFA</h3>
\r
3439 <div class="literalblock">
\r
3440 <div class="content">
\r
3441 <pre><code>Data stack: ( tfa -- cfa )</code></pre>
\r
3443 <div class="paragraph"><p>"TFA>CFA" is a function word that pushes word cfa of the given tfa.</p></div>
\r
3444 <div class="exampleblock">
\r
3445 <div class="content">
\r
3446 <div class="sidebarblock">
\r
3447 <div class="content">
\r
3448 <div class="title">Definition concept for TFA>CFA</div>
\r
3449 <div class="paragraph"><p>: TFA>CFA 8 + @ ;</p></div>
\r
3452 <div style="text-align:center">
\r
3453 _______________________________________________________
\r
3455 <div class="paragraph"><p><a id="p_tfa2dfa"></a></p></div>
\r
3457 <div class="sect2">
\r
3458 <h3 id="_word_tfa_gt_dfa">Word: TFA>DFA</h3>
\r
3459 <div class="literalblock">
\r
3460 <div class="content">
\r
3461 <pre><code>Data stack: ( tfa -- dfa )</code></pre>
\r
3463 <div class="paragraph"><p>"TFA>DFA" is a function word that pushes word dfa of the given tfa.</p></div>
\r
3464 <div class="exampleblock">
\r
3465 <div class="content">
\r
3466 <div class="sidebarblock">
\r
3467 <div class="content">
\r
3468 <div class="title">Definition concept for TFA>DFA</div>
\r
3469 <div class="paragraph"><p>: TFA>DFA TFA>CFA 8 + ;</p></div>
\r
3472 <div style="text-align:center">
\r
3473 _______________________________________________________
\r
3475 <div class="paragraph"><p><a id="p_tfa2flags_get"></a></p></div>
\r
3477 <div class="sect2">
\r
3478 <h3 id="_word_tfa_gt_flags">Word: TFA>FLAGS@</h3>
\r
3479 <div class="literalblock">
\r
3480 <div class="content">
\r
3481 <pre><code>Data stack: ( tfa -- flags )</code></pre>
\r
3483 <div class="paragraph"><p>"TFA>FLAGS@" is a function word that pushes word flags of the given tfa.</p></div>
\r
3484 <div class="exampleblock">
\r
3485 <div class="content">
\r
3486 <div class="sidebarblock">
\r
3487 <div class="content">
\r
3488 <div class="title">Defintion concept for TFA>FLAGS@</div>
\r
3489 <div class="paragraph"><p>: TFA>FLAGS@ 16 + @ ;</p></div>
\r
3492 <div style="text-align:center">
\r
3493 _______________________________________________________
\r
3495 <div class="paragraph"><p><a id="p_tfa2namez"></a></p></div>
\r
3497 <div class="sect2">
\r
3498 <h3 id="_word_tfa_gt_namez">Word: TFA>NAMEZ</h3>
\r
3499 <div class="literalblock">
\r
3500 <div class="content">
\r
3501 <pre><code>Data stack: ( tfa -- char* )</code></pre>
\r
3503 <div class="paragraph"><p>"TFA>NAMEZ" is a function word that pushes changes a tfa pointer to a
\r
3504 pointer to the word pname’s character sequence, which is zero
\r
3505 terminated as well as preceded by a length cell.</p></div>
\r
3506 <div class="exampleblock">
\r
3507 <div class="content">
\r
3508 <div class="sidebarblock">
\r
3509 <div class="content">
\r
3510 <div class="title">Defintion concept for TFA>NAMEZ</div>
\r
3511 <div class="paragraph"><p>: TFA>NAMEZ 32 + ;</p></div>
\r
3514 <div style="text-align:center">
\r
3515 _______________________________________________________
\r
3517 <div class="paragraph"><p><a id="p_then"></a></p></div>
\r
3519 <div class="sect2">
\r
3520 <h3 id="_word_then">Word: THEN</h3>
\r
3521 <div class="literalblock">
\r
3522 <div class="content">
\r
3523 <pre><code>Data stack: Compiling: ( a -- )</code></pre>
\r
3525 <div class="paragraph"><p>"THEN" is an immediate function word that is used together with
\r
3526 <a href="#p_if">IF</a> and <a href="#p_else">ELSE</a> to implement structured execution
\r
3527 control. THEN performs the branch resolution for the stacked address
\r
3528 which pinpoints the foot address the branch offset to resolve, so that
\r
3529 at execution time there is an appropriate conditional branch past the
\r
3530 "then-part" or the "else-part" of the "structured statement".</p></div>
\r
3531 <div style="text-align:center">
\r
3532 _______________________________________________________
\r
3534 <div class="paragraph"><p><a id="p_this_word"></a></p></div>
\r
3536 <div class="sect2">
\r
3537 <h3 id="_word_this_word">Word: THIS-WORD</h3>
\r
3538 <div class="literalblock">
\r
3539 <div class="content">
\r
3540 <pre><code>Data stack: ( -- a )</code></pre>
\r
3542 <div class="paragraph"><p>"THIS-WORD" is a variable word used in
\r
3543 <a href="#p_evaluate_stream:EVALUATE-STREAM">[p_evaluate_stream:EVALUATE-STREAM]</a> as cache for the [n:char*]
\r
3544 values of the successive words being evaluated. This typically points
\r
3545 into the input stream buffer and remain valid until further stream
\r
3546 buffering functions are used.</p></div>
\r
3547 <div style="text-align:center">
\r
3548 _______________________________________________________
\r
3550 <div class="paragraph"><p><a id="p_true"></a></p></div>
\r
3552 <div class="sect2">
\r
3553 <h3 id="_word_true">Word: TRUE</h3>
\r
3554 <div class="literalblock">
\r
3555 <div class="content">
\r
3556 <pre><code>Data stack: ( -- -1 )</code></pre>
\r
3558 <div class="paragraph"><p>"TRUE" is a value word representing logical true.</p></div>
\r
3559 <div style="text-align:center">
\r
3560 _______________________________________________________
\r
3562 <div class="paragraph"><p><a id="p_tuck"></a></p></div>
\r
3564 <div class="sect2">
\r
3565 <h3 id="_word_tuck">Word: TUCK</h3>
\r
3566 <div class="literalblock">
\r
3567 <div class="content">
\r
3568 <pre><code>Data stack ( v1 v2 -- v2 v1 v2 )</code></pre>
\r
3570 <div class="paragraph"><p>"TUCK" is a function word that "inserts" the top cell below the second
\r
3571 cell on the data stack.</p></div>
\r
3572 <div class="exampleblock">
\r
3573 <div class="content">
\r
3574 <div class="sidebarblock">
\r
3575 <div class="content">
\r
3576 <div class="title">Definition concept for TUCK</div>
\r
3577 <div class="paragraph"><p>: TUCK SWAP OVER ;</p></div>
\r
3580 <div style="text-align:center">
\r
3581 _______________________________________________________
\r
3583 <div class="paragraph"><p><a id="p_unequal"></a></p></div>
\r
3585 <div class="sect2">
\r
3586 <h3 id="_word_19">Word: !=</h3>
\r
3587 <div class="literalblock">
\r
3588 <div class="content">
\r
3589 <pre><code>Data stack: ( v1 v2 -- 0/-1 )</code></pre>
\r
3591 <div class="paragraph"><p>"!=" is a function word that replaces a pair of values with -1 of the
\r
3592 values are unequal, and 0 otherwise.</p></div>
\r
3593 <div style="text-align:center">
\r
3594 _______________________________________________________
\r
3596 <div class="paragraph"><p><a id="p_unstream"></a></p></div>
\r
3598 <div class="sect2">
\r
3599 <h3 id="_word_unstream">Word: UNSTREAM</h3>
\r
3600 <div class="literalblock">
\r
3601 <div class="content">
\r
3602 <pre><code>Data stack: ( stream* -- )</code></pre>
\r
3604 <div class="paragraph"><p>"UNSTREAM" is a function word that releases the memory allocated for a
\r
3605 stream, and closes the associated file if it’s a file stream.</p></div>
\r
3606 <div class="sect3">
\r
3607 <h4 id="_file_descriptor_backed_stream_2">File descriptor backed stream</h4>
\r
3608 <div class="paragraph"><p>This kind of stream has the stream header as a prefix within the
\r
3609 allocated memory. Thus, stream* is the base address for the memory to
\r
3610 reclaim, and the size of this is determined from the cell at (stream*
\r
3611 + 16) plus the 32 bytes head itself.</p></div>
\r
3613 <div class="sect3">
\r
3614 <h4 id="_memory_block_backed_stream_2">Memory block backed STREAM</h4>
\r
3615 <div class="paragraph"><p>This kind of stream has a separate header which points at the memory
\r
3616 area to reclaim. The cell at stream* is the base address, and the cell
\r
3617 at (stream* + 16) is its size.</p></div>
\r
3618 <div style="text-align:center">
\r
3619 _______________________________________________________
\r
3621 <div class="paragraph"><p><a id="p_use"></a></p></div>
\r
3624 <div class="sect2">
\r
3625 <h3 id="_word_use">Word: USE</h3>
\r
3626 <div class="literalblock">
\r
3627 <div class="content">
\r
3628 <pre><code>Data value: ( wordlist -- ) Input stream: word</code></pre>
\r
3630 <div class="paragraph"><p>"USE" is a function word that looks up next word given the wordlist.
\r
3631 It reads next word on <a href="#p_input">INPUT</a> via <a href="#p_read_word">READ-WORD</a>,
\r
3632 then temporarily changes <a href="#p_current_wordlist">CURRENT-WORDLIST</a> to
\r
3633 <a href="#p_find">FIND</a> the word via the given wordlist, and returns the TFA
\r
3634 of that word, or just 0 if the word coudn’t be found.</p></div>
\r
3635 <div style="text-align:center">
\r
3636 _______________________________________________________
\r
3638 <div class="paragraph"><p><a id="p_verboseQ"></a></p></div>
\r
3640 <div class="sect2">
\r
3641 <h3 id="_word_verbose">Word: VERBOSE?</h3>
\r
3642 <div class="literalblock">
\r
3643 <div class="content">
\r
3644 <pre><code>Data stack: ( -- a )</code></pre>
\r
3646 <div class="paragraph"><p>"VERBOSE?" is a variable word that is assigned at start up to -1 or 0
\r
3647 signify whether or not the command line arguments includes "-v". When
\r
3648 non-zero (i.e. running rrqforth with "-v") the evaluation loop is more
\r
3649 verbose.</p></div>
\r
3650 <div style="text-align:center">
\r
3651 _______________________________________________________
\r
3653 <div class="paragraph"><p><a id="p_within"></a></p></div>
\r
3655 <div class="sect2">
\r
3656 <h3 id="_word_within">Word: WITHIN</h3>
\r
3657 <div class="literalblock">
\r
3658 <div class="content">
\r
3659 <pre><code>Data stack: ( v lo hi -- 0/-1</code></pre>
\r
3661 <div class="paragraph"><p>"WITHIN" is a function word that replaces a triple of values with -1
\r
3662 of the the first, v, is within the value range spanned by the second,
\r
3663 lo, inclusive and third, hi, exclusive.</p></div>
\r
3664 <div class="exampleblock">
\r
3665 <div class="content">
\r
3666 <div class="sidebarblock">
\r
3667 <div class="content">
\r
3668 <div class="title">Definition concept for WITHIN</div>
\r
3669 <div class="paragraph"><p>: WITHIN 2 PICK > ROT ROT ⇐ AND ;</p></div>
\r
3672 <div style="text-align:center">
\r
3673 _______________________________________________________
\r
3675 <div class="paragraph"><p><a id="p_words"></a></p></div>
\r
3677 <div class="sect2">
\r
3678 <h3 id="_word_words">Word: WORDS</h3>
\r
3679 <div class="literalblock">
\r
3680 <div class="content">
\r
3681 <pre><code>Data stack: ( wl -- )</code></pre>
\r
3683 <div class="paragraph"><p>"WORDS" is a function word that prints all words of teh given word
\r
3684 list to stdout (file descriptor 1).</p></div>
\r
3685 <div style="text-align:center">
\r
3686 _______________________________________________________
\r
3688 <div class="paragraph"><p><a id="p_xor"></a></p></div>
\r
3690 <div class="sect2">
\r
3691 <h3 id="_word_xor">Word: XOR</h3>
\r
3692 <div class="literalblock">
\r
3693 <div class="content">
\r
3694 <pre><code>Data stack: ( v1 v2 -- v3 )</code></pre>
\r
3696 <div class="paragraph"><p>"XOR" is a function word that replaces a value pair with their bitwise
\r
3697 exclusion; each bit is 1 if the corresponding bits of the two operands
\r
3698 differ and 0 if not.</p></div>
\r
3699 <div style="text-align:center">
\r
3700 _______________________________________________________
\r
3702 <div class="paragraph"><p><a id="return_stack"></a></p></div>
\r
3704 <div class="sect2">
\r
3705 <h3 id="_word_return_stack">Word: RETURN-STACK</h3>
\r
3706 <div class="literalblock">
\r
3707 <div class="content">
\r
3708 <pre><code>Data stack: ( -- a )</code></pre>
\r
3710 <div class="paragraph"><p>"RETURN-STACK" is a variable word harbouring the return stack.</p></div>
\r
3714 <div class="sect1">
\r
3715 <h2 id="_system_calls">System calls</h2>
\r
3716 <div class="sectionbody">
\r
3717 <div class="paragraph"><p>RRQFORTH includes function wrapping for all "Linux syscalls", which
\r
3718 generally are described in their "man pages. This wrapping takes the
\r
3719 arguments fro the data stack in reverse order, i.e. the first argument
\r
3720 is deepest.</p></div>
\r
3721 <div class="paragraph"><p>Use <code>SYSTEM WORDS</code> to get a list of all (321) available syscalls.</p></div>
\r
3725 <div id="footnotes"><hr /></div>
\r
3727 <div id="footer-text">
\r
3729 2021-06-11 19:04:48 AEST
\r
projects / rrq / rrqforth.git / blob