extract_ptr: Extract Cpp object pointer from object

In Bijaelo/cmdline.arguments: Flexible and fully customizable commandline tool for R scripting and R based applications

Description

The interface of cmdline.arguments is implemented using a combination or R, Rcpp and the R-core C api. The R interface represents the boiler plate and front-end interface for the user, while the backend is represented by a network of C++ functions and classes to store arguments and perform the actual cmdline argument parsing. While the user provides an R function every effort is made to avoid unnecessary interaction with R. It is not unlikely that several Internal parser functions (in time) will be called or be reimplemented directly in C++ in due time, to avoid the tiny overhead caused by evaluating a call from C++.

Usage

extract_ptr(x, ...)

## S3 method for class 'cmd_arg'
extract_ptr(x, ...)

## S3 method for class 'cmd_parser'
extract_ptr(x, ...)

Arguments

x	an object containing a external_ptr object
...	further parameters passed to parent methods

Value

an external_ptr to the object in question.

Methods (by class)

• cmd_arg: method for class "cmd_arg"

• cmd_parser: method for class "cmd_parser"

Note

This method is NOT intended for usage by the end user. It is highly recommended to only interface with the pointer through the standard methods that has been exposed to the user. Anyone using this pointer directly should spend a not insignificant amount of time consulting the source code of the package.

Bijaelo/cmdline.arguments documentation built on June 12, 2021, 1:42 p.m.