Logo ROOT  
Reference Guide
cpp_cppyy.h
Go to the documentation of this file.
1 #ifndef CPYCPPYY_CPPYY_H
2 #define CPYCPPYY_CPPYY_H
3 
4 // Standard
5 #include <set>
6 #include <string>
7 #include <vector>
8 #include <stddef.h>
9 #include <stdint.h>
10 
11 
12 // ROOT types
13 typedef long long Long64_t;
14 typedef unsigned long long ULong64_t;
15 typedef long double LongDouble_t;
16 
17 namespace Cppyy {
18  typedef size_t TCppScope_t;
20  typedef void* TCppEnum_t;
21  typedef void* TCppObject_t;
22  typedef intptr_t TCppMethod_t;
23 
24  typedef size_t TCppIndex_t;
25  typedef void* TCppFuncAddr_t;
26 
27 // direct interpreter access -------------------------------------------------
29  bool Compile(const std::string& code);
30 
31 // name to opaque C++ scope representation -----------------------------------
33  std::string ResolveName(const std::string& cppitem_name);
35  std::string ResolveEnum(const std::string& enum_type);
37  TCppScope_t GetScope(const std::string& scope_name);
41  size_t SizeOf(TCppType_t klass);
43  size_t SizeOf(const std::string& type_name);
44 
46  bool IsBuiltin(const std::string& type_name);
48  bool IsComplete(const std::string& type_name);
49 
51  TCppScope_t gGlobalScope; // for fast access
52 
53 // memory management ---------------------------------------------------------
62 
63 // method/function dispatching -----------------------------------------------
65  void CallV(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
67  unsigned char CallB(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
69  char CallC(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
71  short CallH(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
73  int CallI(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
75  long CallL(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
77  Long64_t CallLL(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
79  float CallF(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
81  double CallD(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
83  LongDouble_t CallLD(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
85  void* CallR(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
87  char* CallS(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, size_t* length);
89  TCppObject_t CallConstructor(TCppMethod_t method, TCppType_t type, size_t nargs, void* args);
93  TCppObject_t CallO(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, TCppType_t result_type);
94 
96  TCppFuncAddr_t GetFunctionAddress(TCppMethod_t method, bool check_enabled=true);
97 
98 // handling of function argument buffer --------------------------------------
100  void* AllocateFunctionArgs(size_t nargs);
102  void DeallocateFunctionArgs(void* args);
104  size_t GetFunctionArgSizeof();
106  size_t GetFunctionArgTypeoffset();
107 
108 // scope reflection information ----------------------------------------------
110  bool IsNamespace(TCppScope_t scope);
112  bool IsTemplate(const std::string& template_name);
114  bool IsAbstract(TCppType_t type);
116  bool IsEnum(const std::string& type_name);
117 
119  void GetAllCppNames(TCppScope_t scope, std::set<std::string>& cppnames);
120 
121 // namespace reflection information ------------------------------------------
123  std::vector<TCppScope_t> GetUsingNamespaces(TCppScope_t);
124 
125 // class reflection information ----------------------------------------------
127  std::string GetFinalName(TCppType_t type);
129  std::string GetScopedFinalName(TCppType_t type);
137  std::string GetBaseName(TCppType_t type, TCppIndex_t ibase);
139  bool IsSubtype(TCppType_t derived, TCppType_t base);
141  bool IsSmartPtr(TCppType_t type);
143  bool GetSmartPtrInfo(const std::string&, TCppType_t* raw, TCppMethod_t* deref);
145  void AddSmartPtrType(const std::string&);
146 
147 // calculate offsets between declared and actual type, up-cast: direction > 0; down-cast: direction < 0
149  ptrdiff_t GetBaseOffset(
150  TCppType_t derived, TCppType_t base, TCppObject_t address, int direction, bool rerror = false);
151 
152 // method/function reflection information ------------------------------------
156  std::vector<TCppIndex_t> GetMethodIndicesFromName(TCppScope_t scope, const std::string& name);
157 
160 
162  std::string GetMethodName(TCppMethod_t);
164  std::string GetMethodFullName(TCppMethod_t);
166  std::string GetMethodMangledName(TCppMethod_t);
168  std::string GetMethodResultType(TCppMethod_t);
174  std::string GetMethodArgName(TCppMethod_t, TCppIndex_t iarg);
176  std::string GetMethodArgType(TCppMethod_t, TCppIndex_t iarg);
178  std::string GetMethodArgDefault(TCppMethod_t, TCppIndex_t iarg);
180  std::string GetMethodSignature(TCppMethod_t, bool show_formalargs, TCppIndex_t maxargs = (TCppIndex_t)-1);
182  std::string GetMethodPrototype(TCppScope_t scope, TCppMethod_t, bool show_formalargs);
185 
189  std::string GetTemplatedMethodName(TCppScope_t scope, TCppIndex_t imeth);
193  bool ExistsMethodTemplate(TCppScope_t scope, const std::string& name);
195  bool IsMethodTemplate(TCppScope_t scope, TCppIndex_t imeth);
198  TCppScope_t scope, const std::string& name, const std::string& proto);
199 
202  TCppType_t scope, const std::string& lc, const std::string& rc, const std::string& op);
203 
204 // method properties ---------------------------------------------------------
206  bool IsPublicMethod(TCppMethod_t method);
208  bool IsProtectedMethod(TCppMethod_t method);
210  bool IsConstructor(TCppMethod_t method);
212  bool IsDestructor(TCppMethod_t method);
214  bool IsStaticMethod(TCppMethod_t method);
215 
216 // data member reflection information ----------------------------------------
220  std::string GetDatamemberName(TCppScope_t scope, TCppIndex_t idata);
222  std::string GetDatamemberType(TCppScope_t scope, TCppIndex_t idata);
224  intptr_t GetDatamemberOffset(TCppScope_t scope, TCppIndex_t idata);
226  TCppIndex_t GetDatamemberIndex(TCppScope_t scope, const std::string& name);
227 
228 // data member properties ----------------------------------------------------
230  bool IsPublicData(TCppScope_t scope, TCppIndex_t idata);
232  bool IsProtectedData(TCppScope_t scope, TCppIndex_t idata);
234  bool IsStaticData(TCppScope_t scope, TCppIndex_t idata);
236  bool IsConstData(TCppScope_t scope, TCppIndex_t idata);
238  bool IsEnumData(TCppScope_t scope, TCppIndex_t idata);
240  int GetDimensionSize(TCppScope_t scope, TCppIndex_t idata, int dimension);
241 
242 // enum properties -----------------------------------------------------------
244  TCppEnum_t GetEnum(TCppScope_t scope, const std::string& enum_name);
248  std::string GetEnumDataName(TCppEnum_t, TCppIndex_t idata);
250  long long GetEnumDataValue(TCppEnum_t, TCppIndex_t idata);
251 
252 } // namespace Cppyy
253 
254 #endif // !CPYCPPYY_CPPYY_H
RPY_EXPORTED TCppIndex_t GetMethodReqArgs(TCppMethod_t)
TCppScope_t TCppType_t
Definition: cpp_cppyy.h:19
RPY_EXPORTED std::string GetMethodSignature(TCppMethod_t, bool show_formalargs, TCppIndex_t maxargs=(TCppIndex_t) -1)
RPY_EXPORTED bool HasComplexHierarchy(TCppType_t type)
RPY_EXPORTED size_t SizeOf(TCppType_t klass)
long long Long64_t
Definition: RtypesCore.h:71
RPY_EXPORTED std::string GetScopedFinalName(TCppType_t type)
RPY_EXPORTED TCppType_t GetActualClass(TCppType_t klass, TCppObject_t obj)
size_t TCppScope_t
Definition: cpp_cppyy.h:18
RPY_EXPORTED bool IsProtectedData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED bool IsEnum(const std::string &type_name)
RPY_EXPORTED bool IsStaticMethod(TCppMethod_t method)
RPY_EXPORTED char * CallS(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args, size_t *length)
void * TCppEnum_t
Definition: cpp_cppyy.h:20
RPY_EXPORTED std::string GetDatamemberName(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED TCppObject_t CallConstructor(TCppMethod_t method, TCppType_t type, size_t nargs, void *args)
RPY_EXPORTED std::string GetBaseName(TCppType_t type, TCppIndex_t ibase)
RPY_EXPORTED std::vector< TCppIndex_t > GetMethodIndicesFromName(TCppScope_t scope, const std::string &name)
RPY_EXPORTED unsigned char CallB(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED TCppIndex_t GetNumEnumData(TCppEnum_t)
RPY_EXPORTED std::string GetDatamemberType(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED bool Compile(const std::string &code)
RPY_EXPORTED bool ExistsMethodTemplate(TCppScope_t scope, const std::string &name)
RPY_EXPORTED TCppObject_t Allocate(TCppType_t type)
RPY_EXPORTED TCppEnum_t GetEnum(TCppScope_t scope, const std::string &enum_name)
RPY_EXPORTED TCppObject_t CallO(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args, TCppType_t result_type)
RPY_EXPORTED TCppObject_t Construct(TCppType_t type)
RPY_EXPORTED void GetAllCppNames(TCppScope_t scope, std::set< std::string > &cppnames)
RPY_EXPORTED void Destruct(TCppType_t type, TCppObject_t instance)
RPY_EXPORTED TCppMethod_t GetMethod(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED TCppIndex_t GetNumDatamembers(TCppScope_t scope)
RPY_EXPORTED bool IsComplete(const std::string &type_name)
RPY_EXPORTED TCppScope_t gGlobalScope
Definition: cpp_cppyy.h:51
RPY_EXPORTED void AddSmartPtrType(const std::string &)
RPY_EXPORTED std::string GetMethodPrototype(TCppScope_t scope, TCppMethod_t, bool show_formalargs)
RPY_EXPORTED void Deallocate(TCppType_t type, TCppObject_t instance)
RPY_EXPORTED std::string GetTemplatedMethodName(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED TCppIndex_t GetNumTemplatedMethods(TCppScope_t scope)
RPY_EXPORTED Long64_t CallLL(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsPublicData(TCppScope_t scope, TCppIndex_t idata)
size_t TCppIndex_t
Definition: cpp_cppyy.h:24
RPY_EXPORTED bool IsConstructor(TCppMethod_t method)
RPY_EXPORTED std::string GetMethodMangledName(TCppMethod_t)
RPY_EXPORTED size_t GetFunctionArgTypeoffset()
RPY_EXPORTED void * AllocateFunctionArgs(size_t nargs)
RPY_EXPORTED bool IsConstMethod(TCppMethod_t)
RPY_EXPORTED TCppIndex_t GetDatamemberIndex(TCppScope_t scope, const std::string &name)
RPY_EXPORTED short CallH(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED void CallV(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsProtectedMethod(TCppMethod_t method)
RPY_EXPORTED ptrdiff_t GetBaseOffset(TCppType_t derived, TCppType_t base, TCppObject_t address, int direction, bool rerror=false)
RPY_EXPORTED float CallF(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string GetMethodFullName(TCppMethod_t)
RPY_EXPORTED std::string ResolveName(const std::string &cppitem_name)
RPY_EXPORTED TCppIndex_t GetMethodNumArgs(TCppMethod_t)
RPY_EXPORTED bool IsAbstract(TCppType_t type)
void * TCppFuncAddr_t
Definition: cpp_cppyy.h:25
RPY_EXPORTED std::string GetMethodName(TCppMethod_t)
RPY_EXPORTED bool IsStaticData(TCppScope_t scope, TCppIndex_t idata)
long double LongDouble_t
Definition: cpp_cppyy.h:15
RPY_EXPORTED bool IsEnumData(TCppScope_t scope, TCppIndex_t idata)
intptr_t TCppMethod_t
Definition: cpp_cppyy.h:22
RPY_EXPORTED void DeallocateFunctionArgs(void *args)
RPY_EXPORTED bool IsMethodTemplate(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED long long GetEnumDataValue(TCppEnum_t, TCppIndex_t idata)
static Roo_reg_AGKInteg1D instance
RPY_EXPORTED TCppIndex_t GetNumMethods(TCppScope_t scope)
long double LongDouble_t
Definition: RtypesCore.h:59
RPY_EXPORTED TCppIndex_t GetGlobalOperator(TCppType_t scope, const std::string &lc, const std::string &rc, const std::string &op)
RPY_EXPORTED bool GetSmartPtrInfo(const std::string &, TCppType_t *raw, TCppMethod_t *deref)
RPY_EXPORTED std::string GetMethodArgType(TCppMethod_t, TCppIndex_t iarg)
RPY_EXPORTED std::string GetEnumDataName(TCppEnum_t, TCppIndex_t idata)
RPY_EXPORTED double CallD(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string GetMethodResultType(TCppMethod_t)
RPY_EXPORTED TCppIndex_t GetNumBases(TCppType_t type)
RPY_EXPORTED char CallC(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
int type
Definition: TGX11.cxx:120
RPY_EXPORTED TCppFuncAddr_t GetFunctionAddress(TCppMethod_t method, bool check_enabled=true)
RPY_EXPORTED bool IsNamespace(TCppScope_t scope)
RPY_EXPORTED int CallI(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED void * CallR(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string ResolveEnum(const std::string &enum_type)
RPY_EXPORTED bool IsTemplatedConstructor(TCppScope_t scope, TCppIndex_t imeth)
void * TCppObject_t
Definition: cpp_cppyy.h:21
RPY_EXPORTED bool IsTemplate(const std::string &template_name)
RPY_EXPORTED TCppMethod_t GetMethodTemplate(TCppScope_t scope, const std::string &name, const std::string &proto)
RPY_EXPORTED bool IsBuiltin(const std::string &type_name)
unsigned long long ULong64_t
Definition: cpp_cppyy.h:14
RPY_EXPORTED bool IsConstData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED TCppScope_t GetScope(const std::string &scope_name)
const char * proto
Definition: civetweb.c:16604
RPY_EXPORTED void CallDestructor(TCppType_t type, TCppObject_t self)
RPY_EXPORTED bool IsSubtype(TCppType_t derived, TCppType_t base)
RPY_EXPORTED int GetDimensionSize(TCppScope_t scope, TCppIndex_t idata, int dimension)
RPY_EXPORTED std::string GetMethodArgName(TCppMethod_t, TCppIndex_t iarg)
#define RPY_EXPORTED
Definition: precommondefs.h:67
RPY_EXPORTED std::vector< TCppScope_t > GetUsingNamespaces(TCppScope_t)
RPY_EXPORTED long CallL(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string GetMethodArgDefault(TCppMethod_t, TCppIndex_t iarg)
RPY_EXPORTED std::string GetFinalName(TCppType_t type)
RPY_EXPORTED size_t GetFunctionArgSizeof()
RPY_EXPORTED intptr_t GetDatamemberOffset(TCppScope_t scope, TCppIndex_t idata)
char name[80]
Definition: TGX11.cxx:109
RPY_EXPORTED bool IsDestructor(TCppMethod_t method)
RPY_EXPORTED bool IsPublicMethod(TCppMethod_t method)
RPY_EXPORTED bool HasVirtualDestructor(TCppType_t type)
RPY_EXPORTED LongDouble_t CallLD(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsSmartPtr(TCppType_t type)
long long Long64_t
Definition: cpp_cppyy.h:13