https://github.com/hongyuanjia/porter

Generate Port Files for Foreign Function Interface for C Libraries in R
https://github.com/hongyuanjia/porter

Last synced: about 1 month ago
JSON representation

Generate Port Files for Foreign Function Interface for C Libraries in R

• Host: GitHub
• URL: https://github.com/hongyuanjia/porter
• Owner: hongyuanjia
• License: other
• Created: 2023-08-01T07:43:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-13T15:11:21.000Z (over 1 year ago)
• Last Synced: 2024-10-13T19:09:00.609Z (2 months ago)
• Language: R
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

library(porter)

```

# porter

The goal of {porter} is to generate port files for [rdyncall](https://github.com/hongyuanjia/rdyncall)

to support Foreign Function Interface (FFI) for C Libraries in R. It uses

[CastXML](https://github.com/CastXML/CastXML), a C-family abstract syntax tree

XML output tool to parse C header files.

## Installation

You can install the development version of porter like so:

``` r

remotes::install_github("hongyuanjia/port")

```

## Example

### Manage CastXML installation

You can use `install_castxml()` to install CastXML. It downloads the pre-built

binaries of CastXML together with the LLVM/Clang dependencies via the

[CastXML Superbuild](https://github.com/CastXML/CastXMLSuperbuild) project.

`locate_castxml()` will return the current CastXML in use:

```{r example, eval = FALSE}

install_castxml("latest")

locate_castxml()

#>                                         0.5.0

#> "C:\\Users\\hongy\\scoop\\shims\\castxml.exe"

```

Instead of using `install_castxml()`, you may directly use your package manager

to install CastXML, as it may already provide a `castxml` package.

- On Windows, you can use [Scoop](https://scoop.sh/) to install CastXML via:

  `scoop install main/castxml`

- On macOS, you can use [Homebrew](https://brew.sh/) to install CastXML via:

  `brew install castxml`

- On Linux, you can check if your system package manager provides CastXML or

  not via [Repology](https://repology.org/project/castxml/versions).

### Generate port files for C libraries

Take the [SDL2](https://www.libsdl.org/) library as an example. After

downloading the SDL2 [source](https://github.com/libsdl-org/SDL/releases), run

`port()` with the path of SDL2 header file (here `dir` is directory of SDL2

source):

```{r sdl2}

version <- "2.28.0"

dir <- file.path(tempdir(), paste0("SDL2-", version))

if (!dir.exists(dir)) {

  zipfile <- porter:::download_src_sdl2(version)

  unzip(zipfile, exdir = tempdir())

}

```

```{r port}

p <- port(file.path(dir, "include", "SDL.h"))

p <- port_set(p,

  Package = "SDL2",

  Version = "2.28.0",

  Library = c("SDL", "SDL-2.28", "SDL-2.28.so.0")

)

p

```

Use `port_write()` to save the port file.

```{r write}

port_write(p, file.path(tempdir(), "SDL2.dynport"))

```

## Author

Hongyuan Jia

## License

The project is released under the terms of MIT License.

Copyright © 2023 Hongyuan Jia