https://github.com/skx/gobasic

Go
A BASIC interpreter written in golang.

10 PRINT "GOBASIC!"

This repository contains a naive implementation of BASIC, written in Golang.

If you'd prefer to see a more "real" interpreted language, implemented in Go, you might prefer monkey.

The implementation is simple for three main reasons:

• There is no UI, which means any and all graphics-primitives are ruled out.
  • However the embedded sample, described later in this file, demonstrates using BASIC to create a PNG image.
  • There is also a HTTP-based BASIC server, also described later, which allows you to create images "interactively".
• I deliberately set a low bar for myself initially, as this was originally going to be a weekend project.
  • This is still a weekend-project, but happened over the course of a couple of hours of evening/morning time instead.
• I didn't implement the full BASIC set of primitives.
  • Although most of the commands available to the ZX Spectrum are implemented. I only excluded things relating to tape, user-defined functions, etc.

Currently the following obvious primitives work:

• END
  • Exit the program.
• GOTO
  • Jump to the given line.
• GOSUB / RETURN
  • Used to call subroutines, via line-indexes.
• IF / THEN / ELSE
  • Conditional execution.
• INPUT
  • Allow reading a string INPUT "Enter a string", a$.
  • Allow reading a number INPUT "Enter a number", a.
• LET
  • Assign a string/integer/float value to a variable.
• FOR & NEXT
  • Looping constructs.
• PRINT
  • Print a string, an integer, or variable.
  • Multiple arguments may be separated by comma.
• REM
  • A single-line comment (BASIC has no notion of multi-line comments).

Most of the maths-related primitives I'm familiar with from my days coding on a ZX Spectrum are present, for example SIN, COS, PI, ABS.

The interpreter has support for strings, and a small number of string-related primitives:

• LEN "STEVE"
  • Returns the length of a string "STEVE" (5)
• LEFT$ "STEVE", 2
  • Returns the left-most 2 characters of "STEVE" ("ST").
• RIGHT$ "STEVE", 2
  • Returns the right-most 2 characters of "STEVE" ("VE").
• CHR$ 42
  • Converts the integer 42 to a character (*). (i.e. ASCII value)
• CODE " "
  • Converts the given character to the integer value (32).

Limitations

This is a quick hack, so there are some (important) limitations:

• Only a single statement is allowed upon each line.
• Only a subset of the language is implemented.
  • I allow assignment, prints, loops, and control-flow primitives.
  • There may be omissions depending upon the BASIC dialect you're familiar with.
    • If there are primitives you miss report a bug and I'll add them :)
• Only floating-point and string values are permitted, there is no support for arrays.

The handling of the IF statement is perhaps a little unusual, since I'm used to the BASIC provided by the ZX Spectrum which had no ELSE clause!

The general form of the IF statement is:

IF $CONDITIONAL THEN $STATEMENT1 [ELSE $STATEMENT2]

Only a single statement is permitted between "THEN" and "ELSE", and again between "ELSE" and NEWLINE. These are valid IF statements:

IF 1 > 0 THEN PRINT "OK"
IF 1 > 3 THEN PRINT "SOMETHING IS BROKEN": ELSE PRINT "Weird!"

In that second example you see that ":" was used to terminate the PRINT statement, which otherwise would have tried to consume all input until it hit a newline.

You'll also notice that the primitives which are present all suffer from the flaw (?) that they don't allow brackets around their arguments. So this is valid:

10 PRINT RND 100

But this is not:

10 PRINT RND(100)

This particular problem could be fixed, but I've not considered it significant.

Installation

Providing you have a working go-installation you should be able to install this software by running:

go get -u github.com/skx/gobasic

NOTE This will only install the command-line driver, rather than the HTTP-server, or the embedded example code.

If you don't have a golang environment setup you should be able to download various binaries from the github release page:

• Binary Releases

Usage

gobasic is very simple, and just requires the name of a BASIC-program to execute. Write your input in a file and invoke gobasic with the path.

For example the following program was useful to test my implementation of the GOTO primitive:

 10 GOTO 80
 20 GOTO 70
 30 GOTO 60
 40 PRINT "Hello, world!\n"
 50 END
 60 GOTO 40
 70 GOTO 30
 80 GOTO 20

Execute it like this:

$ gobasic examples/10-goto.bas

NOTE: I feel nostalgic seeing keywords in upper-case, but PRINT and print are treated identically.

Implementation

A traditional interpreter for a scripting/toy language would have a series of well-defined steps:

• Split the input into a series of tokens ("lexing").
• Parse those tokens and build an abstract syntax tree (AST).
• Walk that tree, evaluating as you go.

As is common with early 8-bit home-computers this implementation is a little more basic:

• We parse the input into a series of tokens, defined in token/token.go
  • The parsing happens in tokenizer/tokenizer.go
• We then directly execute those tokens.
  • The execution happens in eval/eval.go with a couple of small helpers:
    • eval/for_loop.go holds a simple data-structure for handling FOR/NEXT loops.
    • eval/stack.go holds a call-stack to handle GOSUB/RETURN
    • eval/vars.go holds all our variable references.
    • We have a facility to allow golang code to be made available to BASIC programs, and we use that facility to implement a bunch of our functions.
    • Specifically we use eval/builtin-support.go to define a lot of functions in eval/builtins.go which allow BASIC to call SIN, ABS, PI, etc.
• Because we support both strings and ints/floats in our BASIC scripts we use a wrapper to hold them on the golang-side. This can be found in object/object.go.

As there is no AST step errors cannot be detected prior to the execution of programs - because we only hit them after we've started running.

Sample Code

There are a small number of sample-programs located beneath examples/. These were written in an adhoc fashion to test various parts of the implementation.

Perhaps the best demonstration of the code are the following two samples:

• examples/90-stars.bas
  • Prompt the user for their name and the number of stars to print.
  • Then print them. Riveting! Fascinating! A program for the whole family!
• examples/99-game.bas
  • A class game where you guess the random number the computer has thought of.

Embedding

The interpreter is designed to be easy to embed into your application(s) if you're crazy enough to want to do that!

You can see an example in the file embed/main.go.

The example defines several new functions which can be called by BASIC:

• PEEK
• POKE
• PLOT
• SAVE
• CIRCLE

When the script runs it does some basic variable manipulation and it also creates a PNG file - the PLOT function allows your script to set a pixel and the CIRCLE primitive draws an outline of a circle. Finally the SAVE function writes out the result.

Extending this example to draw filled circles, boxes, etc, is left as an exercise ;)

Hopefully this example shows that making your own functions available to BASIC scripts is pretty simple. (This is how SIN, COS, etc are implemented in the standalone interpreter.)

Visual BASIC!

Building upon the code in the embedded-example I've also implemented a simple HTTP-server which will accept BASIC code, and render images!

To run this:

cd goserver ; go build . ; ./goserver

Once running open your browser at the URL:

• http://localhost:8080

The view will have an area of entering code, and once you run it the result will be shown in the bottom of the screen. Something like this:

There are several included examples which you can load/launch by clicking upon them.

Bugs?

It is probable that bugs exist in this interpreter, but I've tried to do as much testing as I can. If you spot anything that seems wrong please do report an issue.

• If the interpreter segfaults that is a bug.
  • Even if the program is invalid, bogus, or malformed the interpreter should cope with it.
• If a valid program produces the wrong output then that is also a bug.

The project contain a number of test-cases, which you can execute like so:

$ go test ./...

Finally if our test-coverage drops beneath 90% that is also a bug. You can view coverage like so:

$ go test -coverprofile=c.out ./...
$ go tool cover -html=c.out

The interpreter has been fuzz-tested pretty extensively, which has resulted in some significant improvements. See FUZZING.md for details.

Steve