git.iko.soy/rowtype-yoga/purescript-native
on cpp help sign in
rowtype-yoga/purescript-native/README-cpp.md
43 lines 2.8 kB history raw
1### pscpp
4#### Performance
6* No runtime system beyond some support classes and the standard C++11 (or later) runtime library
7* For automatic memory management, uses native C++11 reference counting (`std::shared_ptr`)
8* Uses PureScript's normal tail call optimization techniques for generated C++ code
10#### Differences from PureScript:
12* 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-cpp-ffi)
13* No C++-specific REPL
15#### Other notes:
17* PureScript arrays are implemented using [`std::vector`](http://en.cppreference.com/w/cpp/container/vector)
18* `String` types are implemented with C++11 `u8` literals (UTF-8) and `std::string`
19* `Number` is C++ `double`, `Int` is C++ `int`, `Char` is `std::string` (single UTF-8 entity), `Boolean` is `bool`
21#### Future ideas:
23* 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`)
25#### Getting Started
26This assumes you are running macOS (OS X) or a Unix-like system (Linux, *BSD, etc.).
281. 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.
302. 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.
323. 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-cpp-ffi](https://github.com/andyarvanitis/purescript-native-cpp-ffi) into this directory, in addition to any of your own foreign implementations.
344. Generate the default GNU `Makefile` in your working directory by running `pscpp --makefile`.
365. Use PureScript's standard [`psc-package`](https://psc-package.readthedocs.io/en/latest/) utility to add and manage package dependencies.
386. You should now be ready to build a PureScript program:
39 * 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.
41 * 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).
43---