-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html>
+<!doctype html>
+<html lang="en">
<head>
-<meta
- http-equiv="Content-Type"
- content="text/html; charset=UTF-8">
-<title>FIFTH</title>
+<title>Fifth - virtual machine, operating system, programming language</title>
+<!-- 2018-01-01 Mon 23:29 -->
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="generator" content="Org-mode">
+<meta name="author" content="Svjatoslav Agejenko">
+<link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+<style type="text/css">
+footer {background-color: #111 !important;}
+pre {background-color: #111; color: #ccc;}
+</style>
+<style type="text/css">
+/* org mode styles on top of twbs */
+
+html {
+ position: relative;
+ min-height: 100%;
+}
+
+body {
+ font-size: 18px;
+ margin-bottom: 105px;
+}
+
+footer {
+ position: absolute;
+ bottom: 0;
+ width: 100%;
+ height: 101px;
+ background-color: #f5f5f5;
+}
+
+footer > div {
+ padding: 10px;
+}
+
+footer p {
+ margin: 0 0 5px;
+ text-align: center;
+ font-size: 16px;
+}
+
+#table-of-contents {
+ margin-top: 20px;
+ margin-bottom: 20px;
+}
+
+blockquote p {
+ font-size: 18px;
+}
+
+pre {
+ font-size: 16px;
+}
+
+.footpara {
+ display: inline-block;
+}
+
+figcaption {
+ font-size: 16px;
+ color: #666;
+ font-style: italic;
+ padding-bottom: 15px;
+}
+
+/* from twbs docs */
+
+.bs-docs-sidebar.affix {
+ position: static;
+}
+@media (min-width: 768px) {
+ .bs-docs-sidebar {
+ padding-left: 20px;
+ }
+}
+
+/* All levels of nav */
+.bs-docs-sidebar .nav > li > a {
+ display: block;
+ padding: 4px 20px;
+ font-size: 14px;
+ font-weight: 500;
+ color: #999;
+}
+.bs-docs-sidebar .nav > li > a:hover,
+.bs-docs-sidebar .nav > li > a:focus {
+ padding-left: 19px;
+ color: #A1283B;
+ text-decoration: none;
+ background-color: transparent;
+ border-left: 1px solid #A1283B;
+}
+.bs-docs-sidebar .nav > .active > a,
+.bs-docs-sidebar .nav > .active:hover > a,
+.bs-docs-sidebar .nav > .active:focus > a {
+ padding-left: 18px;
+ font-weight: bold;
+ color: #A1283B;
+ background-color: transparent;
+ border-left: 2px solid #A1283B;
+}
+
+/* Nav: second level (shown on .active) */
+.bs-docs-sidebar .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav > li > a {
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 30px;
+ font-size: 12px;
+ font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav > li > a:focus {
+ padding-left: 29px;
+}
+.bs-docs-sidebar .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav > .active:focus > a {
+ padding-left: 28px;
+ font-weight: 500;
+}
+
+/* Nav: third level (shown on .active) */
+.bs-docs-sidebar .nav .nav .nav {
+ padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a {
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 40px;
+ font-size: 12px;
+ font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav .nav > li > a:focus {
+ padding-left: 39px;
+}
+.bs-docs-sidebar .nav .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav .nav > .active:focus > a {
+ padding-left: 38px;
+ font-weight: 500;
+}
+
+/* Show and affix the side nav when space allows it */
+@media (min-width: 992px) {
+ .bs-docs-sidebar .nav > .active > ul {
+ display: block;
+ }
+ /* Widen the fixed sidebar */
+ .bs-docs-sidebar.affix,
+ .bs-docs-sidebar.affix-bottom {
+ width: 213px;
+ }
+ .bs-docs-sidebar.affix {
+ position: fixed; /* Undo the static from mobile first approach */
+ top: 20px;
+ }
+ .bs-docs-sidebar.affix-bottom {
+ position: absolute; /* Undo the static from mobile first approach */
+ }
+ .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
+ margin-top: 0;
+ margin-bottom: 0
+ }
+}
+@media (min-width: 1200px) {
+ /* Widen the fixed sidebar again */
+ .bs-docs-sidebar.affix-bottom,
+ .bs-docs-sidebar.affix {
+ width: 263px;
+ }
+}
+</style>
+<script type="text/javascript">
+$(function() {
+ 'use strict';
+
+ $('.bs-docs-sidebar li').first().addClass('active');
+
+ $(document.body).scrollspy({target: '.bs-docs-sidebar'});
+
+ $('.bs-docs-sidebar').affix();
+});
+</script>
+
+<script type="text/x-mathjax-config">
+MathJax.Hub.Config({
+ displayAlign: "center",
+ displayIndent: "2em",
+ messageStyle: "none",
+ "HTML-CSS": {
+ scale: 100,
+ styles: {
+ ".MathJax_Display": {
+ "font-size": "100%"
+ }
+ }
+ },
+ "SVG": {
+ scale: 100,
+ styles: {
+ ".MathJax_SVG_Display": {
+ "font-size": "100%",
+ "margin-left": "-2.281em"
+ }
+ }
+ }
+});
+</script>
+<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_SVG"></script>
</head>
<body>
- <h1>FIFTH - virtual machine, operating system, programming language</h1>
- <a href="http://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=snapshot;h=HEAD;sf=tgz">Download</a>
-
- <a href="http://www2.svjatoslav.eu/gitbrowse/fifth/doc/index.html">Online homepage</a>
-
- <a href="http://svjatoslav.eu/programs.jsp">Other applications hosted on svjatoslav.eu</a>
- <pre>
-<b>Program author:</b>
- Svjatoslav Agejenko
- Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
- Email: <a href="mailto:svjatoslav@svjatoslav.eu">svjatoslav@svjatoslav.eu</a>
-
-This software is distributed under <a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU GENERAL PUBLIC LICENSE Version 2</a>.
-
-<h2>Introduction</h2>
-
-Fifth is programming lanquage & operating system, running on
-<a href="emulator.html">virtual CPU</a>, with custom instruction set. It is much like
-Charles Chunk Moore's Forth, it also uses stack architecture,
-and many commands are similar. Basically I got familiar with
-concepts of Forth, and being inspired created my own system.
-<p />
-Note:
-<i>
-Current implementation does not support object oriented programming.
-While working on Fifth I got lots of cool new ideas that require reimplementation
-of everything.
-
-Currently I try to implement those new ideas in the project called <a
- href="http://svjatoslav.eu/static/gitbrowse/sixth/doc/index.html">Sixth</a>.
-</i>
-<br />
-<a href="shots/index.html">Screenshots</a>
-
-Read more about:
-<br> <a href="emulator.html">Virtual CPU</a>
-<br> <a href="commands/index.html">Built-in commands</a>
-<br> <a href="modules/index.html">Additional commands, realized as loadable modules</a>
-<br> <a href="5TH_ET.txt">Example Fifth source file - text editor </a>
-
-
- <h2>Installation</h2>
+<div id="content" class="container">
+<div class="row"><div class="col-md-9"><h1 class="title">Fifth - virtual machine, operating system, programming language</h1>
+<hr >
+<ul class="org-ul">
+<li><a href="http://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=snapshot;h=HEAD;sf=tgz">download latest snapshot</a>
+</li>
-Just unpack all files, witout altering original directory structure,
-somewhere in your hard disk. For example: C:\MISC\FIFTH\....
-To run fifth you need minimally just 2 files.
-emulator itself ( EMULATOR.EXE or EMULATOR.COM ), and
-virtual disk file ( DISK.RAW ).
-Read more about <a href="files.txt">distribution directory layout</a>.
+<li>This program is free software; you can redistribute it and/or modify it under
+the terms of version 3 of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> or later as
+published by the Free Software Foundation.
+</li>
+
+<li>Program author:
+<ul class="org-ul">
+<li>Svjatoslav Agejenko
+</li>
+<li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
+</li>
+<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
+</li>
+</ul>
+</li>
+
+<li><a href="http://www.svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
+</li>
+</ul>
+
+<div id="outline-container-sec-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> !Project deprecated!</h2>
+<div class="outline-text-2" id="text-1">
+<p>
+Current implementation does not support object oriented
+programming. While working on Fifth I got lots of cool new ideas that
+require reimplementation of everything.
+</p>
+
+<p>
+Currently I try to implement those new ideas in the project called
+<a href="http://www2.svjatoslav.eu/gitbrowse/sixth/doc/index.html">Sixth</a>
+</p>
+<p>
+System is built many years ago when I was still using DOS as a primary
+operating system.
+</p>
+</div>
+</div>
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Introduction</h2>
+<div class="outline-text-2" id="text-2">
+<p>
+Fifth is programming lanquage & operating system, running on <i>virtual
+CPU</i>, with custom instruction set. It is much like Charles Chunk
+Moore's Forth, it also uses stack architecture, and many commands are
+similar. Basically I got familiar with concepts of Forth, and being
+inspired created my own system.
+</p>
+<ul class="org-ul">
+<li><a href="5TH_ET.txt">Example Fifth source file - text editor</a>
+</li>
+</ul>
+</div>
+<div id="outline-container-sec-2-1" class="outline-3">
+<h3 id="sec-2-1"><span class="section-number-3">2.1</span> screenshots</h3>
+<div class="outline-text-3" id="text-2-1">
+<ul class="org-ul">
+<li><img src="screenshots/start.png" class="img-responsive" alt="start.png">
+<ul class="org-ul">
+<li>Startup screen diplaying Fifth logo and full file list.
+</li>
+</ul>
+</li>
- <h2>Software/Hardware/Human requirements</h2>
+<li><img src="screenshots/dictionary.png" class="img-responsive" alt="dictionary.png">
+<ul class="org-ul">
+<li>Sample words defined. Most of the words are commands that can be
+executed interactively from command line or from file. When
+executed they can be selectively compiled or interpreted.
+</li>
+</ul>
+</li>
+<li><img src="screenshots/text editor.png" class="img-responsive" alt="text editor.png">
+<ul class="org-ul">
+<li>Built in text editor.
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+</div>
-Software:
- MS-DOS 6.22, with HIMEM.SYS loaded.
- Mouse driver if you have a mouse.
- Does work only when CPU is in real mode.
- To recompile ASM sources I used FASM (Flat Assembler).
- I ran QBasic utilities on QB 4.5 .
- VESA support by BIOS, or external driver (UNIVBE).
+<div id="outline-container-sec-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> Installation</h2>
+<div class="outline-text-2" id="text-3">
+<p>
+Just unpack all files, witout altering original directory structure,
+somewhere in your hard disk. For example: C:\MISC\FIFTH\…. To run
+fifth you need minimally just 2 files. emulator itself ( EMULATOR.EXE
+or EMULATOR.COM ), and virtual disk file ( DISK.RAW ).
+</p>
+
+<p>
+Read more about <i>distribution directory layout</i>
+</p>
+</div>
+</div>
+<div id="outline-container-sec-4" class="outline-2">
+<h2 id="sec-4"><span class="section-number-2">4</span> Fifth distribution directory tree description</h2>
+<div class="outline-text-2" id="text-4">
+<p>
+After downloading and unpacking the ZIP file you shoud get directory
+tree similar to this:
+</p>
-Hardware:
- Minimum CPU 386.
- 64 KB free RAM below 640KB,
- 2 MB of free XMS.
- VESA compatible video card.
+<p class="verse">
+[DOC] - Fifth documentation<br >
+  [commands] - documentation on Fifth built-in commands<br >
+  [modules] - documentation on additional commands, realized as loadable modules<br >
+  [shots] - Fifth screenshots<br >
+<br >
+[imageFile] - files contained within 'disk.raw', just an extracted form.<br >
+<br >
+[source] - source files<br >
+  [emulator] - emulator source<br >
+  [util] - utilites<br >
+<br >
+disk.raw - Virtual disk file, has filesystem inside.<br >
+emulator.com - main executable.<br >
+</p>
+</div>
+</div>
-Human:
- Beginner level Forth knowledge is recommended.
- Enthusiasm.
+<div id="outline-container-sec-5" class="outline-2">
+<h2 id="sec-5"><span class="section-number-2">5</span> Software/Hardware/Human requirements</h2>
+<div class="outline-text-2" id="text-5">
+</div><div id="outline-container-sec-5-1" class="outline-3">
+<h3 id="sec-5-1"><span class="section-number-3">5.1</span> Software</h3>
+<div class="outline-text-3" id="text-5-1">
+<ul class="org-ul">
+<li>MS-DOS 6.22, with HIMEM.SYS loaded.
+</li>
+<li>Mouse driver if you have a mouse.
+</li>
+<li>Does work only when CPU is in real mode.
+</li>
+<li>To recompile ASM sources I used FASM (Flat Assembler).
+</li>
+<li>I ran QBasic utilities on QB 4.5 .
+</li>
+<li>VESA support by BIOS, or external driver (UNIVBE).
+</li>
+</ul>
+</div>
+</div>
+<div id="outline-container-sec-5-2" class="outline-3">
+<h3 id="sec-5-2"><span class="section-number-3">5.2</span> Hardware</h3>
+<div class="outline-text-3" id="text-5-2">
+<ul class="org-ul">
+<li>Minimum CPU 386.
+</li>
+<li>64 KB free RAM below 640KB,
+</li>
+<li>2 MB of free XMS.
+</li>
+<li>VESA compatible video card.
+</li>
+</ul>
+</div>
+</div>
+<div id="outline-container-sec-5-3" class="outline-3">
+<h3 id="sec-5-3"><span class="section-number-3">5.3</span> Human</h3>
+<div class="outline-text-3" id="text-5-3">
+<ul class="org-ul">
+<li>Beginner level Forth knowledge is recommended.
+</li>
+<li>Lots of enthusiasm.
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-6" class="outline-2">
+<h2 id="sec-6"><span class="section-number-2">6</span> Numbers representation within Fifth</h2>
+<div class="outline-text-2" id="text-6">
+<figure>
+<p><a href="numbers.png"><img src="numbers.png" class="img-responsive" alt="numbers.png"></a>
+</p>
+</figure>
+<p>
+Because I can define everything, starting from CPU, why not try also
+alternative and unique number representation ?
+</p>
- <h2>Numbers representation</h2>
+<p>
+Fifth uses its hexdecimal number representation as primary. Numbers
+shape is formed by dividing a square into four parts. And manipulating
+their color (black or white).
+</p>
+</div>
+</div>
+<div id="outline-container-sec-7" class="outline-2">
+<h2 id="sec-7"><span class="section-number-2">7</span> Disk file map, and it's data structures</h2>
+<div class="outline-text-2" id="text-7">
+<p>
+Core and high-level boot code is stored outside of the filesystem to
+allow easy access to it, at early booting time, when filesystem is not
+yet initialized.
+</p>
+</div>
+<div id="outline-container-sec-7-1" class="outline-3">
+<h3 id="sec-7-1"><span class="section-number-3">7.1</span> disk allocation</h3>
+<div class="outline-text-3" id="text-7-1">
+<table class="table table-striped table-bordered table-hover table-condensed">
-<img src="numbers.png">
-Fifth uses hexdecimal number representation as primary.
-Numbers shape is formed by dividing a square into four parts.
-And manipulating their color (black or white).
+<colgroup>
+<col class="left">
+<col class="left">
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-left">offset</th>
+<th scope="col" class="text-left">length</th>
+<th scope="col" class="text-left">description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-left">0</td>
+<td class="text-left">~4 Kb</td>
+<td class="text-left">Fifth core</td>
+</tr>
- <h2>Disk file map, and it's data structures</h2>
+<tr>
+<td class="text-left">4 Kb</td>
+<td class="text-left">~32Kb</td>
+<td class="text-left">high-level boot code</td>
+</tr>
+<tr>
+<td class="text-left">37 Kb</td>
+<td class="text-left">~65Kb</td>
+<td class="text-left">FAT</td>
+</tr>
-Core and high-level boot code is stored outside of the filesystem to allow
-easy access to it, at early booting time, when filesystem is not yet
-initialized.
+<tr>
+<td class="text-left">101Kb</td>
+<td class="text-left">~16MB</td>
+<td class="text-left">filesystem data area</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div id="outline-container-sec-7-2" class="outline-3">
+<h3 id="sec-7-2"><span class="section-number-3">7.2</span> FAT entry format:</h3>
+<div class="outline-text-3" id="text-7-2">
+<table class="table table-striped table-bordered table-hover table-condensed">
- disk allocation:
-offset length description
+<colgroup>
+<col class="right">
-0 ~4 Kb Fifth core
-4 Kb ~32Kb high-level boot code
-37 Kb ~65Kb FAT
-101Kb ~16MB filesystem data area
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right">code</th>
+<th scope="col" class="text-left">meaning</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">-2</td>
+<td class="text-left">last sector</td>
+</tr>
- FAT entry format:
+<tr>
+<td class="text-right">-1</td>
+<td class="text-left">empty sector</td>
+</tr>
--2 last sector
--1 empty sector
-0 -- .. pointer to next block
+<tr>
+<td class="text-right">0 --</td>
+<td class="text-left">.. pointer to next block</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div id="outline-container-sec-7-3" class="outline-3">
+<h3 id="sec-7-3"><span class="section-number-3">7.3</span> file entry format</h3>
+<div class="outline-text-3" id="text-7-3">
+<table class="table table-striped table-bordered table-hover table-condensed">
- file entry format
-offset length description
+<colgroup>
+<col class="right">
-0 4 extension
-4 16 name
-20 4 entry point
-24 4 size
-28 4 last modification time
+<col class="right">
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right">offset</th>
+<th scope="col" class="text-right">length</th>
+<th scope="col" class="text-left">description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">0</td>
+<td class="text-right">4</td>
+<td class="text-left">extension</td>
+</tr>
+<tr>
+<td class="text-right">4</td>
+<td class="text-right">16</td>
+<td class="text-left">name</td>
+</tr>
- <h2>Core architecture</h2>
+<tr>
+<td class="text-right">20</td>
+<td class="text-right">4</td>
+<td class="text-left">entry point</td>
+</tr>
+<tr>
+<td class="text-right">24</td>
+<td class="text-right">4</td>
+<td class="text-left">size</td>
+</tr>
+<tr>
+<td class="text-right">28</td>
+<td class="text-right">4</td>
+<td class="text-left">last modification time</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-8" class="outline-2">
+<h2 id="sec-8"><span class="section-number-2">8</span> Core architecture</h2>
+<div class="outline-text-2" id="text-8">
+<p>
Fifth core is simply some amount of already compiled into machine code
and linked together modules (entries in other words). In compilation
process modules is compiled one by one and simply stored on top of
already existing and growing core. Separately from core is kept
-dictionary, this is special list that contain names of compiled modules,
-variables etc. and they locations in core. Constants use dictionary space
-only. Random word can be removed from dictionary at any time. Currently
-dictionary can contain at most 1000 entries.
+dictionary, this is special list that contain names of compiled
+modules, variables etc. and they locations in core. Constants use
+dictionary space only. Random word can be removed from dictionary at
+any time. Currently dictionary can contain at most 1000 entries.
+</p>
+</div>
+<div id="outline-container-sec-8-1" class="outline-3">
+<h3 id="sec-8-1"><span class="section-number-3">8.1</span> Dictionary entry format</h3>
+<div class="outline-text-3" id="text-8-1">
+<table class="table table-striped table-bordered table-hover table-condensed">
+
+
+<colgroup>
+<col class="right">
+
+<col class="right">
+
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right">offset</th>
+<th scope="col" class="text-right">length</th>
+<th scope="col" class="text-left">description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">0</td>
+<td class="text-right">4</td>
+<td class="text-left">0 &lt; previous entry</td>
+</tr>
+
+<tr>
+<td class="text-right"> </td>
+<td class="text-right"> </td>
+<td class="text-left">0 = last</td>
+</tr>
+
+<tr>
+<td class="text-right"> </td>
+<td class="text-right"> </td>
+<td class="text-left">-1 = empty</td>
+</tr>
+</tbody>
+<tbody>
+<tr>
+<td class="text-right">4</td>
+<td class="text-right">15</td>
+<td class="text-left">module name string</td>
+</tr>
+</tbody>
+<tbody>
+<tr>
+<td class="text-right">19</td>
+<td class="text-right">1</td>
+<td class="text-left">entry type</td>
+</tr>
+</tbody>
+<tbody>
+<tr>
+<td class="text-right">20</td>
+<td class="text-right">4</td>
+<td class="text-left">entry data</td>
+</tr>
+</tbody>
+</table>
+
+<p>
+Core headers as linked list of module names make up something like
+dictionary. When some entry address is needed compiler can quickly
+run through headers backwards and find needed entry.
+</p>
+</div>
+</div>
+<div id="outline-container-sec-8-2" class="outline-3">
+<h3 id="sec-8-2"><span class="section-number-3">8.2</span> Possible module types</h3>
+<div class="outline-text-3" id="text-8-2">
+<table class="table table-striped table-bordered table-hover table-condensed">
+
+
+<colgroup>
+<col class="right">
+
+<col class="left">
+
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right">type</th>
+<th scope="col" class="text-left">description</th>
+<th scope="col" class="text-left">"execute" action</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">0</td>
+<td class="text-left">data</td>
+<td class="text-left">compile "num" instruction</td>
+</tr>
+
+<tr>
+<td class="text-right"> </td>
+<td class="text-left"> </td>
+<td class="text-left">with address to module</td>
+</tr>
+</tbody>
+<tbody>
+<tr>
+<td class="text-right">1</td>
+<td class="text-left">submodule</td>
+<td class="text-left">compile "call" instruction</td>
+</tr>
+
+<tr>
+<td class="text-right"> </td>
+<td class="text-left"> </td>
+<td class="text-left">with address to module</td>
+</tr>
+</tbody>
+<tbody>
+<tr>
+<td class="text-right">2</td>
+<td class="text-left">imm. submodule</td>
+<td class="text-left">immediately call to module</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div id="outline-container-sec-8-3" class="outline-3">
+<h3 id="sec-8-3"><span class="section-number-3">8.3</span> Memory map (average)</h3>
+<div class="outline-text-3" id="text-8-3">
+<table class="table table-striped table-bordered table-hover table-condensed">
+
+
+<colgroup>
+<col class="right">
+
+<col class="left">
+
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right"><loc></th>
+<th scope="col" class="text-left"><size></th>
+<th scope="col" class="text-left"><desc></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">0</td>
+<td class="text-left">~4096</td>
+<td class="text-left">core</td>
+</tr>
+
+<tr>
+<td class="text-right">1500000</td>
+<td class="text-left">~32000</td>
+<td class="text-left">highlevel Fifth boot code</td>
+</tr>
+
+<tr>
+<td class="text-right">200000h</td>
+<td class="text-left"> </td>
+<td class="text-left">core startup messages area</td>
+</tr>
+
+<tr>
+<td class="text-right">5200000</td>
+<td class="text-left"> </td>
+<td class="text-left">end of dynamic memory space</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-9" class="outline-2">
+<h2 id="sec-9"><span class="section-number-2">9</span> Virtual machine</h2>
+<div class="outline-text-2" id="text-9">
+<p>
+Using CPU emulator slows it down but I shouldn't now think too mutch
+about, and waste my time on batteling with problems whitch results on
+complex design of PC hardware. Also it allows me to use existing DOS
+and resident drivers services in real mode. So I don't need to deal
+with hardware too mutch. It also allows me to use all free XMS for
+flat code & data storage.
+</p>
+
+<p>
+Current emulator emulates 1 CPU. It has 2 stacks, ~50 instructions,
+and 4GB flat address space (theoretically). I'm not sure that DOS
+6.22 that I currently prefer can handle more than 64 MB of RAM. While
+I tried to keep instructionset simple, I was forced to put in lot of
+complex instructions to make it's performance acceptable on
+emulator. On actual silicon ~20 instructions is enaugh (I think).
+</p>
+
+<p>
+Maybe one day similar system will run directly on custom silicon chip :)
+</p>
+
+<p>
+CPU has following registers:
+</p>
+<table class="table table-striped table-bordered table-hover table-condensed">
- dictionary entry format
-offset length description
+<colgroup>
+<col class="left">
-0 4 0 < previous entry
- 0 = last
- -1 = empty
-4 15 module name string
-19 1 entry type
-20 4 entry data
+<col class="left">
+</colgroup>
+<tbody>
+<tr>
+<td class="text-left">IP</td>
+<td class="text-left">instruction pointer</td>
+</tr>
-Core headers as linked list of module names make up something like dictionary.
-When some entry address is needed compiler can quickly run through headers
-backwards and find needed entry.
+<tr>
+<td class="text-left">DSP</td>
+<td class="text-left">data stack pointer</td>
+</tr>
- Possible module types
+<tr>
+<td class="text-left">RSP</td>
+<td class="text-left">return stack pointer</td>
+</tr>
+</tbody>
+</table>
-type description "execute" action
+<p>
+Virtual CPU, commands (most of them are avaiable as ordinary commands
+in programming lanquage):
+</p>
-0 data compile "num" instruction
- with address to module
-1 submodule compile "call" instruction
- with address to module
-2 imm. submodule immediately call to module
+<p class="verse">
+<br >
+code mnemonic description<br >
+<br >
+0 nop does notheing<br >
+1 halt halt CPU ( return to DOS on emulator )<br >
+<br >
+2 kbd@ ( – c ) read scancode of pressed or released key.<br >
+                                Returns 0, if no data avaiable.<br >
+3 num <dword> ( – n ) put immidiate number into datastack<br >
+<br >
+4 jmp <dword> jump to specified code<br >
+5 call <dword>jump to specified code, save return address to<br >
+                                return stack.<br >
+<br >
+6 1+ ( n – n+1 )<br >
+7 1- ( n – n-1 )<br >
+<br >
+8 dup ( n – n n ) duplicate top of data stack<br >
+9 drop ( n – ) drop last element in data stack<br >
+<br >
+10 if <dword> ( n – ) jump to addr if top element was 0<br >
+11 ret jump to code, specified in return stack.<br >
+<br >
+12 c@ ( addr – n ) read byte from memory at specified address<br >
+13 c! ( n addr – ) store byte to specified memory<br >
+<br >
+14 push ( DSTK -> RSTK ) move top of datastack to returnstack<br >
+15 pop ( RSTK -> DSTK ) move top of returnstack to datastack<br >
+<br >
+16 <unused><br >
+17 rot ( n1 n2 n3 – n2 n3 n1) rotate stack elements<br >
+<br >
+18 disk@ ( FromDiskSect ToMem – ) read 1KB from disk into RAM<br >
+19 disk! ( FromMem ToDiskSect – ) write 1KB to disk<br >
+<br >
+20 @ ( addr – n ) read 32 bit number from memory<br >
+21 ! ( n addr – ) store 32 bit number to memory<br >
+<br >
+22 over ( n1 n2 – n1 n2 n1 ) self explaining …<br >
+23 swap ( n1 n2 – n2 n1 ) -,,-<br >
+<br >
+24 + ( n1 n2 – n1+n2 ) -,,-<br >
+25 - ( n1 n2 – n1-n2 ) -,,-<br >
+<br >
+26 * ( n1 n2 – n1*n2 ) -,,-<br >
+27 / ( n1 n2 – n1/n2 ) -,,-<br >
+<br >
+28 > ( n1 n2 – result ) is true when n1 > n2<br >
+29 < ( n1 n2 – result ) is true when n1 < n2<br >
+<br >
+30 not ( n1 – not_n1 ) logical not<br >
+31 i ( – n ) copies top of return stack into datastack<br >
+<br >
+32 cprt@ ( addr – n ) read one byte from hardware port<br >
+33 cprt! ( n addr – ) store one byte to hardware port<br >
+<br >
+34 i2 ( – n ) like "i" but takes socond top stack element.<br >
+35 i3 ( – n ) like "i" but takes third top stack element.<br >
+<br >
+36 shl ( n amount – n ) left bit shift<br >
+37 shr ( n amount – n ) right bit shift<br >
+<br >
+38 or ( n1 n2 – n ) logical or<br >
+39 xor ( n1 n2 – n ) exclusive logical or<br >
+<br >
+40 vidmap ( addr – ) copy memory from "addr" to video memory.<br >
+<br >
+41 mouse@ ( – x y button ) read mouse coordinates & buttons<br >
+<br >
+42 vidput ( addr1 addr2 x y – ) put image1 into image2, at<br >
+                                location x, y. Does clipping, so part of a big image<br >
+                                can be mapped into smaller one.<br >
+<br >
+43 cmove ( addr1 addr2 amount ) move memory from addr1 to addr2<br >
+                                if addr1 is greater than addr2 then count address<br >
+                                foward while moving, elseway starts from end and<br >
+                                counts backwards, so no data loss will occure on<br >
+                                overlapping.<br >
+<br >
+44 cfill ( c addr amount – ) fill memory starting at "addr"<br >
+                                with "c" bytes.<br >
+<br >
+45 tvidput ( addr1 addr2 x y – ) same as "vidput" but treats<br >
+                                color 255 in source image as transparent.<br >
+<br >
+46 depth ( – depth ) returns current depth of data stack.<br >
+<br >
+47 charput ( colorfg colorbg addrsrc addrdest x y )<br >
+                                draw character to image buffer located at "addrdest"<br >
+                                to specified x & y location. Decodes 8 bytes from<br >
+                                source to bits, used to draw character.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-10" class="outline-2">
+<h2 id="sec-10"><span class="section-number-2">10</span> Fifth source format</h2>
+<div class="outline-text-2" id="text-10">
+<p>
+Fifth uses a different character table and codes than ASCII (still
+almost similar). I call it FSCII (Fifth Standard Code for Information
+Interchange) for example space character is not 32 but 255 instead. I
+plan to use mainly HEX numbers, and create new characters to represent
+numeric values. So typical nemric characters "0123…" is treated
+like ordinary letters.
+</p>
+</div>
+<div id="outline-container-sec-10-1" class="outline-3">
+<h3 id="sec-10-1"><span class="section-number-3">10.1</span> FSCII</h3>
+<div class="outline-text-3" id="text-10-1">
+<table class="table table-striped table-bordered table-hover table-condensed">
- Memory map: (average)
-<loc> <size> <desc>
-0 ~4096 core
-1500000 ~32000 highlevel Fifth boot code
-200000h core startup messages area
-5200000 end of dynamic memory space
+<colgroup>
+<col class="right">
+<col class="left">
+<col class="left">
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="text-right">DEC</th>
+<th scope="col" class="text-left">HEX</th>
+<th scope="col" class="text-left">function</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="text-right">0 - 15</td>
+<td class="text-left">0 - F</td>
+<td class="text-left">HEX numbers</td>
+</tr>
- <h2>Fifth source format</h2>
+<tr>
+<td class="text-right">252</td>
+<td class="text-left">FC</td>
+<td class="text-left">backspace</td>
+</tr>
+<tr>
+<td class="text-right">253</td>
+<td class="text-left">FD</td>
+<td class="text-left">tabulator (TAB)</td>
+</tr>
-Fifth uses a different character table and codes than ASCII.
-I call it FSCII (Fifth Standard Code for Information Interchange)
-for example space character is not 32 but 255 instead.
-I plan to use mainly HEX numbers, and create new characters
-to represent numeric values. So typical nemric characters "0123..."
-is treated like ordinary letters.
+<tr>
+<td class="text-right">254</td>
+<td class="text-left">FE</td>
+<td class="text-left">carriage return (CR)</td>
+</tr>
- FSCII:
+<tr>
+<td class="text-right">255</td>
+<td class="text-left">FF</td>
+<td class="text-left">space</td>
+</tr>
-DEC HEX function
+<tr>
+<td class="text-right">else</td>
+<td class="text-left"> </td>
+<td class="text-left">ordinary characters, same as in ASCII.</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-11" class="outline-2">
+<h2 id="sec-11"><span class="section-number-2">11</span> Fifth commands</h2>
+<div class="outline-text-2" id="text-11">
+</div><div id="outline-container-sec-11-1" class="outline-3">
+<h3 id="sec-11-1"><span class="section-number-3">11.1</span> Compilation & miscellaneous</h3>
+<div class="outline-text-3" id="text-11-1">
+<p class="verse">
+init module ( – )<br >
+                First module, control is passed to on startup. Contains<br >
+                initialization routines. Also it is the last core module.<br >
+                All new modules on top of it comes as result of executing<br >
+                external source files.<br >
+<br >
+head <name> ( – ) compiles new dictionary entry without specifying<br >
+                new module type.<br >
+                ex: head myentry<br >
+<br >
+: <name> ( – ) creates new code module<br >
+; ( – ) ends module (immideate)<br >
+                ex: : hello ." hi there" ;<br >
+<br >
+const <name> ( n – ) defines new constant.<br >
+                ex: 2147483647 const max<br >
+<br >
+:i <name> ( – ) same as ":" but this module will be executed<br >
+                immideately even in compile mode.<br >
+                ex: :i ( 41 scan ;<br >
+<br >
+create <name> ( – ) same as "head" , but specify module type as data.<br >
+                ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 ,<br >
+<br >
+allot ( n – ) allocate n bytes in dictionary.<br >
+                ex: create MyArray 100 allot<br >
+<br >
+" <string>" ( – ) compile string and its size into core.<br >
+                ex: create Mystring " This is it's contects"<br >
+<br >
+str <name> <string>" ( – ) just shorter way for defining strings.<br >
+                ex: str Mystring This is it's contenc"<br >
+<br >
+var <name> ( – ) define new 32 bit variable.<br >
+                ex: var result<br >
+<br >
+' <module> ( – n ) return memory address of given entry.<br >
+                ex: ' init<br >
+<br >
+forget <name> ( – ) erases from RAM given entry and all entries what was<br >
+                defined after it.<br >
+                ex: forget myprog<br >
+<br >
+[ ( – ) set interpret mode (immideate)<br >
+] ( n – ) set compile mode and compile top stack element<br >
+                in as literal. Together [ …. ] cobination provides good<br >
+                way to compute some values only once, at compile time,<br >
+                rather than every time while program is running.<br >
+                ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ;<br >
+<br >
+defer <name> ( – ) creates new module, with jump instruction.<br >
+                Later address where to jump can be modified by "is" command.<br >
+                This provides method of foward referencing. So you can use<br >
+                modules what not jet exist.<br >
+is ( address1 address2 – ) address1 - where to jump, address2 -<br >
+                address of module created by defer command.<br >
+                ex: defer dispver<br >
+                        : run dispver ." running …" ;<br >
+                               … whatever …<br >
+                        : (dispver ." Version 9.99 " ;<br >
+                        ' (dispver ' dispver is<br >
+<br >
+                Now if I type "run" on the screen appears:<br >
+                        Version 9.99 running …<br >
+<br >
+asc <char> ( – ) reads char ascii code and treats it as literal.<br >
+                (immideate)<br >
+                ex: : BreakLine 30 do asc - emit loop ;<br >
+                                 same as:<br >
+                    : BreakLine 30 do 45 emit loop ;<br >
+<br >
+dyninc ( handle – ) execute code in dynamic memory handle.<br >
+                automatically deallocates it when done.<br >
+<br >
+include ( filenumber – ) execute code in specified file.<br >
+<br >
+words ( – ) display existing blocks in core.<br >
+<br >
+bye ( – ) exit from Fifth<br >
+<br >
+fkey ( – c )<br >
+                Read one byte from input stream.<br >
+<br >
+sadd ( c addr – )<br >
+                Add one byte "c" to string located at "addr" and updates<br >
+                string length.<br >
+<br >
+scan ( c – )<br >
+                Read input stream and store it to pad until it finds c .<br >
+                It ignores all "c" bytes until it finds any non "c" byte.<br >
+                in other words:<br >
+                                c is: "<br >
+                         input stream: """"This is test !"aoeu idh<br >
+                               result: This is test !<br >
+<br >
+                Is useful for breaking text lines into words.<br >
+<br >
+skey ( – c )<br >
+                So called safe "fkey". Reads data from input stream<br >
+                but converts characters with ASCII codes: 9 13 10<br >
+                to spaces.<br >
+<br >
+str=str? ( adr1 adr2 – result )<br >
+                Compares string at "adr1" with string at "adr2", returns<br >
+                true flag if they are equal or false if they are not.<br >
+                true = -1<br >
+                false = 0<br >
+<br >
+find ( – addr )<br >
+                Searches whole dictionary for word in "pad". If found,<br >
+                returns it address, if not, returns 0.<br >
+<br >
+execute ( – )<br >
+                Execute word located in "pad". Depending on "mode".<br >
+<br >
+dta ( addr – DataAddr )<br >
+                Calculates address of dictionary entry data area, from<br >
+                entry point.<br >
+<br >
+2num ( – num result )<br >
+                Attempt to convert string located in "pad" into numeric<br >
+                value. If succeed returns number and true as result.<br >
+                If not, returns whatever and false as result.<br >
+<br >
+dadd ( addr length – )<br >
+                Add to dictionary data located at "addr", with specified<br >
+                length.<br >
+<br >
+lit ( n – )<br >
+                Act with number depending on "mode". When interpreting,<br >
+                leaves it in stack.<br >
+<br >
+<br >
+incmod ( addr – )<br >
+                Add to dictionary data located at "addr"+1 , length is taken<br >
+                from "addr".<br >
+<br >
+here ( – n )<br >
+                return "h" contents.<br >
+<br >
+mode var 8 bit<br >
+                Holds input stream parser operation mode.<br >
+                0 = interpreting<br >
+                1 = compiling<br >
+<br >
+pad var 128 bytes<br >
+                Holds temprorary strings.<br >
+<br >
+h var 32 bit<br >
+                Pointer to free byte in memory, always at the end of the<br >
+                dictionary. Each time when something is stored<br >
+                by "c," command, pointer is incareased.<br >
+<br >
+lp var 32 bit<br >
+                Pointer to last dictionary word. Each time when new word is<br >
+                compiled or erased by "forget", this pointer is updated.<br >
+<br >
+modulechk ( Dstr<filename> – ) check if module is loaded, if not<br >
+                immideately load it.<br >
+<br >
+ne ( entrydata entrytype – ) Compile new dictionary entry.<br >
+                It's name must be in "pad".<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-2" class="outline-3">
+<h3 id="sec-11-2"><span class="section-number-3">11.2</span> Conditionals & control flow</h3>
+<div class="outline-text-3" id="text-11-2">
+<p class="verse">
+if ( flag – ) (immideate)<br >
+                "if 1.. else 2.. then" or<br >
+                "if 1.. then" construction. Conditional execution.<br >
+                Performs "1.." if "flag" was true,<br >
+                elseway performs "2.." if exist. Execution continues after<br >
+                word "then".<br >
+                ex: 1 if ." nonzero" else ." zero" then<br >
+<br >
+>= ( n1 n2 – result ) true if (n1 = n2) or (n1 > n2)<br >
+                ex: 5 3 >= if ." first number is greater or equal" then<br >
+<br >
+<= ( n1 n2 – result ) true if (n1 = n2) or (n1 < n2)<br >
+= ( n1 n2 – result ) true if n1 = n2<br >
+<br >
+do ( count – ) (immideate)<br >
+                "do .. loop" construction. Performs ".." "count" times.<br >
+                In every step "count" is decareased until it is 0.<br >
+                ex: : test 5 do i .d loop ;<br >
+                result: 4 3 2 1 0<br >
+<br >
+doexit ( – ) exit from "do .. loop"<br >
+<br >
+for ( count top – ) (immideate)<br >
+                "for .. loop" construction. Performs ".." (top - count) times.<br >
+                In every step "count" is incareased until it reaches "top" .<br >
+                ex: : test 4 10 for i .d loop ;<br >
+                result: 4 5 6 7 8 9<br >
+<br >
+forexit ( – ) exit from "for .. loop"<br >
+<br >
+until ( – ) (immideate)<br >
+                "until .. loop" construction. Performs ".." until flag become<br >
+                true. False by default. Top of return stack holds flag.<br >
+<br >
+done ( – ) exit from "until .. loop"<br >
+<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-3" class="outline-3">
+<h3 id="sec-11-3"><span class="section-number-3">11.3</span> Disk & file access</h3>
+<div class="outline-text-3" id="text-11-3">
+<p class="verse">
+diskload ( FromDisk ToMem amount – )<br >
+                Load specified abount of bytes from disk into memory.<br >
+<br >
+disksave ( FromMem ToDisk amount – )<br >
+                save specified abount of bytes from memory into disk.<br >
+<br >
+format ( – ) Erase all files.<br >
+<br >
+fsDfilesize@ ( handle – size )<br >
+                Return size of opened file.<br >
+<br >
+fsDcurloc@ ( handle – location )<br >
+                Return current location in file.<br >
+<br >
+fsDupdated@ ( handle – updated? )<br >
+                Return true if file was updated,<br >
+                ie. write operations occured.<br >
+<br >
+fssave ( FromMem DestFileHandle amount – )<br >
+                Save data to file.<br >
+<br >
+fsload ( SrcFileHandle ToMem amount – )<br >
+                Load data from file.<br >
+<br >
+fseof ( handle – bytesLeft )<br >
+                Return amount of bytes left till end of file.<br >
+                Useful before read operation.<br >
+<br >
+fsls ( – ) List all files and lists (directories,folders)<br >
+                in current path.<br >
+<br >
+fslsr ( – ) Same as "fsls" but recursively scans also sub lists.<br >
+<br >
+fscl ( DynStrHand – )<br >
+                Change list (path)<br >
+<br >
+fscreate ( DynStrHand – DescPnt )<br >
+                Create new file or list. Can create multiple lists at once.<br >
+                ex: when creating:<br >
+                    "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme"<br >
+                and only "\listGAMES\" already exist, then<br >
+                "listSTRATEGY" and "listSIMWORLD" lists will be created,<br >
+                and empty file "5th-runme" placed in there.<br >
+<br >
+fsDsave ( DynHand<data> DynStrHand<filename> – )<br >
+                Create new file and save all data from dynamic memory<br >
+                block to it.<br >
+<br >
+fsDload ( DynStr<SrcFileName> DynHand<DataDest> – )<br >
+                Load whole file into dynamic memory block.<br >
+<br >
+fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )<br >
+                Load whole file into new dynamic memory block.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-4" class="outline-3">
+<h3 id="sec-11-4"><span class="section-number-3">11.4</span> Dynamic memory</h3>
+<div class="outline-text-3" id="text-11-4">
+<p class="verse">
+dynal ( size – handle )<br >
+                Allocate dynamic memory block and return it's handle.<br >
+<br >
+dynde ( handle – )<br >
+                Deallocate dynamic memory block.<br >
+<br >
+dynp ( handle – addr )<br >
+                Returns pointer to memory where dynamic block<br >
+                data begins.<br >
+<br >
+dyns ( handle – size )<br >
+                Returns size of dynamic block.<br >
+<br >
+dynresize ( NewSize handle – )<br >
+                Nondestructively resize dynamic block.<br >
+<br >
+dync@ ( addr handle )<br >
+                Read one byte from dynamic block.<br >
+<br >
+dync! ( byte addr dynhandle )<br >
+                Write one byte to dynamic block.<br >
+<br >
+dyn@ ( addr handle )<br >
+                Read 32 bit number from dynamic block.<br >
+                Address will spacify, whitch number, not byte.<br >
+<br >
+dyn! ( 32BitNum addr dynhandle )<br >
+                Write 32 bit number to dynamic block.<br >
+                Address will spacify, whitch number, not byte.<br >
+<br >
+dyncon ( size "name" – )<br >
+                Allocate dynamic block with specified size, and<br >
+                create constant honding its handle.<br >
+                ex: 100 dyncon MyNewBlock<br >
+<br >
+dyn. ( handle – )<br >
+                Write contenc of dynamic memory block to screen.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-5" class="outline-3">
+<h3 id="sec-11-5"><span class="section-number-3">11.5</span> Graphics and text</h3>
+<div class="outline-text-3" id="text-11-5">
+<p class="verse">
+. ( n – ) print number on screen<br >
+<br >
+d. ( n – ) print number on screen in decimal<br >
+<br >
+? ( addr – ) print 32 bit value located at addr.<br >
+<br >
+." <string>" ( – ) print string into screen. Immideately<br >
+                compiles.<br >
+                ex: : greeting ." Hello, World" ;<br >
+<br >
+tab. ( – ) print tabulator<br >
+<br >
+calccol ( b g r – c ) calculate color what best matches given<br >
+                Blue Green & Red values. Values must be in range 0 - 255.<br >
+<br >
+imgalloc ( xsize ysize – imgbuf ) allocate image buffer for<br >
+                specified size.<br >
+<br >
+imgsize ( imgbuf – ) print on the screen X & Y size of image<br >
+                buffer.<br >
+<br >
+point ( x y imgbuf – addr ) returns memory address for specified<br >
+                pixel.<br >
+<br >
+pset ( color x y imgbuf – ) set graphic point<br >
+<br >
+boxf ( x1 x2 y1 y2 imgbuf color – ) draw filled box<br >
+<br >
+cls ( imgbuf – ) clear image buffer<br >
+<br >
+setpal ( b g r color – ) set palette value for specified color.<br >
+                values bust be in size 0 - 63.<br >
+<br >
+putchar ( char color x y imgbuf – ) put graphic character in<br >
+                imagebuffer to specified (x & y) location.<br >
+<br >
+scroll ( x y imgbuf – ) scroll in imgbuf.<br >
+<br >
+scrollf ( color x y screen – ) scroll and fill empty space with<br >
+                given color.<br >
+<br >
+at! ( x y – ) set cursor location<br >
+curc! ( color – ) set text color<br >
+curb! ( solor – ) set backround color<br >
+<br >
+colnorm ( – ) set text color to normal<br >
+colneg ( – ) set text color to negative (selected)<br >
+<br >
+dyntype ( dynhandle – ) display contenc of dynamic memory on screen<br >
+fsdisp ( file – ) clear screen, display file, and wait for key<br >
+<br >
+type ( addr length – )<br >
+                Types on the screen string, from memory at addr and<br >
+                specified length.<br >
+<br >
+write ( addr – )<br >
+                Types on the screen string, from memory at "addr"+1<br >
+                length is taken from "addr" .<br >
+<br >
+screen const 32 bit<br >
+                Holds handle of screen buffer.<br >
+<br >
+copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source<br >
+                image to destination image. Source and destination images<br >
+                must have same size.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-6" class="outline-3">
+<h3 id="sec-11-6"><span class="section-number-3">11.6</span> Math, memory & stack manipulation</h3>
+<div class="outline-text-3" id="text-11-6">
+<p class="verse">
+off ( n – ) writes 0 to given address, good for zeroing variable.<br >
+                ex: MyVariable off<br >
+on ( n – ) writes -1 (true flag) to given address.<br >
+                ex: MyVariable on<br >
+<br >
+2dup ( n1 n2 – n1 n2 n1 n2 )<br >
+2drop ( n1 n2 – )<br >
+nip ( n1 n2 – n2 )<br >
+neg ( n1 – -n1 ) negotiate<br >
+bit@ ( n bit – result ) return specified bit from n.<br >
+                ex: 38 2 bit@ (result will be 1)<br >
+to32bit ( n1 n2 n3 n4 – n32 ) treat 4 last stack elements as bytes<br >
+                and unite them into 32 bit dword. Most significant byte<br >
+                on top.<br >
+                ex: 12 76 23 11 to32bit result: 186076172<br >
+<br >
+to8bit ( n32 – n1 n2 n3 n4 ) break 32 bit number into 4 bytes.<br >
+                Useful if you need to send 32 bit numbers thru 8 bit COM<br >
+                port.<br >
+                ex: 186076172 to8bit result: 12 76 23 11<br >
+<br >
+mod ( n1 n2 – reminder ) divide n1 by n2 and returns reminder.<br >
+                ex: 12 5 mod result: 2<br >
+<br >
+bound ( low n high – n ) check if n is in given bounds,<br >
+                if not then incarease/decarease it to match bounds.<br >
+                ex: 5 80 15 bound result: 15<br >
+                    5 10 15 bound result: 10<br >
+                    5 -10 15 bound result: 5<br >
+<br >
+bound? ( low n high – result ) returns true if n is in the<br >
+                given bounds.<br >
+<br >
+tab ( col – spaces) calculate amount of spaces to add<br >
+                ta reach next tabulation from given column.<br >
+<br >
+count ( addr – addr+1 n )<br >
+                Useful for returning bytes from constantly incareasing<br >
+                address. Module "type" is nice example.<br >
+<br >
+c, ( n – )<br >
+                store one byte at memory specified by "h". And incarease<br >
+                "h" by 1.<br >
+<br >
+, ( n – )<br >
+                store 32 bit number at memory specified by "h". And<br >
+                incarease "h" by 4.<br >
+<br >
+cmove ( addr1 addr2 n – )<br >
+                copy "n" amount of bytes from memory at "addr1" to memory<br >
+                at "addr2".<br >
+<br >
+rnd ( limit – result )<br >
+                generates random number in range 0 to "limit"-1.<br >
+<br >
+abs ( n – |n| )<br >
+                returns absolute value of "n"<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-11-7" class="outline-3">
+<h3 id="sec-11-7"><span class="section-number-3">11.7</span> Dynamic & static strings</h3>
+<div class="outline-text-3" id="text-11-7">
+<p>
+Fifth supports both static and dynamic strings. Static strings must
+have predefined space reserved, and string mustn't exceed this
+length. They manipulation is faster. But they use more memory. Static
+string memory address is used to refer to the string.
+</p>
-0 - 15 0 - F HEX numbers
-252 FC backspace
-253 FD tabulator (TAB)
-254 FE carriage return (CR)
-255 FF space
+<p>
+Dynamic strings can have at any time length form 0 to 0FFh, They take
+up only memory they currently need. They are held in dynamic memory
+blocks, so dynamic block handle is used to refer to this string.
+</p>
-else ordinary characters, like in ASCII.
+<p>
+Both types of strings are stored in the way, where first (0th) byte
+holds current string length, following bytes are string itself.
+</p>
-
-
-
- </pre>
+<p class="verse">
+Dynamic:<br >
+<br >
+Dstral ( – handle )<br >
+                Allocate new string.<br >
+<br >
+Dstrlen ( handle – length )<br >
+                Return string length.<br >
+<br >
+c+Dstr ( chr handle – )<br >
+                Add one byte to end of the string.<br >
+<br >
+c+lDstr ( chr handle – )<br >
+                Add one byte to left side (beginning) of the string.<br >
+<br >
+Dstr. ( handle – )<br >
+                Write contec of string into screen.<br >
+<br >
+Dstrsure ( size Dstr – )<br >
+                Makes sure that at least rquested<br >
+                "size" (amount of characters) is allocated for given<br >
+                dynamic string.<br >
+<br >
+Dstr2str ( handle address – )<br >
+                Copy dyamic string into static memory space.<br >
+<br >
+str2Dstr ( address handle – )<br >
+                Copy static string into dyamic string.<br >
+<br >
+Dstr+str ( Dstr addr – )<br >
+                Add contenc of dynamic string to static string.<br >
+<br >
+D" any string" ( – Dstr )<br >
+                Moves specified string into dynamic string called "defDstr".<br >
+<br >
+D> any_string ( – Dstr )<br >
+                Moves specified string into dynamic string called "defDstr".<br >
+                Space marks end of string!<br >
+<br >
+D>2 any_string ( – Dstr )<br >
+                Moves specified string into dynamic string called "defDstr2".<br >
+                Space marks end of string!<br >
+<br >
+Dstr+Dstr ( Dstr1 Dstr2 – )<br >
+                Adds "Dstr1" to "Dstr2" and places result into "Dstr2".<br >
+<br >
+Dstrclear ( Dstr – )<br >
+                Clears contenc of dynamic string.<br >
+<br >
+Dstr2Dstr ( Dstr1 Dstr2 – )<br >
+                Moves "Dstr1" to "Dstr2".<br >
+Dstr ( data" name – )<br >
+                Creates new dynamic string and moves specified data into it.<br >
+                Then creates new constant with given "name" holding created<br >
+                dynamic string handle.<br >
+<br >
+                ex: Dstr Hello, my name is Sven!" message \ creates it<br >
+                    message Dstr. \ tests it<br >
+<br >
+Dstrlscan ( char Dstr – loc )<br >
+                Searches dynamic string for "char", from left to right,<br >
+                returns first found "char" location in string, or 0,<br >
+                if not found.<br >
+<br >
+Dstrrscan ( char Dstr – loc )<br >
+                Searches dynamic string for "char", from right to left,<br >
+                returns first found "char" location in string, or 0,<br >
+                if not found.<br >
+<br >
+Dstrlscane ( char Dstr – loc )<br >
+                Same as "Dstrlscan" buf returns string length+1 as location.<br >
+ÿ<br >
+Dstrleft ( amo Dstr – )<br >
+                Only specified amount of characters from left remains<br >
+                in dynamic string. ie. cut right part out.<br >
+<br >
+Dstrright ( amo Dstr – )<br >
+                Only specified amount of characters from right remains<br >
+                in dynamic string. ie. cut left part out.<br >
+<br >
+Dstrcutl ( amo Dstr – )<br >
+                Cut specified amount of characters from left of dynamic<br >
+                string out.<br >
+<br >
+Dstrsp ( char Dstr1 Dstr2 – )<br >
+                Separate dynamic string in Dstr1 into two parts,<br >
+                using "char" as separator. First part will be stored in<br >
+                "Dstr2", second part in "Dstr1".<br >
+                ex: asc \ \ ..separator<br >
+                    D> listF\listLIB\5TH_DRVMOUSE \ ..separate from<br >
+                    defDstr2 \ ..place result in<br >
+                    Dstrsp \ separation command<br >
+                    defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE<br >
+                    defDstr2 Dstr. \ will be: listF<br >
+<br >
+Dv ( addr – )<br >
+                Allocates empty dynamic string, and places it's handle<br >
+                into given address.<br >
+<br >
+Df ( addr – )<br >
+                Reads dynamic string handle from given address and<br >
+                deallocates (frees) it.<br >
+<br >
+ex: var mystring1<br >
+        : testmodule<br >
+        mystring1 Dv \ allocates string<br >
+<br >
+                <whatever><br >
+<br >
+        mystring1 Df ; \ deallocates it again when no longer needed.<br >
+</p>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-12" class="outline-2">
+<h2 id="sec-12"><span class="section-number-2">12</span> Dynamically loadable modules</h2>
+<div class="outline-text-2" id="text-12">
+</div><div id="outline-container-sec-12-1" class="outline-3">
+<h3 id="sec-12-1"><span class="section-number-3">12.1</span> Keyboard driver</h3>
+<div class="outline-text-3" id="text-12-1">
+<p class="verse">
+<br >
+KBD_@ ( – code ) get scancodes for pressed keys from keyboard.<br >
+KBD_down? ( key – result ) check is key with specified scancode<br >
+                currently pressed down.<br >
+KBD_SC2FSCII ( code – FSCII ) convert key scancode into FSCII code,<br >
+                or in FSK (Fifth standard keycode).<br >
+KBD_F@ ( – FSCII ) read pressed key FSCII or FSK, returns -1 if no<br >
+                keys are pressed.<br >
+KBD_FW@ ( – FSCII ) read pressed key FSCII or FSK, if no keys is<br >
+                are pressed then waits until there is.<br >
+<br >
+                FSK<br >
+                —<br >
+In HEX.<br >
+<br >
+FC backspace<br >
+FD TAB<br >
+FE enter<br >
+FF space<br >
+<br >
+400 ESC<br >
+401 … F1 …<br >
+410 up<br >
+411 right<br >
+412 down<br >
+413 left<br >
+414 INS<br >
+415 DEL<br >
+416 home<br >
+417 end<br >
+418 PG/UP<br >
+419 PG/DN<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-12-2" class="outline-3">
+<h3 id="sec-12-2"><span class="section-number-3">12.2</span> Mouse driver</h3>
+<div class="outline-text-3" id="text-12-2">
+<p class="verse">
+mousex var Mouse x coordinate.<br >
+mousey var Mouse y coordinate.<br >
+mousekeyl var Mouse left key.<br >
+mousekeym var Mouse middle key.<br >
+mousekeyr var Mouse right key.<br >
+mousec var Display current mouse coordinates in top left part of screen,<br >
+                if true. (good for debugging)<br >
+mousepointer var Image buffer, holding current mouse pointer.<br >
+mouseadd ( ModuleAddr x1 x2 y1 y2 – ) Add specified area on screen,<br >
+                into mause click buffer. If any mouse button is clicked on<br >
+                that area, module at "ModuleAddr" will be executed.<br >
+mousebe var Amount of buffer elements.<br >
+mousedo ( – ) Updates mouse coordinates and keys. Parse mouse<br >
+                click buffer, and draw mouse cursor to "screen".<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-12-3" class="outline-3">
+<h3 id="sec-12-3"><span class="section-number-3">12.3</span> 2D graphic library</h3>
+<div class="outline-text-3" id="text-12-3">
+<p class="verse">
+lineh ( color len x y imgbuf – ) draws horisontal line<br >
+                from X,Y coordinates to right, with specified length.<br >
+linev ( color len x y imgbuf – ) draws vertical line<br >
+                down, from coordinates X,Y, with specified length.<br >
+box ( color x2 x1 y2 y1 imgbuf – ) draws rectangular<br >
+                box. x2 bust be >= x1, y2 must be >= y1.<br >
+                        x1,y1–———+<br >
+                          | |<br >
+                          | |<br >
+                          +–———x2,y2<br >
+<br >
+flipv ( imgbuf – ) flip image vertically.<br >
+imgcoltrans ( ImgBuf Color ToColor – ) Translate all pixels in<br >
+                specified image with "Color" into "ToColor".<br >
+imgfill ( color x y imgbuf – ) Fill image region starting at location<br >
+                X & Y with specified color.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-12-4" class="outline-3">
+<h3 id="sec-12-4"><span class="section-number-3">12.4</span> Trigonometry functions</h3>
+<div class="outline-text-3" id="text-12-4">
+<p class="verse">
+sin ( a – result ) return sinus from given angle "a",<br >
+                360ø is 2000. So 1000 represents 180ø angle.<br >
+                Result will be in range -10'000 to 10'000, instead of ñ1.<br >
+<br >
+cos ( a – result ) return cosinus from given angle.<br >
+                Parameters are like in "sin" function.<br >
+</p>
+</div>
+</div>
+</div>
+</div><div class="col-md-3"><nav id="table-of-contents">
+<div id="text-table-of-contents" class="bs-docs-sidebar">
+<ul class="nav">
+<li><a href="#sec-1">1. !Project deprecated!</a></li>
+<li><a href="#sec-2">2. Introduction</a>
+<ul class="nav">
+<li><a href="#sec-2-1">2.1. screenshots</a></li>
+</ul>
+</li>
+<li><a href="#sec-3">3. Installation</a></li>
+<li><a href="#sec-4">4. Fifth distribution directory tree description</a></li>
+<li><a href="#sec-5">5. Software/Hardware/Human requirements</a>
+<ul class="nav">
+<li><a href="#sec-5-1">5.1. Software</a></li>
+<li><a href="#sec-5-2">5.2. Hardware</a></li>
+<li><a href="#sec-5-3">5.3. Human</a></li>
+</ul>
+</li>
+<li><a href="#sec-6">6. Numbers representation within Fifth</a></li>
+<li><a href="#sec-7">7. Disk file map, and it's data structures</a>
+<ul class="nav">
+<li><a href="#sec-7-1">7.1. disk allocation</a></li>
+<li><a href="#sec-7-2">7.2. FAT entry format:</a></li>
+<li><a href="#sec-7-3">7.3. file entry format</a></li>
+</ul>
+</li>
+<li><a href="#sec-8">8. Core architecture</a>
+<ul class="nav">
+<li><a href="#sec-8-1">8.1. Dictionary entry format</a></li>
+<li><a href="#sec-8-2">8.2. Possible module types</a></li>
+<li><a href="#sec-8-3">8.3. Memory map (average)</a></li>
+</ul>
+</li>
+<li><a href="#sec-9">9. Virtual machine</a></li>
+<li><a href="#sec-10">10. Fifth source format</a>
+<ul class="nav">
+<li><a href="#sec-10-1">10.1. FSCII</a></li>
+</ul>
+</li>
+<li><a href="#sec-11">11. Fifth commands</a>
+<ul class="nav">
+<li><a href="#sec-11-1">11.1. Compilation & miscellaneous</a></li>
+<li><a href="#sec-11-2">11.2. Conditionals & control flow</a></li>
+<li><a href="#sec-11-3">11.3. Disk & file access</a></li>
+<li><a href="#sec-11-4">11.4. Dynamic memory</a></li>
+<li><a href="#sec-11-5">11.5. Graphics and text</a></li>
+<li><a href="#sec-11-6">11.6. Math, memory & stack manipulation</a></li>
+<li><a href="#sec-11-7">11.7. Dynamic & static strings</a></li>
+</ul>
+</li>
+<li><a href="#sec-12">12. Dynamically loadable modules</a>
+<ul class="nav">
+<li><a href="#sec-12-1">12.1. Keyboard driver</a></li>
+<li><a href="#sec-12-2">12.2. Mouse driver</a></li>
+<li><a href="#sec-12-3">12.3. 2D graphic library</a></li>
+<li><a href="#sec-12-4">12.4. Trigonometry functions</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</nav>
+</div></div></div>
+<footer id="postamble" class="">
+<div><p class="author">Author: Svjatoslav Agejenko</p>
+<p class="date">Created: 2018-01-01 Mon 23:29</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
+</div>
+</footer>
</body>
-</html>
\ No newline at end of file
+</html>
projects / fifth.git / blobdiff