@@ -1,42 +1,32 @@
1[](http://purescript.org)
1[](http://purescript.org)
3−This 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.
3+This is an experimental [Go](https://golang.org) compiler backend for [PureScript](https://github.com/purescript/purescript). It attempts to generate "sane", debuggable, and portable Go code as an intermediate language, which is then compiled to a native executable binary. This enables easy interoperability with existing Go frameworks and libraries on a number of platforms.
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.
13#### Platforms
5#### Platforms
14−* Generated C++ code and resulting binary executables tested (to at least some extent) on:
6+* Generated Go code and resulting binary executables tested (to at least some extent) on:
15− * macOS Mojave, Xcode 10.1's clang (full test suite)
7+ * macOS Mojave (full test suite)
16− * Windows 10 x64 and x86, Visual Studio 2017
8+ * ~~Windows 10 x64 and x86, Visual Studio 2017~~ (pending)
17− * Linux Debian 9.5 amd64, default versions of clang and gcc/g++ (full test suite)
9+ * ~~Linux Debian X.X amd64, (full test suite)~~ (pending)
18− * Raspberry Pi 3 B+ Raspbian official build (ARM), default versions of clang and gcc/g++
10+ * ~~Raspberry Pi 3 B+ Raspbian official build (ARM)~~ (pending)
20#### Performance
12#### Performance
22−* No runtime system beyond some support classes and the standard C++11 (or later) runtime library
14+* No runtime system beyond some support types and functions
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
15+* Uses PureScript's normal tail call optimization techniques for generated Go code
26#### Differences from PureScript:
17#### 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)
19+* Foreign imports/exports are Go instead of JavaScript – see [standard library foreign implementations](https://github.com/andyarvanitis/purescript-go-ffi)
29−* No C++-specific REPL
20+* No Go-specific REPL
31#### Other notes:
22#### Other notes:
33−* PureScript arrays are implemented using [`std::vector`](http://en.cppreference.com/w/cpp/container/vector)
24+* The provided `Any` type is just an alias for `interface{}`
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`
25+* PureScript arrays are represented in Go with `[]Any`, the `String` types is `string`, `Number` is `float64`, `Int` is `int`, `Char` is `string` (single UTF-8 entity), `Boolean` is `bool`. PureScript records are rendered as `map[string]Any`.
37#### Future ideas:
27#### 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`)
29+* Nice facilities (modules) for concurrency/parallelism, using goroutines
41#### Requirements for building the compiler itself
31#### Requirements for building the compiler itself
@@ -46,25 +36,22 @@ This is an experimental C++11 (or later) compiler backend for [PureScript](https
47* A recent version (0.13+) of [purescript](https://github.com/purescript/purescript/releases).
37* A recent version (0.13+) of [purescript](https://github.com/purescript/purescript/releases).
49−* A C++11-capable toolchain, e.g. recent versions of clang, gcc, Microsoft Visual Studio
39+* The [Go toolchain](https://golang.org) for your system.
50−* GNU Make is the default supported build tool, but you should be able to use your favorite C++ build system, tools, debuggers, etc.
40+
41+* Your favorite PureScript package manager and build tools – but for simplicity these instructions will use [`spago`](https://github.com/spacchetti/spago).
52#### Getting Started
43#### Getting Started
53This assumes you are running macOS (OS X) or a Unix-like system (Linux, *BSD, etc.).
44This assumes you are running macOS (OS X) or a Unix-like system (Linux, *BSD, etc.).
55−1. 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.
57−2. 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.
46+1. 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.
59−3. 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.
61−4. Generate the default GNU `Makefile` in your working directory by running `pscpp --makefile`.
48+2. Under your working directory, clone or copy [purescript-go-ffi](https://github.com/andyarvanitis/purescript-go-ffi). Place any of your own foreign implementations into subdirectorys of your working directory, make sure your Go packages are all under a `src` directory (standard Go practice).
63−5. Use PureScript's standard [`psc-package`](https://psc-package.readthedocs.io/en/latest/) utility to add and manage package dependencies.
50+3. Initialize your project with `spago init`, and install any dependencies with `spago install` (please see their instructions if you haven't used it before).
65−6. You should now be ready to build a PureScript program:
52+4. 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.
53+ * As stated above, place your source file(s) in the working directory's `src` subdirectory and execute `spago build -- -g corefn && psgo`.
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).
55+ * This will generate the Go source tree for your program and then build an executable binary. The resulting executable will be in your working directory and will be named `Main`. The generated source files will be under `output/src/`.