From 56037f262c669df160a770aa54f9e35ac3f945ca Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Mon, 2 Jul 2018 00:03:50 +0300 Subject: [PATCH 1/7] Fixed broken links --- doc/index.html | 437 ++++++++++++++++++++++-------------------- doc/index.org | 51 ++--- tools/commit and push | 11 ++ tools/update web site | 8 +- 4 files changed, 280 insertions(+), 227 deletions(-) create mode 100755 tools/commit and push diff --git a/doc/index.html b/doc/index.html index 6d320c6..ab17bf9 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,14 +2,14 @@ Fifth - virtual machine, operating system, programming language - + - - -" + + + ------ -- [[http://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]] - -- This program is free software; you can redistribute it and/or modify it under - the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] or later as - published by the Free Software Foundation. +* General +- This program is free software: you can redistribute it and/or modify + it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. - Program author: - Svjatoslav Agejenko - Homepage: http://svjatoslav.eu - Email: mailto://svjatoslav@svjatoslav.eu -- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]] +- [[http://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]] -* (document settings) :noexport: -** use dark style for TWBS-HTML exporter -#+HTML_HEAD: -#+HTML_HEAD: -#+HTML_HEAD: " -#+HTML_HEAD: +** Source code +- [[http://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] + +- [[http://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=summary][Browse Git repository online]] + +- Clone Git repository using command: + : git clone http://www2.svjatoslav.eu/git/fifth.git -* !Project deprecated! +* Warning 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 -[[http://www2.svjatoslav.eu/gitbrowse/sixth/doc/index.html][Sixth]] +[[http://www3.svjatoslav.eu/projects/sixth/][Sixth]] System is built many years ago when I was still using DOS as a primary -operating system. +operating system and not updated since. * Introduction Fifth is programming lanquage & operating system, running on [[emulator.html][virtual CPU]], with custom instruction set. It is much like Charles Chunk @@ -56,9 +62,10 @@ inspired created my own system. * Installation 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 ). +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 [[files.txt][distribution directory layout]] * Fifth distribution directory tree description diff --git a/tools/commit and push b/tools/commit and push new file mode 100755 index 0000000..057b511 --- /dev/null +++ b/tools/commit and push @@ -0,0 +1,11 @@ +#!/bin/bash +cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi; + +cd .. + +cola +git push + +echo "" +echo "Press ENTER to close this window." +read diff --git a/tools/update web site b/tools/update web site index c2cd502..20a52bc 100755 --- a/tools/update web site +++ b/tools/update web site @@ -1,7 +1,11 @@ #!/bin/bash - -cd "${0%/*}" +cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi; cd .. rsync -avz --delete -e 'ssh -p 10006' doc/ n0@www3.svjatoslav.eu:/mnt/big/projects/fifth/ + + +echo "" +echo "Press ENTER to close this window." +read -- 2.20.1 From a913785891f6089f929cf5e12720d1da1269de51 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 21 Dec 2021 20:06:12 +0200 Subject: [PATCH 2/7] Updated documentation --- doc/index.html | 2919 +++++++++++++++++++++++------------------ doc/index.org | 265 ++-- tools/commit and push | 11 - tools/synchronize | 18 + 4 files changed, 1799 insertions(+), 1414 deletions(-) delete mode 100755 tools/commit and push create mode 100755 tools/synchronize diff --git a/doc/index.html b/doc/index.html index a46af2c..430d5a6 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,12 +1,198 @@ - - + + + + + + Fifth - virtual machine, operating system, programming language - - - - - + + + @@ -14,261 +200,179 @@ footer {background-color: #111 !important;} pre {background-color: #111; color: #ccc;} - + - - + -
-

Fifth - virtual machine, operating system, programming language

+
+

Fifth - virtual machine, operating system, programming language

+ -
-

1 General

+
+

1 General

-
  • Other software projects hosted at svjatoslav.eu -
    • +
  • Other software projects hosted at svjatoslav.eu
    • -
    -

    1.1 Source code

    +
    +

    1.1 Source code

    -
    -

    2 !Project deprecated!

    +
    +

    2 !Project deprecated!

    Current implementation does not support object oriented @@ -287,11 +391,11 @@ operating system.

    -
    -

    3 Introduction

    +
    +

    3 Introduction

    -Fifth is programming lanquage & operating system, running on virtual +Fifth is programming lanquage & operating system, running on virtual machine, 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 @@ -299,43 +403,50 @@ inspired created my own system.

    -
    -

    3.1 screenshots

    +
    +

    3.1 screenshots

    -
      -
    • start.png -
        -
      • Startup screen diplaying Fifth logo and full file list. -
        • -
      -
      • -
    • dictionary.png -
        -
      • 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. -
        • -
      -
      • +
      +

      start.png +

      +
      -
    • text editor.png -
        -
      • Built in text editor. -
        • -
      -
      • -
    +

    +Startup screen diplaying Fifth logo and full file list. +

    + + +
    +

    dictionary.png +

    +
    + +

    +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. +

    + + + +
    +

    text editor.png +

    +
    + +

    +Built in text editor. +

    -
    -

    4 Installation

    +
    +

    4 Installation

    Just unpack all files, witout altering original directory structure, @@ -345,13 +456,13 @@ or EMULATOR.COM ), and virtual disk file ( DISK.RAW ).

    -Read more about Fifth distribution directory tree description. +Read more about Fifth distribution directory tree description.

    -
    -

    5 Fifth distribution directory tree description

    +
    +

    5 Fifth distribution directory tree description

    After downloading and unpacking the ZIP file you shoud get directory @@ -359,78 +470,69 @@ tree similar to this:

    -[DOC] - Fifth documentation
    -  [commands] - documentation on Fifth built-in commands
    -  [modules] - documentation on additional commands, realized as loadable modules
    -  [shots] - Fifth screenshots
    -
    -[imageFile] - files contained within 'disk.raw', just an extracted form.
    -
    -[source] - source files
    -  [emulator] - emulator source
    -  [util] - utilites
    -
    -disk.raw - Virtual disk file, has filesystem inside.
    -emulator.com - main executable.
    +DOC - Fifth documentation
    +  commands - documentation on Fifth built-in commands
    +  modules - documentation on additional commands, realized as loadable modules
    +  shots - Fifth screenshots
    +
    +imageFile - files contained within 'disk.raw', just an extracted form.
    +
    +source - source files
    +  emulator - emulator source
    +  util - utilites
    +
    +disk.raw - Virtual disk file, has filesystem inside.
    +emulator.com - main executable.

    -
    -

    6 Software/Hardware/Human requirements

    +
    +

    6 Requirements

    -
    -

    6.1 Software

    +
    +
    +

    6.1 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). -
      • +
    • 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).
    -
    -

    6.2 Hardware

    +
    +

    6.2 Hardware

      -
    • Minimum CPU 386. -
      • -
    • 64 KB free RAM below 640KB, -
      • -
    • 2 MB of free XMS. -
      • -
    • VESA compatible video card. -
      • +
    • Minimum CPU 386.
      • +
    • 64 KB free RAM below 640KB,
      • +
    • 2 MB of free XMS.
      • +
    • VESA compatible video card.
    -
    -

    6.3 Human

    +
    +

    6.3 Human

      -
    • Beginner level Forth knowledge is recommended. -
      • -
    • Lots of enthusiasm. -
      • +
    • Beginner level Forth knowledge is recommended.
      • +
    • Lots of enthusiasm.
    -
    -

    7 Numbers representation within Fifth

    +
    +

    7 Numbers representation within Fifth

    -

    -file:numbers.png + +

    +

    numbers.png

    +

    Because I can define everything, starting from CPU, why not try also @@ -444,8 +546,8 @@ their color (black or white).

    -
    -

    8 Disk file map, and it's data structures

    +
    +

    8 Disk file map, and it's data structures

    Core and high-level boot code is stored outside of the filesystem to @@ -453,147 +555,147 @@ allow easy access to it, at early booting time, when filesystem is not yet initialized.

    -
    -

    8.1 disk allocation

    +
    +

    8.1 Disk allocation

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    offsetlengthdescriptionoffsetlengthdescription
    0~4 KbFifth core0~4 KbFifth core
    4 Kb~32Kbhigh-level boot code4 Kb~32 Kbhigh-level boot code
    37 Kb~65KbFAT37 Kb~65 KbFAT
    101Kb~16MBfilesystem data area101 Kb~16 MBfilesystem data area
    -
    -

    8.2 FAT entry format:

    +
    +

    8.2 FAT entry format:

    - +
    -+-+ - - + + - - + + - - + + - - + +
    codemeaningcodemeaning
    -2last sector-2last sector
    -1empty sector-1empty sector
    0 --.. pointer to next block0 --.. pointer to next block
    -
    -

    8.3 file entry format

    +
    +

    8.3 File entry format

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    offsetlengthdescriptionoffsetlengthdescription
    04extension04extension
    416name416name
    204entry point204entry point
    244size244size
    284last modification time284last modification time
    -
    -

    9 Core architecture

    +
    +

    9 Core architecture

    Fifth core is simply some amount of already compiled into machine code @@ -606,64 +708,64 @@ dictionary space only. Random word can be removed from dictionary at any time. Currently dictionary can contain at most 1000 entries.

    -
    -

    9.1 Dictionary entry format

    +
    +

    9.1 Dictionary entry format

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    offsetlengthdescriptionoffsetlengthdescription
    040 < previous entry040 < previous entry
      0 = last  0 = last
      -1 = empty  -1 = empty
    415module name string415module name string
    191entry type191entry type
    204entry data204entry data
    @@ -675,113 +777,113 @@ run through headers backwards and find needed entry.

    -
    -

    9.2 Possible module types

    +
    +

    9.2 Possible module types

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    typedescription"execute" actiontypedescription"execute" action
    0datacompile "num" instruction0datacompile "num" instruction
      with address to module  with address to module
    1submodulecompile "call" instruction1submodulecompile "call" instruction
      with address to module  with address to module
    2imm. submoduleimmediately call to module2imm. submoduleimmediately call to module
    -
    -

    9.3 Memory map (average)

    +
    +

    9.3 Memory map

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    <loc><size><desc>locationsizedescription
    0~4096core0~4096core
    1500000~32000highlevel Fifth boot code1500000~32000highlevel Fifth boot code
    200000h core startup messages area200000h core startup messages area
    5200000 end of dynamic memory space5200000 end of dynamic memory space
    -
    -

    10 Virtual machine

    +
    +

    10 Virtual machine

    Using CPU emulator slows it down but I shouldn't now think too mutch @@ -809,135 +911,468 @@ Maybe one day similar system will run directly on custom silicon chip :)

    CPU has following registers:

    - +
    -+-+ - - + + - - + + - - + +
    IPinstruction pointerIPinstruction pointer
    DSPdata stack pointerDSPdata stack pointer
    RSPreturn stack pointerRSPreturn stack pointer
    - +
    +
    +

    10.1 instruction set

    +
    +
    +
    +

    10.1.1 overview table

    +

    Virtual CPU, commands (most of them are avaiable as ordinary commands -in programming lanquage): +in programming language):

    -

    -
    -code mnemonic description
    -
    -0 nop does notheing
    -1 halt halt CPU ( return to DOS on emulator )
    -
    -2 kbd@ ( – c ) read scancode of pressed or released key.
    -                                Returns 0, if no data avaiable.
    -3 num <dword> ( – n ) put immidiate number into datastack
    -
    -4 jmp <dword> jump to specified code
    -5 call <dword>jump to specified code, save return address to
    -                                return stack.
    -
    -6 1+ ( n – n+1 )
    -7 1- ( n – n-1 )
    -
    -8 dup ( n – n n ) duplicate top of data stack
    -9 drop ( n – ) drop last element in data stack
    -
    -10 if <dword> ( n – ) jump to addr if top element was 0
    -11 ret jump to code, specified in return stack.
    -
    -12 c@ ( addr – n ) read byte from memory at specified address
    -13 c! ( n addr – ) store byte to specified memory
    -
    -14 push ( DSTK -> RSTK ) move top of datastack to returnstack
    -15 pop ( RSTK -> DSTK ) move top of returnstack to datastack
    -
    -16 <unused>
    -17 rot ( n1 n2 n3 – n2 n3 n1) rotate stack elements
    -
    -18 disk@ ( FromDiskSect ToMem – ) read 1KB from disk into RAM
    -19 disk! ( FromMem ToDiskSect – ) write 1KB to disk
    -
    -20 @ ( addr – n ) read 32 bit number from memory
    -21 ! ( n addr – ) store 32 bit number to memory
    -
    -22 over ( n1 n2 – n1 n2 n1 ) self explaining …
    -23 swap ( n1 n2 – n2 n1 ) -,,-
    -
    -24 + ( n1 n2 – n1+n2 ) -,,-
    -25 - ( n1 n2 – n1-n2 ) -,,-
    -
    -26 * ( n1 n2 – n1*n2 ) -,,-
    -27 / ( n1 n2 – n1/n2 ) -,,-
    -
    -28 > ( n1 n2 – result ) is true when n1 > n2
    -29 < ( n1 n2 – result ) is true when n1 < n2
    -
    -30 not ( n1 – not_n1 ) logical not
    -31 i ( – n ) copies top of return stack into datastack
    -
    -32 cprt@ ( addr – n ) read one byte from hardware port
    -33 cprt! ( n addr – ) store one byte to hardware port
    -
    -34 i2 ( – n ) like "i" but takes socond top stack element.
    -35 i3 ( – n ) like "i" but takes third top stack element.
    -
    -36 shl ( n amount – n ) left bit shift
    -37 shr ( n amount – n ) right bit shift
    -
    -38 or ( n1 n2 – n ) logical or
    -39 xor ( n1 n2 – n ) exclusive logical or
    -
    -40 vidmap ( addr – ) copy memory from "addr" to video memory.
    -
    -41 mouse@ ( – x y button ) read mouse coordinates & buttons
    -
    -42 vidput ( addr1 addr2 x y – ) put image1 into image2, at
    -                                location x, y. Does clipping, so part of a big image
    -                                can be mapped into smaller one.
    -
    -43 cmove ( addr1 addr2 amount ) move memory from addr1 to addr2
    -                                if addr1 is greater than addr2 then count address
    -                                foward while moving, elseway starts from end and
    -                                counts backwards, so no data loss will occure on
    -                                overlapping.
    -
    -44 cfill ( c addr amount – ) fill memory starting at "addr"
    -                                with "c" bytes.
    -
    -45 tvidput ( addr1 addr2 x y – ) same as "vidput" but treats
    -                                color 255 in source image as transparent.
    -
    -46 depth ( – depth ) returns current depth of data stack.
    -
    -47 charput ( colorfg colorbg addrsrc addrdest x y )
    -                                draw character to image buffer located at "addrdest"
    -                                to specified x & y location. Decodes 8 bytes from
    -                                source to bits, used to draw character.
    + + + + +++ ++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    #namestack footprintdescription
    0nop--does nothing
    1halt--halt CPU ( return to DOS on emulator )
    2kbd@– cread scancode of pressed or released key
    3num <dword>– nput immidiate number into datastack
    4jmp <dword>--jump to specified code
    5call <dword> jump to specified code, save return address to return stack
    61+n – n+1 
    71-n – n-1 
    8dupn – n nduplicate top of data stack
    9dropn --drop last element in data stack
    10if <dword>n --jump to addr if top element was 0
    11ret jump to code, specified in return stack.
    12c@addr – nread byte from memory at specified address
    13c!n addr --store byte to specified memory
    14pushDSTK -> RSTKmove top of datastack to returnstack
    15popRSTK -> DSTKmove top of returnstack to datastack
    16<unused>  
    17rotn1 n2 n3 – n2 n3 n1rotate stack elements
    18disk@FromDiskSect ToMem --read 1KB from disk into RAM
    19disk!FromMem ToDiskSect --write 1KB to disk
    20@addr – nread 32 bit number from memory
    21!n addr --store 32 bit number to memory
    22overn1 n2 – n1 n2 n1 
    23swapn1 n2 – n2 n1 
    24+n1 n2 – n1+n2 
    25-n1 n2 – n1-n2 
    26*n1 n2 – n1*n2 
    27/n1 n2 – n1/n2 
    28>n1 n2 – resultis true when n1 > n2
    29<n1 n2 – resultis true when n1 < n2
    30notn1 – not_n1logical not
    31i– ncopies top of return stack into datastack
    32cprt@addr – nread one byte from hardware port
    33cprt!n addr --store one byte to hardware port
    34i2– nlike "i" but takes second top stack element
    35i3– nlike "i" but takes third top stack element.
    36shln amount – nleft bit shift
    37shrn amount – nright bit shift
    38orn1 n2 – nlogical or
    39xorn1 n2 – nexclusive logical or
    40vidmapaddr --copy memory from "addr" to video memory.
    41mouse@– x y buttonread mouse coordinates & buttons
    42vidputaddr1 addr2 x y --put image1 into image2, at location x, y
    43cmoveaddr1 addr2 amountmove memory from addr1 to addr2
    44cfillc addr amount --fill memory starting at "addr" with "c" bytes.
    45tvidputaddr1 addr2 x y --put image with transparency support
    46depth– depthreturns current depth of data stack.
    47charputcolorfg colorbg addrsrc addrdest x ydraw text character
    +

    +
    + +
    +

    10.1.2 kbd@ - read scancode of pressed or released key

    +
    +

    +Returns 0 if no data available.

    +
    +

    10.1.3 vidput - put image1 into image2, at location x, y

    +
    +

    +Does clipping, so part of a big image can be mapped into smaller one. +

    +
    +
    +
    +

    10.1.4 cmove - copy memory array

    +
    +

    +Move memory from addr1 to addr2. If addr1 is greater than addr2 then +count address foward while moving, elseway starts from end and counts +backwards, so no data loss occurs when memory regions partially +overlap. +

    +
    +
    +
    +

    10.1.5 tvidput - put image with transparency support

    +
    +

    +Stack footprint +

    +
    +addr1 addr2 x y --
+
    -
    -

    11 Fifth source format

    + +

    +Put image1 into image2, at location x, y with transparency support +

    + +

    +Color 255 in source image is treated as transparent. +

    +
    +
    +
    +

    10.1.6 charput - draw text character

    +
    +

    +Draw character to image buffer located at "addrdest" to specified x & +y location. Decodes 8 bytes from source to bits, used to draw +character. +

    +
    +
    +
    +
    + +
    +

    11 Fifth source format

    Fifth uses a different character table and codes than ASCII (still @@ -948,524 +1383,525 @@ numeric values. So typical nemric characters "0123…" is treated like ordinary letters.

    -
    -

    11.1 FSCII

    +
    +

    11.1 FSCII

    - +
    -+-+-+ - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    DECHEXfunctionDECHEXfunction
    0 - 150 - FHEX numbers0 - 150 - FHEX numbers
    252FCbackspace252FCbackspace
    253FDtabulator (TAB)253FDtabulator (TAB)
    254FEcarriage return (CR)254FEcarriage return (CR)
    255FFspace255FFspace
    else ordinary characters, same as in ASCII.else ordinary characters, same as in ASCII.
    -
    -

    12 Fifth commands

    +
    +

    12 Fifth commands

    -
    -

    12.1 Compilation & miscellaneous

    +
    +
    +

    12.1 Compilation & miscellaneous

    -init module ( – )
    -                First module, control is passed to on startup. Contains
    -                initialization routines. Also it is the last core module.
    -                All new modules on top of it comes as result of executing
    -                external source files.
    -
    -head <name> ( – ) compiles new dictionary entry without specifying
    -                new module type.
    -                ex: head myentry
    -
    -: <name> ( – ) creates new code module
    -; ( – ) ends module (immideate)
    -                ex: : hello ." hi there" ;
    -
    -const <name> ( n – ) defines new constant.
    -                ex: 2147483647 const max
    -
    -:i <name> ( – ) same as ":" but this module will be executed
    -                immideately even in compile mode.
    -                ex: :i ( 41 scan ;
    -
    -create <name> ( – ) same as "head" , but specify module type as data.
    -                ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 ,
    -
    -allot ( n – ) allocate n bytes in dictionary.
    -                ex: create MyArray 100 allot
    -
    -" <string>" ( – ) compile string and its size into core.
    -                ex: create Mystring " This is it's contects"
    -
    -str <name> <string>" ( – ) just shorter way for defining strings.
    -                ex: str Mystring This is it's contenc"
    -
    -var <name> ( – ) define new 32 bit variable.
    -                ex: var result
    -
    -' <module> ( – n ) return memory address of given entry.
    -                ex: ' init
    -
    -forget <name> ( – ) erases from RAM given entry and all entries what was
    -                defined after it.
    -                ex: forget myprog
    -
    -[ ( – ) set interpret mode (immideate)
    -] ( n – ) set compile mode and compile top stack element
    -                in as literal. Together [ …. ] cobination provides good
    -                way to compute some values only once, at compile time,
    -                rather than every time while program is running.
    -                ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ;
    -
    -defer <name> ( – ) creates new module, with jump instruction.
    -                Later address where to jump can be modified by "is" command.
    -                This provides method of foward referencing. So you can use
    -                modules what not jet exist.
    -is ( address1 address2 – ) address1 - where to jump, address2 -
    -                address of module created by defer command.
    -                ex: defer dispver
    -                        : run dispver ." running …" ;
    -                               … whatever …
    -                        : (dispver ." Version 9.99 " ;
    -                        ' (dispver ' dispver is
    -
    -                Now if I type "run" on the screen appears:
    -                        Version 9.99 running …
    -
    -asc <char> ( – ) reads char ascii code and treats it as literal.
    -                (immideate)
    -                ex: : BreakLine 30 do asc - emit loop ;
    -                                 same as:
    -                    : BreakLine 30 do 45 emit loop ;
    -
    -dyninc ( handle – ) execute code in dynamic memory handle.
    -                automatically deallocates it when done.
    -
    -include ( filenumber – ) execute code in specified file.
    -
    -words ( – ) display existing blocks in core.
    -
    -bye ( – ) exit from Fifth
    -
    -fkey ( – c )
    -                Read one byte from input stream.
    -
    -sadd ( c addr – )
    -                Add one byte "c" to string located at "addr" and updates
    -                string length.
    -
    -scan ( c – )
    -                Read input stream and store it to pad until it finds c .
    -                It ignores all "c" bytes until it finds any non "c" byte.
    -                in other words:
    -                                c is: "
    -                         input stream: """"This is test !"aoeu idh
    -                               result: This is test !
    -
    -                Is useful for breaking text lines into words.
    -
    -skey ( – c )
    -                So called safe "fkey". Reads data from input stream
    -                but converts characters with ASCII codes: 9 13 10
    -                to spaces.
    -
    -str=str? ( adr1 adr2 – result )
    -                Compares string at "adr1" with string at "adr2", returns
    -                true flag if they are equal or false if they are not.
    -                true = -1
    -                false = 0
    -
    -find ( – addr )
    -                Searches whole dictionary for word in "pad". If found,
    -                returns it address, if not, returns 0.
    -
    -execute ( – )
    -                Execute word located in "pad". Depending on "mode".
    -
    -dta ( addr – DataAddr )
    -                Calculates address of dictionary entry data area, from
    -                entry point.
    -
    -2num ( – num result )
    -                Attempt to convert string located in "pad" into numeric
    -                value. If succeed returns number and true as result.
    -                If not, returns whatever and false as result.
    -
    -dadd ( addr length – )
    -                Add to dictionary data located at "addr", with specified
    -                length.
    -
    -lit ( n – )
    -                Act with number depending on "mode". When interpreting,
    -                leaves it in stack.
    -
    -
    -incmod ( addr – )
    -                Add to dictionary data located at "addr"+1 , length is taken
    -                from "addr".
    -
    -here ( – n )
    -                return "h" contents.
    -
    -mode var 8 bit
    -                Holds input stream parser operation mode.
    -                0 = interpreting
    -                1 = compiling
    -
    -pad var 128 bytes
    -                Holds temprorary strings.
    -
    -h var 32 bit
    -                Pointer to free byte in memory, always at the end of the
    -                dictionary. Each time when something is stored
    -                by "c," command, pointer is incareased.
    -
    -lp var 32 bit
    -                Pointer to last dictionary word. Each time when new word is
    -                compiled or erased by "forget", this pointer is updated.
    -
    -modulechk ( Dstr<filename> – ) check if module is loaded, if not
    -                immideately load it.
    -
    -ne ( entrydata entrytype – ) Compile new dictionary entry.
    -                It's name must be in "pad".
    +init module ( – )
    +                First module, control is passed to on startup. Contains
    +                initialization routines. Also it is the last core module.
    +                All new modules on top of it comes as result of executing
    +                external source files.
    +
    +head <name> ( – ) compiles new dictionary entry without specifying
    +                new module type.
    +                ex: head myentry
    +
    +: <name> ( – ) creates new code module
    +; ( – ) ends module (immideate)
    +                ex: : hello ." hi there" ;
    +
    +const <name> ( n – ) defines new constant.
    +                ex: 2147483647 const max
    +
    +:i <name> ( – ) same as ":" but this module will be executed
    +                immideately even in compile mode.
    +                ex: :i ( 41 scan ;
    +
    +create <name> ( – ) same as "head" , but specify module type as data.
    +                ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 ,
    +
    +allot ( n – ) allocate n bytes in dictionary.
    +                ex: create MyArray 100 allot
    +
    +" <string>" ( – ) compile string and its size into core.
    +                ex: create Mystring " This is it's contects"
    +
    +str <name> <string>" ( – ) just shorter way for defining strings.
    +                ex: str Mystring This is it's contenc"
    +
    +var <name> ( – ) define new 32 bit variable.
    +                ex: var result
    +
    +' <module> ( – n ) return memory address of given entry.
    +                ex: ' init
    +
    +forget <name> ( – ) erases from RAM given entry and all entries what was
    +                defined after it.
    +                ex: forget myprog
    +
    +[ ( – ) set interpret mode (immideate)
    +] ( n – ) set compile mode and compile top stack element
    +                in as literal. Together [ …. ] cobination provides good
    +                way to compute some values only once, at compile time,
    +                rather than every time while program is running.
    +                ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ;
    +
    +defer <name> ( – ) creates new module, with jump instruction.
    +                Later address where to jump can be modified by "is" command.
    +                This provides method of foward referencing. So you can use
    +                modules what not jet exist.
    +is ( address1 address2 – ) address1 - where to jump, address2 -
    +                address of module created by defer command.
    +                ex: defer dispver
    +                        : run dispver ." running …" ;
    +                               … whatever …
    +                        : (dispver ." Version 9.99 " ;
    +                        ' (dispver ' dispver is
    +
    +                Now if I type "run" on the screen appears:
    +                        Version 9.99 running …
    +
    +asc <char> ( – ) reads char ascii code and treats it as literal.
    +                (immideate)
    +                ex: : BreakLine 30 do asc - emit loop ;
    +                                 same as:
    +                    : BreakLine 30 do 45 emit loop ;
    +
    +dyninc ( handle – ) execute code in dynamic memory handle.
    +                automatically deallocates it when done.
    +
    +include ( filenumber – ) execute code in specified file.
    +
    +words ( – ) display existing blocks in core.
    +
    +bye ( – ) exit from Fifth
    +
    +fkey ( – c )
    +                Read one byte from input stream.
    +
    +sadd ( c addr – )
    +                Add one byte "c" to string located at "addr" and updates
    +                string length.
    +
    +scan ( c – )
    +                Read input stream and store it to pad until it finds c .
    +                It ignores all "c" bytes until it finds any non "c" byte.
    +                in other words:
    +                                c is: "
    +                         input stream: """"This is test !"aoeu idh
    +                               result: This is test !
    +
    +                Is useful for breaking text lines into words.
    +
    +skey ( – c )
    +                So called safe "fkey". Reads data from input stream
    +                but converts characters with ASCII codes: 9 13 10
    +                to spaces.
    +
    +str=str? ( adr1 adr2 – result )
    +                Compares string at "adr1" with string at "adr2", returns
    +                true flag if they are equal or false if they are not.
    +                true = -1
    +                false = 0
    +
    +find ( – addr )
    +                Searches whole dictionary for word in "pad". If found,
    +                returns it address, if not, returns 0.
    +
    +execute ( – )
    +                Execute word located in "pad". Depending on "mode".
    +
    +dta ( addr – DataAddr )
    +                Calculates address of dictionary entry data area, from
    +                entry point.
    +
    +2num ( – num result )
    +                Attempt to convert string located in "pad" into numeric
    +                value. If succeed returns number and true as result.
    +                If not, returns whatever and false as result.
    +
    +dadd ( addr length – )
    +                Add to dictionary data located at "addr", with specified
    +                length.
    +
    +lit ( n – )
    +                Act with number depending on "mode". When interpreting,
    +                leaves it in stack.
    +
    +
    +incmod ( addr – )
    +                Add to dictionary data located at "addr"+1 , length is taken
    +                from "addr".
    +
    +here ( – n )
    +                return "h" contents.
    +
    +mode var 8 bit
    +                Holds input stream parser operation mode.
    +                0 = interpreting
    +                1 = compiling
    +
    +pad var 128 bytes
    +                Holds temprorary strings.
    +
    +h var 32 bit
    +                Pointer to free byte in memory, always at the end of the
    +                dictionary. Each time when something is stored
    +                by "c," command, pointer is incareased.
    +
    +lp var 32 bit
    +                Pointer to last dictionary word. Each time when new word is
    +                compiled or erased by "forget", this pointer is updated.
    +
    +modulechk ( Dstr<filename> – ) check if module is loaded, if not
    +                immideately load it.
    +
    +ne ( entrydata entrytype – ) Compile new dictionary entry.
    +                It's name must be in "pad".

    -
    -

    12.2 Conditionals & control flow

    +
    +

    12.2 Conditionals & control flow

    -if ( flag – ) (immideate)
    -                "if 1.. else 2.. then" or
    -                "if 1.. then" construction. Conditional execution.
    -                Performs "1.." if "flag" was true,
    -                elseway performs "2.." if exist. Execution continues after
    -                word "then".
    -                ex: 1 if ." nonzero" else ." zero" then
    -
    ->= ( n1 n2 – result ) true if (n1 = n2) or (n1 > n2)
    -                ex: 5 3 >= if ." first number is greater or equal" then
    -
    -<= ( n1 n2 – result ) true if (n1 = n2) or (n1 < n2)
    -= ( n1 n2 – result ) true if n1 = n2
    -
    -do ( count – ) (immideate)
    -                "do .. loop" construction. Performs ".." "count" times.
    -                In every step "count" is decareased until it is 0.
    -                ex: : test 5 do i .d loop ;
    -                result: 4 3 2 1 0
    -
    -doexit ( – ) exit from "do .. loop"
    -
    -for ( count top – ) (immideate)
    -                "for .. loop" construction. Performs ".." (top - count) times.
    -                In every step "count" is incareased until it reaches "top" .
    -                ex: : test 4 10 for i .d loop ;
    -                result: 4 5 6 7 8 9
    -
    -forexit ( – ) exit from "for .. loop"
    -
    -until ( – ) (immideate)
    -                "until .. loop" construction. Performs ".." until flag become
    -                true. False by default. Top of return stack holds flag.
    -
    -done ( – ) exit from "until .. loop"
    -
    +if ( flag – ) (immideate)
    +                "if 1.. else 2.. then" or
    +                "if 1.. then" construction. Conditional execution.
    +                Performs "1.." if "flag" was true,
    +                elseway performs "2.." if exist. Execution continues after
    +                word "then".
    +                ex: 1 if ." nonzero" else ." zero" then
    +
    +>= ( n1 n2 – result ) true if (n1 = n2) or (n1 > n2)
    +                ex: 5 3 >= if ." first number is greater or equal" then
    +
    +<= ( n1 n2 – result ) true if (n1 = n2) or (n1 < n2)
    += ( n1 n2 – result ) true if n1 = n2
    +
    +do ( count – ) (immideate)
    +                "do .. loop" construction. Performs ".." "count" times.
    +                In every step "count" is decareased until it is 0.
    +                ex: : test 5 do i .d loop ;
    +                result: 4 3 2 1 0
    +
    +doexit ( – ) exit from "do .. loop"
    +
    +for ( count top – ) (immideate)
    +                "for .. loop" construction. Performs ".." (top - count) times.
    +                In every step "count" is incareased until it reaches "top" .
    +                ex: : test 4 10 for i .d loop ;
    +                result: 4 5 6 7 8 9
    +
    +forexit ( – ) exit from "for .. loop"
    +
    +until ( – ) (immideate)
    +                "until .. loop" construction. Performs ".." until flag become
    +                true. False by default. Top of return stack holds flag.
    +
    +done ( – ) exit from "until .. loop"
    +

    -
    -

    12.3 Disk & file access

    +
    +

    12.3 Disk & file access

    -diskload ( FromDisk ToMem amount – )
    -                Load specified abount of bytes from disk into memory.
    -
    -disksave ( FromMem ToDisk amount – )
    -                save specified abount of bytes from memory into disk.
    -
    -format ( – ) Erase all files.
    -
    -fsDfilesize@ ( handle – size )
    -                Return size of opened file.
    -
    -fsDcurloc@ ( handle – location )
    -                Return current location in file.
    -
    -fsDupdated@ ( handle – updated? )
    -                Return true if file was updated,
    -                ie. write operations occured.
    -
    -fssave ( FromMem DestFileHandle amount – )
    -                Save data to file.
    -
    -fsload ( SrcFileHandle ToMem amount – )
    -                Load data from file.
    -
    -fseof ( handle – bytesLeft )
    -                Return amount of bytes left till end of file.
    -                Useful before read operation.
    -
    -fsls ( – ) List all files and lists (directories,folders)
    -                in current path.
    -
    -fslsr ( – ) Same as "fsls" but recursively scans also sub lists.
    -
    -fscl ( DynStrHand – )
    -                Change list (path)
    -
    -fscreate ( DynStrHand – DescPnt )
    -                Create new file or list. Can create multiple lists at once.
    -                ex: when creating:
    -                    "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme"
    -                and only "\listGAMES\" already exist, then
    -                "listSTRATEGY" and "listSIMWORLD" lists will be created,
    -                and empty file "5th-runme" placed in there.
    -
    -fsDsave ( DynHand<data> DynStrHand<filename> – )
    -                Create new file and save all data from dynamic memory
    -                block to it.
    -
    -fsDload ( DynStr<SrcFileName> DynHand<DataDest> – )
    -                Load whole file into dynamic memory block.
    -
    -fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )
    -                Load whole file into new dynamic memory block.
    +diskload ( FromDisk ToMem amount – )
    +                Load specified abount of bytes from disk into memory.
    +
    +disksave ( FromMem ToDisk amount – )
    +                save specified abount of bytes from memory into disk.
    +
    +format ( – ) Erase all files.
    +
    +fsDfilesize@ ( handle – size )
    +                Return size of opened file.
    +
    +fsDcurloc@ ( handle – location )
    +                Return current location in file.
    +
    +fsDupdated@ ( handle – updated? )
    +                Return true if file was updated,
    +                ie. write operations occured.
    +
    +fssave ( FromMem DestFileHandle amount – )
    +                Save data to file.
    +
    +fsload ( SrcFileHandle ToMem amount – )
    +                Load data from file.
    +
    +fseof ( handle – bytesLeft )
    +                Return amount of bytes left till end of file.
    +                Useful before read operation.
    +
    +fsls ( – ) List all files and lists (directories,folders)
    +                in current path.
    +
    +fslsr ( – ) Same as "fsls" but recursively scans also sub lists.
    +
    +fscl ( DynStrHand – )
    +                Change list (path)
    +
    +fscreate ( DynStrHand – DescPnt )
    +                Create new file or list. Can create multiple lists at once.
    +                ex: when creating:
    +                    "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme"
    +                and only "\listGAMES\" already exist, then
    +                "listSTRATEGY" and "listSIMWORLD" lists will be created,
    +                and empty file "5th-runme" placed in there.
    +
    +fsDsave ( DynHand<data> DynStrHand<filename> – )
    +                Create new file and save all data from dynamic memory
    +                block to it.
    +
    +fsDload ( DynStr<SrcFileName> DynHand<DataDest> – )
    +                Load whole file into dynamic memory block.
    +
    +fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )
    +                Load whole file into new dynamic memory block.

    -
    -

    12.4 Dynamic memory

    +
    +

    12.4 Dynamic memory

    -dynal ( size – handle )
    -                Allocate dynamic memory block and return it's handle.
    -
    -dynde ( handle – )
    -                Deallocate dynamic memory block.
    -
    -dynp ( handle – addr )
    -                Returns pointer to memory where dynamic block
    -                data begins.
    -
    -dyns ( handle – size )
    -                Returns size of dynamic block.
    -
    -dynresize ( NewSize handle – )
    -                Nondestructively resize dynamic block.
    -
    -dync@ ( addr handle )
    -                Read one byte from dynamic block.
    -
    -dync! ( byte addr dynhandle )
    -                Write one byte to dynamic block.
    -
    -dyn@ ( addr handle )
    -                Read 32 bit number from dynamic block.
    -                Address will spacify, whitch number, not byte.
    -
    -dyn! ( 32BitNum addr dynhandle )
    -                Write 32 bit number to dynamic block.
    -                Address will spacify, whitch number, not byte.
    -
    -dyncon ( size "name" – )
    -                Allocate dynamic block with specified size, and
    -                create constant honding its handle.
    -                ex: 100 dyncon MyNewBlock
    -
    -dyn. ( handle – )
    -                Write contenc of dynamic memory block to screen.
    +dynal ( size – handle )
    +                Allocate dynamic memory block and return it's handle.
    +
    +dynde ( handle – )
    +                Deallocate dynamic memory block.
    +
    +dynp ( handle – addr )
    +                Returns pointer to memory where dynamic block
    +                data begins.
    +
    +dyns ( handle – size )
    +                Returns size of dynamic block.
    +
    +dynresize ( NewSize handle – )
    +                Nondestructively resize dynamic block.
    +
    +dync@ ( addr handle )
    +                Read one byte from dynamic block.
    +
    +dync! ( byte addr dynhandle )
    +                Write one byte to dynamic block.
    +
    +dyn@ ( addr handle )
    +                Read 32 bit number from dynamic block.
    +                Address will spacify, whitch number, not byte.
    +
    +dyn! ( 32BitNum addr dynhandle )
    +                Write 32 bit number to dynamic block.
    +                Address will spacify, whitch number, not byte.
    +
    +dyncon ( size "name" – )
    +                Allocate dynamic block with specified size, and
    +                create constant honding its handle.
    +                ex: 100 dyncon MyNewBlock
    +
    +dyn. ( handle – )
    +                Write contenc of dynamic memory block to screen.

    -
    -

    12.5 Graphics and text

    +
    +

    12.5 Graphics and text

    -. ( n – ) print number on screen
    -
    -d. ( n – ) print number on screen in decimal
    -
    -? ( addr – ) print 32 bit value located at addr.
    -
    -." <string>" ( – ) print string into screen. Immideately
    -                compiles.
    -                ex: : greeting ." Hello, World" ;
    -
    -tab. ( – ) print tabulator
    -
    -calccol ( b g r – c ) calculate color what best matches given
    -                Blue Green & Red values. Values must be in range 0 - 255.
    -
    -imgalloc ( xsize ysize – imgbuf ) allocate image buffer for
    -                specified size.
    -
    -imgsize ( imgbuf – ) print on the screen X & Y size of image
    -                buffer.
    -
    -point ( x y imgbuf – addr ) returns memory address for specified
    -                pixel.
    -
    -pset ( color x y imgbuf – ) set graphic point
    -
    -boxf ( x1 x2 y1 y2 imgbuf color – ) draw filled box
    -
    -cls ( imgbuf – ) clear image buffer
    -
    -setpal ( b g r color – ) set palette value for specified color.
    -                values bust be in size 0 - 63.
    -
    -putchar ( char color x y imgbuf – ) put graphic character in
    -                imagebuffer to specified (x & y) location.
    -
    -scroll ( x y imgbuf – ) scroll in imgbuf.
    -
    -scrollf ( color x y screen – ) scroll and fill empty space with
    -                given color.
    -
    -at! ( x y – ) set cursor location
    -curc! ( color – ) set text color
    -curb! ( solor – ) set backround color
    -
    -colnorm ( – ) set text color to normal
    -colneg ( – ) set text color to negative (selected)
    -
    -dyntype ( dynhandle – ) display contenc of dynamic memory on screen
    -fsdisp ( file – ) clear screen, display file, and wait for key
    -
    -type ( addr length – )
    -                Types on the screen string, from memory at addr and
    -                specified length.
    -
    -write ( addr – )
    -                Types on the screen string, from memory at "addr"+1
    -                length is taken from "addr" .
    -
    -screen const 32 bit
    -                Holds handle of screen buffer.
    -
    -copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source
    -                image to destination image. Source and destination images
    -                must have same size.
    +. ( n – ) print number on screen
    +
    +d. ( n – ) print number on screen in decimal
    +
    +? ( addr – ) print 32 bit value located at addr.
    +
    +." <string>" ( – ) print string into screen. Immideately
    +                compiles.
    +                ex: : greeting ." Hello, World" ;
    +
    +tab. ( – ) print tabulator
    +
    +calccol ( b g r – c ) calculate color what best matches given
    +                Blue Green & Red values. Values must be in range 0 - 255.
    +
    +imgalloc ( xsize ysize – imgbuf ) allocate image buffer for
    +                specified size.
    +
    +imgsize ( imgbuf – ) print on the screen X & Y size of image
    +                buffer.
    +
    +point ( x y imgbuf – addr ) returns memory address for specified
    +                pixel.
    +
    +pset ( color x y imgbuf – ) set graphic point
    +
    +boxf ( x1 x2 y1 y2 imgbuf color – ) draw filled box
    +
    +cls ( imgbuf – ) clear image buffer
    +
    +setpal ( b g r color – ) set palette value for specified color.
    +                values bust be in size 0 - 63.
    +
    +putchar ( char color x y imgbuf – ) put graphic character in
    +                imagebuffer to specified (x & y) location.
    +
    +scroll ( x y imgbuf – ) scroll in imgbuf.
    +
    +scrollf ( color x y screen – ) scroll and fill empty space with
    +                given color.
    +
    +at! ( x y – ) set cursor location
    +curc! ( color – ) set text color
    +curb! ( solor – ) set backround color
    +
    +colnorm ( – ) set text color to normal
    +colneg ( – ) set text color to negative (selected)
    +
    +dyntype ( dynhandle – ) display contenc of dynamic memory on screen
    +fsdisp ( file – ) clear screen, display file, and wait for key
    +
    +type ( addr length – )
    +                Types on the screen string, from memory at addr and
    +                specified length.
    +
    +write ( addr – )
    +                Types on the screen string, from memory at "addr"+1
    +                length is taken from "addr" .
    +
    +screen const 32 bit
    +                Holds handle of screen buffer.
    +
    +copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source
    +                image to destination image. Source and destination images
    +                must have same size.

    -
    -

    12.6 Math, memory & stack manipulation

    +
    +

    12.6 Math, memory & stack manipulation

    -off ( n – ) writes 0 to given address, good for zeroing variable.
    -                ex: MyVariable off
    -on ( n – ) writes -1 (true flag) to given address.
    -                ex: MyVariable on
    -
    -2dup ( n1 n2 – n1 n2 n1 n2 )
    -2drop ( n1 n2 – )
    -nip ( n1 n2 – n2 )
    -neg ( n1 – -n1 ) negotiate
    -bit@ ( n bit – result ) return specified bit from n.
    -                ex: 38 2 bit@ (result will be 1)
    -to32bit ( n1 n2 n3 n4 – n32 ) treat 4 last stack elements as bytes
    -                and unite them into 32 bit dword. Most significant byte
    -                on top.
    -                ex: 12 76 23 11 to32bit result: 186076172
    -
    -to8bit ( n32 – n1 n2 n3 n4 ) break 32 bit number into 4 bytes.
    -                Useful if you need to send 32 bit numbers thru 8 bit COM
    -                port.
    -                ex: 186076172 to8bit result: 12 76 23 11
    -
    -mod ( n1 n2 – reminder ) divide n1 by n2 and returns reminder.
    -                ex: 12 5 mod result: 2
    -
    -bound ( low n high – n ) check if n is in given bounds,
    -                if not then incarease/decarease it to match bounds.
    -                ex: 5 80 15 bound result: 15
    -                    5 10 15 bound result: 10
    -                    5 -10 15 bound result: 5
    -
    -bound? ( low n high – result ) returns true if n is in the
    -                given bounds.
    -
    -tab ( col – spaces) calculate amount of spaces to add
    -                ta reach next tabulation from given column.
    -
    -count ( addr – addr+1 n )
    -                Useful for returning bytes from constantly incareasing
    -                address. Module "type" is nice example.
    -
    -c, ( n – )
    -                store one byte at memory specified by "h". And incarease
    -                "h" by 1.
    -
    -, ( n – )
    -                store 32 bit number at memory specified by "h". And
    -                incarease "h" by 4.
    -
    -cmove ( addr1 addr2 n – )
    -                copy "n" amount of bytes from memory at "addr1" to memory
    -                at "addr2".
    -
    -rnd ( limit – result )
    -                generates random number in range 0 to "limit"-1.
    -
    -abs ( n – |n| )
    -                returns absolute value of "n"
    +off ( n – ) writes 0 to given address, good for zeroing variable.
    +                ex: MyVariable off
    +on ( n – ) writes -1 (true flag) to given address.
    +                ex: MyVariable on
    +
    +2dup ( n1 n2 – n1 n2 n1 n2 )
    +2drop ( n1 n2 – )
    +nip ( n1 n2 – n2 )
    +neg ( n1 – -n1 ) negotiate
    +bit@ ( n bit – result ) return specified bit from n.
    +                ex: 38 2 bit@ (result will be 1)
    +to32bit ( n1 n2 n3 n4 – n32 ) treat 4 last stack elements as bytes
    +                and unite them into 32 bit dword. Most significant byte
    +                on top.
    +                ex: 12 76 23 11 to32bit result: 186076172
    +
    +to8bit ( n32 – n1 n2 n3 n4 ) break 32 bit number into 4 bytes.
    +                Useful if you need to send 32 bit numbers thru 8 bit COM
    +                port.
    +                ex: 186076172 to8bit result: 12 76 23 11
    +
    +mod ( n1 n2 – reminder ) divide n1 by n2 and returns reminder.
    +                ex: 12 5 mod result: 2
    +
    +bound ( low n high – n ) check if n is in given bounds,
    +                if not then incarease/decarease it to match bounds.
    +                ex: 5 80 15 bound result: 15
    +                    5 10 15 bound result: 10
    +                    5 -10 15 bound result: 5
    +
    +bound? ( low n high – result ) returns true if n is in the
    +                given bounds.
    +
    +tab ( col – spaces) calculate amount of spaces to add
    +                ta reach next tabulation from given column.
    +
    +count ( addr – addr+1 n )
    +                Useful for returning bytes from constantly incareasing
    +                address. Module "type" is nice example.
    +
    +c, ( n – )
    +                store one byte at memory specified by "h". And incarease
    +                "h" by 1.
    +
    +, ( n – )
    +                store 32 bit number at memory specified by "h". And
    +                incarease "h" by 4.
    +
    +cmove ( addr1 addr2 n – )
    +                copy "n" amount of bytes from memory at "addr1" to memory
    +                at "addr2".
    +
    +rnd ( limit – result )
    +                generates random number in range 0 to "limit"-1.
    +
    +abs ( n – |n| )
    +                returns absolute value of "n"

    -
    -

    12.7 Dynamic & static strings

    +
    +

    12.7 Dynamic & static strings

    Fifth supports both static and dynamic strings. Static strings must @@ -1487,291 +1923,234 @@ holds current string length, following bytes are string itself.

    -Dynamic:
    -
    -Dstral ( – handle )
    -                Allocate new string.
    -
    -Dstrlen ( handle – length )
    -                Return string length.
    -
    -c+Dstr ( chr handle – )
    -                Add one byte to end of the string.
    -
    -c+lDstr ( chr handle – )
    -                Add one byte to left side (beginning) of the string.
    -
    -Dstr. ( handle – )
    -                Write contec of string into screen.
    -
    -Dstrsure ( size Dstr – )
    -                Makes sure that at least rquested
    -                "size" (amount of characters) is allocated for given
    -                dynamic string.
    -
    -Dstr2str ( handle address – )
    -                Copy dyamic string into static memory space.
    -
    -str2Dstr ( address handle – )
    -                Copy static string into dyamic string.
    -
    -Dstr+str ( Dstr addr – )
    -                Add contenc of dynamic string to static string.
    -
    -D" any string" ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr".
    -
    -D> any_string ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr".
    -                Space marks end of string!
    -
    -D>2 any_string ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr2".
    -                Space marks end of string!
    -
    -Dstr+Dstr ( Dstr1 Dstr2 – )
    -                Adds "Dstr1" to "Dstr2" and places result into "Dstr2".
    -
    -Dstrclear ( Dstr – )
    -                Clears contenc of dynamic string.
    -
    -Dstr2Dstr ( Dstr1 Dstr2 – )
    -                Moves "Dstr1" to "Dstr2".
    -Dstr ( data" name – )
    -                Creates new dynamic string and moves specified data into it.
    -                Then creates new constant with given "name" holding created
    -                dynamic string handle.
    -
    -                ex: Dstr Hello, my name is Sven!" message \ creates it
    -                    message Dstr. \ tests it
    -
    -Dstrlscan ( char Dstr – loc )
    -                Searches dynamic string for "char", from left to right,
    -                returns first found "char" location in string, or 0,
    -                if not found.
    -
    -Dstrrscan ( char Dstr – loc )
    -                Searches dynamic string for "char", from right to left,
    -                returns first found "char" location in string, or 0,
    -                if not found.
    -
    -Dstrlscane ( char Dstr – loc )
    -                Same as "Dstrlscan" buf returns string length+1 as location.
    -ÿ
    -Dstrleft ( amo Dstr – )
    -                Only specified amount of characters from left remains
    -                in dynamic string. ie. cut right part out.
    -
    -Dstrright ( amo Dstr – )
    -                Only specified amount of characters from right remains
    -                in dynamic string. ie. cut left part out.
    -
    -Dstrcutl ( amo Dstr – )
    -                Cut specified amount of characters from left of dynamic
    -                string out.
    -
    -Dstrsp ( char Dstr1 Dstr2 – )
    -                Separate dynamic string in Dstr1 into two parts,
    -                using "char" as separator. First part will be stored in
    -                "Dstr2", second part in "Dstr1".
    -                ex: asc \ \ ..separator
    -                    D> listF\listLIB\5TH_DRVMOUSE \ ..separate from
    -                    defDstr2 \ ..place result in
    -                    Dstrsp \ separation command
    -                    defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE
    -                    defDstr2 Dstr. \ will be: listF
    -
    -Dv ( addr – )
    -                Allocates empty dynamic string, and places it's handle
    -                into given address.
    -
    -Df ( addr – )
    -                Reads dynamic string handle from given address and
    -                deallocates (frees) it.
    -
    -ex: var mystring1
    -        : testmodule
    -        mystring1 Dv \ allocates string
    -
    -                <whatever>
    -
    -        mystring1 Df ; \ deallocates it again when no longer needed.
    +Dynamic:
    +
    +Dstral ( – handle )
    +                Allocate new string.
    +
    +Dstrlen ( handle – length )
    +                Return string length.
    +
    +c+Dstr ( chr handle – )
    +                Add one byte to end of the string.
    +
    +c+lDstr ( chr handle – )
    +                Add one byte to left side (beginning) of the string.
    +
    +Dstr. ( handle – )
    +                Write contec of string into screen.
    +
    +Dstrsure ( size Dstr – )
    +                Makes sure that at least rquested
    +                "size" (amount of characters) is allocated for given
    +                dynamic string.
    +
    +Dstr2str ( handle address – )
    +                Copy dyamic string into static memory space.
    +
    +str2Dstr ( address handle – )
    +                Copy static string into dyamic string.
    +
    +Dstr+str ( Dstr addr – )
    +                Add contenc of dynamic string to static string.
    +
    +D" any string" ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr".
    +
    +D> any_string ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr".
    +                Space marks end of string!
    +
    +D>2 any_string ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr2".
    +                Space marks end of string!
    +
    +Dstr+Dstr ( Dstr1 Dstr2 – )
    +                Adds "Dstr1" to "Dstr2" and places result into "Dstr2".
    +
    +Dstrclear ( Dstr – )
    +                Clears contenc of dynamic string.
    +
    +Dstr2Dstr ( Dstr1 Dstr2 – )
    +                Moves "Dstr1" to "Dstr2".
    +Dstr ( data" name – )
    +                Creates new dynamic string and moves specified data into it.
    +                Then creates new constant with given "name" holding created
    +                dynamic string handle.
    +
    +                ex: Dstr Hello, my name is Sven!" message \ creates it
    +                    message Dstr. \ tests it
    +
    +Dstrlscan ( char Dstr – loc )
    +                Searches dynamic string for "char", from left to right,
    +                returns first found "char" location in string, or 0,
    +                if not found.
    +
    +Dstrrscan ( char Dstr – loc )
    +                Searches dynamic string for "char", from right to left,
    +                returns first found "char" location in string, or 0,
    +                if not found.
    +
    +Dstrlscane ( char Dstr – loc )
    +                Same as "Dstrlscan" buf returns string length+1 as location.
    +ÿ
    +Dstrleft ( amo Dstr – )
    +                Only specified amount of characters from left remains
    +                in dynamic string. ie. cut right part out.
    +
    +Dstrright ( amo Dstr – )
    +                Only specified amount of characters from right remains
    +                in dynamic string. ie. cut left part out.
    +
    +Dstrcutl ( amo Dstr – )
    +                Cut specified amount of characters from left of dynamic
    +                string out.
    +
    +Dstrsp ( char Dstr1 Dstr2 – )
    +                Separate dynamic string in Dstr1 into two parts,
    +                using "char" as separator. First part will be stored in
    +                "Dstr2", second part in "Dstr1".
    +                ex: asc \ \ ..separator
    +                    D> listF\listLIB\5TH_DRVMOUSE \ ..separate from
    +                    defDstr2 \ ..place result in
    +                    Dstrsp \ separation command
    +                    defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE
    +                    defDstr2 Dstr. \ will be: listF
    +
    +Dv ( addr – )
    +                Allocates empty dynamic string, and places it's handle
    +                into given address.
    +
    +Df ( addr – )
    +                Reads dynamic string handle from given address and
    +                deallocates (frees) it.
    +
    +ex: var mystring1
    +        : testmodule
    +        mystring1 Dv \ allocates string
    +
    +                <whatever>
    +
    +        mystring1 Df ; \ deallocates it again when no longer needed.

    -
    -

    13 Dynamically loadable modules

    +
    +

    13 Dynamically loadable modules

    -
    -

    13.1 Keyboard driver

    +
    +
    +

    13.1 Keyboard driver

    -
    -KBD_@ ( – code ) get scancodes for pressed keys from keyboard.
    -KBD_down? ( key – result ) check is key with specified scancode
    -                currently pressed down.
    -KBD_SC2FSCII ( code – FSCII ) convert key scancode into FSCII code,
    -                or in FSK (Fifth standard keycode).
    -KBD_F@ ( – FSCII ) read pressed key FSCII or FSK, returns -1 if no
    -                keys are pressed.
    -KBD_FW@ ( – FSCII ) read pressed key FSCII or FSK, if no keys is
    -                are pressed then waits until there is.
    -
    -                FSK
    -                —
    -In HEX.
    -
    -FC backspace
    -FD TAB
    -FE enter
    -FF space
    -
    -400 ESC
    -401 … F1 …
    -410 up
    -411 right
    -412 down
    -413 left
    -414 INS
    -415 DEL
    -416 home
    -417 end
    -418 PG/UP
    -419 PG/DN
    +
    +KBD_@ ( – code ) get scancodes for pressed keys from keyboard.
    +KBD_down? ( key – result ) check is key with specified scancode
    +                currently pressed down.
    +KBD_SC2FSCII ( code – FSCII ) convert key scancode into FSCII code,
    +                or in FSK (Fifth standard keycode).
    +KBD_F@ ( – FSCII ) read pressed key FSCII or FSK, returns -1 if no
    +                keys are pressed.
    +KBD_FW@ ( – FSCII ) read pressed key FSCII or FSK, if no keys is
    +                are pressed then waits until there is.
    +
    +                FSK
    +                —
    +In HEX.
    +
    +FC backspace
    +FD TAB
    +FE enter
    +FF space
    +
    +400 ESC
    +401 … F1 …
    +410 up
    +411 right
    +412 down
    +413 left
    +414 INS
    +415 DEL
    +416 home
    +417 end
    +418 PG/UP
    +419 PG/DN

    -
    -

    13.2 Mouse driver

    +
    +

    13.2 Mouse driver

    -mousex var Mouse x coordinate.
    -mousey var Mouse y coordinate.
    -mousekeyl var Mouse left key.
    -mousekeym var Mouse middle key.
    -mousekeyr var Mouse right key.
    -mousec var Display current mouse coordinates in top left part of screen,
    -                if true. (good for debugging)
    -mousepointer var Image buffer, holding current mouse pointer.
    -mouseadd ( ModuleAddr x1 x2 y1 y2 – ) Add specified area on screen,
    -                into mause click buffer. If any mouse button is clicked on
    -                that area, module at "ModuleAddr" will be executed.
    -mousebe var Amount of buffer elements.
    -mousedo ( – ) Updates mouse coordinates and keys. Parse mouse
    -                click buffer, and draw mouse cursor to "screen".
    +mousex var Mouse x coordinate.
    +mousey var Mouse y coordinate.
    +mousekeyl var Mouse left key.
    +mousekeym var Mouse middle key.
    +mousekeyr var Mouse right key.
    +mousec var Display current mouse coordinates in top left part of screen,
    +                if true. (good for debugging)
    +mousepointer var Image buffer, holding current mouse pointer.
    +mouseadd ( ModuleAddr x1 x2 y1 y2 – ) Add specified area on screen,
    +                into mause click buffer. If any mouse button is clicked on
    +                that area, module at "ModuleAddr" will be executed.
    +mousebe var Amount of buffer elements.
    +mousedo ( – ) Updates mouse coordinates and keys. Parse mouse
    +                click buffer, and draw mouse cursor to "screen".

    -
    -

    13.3 2D graphic library

    +
    +

    13.3 2D graphic library

    -lineh ( color len x y imgbuf – ) draws horisontal line
    -                from X,Y coordinates to right, with specified length.
    -linev ( color len x y imgbuf – ) draws vertical line
    -                down, from coordinates X,Y, with specified length.
    -box ( color x2 x1 y2 y1 imgbuf – ) draws rectangular
    -                box. x2 bust be >= x1, y2 must be >= y1.
    -                        x1,y1–———+
    -                          | |
    -                          | |
    -                          +–———x2,y2
    -
    -flipv ( imgbuf – ) flip image vertically.
    -imgcoltrans ( ImgBuf Color ToColor – ) Translate all pixels in
    -                specified image with "Color" into "ToColor".
    -imgfill ( color x y imgbuf – ) Fill image region starting at location
    -                X & Y with specified color.
    +lineh ( color len x y imgbuf – ) draws horisontal line
    +                from X,Y coordinates to right, with specified length.
    +linev ( color len x y imgbuf – ) draws vertical line
    +                down, from coordinates X,Y, with specified length.
    +box ( color x2 x1 y2 y1 imgbuf – ) draws rectangular
    +                box. x2 bust be >= x1, y2 must be >= y1.
    +                        x1,y1------–—+
    +                          | |
    +                          | |
    +                          +------–—x2,y2
    +
    +flipv ( imgbuf – ) flip image vertically.
    +imgcoltrans ( ImgBuf Color ToColor – ) Translate all pixels in
    +                specified image with "Color" into "ToColor".
    +imgfill ( color x y imgbuf – ) Fill image region starting at location
    +                X & Y with specified color.

    -
    -

    13.4 Trigonometry functions

    +
    +

    13.4 Trigonometry functions

    -

    -sin ( a – result ) return sinus from given angle "a",
    -                360ø is 2000. So 1000 represents 180ø angle.
    -                Result will be in range -10'000 to 10'000, instead of ñ1.
    -
    -cos ( a – result ) return cosinus from given angle.
    -                Parameters are like in "sin" function.
    +

    +
    +

    13.4.1 sin ( a – result )

    +
    +

    +Return sinus from given angle "a", 360ø is 2000. So 1000 represents +180ø angle. Result will be in range -10'000 to 10'000, instead of ñ1. +

    +
    +
    +
    +

    13.4.2 cos ( a – result )

    +
    +

    +Return cosinus from given angle. Parameters are like in sin function.

    -
    -
    -
    -

    Author: Svjatoslav Agejenko

    -

    Created: 2020-05-02 Sat 00:04

    -

    Emacs 26.1 (Org-mode 9.1.9)

    -
    +
    +

    Author: Svjatoslav Agejenko

    +

    Created: 2021-12-21 T 20:02

    +

    Validate

    +
    diff --git a/doc/index.org b/doc/index.org index fca8640..79b5592 100644 --- a/doc/index.org +++ b/doc/index.org @@ -46,16 +46,20 @@ inspired created my own system. - [[file:5TH_ET.txt][Example Fifth source file - text editor]] ** screenshots -- [[file:screenshots/start.png]] - - Startup screen diplaying Fifth logo and full file list. +[[file:screenshots/start.png]] -- [[file:screenshots/dictionary.png]] - - 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. +Startup screen diplaying Fifth logo and full file list. -- [[file:screenshots/text editor.png]] - - Built in text editor. +[[file:screenshots/dictionary.png]] + +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. + + +[[file:screenshots/text editor.png]] + +Built in text editor. * Installation Just unpack all files, witout altering original directory structure, @@ -73,22 +77,22 @@ After downloading and unpacking the ZIP file you shoud get directory tree similar to this: #+BEGIN_VERSE -[DOC] - Fifth documentation - [commands] - documentation on Fifth built-in commands - [modules] - documentation on additional commands, realized as loadable modules - [shots] - Fifth screenshots +*DOC* - Fifth documentation + *commands* - documentation on Fifth built-in commands + *modules* - documentation on additional commands, realized as loadable modules + *shots* - Fifth screenshots -[imageFile] - files contained within 'disk.raw', just an extracted form. +*imageFile* - files contained within 'disk.raw', just an extracted form. -[source] - source files - [emulator] - emulator source - [util] - utilites +*source* - source files + *emulator* - emulator source + *util* - utilites -disk.raw - Virtual disk file, has filesystem inside. -emulator.com - main executable. +*disk.raw* - Virtual disk file, has filesystem inside. +*emulator.com* - main executable. #+END_VERSE -* Software/Hardware/Human requirements +* Requirements ** Software - MS-DOS 6.22, with HIMEM.SYS loaded. - Mouse driver if you have a mouse. @@ -118,20 +122,20 @@ their color (black or white). 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. -** disk allocation +** Disk allocation | offset | length | description | |--------+--------+----------------------| | 0 | ~4 Kb | Fifth core | -| 4 Kb | ~32Kb | high-level boot code | -| 37 Kb | ~65Kb | FAT | -| 101Kb | ~16MB | filesystem data area | +| 4 Kb | ~32 Kb | high-level boot code | +| 37 Kb | ~65 Kb | FAT | +| 101 Kb | ~16 MB | filesystem data area | ** FAT entry format: | code | meaning | |------+--------------------------| | -2 | last sector | | -1 | empty sector | | 0 -- | .. pointer to next block | -** file entry format +** File entry format | offset | length | description | |--------+--------+------------------------| | 0 | 4 | extension | @@ -174,13 +178,13 @@ run through headers backwards and find needed entry. | | | with address to module | |------+----------------+----------------------------| | 2 | imm. submodule | immediately call to module | -** Memory map (average) -| | | | -|---------+--------+-----------------------------| -| 0 | ~4096 | core | -| 1500000 | ~32000 | highlevel Fifth boot code | -| 200000h | | core startup messages area | -| 5200000 | | end of dynamic memory space | +** Memory map +| location | size | description | +|----------+--------+-----------------------------| +| 0 | ~4096 | core | +| 1500000 | ~32000 | highlevel Fifth boot code | +| 200000h | | core startup messages area | +| 5200000 | | end of dynamic memory space | * Virtual machine :PROPERTIES: :ID: 9b251eb9-aff6-4025-94bf-25e89e26d54a @@ -206,103 +210,98 @@ CPU has following registers: | IP | instruction pointer | | DSP | data stack pointer | | RSP | return stack pointer | - +** instruction set +*** overview table Virtual CPU, commands (most of them are avaiable as ordinary commands -in programming lanquage): - -#+BEGIN_VERSE - -code mnemonic description - -0 nop does notheing -1 halt halt CPU ( return to DOS on emulator ) - -2 kbd@ ( -- c ) read scancode of pressed or released key. - Returns 0, if no data avaiable. -3 num ( -- n ) put immidiate number into datastack - -4 jmp jump to specified code -5 call jump to specified code, save return address to - return stack. - -6 1+ ( n -- n+1 ) -7 1- ( n -- n-1 ) - -8 dup ( n -- n n ) duplicate top of data stack -9 drop ( n -- ) drop last element in data stack - -10 if ( n -- ) jump to addr if top element was 0 -11 ret jump to code, specified in return stack. - -12 c@ ( addr -- n ) read byte from memory at specified address -13 c! ( n addr -- ) store byte to specified memory - -14 push ( DSTK -> RSTK ) move top of datastack to returnstack -15 pop ( RSTK -> DSTK ) move top of returnstack to datastack - -16 -17 rot ( n1 n2 n3 -- n2 n3 n1) rotate stack elements - -18 disk@ ( FromDiskSect ToMem -- ) read 1KB from disk into RAM -19 disk! ( FromMem ToDiskSect -- ) write 1KB to disk - -20 @ ( addr -- n ) read 32 bit number from memory -21 ! ( n addr -- ) store 32 bit number to memory - -22 over ( n1 n2 -- n1 n2 n1 ) self explaining ... -23 swap ( n1 n2 -- n2 n1 ) -,,- - -24 + ( n1 n2 -- n1+n2 ) -,,- -25 - ( n1 n2 -- n1-n2 ) -,,- - -26 * ( n1 n2 -- n1*n2 ) -,,- -27 / ( n1 n2 -- n1/n2 ) -,,- - -28 > ( n1 n2 -- result ) is true when n1 > n2 -29 < ( n1 n2 -- result ) is true when n1 < n2 - -30 not ( n1 -- not_n1 ) logical not -31 i ( -- n ) copies top of return stack into datastack - -32 cprt@ ( addr -- n ) read one byte from hardware port -33 cprt! ( n addr -- ) store one byte to hardware port - -34 i2 ( -- n ) like "i" but takes socond top stack element. -35 i3 ( -- n ) like "i" but takes third top stack element. - -36 shl ( n amount -- n ) left bit shift -37 shr ( n amount -- n ) right bit shift - -38 or ( n1 n2 -- n ) logical or -39 xor ( n1 n2 -- n ) exclusive logical or - -40 vidmap ( addr -- ) copy memory from "addr" to video memory. - -41 mouse@ ( -- x y button ) read mouse coordinates & buttons - -42 vidput ( addr1 addr2 x y -- ) put image1 into image2, at - location x, y. Does clipping, so part of a big image - can be mapped into smaller one. - -43 cmove ( addr1 addr2 amount ) move memory from addr1 to addr2 - if addr1 is greater than addr2 then count address - foward while moving, elseway starts from end and - counts backwards, so no data loss will occure on - overlapping. - -44 cfill ( c addr amount -- ) fill memory starting at "addr" - with "c" bytes. - -45 tvidput ( addr1 addr2 x y -- ) same as "vidput" but treats - color 255 in source image as transparent. +in programming language): + + +| # | name | stack footprint | description | +|----+--------------+--------------------------------------+-------------------------------------------------------------| +| 0 | nop | -- | does nothing | +| 1 | halt | -- | halt CPU ( return to DOS on emulator ) | +| 2 | [[id:820b1b90-4f4c-4ab1-b49f-9b4a52ea2528][kbd@]] | -- c | read scancode of pressed or released key | +| 3 | num | -- n | put immidiate number into datastack | +| 4 | jmp | -- | jump to specified code | +| 5 | call | | jump to specified code, save return address to return stack | +| 6 | 1+ | n -- n+1 | | +| 7 | 1- | n -- n-1 | | +| 8 | dup | n -- n n | duplicate top of data stack | +| 9 | drop | n -- | drop last element in data stack | +| 10 | if | n -- | jump to addr if top element was 0 | +| 11 | ret | | jump to code, specified in return stack. | +| 12 | c@ | addr -- n | read byte from memory at specified address | +| 13 | c! | n addr -- | store byte to specified memory | +| 14 | push | DSTK -> RSTK | move top of datastack to returnstack | +| 15 | pop | RSTK -> DSTK | move top of returnstack to datastack | +| 16 | | | | +| 17 | rot | n1 n2 n3 -- n2 n3 n1 | rotate stack elements | +| 18 | disk@ | FromDiskSect ToMem -- | read 1KB from disk into RAM | +| 19 | disk! | FromMem ToDiskSect -- | write 1KB to disk | +| 20 | @ | addr -- n | read 32 bit number from memory | +| 21 | ! | n addr -- | store 32 bit number to memory | +| 22 | over | n1 n2 -- n1 n2 n1 | | +| 23 | swap | n1 n2 -- n2 n1 | | +| 24 | + | n1 n2 -- n1+n2 | | +| 25 | - | n1 n2 -- n1-n2 | | +| 26 | * | n1 n2 -- n1*n2 | | +| 27 | / | n1 n2 -- n1/n2 | | +| 28 | > | n1 n2 -- result | is true when n1 > n2 | +| 29 | < | n1 n2 -- result | is true when n1 < n2 | +| 30 | not | n1 -- not_n1 | logical not | +| 31 | i | -- n | copies top of return stack into datastack | +| 32 | cprt@ | addr -- n | read one byte from hardware port | +| 33 | cprt! | n addr -- | store one byte to hardware port | +| 34 | i2 | -- n | like "i" but takes second top stack element | +| 35 | i3 | -- n | like "i" but takes third top stack element. | +| 36 | shl | n amount -- n | left bit shift | +| 37 | shr | n amount -- n | right bit shift | +| 38 | or | n1 n2 -- n | logical or | +| 39 | xor | n1 n2 -- n | exclusive logical or | +| 40 | vidmap | addr -- | copy memory from "addr" to video memory. | +| 41 | mouse@ | -- x y button | read mouse coordinates & buttons | +| 42 | [[id:238e8b03-57b6-424d-bfee-b6bb652cefbc][vidput]] | addr1 addr2 x y -- | put image1 into image2, at location x, y | +| 43 | [[id:79e1916f-4103-42cc-ac10-bb1ee776ed50][cmove]] | addr1 addr2 amount | move memory from addr1 to addr2 | +| 44 | cfill | c addr amount -- | fill memory starting at "addr" with "c" bytes. | +| 45 | [[id:ab45247c-44c3-464d-9e2a-337f483b4616][tvidput]] | addr1 addr2 x y -- | put image with transparency support | +| 46 | depth | -- depth | returns current depth of data stack. | +| 47 | [[id:4bb479cf-aae0-4128-9868-f016c286a162][charput]] | colorfg colorbg addrsrc addrdest x y | draw text character | + +*** kbd@ - read scancode of pressed or released key +:PROPERTIES: +:ID: 820b1b90-4f4c-4ab1-b49f-9b4a52ea2528 +:END: +Returns 0 if no data available. +*** vidput - put image1 into image2, at location x, y +:PROPERTIES: +:ID: 238e8b03-57b6-424d-bfee-b6bb652cefbc +:END: +Does clipping, so part of a big image can be mapped into smaller one. +*** cmove - copy memory array +:PROPERTIES: +:ID: 79e1916f-4103-42cc-ac10-bb1ee776ed50 +:END: +Move memory from addr1 to addr2. If addr1 is greater than addr2 then +count address foward while moving, elseway starts from end and counts +backwards, so no data loss occurs when memory regions partially +overlap. +*** tvidput - put image with transparency support +:PROPERTIES: +:ID: ab45247c-44c3-464d-9e2a-337f483b4616 +:END: +Stack footprint +: addr1 addr2 x y -- -46 depth ( -- depth ) returns current depth of data stack. +Put image1 into image2, at location x, y with transparency support -47 charput ( colorfg colorbg addrsrc addrdest x y ) - draw character to image buffer located at "addrdest" - to specified x & y location. Decodes 8 bytes from - source to bits, used to draw character. -#+END_VERSE +Color 255 in source image is treated as transparent. +*** charput - draw text character +:PROPERTIES: +:ID: 4bb479cf-aae0-4128-9868-f016c286a162 +:END: +Draw character to image buffer located at "addrdest" to specified x & +y location. Decodes 8 bytes from source to bits, used to draw +character. * Fifth source format Fifth uses a different character table and codes than ASCII (still @@ -948,11 +947,11 @@ imgfill ( color x y imgbuf -- ) Fill image region starting at location X & Y with specified color. #+END_VERSE ** Trigonometry functions -#+BEGIN_VERSE -sin ( a -- result ) return sinus from given angle "a", - 360ø is 2000. So 1000 represents 180ø angle. - Result will be in range -10'000 to 10'000, instead of ñ1. - -cos ( a -- result ) return cosinus from given angle. - Parameters are like in "sin" function. -#+END_VERSE +*** sin ( a -- result ) +:PROPERTIES: +:ID: 9a66ca9c-eb5f-45aa-8116-71763081f2fb +:END: +Return sinus from given angle "a", 360ø is 2000. So 1000 represents +180ø angle. Result will be in range -10'000 to 10'000, instead of ñ1. +*** cos ( a -- result ) +Return cosinus from given angle. Parameters are like in [[id:9a66ca9c-eb5f-45aa-8116-71763081f2fb][sin]] function. diff --git a/tools/commit and push b/tools/commit and push deleted file mode 100755 index 057b511..0000000 --- a/tools/commit and push +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash -cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi; - -cd .. - -cola -git push - -echo "" -echo "Press ENTER to close this window." -read diff --git a/tools/synchronize b/tools/synchronize new file mode 100755 index 0000000..8427b12 --- /dev/null +++ b/tools/synchronize @@ -0,0 +1,18 @@ +#!/bin/bash +cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -- "$0" T; exit; fi + +cd .. + +# pull latest content from repository +git pull + +# stage all changes +git add --all + +# open GUI to confirm/revert/commit changes +cola + +# push changes to remote repository +git push + +sleep 3 -- 2.20.1 From 8b04e67d1f2539276a20828375c5f0025d1de0d4 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 21 Dec 2021 20:08:10 +0200 Subject: [PATCH 3/7] Updated website update script --- tools/update web site | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/update web site b/tools/update web site index 20a52bc..a4d0fd0 100755 --- a/tools/update web site +++ b/tools/update web site @@ -1,5 +1,5 @@ #!/bin/bash -cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -e "'$0' T"; exit; fi; +cd "${0%/*}"; if [ "$1" != "T" ]; then gnome-terminal -- "$0" T; exit; fi; cd .. -- 2.20.1 From 1a9256b173a7c94a017d6480acdf2f67d49bae36 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 21 Dec 2021 20:10:37 +0200 Subject: [PATCH 4/7] fixed file permissions --- imageFile/f/5TH_AUTORUN | 0 imageFile/f/5TH_QUICKPATH | 0 imageFile/f/5th_boot | 0 imageFile/f/5th_demo | 0 imageFile/f/5th_eg | 0 imageFile/f/5th_et | 0 imageFile/f/5th_logo | 0 imageFile/f/FNT_SYSTEM | Bin imageFile/f/I01_MCARROW | Bin imageFile/f/lib/5TH_DRVKBD | 0 imageFile/f/lib/5TH_DRVMOUSE | 0 imageFile/f/lib/5TH_KBD_US | 0 imageFile/f/lib/5TH_KBD_USDVORAK | 0 imageFile/f/lib/5TH_UICMD | 0 imageFile/f/lib/5th_gfx | 0 imageFile/f/lib/5th_gfx2 | 0 imageFile/f/lib/5th_trig | 0 imageFile/f/txt_eg | 0 imageFile/f/txt_et | 0 imageFile/f/txt_help | 0 20 files changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 imageFile/f/5TH_AUTORUN mode change 100755 => 100644 imageFile/f/5TH_QUICKPATH mode change 100755 => 100644 imageFile/f/5th_boot mode change 100755 => 100644 imageFile/f/5th_demo mode change 100755 => 100644 imageFile/f/5th_eg mode change 100755 => 100644 imageFile/f/5th_et mode change 100755 => 100644 imageFile/f/5th_logo mode change 100755 => 100644 imageFile/f/FNT_SYSTEM mode change 100755 => 100644 imageFile/f/I01_MCARROW mode change 100755 => 100644 imageFile/f/lib/5TH_DRVKBD mode change 100755 => 100644 imageFile/f/lib/5TH_DRVMOUSE mode change 100755 => 100644 imageFile/f/lib/5TH_KBD_US mode change 100755 => 100644 imageFile/f/lib/5TH_KBD_USDVORAK mode change 100755 => 100644 imageFile/f/lib/5TH_UICMD mode change 100755 => 100644 imageFile/f/lib/5th_gfx mode change 100755 => 100644 imageFile/f/lib/5th_gfx2 mode change 100755 => 100644 imageFile/f/lib/5th_trig mode change 100755 => 100644 imageFile/f/txt_eg mode change 100755 => 100644 imageFile/f/txt_et mode change 100755 => 100644 imageFile/f/txt_help diff --git a/imageFile/f/5TH_AUTORUN b/imageFile/f/5TH_AUTORUN old mode 100755 new mode 100644 diff --git a/imageFile/f/5TH_QUICKPATH b/imageFile/f/5TH_QUICKPATH old mode 100755 new mode 100644 diff --git a/imageFile/f/5th_boot b/imageFile/f/5th_boot old mode 100755 new mode 100644 diff --git a/imageFile/f/5th_demo b/imageFile/f/5th_demo old mode 100755 new mode 100644 diff --git a/imageFile/f/5th_eg b/imageFile/f/5th_eg old mode 100755 new mode 100644 diff --git a/imageFile/f/5th_et b/imageFile/f/5th_et old mode 100755 new mode 100644 diff --git a/imageFile/f/5th_logo b/imageFile/f/5th_logo old mode 100755 new mode 100644 diff --git a/imageFile/f/FNT_SYSTEM b/imageFile/f/FNT_SYSTEM old mode 100755 new mode 100644 diff --git a/imageFile/f/I01_MCARROW b/imageFile/f/I01_MCARROW old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5TH_DRVKBD b/imageFile/f/lib/5TH_DRVKBD old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5TH_DRVMOUSE b/imageFile/f/lib/5TH_DRVMOUSE old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5TH_KBD_US b/imageFile/f/lib/5TH_KBD_US old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5TH_KBD_USDVORAK b/imageFile/f/lib/5TH_KBD_USDVORAK old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5TH_UICMD b/imageFile/f/lib/5TH_UICMD old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5th_gfx b/imageFile/f/lib/5th_gfx old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5th_gfx2 b/imageFile/f/lib/5th_gfx2 old mode 100755 new mode 100644 diff --git a/imageFile/f/lib/5th_trig b/imageFile/f/lib/5th_trig old mode 100755 new mode 100644 diff --git a/imageFile/f/txt_eg b/imageFile/f/txt_eg old mode 100755 new mode 100644 diff --git a/imageFile/f/txt_et b/imageFile/f/txt_et old mode 100755 new mode 100644 diff --git a/imageFile/f/txt_help b/imageFile/f/txt_help old mode 100755 new mode 100644 -- 2.20.1 From be12874c4742b31507e81536b80db7de4b800d24 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sun, 17 Apr 2022 18:16:21 +0300 Subject: [PATCH 5/7] Added reference to Bibi-binary --- doc/index.html | 442 +++++++++++++++++++++++++++---------------------- doc/index.org | 71 ++++---- 2 files changed, 281 insertions(+), 232 deletions(-) diff --git a/doc/index.html b/doc/index.html index 430d5a6..107188f 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Fifth - virtual machine, operating system, programming language @@ -40,7 +40,7 @@ } pre.src { position: relative; - overflow: auto; + overflow: visible; padding-top: 1.2em; } pre.src:before { @@ -52,7 +52,7 @@ padding: 3px; border: 1px solid black; } - pre.src:hover:before { display: inline; margin-top: 14px;} + pre.src:hover:before { display: inline;} /* Languages per Org manual */ pre.src-asymptote:before { content: 'Asymptote'; } pre.src-awk:before { content: 'Awk'; } @@ -193,35 +193,52 @@ .org-svg { width: 90%; } /*]]>*/--> - - - - -#+HTML_HEAD: -#+HTML_HEAD: * General - This program is free software: released under Creative Commons Zero (CC0) license @@ -110,14 +101,22 @@ tree similar to this: - Lots of enthusiasm. * Numbers representation within Fifth +Because we are in full experimentation mode here (no regard for +compatibility whatsoever), why not to try also alternative number +representation ? + +Here alternative hexadecimal number representation format is devised: + [[file:numbers.png][file:numbers.png]] -Because I can define everything, starting from CPU, why not try also -alternative and unique number representation ? +Essentially square is split into 4 triangles. Each triangle represents +one bit. + +Fifth uses this hexadecimal format as primary throughout entire +system. + +See also: [[https://en.wikipedia.org/wiki/Bibi-binary][Bibi-binary]]. -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). * Disk file map, and it's data structures 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 @@ -928,24 +927,32 @@ mousedo ( -- ) Updates mouse coordinates and keys. Parse mouse click buffer, and draw mouse cursor to "screen". #+END_VERSE ** 2D graphic library -#+BEGIN_VERSE -lineh ( color len x y imgbuf -- ) draws horisontal line - from X,Y coordinates to right, with specified length. -linev ( color len x y imgbuf -- ) draws vertical line - down, from coordinates X,Y, with specified length. -box ( color x2 x1 y2 y1 imgbuf -- ) draws rectangular - box. x2 bust be >= x1, y2 must be >= y1. - x1,y1-----------+ - | | - | | - +-----------x2,y2 - -flipv ( imgbuf -- ) flip image vertically. -imgcoltrans ( ImgBuf Color ToColor -- ) Translate all pixels in - specified image with "Color" into "ToColor". -imgfill ( color x y imgbuf -- ) Fill image region starting at location - X & Y with specified color. -#+END_VERSE + ++ lineh ( color len x y imgbuf -- ) :: draws horisontal line from X,Y + coordinates to right, with specified length. + ++ linev ( color len x y imgbuf -- ) :: draws vertical line down, from + coordinates X,Y, with specified length. + ++ box ( color x2 x1 y2 y1 imgbuf -- ) :: draws rectangular box. x2 + bust be >= x1, y2 must be >= y1. + + #+begin_example + x1,y1-----------+ + | | + | | + +-----------x2,y2 + #+end_example + ++ flipv ( imgbuf -- ) :: flip image vertically. + ++ imgcoltrans ( ImgBuf Color ToColor -- ) :: Translate all pixels in + specified image with "Color" into "ToColor". + ++ imgfill ( color x y imgbuf -- ) :: Fill image region starting at + location X & Y with specified color. + + ** Trigonometry functions *** sin ( a -- result ) :PROPERTIES: -- 2.20.1 From 0df562d446afbd2094012c8e57fb4144c510c434 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Mon, 18 Sep 2023 01:53:36 +0300 Subject: [PATCH 6/7] Refactored CPU and language descriptions into dedicated pages. --- doc/index.html | 1471 +++--------------------------------- doc/index.org | 701 +---------------- doc/language.html | 919 ++++++++++++++++++++++ doc/language.org | 580 ++++++++++++++ doc/screenshots/index.html | 27 - doc/virtual machine.html | 677 +++++++++++++++++ doc/virtual machine.org | 115 +++ tools/synchronize | 5 +- 8 files changed, 2419 insertions(+), 2076 deletions(-) create mode 100644 doc/language.html create mode 100644 doc/language.org delete mode 100644 doc/screenshots/index.html create mode 100644 doc/virtual machine.html create mode 100644 doc/virtual machine.org diff --git a/doc/index.html b/doc/index.html index 107188f..cadd753 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,14 +3,14 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Fifth - virtual machine, operating system, programming language - - - - + -
    +

    Fifth - virtual machine, operating system, programming language

    -
    +

    Table of Contents

    -
    -
    -
    -

    1 General

    +
    +

    1. General

    -
    -

    1.1 Source code

    + +
    +

    1.1. Source code

    -
    -

    2 !Project deprecated!

    +
    +

    2. !Project deprecated!

    Current implementation does not support object oriented @@ -408,26 +332,24 @@ operating system.

    -
    -

    3 Introduction

    +
    +

    3. Introduction

    -Fifth is programming lanquage & operating system, running on virtual -machine, 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. +Fifth is a combination of:

    -
    -
    -

    3.1 screenshots

    +
    +

    3.1. screenshots

    -
    +

    start.png

    @@ -437,7 +359,7 @@ Startup screen diplaying Fifth logo and full file list.

    -
    +

    dictionary.png

    @@ -450,7 +372,7 @@ they can be selectively compiled or interpreted. -
    +

    text editor.png

    @@ -462,8 +384,8 @@ Built in text editor.
    -
    -

    4 Installation

    +
    +

    4. Installation

    Just unpack all files, witout altering original directory structure, @@ -473,13 +395,13 @@ or EMULATOR.COM ), and virtual disk file ( DISK.RAW ).

    -Read more about Fifth distribution directory tree description. +Read more about Fifth distribution directory tree description.

    -
    -

    5 Fifth distribution directory tree description

    +
    +

    5. Fifth distribution directory tree description

    After downloading and unpacking the ZIP file you shoud get directory @@ -504,12 +426,12 @@ tree similar to this:

    -
    -

    6 Requirements

    +
    +

    6. Requirements

    -
    -

    6.1 Software

    +
    +

    6.1. Software

    • MS-DOS 6.22, with HIMEM.SYS loaded.
      • @@ -521,8 +443,8 @@ tree similar to this:
    -
    -

    6.2 Hardware

    +
    +

    6.2. Hardware

    • Minimum CPU 386.
      • @@ -532,8 +454,8 @@ tree similar to this:
    -
    -

    6.3 Human

    +
    +

    6.3. Human

    • Beginner level Forth knowledge is recommended.
      • @@ -542,8 +464,8 @@ tree similar to this:
    -
    -

    7 Numbers representation within Fifth

    +
    +

    7. Numbers representation within Fifth

    Because we are in full experimentation mode here (no regard for @@ -556,7 +478,7 @@ Here alternative hexadecimal number representation format is devised:

    -
    +

    numbers.png

    @@ -577,8 +499,8 @@ See also: Bibi-binary.
    -
    -

    8 Disk file map, and it's data structures

    +
    +

    8. Disk file map, and it's data structures

    Core and high-level boot code is stored outside of the filesystem to @@ -586,8 +508,8 @@ allow easy access to it, at early booting time, when filesystem is not yet initialized.

    -
    -

    8.1 Disk allocation

    +
    +

    8.1. Disk allocation

    @@ -634,8 +556,8 @@ yet initialized.
    -
    -

    8.2 FAT entry format:

    +
    +

    8.2. FAT entry format:

    @@ -670,8 +592,8 @@ yet initialized.
    -
    -

    8.3 File entry format

    +
    +

    8.3. File entry format

    @@ -725,8 +647,8 @@ yet initialized. -
    -

    9 Core architecture

    +
    +

    9. Core architecture

    Fifth core is simply some amount of already compiled into machine code @@ -739,8 +661,8 @@ dictionary space only. Random word can be removed from dictionary at any time. Currently dictionary can contain at most 1000 entries.

    -
    -

    9.1 Dictionary entry format

    +
    +

    9.1. Dictionary entry format

    @@ -808,8 +730,8 @@ run through headers backwards and find needed entry.

    -
    -

    9.2 Possible module types

    +
    +

    9.2. Possible module types

    @@ -864,8 +786,8 @@ run through headers backwards and find needed entry.
    -
    -

    9.3 Memory map

    +
    +

    9.3. Memory map

    @@ -913,1167 +835,13 @@ run through headers backwards and find needed entry. -
    -

    10 Virtual machine

    +
    +

    10. Dynamically loadable modules

    -

    -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. -

    - -

    -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). -

    - -

    -Maybe one day similar system will run directly on custom silicon chip :) -

    - - -

    -CPU has following registers: -

    -
    - - --- -- - - - - - - - - - - - - - - - - -
    IPinstruction pointer
    DSPdata stack pointer
    RSPreturn stack pointer
    -
    -

    10.1 instruction set

    +
    +

    10.1. Keyboard driver

    -
    -
    -

    10.1.1 overview table

    -
    -

    -Virtual CPU, commands (most of them are avaiable as ordinary commands -in programming language): -

    - - - - - --- -- -- -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    #namestack footprintdescription
    0nop--does nothing
    1halt--halt CPU ( return to DOS on emulator )
    2kbd@– cread scancode of pressed or released key
    3num <dword>– nput immidiate number into datastack
    4jmp <dword>--jump to specified code
    5call <dword> jump to specified code, save return address to return stack
    61+n – n+1 
    71-n – n-1 
    8dupn – n nduplicate top of data stack
    9dropn --drop last element in data stack
    10if <dword>n --jump to addr if top element was 0
    11ret jump to code, specified in return stack.
    12c@addr – nread byte from memory at specified address
    13c!n addr --store byte to specified memory
    14pushDSTK -> RSTKmove top of datastack to returnstack
    15popRSTK -> DSTKmove top of returnstack to datastack
    16<unused>  
    17rotn1 n2 n3 – n2 n3 n1rotate stack elements
    18disk@FromDiskSect ToMem --read 1KB from disk into RAM
    19disk!FromMem ToDiskSect --write 1KB to disk
    20@addr – nread 32 bit number from memory
    21!n addr --store 32 bit number to memory
    22overn1 n2 – n1 n2 n1 
    23swapn1 n2 – n2 n1 
    24+n1 n2 – n1+n2 
    25-n1 n2 – n1-n2 
    26*n1 n2 – n1*n2 
    27/n1 n2 – n1/n2 
    28>n1 n2 – resultis true when n1 > n2
    29<n1 n2 – resultis true when n1 < n2
    30notn1 – not_n1logical not
    31i– ncopies top of return stack into datastack
    32cprt@addr – nread one byte from hardware port
    33cprt!n addr --store one byte to hardware port
    34i2– nlike "i" but takes second top stack element
    35i3– nlike "i" but takes third top stack element.
    36shln amount – nleft bit shift
    37shrn amount – nright bit shift
    38orn1 n2 – nlogical or
    39xorn1 n2 – nexclusive logical or
    40vidmapaddr --copy memory from "addr" to video memory.
    41mouse@– x y buttonread mouse coordinates & buttons
    42vidputaddr1 addr2 x y --put image1 into image2, at location x, y
    43cmoveaddr1 addr2 amountmove memory from addr1 to addr2
    44cfillc addr amount --fill memory starting at "addr" with "c" bytes.
    45tvidputaddr1 addr2 x y --put image with transparency support
    46depth– depthreturns current depth of data stack.
    47charputcolorfg colorbg addrsrc addrdest x ydraw text character
    -
    -
    - -
    -

    10.1.2 kbd@ - read scancode of pressed or released key

    -
    -

    -Returns 0 if no data available. -

    -
    -
    -
    -

    10.1.3 vidput - put image1 into image2, at location x, y

    -
    -

    -Does clipping, so part of a big image can be mapped into smaller one. -

    -
    -
    -
    -

    10.1.4 cmove - copy memory array

    -
    -

    -Move memory from addr1 to addr2. If addr1 is greater than addr2 then -count address foward while moving, elseway starts from end and counts -backwards, so no data loss occurs when memory regions partially -overlap. -

    -
    -
    -
    -

    10.1.5 tvidput - put image with transparency support

    -
    -

    -Stack footprint -

    -
    -addr1 addr2 x y --
-
    - - -

    -Put image1 into image2, at location x, y with transparency support -

    - -

    -Color 255 in source image is treated as transparent. -

    -
    -
    -
    -

    10.1.6 charput - draw text character

    -
    -

    -Draw character to image buffer located at "addrdest" to specified x & -y location. Decodes 8 bytes from source to bits, used to draw -character. -

    -
    -
    -
    -
    - -
    -

    11 Fifth source format

    -
    -

    -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. -

    -
    -
    -

    11.1 FSCII

    -
    - - - --- -- -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    DECHEXfunction
    0 - 150 - FHEX numbers
    252FCbackspace
    253FDtabulator (TAB)
    254FEcarriage return (CR)
    255FFspace
    else ordinary characters, same as in ASCII.
    -
    -
    -
    -
    -

    12 Fifth commands

    -
    -
    -
    -

    12.1 Compilation & miscellaneous

    -
    -

    -init module ( – )
    -                First module, control is passed to on startup. Contains
    -                initialization routines. Also it is the last core module.
    -                All new modules on top of it comes as result of executing
    -                external source files.
    -
    -head <name> ( – ) compiles new dictionary entry without specifying
    -                new module type.
    -                ex: head myentry
    -
    -: <name> ( – ) creates new code module
    -; ( – ) ends module (immideate)
    -                ex: : hello ." hi there" ;
    -
    -const <name> ( n – ) defines new constant.
    -                ex: 2147483647 const max
    -
    -:i <name> ( – ) same as ":" but this module will be executed
    -                immideately even in compile mode.
    -                ex: :i ( 41 scan ;
    -
    -create <name> ( – ) same as "head" , but specify module type as data.
    -                ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 ,
    -
    -allot ( n – ) allocate n bytes in dictionary.
    -                ex: create MyArray 100 allot
    -
    -" <string>" ( – ) compile string and its size into core.
    -                ex: create Mystring " This is it's contects"
    -
    -str <name> <string>" ( – ) just shorter way for defining strings.
    -                ex: str Mystring This is it's contenc"
    -
    -var <name> ( – ) define new 32 bit variable.
    -                ex: var result
    -
    -' <module> ( – n ) return memory address of given entry.
    -                ex: ' init
    -
    -forget <name> ( – ) erases from RAM given entry and all entries what was
    -                defined after it.
    -                ex: forget myprog
    -
    -[ ( – ) set interpret mode (immideate)
    -] ( n – ) set compile mode and compile top stack element
    -                in as literal. Together [ …. ] cobination provides good
    -                way to compute some values only once, at compile time,
    -                rather than every time while program is running.
    -                ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ;
    -
    -defer <name> ( – ) creates new module, with jump instruction.
    -                Later address where to jump can be modified by "is" command.
    -                This provides method of foward referencing. So you can use
    -                modules what not jet exist.
    -is ( address1 address2 – ) address1 - where to jump, address2 -
    -                address of module created by defer command.
    -                ex: defer dispver
    -                        : run dispver ." running …" ;
    -                               … whatever …
    -                        : (dispver ." Version 9.99 " ;
    -                        ' (dispver ' dispver is
    -
    -                Now if I type "run" on the screen appears:
    -                        Version 9.99 running …
    -
    -asc <char> ( – ) reads char ascii code and treats it as literal.
    -                (immideate)
    -                ex: : BreakLine 30 do asc - emit loop ;
    -                                 same as:
    -                    : BreakLine 30 do 45 emit loop ;
    -
    -dyninc ( handle – ) execute code in dynamic memory handle.
    -                automatically deallocates it when done.
    -
    -include ( filenumber – ) execute code in specified file.
    -
    -words ( – ) display existing blocks in core.
    -
    -bye ( – ) exit from Fifth
    -
    -fkey ( – c )
    -                Read one byte from input stream.
    -
    -sadd ( c addr – )
    -                Add one byte "c" to string located at "addr" and updates
    -                string length.
    -
    -scan ( c – )
    -                Read input stream and store it to pad until it finds c .
    -                It ignores all "c" bytes until it finds any non "c" byte.
    -                in other words:
    -                                c is: "
    -                         input stream: """"This is test !"aoeu idh
    -                               result: This is test !
    -
    -                Is useful for breaking text lines into words.
    -
    -skey ( – c )
    -                So called safe "fkey". Reads data from input stream
    -                but converts characters with ASCII codes: 9 13 10
    -                to spaces.
    -
    -str=str? ( adr1 adr2 – result )
    -                Compares string at "adr1" with string at "adr2", returns
    -                true flag if they are equal or false if they are not.
    -                true = -1
    -                false = 0
    -
    -find ( – addr )
    -                Searches whole dictionary for word in "pad". If found,
    -                returns it address, if not, returns 0.
    -
    -execute ( – )
    -                Execute word located in "pad". Depending on "mode".
    -
    -dta ( addr – DataAddr )
    -                Calculates address of dictionary entry data area, from
    -                entry point.
    -
    -2num ( – num result )
    -                Attempt to convert string located in "pad" into numeric
    -                value. If succeed returns number and true as result.
    -                If not, returns whatever and false as result.
    -
    -dadd ( addr length – )
    -                Add to dictionary data located at "addr", with specified
    -                length.
    -
    -lit ( n – )
    -                Act with number depending on "mode". When interpreting,
    -                leaves it in stack.
    -
    -
    -incmod ( addr – )
    -                Add to dictionary data located at "addr"+1 , length is taken
    -                from "addr".
    -
    -here ( – n )
    -                return "h" contents.
    -
    -mode var 8 bit
    -                Holds input stream parser operation mode.
    -                0 = interpreting
    -                1 = compiling
    -
    -pad var 128 bytes
    -                Holds temprorary strings.
    -
    -h var 32 bit
    -                Pointer to free byte in memory, always at the end of the
    -                dictionary. Each time when something is stored
    -                by "c," command, pointer is incareased.
    -
    -lp var 32 bit
    -                Pointer to last dictionary word. Each time when new word is
    -                compiled or erased by "forget", this pointer is updated.
    -
    -modulechk ( Dstr<filename> – ) check if module is loaded, if not
    -                immideately load it.
    -
    -ne ( entrydata entrytype – ) Compile new dictionary entry.
    -                It's name must be in "pad".
    -

    -
    -
    -
    -

    12.2 Conditionals & control flow

    -
    -

    -if ( flag – ) (immideate)
    -                "if 1.. else 2.. then" or
    -                "if 1.. then" construction. Conditional execution.
    -                Performs "1.." if "flag" was true,
    -                elseway performs "2.." if exist. Execution continues after
    -                word "then".
    -                ex: 1 if ." nonzero" else ." zero" then
    -
    ->= ( n1 n2 – result ) true if (n1 = n2) or (n1 > n2)
    -                ex: 5 3 >= if ." first number is greater or equal" then
    -
    -<= ( n1 n2 – result ) true if (n1 = n2) or (n1 < n2)
    -= ( n1 n2 – result ) true if n1 = n2
    -
    -do ( count – ) (immideate)
    -                "do .. loop" construction. Performs ".." "count" times.
    -                In every step "count" is decareased until it is 0.
    -                ex: : test 5 do i .d loop ;
    -                result: 4 3 2 1 0
    -
    -doexit ( – ) exit from "do .. loop"
    -
    -for ( count top – ) (immideate)
    -                "for .. loop" construction. Performs ".." (top - count) times.
    -                In every step "count" is incareased until it reaches "top" .
    -                ex: : test 4 10 for i .d loop ;
    -                result: 4 5 6 7 8 9
    -
    -forexit ( – ) exit from "for .. loop"
    -
    -until ( – ) (immideate)
    -                "until .. loop" construction. Performs ".." until flag become
    -                true. False by default. Top of return stack holds flag.
    -
    -done ( – ) exit from "until .. loop"
    -
    -

    -
    -
    -
    -

    12.3 Disk & file access

    -
    -

    -diskload ( FromDisk ToMem amount – )
    -                Load specified abount of bytes from disk into memory.
    -
    -disksave ( FromMem ToDisk amount – )
    -                save specified abount of bytes from memory into disk.
    -
    -format ( – ) Erase all files.
    -
    -fsDfilesize@ ( handle – size )
    -                Return size of opened file.
    -
    -fsDcurloc@ ( handle – location )
    -                Return current location in file.
    -
    -fsDupdated@ ( handle – updated? )
    -                Return true if file was updated,
    -                ie. write operations occured.
    -
    -fssave ( FromMem DestFileHandle amount – )
    -                Save data to file.
    -
    -fsload ( SrcFileHandle ToMem amount – )
    -                Load data from file.
    -
    -fseof ( handle – bytesLeft )
    -                Return amount of bytes left till end of file.
    -                Useful before read operation.
    -
    -fsls ( – ) List all files and lists (directories,folders)
    -                in current path.
    -
    -fslsr ( – ) Same as "fsls" but recursively scans also sub lists.
    -
    -fscl ( DynStrHand – )
    -                Change list (path)
    -
    -fscreate ( DynStrHand – DescPnt )
    -                Create new file or list. Can create multiple lists at once.
    -                ex: when creating:
    -                    "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme"
    -                and only "\listGAMES\" already exist, then
    -                "listSTRATEGY" and "listSIMWORLD" lists will be created,
    -                and empty file "5th-runme" placed in there.
    -
    -fsDsave ( DynHand<data> DynStrHand<filename> – )
    -                Create new file and save all data from dynamic memory
    -                block to it.
    -
    -fsDload ( DynStr<SrcFileName> DynHand<DataDest> – )
    -                Load whole file into dynamic memory block.
    -
    -fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )
    -                Load whole file into new dynamic memory block.
    -

    -
    -
    -
    -

    12.4 Dynamic memory

    -
    -

    -dynal ( size – handle )
    -                Allocate dynamic memory block and return it's handle.
    -
    -dynde ( handle – )
    -                Deallocate dynamic memory block.
    -
    -dynp ( handle – addr )
    -                Returns pointer to memory where dynamic block
    -                data begins.
    -
    -dyns ( handle – size )
    -                Returns size of dynamic block.
    -
    -dynresize ( NewSize handle – )
    -                Nondestructively resize dynamic block.
    -
    -dync@ ( addr handle )
    -                Read one byte from dynamic block.
    -
    -dync! ( byte addr dynhandle )
    -                Write one byte to dynamic block.
    -
    -dyn@ ( addr handle )
    -                Read 32 bit number from dynamic block.
    -                Address will spacify, whitch number, not byte.
    -
    -dyn! ( 32BitNum addr dynhandle )
    -                Write 32 bit number to dynamic block.
    -                Address will spacify, whitch number, not byte.
    -
    -dyncon ( size "name" – )
    -                Allocate dynamic block with specified size, and
    -                create constant honding its handle.
    -                ex: 100 dyncon MyNewBlock
    -
    -dyn. ( handle – )
    -                Write contenc of dynamic memory block to screen.
    -

    -
    -
    -
    -

    12.5 Graphics and text

    -
    -

    -. ( n – ) print number on screen
    -
    -d. ( n – ) print number on screen in decimal
    -
    -? ( addr – ) print 32 bit value located at addr.
    -
    -." <string>" ( – ) print string into screen. Immideately
    -                compiles.
    -                ex: : greeting ." Hello, World" ;
    -
    -tab. ( – ) print tabulator
    -
    -calccol ( b g r – c ) calculate color what best matches given
    -                Blue Green & Red values. Values must be in range 0 - 255.
    -
    -imgalloc ( xsize ysize – imgbuf ) allocate image buffer for
    -                specified size.
    -
    -imgsize ( imgbuf – ) print on the screen X & Y size of image
    -                buffer.
    -
    -point ( x y imgbuf – addr ) returns memory address for specified
    -                pixel.
    -
    -pset ( color x y imgbuf – ) set graphic point
    -
    -boxf ( x1 x2 y1 y2 imgbuf color – ) draw filled box
    -
    -cls ( imgbuf – ) clear image buffer
    -
    -setpal ( b g r color – ) set palette value for specified color.
    -                values bust be in size 0 - 63.
    -
    -putchar ( char color x y imgbuf – ) put graphic character in
    -                imagebuffer to specified (x & y) location.
    -
    -scroll ( x y imgbuf – ) scroll in imgbuf.
    -
    -scrollf ( color x y screen – ) scroll and fill empty space with
    -                given color.
    -
    -at! ( x y – ) set cursor location
    -curc! ( color – ) set text color
    -curb! ( solor – ) set backround color
    -
    -colnorm ( – ) set text color to normal
    -colneg ( – ) set text color to negative (selected)
    -
    -dyntype ( dynhandle – ) display contenc of dynamic memory on screen
    -fsdisp ( file – ) clear screen, display file, and wait for key
    -
    -type ( addr length – )
    -                Types on the screen string, from memory at addr and
    -                specified length.
    -
    -write ( addr – )
    -                Types on the screen string, from memory at "addr"+1
    -                length is taken from "addr" .
    -
    -screen const 32 bit
    -                Holds handle of screen buffer.
    -
    -copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source
    -                image to destination image. Source and destination images
    -                must have same size.
    -

    -
    -
    -
    -

    12.6 Math, memory & stack manipulation

    -
    -

    -off ( n – ) writes 0 to given address, good for zeroing variable.
    -                ex: MyVariable off
    -on ( n – ) writes -1 (true flag) to given address.
    -                ex: MyVariable on
    -
    -2dup ( n1 n2 – n1 n2 n1 n2 )
    -2drop ( n1 n2 – )
    -nip ( n1 n2 – n2 )
    -neg ( n1 – -n1 ) negotiate
    -bit@ ( n bit – result ) return specified bit from n.
    -                ex: 38 2 bit@ (result will be 1)
    -to32bit ( n1 n2 n3 n4 – n32 ) treat 4 last stack elements as bytes
    -                and unite them into 32 bit dword. Most significant byte
    -                on top.
    -                ex: 12 76 23 11 to32bit result: 186076172
    -
    -to8bit ( n32 – n1 n2 n3 n4 ) break 32 bit number into 4 bytes.
    -                Useful if you need to send 32 bit numbers thru 8 bit COM
    -                port.
    -                ex: 186076172 to8bit result: 12 76 23 11
    -
    -mod ( n1 n2 – reminder ) divide n1 by n2 and returns reminder.
    -                ex: 12 5 mod result: 2
    -
    -bound ( low n high – n ) check if n is in given bounds,
    -                if not then incarease/decarease it to match bounds.
    -                ex: 5 80 15 bound result: 15
    -                    5 10 15 bound result: 10
    -                    5 -10 15 bound result: 5
    -
    -bound? ( low n high – result ) returns true if n is in the
    -                given bounds.
    -
    -tab ( col – spaces) calculate amount of spaces to add
    -                ta reach next tabulation from given column.
    -
    -count ( addr – addr+1 n )
    -                Useful for returning bytes from constantly incareasing
    -                address. Module "type" is nice example.
    -
    -c, ( n – )
    -                store one byte at memory specified by "h". And incarease
    -                "h" by 1.
    -
    -, ( n – )
    -                store 32 bit number at memory specified by "h". And
    -                incarease "h" by 4.
    -
    -cmove ( addr1 addr2 n – )
    -                copy "n" amount of bytes from memory at "addr1" to memory
    -                at "addr2".
    -
    -rnd ( limit – result )
    -                generates random number in range 0 to "limit"-1.
    -
    -abs ( n – |n| )
    -                returns absolute value of "n"
    -

    -
    -
    -
    -

    12.7 Dynamic & static strings

    -
    -

    -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. -

    - -

    -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. -

    - -

    -Both types of strings are stored in the way, where first (0th) byte -holds current string length, following bytes are string itself. -

    - - -

    -Dynamic:
    -
    -Dstral ( – handle )
    -                Allocate new string.
    -
    -Dstrlen ( handle – length )
    -                Return string length.
    -
    -c+Dstr ( chr handle – )
    -                Add one byte to end of the string.
    -
    -c+lDstr ( chr handle – )
    -                Add one byte to left side (beginning) of the string.
    -
    -Dstr. ( handle – )
    -                Write contec of string into screen.
    -
    -Dstrsure ( size Dstr – )
    -                Makes sure that at least rquested
    -                "size" (amount of characters) is allocated for given
    -                dynamic string.
    -
    -Dstr2str ( handle address – )
    -                Copy dyamic string into static memory space.
    -
    -str2Dstr ( address handle – )
    -                Copy static string into dyamic string.
    -
    -Dstr+str ( Dstr addr – )
    -                Add contenc of dynamic string to static string.
    -
    -D" any string" ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr".
    -
    -D> any_string ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr".
    -                Space marks end of string!
    -
    -D>2 any_string ( – Dstr )
    -                Moves specified string into dynamic string called "defDstr2".
    -                Space marks end of string!
    -
    -Dstr+Dstr ( Dstr1 Dstr2 – )
    -                Adds "Dstr1" to "Dstr2" and places result into "Dstr2".
    -
    -Dstrclear ( Dstr – )
    -                Clears contenc of dynamic string.
    -
    -Dstr2Dstr ( Dstr1 Dstr2 – )
    -                Moves "Dstr1" to "Dstr2".
    -Dstr ( data" name – )
    -                Creates new dynamic string and moves specified data into it.
    -                Then creates new constant with given "name" holding created
    -                dynamic string handle.
    -
    -                ex: Dstr Hello, my name is Sven!" message \ creates it
    -                    message Dstr. \ tests it
    -
    -Dstrlscan ( char Dstr – loc )
    -                Searches dynamic string for "char", from left to right,
    -                returns first found "char" location in string, or 0,
    -                if not found.
    -
    -Dstrrscan ( char Dstr – loc )
    -                Searches dynamic string for "char", from right to left,
    -                returns first found "char" location in string, or 0,
    -                if not found.
    -
    -Dstrlscane ( char Dstr – loc )
    -                Same as "Dstrlscan" buf returns string length+1 as location.
    -ÿ
    -Dstrleft ( amo Dstr – )
    -                Only specified amount of characters from left remains
    -                in dynamic string. ie. cut right part out.
    -
    -Dstrright ( amo Dstr – )
    -                Only specified amount of characters from right remains
    -                in dynamic string. ie. cut left part out.
    -
    -Dstrcutl ( amo Dstr – )
    -                Cut specified amount of characters from left of dynamic
    -                string out.
    -
    -Dstrsp ( char Dstr1 Dstr2 – )
    -                Separate dynamic string in Dstr1 into two parts,
    -                using "char" as separator. First part will be stored in
    -                "Dstr2", second part in "Dstr1".
    -                ex: asc \ \ ..separator
    -                    D> listF\listLIB\5TH_DRVMOUSE \ ..separate from
    -                    defDstr2 \ ..place result in
    -                    Dstrsp \ separation command
    -                    defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE
    -                    defDstr2 Dstr. \ will be: listF
    -
    -Dv ( addr – )
    -                Allocates empty dynamic string, and places it's handle
    -                into given address.
    -
    -Df ( addr – )
    -                Reads dynamic string handle from given address and
    -                deallocates (frees) it.
    -
    -ex: var mystring1
    -        : testmodule
    -        mystring1 Dv \ allocates string
    -
    -                <whatever>
    -
    -        mystring1 Df ; \ deallocates it again when no longer needed.
    -

    -
    -
    -
    -
    -

    13 Dynamically loadable modules

    -
    -
    -
    -

    13.1 Keyboard driver

    -


    KBD_@ ( – code ) get scancodes for pressed keys from keyboard.
    @@ -2110,9 +878,9 @@ FF space

    -
    -

    13.2 Mouse driver

    -
    +
    +

    10.2. Mouse driver

    +

    mousex var Mouse x coordinate.
    mousey var Mouse y coordinate.
    @@ -2131,9 +899,9 @@ mousedo ( – ) Updates mouse coordinates and keys. Parse mouse

    -
    -

    13.3 2D graphic library

    -
    +
    +

    10.3. 2D graphic library

    +
    lineh ( color len x y imgbuf – )
    draws horisontal line from X,Y coordinates to right, with specified length.
    @@ -2146,7 +914,7 @@ draws rectangular box. x2 bust be >= x1, y2 must be >= y1.

    -
    +
     x1,y1-----------+
   |             |
   |             |
@@ -2164,25 +932,24 @@ location X & Y with specified color.
    - -
    -

    13.4 Trigonometry functions

    -
    +
    +

    10.4. Trigonometry functions

    +
    -
    -

    13.4.1 sin ( a – result )

    -
    +
    +

    10.4.1. sin ( a – result )

    +

    Return sinus from given angle "a", 360ø is 2000. So 1000 represents 180ø angle. Result will be in range -10'000 to 10'000, instead of ñ1.

    -
    -

    13.4.2 cos ( a – result )

    -
    +
    +

    10.4.2. cos ( a – result )

    +

    -Return cosinus from given angle. Parameters are like in sin function. +Return cosinus from given angle. Parameters are like in sin function.

    @@ -2191,8 +958,8 @@ Return cosinus from given angle. Parameters are like in s
    diff --git a/doc/index.org b/doc/index.org index 6303947..4d9c4a0 100644 --- a/doc/index.org +++ b/doc/index.org @@ -10,6 +10,7 @@ - Email: mailto://svjatoslav@svjatoslav.eu - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]] + ** Source code - [[https://www2.svjatoslav.eu/gitweb/?p=fifth.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] @@ -29,12 +30,10 @@ Currently I try to implement those new ideas in the project called System is built many years ago when I was still using DOS as a primary operating system. * Introduction -Fifth is programming lanquage & operating system, running on [[id:9b251eb9-aff6-4025-94bf-25e89e26d54a][virtual -machine]], 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. - +Fifth is a combination of: +- [[id:da7fff9b-0b67-4843-828a-52a404d7f401][Programming language]] (inspired by Forth). +- Operating system. +- [[id:9b251eb9-aff6-4025-94bf-25e89e26d54a][Virtual machine]] with custom instruction set. - [[file:5TH_ET.txt][Example Fifth source file - text editor]] ** screenshots [[file:screenshots/start.png]] @@ -184,695 +183,6 @@ run through headers backwards and find needed entry. | 1500000 | ~32000 | highlevel Fifth boot code | | 200000h | | core startup messages area | | 5200000 | | end of dynamic memory space | -* Virtual machine -:PROPERTIES: -:ID: 9b251eb9-aff6-4025-94bf-25e89e26d54a -:END: -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. - -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). - -Maybe one day similar system will run directly on custom silicon chip :) - - -CPU has following registers: -| IP | instruction pointer | -| DSP | data stack pointer | -| RSP | return stack pointer | -** instruction set -*** overview table -Virtual CPU, commands (most of them are avaiable as ordinary commands -in programming language): - - -| # | name | stack footprint | description | -|----+--------------+--------------------------------------+-------------------------------------------------------------| -| 0 | nop | -- | does nothing | -| 1 | halt | -- | halt CPU ( return to DOS on emulator ) | -| 2 | [[id:820b1b90-4f4c-4ab1-b49f-9b4a52ea2528][kbd@]] | -- c | read scancode of pressed or released key | -| 3 | num | -- n | put immidiate number into datastack | -| 4 | jmp | -- | jump to specified code | -| 5 | call | | jump to specified code, save return address to return stack | -| 6 | 1+ | n -- n+1 | | -| 7 | 1- | n -- n-1 | | -| 8 | dup | n -- n n | duplicate top of data stack | -| 9 | drop | n -- | drop last element in data stack | -| 10 | if | n -- | jump to addr if top element was 0 | -| 11 | ret | | jump to code, specified in return stack. | -| 12 | c@ | addr -- n | read byte from memory at specified address | -| 13 | c! | n addr -- | store byte to specified memory | -| 14 | push | DSTK -> RSTK | move top of datastack to returnstack | -| 15 | pop | RSTK -> DSTK | move top of returnstack to datastack | -| 16 | | | | -| 17 | rot | n1 n2 n3 -- n2 n3 n1 | rotate stack elements | -| 18 | disk@ | FromDiskSect ToMem -- | read 1KB from disk into RAM | -| 19 | disk! | FromMem ToDiskSect -- | write 1KB to disk | -| 20 | @ | addr -- n | read 32 bit number from memory | -| 21 | ! | n addr -- | store 32 bit number to memory | -| 22 | over | n1 n2 -- n1 n2 n1 | | -| 23 | swap | n1 n2 -- n2 n1 | | -| 24 | + | n1 n2 -- n1+n2 | | -| 25 | - | n1 n2 -- n1-n2 | | -| 26 | * | n1 n2 -- n1*n2 | | -| 27 | / | n1 n2 -- n1/n2 | | -| 28 | > | n1 n2 -- result | is true when n1 > n2 | -| 29 | < | n1 n2 -- result | is true when n1 < n2 | -| 30 | not | n1 -- not_n1 | logical not | -| 31 | i | -- n | copies top of return stack into datastack | -| 32 | cprt@ | addr -- n | read one byte from hardware port | -| 33 | cprt! | n addr -- | store one byte to hardware port | -| 34 | i2 | -- n | like "i" but takes second top stack element | -| 35 | i3 | -- n | like "i" but takes third top stack element. | -| 36 | shl | n amount -- n | left bit shift | -| 37 | shr | n amount -- n | right bit shift | -| 38 | or | n1 n2 -- n | logical or | -| 39 | xor | n1 n2 -- n | exclusive logical or | -| 40 | vidmap | addr -- | copy memory from "addr" to video memory. | -| 41 | mouse@ | -- x y button | read mouse coordinates & buttons | -| 42 | [[id:238e8b03-57b6-424d-bfee-b6bb652cefbc][vidput]] | addr1 addr2 x y -- | put image1 into image2, at location x, y | -| 43 | [[id:79e1916f-4103-42cc-ac10-bb1ee776ed50][cmove]] | addr1 addr2 amount | move memory from addr1 to addr2 | -| 44 | cfill | c addr amount -- | fill memory starting at "addr" with "c" bytes. | -| 45 | [[id:ab45247c-44c3-464d-9e2a-337f483b4616][tvidput]] | addr1 addr2 x y -- | put image with transparency support | -| 46 | depth | -- depth | returns current depth of data stack. | -| 47 | [[id:4bb479cf-aae0-4128-9868-f016c286a162][charput]] | colorfg colorbg addrsrc addrdest x y | draw text character | - -*** kbd@ - read scancode of pressed or released key -:PROPERTIES: -:ID: 820b1b90-4f4c-4ab1-b49f-9b4a52ea2528 -:END: -Returns 0 if no data available. -*** vidput - put image1 into image2, at location x, y -:PROPERTIES: -:ID: 238e8b03-57b6-424d-bfee-b6bb652cefbc -:END: -Does clipping, so part of a big image can be mapped into smaller one. -*** cmove - copy memory array -:PROPERTIES: -:ID: 79e1916f-4103-42cc-ac10-bb1ee776ed50 -:END: -Move memory from addr1 to addr2. If addr1 is greater than addr2 then -count address foward while moving, elseway starts from end and counts -backwards, so no data loss occurs when memory regions partially -overlap. -*** tvidput - put image with transparency support -:PROPERTIES: -:ID: ab45247c-44c3-464d-9e2a-337f483b4616 -:END: -Stack footprint -: addr1 addr2 x y -- - -Put image1 into image2, at location x, y with transparency support - -Color 255 in source image is treated as transparent. -*** charput - draw text character -:PROPERTIES: -:ID: 4bb479cf-aae0-4128-9868-f016c286a162 -:END: -Draw character to image buffer located at "addrdest" to specified x & -y location. Decodes 8 bytes from source to bits, used to draw -character. - -* Fifth source format -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. -** FSCII - -| DEC | HEX | function | -|--------+-------+----------------------------------------| -| 0 - 15 | 0 - F | HEX numbers | -| 252 | FC | backspace | -| 253 | FD | tabulator (TAB) | -| 254 | FE | carriage return (CR) | -| 255 | FF | space | -| else | | ordinary characters, same as in ASCII. | -* Fifth commands -** Compilation & miscellaneous -#+BEGIN_VERSE -init module ( -- ) - First module, control is passed to on startup. Contains - initialization routines. Also it is the last core module. - All new modules on top of it comes as result of executing - external source files. - -head ( -- ) compiles new dictionary entry without specifying - new module type. - ex: head myentry - -: ( -- ) creates new code module -; ( -- ) ends module (immideate) - ex: : hello ." hi there" ; - -const ( n -- ) defines new constant. - ex: 2147483647 const max - -:i ( -- ) same as ":" but this module will be executed - immideately even in compile mode. - ex: :i ( 41 scan ; - -create ( -- ) same as "head" , but specify module type as data. - ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 , - -allot ( n -- ) allocate n bytes in dictionary. - ex: create MyArray 100 allot - -" " ( -- ) compile string and its size into core. - ex: create Mystring " This is it's contects" - -str " ( -- ) just shorter way for defining strings. - ex: str Mystring This is it's contenc" - -var ( -- ) define new 32 bit variable. - ex: var result - -' ( -- n ) return memory address of given entry. - ex: ' init - -forget ( -- ) erases from RAM given entry and all entries what was - defined after it. - ex: forget myprog - -[ ( -- ) set interpret mode (immideate) -] ( n -- ) set compile mode and compile top stack element - in as literal. Together [ .... ] cobination provides good - way to compute some values only once, at compile time, - rather than every time while program is running. - ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ; - -defer ( -- ) creates new module, with jump instruction. - Later address where to jump can be modified by "is" command. - This provides method of foward referencing. So you can use - modules what not jet exist. -is ( address1 address2 -- ) address1 - where to jump, address2 - - address of module created by defer command. - ex: defer dispver - : run dispver ." running ..." ; - ... whatever ... - : (dispver ." Version 9.99 " ; - ' (dispver ' dispver is - - Now if I type "run" on the screen appears: - Version 9.99 running ... - -asc ( -- ) reads char ascii code and treats it as literal. - (immideate) - ex: : BreakLine 30 do asc - emit loop ; - same as: - : BreakLine 30 do 45 emit loop ; - -dyninc ( handle -- ) execute code in dynamic memory handle. - automatically deallocates it when done. - -include ( filenumber -- ) execute code in specified file. - -words ( -- ) display existing blocks in core. - -bye ( -- ) exit from Fifth - -fkey ( -- c ) - Read one byte from input stream. - -sadd ( c addr -- ) - Add one byte "c" to string located at "addr" and updates - string length. - -scan ( c -- ) - Read input stream and store it to pad until it finds c . - It ignores all "c" bytes until it finds any non "c" byte. - in other words: - c is: " - input stream: """"This is test !"aoeu idh - result: This is test ! - - Is useful for breaking text lines into words. - -skey ( -- c ) - So called safe "fkey". Reads data from input stream - but converts characters with ASCII codes: 9 13 10 - to spaces. - -str=str? ( adr1 adr2 -- result ) - Compares string at "adr1" with string at "adr2", returns - true flag if they are equal or false if they are not. - true = -1 - false = 0 - -find ( -- addr ) - Searches whole dictionary for word in "pad". If found, - returns it address, if not, returns 0. - -execute ( -- ) - Execute word located in "pad". Depending on "mode". - -dta ( addr -- DataAddr ) - Calculates address of dictionary entry data area, from - entry point. - -2num ( -- num result ) - Attempt to convert string located in "pad" into numeric - value. If succeed returns number and true as result. - If not, returns whatever and false as result. - -dadd ( addr length -- ) - Add to dictionary data located at "addr", with specified - length. - -lit ( n -- ) - Act with number depending on "mode". When interpreting, - leaves it in stack. - - -incmod ( addr -- ) - Add to dictionary data located at "addr"+1 , length is taken - from "addr". - -here ( -- n ) - return "h" contents. - -mode var 8 bit - Holds input stream parser operation mode. - 0 = interpreting - 1 = compiling - -pad var 128 bytes - Holds temprorary strings. - -h var 32 bit - Pointer to free byte in memory, always at the end of the - dictionary. Each time when something is stored - by "c," command, pointer is incareased. - -lp var 32 bit - Pointer to last dictionary word. Each time when new word is - compiled or erased by "forget", this pointer is updated. - -modulechk ( Dstr -- ) check if module is loaded, if not - immideately load it. - -ne ( entrydata entrytype -- ) Compile new dictionary entry. - It's name must be in "pad". -#+END_VERSE -** Conditionals & control flow -#+BEGIN_VERSE -if ( flag -- ) (immideate) - "if 1.. else 2.. then" or - "if 1.. then" construction. Conditional execution. - Performs "1.." if "flag" was true, - elseway performs "2.." if exist. Execution continues after - word "then". - ex: 1 if ." nonzero" else ." zero" then - ->= ( n1 n2 -- result ) true if (n1 = n2) or (n1 > n2) - ex: 5 3 >= if ." first number is greater or equal" then - -<= ( n1 n2 -- result ) true if (n1 = n2) or (n1 < n2) -= ( n1 n2 -- result ) true if n1 = n2 - -do ( count -- ) (immideate) - "do .. loop" construction. Performs ".." "count" times. - In every step "count" is decareased until it is 0. - ex: : test 5 do i .d loop ; - result: 4 3 2 1 0 - -doexit ( -- ) exit from "do .. loop" - -for ( count top -- ) (immideate) - "for .. loop" construction. Performs ".." (top - count) times. - In every step "count" is incareased until it reaches "top" . - ex: : test 4 10 for i .d loop ; - result: 4 5 6 7 8 9 - -forexit ( -- ) exit from "for .. loop" - -until ( -- ) (immideate) - "until .. loop" construction. Performs ".." until flag become - true. False by default. Top of return stack holds flag. - -done ( -- ) exit from "until .. loop" - -#+END_VERSE -** Disk & file access -#+BEGIN_VERSE -diskload ( FromDisk ToMem amount -- ) - Load specified abount of bytes from disk into memory. - -disksave ( FromMem ToDisk amount -- ) - save specified abount of bytes from memory into disk. - -format ( -- ) Erase all files. - -fsDfilesize@ ( handle -- size ) - Return size of opened file. - -fsDcurloc@ ( handle -- location ) - Return current location in file. - -fsDupdated@ ( handle -- updated? ) - Return true if file was updated, - ie. write operations occured. - -fssave ( FromMem DestFileHandle amount -- ) - Save data to file. - -fsload ( SrcFileHandle ToMem amount -- ) - Load data from file. - -fseof ( handle -- bytesLeft ) - Return amount of bytes left till end of file. - Useful before read operation. - -fsls ( -- ) List all files and lists (directories,folders) - in current path. - -fslsr ( -- ) Same as "fsls" but recursively scans also sub lists. - -fscl ( DynStrHand -- ) - Change list (path) - -fscreate ( DynStrHand -- DescPnt ) - Create new file or list. Can create multiple lists at once. - ex: when creating: - "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme" - and only "\listGAMES\" already exist, then - "listSTRATEGY" and "listSIMWORLD" lists will be created, - and empty file "5th-runme" placed in there. - -fsDsave ( DynHand DynStrHand -- ) - Create new file and save all data from dynamic memory - block to it. - -fsDload ( DynStr DynHand -- ) - Load whole file into dynamic memory block. - -fsDloadnew ( DynStr -- DynHand ) - Load whole file into new dynamic memory block. -#+END_VERSE -** Dynamic memory -#+BEGIN_VERSE -dynal ( size -- handle ) - Allocate dynamic memory block and return it's handle. - -dynde ( handle -- ) - Deallocate dynamic memory block. - -dynp ( handle -- addr ) - Returns pointer to memory where dynamic block - data begins. - -dyns ( handle -- size ) - Returns size of dynamic block. - -dynresize ( NewSize handle -- ) - Nondestructively resize dynamic block. - -dync@ ( addr handle ) - Read one byte from dynamic block. - -dync! ( byte addr dynhandle ) - Write one byte to dynamic block. - -dyn@ ( addr handle ) - Read 32 bit number from dynamic block. - Address will spacify, whitch number, not byte. - -dyn! ( 32BitNum addr dynhandle ) - Write 32 bit number to dynamic block. - Address will spacify, whitch number, not byte. - -dyncon ( size "name" -- ) - Allocate dynamic block with specified size, and - create constant honding its handle. - ex: 100 dyncon MyNewBlock - -dyn. ( handle -- ) - Write contenc of dynamic memory block to screen. -#+END_VERSE -** Graphics and text -#+BEGIN_VERSE -. ( n -- ) print number on screen - -d. ( n -- ) print number on screen in decimal - -? ( addr -- ) print 32 bit value located at addr. - -." " ( -- ) print string into screen. Immideately - compiles. - ex: : greeting ." Hello, World" ; - -tab. ( -- ) print tabulator - -calccol ( b g r -- c ) calculate color what best matches given - Blue Green & Red values. Values must be in range 0 - 255. - -imgalloc ( xsize ysize -- imgbuf ) allocate image buffer for - specified size. - -imgsize ( imgbuf -- ) print on the screen X & Y size of image - buffer. - -point ( x y imgbuf -- addr ) returns memory address for specified - pixel. - -pset ( color x y imgbuf -- ) set graphic point - -boxf ( x1 x2 y1 y2 imgbuf color -- ) draw filled box - -cls ( imgbuf -- ) clear image buffer - -setpal ( b g r color -- ) set palette value for specified color. - values bust be in size 0 - 63. - -putchar ( char color x y imgbuf -- ) put graphic character in - imagebuffer to specified (x & y) location. - -scroll ( x y imgbuf -- ) scroll in imgbuf. - -scrollf ( color x y screen -- ) scroll and fill empty space with - given color. - -at! ( x y -- ) set cursor location -curc! ( color -- ) set text color -curb! ( solor -- ) set backround color - -colnorm ( -- ) set text color to normal -colneg ( -- ) set text color to negative (selected) - -dyntype ( dynhandle -- ) display contenc of dynamic memory on screen -fsdisp ( file -- ) clear screen, display file, and wait for key - -type ( addr length -- ) - Types on the screen string, from memory at addr and - specified length. - -write ( addr -- ) - Types on the screen string, from memory at "addr"+1 - length is taken from "addr" . - -screen const 32 bit - Holds handle of screen buffer. - -copyscreen ( SrcImgHandle DestImgHandle -- ) copy contenc of source - image to destination image. Source and destination images - must have same size. -#+END_VERSE -** Math, memory & stack manipulation -#+BEGIN_VERSE -off ( n -- ) writes 0 to given address, good for zeroing variable. - ex: MyVariable off -on ( n -- ) writes -1 (true flag) to given address. - ex: MyVariable on - -2dup ( n1 n2 -- n1 n2 n1 n2 ) -2drop ( n1 n2 -- ) -nip ( n1 n2 -- n2 ) -neg ( n1 -- -n1 ) negotiate -bit@ ( n bit -- result ) return specified bit from n. - ex: 38 2 bit@ (result will be 1) -to32bit ( n1 n2 n3 n4 -- n32 ) treat 4 last stack elements as bytes - and unite them into 32 bit dword. Most significant byte - on top. - ex: 12 76 23 11 to32bit result: 186076172 - -to8bit ( n32 -- n1 n2 n3 n4 ) break 32 bit number into 4 bytes. - Useful if you need to send 32 bit numbers thru 8 bit COM - port. - ex: 186076172 to8bit result: 12 76 23 11 - -mod ( n1 n2 -- reminder ) divide n1 by n2 and returns reminder. - ex: 12 5 mod result: 2 - -bound ( low n high -- n ) check if n is in given bounds, - if not then incarease/decarease it to match bounds. - ex: 5 80 15 bound result: 15 - 5 10 15 bound result: 10 - 5 -10 15 bound result: 5 - -bound? ( low n high -- result ) returns true if n is in the - given bounds. - -tab ( col -- spaces) calculate amount of spaces to add - ta reach next tabulation from given column. - -count ( addr -- addr+1 n ) - Useful for returning bytes from constantly incareasing - address. Module "type" is nice example. - -c, ( n -- ) - store one byte at memory specified by "h". And incarease - "h" by 1. - -, ( n -- ) - store 32 bit number at memory specified by "h". And - incarease "h" by 4. - -cmove ( addr1 addr2 n -- ) - copy "n" amount of bytes from memory at "addr1" to memory - at "addr2". - -rnd ( limit -- result ) - generates random number in range 0 to "limit"-1. - -abs ( n -- |n| ) - returns absolute value of "n" -#+END_VERSE -** Dynamic & static strings -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. - -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. - -Both types of strings are stored in the way, where first (0th) byte -holds current string length, following bytes are string itself. - - -#+BEGIN_VERSE -Dynamic: - -Dstral ( -- handle ) - Allocate new string. - -Dstrlen ( handle -- length ) - Return string length. - -c+Dstr ( chr handle -- ) - Add one byte to end of the string. - -c+lDstr ( chr handle -- ) - Add one byte to left side (beginning) of the string. - -Dstr. ( handle -- ) - Write contec of string into screen. - -Dstrsure ( size Dstr -- ) - Makes sure that at least rquested - "size" (amount of characters) is allocated for given - dynamic string. - -Dstr2str ( handle address -- ) - Copy dyamic string into static memory space. - -str2Dstr ( address handle -- ) - Copy static string into dyamic string. - -Dstr+str ( Dstr addr -- ) - Add contenc of dynamic string to static string. - -D" any string" ( -- Dstr ) - Moves specified string into dynamic string called "defDstr". - -D> any_string ( -- Dstr ) - Moves specified string into dynamic string called "defDstr". - Space marks end of string! - -D>2 any_string ( -- Dstr ) - Moves specified string into dynamic string called "defDstr2". - Space marks end of string! - -Dstr+Dstr ( Dstr1 Dstr2 -- ) - Adds "Dstr1" to "Dstr2" and places result into "Dstr2". - -Dstrclear ( Dstr -- ) - Clears contenc of dynamic string. - -Dstr2Dstr ( Dstr1 Dstr2 -- ) - Moves "Dstr1" to "Dstr2". -Dstr ( data" name -- ) - Creates new dynamic string and moves specified data into it. - Then creates new constant with given "name" holding created - dynamic string handle. - - ex: Dstr Hello, my name is Sven!" message \ creates it - message Dstr. \ tests it - -Dstrlscan ( char Dstr -- loc ) - Searches dynamic string for "char", from left to right, - returns first found "char" location in string, or 0, - if not found. - -Dstrrscan ( char Dstr -- loc ) - Searches dynamic string for "char", from right to left, - returns first found "char" location in string, or 0, - if not found. - -Dstrlscane ( char Dstr -- loc ) - Same as "Dstrlscan" buf returns string length+1 as location. -ÿ -Dstrleft ( amo Dstr -- ) - Only specified amount of characters from left remains - in dynamic string. ie. cut right part out. - -Dstrright ( amo Dstr -- ) - Only specified amount of characters from right remains - in dynamic string. ie. cut left part out. - -Dstrcutl ( amo Dstr -- ) - Cut specified amount of characters from left of dynamic - string out. - -Dstrsp ( char Dstr1 Dstr2 -- ) - Separate dynamic string in Dstr1 into two parts, - using "char" as separator. First part will be stored in - "Dstr2", second part in "Dstr1". - ex: asc \ \ ..separator - D> listF\listLIB\5TH_DRVMOUSE \ ..separate from - defDstr2 \ ..place result in - Dstrsp \ separation command - defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE - defDstr2 Dstr. \ will be: listF - -Dv ( addr -- ) - Allocates empty dynamic string, and places it's handle - into given address. - -Df ( addr -- ) - Reads dynamic string handle from given address and - deallocates (frees) it. - -ex: var mystring1 - : testmodule - mystring1 Dv \ allocates string - - - - mystring1 Df ; \ deallocates it again when no longer needed. -#+END_VERSE * Dynamically loadable modules ** Keyboard driver #+BEGIN_VERSE @@ -952,7 +262,6 @@ mousedo ( -- ) Updates mouse coordinates and keys. Parse mouse + imgfill ( color x y imgbuf -- ) :: Fill image region starting at location X & Y with specified color. - ** Trigonometry functions *** sin ( a -- result ) :PROPERTIES: diff --git a/doc/language.html b/doc/language.html new file mode 100644 index 0000000..b6c120c --- /dev/null +++ b/doc/language.html @@ -0,0 +1,919 @@ + + + + + + + +Fifth - language + + + + + + + + +
    +

    Fifth - language

    + + + +
    +

    1. Fifth source format

    +
    +

    +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. +

    +
    +
    +

    1.1. FSCII

    +
    + + + +++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    DECHEXfunction
    0 - 150 - FHEX numbers
    252FCbackspace
    253FDtabulator (TAB)
    254FEcarriage return (CR)
    255FFspace
    else ordinary characters, same as in ASCII.
    +
    +
    +
    +
    +

    2. Fifth commands

    +
    +
    +
    +

    2.1. Compilation & miscellaneous

    +
    +

    +init module ( – )
    +                First module, control is passed to on startup. Contains
    +                initialization routines. Also it is the last core module.
    +                All new modules on top of it comes as result of executing
    +                external source files.
    +
    +head <name> ( – ) compiles new dictionary entry without specifying
    +                new module type.
    +                ex: head myentry
    +
    +: <name> ( – ) creates new code module
    +; ( – ) ends module (immideate)
    +                ex: : hello ." hi there" ;
    +
    +const <name> ( n – ) defines new constant.
    +                ex: 2147483647 const max
    +
    +:i <name> ( – ) same as ":" but this module will be executed
    +                immideately even in compile mode.
    +                ex: :i ( 41 scan ;
    +
    +create <name> ( – ) same as "head" , but specify module type as data.
    +                ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 ,
    +
    +allot ( n – ) allocate n bytes in dictionary.
    +                ex: create MyArray 100 allot
    +
    +" <string>" ( – ) compile string and its size into core.
    +                ex: create Mystring " This is it's contects"
    +
    +str <name> <string>" ( – ) just shorter way for defining strings.
    +                ex: str Mystring This is it's contenc"
    +
    +var <name> ( – ) define new 32 bit variable.
    +                ex: var result
    +
    +' <module> ( – n ) return memory address of given entry.
    +                ex: ' init
    +
    +forget <name> ( – ) erases from RAM given entry and all entries what was
    +                defined after it.
    +                ex: forget myprog
    +
    +[ ( – ) set interpret mode (immideate)
    +] ( n – ) set compile mode and compile top stack element
    +                in as literal. Together [ …. ] cobination provides good
    +                way to compute some values only once, at compile time,
    +                rather than every time while program is running.
    +                ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ;
    +
    +defer <name> ( – ) creates new module, with jump instruction.
    +                Later address where to jump can be modified by "is" command.
    +                This provides method of foward referencing. So you can use
    +                modules what not jet exist.
    +is ( address1 address2 – ) address1 - where to jump, address2 -
    +                address of module created by defer command.
    +                ex: defer dispver
    +                        : run dispver ." running …" ;
    +                               … whatever …
    +                        : (dispver ." Version 9.99 " ;
    +                        ' (dispver ' dispver is
    +
    +                Now if I type "run" on the screen appears:
    +                        Version 9.99 running …
    +
    +asc <char> ( – ) reads char ascii code and treats it as literal.
    +                (immideate)
    +                ex: : BreakLine 30 do asc - emit loop ;
    +                                 same as:
    +                    : BreakLine 30 do 45 emit loop ;
    +
    +dyninc ( handle – ) execute code in dynamic memory handle.
    +                automatically deallocates it when done.
    +
    +include ( filenumber – ) execute code in specified file.
    +
    +words ( – ) display existing blocks in core.
    +
    +bye ( – ) exit from Fifth
    +
    +fkey ( – c )
    +                Read one byte from input stream.
    +
    +sadd ( c addr – )
    +                Add one byte "c" to string located at "addr" and updates
    +                string length.
    +
    +scan ( c – )
    +                Read input stream and store it to pad until it finds c .
    +                It ignores all "c" bytes until it finds any non "c" byte.
    +                in other words:
    +                                c is: "
    +                         input stream: """"This is test !"aoeu idh
    +                               result: This is test !
    +
    +                Is useful for breaking text lines into words.
    +
    +skey ( – c )
    +                So called safe "fkey". Reads data from input stream
    +                but converts characters with ASCII codes: 9 13 10
    +                to spaces.
    +
    +str=str? ( adr1 adr2 – result )
    +                Compares string at "adr1" with string at "adr2", returns
    +                true flag if they are equal or false if they are not.
    +                true = -1
    +                false = 0
    +
    +find ( – addr )
    +                Searches whole dictionary for word in "pad". If found,
    +                returns it address, if not, returns 0.
    +
    +execute ( – )
    +                Execute word located in "pad". Depending on "mode".
    +
    +dta ( addr – DataAddr )
    +                Calculates address of dictionary entry data area, from
    +                entry point.
    +
    +2num ( – num result )
    +                Attempt to convert string located in "pad" into numeric
    +                value. If succeed returns number and true as result.
    +                If not, returns whatever and false as result.
    +
    +dadd ( addr length – )
    +                Add to dictionary data located at "addr", with specified
    +                length.
    +
    +lit ( n – )
    +                Act with number depending on "mode". When interpreting,
    +                leaves it in stack.
    +
    +
    +incmod ( addr – )
    +                Add to dictionary data located at "addr"+1 , length is taken
    +                from "addr".
    +
    +here ( – n )
    +                return "h" contents.
    +
    +mode var 8 bit
    +                Holds input stream parser operation mode.
    +                0 = interpreting
    +                1 = compiling
    +
    +pad var 128 bytes
    +                Holds temprorary strings.
    +
    +h var 32 bit
    +                Pointer to free byte in memory, always at the end of the
    +                dictionary. Each time when something is stored
    +                by "c," command, pointer is incareased.
    +
    +lp var 32 bit
    +                Pointer to last dictionary word. Each time when new word is
    +                compiled or erased by "forget", this pointer is updated.
    +
    +modulechk ( Dstr<filename> – ) check if module is loaded, if not
    +                immideately load it.
    +
    +ne ( entrydata entrytype – ) Compile new dictionary entry.
    +                It's name must be in "pad".
    +

    +
    +
    +
    +

    2.2. Conditionals & control flow

    +
    +

    +if ( flag – ) (immideate)
    +                "if 1.. else 2.. then" or
    +                "if 1.. then" construction. Conditional execution.
    +                Performs "1.." if "flag" was true,
    +                elseway performs "2.." if exist. Execution continues after
    +                word "then".
    +                ex: 1 if ." nonzero" else ." zero" then
    +
    +>= ( n1 n2 – result ) true if (n1 = n2) or (n1 > n2)
    +                ex: 5 3 >= if ." first number is greater or equal" then
    +
    +<= ( n1 n2 – result ) true if (n1 = n2) or (n1 < n2)
    += ( n1 n2 – result ) true if n1 = n2
    +
    +do ( count – ) (immideate)
    +                "do .. loop" construction. Performs ".." "count" times.
    +                In every step "count" is decareased until it is 0.
    +                ex: : test 5 do i .d loop ;
    +                result: 4 3 2 1 0
    +
    +doexit ( – ) exit from "do .. loop"
    +
    +for ( count top – ) (immideate)
    +                "for .. loop" construction. Performs ".." (top - count) times.
    +                In every step "count" is incareased until it reaches "top" .
    +                ex: : test 4 10 for i .d loop ;
    +                result: 4 5 6 7 8 9
    +
    +forexit ( – ) exit from "for .. loop"
    +
    +until ( – ) (immideate)
    +                "until .. loop" construction. Performs ".." until flag become
    +                true. False by default. Top of return stack holds flag.
    +
    +done ( – ) exit from "until .. loop"
    +
    +

    +
    +
    +
    +

    2.3. Disk & file access

    +
    +

    +diskload ( FromDisk ToMem amount – )
    +                Load specified abount of bytes from disk into memory.
    +
    +disksave ( FromMem ToDisk amount – )
    +                save specified abount of bytes from memory into disk.
    +
    +format ( – ) Erase all files.
    +
    +fsDfilesize@ ( handle – size )
    +                Return size of opened file.
    +
    +fsDcurloc@ ( handle – location )
    +                Return current location in file.
    +
    +fsDupdated@ ( handle – updated? )
    +                Return true if file was updated,
    +                ie. write operations occured.
    +
    +fssave ( FromMem DestFileHandle amount – )
    +                Save data to file.
    +
    +fsload ( SrcFileHandle ToMem amount – )
    +                Load data from file.
    +
    +fseof ( handle – bytesLeft )
    +                Return amount of bytes left till end of file.
    +                Useful before read operation.
    +
    +fsls ( – ) List all files and lists (directories,folders)
    +                in current path.
    +
    +fslsr ( – ) Same as "fsls" but recursively scans also sub lists.
    +
    +fscl ( DynStrHand – )
    +                Change list (path)
    +
    +fscreate ( DynStrHand – DescPnt )
    +                Create new file or list. Can create multiple lists at once.
    +                ex: when creating:
    +                    "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme"
    +                and only "\listGAMES\" already exist, then
    +                "listSTRATEGY" and "listSIMWORLD" lists will be created,
    +                and empty file "5th-runme" placed in there.
    +
    +fsDsave ( DynHand<data> DynStrHand<filename> – )
    +                Create new file and save all data from dynamic memory
    +                block to it.
    +
    +fsDload ( DynStr<SrcFileName> DynHand<DataDest> – )
    +                Load whole file into dynamic memory block.
    +
    +fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )
    +                Load whole file into new dynamic memory block.
    +

    +
    +
    +
    +

    2.4. Dynamic memory

    +
    +

    +dynal ( size – handle )
    +                Allocate dynamic memory block and return it's handle.
    +
    +dynde ( handle – )
    +                Deallocate dynamic memory block.
    +
    +dynp ( handle – addr )
    +                Returns pointer to memory where dynamic block
    +                data begins.
    +
    +dyns ( handle – size )
    +                Returns size of dynamic block.
    +
    +dynresize ( NewSize handle – )
    +                Nondestructively resize dynamic block.
    +
    +dync@ ( addr handle )
    +                Read one byte from dynamic block.
    +
    +dync! ( byte addr dynhandle )
    +                Write one byte to dynamic block.
    +
    +dyn@ ( addr handle )
    +                Read 32 bit number from dynamic block.
    +                Address will spacify, whitch number, not byte.
    +
    +dyn! ( 32BitNum addr dynhandle )
    +                Write 32 bit number to dynamic block.
    +                Address will spacify, whitch number, not byte.
    +
    +dyncon ( size "name" – )
    +                Allocate dynamic block with specified size, and
    +                create constant honding its handle.
    +                ex: 100 dyncon MyNewBlock
    +
    +dyn. ( handle – )
    +                Write contenc of dynamic memory block to screen.
    +

    +
    +
    +
    +

    2.5. Graphics and text

    +
    +

    +. ( n – ) print number on screen
    +
    +d. ( n – ) print number on screen in decimal
    +
    +? ( addr – ) print 32 bit value located at addr.
    +
    +." <string>" ( – ) print string into screen. Immideately
    +                compiles.
    +                ex: : greeting ." Hello, World" ;
    +
    +tab. ( – ) print tabulator
    +
    +calccol ( b g r – c ) calculate color what best matches given
    +                Blue Green & Red values. Values must be in range 0 - 255.
    +
    +imgalloc ( xsize ysize – imgbuf ) allocate image buffer for
    +                specified size.
    +
    +imgsize ( imgbuf – ) print on the screen X & Y size of image
    +                buffer.
    +
    +point ( x y imgbuf – addr ) returns memory address for specified
    +                pixel.
    +
    +pset ( color x y imgbuf – ) set graphic point
    +
    +boxf ( x1 x2 y1 y2 imgbuf color – ) draw filled box
    +
    +cls ( imgbuf – ) clear image buffer
    +
    +setpal ( b g r color – ) set palette value for specified color.
    +                values bust be in size 0 - 63.
    +
    +putchar ( char color x y imgbuf – ) put graphic character in
    +                imagebuffer to specified (x & y) location.
    +
    +scroll ( x y imgbuf – ) scroll in imgbuf.
    +
    +scrollf ( color x y screen – ) scroll and fill empty space with
    +                given color.
    +
    +at! ( x y – ) set cursor location
    +curc! ( color – ) set text color
    +curb! ( solor – ) set backround color
    +
    +colnorm ( – ) set text color to normal
    +colneg ( – ) set text color to negative (selected)
    +
    +dyntype ( dynhandle – ) display contenc of dynamic memory on screen
    +fsdisp ( file – ) clear screen, display file, and wait for key
    +
    +type ( addr length – )
    +                Types on the screen string, from memory at addr and
    +                specified length.
    +
    +write ( addr – )
    +                Types on the screen string, from memory at "addr"+1
    +                length is taken from "addr" .
    +
    +screen const 32 bit
    +                Holds handle of screen buffer.
    +
    +copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source
    +                image to destination image. Source and destination images
    +                must have same size.
    +

    +
    +
    +
    +

    2.6. Math, memory & stack manipulation

    +
    +

    +off ( n – ) writes 0 to given address, good for zeroing variable.
    +                ex: MyVariable off
    +on ( n – ) writes -1 (true flag) to given address.
    +                ex: MyVariable on
    +
    +2dup ( n1 n2 – n1 n2 n1 n2 )
    +2drop ( n1 n2 – )
    +nip ( n1 n2 – n2 )
    +neg ( n1 – -n1 ) negotiate
    +bit@ ( n bit – result ) return specified bit from n.
    +                ex: 38 2 bit@ (result will be 1)
    +to32bit ( n1 n2 n3 n4 – n32 ) treat 4 last stack elements as bytes
    +                and unite them into 32 bit dword. Most significant byte
    +                on top.
    +                ex: 12 76 23 11 to32bit result: 186076172
    +
    +to8bit ( n32 – n1 n2 n3 n4 ) break 32 bit number into 4 bytes.
    +                Useful if you need to send 32 bit numbers thru 8 bit COM
    +                port.
    +                ex: 186076172 to8bit result: 12 76 23 11
    +
    +mod ( n1 n2 – reminder ) divide n1 by n2 and returns reminder.
    +                ex: 12 5 mod result: 2
    +
    +bound ( low n high – n ) check if n is in given bounds,
    +                if not then incarease/decarease it to match bounds.
    +                ex: 5 80 15 bound result: 15
    +                    5 10 15 bound result: 10
    +                    5 -10 15 bound result: 5
    +
    +bound? ( low n high – result ) returns true if n is in the
    +                given bounds.
    +
    +tab ( col – spaces) calculate amount of spaces to add
    +                ta reach next tabulation from given column.
    +
    +count ( addr – addr+1 n )
    +                Useful for returning bytes from constantly incareasing
    +                address. Module "type" is nice example.
    +
    +c, ( n – )
    +                store one byte at memory specified by "h". And incarease
    +                "h" by 1.
    +
    +, ( n – )
    +                store 32 bit number at memory specified by "h". And
    +                incarease "h" by 4.
    +
    +cmove ( addr1 addr2 n – )
    +                copy "n" amount of bytes from memory at "addr1" to memory
    +                at "addr2".
    +
    +rnd ( limit – result )
    +                generates random number in range 0 to "limit"-1.
    +
    +abs ( n – |n| )
    +                returns absolute value of "n"
    +

    +
    +
    +
    +

    2.7. Dynamic & static strings

    +
    +

    +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. +

    + +

    +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. +

    + +

    +Both types of strings are stored in the way, where first (0th) byte +holds current string length, following bytes are string itself. +

    + + +

    +Dynamic:
    +
    +Dstral ( – handle )
    +                Allocate new string.
    +
    +Dstrlen ( handle – length )
    +                Return string length.
    +
    +c+Dstr ( chr handle – )
    +                Add one byte to end of the string.
    +
    +c+lDstr ( chr handle – )
    +                Add one byte to left side (beginning) of the string.
    +
    +Dstr. ( handle – )
    +                Write contec of string into screen.
    +
    +Dstrsure ( size Dstr – )
    +                Makes sure that at least rquested
    +                "size" (amount of characters) is allocated for given
    +                dynamic string.
    +
    +Dstr2str ( handle address – )
    +                Copy dyamic string into static memory space.
    +
    +str2Dstr ( address handle – )
    +                Copy static string into dyamic string.
    +
    +Dstr+str ( Dstr addr – )
    +                Add contenc of dynamic string to static string.
    +
    +D" any string" ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr".
    +
    +D> any_string ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr".
    +                Space marks end of string!
    +
    +D>2 any_string ( – Dstr )
    +                Moves specified string into dynamic string called "defDstr2".
    +                Space marks end of string!
    +
    +Dstr+Dstr ( Dstr1 Dstr2 – )
    +                Adds "Dstr1" to "Dstr2" and places result into "Dstr2".
    +
    +Dstrclear ( Dstr – )
    +                Clears contenc of dynamic string.
    +
    +Dstr2Dstr ( Dstr1 Dstr2 – )
    +                Moves "Dstr1" to "Dstr2".
    +Dstr ( data" name – )
    +                Creates new dynamic string and moves specified data into it.
    +                Then creates new constant with given "name" holding created
    +                dynamic string handle.
    +
    +                ex: Dstr Hello, my name is Sven!" message \ creates it
    +                    message Dstr. \ tests it
    +
    +Dstrlscan ( char Dstr – loc )
    +                Searches dynamic string for "char", from left to right,
    +                returns first found "char" location in string, or 0,
    +                if not found.
    +
    +Dstrrscan ( char Dstr – loc )
    +                Searches dynamic string for "char", from right to left,
    +                returns first found "char" location in string, or 0,
    +                if not found.
    +
    +Dstrlscane ( char Dstr – loc )
    +                Same as "Dstrlscan" buf returns string length+1 as location.
    +ÿ
    +Dstrleft ( amo Dstr – )
    +                Only specified amount of characters from left remains
    +                in dynamic string. ie. cut right part out.
    +
    +Dstrright ( amo Dstr – )
    +                Only specified amount of characters from right remains
    +                in dynamic string. ie. cut left part out.
    +
    +Dstrcutl ( amo Dstr – )
    +                Cut specified amount of characters from left of dynamic
    +                string out.
    +
    +Dstrsp ( char Dstr1 Dstr2 – )
    +                Separate dynamic string in Dstr1 into two parts,
    +                using "char" as separator. First part will be stored in
    +                "Dstr2", second part in "Dstr1".
    +                ex: asc \ \ ..separator
    +                    D> listF\listLIB\5TH_DRVMOUSE \ ..separate from
    +                    defDstr2 \ ..place result in
    +                    Dstrsp \ separation command
    +                    defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE
    +                    defDstr2 Dstr. \ will be: listF
    +
    +Dv ( addr – )
    +                Allocates empty dynamic string, and places it's handle
    +                into given address.
    +
    +Df ( addr – )
    +                Reads dynamic string handle from given address and
    +                deallocates (frees) it.
    +
    +ex: var mystring1
    +        : testmodule
    +        mystring1 Dv \ allocates string
    +
    +                <whatever>
    +
    +        mystring1 Df ; \ deallocates it again when no longer needed.
    +

    +
    +
    +
    +
    +
    +

    Author: Svjatoslav Agejenko

    +

    Created: 2023-09-18 Mon 01:47

    +

    Validate

    +
    + + diff --git a/doc/language.org b/doc/language.org new file mode 100644 index 0000000..4d7a07a --- /dev/null +++ b/doc/language.org @@ -0,0 +1,580 @@ +:PROPERTIES: +:ID: da7fff9b-0b67-4843-828a-52a404d7f401 +:END: + +#+TITLE: Fifth - language +#+AUTHOR: Svjatoslav Agejenko +#+LANGUAGE: en + + +* Fifth source format +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. +** FSCII + +| DEC | HEX | function | +|--------+-------+----------------------------------------| +| 0 - 15 | 0 - F | HEX numbers | +| 252 | FC | backspace | +| 253 | FD | tabulator (TAB) | +| 254 | FE | carriage return (CR) | +| 255 | FF | space | +| else | | ordinary characters, same as in ASCII. | +* Fifth commands +** Compilation & miscellaneous +#+BEGIN_VERSE +init module ( -- ) + First module, control is passed to on startup. Contains + initialization routines. Also it is the last core module. + All new modules on top of it comes as result of executing + external source files. + +head ( -- ) compiles new dictionary entry without specifying + new module type. + ex: head myentry + +: ( -- ) creates new code module +; ( -- ) ends module (immideate) + ex: : hello ." hi there" ; + +const ( n -- ) defines new constant. + ex: 2147483647 const max + +:i ( -- ) same as ":" but this module will be executed + immideately even in compile mode. + ex: :i ( 41 scan ; + +create ( -- ) same as "head" , but specify module type as data. + ex: create LotoResults 5 , 13 , 52 , 12 , 11 , 3 , + +allot ( n -- ) allocate n bytes in dictionary. + ex: create MyArray 100 allot + +" " ( -- ) compile string and its size into core. + ex: create Mystring " This is it's contects" + +str " ( -- ) just shorter way for defining strings. + ex: str Mystring This is it's contenc" + +var ( -- ) define new 32 bit variable. + ex: var result + +' ( -- n ) return memory address of given entry. + ex: ' init + +forget ( -- ) erases from RAM given entry and all entries what was + defined after it. + ex: forget myprog + +[ ( -- ) set interpret mode (immideate) +] ( n -- ) set compile mode and compile top stack element + in as literal. Together [ .... ] cobination provides good + way to compute some values only once, at compile time, + rather than every time while program is running. + ex: : calculate - [ 4 MyConst1 + MyConst2 * ] ; + +defer ( -- ) creates new module, with jump instruction. + Later address where to jump can be modified by "is" command. + This provides method of foward referencing. So you can use + modules what not jet exist. +is ( address1 address2 -- ) address1 - where to jump, address2 - + address of module created by defer command. + ex: defer dispver + : run dispver ." running ..." ; + ... whatever ... + : (dispver ." Version 9.99 " ; + ' (dispver ' dispver is + + Now if I type "run" on the screen appears: + Version 9.99 running ... + +asc ( -- ) reads char ascii code and treats it as literal. + (immideate) + ex: : BreakLine 30 do asc - emit loop ; + same as: + : BreakLine 30 do 45 emit loop ; + +dyninc ( handle -- ) execute code in dynamic memory handle. + automatically deallocates it when done. + +include ( filenumber -- ) execute code in specified file. + +words ( -- ) display existing blocks in core. + +bye ( -- ) exit from Fifth + +fkey ( -- c ) + Read one byte from input stream. + +sadd ( c addr -- ) + Add one byte "c" to string located at "addr" and updates + string length. + +scan ( c -- ) + Read input stream and store it to pad until it finds c . + It ignores all "c" bytes until it finds any non "c" byte. + in other words: + c is: " + input stream: """"This is test !"aoeu idh + result: This is test ! + + Is useful for breaking text lines into words. + +skey ( -- c ) + So called safe "fkey". Reads data from input stream + but converts characters with ASCII codes: 9 13 10 + to spaces. + +str=str? ( adr1 adr2 -- result ) + Compares string at "adr1" with string at "adr2", returns + true flag if they are equal or false if they are not. + true = -1 + false = 0 + +find ( -- addr ) + Searches whole dictionary for word in "pad". If found, + returns it address, if not, returns 0. + +execute ( -- ) + Execute word located in "pad". Depending on "mode". + +dta ( addr -- DataAddr ) + Calculates address of dictionary entry data area, from + entry point. + +2num ( -- num result ) + Attempt to convert string located in "pad" into numeric + value. If succeed returns number and true as result. + If not, returns whatever and false as result. + +dadd ( addr length -- ) + Add to dictionary data located at "addr", with specified + length. + +lit ( n -- ) + Act with number depending on "mode". When interpreting, + leaves it in stack. + + +incmod ( addr -- ) + Add to dictionary data located at "addr"+1 , length is taken + from "addr". + +here ( -- n ) + return "h" contents. + +mode var 8 bit + Holds input stream parser operation mode. + 0 = interpreting + 1 = compiling + +pad var 128 bytes + Holds temprorary strings. + +h var 32 bit + Pointer to free byte in memory, always at the end of the + dictionary. Each time when something is stored + by "c," command, pointer is incareased. + +lp var 32 bit + Pointer to last dictionary word. Each time when new word is + compiled or erased by "forget", this pointer is updated. + +modulechk ( Dstr -- ) check if module is loaded, if not + immideately load it. + +ne ( entrydata entrytype -- ) Compile new dictionary entry. + It's name must be in "pad". +#+END_VERSE +** Conditionals & control flow +#+BEGIN_VERSE +if ( flag -- ) (immideate) + "if 1.. else 2.. then" or + "if 1.. then" construction. Conditional execution. + Performs "1.." if "flag" was true, + elseway performs "2.." if exist. Execution continues after + word "then". + ex: 1 if ." nonzero" else ." zero" then + +>= ( n1 n2 -- result ) true if (n1 = n2) or (n1 > n2) + ex: 5 3 >= if ." first number is greater or equal" then + +<= ( n1 n2 -- result ) true if (n1 = n2) or (n1 < n2) += ( n1 n2 -- result ) true if n1 = n2 + +do ( count -- ) (immideate) + "do .. loop" construction. Performs ".." "count" times. + In every step "count" is decareased until it is 0. + ex: : test 5 do i .d loop ; + result: 4 3 2 1 0 + +doexit ( -- ) exit from "do .. loop" + +for ( count top -- ) (immideate) + "for .. loop" construction. Performs ".." (top - count) times. + In every step "count" is incareased until it reaches "top" . + ex: : test 4 10 for i .d loop ; + result: 4 5 6 7 8 9 + +forexit ( -- ) exit from "for .. loop" + +until ( -- ) (immideate) + "until .. loop" construction. Performs ".." until flag become + true. False by default. Top of return stack holds flag. + +done ( -- ) exit from "until .. loop" + +#+END_VERSE +** Disk & file access +#+BEGIN_VERSE +diskload ( FromDisk ToMem amount -- ) + Load specified abount of bytes from disk into memory. + +disksave ( FromMem ToDisk amount -- ) + save specified abount of bytes from memory into disk. + +format ( -- ) Erase all files. + +fsDfilesize@ ( handle -- size ) + Return size of opened file. + +fsDcurloc@ ( handle -- location ) + Return current location in file. + +fsDupdated@ ( handle -- updated? ) + Return true if file was updated, + ie. write operations occured. + +fssave ( FromMem DestFileHandle amount -- ) + Save data to file. + +fsload ( SrcFileHandle ToMem amount -- ) + Load data from file. + +fseof ( handle -- bytesLeft ) + Return amount of bytes left till end of file. + Useful before read operation. + +fsls ( -- ) List all files and lists (directories,folders) + in current path. + +fslsr ( -- ) Same as "fsls" but recursively scans also sub lists. + +fscl ( DynStrHand -- ) + Change list (path) + +fscreate ( DynStrHand -- DescPnt ) + Create new file or list. Can create multiple lists at once. + ex: when creating: + "\listGAMES\listSTRATEGY\listSIMWORLD\5th-runme" + and only "\listGAMES\" already exist, then + "listSTRATEGY" and "listSIMWORLD" lists will be created, + and empty file "5th-runme" placed in there. + +fsDsave ( DynHand DynStrHand -- ) + Create new file and save all data from dynamic memory + block to it. + +fsDload ( DynStr DynHand -- ) + Load whole file into dynamic memory block. + +fsDloadnew ( DynStr -- DynHand ) + Load whole file into new dynamic memory block. +#+END_VERSE +** Dynamic memory +#+BEGIN_VERSE +dynal ( size -- handle ) + Allocate dynamic memory block and return it's handle. + +dynde ( handle -- ) + Deallocate dynamic memory block. + +dynp ( handle -- addr ) + Returns pointer to memory where dynamic block + data begins. + +dyns ( handle -- size ) + Returns size of dynamic block. + +dynresize ( NewSize handle -- ) + Nondestructively resize dynamic block. + +dync@ ( addr handle ) + Read one byte from dynamic block. + +dync! ( byte addr dynhandle ) + Write one byte to dynamic block. + +dyn@ ( addr handle ) + Read 32 bit number from dynamic block. + Address will spacify, whitch number, not byte. + +dyn! ( 32BitNum addr dynhandle ) + Write 32 bit number to dynamic block. + Address will spacify, whitch number, not byte. + +dyncon ( size "name" -- ) + Allocate dynamic block with specified size, and + create constant honding its handle. + ex: 100 dyncon MyNewBlock + +dyn. ( handle -- ) + Write contenc of dynamic memory block to screen. +#+END_VERSE +** Graphics and text +#+BEGIN_VERSE +. ( n -- ) print number on screen + +d. ( n -- ) print number on screen in decimal + +? ( addr -- ) print 32 bit value located at addr. + +." " ( -- ) print string into screen. Immideately + compiles. + ex: : greeting ." Hello, World" ; + +tab. ( -- ) print tabulator + +calccol ( b g r -- c ) calculate color what best matches given + Blue Green & Red values. Values must be in range 0 - 255. + +imgalloc ( xsize ysize -- imgbuf ) allocate image buffer for + specified size. + +imgsize ( imgbuf -- ) print on the screen X & Y size of image + buffer. + +point ( x y imgbuf -- addr ) returns memory address for specified + pixel. + +pset ( color x y imgbuf -- ) set graphic point + +boxf ( x1 x2 y1 y2 imgbuf color -- ) draw filled box + +cls ( imgbuf -- ) clear image buffer + +setpal ( b g r color -- ) set palette value for specified color. + values bust be in size 0 - 63. + +putchar ( char color x y imgbuf -- ) put graphic character in + imagebuffer to specified (x & y) location. + +scroll ( x y imgbuf -- ) scroll in imgbuf. + +scrollf ( color x y screen -- ) scroll and fill empty space with + given color. + +at! ( x y -- ) set cursor location +curc! ( color -- ) set text color +curb! ( solor -- ) set backround color + +colnorm ( -- ) set text color to normal +colneg ( -- ) set text color to negative (selected) + +dyntype ( dynhandle -- ) display contenc of dynamic memory on screen +fsdisp ( file -- ) clear screen, display file, and wait for key + +type ( addr length -- ) + Types on the screen string, from memory at addr and + specified length. + +write ( addr -- ) + Types on the screen string, from memory at "addr"+1 + length is taken from "addr" . + +screen const 32 bit + Holds handle of screen buffer. + +copyscreen ( SrcImgHandle DestImgHandle -- ) copy contenc of source + image to destination image. Source and destination images + must have same size. +#+END_VERSE +** Math, memory & stack manipulation +#+BEGIN_VERSE +off ( n -- ) writes 0 to given address, good for zeroing variable. + ex: MyVariable off +on ( n -- ) writes -1 (true flag) to given address. + ex: MyVariable on + +2dup ( n1 n2 -- n1 n2 n1 n2 ) +2drop ( n1 n2 -- ) +nip ( n1 n2 -- n2 ) +neg ( n1 -- -n1 ) negotiate +bit@ ( n bit -- result ) return specified bit from n. + ex: 38 2 bit@ (result will be 1) +to32bit ( n1 n2 n3 n4 -- n32 ) treat 4 last stack elements as bytes + and unite them into 32 bit dword. Most significant byte + on top. + ex: 12 76 23 11 to32bit result: 186076172 + +to8bit ( n32 -- n1 n2 n3 n4 ) break 32 bit number into 4 bytes. + Useful if you need to send 32 bit numbers thru 8 bit COM + port. + ex: 186076172 to8bit result: 12 76 23 11 + +mod ( n1 n2 -- reminder ) divide n1 by n2 and returns reminder. + ex: 12 5 mod result: 2 + +bound ( low n high -- n ) check if n is in given bounds, + if not then incarease/decarease it to match bounds. + ex: 5 80 15 bound result: 15 + 5 10 15 bound result: 10 + 5 -10 15 bound result: 5 + +bound? ( low n high -- result ) returns true if n is in the + given bounds. + +tab ( col -- spaces) calculate amount of spaces to add + ta reach next tabulation from given column. + +count ( addr -- addr+1 n ) + Useful for returning bytes from constantly incareasing + address. Module "type" is nice example. + +c, ( n -- ) + store one byte at memory specified by "h". And incarease + "h" by 1. + +, ( n -- ) + store 32 bit number at memory specified by "h". And + incarease "h" by 4. + +cmove ( addr1 addr2 n -- ) + copy "n" amount of bytes from memory at "addr1" to memory + at "addr2". + +rnd ( limit -- result ) + generates random number in range 0 to "limit"-1. + +abs ( n -- |n| ) + returns absolute value of "n" +#+END_VERSE +** Dynamic & static strings +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. + +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. + +Both types of strings are stored in the way, where first (0th) byte +holds current string length, following bytes are string itself. + + +#+BEGIN_VERSE +Dynamic: + +Dstral ( -- handle ) + Allocate new string. + +Dstrlen ( handle -- length ) + Return string length. + +c+Dstr ( chr handle -- ) + Add one byte to end of the string. + +c+lDstr ( chr handle -- ) + Add one byte to left side (beginning) of the string. + +Dstr. ( handle -- ) + Write contec of string into screen. + +Dstrsure ( size Dstr -- ) + Makes sure that at least rquested + "size" (amount of characters) is allocated for given + dynamic string. + +Dstr2str ( handle address -- ) + Copy dyamic string into static memory space. + +str2Dstr ( address handle -- ) + Copy static string into dyamic string. + +Dstr+str ( Dstr addr -- ) + Add contenc of dynamic string to static string. + +D" any string" ( -- Dstr ) + Moves specified string into dynamic string called "defDstr". + +D> any_string ( -- Dstr ) + Moves specified string into dynamic string called "defDstr". + Space marks end of string! + +D>2 any_string ( -- Dstr ) + Moves specified string into dynamic string called "defDstr2". + Space marks end of string! + +Dstr+Dstr ( Dstr1 Dstr2 -- ) + Adds "Dstr1" to "Dstr2" and places result into "Dstr2". + +Dstrclear ( Dstr -- ) + Clears contenc of dynamic string. + +Dstr2Dstr ( Dstr1 Dstr2 -- ) + Moves "Dstr1" to "Dstr2". +Dstr ( data" name -- ) + Creates new dynamic string and moves specified data into it. + Then creates new constant with given "name" holding created + dynamic string handle. + + ex: Dstr Hello, my name is Sven!" message \ creates it + message Dstr. \ tests it + +Dstrlscan ( char Dstr -- loc ) + Searches dynamic string for "char", from left to right, + returns first found "char" location in string, or 0, + if not found. + +Dstrrscan ( char Dstr -- loc ) + Searches dynamic string for "char", from right to left, + returns first found "char" location in string, or 0, + if not found. + +Dstrlscane ( char Dstr -- loc ) + Same as "Dstrlscan" buf returns string length+1 as location. +ÿ +Dstrleft ( amo Dstr -- ) + Only specified amount of characters from left remains + in dynamic string. ie. cut right part out. + +Dstrright ( amo Dstr -- ) + Only specified amount of characters from right remains + in dynamic string. ie. cut left part out. + +Dstrcutl ( amo Dstr -- ) + Cut specified amount of characters from left of dynamic + string out. + +Dstrsp ( char Dstr1 Dstr2 -- ) + Separate dynamic string in Dstr1 into two parts, + using "char" as separator. First part will be stored in + "Dstr2", second part in "Dstr1". + ex: asc \ \ ..separator + D> listF\listLIB\5TH_DRVMOUSE \ ..separate from + defDstr2 \ ..place result in + Dstrsp \ separation command + defDstr Dstr. \ will be: listLIB\5TH_DRVMOUSE + defDstr2 Dstr. \ will be: listF + +Dv ( addr -- ) + Allocates empty dynamic string, and places it's handle + into given address. + +Df ( addr -- ) + Reads dynamic string handle from given address and + deallocates (frees) it. + +ex: var mystring1 + : testmodule + mystring1 Dv \ allocates string + + + + mystring1 Df ; \ deallocates it again when no longer needed. +#+END_VERSE diff --git a/doc/screenshots/index.html b/doc/screenshots/index.html deleted file mode 100644 index 2504418..0000000 --- a/doc/screenshots/index.html +++ /dev/null @@ -1,27 +0,0 @@ -FIFTH - - -
    -
-    
    Screen shots
    
-
-
-
-
-
-
-
-
-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.
-
-
-
-
-Built in text editor.
-
-
-
-
    - diff --git a/doc/virtual machine.html b/doc/virtual machine.html new file mode 100644 index 0000000..fbf1f6c --- /dev/null +++ b/doc/virtual machine.html @@ -0,0 +1,677 @@ + + + + + + + +Fifth - virtual machine + + + + + + +
    +

    Fifth - virtual machine

    + +

    +Current emulator emulates: +

    +
      +
    • 1 CPU.
      • +
    • It has 2 stacks
      • +
    • ~50 instructions
      • +
    • 4GB flat address space (theoretically).
      • +
    + + +

    +While I tried to keep instruction set simple, I was forced to put in +some complex instructions to make performance acceptable on +emulator. +

    + +

    +CPU has following registers: +

    +
    +
    IP
    instruction pointer
    +
    DSP
    data stack pointer
    +
    RSP
    return stack pointer
    +
    + +
    +

    1. Instructions overview

    +
    +

    +Virtual CPU, commands (most of them are avaiable as ordinary commands +in programming language): +

    + + + + + +++ ++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    #namestack footprintdescription
    0nop--does nothing
    1halt--halt CPU ( return to DOS on emulator )
    2kbd@– cread scancode of pressed or released key
    3num <dword>– nput immidiate number into datastack
    4jmp <dword>--jump to specified code
    5call <dword> jump to specified code, save return address to return stack
    61+n – n+1 
    71-n – n-1 
    8dupn – n nduplicate top of data stack
    9dropn --drop last element in data stack
    10if <dword>n --jump to addr if top element was 0
    11ret jump to code, specified in return stack.
    12c@addr – nread byte from memory at specified address
    13c!n addr --store byte to specified memory
    14pushDSTK -> RSTKmove top of datastack to returnstack
    15popRSTK -> DSTKmove top of returnstack to datastack
    16<unused>  
    17rotn1 n2 n3 – n2 n3 n1rotate stack elements
    18disk@FromDiskSect ToMem --read 1KB from disk into RAM
    19disk!FromMem ToDiskSect --write 1KB to disk
    20@addr – nread 32 bit number from memory
    21!n addr --store 32 bit number to memory
    22overn1 n2 – n1 n2 n1 
    23swapn1 n2 – n2 n1 
    24+n1 n2 – n1+n2 
    25-n1 n2 – n1-n2 
    26*n1 n2 – n1*n2 
    27/n1 n2 – n1/n2 
    28>n1 n2 – resultis true when n1 > n2
    29<n1 n2 – resultis true when n1 < n2
    30notn1 – not_n1logical not
    31i– ncopies top of return stack into datastack
    32cprt@addr – nread one byte from hardware port
    33cprt!n addr --store one byte to hardware port
    34i2– nlike "i" but takes second top stack element
    35i3– nlike "i" but takes third top stack element.
    36shln amount – nleft bit shift
    37shrn amount – nright bit shift
    38orn1 n2 – nlogical or
    39xorn1 n2 – nexclusive logical or
    40vidmapaddr --copy memory from "addr" to video memory.
    41mouse@– x y buttonread mouse coordinates & buttons
    42vidputaddr1 addr2 x y --put image1 into image2, at location x, y
    43cmoveaddr1 addr2 amountmove memory from addr1 to addr2
    44cfillc addr amount --fill memory starting at "addr" with "c" bytes.
    45tvidputaddr1 addr2 x y --put image with transparency support
    46depth– depthreturns current depth of data stack.
    47charputcolorfg colorbg addrsrc addrdest x ydraw text character
    +
    + +
    +

    1.1. kbd@ - read scancode of pressed or released key

    +
    +

    +Returns 0 if no data available. +

    +
    +
    +
    +

    1.2. vidput - put image1 into image2, at location x, y

    +
    +

    +Does clipping, so part of a big image can be mapped into smaller one. +

    +
    +
    +
    +

    1.3. cmove - copy memory array

    +
    +

    +Move memory from addr1 to addr2. If addr1 is greater than addr2 then +count address foward while moving, elseway starts from end and counts +backwards, so no data loss occurs when memory regions partially +overlap. +

    +
    +
    +
    +

    1.4. tvidput - put image with transparency support

    +
    +

    +Stack footprint +

    +
    +addr1 addr2 x y --
+
    + + +

    +Put image1 into image2, at location x, y with transparency support +

    + +

    +Color 255 in source image is treated as transparent. +

    +
    +
    +
    +

    1.5. charput - draw text character

    +
    +

    +Draw character to image buffer located at "addrdest" to specified x & +y location. Decodes 8 bytes from source to bits, used to draw +character. +

    +
    +
    +
    +
    +
    +

    Author: Svjatoslav Agejenko

    +

    Created: 2023-09-18 Mon 01:46

    +

    Validate

    +
    + + diff --git a/doc/virtual machine.org b/doc/virtual machine.org new file mode 100644 index 0000000..262c414 --- /dev/null +++ b/doc/virtual machine.org @@ -0,0 +1,115 @@ +:PROPERTIES: +:ID: 9b251eb9-aff6-4025-94bf-25e89e26d54a +:END: + +#+TITLE: Fifth - virtual machine +#+AUTHOR: Svjatoslav Agejenko +#+LANGUAGE: en + +Current emulator emulates: +- 1 CPU. +- It has 2 stacks +- ~50 instructions +- 4GB flat address space (theoretically). + + +While I tried to keep instruction set simple, I was forced to put in +some complex instructions to make performance acceptable on +emulator. + +CPU has following registers: +- IP :: instruction pointer +- DSP :: data stack pointer +- RSP :: return stack pointer + +* Instructions overview +Virtual CPU, commands (most of them are avaiable as ordinary commands +in programming language): + + +| # | name | stack footprint | description | +|----+--------------+--------------------------------------+-------------------------------------------------------------| +| 0 | nop | -- | does nothing | +| 1 | halt | -- | halt CPU ( return to DOS on emulator ) | +| 2 | [[id:820b1b90-4f4c-4ab1-b49f-9b4a52ea2528][kbd@]] | -- c | read scancode of pressed or released key | +| 3 | num | -- n | put immidiate number into datastack | +| 4 | jmp | -- | jump to specified code | +| 5 | call | | jump to specified code, save return address to return stack | +| 6 | 1+ | n -- n+1 | | +| 7 | 1- | n -- n-1 | | +| 8 | dup | n -- n n | duplicate top of data stack | +| 9 | drop | n -- | drop last element in data stack | +| 10 | if | n -- | jump to addr if top element was 0 | +| 11 | ret | | jump to code, specified in return stack. | +| 12 | c@ | addr -- n | read byte from memory at specified address | +| 13 | c! | n addr -- | store byte to specified memory | +| 14 | push | DSTK -> RSTK | move top of datastack to returnstack | +| 15 | pop | RSTK -> DSTK | move top of returnstack to datastack | +| 16 | | | | +| 17 | rot | n1 n2 n3 -- n2 n3 n1 | rotate stack elements | +| 18 | disk@ | FromDiskSect ToMem -- | read 1KB from disk into RAM | +| 19 | disk! | FromMem ToDiskSect -- | write 1KB to disk | +| 20 | @ | addr -- n | read 32 bit number from memory | +| 21 | ! | n addr -- | store 32 bit number to memory | +| 22 | over | n1 n2 -- n1 n2 n1 | | +| 23 | swap | n1 n2 -- n2 n1 | | +| 24 | + | n1 n2 -- n1+n2 | | +| 25 | - | n1 n2 -- n1-n2 | | +| 26 | * | n1 n2 -- n1*n2 | | +| 27 | / | n1 n2 -- n1/n2 | | +| 28 | > | n1 n2 -- result | is true when n1 > n2 | +| 29 | < | n1 n2 -- result | is true when n1 < n2 | +| 30 | not | n1 -- not_n1 | logical not | +| 31 | i | -- n | copies top of return stack into datastack | +| 32 | cprt@ | addr -- n | read one byte from hardware port | +| 33 | cprt! | n addr -- | store one byte to hardware port | +| 34 | i2 | -- n | like "i" but takes second top stack element | +| 35 | i3 | -- n | like "i" but takes third top stack element. | +| 36 | shl | n amount -- n | left bit shift | +| 37 | shr | n amount -- n | right bit shift | +| 38 | or | n1 n2 -- n | logical or | +| 39 | xor | n1 n2 -- n | exclusive logical or | +| 40 | vidmap | addr -- | copy memory from "addr" to video memory. | +| 41 | mouse@ | -- x y button | read mouse coordinates & buttons | +| 42 | [[id:238e8b03-57b6-424d-bfee-b6bb652cefbc][vidput]] | addr1 addr2 x y -- | put image1 into image2, at location x, y | +| 43 | [[id:79e1916f-4103-42cc-ac10-bb1ee776ed50][cmove]] | addr1 addr2 amount | move memory from addr1 to addr2 | +| 44 | cfill | c addr amount -- | fill memory starting at "addr" with "c" bytes. | +| 45 | [[id:ab45247c-44c3-464d-9e2a-337f483b4616][tvidput]] | addr1 addr2 x y -- | put image with transparency support | +| 46 | depth | -- depth | returns current depth of data stack. | +| 47 | [[id:4bb479cf-aae0-4128-9868-f016c286a162][charput]] | colorfg colorbg addrsrc addrdest x y | draw text character | + +** kbd@ - read scancode of pressed or released key +:PROPERTIES: +:ID: 820b1b90-4f4c-4ab1-b49f-9b4a52ea2528 +:END: +Returns 0 if no data available. +** vidput - put image1 into image2, at location x, y +:PROPERTIES: +:ID: 238e8b03-57b6-424d-bfee-b6bb652cefbc +:END: +Does clipping, so part of a big image can be mapped into smaller one. +** cmove - copy memory array +:PROPERTIES: +:ID: 79e1916f-4103-42cc-ac10-bb1ee776ed50 +:END: +Move memory from addr1 to addr2. If addr1 is greater than addr2 then +count address foward while moving, elseway starts from end and counts +backwards, so no data loss occurs when memory regions partially +overlap. +** tvidput - put image with transparency support +:PROPERTIES: +:ID: ab45247c-44c3-464d-9e2a-337f483b4616 +:END: +Stack footprint +: addr1 addr2 x y -- + +Put image1 into image2, at location x, y with transparency support + +Color 255 in source image is treated as transparent. +** charput - draw text character +:PROPERTIES: +:ID: 4bb479cf-aae0-4128-9868-f016c286a162 +:END: +Draw character to image buffer located at "addrdest" to specified x & +y location. Decodes 8 bytes from source to bits, used to draw +character. diff --git a/tools/synchronize b/tools/synchronize index 8427b12..bbc8d16 100755 --- a/tools/synchronize +++ b/tools/synchronize @@ -15,4 +15,7 @@ cola # push changes to remote repository git push -sleep 3 + +echo "" +echo "Press ENTER to close this window." +read -- 2.20.1 From 404df5a007951012b727f2a90bc3a59254a05dbd Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 19 Sep 2023 18:10:01 +0300 Subject: [PATCH 7/7] Rephrased documentation for better readability --- doc/index.html | 251 +++++++++++++++++++++------------------------- doc/index.org | 47 +++++---- doc/language.html | 68 +++++++------ doc/language.org | 1 + 4 files changed, 179 insertions(+), 188 deletions(-) diff --git a/doc/index.html b/doc/index.html index cadd753..174e5ec 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Fifth - virtual machine, operating system, programming language @@ -194,27 +194,6 @@ .org-svg { } - -
    @@ -223,50 +202,49 @@

    Table of Contents

    -
    -

    1. General

    +
    +

    1. General

    • This program is free software: released under Creative Commons Zero @@ -293,8 +271,8 @@
    -
    -

    1.1. Source code

    +
    +

    1.1. Source code

    -
    -

    2. !Project deprecated!

    +
    +

    2. !Project deprecated!

    Current implementation does not support object oriented @@ -332,8 +310,8 @@ operating system.

    -
    -

    3. Introduction

    +
    +

    3. Introduction

    Fifth is a combination of: @@ -342,14 +320,14 @@ Fifth is a combination of:

  • Programming language (inspired by Forth).
  • Operating system.
  • Virtual machine with custom instruction set.
    • -
  • Example Fifth source file - text editor
    • -
    -

    3.1. screenshots

    + +
    +

    3.1. Screenshots

    -
    +

    start.png

    @@ -359,20 +337,20 @@ Startup screen diplaying Fifth logo and full file list.

    -
    +

    dictionary.png

    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. +executed interactively from the command line or from a file. When +executed, they can be selectively compiled or interpreted.

    -
    +

    text editor.png

    @@ -384,24 +362,36 @@ Built in text editor.
    -
    -

    4. Installation

    +
    +

    4. Installation

    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 ). +somewhere in your hard disk. For example:

    +
    +C:\MISC\FIFTH\
+
    + +

    -Read more about Fifth distribution directory tree description. +To run fifth you need minimally just 2 files: +

    +
    +
    EMULATOR.COM
    Virtual CPU emulator
    +
    DISK.RAW
    Virtual disk file
    +
    + +

    +For more information, please refer to Fifth distribution directory +tree description.

    -
    -

    5. Fifth distribution directory tree description

    +
    +

    5. Fifth distribution directory tree description

    After downloading and unpacking the ZIP file you shoud get directory @@ -426,46 +416,39 @@ tree similar to this:

    -
    -

    6. Requirements

    +
    +

    6. Requirements

    -
    -

    6.1. Software

    +
    +

    6.1. 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).
      • +
    • MS-DOS 6.22 with HIMEM.SYS loaded.
      • +
    • Mouse driver (optional, if you have a mouse).
      • +
    • CPU is initialized into Unreal Mode during operation.
      • +
    • To recompile ASM sources, you can use FASM (Flat Assembler).
      • +
    • To run Quick Basic utilities, use Microsoft Quick Basic 4.5.
      • +
    • VESA support through BIOS or external driver (UNIVBE).
    -
    -

    6.2. Hardware

    + +
    +

    6.2. Hardware

      -
    • Minimum CPU 386.
      • -
    • 64 KB free RAM below 640KB,
      • -
    • 2 MB of free XMS.
      • -
    • VESA compatible video card.
      • +
    • A minimum of a i386 CPU.
      • +
    • 64 KB of free RAM below 640KB.
      • +
    • 2 MB of free extended memory.
      • +
    • A VESA-compatible video card.
    -
    -

    6.3. Human

    -
    -
      -
    • Beginner level Forth knowledge is recommended.
      • -
    • Lots of enthusiasm.
      • -
    -
    -
    -
    -

    7. Numbers representation within Fifth

    + +
    +

    7. Numbers representation within Fifth

    Because we are in full experimentation mode here (no regard for @@ -478,7 +461,7 @@ Here alternative hexadecimal number representation format is devised:

    -
    +

    numbers.png

    @@ -499,8 +482,8 @@ See also: Bibi-binary.
    -
    -

    8. Disk file map, and it's data structures

    +
    +

    8. Disk file map, and it's data structures

    Core and high-level boot code is stored outside of the filesystem to @@ -508,8 +491,8 @@ allow easy access to it, at early booting time, when filesystem is not yet initialized.

    -
    -

    8.1. Disk allocation

    +
    +

    8.1. Disk allocation

    @@ -556,8 +539,8 @@ yet initialized.
    -
    -

    8.2. FAT entry format:

    +
    +

    8.2. FAT entry format:

    @@ -592,8 +575,8 @@ yet initialized.
    -
    -

    8.3. File entry format

    +
    +

    8.3. File entry format

    @@ -647,8 +630,8 @@ yet initialized. -
    -

    9. Core architecture

    +
    +

    9. Core architecture

    Fifth core is simply some amount of already compiled into machine code @@ -661,8 +644,8 @@ dictionary space only. Random word can be removed from dictionary at any time. Currently dictionary can contain at most 1000 entries.

    -
    -

    9.1. Dictionary entry format

    +
    +

    9.1. Dictionary entry format

    @@ -730,8 +713,8 @@ run through headers backwards and find needed entry.

    -
    -

    9.2. Possible module types

    +
    +

    9.2. Possible module types

    @@ -786,8 +769,8 @@ run through headers backwards and find needed entry.
    -
    -

    9.3. Memory map

    +
    +

    9.3. Memory map

    @@ -835,12 +818,12 @@ run through headers backwards and find needed entry. -
    -

    10. Dynamically loadable modules

    +
    +

    10. Dynamically loadable modules

    -
    -

    10.1. Keyboard driver

    +
    +

    10.1. Keyboard driver


    @@ -878,8 +861,8 @@ FF space

    -
    -

    10.2. Mouse driver

    +
    +

    10.2. Mouse driver

    mousex var Mouse x coordinate.
    @@ -899,8 +882,8 @@ mousedo ( – ) Updates mouse coordinates and keys. Parse mouse

    -
    -

    10.3. 2D graphic library

    +
    +

    10.3. 2D graphic library

    lineh ( color len x y imgbuf – )
    draws horisontal line from X,Y @@ -914,7 +897,7 @@ draws rectangular box. x2 bust be >= x1, y2 must be >= y1.

    -
    +
     x1,y1-----------+
   |             |
   |             |
@@ -932,12 +915,12 @@ location X & Y with specified color.
    -
    -

    10.4. Trigonometry functions

    +
    +

    10.4. Trigonometry functions

    -
    -

    10.4.1. sin ( a – result )

    +
    +

    10.4.1. sin ( a – result )

    Return sinus from given angle "a", 360ø is 2000. So 1000 represents @@ -945,11 +928,11 @@ Return sinus from given angle "a", 360ø is 2000. So 1000 represents

    -
    -

    10.4.2. cos ( a – result )

    +
    +

    10.4.2. cos ( a – result )

    -Return cosinus from given angle. Parameters are like in sin function. +Return cosinus from given angle. Parameters are like in sin function.

    @@ -958,7 +941,7 @@ Return cosinus from given angle. Parameters are like in s
    diff --git a/doc/index.org b/doc/index.org index 4d9c4a0..c370a29 100644 --- a/doc/index.org +++ b/doc/index.org @@ -34,8 +34,9 @@ Fifth is a combination of: - [[id:da7fff9b-0b67-4843-828a-52a404d7f401][Programming language]] (inspired by Forth). - Operating system. - [[id:9b251eb9-aff6-4025-94bf-25e89e26d54a][Virtual machine]] with custom instruction set. -- [[file:5TH_ET.txt][Example Fifth source file - text editor]] -** screenshots + +** Screenshots + [[file:screenshots/start.png]] Startup screen diplaying Fifth logo and full file list. @@ -43,8 +44,8 @@ Startup screen diplaying Fifth logo and full file list. [[file:screenshots/dictionary.png]] 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. +executed interactively from the command line or from a file. When +executed, they can be selectively compiled or interpreted. [[file:screenshots/text editor.png]] @@ -53,11 +54,16 @@ Built in text editor. * Installation 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 ). +somewhere in your hard disk. For example: + +: C:\MISC\FIFTH\ -Read more about [[id:0759f3e0-28bb-4901-9e4f-09ef41732173][Fifth distribution directory tree description]]. +To run fifth you need minimally just 2 files: +- EMULATOR.COM :: Virtual CPU emulator +- DISK.RAW :: Virtual disk file + +For more information, please refer to [[id:0759f3e0-28bb-4901-9e4f-09ef41732173][Fifth distribution directory +tree description]]. * Fifth distribution directory tree description :PROPERTIES: @@ -84,20 +90,19 @@ tree similar to this: * Requirements ** 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). +- MS-DOS 6.22 with HIMEM.SYS loaded. +- Mouse driver (optional, if you have a mouse). +- CPU is initialized into [[https://en.wikipedia.org/wiki/Unreal_mode][Unreal Mode]] during operation. +- To recompile ASM sources, you can use FASM (Flat Assembler). +- To run Quick Basic utilities, use Microsoft Quick Basic 4.5. +- VESA support through BIOS or external driver (UNIVBE). + ** Hardware -- Minimum CPU 386. -- 64 KB free RAM below 640KB, -- 2 MB of free XMS. -- VESA compatible video card. -** Human -- Beginner level Forth knowledge is recommended. -- Lots of enthusiasm. +- A minimum of a i386 CPU. +- 64 KB of free RAM below 640KB. +- 2 MB of free [[https://en.wikipedia.org/wiki/Extended_memory][extended memory]]. +- A VESA-compatible video card. + * Numbers representation within Fifth Because we are in full experimentation mode here (no regard for diff --git a/doc/language.html b/doc/language.html index b6c120c..ef8f0eb 100644 --- a/doc/language.html +++ b/doc/language.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Fifth - language @@ -223,29 +223,31 @@

    Table of Contents

    + - -
    -

    1. Fifth source format

    +
    +

    1. Fifth source format

    Fifth uses a different character table and codes than ASCII (still @@ -256,8 +258,8 @@ numeric values. So typical nemric characters "0123…" is treated like ordinary letters.

    -
    -

    1.1. FSCII

    +
    +

    1.1. FSCII

    @@ -317,12 +319,12 @@ like ordinary letters. -
    -

    2. Fifth commands

    +
    +

    2. Fifth commands

    -
    -

    2.1. Compilation & miscellaneous

    +
    +

    2.1. Compilation & miscellaneous

    init module ( – )
    @@ -490,8 +492,8 @@ ne ( entrydata entrytype – ) Compile new dictionary entry.

    -
    -

    2.2. Conditionals & control flow

    +
    +

    2.2. Conditionals & control flow

    if ( flag – ) (immideate)
    @@ -533,8 +535,8 @@ done ( – ) exit from "until .. loop"

    -
    -

    2.3. Disk & file access

    +
    +

    2.3. Disk & file access

    diskload ( FromDisk ToMem amount – )
    @@ -593,8 +595,8 @@ fsDloadnew ( DynStr<SrcFileName> – DynHand<DataDest> )

    -
    -

    2.4. Dynamic memory

    +
    +

    2.4. Dynamic memory

    dynal ( size – handle )
    @@ -637,8 +639,8 @@ dyn. ( handle – )

    -
    -

    2.5. Graphics and text

    +
    +

    2.5. Graphics and text

    . ( n – ) print number on screen
    @@ -709,8 +711,8 @@ copyscreen ( SrcImgHandle DestImgHandle – ) copy contenc of source

    -
    -

    2.6. Math, memory & stack manipulation

    +
    +

    2.6. Math, memory & stack manipulation

    off ( n – ) writes 0 to given address, good for zeroing variable.
    @@ -773,8 +775,8 @@ abs ( n – |n| )

    -
    -

    2.7. Dynamic & static strings

    +
    +

    2.7. Dynamic & static strings

    Fifth supports both static and dynamic strings. Static strings must @@ -912,7 +914,7 @@ ex: var mystring1

    Author: Svjatoslav Agejenko

    -

    Created: 2023-09-18 Mon 01:47

    +

    Created: 2023-09-19 Tue 18:07

    Validate

    diff --git a/doc/language.org b/doc/language.org index 4d7a07a..d64d0f6 100644 --- a/doc/language.org +++ b/doc/language.org @@ -6,6 +6,7 @@ #+AUTHOR: Svjatoslav Agejenko #+LANGUAGE: en +- [[file:5TH_ET.txt][Example Fifth source file - text editor]] * Fifth source format Fifth uses a different character table and codes than ASCII (still -- 2.20.1