# A [BQN](https://github.com/mlochbaum/BQN) implementation in C [CBQN-specific documentation](docs/README.md) • [source code overview](src/README.md) ## Running 1. `make` - Third-party packages and other ways to run BQN are listed [here](https://mlochbaum.github.io/BQN/running.html) - `make CC=gcc` if clang isn't installed - `make PIE=""` on ARM CPUs (incl. Android & M1) - `make FFI=0` if your system doesn't have libffi (see [macOS](#macos) for FFI support on macOS) - Use `gmake` on BSD - `make clean` if anything breaks and you want a clean build slate - Run `sudo make install` afterwards to install into `/usr/local/bin/bqn` (a `PREFIX=/some/path` argument will install to `/some/path/bin/bqn`); `sudo make uninstall` to uninstall - If you want to use custom build types but your system doesn't have `shasum`/`sha256sum`, add `force_build_dir=some_identifier`. That identifier will be used to decide on the directory for incremental build object files. 2. `./BQN somefile.bqn` to execute a file, or `rlwrap ./BQN` for a REPL ## Configuration options - Different build types: - `make o3` - `-O3`, the default build - `make o3n` - `-O3 -march=native` - `make o3g` - `-g -O3` - `make debug` - unoptimized debug build - `make debug1` - debug build without parallel compilation. Useful if everything errors, and you don't want error messages of multiple threads to be written at the same time. - `make heapverify` - verify that refcounting is done correctly - `make o3n-singeli` - a Singeli build, currently only for x86-64 CPUs supporting AVX2 & BMI2 - `make shared-o3` - produce the shared library `libcbqn.so` - `make c` - a build with no flags, for manual customizing - `make shared-c` - like `make c` but for a shared library - `make single-(o3|o3g|debug|c)` - compile everything as a single translation unit. Will compile slower & won't have incremental compilation. - For any of the above (especially `make c`), you can add extra flags with `f=...` (and linker flags with `lf=...`), e.g. `make f='-O3 -DSOME_MACRO=whatever -some_other_cc_flag' c` Macros that you may want to define are listed in `src/h.h`. - A specific build type can be cleaned by adding `clean=1` to the make argument list. Similarly, adding `builddir=1` will give you the build directory. - Tests can be run with `./BQN path/to/mlochbaum/BQN/test/this.bqn` (add `-noerr` if using `make heapverify`). - [Some implementation docs](https://github.com/dzaima/CBQN/tree/master/src#readme) ### Precompiled bytecode CBQN uses [the self-hosted BQN compiler](https://github.com/mlochbaum/BQN/blob/master/src/c.bqn) & some parts of [the runtime](https://github.com/mlochbaum/BQN/blob/master/src/r1.bqn), and therefore needs to be bootstrapped. By default, the CBQN will use [precompiled bytecode](https://github.com/dzaima/cbqnBytecode). In order to build everything from source, you need to: 1. get another BQN implementation; [dzaima/BQN](https://github.com/dzaima/BQN) is one that is completely implemented in Java (clone it & run `./build`). 2. clone [mlochbaum/BQN](https://github.com/mlochbaum/BQN). 2. From within CBQNs directory, run `mkdir -p build/bytecodeLocal/gen` 3. Run `said-other-bqn-impl ./genRuntime path/to/mlochbaum/BQN build/bytecodeLocal` In the case of the Java impl, `java -jar path/to/dzaima/BQN/BQN.jar ./genRuntime ~/git/BQN build/bytecodeLocal` ## macOS To use FFI in macOS, libffi must be installed, and manually added to `C_INCLUDE_PATH` and `LIBRARY_PATH`. In addition, the `NO_DYNAMIC_LIST=1` make argument is needed, so the full command might, depending on where libffi is installed, look like one of these: ```sh C_INCLUDE_PATH=/opt/homebrew/opt/libffi/include:$C_INCLUDE_PATH LIBRARY_PATH=/opt/homebrew/opt/libffi/lib:$LIBRARY_PATH make PIE="" NO_DYNAMIC_LIST=1 C_INCLUDE_PATH=/usr/local/opt/libffi/include:$C_INCLUDE_PATH LIBRARY_PATH=/usr/local/opt/libffi/lib:$LIBRARY_PATH make PIE="" NO_DYNAMIC_LIST=1 ``` Further configuration (different build type, compiler options, etc) can still be done by adding more make arguments. ## License Any file without an explicit copyright message is copyright (c) 2021 dzaima, GNU GPLv3 - see LICENSE