Rcpp Version 0.12.14
Rcpp::attributes Namespace Reference

Classes

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

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)
 
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 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"
 

Function Documentation

◆ createDirectory()

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

◆ endsWith()

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

Definition at line 2932 of file attributes.cpp.

Referenced by compileAttributes().

◆ generateCpp()

◆ generateRArgList()

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

◆ isQuoted()

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

Definition at line 2924 of file attributes.cpp.

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

◆ isRoxygenCpp()

◆ isWhitespace()

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

◆ operator<<() [1/5]

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

◆ operator<<() [2/5]

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

Definition at line 1073 of file attributes.cpp.

References printArgument().

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 1101 of file attributes.cpp.

References 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 1107 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 Attribute attribute 
)

◆ printArgument()

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

◆ printFunction()

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

Definition at line 1079 of file attributes.cpp.

References printArgument().

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

Here is the call graph for this function:

◆ removeFile()

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

Definition at line 2825 of file attributes.cpp.

References Rcpp::base_env(), Rcpp::attributes::FileInfo::exists(), and Rcpp::attributes::FileInfo::FileInfo().

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 2939 of file attributes.cpp.

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

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

Here is the call graph for this function:

◆ stripQuotes()

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

Definition at line 2915 of file attributes.cpp.

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

◆ stripTrailingLineComments()

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

Definition at line 2854 of file attributes.cpp.

References isRoxygenCpp().

Here is the call graph for this function:

◆ trimWhitespace()

Variable Documentation

◆ kDependsAttribute

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

◆ kExportAttribute

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

◆ kExportName

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

◆ kExportRng

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

◆ kInterfaceCpp

◆ kInterfaceR

◆ kInterfacesAttribute

◆ kParamValueFalse

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

◆ kParamValueFALSE

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

◆ kParamValueTrue

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

◆ kParamValueTRUE

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

◆ kPluginsAttribute

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

◆ kWhitespaceChars

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