Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 2.05 KB

README.md

File metadata and controls

78 lines (49 loc) · 2.05 KB
Raw

HaSOM - The Simple Object Machine implemented in Haskell

Introduction

SOM is a minimal Smalltalk dialect used to teach VM construction at the Hasso Plattner Institute. It was originally built at the University of Århus (Denmark) where it was also used for teaching.

A simple SOM Hello World looks like:

Hello = (
  run = (
    'Hello World!' println.
  )
)

This repository contains the Haskell implementation of SOM, including an implementation of the SOM standard library and a number of examples. Please see the main project page for links to the VM implementations.

Build and run

To build and run HaSOM, the Haskell Tool Stack is required.

HaSOM can be built with:

$ stack build

A simple Hello World program is executed with:

$ stack run -- -c core-lib/Smalltalk/ -c core-lib/Examples/Hello.som Hello

For more options, run the help:

$ stack run -- --help

Tests

The tests can be executed with:

$ stack run -- -c core-lib/Smalltalk/ -c core-lib/TestSuite/ TestHarness

Some of the tests terminates the VM. There is a modified test suite that excludes these test, that can be ran with:

$ stack run -- -c core-lib/Smalltalk/ -c core-lib/TestSuite/ -c TestSuite CustomTestHarness

Or with the helper script:

$ ./TestSuite/run.sh

Documentation

The documentation can be build with:

$ stack haddock

It is then available from .stack-work/dist/x86_64-linux/Cabal-3.4.1.0/doc/html/HaSOM/index.html

Directory structure

The structure of folders is as follows:

  • src/ - HaSOM source code
  • app/ - CLI for executing HaSOM
  • test/ - tests source code
  • source-tests/ - input file for golden tests
  • .golden/ - expected result for golden tests
  • core-lib/ - linked official SOM repository with standard library, examples and test suite
  • TestSuite/ - additional files for running the official test suite on HaSOM