1
0
mirror of https://github.com/catseye/SixtyPical.git synced 2024-11-25 23:49:17 +00:00
SixtyPical/README.md

85 lines
3.5 KiB
Markdown
Raw Normal View History

2014-03-31 22:31:30 +00:00
SixtyPical
==========
_Version 0.18. Work-in-progress, everything is subject to change._
2018-09-05 20:36:18 +00:00
**SixtyPical** is a low-level programming language with advanced
static analysis. Many of its primitive instructions resemble
those of the 6502 CPU — in fact it is intended to be compiled to
2018-09-14 12:14:32 +00:00
6502 machine code — but along with these instructions are
constructs which ease structuring and analyzing the code. The
language aims to fill this niche:
2018-09-05 20:36:18 +00:00
* You'd use assembly, but you don't want to spend hours
debugging (say) a memory overrun that happened because of a
ridiculous silly error.
2018-09-14 12:14:32 +00:00
* You'd use C or some other "high-level" language, but you don't
want the extra overhead added by the compiler to manage the
stack and registers.
2018-09-05 20:36:18 +00:00
SixtyPical gives the programmer a coding regimen on par with assembly
language in terms of size and hands-on-ness, but also able to catch
many ridiculous silly errors at compile time, such as
* you forgot to clear carry before adding something to the accumulator
2018-09-05 20:36:18 +00:00
* a subroutine that you called trashes a register you thought it preserved
* you tried to read or write a byte beyond the end of a byte array
2015-10-22 18:20:48 +00:00
* you tried to write the address of something that was not a routine, to
a jump vector
2018-09-05 20:36:18 +00:00
Many of these checks are done with _abstract interpretation_, where we
go through the program step by step, tracking not just the changes that
happen during a _specific_ execution of the program, but _sets_ of changes
that could _possibly_ happen in any run of the program.
SixtyPical also provides some convenient operations based on
2018-03-08 15:34:28 +00:00
machine-language programming idioms, such as
2015-10-22 18:20:48 +00:00
* copying values from one register to another (via a third register when
there are no underlying instructions that directly support it); this
includes 16-bit values, which are copied in two steps
2015-10-22 18:20:48 +00:00
* explicit tail calls
* indirect subroutine calls
2018-09-05 20:36:18 +00:00
SixtyPical is defined by a specification document, a set of test cases,
and a reference implementation written in Python 2. The reference
2018-09-14 12:14:32 +00:00
implementation can analyze and compile SixtyPical programs to 6502 machine
code, which can be run on several 6502-based 8-bit architectures:
2018-09-05 20:36:18 +00:00
* Commodore 64
* Commodore VIC-20
* Atari 2600 VCS
* Apple II
2018-03-08 13:36:30 +00:00
Quick Start
-----------
If you have the [VICE][] emulator installed, from this directory, you can run
./loadngo.sh c64 eg/c64/hearts.60p
and it will compile the [hearts.60p source code](eg/c64/hearts.60p) and
automatically start it in the `x64` emulator, and you should see:
![Screenshot of result of running hearts.60p](images/hearts.png?raw=true)
2018-03-08 13:36:30 +00:00
You can try the `loadngo.sh` script on other sources in the `eg` directory
2018-03-26 12:16:53 +00:00
tree, which contains more extensive examples, including an entire
game(-like program); see [eg/README.md](eg/README.md) for a listing.
2018-03-08 13:36:30 +00:00
2018-04-18 15:46:34 +00:00
[VICE]: http://vice-emu.sourceforge.net/
Documentation
-------------
2014-04-01 13:33:57 +00:00
2017-11-21 11:13:21 +00:00
* [Design Goals](doc/Design%20Goals.md)
* [SixtyPical specification](doc/SixtyPical.md)
2017-11-21 11:13:21 +00:00
* [SixtyPical revision history](HISTORY.md)
2017-11-17 15:48:38 +00:00
* [Literate test suite for SixtyPical syntax](tests/SixtyPical%20Syntax.md)
* [Literate test suite for SixtyPical analysis](tests/SixtyPical%20Analysis.md)
* [Literate test suite for SixtyPical compilation](tests/SixtyPical%20Compilation.md)
* [Literate test suite for SixtyPical fallthru optimization](tests/SixtyPical%20Fallthru.md)
2017-11-17 15:48:38 +00:00
* [6502 Opcodes used/not used in SixtyPical](doc/6502%20Opcodes.md)
* [Output formats supported by `sixtypical`](doc/Output%20Formats.md)
2018-08-26 13:35:28 +00:00
* [TODO](TODO.md)