boriel-basic · boriel · Apr 3, 2019 · Oct 18, 2017 · Oct 18, 2017 · Oct 18, 2017
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,4 +1,4 @@
 [bumpversion]
-current_version = 1.6.9
+current_version = 1.8.9
 files = version.py
 
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,3 @@
+[run]
+omit =
+    .tox/*
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,18 @@
+
+* text=false
+
+*.bas -crlf
+*.asm -crlf
+*.bi -crlf
+
+*.txt text
+*.md text
+*.py text
+*.ini text
+*.yml text
+
+*.png binary
+
+*.bas linguist-vendored
+*.asm linguist-vendored
+
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 *.egg-info/
 *.pyc
 .cache/
+.pytest_cache/
 .idea/
 .python-version
 .tox/
@@ -16,3 +17,5 @@ dist/
 examples/*.bin
 examples/*.tzx
 scratch/
+.coverage
+htmlcov/
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 language: python
 python:
   # - "2.7" <- Unsupported, uses 2.7.9 ?
-  - "3.5"
+  - "3.6"
   # PyPy versions
   # - "pypy"  # PyPy2 2.5.0
   # - "pypy3" # Pypy3 2.4.0

diff --git a/ChangeLog b/ChangeLog
@@ -1,7 +1,107 @@
+================================================================
+Changes from Version 1.8.8 to 1.8.9
+! Bugfix: Crash in READ and DATA sentences under some cases
+! Bugfix: Fix INT to behave like the original one (Round to -INF)
+! Bugfix: --array-check was not working properly. Fixed!
+
+================================================================
+Changes from Version 1.8.7 to 1.8.8
+! Bugfix: fix 32 bit operations (DIV, MOD...)
+
+================================================================
+Changes from Version 1.8.6 to 1.8.7
+! Bugfix: do not remove ASM blocks (optimize)
+
+================================================================
+Changes from Version 1.8.5 to 1.8.6
+! Bugfix: END instruction was not returning result. Fixed.
+
+================================================================
+Changes from Version 1.8.4 to 1.8.5
+! Bugfix: crash on bad array declaration
+
+================================================================
+Changes from Version 1.8.3 to 1.8.4
+! Several bugfixes with contants declaration
++ Suport for UTF-8 BOM files
+! Bugfixes with -O3 crash
+! Fixes crash with arrays
+! Other bugfixes and better stability
+* Better warning explanation under some circumstances
+
+================================================================
+Changes from Version 1.8.2 to 1.8.3
+! Bugfix in the peephole optimizer (-O2)
+! Several bugfixes to improve stability
++ Optimization in the peephole optimizer (-O1)
++ Support for extended array str element operations
+! Other syntax bugfixes
+
+================================================================
+Changes from Version 1.8.1 to 1.8.2
+! Bugfixes in the peephole optimizer
++ Shorter and faster generated code (deep optimizations)
+! Bugfix in the PRINT42 routine that now supports newlines, etc
++ Implemented routine input42 (INPUT42.BAS) for PRINT42 mode
+
+================================================================
+Changes from Version 1.8.0 to 1.8.1
+! Bugfixes in the peephole optimizer
+! Bugfix in OUT instruction
++ Fixes minor errors and bugs (i.e. --enable-break)
++ Improved and faster generated code (IN, OUT, AND, check BREAK...)
+* Added basic.bas library (meta-interpreter) and eval.bas example!!
+  (thanks to @mcleod_ideafix!!!)
+
+================================================================
+Changes from Version 1.7.2 to 1.8.0
+! Bugfixes in the peephole optimizer (-O3)
++ Better optimized code
++ Improved compiling speed and more stability
++ Fixes minor errors and bugs
++ Now single line IF sentences does not require END IF
+
+================================================================
+Changes from Version 1.7.1 to 1.7.2
+! Bugfixes in libraries esxdos.bas and memcopy.bas
+* Improved pong.bas example
+* Improved readme file :) (thanks to @harko and @haplo)
+
+================================================================
+Changes from Version 1.7.0 to 1.7.1
+! Bugfixes with -O3 and DATA statements
+* Little improvements
+* Updates README.md and added TESTING.md
+
+================================================================
+Changes from Version 1.6.13 to 1.7.0
++ Added READ, DATA, RESTORE (finally!)
++ Allows to call SUBs with no parenthesis (e.g. mySUB 1, 2+a)
++ Allows to call FUNCTIONS with 1 or no params with no parenthesis
++ Some bug fixes for better stability
+
+================================================================
+Changes from Version 1.6.12 to 1.6.13
+! Fixes and improves strict mode checking
++ Adds #error and #warning directives
+
+================================================================
+Changes from Version 1.6.11 to 1.6.12
++ Adds missing default font (Haplo) for Radastan mode
+! Bugfixes and little improvements
+
+================================================================
+Changes from Version 1.6.10 to 1.6.11
+! Fix infinite recursive include in Windows (yes, win sucks)
+* Little optimizations in memset and rnd
+* Standarize file includes like in cpp
+
 ================================================================
 Changes from Version 1.6.9 to 1.6.10
-* Added UART library (by yomboprime) for serial communication 
-* Several bugfixes and minor errors
++ Added many more drawing primitives for Radastan Mode
++ Added instructions ON .. GOTO and ON .. GOSUB
++ Added UART library (by yomboprime) for serial communication 
+! Several bugfixes and minor errors and better stability
 * Better code generation
 * Allows array initialization with @label references
 * Switch .bas libraries (not the compiler) to MIT license
@@ -56,6 +156,19 @@ and attribute traversal which depends on the symbolTYPE being parsed.
 e.g. for symbolBINARY (binary expressions), we have node.left, node.right,
 node.operand, but also node.children[0], node.children[1].
 
+===From Version 1.2.9 to 1.3.0===
+* ! Fixed a bug in USR <string>
+* ! Fixed a bug in SAVE / LOAD
+* ! Fixed a serious bug in the preprocessor
+* ! Fixed a bug with DIM and constants
+* ! Fixed a bug with SHL/SHR for 0 shifts
+* + Added -D option. ZXBASIC now allows commandline macro definition
+* ! Fixed a bug with CODE and INKEY$
+* ! Fixed a bug with string slicing assignation (e.g. a$(3) = "x")
+* ! Fixed a bug with arrays of integer assignation (e.g. a(3) = 5, being a of Integer type)
+* ! Fixed a bug with peephole optimizer (-O3)
+* * Some changes and code refactorization towards 2.x branch
+
 ================================================================
 Changes from Version 1.2.8 to 1.2.9
 

diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
+![Boriel ZX Basic](./zxbasic_logo.png)
+
 [![Build Status](https://travis-ci.org/boriel/zxbasic.svg?branch=master)](https://travis-ci.org/boriel/zxbasic)
+[![license](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.txt)
+[![pyversions](https://img.shields.io/pypi/pyversions/zxbasic.svg)](https://pypi.python.org/pypi/zxbasic)
 
 ZX BASIC
 --------
@@ -30,43 +34,70 @@ For help, support, updates meet the community at my forum:
 <http://www.boriel.com/forum/zx-basic-compiler>
 
 
-INSTALL
--------
+INSTALLATION
+------------
 
 Go to the ZXBasic download page <http://www.boriel.com/wiki/en/index.php/ZX_BASIC:Archive>
-and get the version most suitable for you. 
+and get the version most suitable for you.
 
-These tools are completely written in python, so you will need a python
-interpreter (available on many platforms). Just copy them in a directory of your
-hoice and installation is done. :-)
+There are, basically, two flavors (both with identical capabilities):
 
-For Windows users there is also a binary .MSI installation, which does not need
-python installed.
+ - For Windows you can download de win32 executable (Windows .exe zip package) version. 
+To install just uncompress it in a directory of your choice.
+The main executable is `zxb.exe` (more on this later). With this toolchain
+also comes `zxbasm.exe` (the assembler) and `zxbpp.exe` (the preprocessor), but these 
+are not needed when programming in BASIC.
 
+ - For Linux and Mac OSX there is a python version, so you will need a python
+interpreter (available on many platforms, and usually already installed in Linux and Mac OSX).
+Just uncompress it in a directory of your choice and installation is done. :-)
+The main executables are `zxb.py` (the compiler), `zxbasm.py` (the assembler) and `zxbpp.py` (the preprocessor).
+You can use this version in Windows, but will need to install a python interpreter first.
 
-TESTING
--------
+##### Examples
 
-You will need to get Tox in order to run the project tests. Normally it is done
-by calling:
 
-~~~~
-$ pip install tox
-~~~~
+|![Eleuterio, el mono serio](http://www.boriel.com/wiki/en/images/a/ab/EleuterioElMonoSerio.gif)|![El Hobbit](http://www.boriel.com/wiki/en/images/7/72/HobbitEl.gif)|![Knight & Demonds DX](http://www.boriel.com/wiki/en/images/f/fe/KnightsDemonsDX.png)|
+|---|---|---|
+| An in-game screenshot of Eleuterio by @*na_th_an* | Ingame screenshot of _El Hobbit_ by @*Wilco2000*| Ingame screenshot of _Knignt and Demonds DX_ by Einar Saukas
+
+See more examples at http://www.boriel.com/wiki/en/index.php/ZX_BASIC:Released_Programs
 
-inside a Virtual Environment ( https://virtualenv.pypa.io/en/stable/ ).
+QUICK START
+-----------
 
-Please, see https://tox.readthedocs.io/en/latest/install.html for more
-information about installing Tox.
+For a quick start, just open a terminal in your PC in the same directory you uncompressed ZX Basic
+and type `zxb` (on Windows) or `zxb.py` (OSX, Linux). You should see a zxbasic message like this:
 
-Once you have installed Tox, just call:
+```
+usage: zxb [-h] [-d] [-O OPTIMIZE] [-o OUTPUT_FILE] [-T] [-t] [-B] [-a] [-A]
+           [-S ORG] [-e STDERR] [--array-base ARRAY_BASE]
+           [--string-base STRING_BASE] [-Z] [-H HEAP_SIZE] [--debug-memory]
+           [--debug-array] [--strict-bool] [--enable-break] [-E] [--explicit]
+           [-D DEFINES] [-M MEMORY_MAP] [-i] [-I INCLUDE_PATH] [--strict]
+           [--version]
+           PROGRAM
+zxb: error: the following arguments are required: PROGRAM
+```
+
+Create a text file with the following content:
+
+~~~~
+10 CLS
+20 PRINT "HELLO WORLD!"
+~~~~
 
+Save it as `hello.bas` and finally compile it with:
 ~~~~
-$ tox
+zxb -taB hello.bas
 ~~~~
 
-to get your tests running.
+If everything went well, a file named `hello.tap` should be created.
+Open it with your favourite emulator (i.e. fuse) and see the result.
 
+Congratulations! You're now ready to create compiled BASIC programs for
+your machine. Check and compile the examples included in the examples/ folder
+or go to the Wiki <http://zxbasic.net> for further info.
 
 AKNOWLEDGEMENTS
 ---------------

diff --git a/TESTING.md b/TESTING.md
@@ -0,0 +1,32 @@
+TESTING
+-------
+
+This instructions are for TDD (Test Drive Development) the compiler and are intended
+for developing the compiler internals, and checks for bugs in it.
+
+You **DONT** need to do this to compile BASIC.
+
+You are required to be familiar not only with python, but also with the python 
+ecosystem (virtualenvs, tox, py.test).
+
+You will need to get Tox in order to run the project tests. Normally it is done
+by calling:
+
+~~~~
+$ pip install tox
+~~~~
+
+Inside a Virtual Environment of your choice ( https://virtualenv.pypa.io/en/stable/ ).
+
+Please, see https://tox.readthedocs.io/en/latest/install.html for more
+information about installing Tox.
+
+Once you have installed Tox, just call:
+
+~~~~
+$ tox
+~~~~
+
+to get your tests running.
+
+This tox config also supports detox (parallel tox testing).
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    [run]
+    omit =
+        .tox/*