Began implementing the funge field
This commit is contained in:
parent
4a296c28ee
commit
9a5ff5f233
6 changed files with 135 additions and 0 deletions
64
README.md
Normal file
64
README.md
Normal file
|
@ -0,0 +1,64 @@
|
|||
# NimFunge98 : a Funge-98 interpreter written in nim
|
||||
|
||||
This repository contains code for a nim program that can interpret a valid [Funge-98](https://github.com/catseye/Funge-98/blob/master/doc/funge98.markdown) program. It will soon pass the [mycology test suite](https://github.com/Deewiant/Mycology).
|
||||
|
||||
Current limitations are :
|
||||
- it is not finished!
|
||||
- currently does not implement any fingerprints
|
||||
- does not implement concurrent execution with the `t` command
|
||||
- does not implement file I/O with the `i` and `o` commands
|
||||
- does not implement system execution with the `=` command
|
||||
|
||||
## Contents
|
||||
|
||||
- [Dependencies](#dependencies)
|
||||
- [Quick install](#quick-install)
|
||||
- [Usage](#usage)
|
||||
- [Building](#building)
|
||||
|
||||
## Dependencies
|
||||
|
||||
nim is required. Only nim version >= 1.4.8 on linux amd64 (Gentoo) is being regularly tested.
|
||||
|
||||
## Quick Install
|
||||
|
||||
To install, clone this repository then run :
|
||||
```
|
||||
nimble install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Launching the interpreter is as simple as :
|
||||
```
|
||||
nimfunge98 -f something.b98
|
||||
```
|
||||
|
||||
The interpreter will then load and execute the specified Funge-98 program until the program normally terminates or is interrupted or killed.
|
||||
|
||||
## Building
|
||||
|
||||
For a debug build, use :
|
||||
```
|
||||
nimble build
|
||||
```
|
||||
|
||||
For a release build, use :
|
||||
```
|
||||
nimble build -d:release
|
||||
```
|
||||
|
||||
To run unit tests, use :
|
||||
```
|
||||
nimble tests
|
||||
```
|
||||
|
||||
To run integration tests, use :
|
||||
```
|
||||
nimble integration
|
||||
```
|
||||
|
||||
To calculate the code coverage of tests, use :
|
||||
```
|
||||
nimble coverage
|
||||
```
|
24
nimfunge98.nimble
Normal file
24
nimfunge98.nimble
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Package
|
||||
|
||||
version = "0.1.0"
|
||||
author = "Julien Dessaux"
|
||||
description = "A Funge-98 interpreter written in nim"
|
||||
license = "EUPL-1.2"
|
||||
srcDir = "src"
|
||||
bin = @["nimfunge98"]
|
||||
|
||||
# Dependencies
|
||||
|
||||
requires "nim >= 1.4.8"
|
||||
|
||||
# Tasks
|
||||
|
||||
task integration, "Runs the test suite":
|
||||
exec "testament all"
|
||||
|
||||
task coverage, "Run all tests and calculate coverage":
|
||||
exec "coco --target 'tests/**/*.nim' --cov '!tests,!nimcache'"
|
||||
|
||||
task clean, "Clean":
|
||||
exec "rm -rf coverage lcov.info nimcache"
|
||||
exec "rm -rf outputGotten.txt testresults tests/megatest tests/megatest.nim"
|
37
src/field.nim
Normal file
37
src/field.nim
Normal file
|
@ -0,0 +1,37 @@
|
|||
type
|
||||
Line = ref object
|
||||
x, l: int
|
||||
columns: seq[int]
|
||||
|
||||
Field* = ref object
|
||||
x, y: int
|
||||
lx, ly: int
|
||||
lines: seq[Line]
|
||||
|
||||
proc get*(f: Field, x, y: int): int =
|
||||
if y >= f.y and y < f.y + f.ly:
|
||||
let l = f.lines[y-f.y]
|
||||
if x >= l.x and x < l.x + l.l:
|
||||
return l.columns[x-l.x]
|
||||
return int(' ')
|
||||
|
||||
proc isIn*(f: Field, x, y: int): bool =
|
||||
return x >= f.x and y >= f.y and x < f.x+f.lx and y < f.y+f.ly
|
||||
|
||||
when defined(unitTesting):
|
||||
let minimal = Field(
|
||||
x: 0,
|
||||
y: 0,
|
||||
lx: 1,
|
||||
ly: 1,
|
||||
lines: @[
|
||||
Line(x: 0, l: 1, columns: @[int('@')])
|
||||
]
|
||||
)
|
||||
suite "Field":
|
||||
test "Field.get":
|
||||
check minimal.get(0,0) == int('@')
|
||||
check minimal.get(1,0) == int(' ')
|
||||
test "Field.isIn":
|
||||
check minimal.isIn(0, 0) == true
|
||||
check minimal.isIn(1, 0) == false
|
5
src/nimfunge98.nim
Normal file
5
src/nimfunge98.nim
Normal file
|
@ -0,0 +1,5 @@
|
|||
import nimfunge98/field/field
|
||||
|
||||
let f:Field
|
||||
|
||||
echo f.get(3,2)
|
2
tests/config.nims
Normal file
2
tests/config.nims
Normal file
|
@ -0,0 +1,2 @@
|
|||
switch("path", "$projectDir/../src")
|
||||
switch("define", "unitTesting")
|
3
tests/testField.nim
Normal file
3
tests/testField.nim
Normal file
|
@ -0,0 +1,3 @@
|
|||
import unittest
|
||||
|
||||
include field
|
Reference in a new issue