Skip to content

Latest commit

 

History

History
76 lines (55 loc) · 4.19 KB

README.md

File metadata and controls

76 lines (55 loc) · 4.19 KB
Raw

wk-rs

Provides Rust bindings for wk.

Build requirements

You must have R available in the PATH.

Windows

You must have Rtools installed. Set the target and the linker in Cargo, for example by providing a .cargo\config.toml in the root of this crate, with

[build]
# # target-dir = "target"
target = "x86_64-pc-windows-gnu"

[target.x86_64-pc-windows-gnu]
linker = "x86_64-w64-mingw32.static.posix-gcc.exe"

Developers

BEWARE that the repository contains .vscode/settings.json, and .vscode/c_cpp_properties.json that are configured for specific needs in mind. You must adjust or comment these depending on the task you wish to do.

IMPORTANT: Mac users may want to delete the contents of .cargo/config.toml, as this specifies things necessary for building on Windows specifically.

R must be available in the PATH for the build to run, and on Windows you need to install Rtools as well.

Generate Bindings

This repo uses git submodule. If you wish to upgrade the bindings, you must update the attached modules, e.g. wk, cpp11, etc.

git submodule init
git submodule update

To regenerate bindings, run cargo build --features export_bindings. Note, that edits to the bindings must be carried over.

See also notes for more information.

vscode

Using the C/C++ Extensions by Microsoft (Extension Pack ms-vscode.cpptools-extension-pack) can provide help when reading the code.

To that end, one may set .vscode\c_cpp_properties.json with the following:

{
    "env": {
        "R_HOME": "C:\\Users\\minin\\scoop\\apps\\r\\current"
    },
    "configurations": [
        {
            "includePath": [
                "${workspaceFolder}/**",
                "${workspaceFolder}/wk/inst/include",
                "${env:R_HOME}/include"
            ],
            [REDACTED]
        }
    ],
    "version": 4
}

Meaning, one may set their R_HOME in [env] and then, the includePath should pick up R-headers and the wk headers.