Access a compiled FFI symbol

Description

Overrides $ to detect dead pointers after deserialization and recompile transparently from the stored recipe.

Usage

## S3 method for class 'tcc_compiled'
x$name

Arguments

Value

The callable function or metadata field

we are using .Call directly, this is to make R CMD check happy

Description

we are using .Call directly, this is to make R CMD check happy

Usage

.RtinyccCall()

Value

The result returned by the invoked native routine. This alias is package-internal and exists to satisfy ⁠R CMD check⁠ native routine registration requirements.

Convert a tcc_cstring object to an R string

Description

Convert a tcc_cstring object to an R string

Usage

## S3 method for class 'tcc_cstring'
as.character(x, ...)

Arguments

Value

A character scalar containing the string value. Returns the cached R copy when available; otherwise reads the current NUL-terminated C string from x$ptr.

Report active BLAS/LAPACK runtime information from R

Description

Returns the BLAS/LAPACK runtime details as reported by R itself, plus convenience flags indicating whether Rblas and Rlapack appear available in loaded DLLs/shared objects.

Usage

blas_lapack_info()

Value

A named list with fields: blas_path, lapack_path, has_rblas, has_rlapack, loaded_dlls.

Generate trampoline code for a callback argument

Description

Generate trampoline code for a callback argument

Usage

generate_trampoline(trampoline_name, sig)

Arguments

Value

C code string for the trampoline

Get the address of an external pointer

Description

Extract the memory address from an external pointer as a numeric value. This is primarily useful for debugging and inspection purposes.

Usage

get_external_ptr_addr(ptr)

Arguments

Value

The memory address as a numeric value.

Check if a type represents a callback

Description

Check if a type represents a callback

Usage

is_callback_type(type)

Arguments

Value

Logical

Parse callback type specification

Description

Parse callback type specification

Usage

parse_callback_type(type)

Arguments

Value

Parsed signature list or NULL

Print tcc_callback object

Description

Print tcc_callback object

Usage

## S3 method for class 'tcc_callback'
print(x, ...)

Arguments

Value

The input tcc_callback object, invisibly. Called for its side effect of printing the callback signature, thread-safety flag, and validity status.

Print tcc_compiled object

Description

Print tcc_compiled object

Usage

## S3 method for class 'tcc_compiled'
print(x, ...)

Arguments

Value

The input tcc_compiled object, invisibly. Called for its side effect of printing the compilation output mode and the status of compiled callable symbols.

Print a tcc_cstring object

Description

Print a tcc_cstring object

Usage

## S3 method for class 'tcc_cstring'
print(x, ...)

Arguments

Value

The input tcc_cstring object, invisibly. Called for its side effect of printing the current string value.

Print tcc_ffi object

Description

Print tcc_ffi object

Usage

## S3 method for class 'tcc_ffi'
print(x, ...)

Arguments

Value

The input tcc_ffi object, invisibly. Called for its side effect of printing the configured output mode, registered symbols, and selected libraries/include paths.

Add a source file to a libtcc state

Description

Add a source file to a libtcc state

Usage

tcc_add_file(state, path)

Arguments

Value

Integer status code (0 = success).

Add an include path to a libtcc state

Description

Add an include path to a libtcc state

Usage

tcc_add_include_path(state, path)

Arguments

Value

Integer status code (0 = success).

Add a library to a libtcc state

Description

Add a library to a libtcc state

Usage

tcc_add_library(state, library)

Arguments

Value

Integer status code (0 = success).

Add a library path to a libtcc state

Description

Add a library path to a libtcc state

Usage

tcc_add_library_path(state, path)

Arguments

Value

Integer status code (0 = success).

Add a symbol to a libtcc state

Description

Add a symbol to a libtcc state

Usage

tcc_add_symbol(state, name, addr)

Arguments

Value

Integer status code (0 = success).

Add a system include path to a libtcc state

Description

Add a system include path to a libtcc state

Usage

tcc_add_sysinclude_path(state, path)

Arguments

Value

Integer status code (0 = success).

Bind symbols with type specifications

Description

Define symbols with Bun-style type specifications for API mode. This is the core of the declarative FFI API.

Usage

tcc_bind(ffi, ...)

Arguments

Value

Updated tcc_ffi object (for chaining)

Examples

ffi <- tcc_ffi() |>
  tcc_bind(
    add = list(args = list("i32", "i32"), returns = "i32"),
    greet = list(args = list("cstring"), returns = "cstring")
  )

Call a zero-argument symbol with a specified return type

Description

Call a zero-argument symbol with a specified return type

Usage

tcc_call_symbol(state, name, return = c("int", "double", "void"))

Arguments

Value

The return value cast to the requested type (NULL for void).

Register an R function as a callback

Description

Wraps an R function so it can be passed as a C function pointer to compiled code. The callback will be invoked via a trampoline that marshals arguments between C and R.

Usage

tcc_callback(fun, signature, threadsafe = FALSE)

Arguments

Details

Thread safety: callbacks are executed on the R main thread only. Invoking a callback from a worker thread is unsupported and may crash R. The threadsafe flag is currently informational only.

If a callback raises an error, a warning is emitted and a type-appropriate default value is returned.

When binding callbacks with tcc_bind(), use a ⁠callback:<signature>⁠ argument type so a synchronous trampoline is generated. The trampoline expects a ⁠void*⁠ user-data pointer as its first argument; pass tcc_callback_ptr(cb) as the user-data argument to the C API. For thread-safe usage from worker threads, use ⁠callback_async:<signature>⁠ which schedules the call on the main thread and returns a default value.

Pointer arguments (e.g., double*, int*) are passed as external pointers. Lengths must be supplied separately if needed.

The return type may be any scalar type supported by the FFI mappings (e.g., i32, f64, bool, cstring), or SEXP to return an R object directly.

Callback lifetime: callbacks are eventually released by finalizers and package unload. Call tcc_callback_close() when you want deterministic invalidation and earlier release of the preserved R function.

Value

A tcc_callback object (externalptr wrapper)

Drain the async callback queue

Description

Execute any pending async callbacks immediately on the main R thread. Normally callbacks fire automatically via R's event loop (input handler on POSIX, message pump on Windows), so explicit draining is only needed in test harnesses or tight batch loops that never yield to R's event loop.

Usage

tcc_callback_async_drain()

Details

TCC-compiled C code running on the main thread can call RC_callback_async_drain_c() directly instead of returning to R.

Value

NULL (invisible)

Schedule a callback to run on the main thread

Description

Enqueue a callback for main-thread execution. Arguments must be basic scalars or external pointers.

Usage

tcc_callback_async_schedule(callback, args = list())

Arguments

Value

NULL (invisible)

Close/unregister a callback

Description

Invalidates a callback immediately, releases the preserved R function reference, and cleans up callback resources as early as possible. This is recommended for deterministic lifetime management, but callbacks are also eventually released by finalizers if you simply drop all references.

Usage

tcc_callback_close(callback)

Arguments

Value

NULL (invisible)

Get the C-compatible function pointer

Description

Returns an external pointer that can be passed to compiled C code as user data for trampolines. Keep this handle (and the original tcc_callback) alive for as long as C may call back. The pointer handle keeps the underlying token storage alive until it is garbage collected. Closing the original callback still invalidates the callback registry entry, so C must not continue invoking it after tcc_callback_close().

Usage

tcc_callback_ptr(callback)

Arguments

Details

Pointer arguments and return values are treated as external pointers. Use tcc_read_bytes(), tcc_read_u8(), or tcc_read_f64() to inspect pointed data when needed.

Value

An external pointer (address of the callback token)

Check if callback is still valid

Description

Check if callback is still valid

Usage

tcc_callback_valid(callback)

Arguments

Value

Logical indicating if callback can be invoked

Compile FFI bindings

Description

Compile the defined symbols into callable functions. This generates C wrapper code and compiles it with TinyCC.

Usage

tcc_compile(ffi, verbose = FALSE)

Arguments

Value

A tcc_compiled object with callable functions

Compile C code from a character string

Description

Compile C code from a character string

Usage

tcc_compile_string(state, code)

Arguments

Value

Integer status code (0 = success).

Generate container_of helper for struct member

Description

Creates a function that recovers the parent struct pointer from a pointer to one of its members. This is the classic Linux kernel container_of macro made accessible from R.

Usage

tcc_container_of(ffi, struct_name, member_name)

Arguments

Value

Updated tcc_ffi object

Examples

## Not run: 
ffi <- tcc_ffi() |>
  tcc_struct("student", list(id = "i32", marks = "i32")) |>
  tcc_container_of("student", "marks") # Creates struct_student_from_marks()

## End(Not run)

Create a C-style string pointer

Description

Convert R character strings to C-style null-terminated string pointers. This handles UTF-8 encoding and null termination automatically.

Usage

tcc_cstring(str)

Arguments

Value

An external pointer tagged "rtinycc_owned" pointing to a malloc'd copy of the string. Freed on garbage collection or via tcc_free().

CString S3 Class

Description

Wrapper around a C string pointer with an optional cached R copy. Ownership follows the underlying external pointer; this wrapper does not add finalizer or freeing behavior on top of that pointer.

Usage

tcc_cstring_object(ptr, clone = TRUE, owned = FALSE)

Arguments

Value

A tcc_cstring object

Dereference a pointer-to-pointer

Description

Treats ptr_ref as a pointer to a pointer and returns the pointed address as an external pointer. This is useful for fields like ⁠void**⁠ or ⁠T**⁠.

Usage

tcc_data_ptr(ptr_ref)

Arguments

Value

An external pointer tagged "rtinycc_borrowed". Not owned by Rtinycc and never freed on garbage collection. Do not pass to tcc_free().

Declare enum for FFI helper generation

Description

Generate R-callable helpers for enum constants and type conversions. The enum must be defined in a header.

Usage

tcc_enum(ffi, name, constants = NULL, export_constants = FALSE)

Arguments

Value

Updated tcc_ffi object

Examples

## Not run: 
ffi <- tcc_ffi() |>
  tcc_header("#include <errors.h>") |>
  tcc_enum("error_code", constants = c("OK", "ERROR"), export_constants = TRUE)

## End(Not run)

Create a new FFI compilation context

Description

Initialize a Bun-style FFI context for API-mode compilation. This is the entry point for the modern FFI API.

Usage

tcc_ffi()

Value

A tcc_ffi object with chaining support

Examples

ffi <- tcc_ffi()

Generate field address getter helpers

Description

Creates functions that return pointers to specific struct fields. Useful for passing field pointers to C functions or for container_of.

Usage

tcc_field_addr(ffi, struct_name, fields)

Arguments

Value

Updated tcc_ffi object

Examples

## Not run: 
ffi <- tcc_ffi() |>
  tcc_struct("point", list(x = "f64", y = "f64")) |>
  tcc_field_addr("point", c("x", "y")) # point_x_addr(), point_y_addr()

## End(Not run)

Free owned memory

Description

Free memory whose external pointer is tagged "rtinycc_owned" (e.g. from tcc_malloc() or tcc_cstring()). Errors on struct pointers (use the generated ⁠struct_<name>_free()⁠) or borrowed pointers from tcc_data_ptr().

Usage

tcc_free(ptr)

Arguments

Value

NULL.

Generate bindings from header declarations

Description

Generate bindings from header declarations

Usage

tcc_generate_bindings(
  ffi = NULL,
  header,
  mapper = tcc_map_c_type_to_ffi,
  functions = TRUE,
  structs = TRUE,
  unions = TRUE,
  enums = TRUE,
  globals = TRUE,
  bitfield_type = "u8",
  include_bitfields = TRUE
)

Arguments

Value

Updated tcc_ffi object.

Examples

## Not run: 
header <- "double sqrt(double x); struct point { double x; double y; };"
ffi <- tcc_generate_bindings(tcc_ffi(), header)

## End(Not run)

Get a symbol pointer from a libtcc state

Description

Get a symbol pointer from a libtcc state

Usage

tcc_get_symbol(state, name)

Arguments

Value

External pointer of class tcc_symbol.

Declare a global variable getter

Description

Register a global C symbol so the compiled object exposes getter/setter functions ⁠global_<name>_get()⁠ and ⁠global_<name>_set()⁠.

Usage

tcc_global(ffi, name, type)

Arguments

Details

Globals are limited to scalar FFI types. Array types are rejected. Scalar conversions follow the same rules as wrapper arguments:

• Integer inputs (i8, i16, i32, u8, u16) must be finite and within range; NA values error.

• Large integer types (i64, u32, u64) are mediated through R numeric (double). Values must be integer-valued and within range; for i64/u64 only exact integers up to $2^53$ are accepted.

• Getter wrappers for i64/u64 warn when the stored value exceeds R's exact integer range for numeric vectors.

• bool rejects NA logicals.

Ownership notes:

• ptr globals store the raw address from an external pointer. If the external pointer owns memory, keep it alive; otherwise the pointer may be freed while the global still points to it.

• cstring globals store a borrowed pointer to R's string data (UTF-8 translation). Do not free it; for C-owned strings prefer a ptr global and manage lifetime explicitly (e.g., with tcc_cstring()).

Value

Updated tcc_ffi object (for chaining)

Note

Global helpers are generated inside the compiled TCC unit. Recompiling creates a new instance of the global variable; existing compiled objects continue to refer to their own copy.

Examples

ffi <- tcc_ffi() |>
  tcc_source("int global_counter = 7;") |>
  tcc_global("global_counter", "i32") |>
  tcc_compile()
ffi$global_global_counter_get()

Add C headers

Description

Add C headers

Usage

tcc_header(ffi, header)

Arguments

Value

Updated tcc_ffi object (for chaining)

Add include path to FFI context

Description

Add include path to FFI context

Usage

tcc_include(ffi, path)

Arguments

Value

Updated tcc_ffi object (for chaining)

TinyCC include search paths

Description

Returns the include directories used by the bundled TinyCC (top-level include and lib/tcc/include).

Usage

tcc_include_paths()

tcc_sysinclude_paths()

Value

A character vector of include directories.

Enable introspection helpers

Description

Generates sizeof, alignof, and offsetof helper functions for structs, unions, and enums. Useful for debugging or when you need to know C layout information from R.

Usage

tcc_introspect(ffi)

Arguments

Value

Updated tcc_ffi object

Add library to link against

Description

Add library to link against

Usage

tcc_library(ffi, library)

Arguments

Value

Updated tcc_ffi object (for chaining)

Add library path to FFI context

Description

Add library path to FFI context

Usage

tcc_library_path(ffi, path)

Arguments

Value

Updated tcc_ffi object (for chaining)

Link an external shared library with Bun-style FFI bindings

Description

Link a system library (like libsqlite3) and generate type-safe wrappers automatically using TinyCC JIT compilation (API mode). Unlike dlopen(), this uses TinyCC to compile bindings that handle type conversion between R and C automatically.

Usage

tcc_link(
  path,
  symbols,
  headers = NULL,
  libs = character(0),
  lib_paths = character(0),
  include_paths = character(0),
  user_code = NULL,
  verbose = FALSE
)

Arguments

Value

A tcc_compiled object with callable functions

Examples

## Not run: 
# Link SQLite with type-safe bindings
sqlite <- tcc_link(
  "libsqlite3.so",
  symbols = list(
    sqlite3_libversion = list(args = list(), returns = "cstring"),
    sqlite3_open = list(args = list("cstring", "ptr"), returns = "i32")
  ),
  libs = "sqlite3"
)

# Call directly - type conversion happens automatically
sqlite$sqlite3_libversion()

# Example with custom user code for helper functions
math_with_helpers <- tcc_link(
  "m",
  symbols = list(
    sqrt = list(args = list("f64"), returns = "f64"),
    safe_sqrt = list(args = list("f64"), returns = "f64")
  ),
  user_code = "
    #include <math.h>

    // Helper function that validates input before calling sqrt
    double safe_sqrt(double x) {
      if (x < 0) {
        return NAN;
      }
      return sqrt(x);
    }
  ",
  libs = "m"
)
math_with_helpers$safe_sqrt(16.0)
math_with_helpers$safe_sqrt(-4.0) # Returns NaN for negative input

## End(Not run)

Allocate memory buffer

Description

Allocate a memory buffer of specified size, equivalent to C malloc. Returns an external pointer that can be passed to FFI functions.

Usage

tcc_malloc(size)

Arguments

Value

An external pointer tagged "rtinycc_owned" with an R finalizer. Freed on garbage collection or explicitly via tcc_free().

Map a C type string to an Rtinycc FFI type

Description

Map a C type string to an Rtinycc FFI type

Usage

tcc_map_c_type_to_ffi(c_type)

Arguments

Details

This mapper is intentionally conservative for pointer types. ⁠char*⁠ is treated as a raw pointer (ptr) because C does not guarantee NUL-terminated strings. If you know the API expects a C string, map it explicitly to cstring in your custom mapper.

Value

A single FFI type string.

Examples

## Not run: 
tcc_map_c_type_to_ffi("int")
tcc_map_c_type_to_ffi("const char *")

## End(Not run)

Create a NULL pointer

Description

Creates a NULL pointer equivalent for use with FFI functions that expect optional pointer arguments.

Usage

tcc_null_ptr()

Value

An external pointer with NULL address

Add TinyCC compiler options to FFI context

Description

Append raw options that are passed to tcc_set_options() before compiling generated wrappers (for example "-O2" or "-Wall").

Usage

tcc_options(ffi, options)

Arguments

Value

Updated tcc_ffi object (for chaining)

Set output type for FFI compilation

Description

Set output type for FFI compilation

Usage

tcc_output(ffi, output = c("memory", "dll", "exe"))

Arguments

Value

Updated tcc_ffi object (for chaining)

Locate the TinyCC executable

Description

Returns the platform-specific tcc binary path (or tcc.exe on Windows), preferring the bundled installation.

Usage

tcc_path()

Value

A character scalar path.

TinyCC paths

Description

Helpers to locate the bundled tinycc installation after the package is installed.

Usage

tcc_prefix()

tcc_lib_path()

tcc_lib_paths()

tcc_include_path()

tcc_bin_path()

tcc_cli()

Value

A character scalar path.

Get pointer address as integer

Description

Get the numeric address of an external pointer, useful for debugging and when APIs require pointer addresses as integers. Optional hex mode available.

Usage

tcc_ptr_addr(ptr, hex = FALSE)

Arguments

Value

Character representation of pointer address (hex if requested, decimal otherwise)

Free the pointed memory and set to NULL

Description

Frees the memory pointed to by ptr_ref and sets the pointer to NULL. Use this only when the pointed memory is not already owned by another external pointer with its own finalizer.

Usage

tcc_ptr_free_set_null(ptr_ref)

Arguments

Value

The updated pointer reference (invisibly).

Check whether an external pointer is NULL

Description

Returns TRUE if the external pointer address is NULL, FALSE otherwise.

Usage

tcc_ptr_is_null(ptr)

Arguments

Value

Logical scalar

Check for the "rtinycc_owned" tag

Description

Returns TRUE only for pointers created by tcc_malloc() or tcc_cstring(). Struct pointers (tagged "struct_<name>") and borrowed pointers return FALSE.

Usage

tcc_ptr_is_owned(ptr)

Arguments

Value

Logical scalar

Set a pointer-to-pointer value

Description

Assigns the address in ptr_value to the location pointed to by ptr_ref.

Usage

tcc_ptr_set(ptr_ref, ptr_value)

Arguments

Value

The updated pointer reference (invisibly).

Pointer and Buffer Utilities for FFI

Description

Generic helper functions for common FFI operations inspired by Bun's FFI. These utilities handle pointer creation, buffer management, and memory operations that are commonly needed when working with external libraries.

Value

No return value. This is a documentation topic that groups the pointer and buffer utility functions described below.

Read raw bytes from a pointer

Description

Read a fixed number of bytes from an external pointer into a raw vector.

Usage

tcc_read_bytes(ptr, nbytes)

Arguments

Value

Raw vector

Read C-style string from pointer

Description

Convert a C-style null-terminated string pointer back to R character string. Handles UTF-8 decoding automatically.

Usage

tcc_read_cstring(
  ptr,
  max_bytes = NULL,
  null_action = c("na", "empty", "error")
)

Arguments

Value

Character string, or NA/"" for NULL pointers depending on null_action.

Read 32-bit float

Description

Read 32-bit float

Usage

tcc_read_f32(ptr, offset = 0L)

Arguments

Value

Numeric scalar (promoted to double).

Read 64-bit doubles from a pointer

Description

Read 64-bit doubles from a pointer

Usage

tcc_read_f64(ptr, n = NULL, offset = 0L)

Arguments

Value

Numeric scalar (offset form) or numeric vector (n form).

Read signed 16-bit integer

Description

Read signed 16-bit integer

Usage

tcc_read_i16(ptr, offset = 0L)

Arguments

Value

Integer scalar

Read signed 32-bit integers from a pointer

Description

Read signed 32-bit integers from a pointer

Usage

tcc_read_i32(ptr, n = NULL, offset = 0L)

Arguments

Value

Integer scalar (offset form) or integer vector (n form).

Read signed 64-bit integer

Description

Read signed 64-bit integer

Usage

tcc_read_i64(ptr, offset = 0L)

Arguments

Value

Numeric scalar (double, exact up to 2^53).

Read signed 8-bit integer

Description

Read signed 8-bit integer

Usage

tcc_read_i8(ptr, offset = 0L)

Arguments

Value

Integer scalar

Read a pointer at byte offset

Description

Dereferences a ⁠void*⁠ at the given byte offset from ptr. Equivalent to ⁠*(void**)(ptr + offset)⁠. The returned pointer is tagged "rtinycc_borrowed" and will not be freed by the garbage collector.

Usage

tcc_read_ptr(ptr, offset = 0L)

Arguments

Value

External pointer

Read unsigned 16-bit integer

Description

Read unsigned 16-bit integer

Usage

tcc_read_u16(ptr, offset = 0L)

Arguments

Value

Integer scalar

Read unsigned 32-bit integer

Description

Read unsigned 32-bit integer

Usage

tcc_read_u32(ptr, offset = 0L)

Arguments

Value

Numeric scalar (double, exact up to 2^32-1).

Read unsigned 64-bit integer

Description

Read unsigned 64-bit integer

Usage

tcc_read_u64(ptr, offset = 0L)

Arguments

Value

Numeric scalar (double, exact up to 2^53).

Read unsigned 8-bit values from a pointer

Description

Read unsigned 8-bit values from a pointer

Usage

tcc_read_u8(ptr, n = NULL, offset = 0L)

Arguments

Value

Integer scalar (offset form) or integer vector (n form).

Recompile a tcc_compiled object

Description

Explicitly recompile from the stored FFI recipe. Useful after deserialization (readRDS, unserialize) or to force a fresh compilation.

Usage

tcc_recompile(compiled)

Arguments

Value

The recompiled tcc_compiled object (invisibly, same environment)

Relocate compiled code

Description

Relocate compiled code

Usage

tcc_relocate(state)

Arguments

Value

Integer status code (0 = success).

Run the tinycc CLI

Description

Run the tinycc CLI

Usage

tcc_run_cli(args = character(), tcc_path = check_cli_exists())

Arguments

Value

Integer status from system2().

Apply raw TinyCC options to a libtcc state

Description

Passes options directly to tcc_set_options() for the given state.

Usage

tcc_set_options(state, options)

Arguments

Value

Integer status code (0 on success; negative on parse error).

Add C source code

Description

Add C source code

Usage

tcc_source(ffi, code)

Arguments

Value

Updated tcc_ffi object (for chaining)

Create a libtcc state

Description

Initialize a libtcc compilation state, optionally pointing at the bundled include/lib paths.

Usage

tcc_state(
  output = c("memory", "obj", "dll", "exe", "preprocess"),
  include_path = tcc_include_paths(),
  lib_path = tcc_lib_paths()
)

Arguments

Value

An external pointer of class tcc_state.

Declare struct for FFI helper generation

Description

Generate R-callable helpers for struct allocation, field access, and pointer management. The struct must be defined in a header.

Usage

tcc_struct(ffi, name, accessors)

Arguments

Value

Updated tcc_ffi object

Examples

## Not run: 
ffi <- tcc_ffi() |>
  tcc_header("#include <point.h>") |>
  tcc_struct("point", list(x = "f64", y = "f64", id = "i32"))

## End(Not run)

Enable raw byte access for struct

Description

Generates helper functions to read/write raw bytes from struct memory. Useful for bitwise operations, debugging, or manual serialization.

Usage

tcc_struct_raw_access(ffi, struct_name)

Arguments

Value

Updated tcc_ffi object

Check if a tcc_symbol external pointer is valid

Description

Check if a tcc_symbol external pointer is valid

Usage

tcc_symbol_is_valid(ptr)

Arguments

Value

TRUE if the pointer address is non-null, FALSE otherwise.

Generate bindings from a header

Description

Generate bindings from a header

Usage

tcc_treesitter_bindings(
  header,
  mapper = tcc_map_c_type_to_ffi,
  ffi = NULL,
  functions = TRUE,
  structs = FALSE,
  unions = FALSE,
  enums = FALSE,
  globals = FALSE,
  bitfield_type = "u8",
  include_bitfields = TRUE
)

Arguments

Value

Named list suitable for tcc_bind() when ffi is NULL, otherwise an updated tcc_ffi object.

Examples

## Not run: 
header <- "double sqrt(double x);"
symbols <- tcc_treesitter_bindings(header)

## End(Not run)

Extract macro defines from a header file

Description

Extract macro defines from a header file

Usage

tcc_treesitter_defines(
  file,
  use_cpp = TRUE,
  cc = treesitter.c::r_cc(),
  ccflags = NULL
)

Arguments

Value

Character vector of macro names defined in file.

Examples

## Not run: 
tcc_treesitter_defines("/usr/include/math.h")

## End(Not run)

Apply tcc_enum() bindings from a header

Description

Apply tcc_enum() bindings from a header

Usage

tcc_treesitter_enum_bindings(ffi, header, constants = NULL)

Arguments

Value

Updated tcc_ffi object.

Examples

## Not run: 
header <- "enum status { OK = 0, ERR = 1 };"
ffi <- tcc_ffi()
ffi <- tcc_treesitter_enum_bindings(ffi, header, constants = list(status = c("OK", "ERR")))

## End(Not run)

Parse enum members with treesitter.c

Description

Parse enum members with treesitter.c

Usage

tcc_treesitter_enum_members(header, ...)

Arguments

Value

A data frame of enum members.

Examples

## Not run: 
header <- "enum status { OK = 0, ERR = 1 };"
tcc_treesitter_enum_members(header)

## End(Not run)

Parse enum declarations with treesitter.c

Description

Parse enum declarations with treesitter.c

Usage

tcc_treesitter_enums(header, ...)

Arguments

Value

A data frame of enum nodes.

Examples

## Not run: 
header <- "enum status { OK = 0, ERR = 1 };"
tcc_treesitter_enums(header)

## End(Not run)

Parse function declarations with treesitter.c

Description

Parse function declarations with treesitter.c

Usage

tcc_treesitter_functions(header, ...)

Arguments

Value

A data frame of function nodes.

Examples

## Not run: 
header <- "double sqrt(double x);"
tcc_treesitter_functions(header)

## End(Not run)

Parse global declarations with types using treesitter.c

Description

Parse global declarations with types using treesitter.c

Usage

tcc_treesitter_global_types(header, ...)

Arguments

Value

A data frame of global names and C types.

Examples

## Not run: 
header <- "int global_counter;"
tcc_treesitter_global_types(header)

## End(Not run)

Parse global declarations with treesitter.c

Description

Parse global declarations with treesitter.c

Usage

tcc_treesitter_globals(header, ...)

Arguments

Value

A data frame of global names.

Examples

## Not run: 
header <- "int global_counter;"
tcc_treesitter_globals(header)

## End(Not run)

Treesitter helpers for header-driven bindings

Description

Convenience wrappers around treesitter.c that map C types to the Rtinycc FFI type system and return tcc_bind()-ready specs.

Arguments

Value

A data frame of nodes or a named list of binding specs.

treesitter.c

These helpers require the optional treesitter.c package.

Examples

## Not run: 
header <- "double sqrt(double x);\nint add(int a, int b);"
tcc_treesitter_functions(header)
tcc_treesitter_bindings(header)

## End(Not run)

Generate tcc_struct() accessors from header structs

Description

Generate tcc_struct() accessors from header structs

Usage

tcc_treesitter_struct_accessors(
  header,
  mapper = tcc_map_c_type_to_ffi,
  bitfield_type = "u8",
  include_bitfields = TRUE
)

Arguments

Value

Named list of accessors by struct name. Bitfields are returned as lists with type, bitfield = TRUE, and width. Named nested struct fields are returned as "struct:<name>"; ambiguous or anonymous nested structs fall back to "ptr".

Examples

## Not run: 
header <- "struct point { double x; double y; };"
tcc_treesitter_struct_accessors(header)

## End(Not run)

Apply tcc_struct() bindings from a header

Description

Apply tcc_struct() bindings from a header

Usage

tcc_treesitter_struct_bindings(ffi, header, ...)

Arguments

Value

Updated tcc_ffi object.

Examples

## Not run: 
header <- "struct point { double x; double y; };"
ffi <- tcc_ffi()
ffi <- tcc_treesitter_struct_bindings(ffi, header)

## End(Not run)

Parse struct members (including bitfields) with treesitter.c

Description

Parse struct members (including bitfields) with treesitter.c

Usage

tcc_treesitter_struct_members(header, ...)

Arguments

Value

A data frame of struct members.

Examples

## Not run: 
header <- "struct point { double x; double y; };"
tcc_treesitter_struct_members(header)

## End(Not run)

Parse struct declarations with treesitter.c

Description

Parse struct declarations with treesitter.c

Usage

tcc_treesitter_structs(header, ...)

Arguments

Value

A data frame of struct nodes.

Examples

## Not run: 
header <- "struct point { double x; double y; };"
tcc_treesitter_structs(header)

## End(Not run)

Generate tcc_union() accessors from header unions

Description

Generate tcc_union() accessors from header unions

Usage

tcc_treesitter_union_accessors(
  header,
  mapper = tcc_map_c_type_to_ffi,
  bitfield_type = "u8",
  include_bitfields = TRUE
)

Arguments

Value

Named list of accessors by union name. Bitfields are returned as lists with type, bitfield = TRUE, and width. Nested struct members are returned as ⁠list(type = "struct", struct_name = <name>)⁠ when the struct name is available, otherwise list(type = "struct").

Examples

## Not run: 
header <- "union data { int i; double d; };"
tcc_treesitter_union_accessors(header)

## End(Not run)

Apply tcc_union() bindings from a header

Description

Apply tcc_union() bindings from a header

Usage

tcc_treesitter_union_bindings(ffi, header, ...)

Arguments

Value

Updated tcc_ffi object.

Examples

## Not run: 
header <- "union data { int i; double d; };"
ffi <- tcc_ffi()
ffi <- tcc_treesitter_union_bindings(ffi, header)

## End(Not run)

Parse union members with treesitter.c

Description

Parse union members with treesitter.c

Usage

tcc_treesitter_union_members(header, ...)

Arguments

Value

A data frame of union members.

Examples

## Not run: 
header <- "union data { int i; double d; };"
tcc_treesitter_union_members(header)

## End(Not run)

Parse union declarations with treesitter.c

Description

Parse union declarations with treesitter.c

Usage

tcc_treesitter_unions(header, ...)

Arguments

Value

A data frame of union nodes.

Examples

## Not run: 
header <- "union data { int i; double d; };"
tcc_treesitter_unions(header)

## End(Not run)

Declare union for FFI helper generation

Description

Generate R-callable helpers for union allocation and member access. The union must be defined in a header.

Usage

tcc_union(ffi, name, members, active = NULL)

Arguments

Value

Updated tcc_ffi object

Examples

## Not run: 
ffi <- tcc_ffi() |>
  tcc_union("data_variant",
    members = list(as_int = "i32", as_float = "f32"),
    active = "as_int"
  )

## End(Not run)

Write raw bytes to a pointer

Description

Write a raw vector into memory pointed to by an external pointer.

Usage

tcc_write_bytes(ptr, raw)

Arguments

Value

NULL.

Write a 32-bit float

Description

Write a 32-bit float

Usage

tcc_write_f32(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one 32-bit floating-point value into native memory at ptr + offset.

Write a 64-bit double

Description

Write a 64-bit double

Usage

tcc_write_f64(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one 64-bit floating-point value into native memory at ptr + offset.

Write a signed 16-bit integer

Description

Write a signed 16-bit integer

Usage

tcc_write_i16(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one signed 16-bit value into native memory at ptr + offset.

Write a signed 32-bit integer

Description

Write a signed 32-bit integer

Usage

tcc_write_i32(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one signed 32-bit value into native memory at ptr + offset.

Write a signed 64-bit integer

Description

Write a signed 64-bit integer

Usage

tcc_write_i64(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one signed 64-bit value into native memory at ptr + offset.

Write a signed 8-bit integer

Description

Write a signed 8-bit integer

Usage

tcc_write_i8(ptr, offset, value)

Arguments

Value

NULL (invisibly).

Write a pointer at byte offset

Description

Write a pointer at byte offset

Usage

tcc_write_ptr(ptr, offset, value)

Arguments

Value

NULL (invisibly).

Write an unsigned 16-bit integer

Description

Write an unsigned 16-bit integer

Usage

tcc_write_u16(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one unsigned 16-bit value into native memory at ptr + offset.

Write an unsigned 32-bit integer

Description

Write an unsigned 32-bit integer

Usage

tcc_write_u32(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one unsigned 32-bit value into native memory at ptr + offset.

Write an unsigned 64-bit integer

Description

Write an unsigned 64-bit integer

Usage

tcc_write_u64(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one unsigned 64-bit value into native memory at ptr + offset.

Write an unsigned 8-bit integer

Description

Write an unsigned 8-bit integer

Usage

tcc_write_u8(ptr, offset, value)

Arguments

Value

NULL (invisibly). Called for its side effect of writing one unsigned 8-bit value into native memory at ptr + offset.