Module.h File Reference

#include <Rcpp/config.h>
#include <Rcpp/internal/call.h>
#include <Rcpp/module/CppFunction.h>
#include <Rcpp/module/get_return_type.h>
#include <Rcpp/module/class_Base.h>
#include <Rcpp/module/Module.h>
#include <Rcpp/module/Module_Property.h>
#include <Rcpp/module/class.h>

Include dependency graph for Module.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Rcpp::result< T >
class	Rcpp::object< T >
class	Rcpp::CppFunctionN< RESULT_TYPE, T >
class	Rcpp::CppFunction_WithFormalsN< RESULT_TYPE, T >
class	Rcpp::CppMethod< Class >
class	Rcpp::CppInheritedMethod< Class, Parent >
class	Rcpp::Constructor_Base< Class >
class	Rcpp::Constructor< Class, T >
class	Rcpp::Factory_Base< Class >
class	Rcpp::Factory< Class, T >
class	Rcpp::SignedConstructor< Class >
class	Rcpp::SignedFactory< Class >
class	Rcpp::SignedMethod< Class >
class	Rcpp::S4_CppConstructor< Class >
class	Rcpp::S4_CppOverloadedMethods< Class >
class	Rcpp::CppMethodImplN< IsConst, Class, RESULT_TYPE, T >
class	Rcpp::Pointer_CppMethodImplN< IsConst, Class, RESULT_TYPE, T >
class	Rcpp::CppProperty< Class >
class	Rcpp::CppInheritedProperty< Class, Parent >
class	Rcpp::CppFinalizer< Class >
class	Rcpp::FunctionFinalizer< Class >
class	Rcpp::S4_field< Class >
class	Rcpp::CppProperty_GetMethod< Class, PROP >
class	Rcpp::CppProperty_GetConstMethod< Class, PROP >
class	Rcpp::CppProperty_GetPointerMethod< Class, PROP >
class	Rcpp::CppProperty_GetMethod_SetMethod< Class, PROP >
class	Rcpp::CppProperty_GetConstMethod_SetMethod< Class, PROP >
class	Rcpp::CppProperty_GetMethod_SetPointer< Class, PROP >
class	Rcpp::CppProperty_GetConstMethod_SetPointer< Class, PROP >
class	Rcpp::CppProperty_GetPointer_SetMethod< Class, PROP >
class	Rcpp::CppProperty_GetPointer_SetPointer< Class, PROP >
class	Rcpp::class_< Class >
class	Rcpp::class_< Class >::CppProperty_Getter_Setter< PROP >
class	Rcpp::class_< Class >::CppProperty_Getter< PROP >
class	Rcpp::enum_< Enum, Parent >
class	Rcpp::CppClass
class	Rcpp::CppObject

Namespaces
namespace	Rcpp
	Rcpp API.
namespace	Rcpp::internal
	internal implementation details

Macros
#define	Rcpp_Module_Property_h
#define	Rcpp_Module_CLASS_h
#define	Rcpp_Module_Field_h
#define	Rcpp_Module_Add_Property_h
#define	RCPP_MODULE_BOOT(name)
#define	RCPP_MODULE(name)
#define	VARIABLE_IS_NOT_USED
#define	GET_MODULE_SYM   ( moduleSym == NULL ? moduleSym = Rf_install("Module") : moduleSym )
#define	LOAD_RCPP_MODULE(NAME)

Typedefs
typedef bool(*	Rcpp::ValidConstructor) (SEXP *, int)
typedef bool(*	Rcpp::ValidMethod) (SEXP *, int)
template<typename Class, typename RESULT_TYPE, typename... T>
using	Rcpp::CppMethodN = CppMethodImplN<false, Class, RESULT_TYPE, T...>
template<typename Class, typename RESULT_TYPE, typename... T>
using	Rcpp::const_CppMethodN = CppMethodImplN<true, Class, RESULT_TYPE, T...>
template<typename Class, typename RESULT_TYPE, typename... T>
using	Rcpp::Pointer_CppMethodN = Pointer_CppMethodImplN<false, Class, RESULT_TYPE, T...>
template<typename Class, typename RESULT_TYPE, typename... T>
using	Rcpp::Const_Pointer_CppMethodN = Pointer_CppMethodImplN<true, Class, RESULT_TYPE, T...>

Functions
template<typename FROM, typename TO>
std::string	Rcpp::internal::get_converter_name (const char *from, const char *to)
template<typename Class>
SEXP	Rcpp::internal::make_new_object (Class *ptr)
template<typename RESULT_TYPE, typename... T>
void	Rcpp::signature (std::string &s, const char *name)
template<typename... T>
void	Rcpp::ctor_signature (std::string &s, const std::string &classname)
bool	Rcpp::yes (SEXP *, int)
template<int n>
bool	Rcpp::yes_arity (SEXP *, int nargs)
template<typename RESULT_TYPE, typename... T>
void	Rcpp::function (const char *name_, RESULT_TYPE(*fun)(T... t), const char *docstring=0)
template<typename RESULT_TYPE, typename... T>
void	Rcpp::function (const char *name_, RESULT_TYPE(*fun)(T... t), Rcpp::List formals, const char *docstring=0)
template<typename FROM, typename TO>
void	Rcpp::converter (const char *from, const char *to, TO(*fun)(FROM), const char *docstring=0)

Variables
static VARIABLE_IS_NOT_USED SEXP	moduleSym = NULL

Macro Definition Documentation

GET_MODULE_SYM

#define GET_MODULE_SYM   ( moduleSym == NULL ? moduleSym = Rf_install("Module") : moduleSym )

Definition at line 639 of file Module.h.

LOAD_RCPP_MODULE

#define LOAD_RCPP_MODULE

(

NAME

)

Value:

    Shield<SEXP> __load_module_call__( Rf_lang2( GET_MODULE_SYM, _rcpp_module_boot_##NAME() ) ); \
    Rcpp_fast_eval( __load_module_call__, R_GlobalEnv );

Definition at line 642 of file Module.h.

RCPP_MODULE

#define RCPP_MODULE

(

name

)

Value:

    void _rcpp_module_##name##_init() ;                                 \
    static Rcpp::Module _rcpp_module_##name( # name ) ;                 \
    extern "C" SEXP _rcpp_module_boot_##name(){                         \
        ::setCurrentScope( & _rcpp_module_##name ) ;                    \
        _rcpp_module_##name##_init( ) ;                                 \
        Rcpp::XPtr<Rcpp::Module> mod_xp(& _rcpp_module_##name , false); \
        ::setCurrentScope( 0 ) ;                                        \
        return mod_xp ;                                                 \
    }                                                                   \
    void _rcpp_module_##name##_init()

Definition at line 615 of file Module.h.

Rcpp_Module_Add_Property_h

#define Rcpp_Module_Add_Property_h

RCPP_MODULE_BOOT

#define RCPP_MODULE_BOOT

(

name

)

Value:

_rcpp_module_boot_##name

Definition at line 613 of file Module.h.

Rcpp_Module_CLASS_h

#define Rcpp_Module_CLASS_h

Definition at line 23 of file Module.h.

Rcpp_Module_Field_h

#define Rcpp_Module_Field_h

Rcpp_Module_Property_h

#define Rcpp_Module_Property_h

Definition at line 24 of file Module.h.

VARIABLE_IS_NOT_USED

#define VARIABLE_IS_NOT_USED

Definition at line 631 of file Module.h.

Variable Documentation

moduleSym

VARIABLE_IS_NOT_USED SEXP moduleSym = NULL

static

Definition at line 635 of file Module.h.