Module.h File Reference

#include <Rcpp/config.h>
#include <Rcpp/module/Module_generated_get_return_type.h>
#include <Rcpp/module/Module_generated_get_signature.h>
#include <Rcpp/module/Module_generated_CppFunction.h>
#include <Rcpp/module/Module_generated_ctor_signature.h>
#include <Rcpp/module/Module_generated_Constructor.h>
#include <Rcpp/module/Module_generated_class_signature.h>
#include <Rcpp/module/Module_generated_CppMethod.h>
#include <Rcpp/module/Module_generated_Pointer_CppMethod.h>
#include <Rcpp/module/Module_Property.h>
#include <Rcpp/module/Module_generated_class_constructor.h>
#include <Rcpp/module/Module_generated_method.h>
#include <Rcpp/module/Module_generated_Pointer_method.h>
#include <Rcpp/module/Module_Field.h>
#include <Rcpp/module/Module_Add_Property.h>
#include <Rcpp/module/Module_generated_function.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::CppFunction
class	Rcpp::class_Base
class	Rcpp::Module
class	Rcpp::CppMethod< Class >
class	Rcpp::SignedConstructor< Class >
class	Rcpp::SignedMethod< Class >
class	Rcpp::S4_CppConstructor< Class >
class	Rcpp::S4_CppOverloadedMethods< Class >
class	Rcpp::CppProperty< Class >
class	Rcpp::CppFinalizer< Class >
class	Rcpp::FunctionFinalizer< Class >
class	Rcpp::S4_field< Class >
class	Rcpp::class_< Class >
class	Rcpp::CppClass
class	Rcpp::CppObject
Namespaces
namespace	Rcpp
	Rcpp API.
namespace	Rcpp::internal
	internal implementation details
Defines
#define	RCPP_MODULE_BOOT(name)   _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)   Rf_eval( Rf_lang2( GET_MODULE_SYM, _rcpp_module_boot_##NAME() ), R_GlobalEnv )
Typedefs
typedef bool(*	Rcpp::ValidConstructor )(SEXP *, int)
typedef bool(*	Rcpp::ValidMethod )(SEXP *, int)
Functions
template<typename Class >
SEXP	Rcpp::internal::make_new_object (Class *ptr)
Rcpp::Module *	getCurrentScope ()
void	setCurrentScope (Rcpp::Module *)
Variables
static VARIABLE_IS_NOT_USED SEXP	moduleSym = NULL

---

Define Documentation

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

Definition at line 781 of file Module.h.

#define LOAD_RCPP_MODULE

(

NAME

)

Rf_eval( Rf_lang2( GET_MODULE_SYM, _rcpp_module_boot_##NAME() ), R_GlobalEnv )

Definition at line 784 of file Module.h.

#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 757 of file Module.h.

#define RCPP_MODULE_BOOT

(

name

)

_rcpp_module_boot_##name

Definition at line 755 of file Module.h.

#define VARIABLE_IS_NOT_USED

Definition at line 773 of file Module.h.

---

Function Documentation

Rcpp::Module* getCurrentScope

(

)

Definition at line 258 of file Module.cpp.

References Rcpp::current_scope.

Referenced by Rcpp::class_< Class >::class_().

void setCurrentScope

(

Rcpp::Module *

)

Definition at line 259 of file Module.cpp.

References Rcpp::current_scope, and scope.

---

Variable Documentation

VARIABLE_IS_NOT_USED SEXP moduleSym = NULL [static]

Definition at line 777 of file Module.h.