Skip to content

iwillspeak/feersum

Repository files navigation

Ant in a box

(feersum . scheme)

Build Status Feersum on fuget.org

Wots in that thare box yoor holdin?

A Scheme compiler for .NET written in F#. Progress livestreamed on Twitch, catchup on YouTube

Contributing

Feersum is in active development. Contributions are welcome. See CONTRIBUTING for more imformation. For an introduction to buiding and testing the compiler, as well as a discussion of the high-level structure check out the DEVGUIDE.

Getting Started using Feersum

Feersum is distributed as a .NET tool, and MSBuild SDK. For quick use with an interactive REPL and simple compilation the tool can be installed directly:

$ dotnet tool install -g Feersum

Then from the command line feersum-scheme should launch a Scheme REPL. Type in Scheme code to have it compiled and evaluated. To compile a file into a simple executable run feersum-scheme yourfile.scm. This will produce a new file yourfile.exe which can then be run by dotnet yourfile.exe.

To create an SDK style scheme project and build it with dotnet build first install the Feersum.Templates template pack:

$ dotnet new --install Feersum.Templates::*

Then from the command line:

$ dotnet new scm-console --language Scheme

This generates a new console application project in the current directory. Compile and run with dotnet build and dotnet run as usual! Other templates are available:

  • scm-classlib - Generate a .NET class library project.
  • scmlib - Generate s Scheme library definition file.

Planned Features

This is a rough list of interesting features I'd like to implement in this project, and is by no means a guarantee or a strict roadmap.

  • Implement all special forms
  • Support all value types
  • Support all standard procedures
  • Macros support.
    • Macro Hygene (#13).
  • Support for Scheme exceptions and guard.
  • Full numeric tower support.
  • Interop with other .NET assemblies.
  • Multi-statement support in the REPL.
  • Debugging support
    • Bound tree contains sequence points for debuging
    • Debuggable REPL. Embedded source in PDBs?
    • Stop at entry, and step in.
  • MSBUILD SDK support so .scmproj can be defined.
    • Proper support for different target frameworks
  • Scheme library and import support.
  • Standard library & builtins from a separate assembly.
  • Quoted expressions.
  • Diagnostics with position
    • Expose position information in parser.
    • Handle multiple parser errors.
    • Turn errors in bind into diagnotics too.
  • Perform on-demand compilation & emit to in-memory assembly for REPL.

Future themes of development are also tracked with Roadmap issues on GitHub.