F2J: A Compiler for FCore
Building from Source
The following instructions should work on any platform, from OS X to Ubuntu. It builds the compiler from source, thus may take some time.
Make sure you have installed the dependencies:
- Java SDK (8 or newer)
- Apache Ant (version 1.8 or above)
git clone https://github.com/hkuplg/fcore.git cd fcore
Quick install with stack:
You may be prompted to run
stack setup, which will automatically download the GHC compiler if needed.
After the installation, invoking
f2jin your console will show its usage. If not, you probably want to add
Building on Windows
The above instructions should automatically work on Windows.
doc directory for more details.
F2j has a few built-in compilation methods (by default, it doesn't
use any optimization), namely
- Apply: multi-argument optimization
- Stack: tail call elimination
- Unbox: auto-unboxing optimization
To use one or more of them, simply append the compilation methods you want to use as the command line arguments.
For example, say you want to use the
apply method, running the
f2j -m apply some_file
If you want to combine different methods (say,
f2j -m apply -m stack some_file
-r flag will make the compiler compile and run the
generated Java code.
There is also a REPL at your service. Simply invoking
f2ji will take
you to the REPL.
example directory, you will see a lot of example programs
written in FCore. You may want to take a look at them to get familiar
with the syntax. These examples demonstrate different features of our
compiler, such as record syntax, modules, type synonyms, etc.
examples/fractals, there is an interesting program
that draws a fractal.
If you run into any problem, try to do
If the problem persists, create an issue!
LICENSE at the top-level directory for details.