diff --git a/Makefile b/Makefile index 60b4922..86df6a6 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ msp430: AR := msp430-elf32-ar msp430: CXXFLAGS += -Os -mmcu=msp430g2553 -ffunction-sections -fdata-sections msp430: CXXFLAGS += -DMEMDICTSIZE=200 msp430: LDFLAGS += -L/opt/msp430-elf32/include -Wl,-gc-sections -msp430: alee-msp430 +msp430: clean-lib alee-msp430 small: CXXFLAGS += -Os small: alee @@ -37,9 +37,12 @@ core.fth.h: alee.dat alee.dat: alee core.fth echo "2 sys" | ./alee core.fth -clean: +clean: clean-lib rm -f alee alee-msp430 alee-standalone - rm -f $(LIBFILE) $(OBJFILES) alee.dat core.fth.h + rm -f alee.dat core.fth.h -.PHONY: all msp430 small fast standalone clean +clean-lib: + rm -f $(LIBFILE) $(OBJFILES) + +.PHONY: all msp430 small fast standalone clean clean-lib diff --git a/README.md b/README.md index 4f81e0e..e41b628 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,33 @@ # Alee Forth -**Still very much in development! Not suitable for real applications yet.** - -Alee is a portable and concise Forth implementation in modern C++. Its primary aims are for reduced program size and execution efficiency. Portability includes bare-metal platforms, with intentions to support microcontrollers with kilobytes of memory. +Alee is a concise Forth implementation written in modern C++ that aims for portability, minimal program size, and execution efficiency. ## Cross-platform compatibility -Alee relies on the C++17 standard. Alee *does not* rely on operating-system-specific functions, making portability easy. See the `msp430` target for an example of a port. +Alee relies on the C++17 standard. Alee *does not* rely on operating-system-specific functions, making portability easy. + +The goal of portability extends down to microcontroller targets with kilobytes of memory. See the `msp430` target for an example of a port. -System-specific functionality such as text output is contained to a `sys` word. This word calls a user-supplied `user_sys` C++ function that should implement the necessary (or any additional) system-specific functionality. +System-specific functionality is obtained through a `sys` Forth word. This word calls a user-supplied C++ function that implements the necessary (or any additional) functionality. # Forth compatibility -A base dictionary is being built by working through the "core" and "core extension" [glossaries](https://forth-standard.org/standard/core). These glossaries are listed in `compat.txt`, with "yes" indicating that the word is implemented either in `core.fth` or within Alee itself. `core.fth` may be compiled into a binary for loading on targets without filesystems. +Alee implements a large majority of the "core" and "core extension" [glossaries](https://forth-standard.org/standard/core). Implementation is tracked in `compat.txt`, with missing words listed below. Fundamental words are built into Alee (written in C++); the rest of the implementation is in `core.fth`. + +This means Alee should be executed as `alee core.fth` to include these words. Alternatively, the `standalone` target packages the `core.fth` dictionary into the program. -Alee Forth aims for compliance with common Forth standards like Forth 2012 and ANS Forth. Compliance is tested using a [Forth 2012 test suite](https://github.com/gerryjackson/forth2012-test-suite). Supported test files are in the `test` directory, with non-passing or unimplemented tests commented out. +**Missing** core features: +* Pictured numeric output conversion `<# #>` +* Words for unsigned integers: `U. U< UM* UM/MOD` +* `>NUMBER` +* `FIND` + +**Missing** core extensions: +``` +.R HOLDS PAD PARSE PARSE-NAME REFILL RESTORE-INPUT S\" SAVE-INPUT SOURCE-ID U.R U> UNUSED WITHIN [COMPILE] +``` + +Alee aims for compliance with common Forth standards like Forth 2012 and ANS Forth. Compliance is tested using a [Forth 2012 test suite](https://github.com/gerryjackson/forth2012-test-suite). Supported test files are in the `test` directory, with tests for unimplemented words commented out. ## Building @@ -22,5 +35,9 @@ Alee requires `make` and a C++17-compatible compiler. To compile, simply run the `make` command. This will produce a library, `libalee.a`, as well as a REPL binary named `alee`. A `small` target exists that optimizes the build for size. -A `fast` target exists that optimizes for maximum performance on the host (not target) system. +A `fast` target exists that optimizes for maximum performance on the host system. +The `standalone` target will produce a `alee-standalone` binary that contains and pre-loads the core dictionary. +The `msp430` target builds Alee for the [MSP430G2553](https://www.ti.com/product/MSP430G2553) microcontroller. Like `standalone`, the core dictionary is built into the binary. + +Configurable constants and types are defined either in the Makefile or in `types.hpp`. diff --git a/alee-msp430.cpp b/alee-msp430.cpp index 00151f0..7c82c03 100644 --- a/alee-msp430.cpp +++ b/alee-msp430.cpp @@ -17,10 +17,12 @@ */ #include "alee.hpp" -#include "memdict.hpp" +#include "splitmemdict.hpp" #include +#include "core.fth.h" + static char strbuf[32]; static void readchar(State& state); @@ -47,15 +49,10 @@ int main() __enable_interrupt(); - static MemDict dict; + static SplitMemDict dict (alee_dat); State state (dict, readchar); Parser parser; - dict.write(Dictionary::Base, 10); - dict.write(Dictionary::Latest, Dictionary::Begin); - dict.write(Dictionary::Compiling, 0); - dict.write(Dictionary::Postpone, 0); - serputs("alee forth\n\r"); auto ptr = strbuf;