Classes
class	FileInfo
class	Type
class	Argument
class	Function
class	Param
class	Attribute
class	SourceFileAttributes
class	CommentState
class	SourceFileAttributesParser
class	ExportsGenerator
class	CppExportsGenerator
class	CppExportsIncludeGenerator
class	CppPackageIncludeGenerator
class	RExportsGenerator
class	ExportsGenerators

Functions
bool	removeFile (const std::string &path)
void	createDirectory (const std::string &path)
bool	isWhitespace (char ch)
void	trimWhitespace (std::string *pStr)
void	stripTrailingLineComments (std::string *pStr)
void	stripQuotes (std::string *pStr)
bool	isQuoted (const std::string &str)
bool	endsWith (const std::string &str, const std::string &suffix)
void	showWarning (const std::string &msg)
bool	isRoxygenCpp (const std::string &str)
std::ostream &	operator<< (std::ostream &os, const Type &type)
std::ostream &	operator<< (std::ostream &os, const Argument &argument)
std::ostream &	operator<< (std::ostream &os, const Function &function)
std::ostream &	operator<< (std::ostream &os, const Param &param)
std::ostream &	operator<< (std::ostream &os, const Attribute &attribute)
std::string	generateRArgList (const Function &function)
bool	checkRSignature (const Function &function, std::string args)
void	initializeGlobals (std::ostream &ostr)
void	generateCpp (std::ostream &ostr, const SourceFileAttributes &attributes, bool includePrototype, bool cppInterface, const std::string &contextId)
void	printArgument (std::ostream &os, const Argument &argument, bool printDefault=true)
void	printFunction (std::ostream &os, const Function &function, bool printArgDefaults=true)

Variables
const char *const	kWhitespaceChars = " \f\n\r\t\v"
const char *const	kExportAttribute = "export"
const char *const	kExportName = "name"
const char *const	kExportRng = "rng"
const char *const	kExportInvisible = "invisible"
const char *const	kExportSignature = "signature"
const char *const	kInitAttribute = "init"
const char *const	kDependsAttribute = "depends"
const char *const	kPluginsAttribute = "plugins"
const char *const	kInterfacesAttribute = "interfaces"
const char *const	kInterfaceR = "r"
const char *const	kInterfaceCpp = "cpp"
const char *const	kParamValueFalse = "false"
const char *const	kParamValueTrue = "true"
const char *const	kParamValueFALSE = "FALSE"
const char *const	kParamValueTRUE = "TRUE"
const char *const	kParamBlockStart = "{;"
const char *const	kParamBlockEnd = "}"

Function Documentation

◆ checkRSignature()

bool Rcpp::attributes::checkRSignature	(	const Function &	function,
		std::string	args )

Definition at line 2800 of file attributes.cpp.

References Rcpp::_, Rcpp::as(), Rcpp::eval(), Rcpp::function(), and Rcpp::attributes::Argument::name().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions().

Here is the call graph for this function:

◆ createDirectory()

void Rcpp::attributes::createDirectory ( const std::string & path )

Definition at line 3012 of file attributes.cpp.

References Rcpp::exists(), and Rcpp::Named().

Referenced by Rcpp::attributes::CppExportsIncludeGenerator::commit(), and Rcpp::attributes::CppPackageIncludeGenerator::commit().

Here is the call graph for this function:

◆ endsWith()

bool Rcpp::attributes::endsWith	(	const std::string &	str,
		const std::string &	suffix )

Definition at line 3107 of file attributes.cpp.

Referenced by compileAttributes().

◆ generateCpp()

void Rcpp::attributes::generateCpp	(	std::ostream &	ostr,
		const SourceFileAttributes &	attributes,
		bool	includePrototype,
		bool	cppInterface,
		const std::string &	contextId )

Definition at line 2840 of file attributes.cpp.

References Rcpp::attributes::Type::full_name(), Rcpp::attributes::Attribute::function(), Rcpp::function(), Rcpp::attributes::Attribute::isExportedFunction(), Rcpp::attributes::Argument::name(), printFunction(), Rcpp::attributes::Attribute::rng(), and Rcpp::attributes::Argument::type().

Referenced by Rcpp::attributes::CppExportsGenerator::doWriteFunctions().

Here is the call graph for this function:

◆ generateRArgList()

std::string Rcpp::attributes::generateRArgList ( const Function & function )

Definition at line 2775 of file attributes.cpp.

References Rcpp::attributes::Argument::defaultValue(), Rcpp::function(), Rcpp::attributes::Argument::name(), Rcpp::attributes::Type::name(), showWarning(), and Rcpp::attributes::Argument::type().

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions().

Here is the call graph for this function:

◆ initializeGlobals()

void Rcpp::attributes::initializeGlobals ( std::ostream & ostr )

Definition at line 2829 of file attributes.cpp.

Referenced by Rcpp::attributes::CppExportsGenerator::commit().

◆ isQuoted()

bool Rcpp::attributes::isQuoted ( const std::string & str )

Definition at line 3099 of file attributes.cpp.

◆ isRoxygenCpp()

bool Rcpp::attributes::isRoxygenCpp ( const std::string & str )

Definition at line 3119 of file attributes.cpp.

References kWhitespaceChars.

Referenced by stripTrailingLineComments().

◆ isWhitespace()

bool Rcpp::attributes::isWhitespace ( char ch )

Definition at line 3023 of file attributes.cpp.

References kWhitespaceChars.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseFunction().

◆ operator<<() [1/5]

std::ostream & Rcpp::attributes::operator<<	(	std::ostream &	os,
		const Argument &	argument )

Definition at line 1111 of file attributes.cpp.

References printArgument().

Here is the call graph for this function:

◆ operator<<() [2/5]

std::ostream & Rcpp::attributes::operator<<	(	std::ostream &	os,
		const Attribute &	attribute )

Definition at line 1155 of file attributes.cpp.

References Rcpp::attributes::Attribute::empty(), Rcpp::attributes::Function::empty(), Rcpp::attributes::Attribute::function(), Rcpp::attributes::Attribute::name(), and Rcpp::attributes::Attribute::params().

Here is the call graph for this function:

◆ operator<<() [3/5]

std::ostream & Rcpp::attributes::operator<<	(	std::ostream &	os,
		const Function &	function )

Definition at line 1139 of file attributes.cpp.

References Rcpp::function(), and printFunction().

Here is the call graph for this function:

◆ operator<<() [4/5]

std::ostream & Rcpp::attributes::operator<<	(	std::ostream &	os,
		const Param &	param )

Definition at line 1145 of file attributes.cpp.

References Rcpp::attributes::Param::empty(), Rcpp::attributes::Param::name(), and Rcpp::attributes::Param::value().

Here is the call graph for this function:

◆ operator<<() [5/5]

std::ostream & Rcpp::attributes::operator<<	(	std::ostream &	os,
		const Type &	type )

Definition at line 1084 of file attributes.cpp.

References Rcpp::attributes::Type::empty(), Rcpp::attributes::Type::isConst(), Rcpp::attributes::Type::isReference(), and Rcpp::attributes::Type::name().

Here is the call graph for this function:

◆ printArgument()

void Rcpp::attributes::printArgument	(	std::ostream &	os,
		const Argument &	argument,
		bool	printDefault = true )

Definition at line 1096 of file attributes.cpp.

References Rcpp::attributes::Argument::defaultValue(), Rcpp::attributes::Argument::empty(), Rcpp::attributes::Argument::name(), and Rcpp::attributes::Argument::type().

Referenced by operator<<(), and printFunction().

Here is the call graph for this function:

◆ printFunction()

void Rcpp::attributes::printFunction	(	std::ostream &	os,
		const Function &	function,
		bool	printArgDefaults = true )

Definition at line 1117 of file attributes.cpp.

References Rcpp::function(), and printArgument().

Referenced by generateCpp(), operator<<(), and Rcpp::attributes::CppExportsGenerator::writeEnd().

Here is the call graph for this function:

◆ removeFile()

bool Rcpp::attributes::removeFile ( const std::string & path )

Definition at line 3000 of file attributes.cpp.

References Rcpp::exists().

Referenced by Rcpp::attributes::ExportsGenerator::remove().

Here is the call graph for this function:

◆ showWarning()

void Rcpp::attributes::showWarning ( const std::string & msg )

Definition at line 3114 of file attributes.cpp.

References Rcpp::Named(), and Rcpp::warning().

Referenced by Rcpp::attributes::SourceFileAttributesParser::attributeWarning(), compileAttributes(), generateRArgList(), and Rcpp::attributes::CppExportsGenerator::writeEnd().

Here is the call graph for this function:

◆ stripQuotes()

void Rcpp::attributes::stripQuotes ( std::string * pStr )

Definition at line 3090 of file attributes.cpp.

Referenced by Rcpp::attributes::Param::Param().

◆ stripTrailingLineComments()

void Rcpp::attributes::stripTrailingLineComments ( std::string * pStr )

Definition at line 3029 of file attributes.cpp.

References isRoxygenCpp(), and kWhitespaceChars.

Here is the call graph for this function:

◆ trimWhitespace()

void Rcpp::attributes::trimWhitespace ( std::string * pStr )

Definition at line 3073 of file attributes.cpp.

References kWhitespaceChars.

Referenced by Rcpp::attributes::Attribute::customRSignature(), Rcpp::attributes::Param::Param(), Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), Rcpp::attributes::SourceFileAttributesParser::parseFunction(), and Rcpp::attributes::SourceFileAttributesParser::parseType().

Variable Documentation

◆ kDependsAttribute

const char* const Rcpp::attributes::kDependsAttribute = "depends"

Definition at line 159 of file attributes.cpp.

Referenced by compileAttributes(), and Rcpp::attributes::SourceFileAttributesParser::isKnownAttribute().

◆ kExportAttribute

const char* const Rcpp::attributes::kExportAttribute = "export"

Definition at line 153 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::isExportedFunction(), Rcpp::attributes::SourceFileAttributesParser::isKnownAttribute(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kExportInvisible

const char* const Rcpp::attributes::kExportInvisible = "invisible"

Definition at line 156 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::invisible(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kExportName

const char* const Rcpp::attributes::kExportName = "name"

Definition at line 154 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::exportedName(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kExportRng

const char* const Rcpp::attributes::kExportRng = "rng"

Definition at line 155 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), and Rcpp::attributes::Attribute::rng().

◆ kExportSignature

const char* const Rcpp::attributes::kExportSignature = "signature"

Definition at line 157 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::customRSignature(), Rcpp::attributes::RExportsGenerator::doWriteFunctions(), Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), and Rcpp::attributes::SourceFileAttributesParser::parseParameters().

◆ kInitAttribute

const char* const Rcpp::attributes::kInitAttribute = "init"

Definition at line 158 of file attributes.cpp.

Referenced by Rcpp::attributes::CppExportsGenerator::doWriteFunctions(), Rcpp::attributes::SourceFileAttributesParser::isKnownAttribute(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kInterfaceCpp

const char* const Rcpp::attributes::kInterfaceCpp = "cpp"

Definition at line 163 of file attributes.cpp.

Referenced by Rcpp::attributes::CppExportsGenerator::doWriteFunctions(), Rcpp::attributes::CppExportsIncludeGenerator::doWriteFunctions(), Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), and Rcpp::attributes::ExportsGenerator::writeFunctions().

◆ kInterfaceR

const char* const Rcpp::attributes::kInterfaceR = "r"

Definition at line 162 of file attributes.cpp.

Referenced by Rcpp::attributes::RExportsGenerator::doWriteFunctions(), Rcpp::attributes::SourceFileAttributesParser::hasInterface(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kInterfacesAttribute

const char* const Rcpp::attributes::kInterfacesAttribute = "interfaces"

Definition at line 161 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::hasInterface(), Rcpp::attributes::SourceFileAttributesParser::isKnownAttribute(), and Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kParamBlockEnd

const char* const Rcpp::attributes::kParamBlockEnd = "}"

Definition at line 169 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseParameters().

◆ kParamBlockStart

const char* const Rcpp::attributes::kParamBlockStart = "{;"

Definition at line 168 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseParameters().

◆ kParamValueFALSE

const char* const Rcpp::attributes::kParamValueFALSE = "FALSE"

Definition at line 166 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kParamValueFalse

const char* const Rcpp::attributes::kParamValueFalse = "false"

Definition at line 164 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::parseAttribute().

◆ kParamValueTRUE

const char* const Rcpp::attributes::kParamValueTRUE = "TRUE"

Definition at line 167 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::invisible(), Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), and Rcpp::attributes::Attribute::rng().

◆ kParamValueTrue

const char* const Rcpp::attributes::kParamValueTrue = "true"

Definition at line 165 of file attributes.cpp.

Referenced by Rcpp::attributes::Attribute::invisible(), Rcpp::attributes::SourceFileAttributesParser::parseAttribute(), and Rcpp::attributes::Attribute::rng().

◆ kPluginsAttribute

const char* const Rcpp::attributes::kPluginsAttribute = "plugins"

Definition at line 160 of file attributes.cpp.

Referenced by Rcpp::attributes::SourceFileAttributesParser::isKnownAttribute().

◆ kWhitespaceChars

const char *const Rcpp::attributes::kWhitespaceChars = " \f\n\r\t\v"

Definition at line 3020 of file attributes.cpp.

Referenced by isRoxygenCpp(), isWhitespace(), Rcpp::attributes::SourceFileAttributesParser::parseFunction(), stripTrailingLineComments(), and trimWhitespace().

Classes

Functions

Variables

Function Documentation

◆ checkRSignature()

◆ createDirectory()

◆ endsWith()

◆ generateCpp()

◆ generateRArgList()

◆ initializeGlobals()

◆ isQuoted()

◆ isRoxygenCpp()

◆ isWhitespace()

◆ operator<<() [1/5]

◆ operator<<() [2/5]

◆ operator<<() [3/5]

◆ operator<<() [4/5]

◆ operator<<() [5/5]

◆ printArgument()

◆ printFunction()

◆ removeFile()

◆ showWarning()

◆ stripQuotes()

◆ stripTrailingLineComments()

◆ trimWhitespace()

Variable Documentation

◆ kDependsAttribute

◆ kExportAttribute

◆ kExportInvisible

◆ kExportName

◆ kExportRng

◆ kExportSignature

◆ kInitAttribute

◆ kInterfaceCpp

◆ kInterfaceR

◆ kInterfacesAttribute

◆ kParamBlockEnd

◆ kParamBlockStart

◆ kParamValueFALSE

◆ kParamValueFalse

◆ kParamValueTRUE

◆ kParamValueTrue

◆ kPluginsAttribute

◆ kWhitespaceChars