git.iko.soy/rowtype-yoga/purescript-native
on ba2cc5c help sign in
rowtype-yoga/purescript-native/README.md
70 lines 4.5 kB history raw
1[![PureScript](https://raw.githubusercontent.com/purescript/purescript/master/logo.png)](http://purescript.org)
3This is an experimental C++11 (or later) compiler backend for [PureScript](https://github.com/purescript/purescript). It attempts to generate "sane", debuggable, and portable C++ code as an intermediate language, which is then compiled to a native executable binary. This enables easy interoperability with existing C/C++ frameworks and libraries on a number of platforms.
5---
7### **Please note that this project supersedes [pure11](https://github.com/pure11/pure11)**
9#### Please see [changes](https://github.com/andyarvanitis/purescript-native/wiki/changes) for more details.
11---
13#### Platforms
14* Generated C++ code and resulting binary executables tested (to at least some extent) on:
15 * macOS Mojave, Xcode 10.1's clang (full test suite)
16 * Windows 10 x64 and x86, Visual Studio 2017
17 * Linux Debian 9.5 amd64, default versions of clang and gcc/g++ (full test suite)
18 * Raspberry Pi 3 B+ Raspbian official build (ARM), default versions of clang and gcc/g++
20#### Performance
22* No runtime system beyond some support classes and the standard C++11 (or later) runtime library
23* For automatic memory management, uses native C++11 reference counting (`std::shared_ptr`)
24* Uses PureScript's normal tail call optimization techniques for generated C++ code
26#### Differences from PureScript:
28* Foreign imports/exports are C++ instead of JavaScript – see [FFI notes](https://github.com/andyarvanitis/purescript-native/wiki/FFI) and [standard library foreign implementations](https://github.com/andyarvanitis/purescript-native-ffi)
29* No C++-specific REPL
31#### Other notes:
33* PureScript arrays are implemented using [`std::vector`](http://en.cppreference.com/w/cpp/container/vector)
34* `String` types are implemented with C++11 `u8` literals (UTF-8) and `std::string`
35* `Number` is C++ `double`, `Int` is C++ `int`, `Char` is `std::string` (single UTF-8 entity), `Boolean` is `bool`
37#### Future ideas:
39* Nice facilities (modules) for concurrency/parallelism, using `std::thread`, `std::async`, etc. under the hood (output is already generally thread-safe for immutable values, thanks to `std::shared_ptr`)
41#### Requirements for building the compiler itself
43* [Haskell Stack](https://docs.haskellstack.org/en/stable/README/) (if you're running macOS 10.13+, you can use pre-built binaries from [here](https://github.com/andyarvanitis/purescript-native/releases/))
45#### Requirements for using it
47* A recent version (0.12+) of [purescript](https://github.com/purescript/purescript/releases).
49* A C++11-capable toolchain, e.g. recent versions of clang, gcc, Microsoft Visual Studio
50* GNU Make is the default supported build tool, but you should be able to use your favorite C++ build system, tools, debuggers, etc.
52#### Getting Started
53This assumes you are running macOS (OS X) or a Unix-like system (Linux, *BSD, etc.).
551. Make sure you have developer tools for your system installed. For macOS, you'll need a recent version of Xcode. For Linux, etc., you can use clang 3.5 or later, or gcc/g++ 4.9.2 or later.
572. Create a working directory wherever you like, and a `src` subdirectory under it, which will be where you will place your own PureScript source files.
593. Under your working directory, also create an `ffi` subdirectory, which will be where you will place C/C++ FFI source files. You should at least add the contents of [purescript-native-ffi](https://github.com/andyarvanitis/purescript-native-ffi) into this directory, in addition to any of your own foreign implementations.
614. Generate the default GNU `Makefile` in your working directory by running `pscpp --makefile`.
635. Use PureScript's standard [`psc-package`](https://psc-package.readthedocs.io/en/latest/) utility to add and manage package dependencies.
656. You should now be ready to build a PureScript program:
66 * As stated above, place your source file(s) in the working directory's `src` subdirectory and execute `make debug` or `make release`. If your build machine has multiple cores, you might want to append `-jN` to your *make* command, where `N` is the number of cores.
68 * This will generate the C++ source tree for your program and then build an executable binary. The resulting executable will be in the `bin` subdirectory under the output directory and called `main` (so `output/bin/main`, by default). Source files will be under `src` (`output/src/` by default).
70---