cpp_decorations: Decorations in a 'C++' file

In r-lib/decor: Retrieve Code Decorations

Decorations in a 'C++' file

Description

Decorations in a 'C++' file

Usage

cpp_decorations(pkg = ".", files = cpp_files(pkg = pkg), is_attribute = FALSE)

Arguments

pkg	The path to a package's root directory.
files	Paths to 'C++' files. If given, 'pkg' will not be used.
is_attribute	If 'TRUE' the decorations are C++11 attributes, if 'FALSE' they are comments.

Value

A tibble with the decorations found, containing fields: - file - The filename for the decoration - line - The line the decoration was found - decoration - The name of the decoration - params - Any parameters given with the decoration - context - The text of the decoration line and all lines until the next decoration (or the end of the file).

Examples

# Setup
f <- tempfile()
writeLines("[[cpp11::register]] int fun(int x = 1) { return x + 1; }", f)

# Retrieve the decorations in the file
cpp_decorations(files = f, is_attribute = TRUE)

# Cleanup
unlink(f)

r-lib/decor documentation built on July 27, 2023, 8:01 a.m.