prog8/README.md

131 lines
5.1 KiB
Markdown
Raw Normal View History

2019-06-21 21:22:34 +00:00
[![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/irmen)
[![Build Status](https://travis-ci.org/irmen/prog8.svg?branch=master)](https://travis-ci.org/irmen/prog8)
2018-09-15 14:21:05 +00:00
Prog8 - Structured Programming Language for 8-bit 6502/6510 microprocessors
===========================================================================
2017-12-21 13:52:30 +00:00
2018-01-09 23:44:11 +00:00
*Written by Irmen de Jong (irmen@razorvine.net)*
2017-12-21 13:52:30 +00:00
2018-01-08 02:31:23 +00:00
*Software license: GNU GPL 3.0, see file LICENSE*
2017-12-25 15:00:25 +00:00
2018-09-15 14:21:05 +00:00
This is a structured programming language for the 8-bit 6502/6510 microprocessor from the late 1970's and 1980's
as used in many home computers from that era. It is a medium to low level programming language,
2017-12-25 15:00:25 +00:00
which aims to provide many conveniences over raw assembly code (even when using a macro assembler):
- reduction of source code length
- modularity, symbol scoping, subroutines
- various data types other than just bytes (16-bit words, floats, strings)
2019-08-14 20:28:44 +00:00
- automatic variable allocations, automatic string and array variables and string sharing
- subroutines with a input- and output parameter signature
- constant folding in expressions
2019-06-21 21:41:20 +00:00
- conditional branches
2019-08-14 20:28:44 +00:00
- 'when' statement to provide a concise jump table alternative to if/elseif chains
2019-07-12 17:01:36 +00:00
- structs to group together sets of variables and manipulate them at once
2019-08-14 20:28:44 +00:00
- floating point operations (requires the C64 Basic ROM routines for this)
- abstracting away low level aspects such as ZeroPage handling, program startup, explicit memory addresses
2019-07-23 22:43:37 +00:00
- various code optimizations (code structure, logical and numerical expressions, unused code removal...)
- inline assembly allows you to have full control when every cycle or byte matters
2019-08-17 23:39:48 +00:00
- many built-in functions such as ``sin``, ``cos``, ``rnd``, ``abs``, ``min``, ``max``, ``sqrt``, ``msb``, ``rol``, ``ror``, ``swap``, ``memset``, ``memcopy``, ``sort`` and ``reverse``
2019-06-21 21:41:20 +00:00
Rapid edit-compile-run-debug cycle:
2020-02-09 00:33:20 +00:00
- use modern PC to work on
2019-08-14 20:28:44 +00:00
- quick compilation times (seconds)
2020-02-09 00:33:20 +00:00
- option to automatically run the program in the Vice emulator
2017-12-27 22:45:22 +00:00
- breakpoints, that let the Vice emulator drop into the monitor if execution hits them
- source code labels automatically loaded in Vice emulator so it can show them in disassembly
2019-08-14 20:28:44 +00:00
- virtual machine that can execute compiled code directy on the host system,
2020-02-09 00:33:20 +00:00
without having to actually convert it to assembly to run on a real 6502
2017-12-25 15:00:25 +00:00
2019-01-26 17:41:25 +00:00
It is mainly targeted at the Commodore-64 machine at this time.
2019-06-21 21:41:20 +00:00
Contributions to add support for other 8-bit (or other?!) machines are welcome.
2017-12-25 15:00:25 +00:00
2019-08-10 19:38:08 +00:00
Documentation/manual
--------------------
2020-02-09 00:33:20 +00:00
This describes the language, but also how to build and run the compiler. See https://prog8.readthedocs.io/
2019-01-26 17:56:53 +00:00
2019-08-10 19:38:08 +00:00
Required tools
--------------
2017-12-25 15:00:25 +00:00
2019-01-26 17:59:14 +00:00
[64tass](https://sourceforge.net/projects/tass64/) - cross assembler. Install this on your shell path.
A recent .exe version of this tool for Windows can be obtained from my [clone](https://github.com/irmen/64tass/releases) of this project.
2019-01-26 17:41:25 +00:00
For other platforms it is very easy to compile it yourself (make ; make install).
2019-06-21 21:41:20 +00:00
A **Java runtime (jre or jdk), version 8 or newer** is required to run a prepackaged version of the compiler.
If you want to build it from source, you'll need a Java SDK + Kotlin 1.3.x SDK (or for instance,
2019-01-26 17:41:25 +00:00
IntelliJ IDEA with the Kotlin plugin).
It's handy to have a C-64 emulator or a real C-64 to run the programs on. The compiler assumes the presence
2019-01-26 17:59:14 +00:00
of the [Vice emulator](http://vice-emu.sourceforge.net/)
2019-01-26 17:41:25 +00:00
Example code
------------
2019-04-12 20:34:43 +00:00
This code calculates prime numbers using the Sieve of Eratosthenes algorithm::
2019-01-26 17:41:25 +00:00
%import c64utils
2019-04-12 20:34:43 +00:00
%zeropage basicsafe
2019-01-26 17:41:25 +00:00
2019-08-05 19:11:58 +00:00
main {
2019-04-12 20:34:43 +00:00
ubyte[256] sieve
ubyte candidate_prime = 2
2019-01-26 17:41:25 +00:00
sub start() {
2019-04-12 20:34:43 +00:00
memset(sieve, 256, false)
c64scr.print("prime numbers up to 255:\n\n")
ubyte amount=0
while true {
ubyte prime = find_next_prime()
if prime==0
break
c64scr.print_ub(prime)
c64scr.print(", ")
amount++
}
c64.CHROUT('\n')
c64scr.print("number of primes (expected 54): ")
c64scr.print_ub(amount)
2019-01-26 17:41:25 +00:00
c64.CHROUT('\n')
}
2019-04-12 20:34:43 +00:00
sub find_next_prime() -> ubyte {
while sieve[candidate_prime] {
candidate_prime++
if candidate_prime==0
return 0
}
sieve[candidate_prime] = true
uword multiple = candidate_prime
while multiple < len(sieve) {
sieve[lsb(multiple)] = true
multiple += candidate_prime
}
return candidate_prime
}
}
2019-01-26 17:45:17 +00:00
2019-04-12 20:34:43 +00:00
when compiled an ran on a C-64 you'll get:
2019-01-26 17:41:25 +00:00
2019-04-12 20:34:43 +00:00
![c64 screen](docs/source/_static/primes_example.png)
2019-01-26 18:13:42 +00:00
One of the included examples (wizzine.p8) animates a bunch of sprite balloons and looks like this:
![wizzine screen](docs/source/_static/wizzine.png)
Another example (cube3d-sprites.p8) draws the vertices of a rotating 3d cube:
![cube3d screen](docs/source/_static/cube3d.png)
2019-03-10 04:38:14 +00:00
If you want to play a video game, a fully working Tetris clone is included in the examples:
![tehtriz_screen](docs/source/_static/tehtriz.png)