Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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
13typedef long long Long64_t;
14typedef unsigned long long ULong64_t;
15typedef long double LongDouble_t;
16
17namespace 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, bool silent = false);
31 std::string ToString(TCppType_t klass, TCppObject_t obj);
32
33// name to opaque C++ scope representation -----------------------------------
35 std::string ResolveName(const std::string& cppitem_name);
37 std::string ResolveEnum(const std::string& enum_type);
39 TCppScope_t GetScope(const std::string& scope_name);
43 size_t SizeOf(TCppType_t klass);
45 size_t SizeOf(const std::string& type_name);
46
48 bool IsBuiltin(const std::string& type_name);
50 bool IsComplete(const std::string& type_name);
51
53 TCppScope_t gGlobalScope; // for fast access
54
55// memory management ---------------------------------------------------------
61 TCppObject_t Construct(TCppType_t type, void* arena = nullptr);
64
65// method/function dispatching -----------------------------------------------
67 void CallV(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
69 unsigned char CallB(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
71 char CallC(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
73 short CallH(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
75 int CallI(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
77 long CallL(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
79 Long64_t CallLL(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
81 float CallF(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
83 double CallD(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
85 LongDouble_t CallLD(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
87 void* CallR(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
89 char* CallS(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, size_t* length);
91 TCppObject_t CallConstructor(TCppMethod_t method, TCppType_t type, size_t nargs, void* args);
95 TCppObject_t CallO(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, TCppType_t result_type);
96
98 TCppFuncAddr_t GetFunctionAddress(TCppMethod_t method, bool check_enabled=true);
99
100// handling of function argument buffer --------------------------------------
102 void* AllocateFunctionArgs(size_t nargs);
104 void DeallocateFunctionArgs(void* args);
106 size_t GetFunctionArgSizeof();
109
110// scope reflection information ----------------------------------------------
112 bool IsNamespace(TCppScope_t scope);
114 bool IsTemplate(const std::string& template_name);
118 bool IsEnum(const std::string& type_name);
123
125 void GetAllCppNames(TCppScope_t scope, std::set<std::string>& cppnames);
126
127// namespace reflection information ------------------------------------------
129 std::vector<TCppScope_t> GetUsingNamespaces(TCppScope_t);
130
131// class reflection information ----------------------------------------------
133 std::string GetFinalName(TCppType_t type);
145 std::string GetBaseName(TCppType_t type, TCppIndex_t ibase);
147 bool IsSubtype(TCppType_t derived, TCppType_t base);
151 bool GetSmartPtrInfo(const std::string&, TCppType_t* raw, TCppMethod_t* deref);
153 void AddSmartPtrType(const std::string&);
154
156 void AddTypeReducer(const std::string& reducable, const std::string& reduced);
157
158// calculate offsets between declared and actual type, up-cast: direction > 0; down-cast: direction < 0
160 ptrdiff_t GetBaseOffset(
161 TCppType_t derived, TCppType_t base, TCppObject_t address, int direction, bool rerror = false);
162
163// method/function reflection information ------------------------------------
165 TCppIndex_t GetNumMethods(TCppScope_t scope, bool accept_namespace = false);
167 std::vector<TCppIndex_t> GetMethodIndicesFromName(TCppScope_t scope, const std::string& name);
168
171
173 std::string GetMethodName(TCppMethod_t);
175 std::string GetMethodFullName(TCppMethod_t);
185 std::string GetMethodArgName(TCppMethod_t, TCppIndex_t iarg);
187 std::string GetMethodArgType(TCppMethod_t, TCppIndex_t iarg);
193 std::string GetMethodSignature(TCppMethod_t, bool show_formalargs, TCppIndex_t maxargs = (TCppIndex_t)-1);
195 std::string GetMethodPrototype(TCppScope_t scope, TCppMethod_t, bool show_formalargs);
198
200 TCppIndex_t GetNumTemplatedMethods(TCppScope_t scope, bool accept_namespace = false);
202 std::string GetTemplatedMethodName(TCppScope_t scope, TCppIndex_t imeth);
206 bool ExistsMethodTemplate(TCppScope_t scope, const std::string& name);
208 bool IsMethodTemplate(TCppScope_t scope, TCppIndex_t imeth);
211 TCppScope_t scope, const std::string& name, const std::string& proto);
212
215 TCppType_t scope, const std::string& lc, const std::string& rc, const std::string& op);
216
217// method properties ---------------------------------------------------------
219 bool IsPublicMethod(TCppMethod_t method);
221 bool IsProtectedMethod(TCppMethod_t method);
223 bool IsConstructor(TCppMethod_t method);
225 bool IsDestructor(TCppMethod_t method);
227 bool IsStaticMethod(TCppMethod_t method);
228
229// data member reflection information ----------------------------------------
231 TCppIndex_t GetNumDatamembers(TCppScope_t scope, bool accept_namespace = false);
233 std::string GetDatamemberName(TCppScope_t scope, TCppIndex_t idata);
235 std::string GetDatamemberType(TCppScope_t scope, TCppIndex_t idata);
237 intptr_t GetDatamemberOffset(TCppScope_t scope, TCppIndex_t idata);
239 TCppIndex_t GetDatamemberIndex(TCppScope_t scope, const std::string& name);
240
241// data member properties ----------------------------------------------------
243 bool IsPublicData(TCppScope_t scope, TCppIndex_t idata);
245 bool IsProtectedData(TCppScope_t scope, TCppIndex_t idata);
247 bool IsStaticData(TCppScope_t scope, TCppIndex_t idata);
249 bool IsConstData(TCppScope_t scope, TCppIndex_t idata);
251 bool IsEnumData(TCppScope_t scope, TCppIndex_t idata);
253 int GetDimensionSize(TCppScope_t scope, TCppIndex_t idata, int dimension);
254
255// enum properties -----------------------------------------------------------
257 TCppEnum_t GetEnum(TCppScope_t scope, const std::string& enum_name);
261 std::string GetEnumDataName(TCppEnum_t, TCppIndex_t idata);
263 long long GetEnumDataValue(TCppEnum_t, TCppIndex_t idata);
264
265} // namespace Cppyy
266
267#endif // !CPYCPPYY_CPPYY_H
static Roo_reg_AGKInteg1D instance
long double LongDouble_t
Definition RtypesCore.h:61
long long Long64_t
Definition RtypesCore.h:69
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h length
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h req_type
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
char name[80]
Definition TGX11.cxx:110
const char * proto
Definition civetweb.c:17536
long double LongDouble_t
Definition cpp_cppyy.h:15
long long Long64_t
Definition cpp_cppyy.h:13
unsigned long long ULong64_t
Definition cpp_cppyy.h:14
size_t TCppIndex_t
Definition cpp_cppyy.h:24
RPY_EXPORTED TCppIndex_t GetNumTemplatedMethods(TCppScope_t scope, bool accept_namespace=false)
RPY_EXPORTED std::string GetMethodMangledName(TCppMethod_t)
RPY_EXPORTED TCppObject_t CallO(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args, TCppType_t result_type)
RPY_EXPORTED int CallI(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED TCppIndex_t CompareMethodArgType(TCppMethod_t, TCppIndex_t iarg, const std::string &req_type)
RPY_EXPORTED ptrdiff_t GetBaseOffset(TCppType_t derived, TCppType_t base, TCppObject_t address, int direction, bool rerror=false)
RPY_EXPORTED void DeallocateFunctionArgs(void *args)
RPY_EXPORTED bool IsEnumData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED unsigned char CallB(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED Long64_t CallLL(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsAbstract(TCppType_t type)
RPY_EXPORTED size_t SizeOf(TCppType_t klass)
RPY_EXPORTED TCppObject_t CallConstructor(TCppMethod_t method, TCppType_t type, size_t nargs, void *args)
intptr_t TCppMethod_t
Definition cpp_cppyy.h:22
RPY_EXPORTED void * AllocateFunctionArgs(size_t nargs)
RPY_EXPORTED bool IsDefaultConstructable(TCppType_t type)
RPY_EXPORTED bool IsTemplate(const std::string &template_name)
RPY_EXPORTED TCppIndex_t GetMethodReqArgs(TCppMethod_t)
RPY_EXPORTED bool IsEnum(const std::string &type_name)
RPY_EXPORTED std::vector< TCppIndex_t > GetMethodIndicesFromName(TCppScope_t scope, const std::string &name)
RPY_EXPORTED bool ExistsMethodTemplate(TCppScope_t scope, const std::string &name)
RPY_EXPORTED TCppIndex_t GetNumDatamembers(TCppScope_t scope, bool accept_namespace=false)
RPY_EXPORTED std::string ToString(TCppType_t klass, TCppObject_t obj)
RPY_EXPORTED std::string GetMethodName(TCppMethod_t)
RPY_EXPORTED bool IsConstData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED void AddSmartPtrType(const std::string &)
RPY_EXPORTED bool Compile(const std::string &code, bool silent=false)
RPY_EXPORTED void CallDestructor(TCppType_t type, TCppObject_t self)
RPY_EXPORTED TCppScope_t gGlobalScope
Definition cpp_cppyy.h:53
RPY_EXPORTED bool IsProtectedData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED std::string GetMethodSignature(TCppMethod_t, bool show_formalargs, TCppIndex_t maxargs=(TCppIndex_t) -1)
RPY_EXPORTED int GetDimensionSize(TCppScope_t scope, TCppIndex_t idata, int dimension)
RPY_EXPORTED bool IsSubtype(TCppType_t derived, TCppType_t base)
RPY_EXPORTED TCppMethod_t GetMethodTemplate(TCppScope_t scope, const std::string &name, const std::string &proto)
void * TCppObject_t
Definition cpp_cppyy.h:21
RPY_EXPORTED bool IsConstructor(TCppMethod_t method)
RPY_EXPORTED TCppIndex_t GetNumMethods(TCppScope_t scope, bool accept_namespace=false)
RPY_EXPORTED TCppObject_t Construct(TCppType_t type, void *arena=nullptr)
RPY_EXPORTED bool GetSmartPtrInfo(const std::string &, TCppType_t *raw, TCppMethod_t *deref)
RPY_EXPORTED char CallC(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string GetMethodArgName(TCppMethod_t, TCppIndex_t iarg)
RPY_EXPORTED double CallD(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED size_t GetFunctionArgTypeoffset()
RPY_EXPORTED TCppObject_t Allocate(TCppType_t type)
RPY_EXPORTED void Destruct(TCppType_t type, TCppObject_t instance)
RPY_EXPORTED std::string ResolveName(const std::string &cppitem_name)
TCppScope_t TCppType_t
Definition cpp_cppyy.h:19
RPY_EXPORTED void AddTypeReducer(const std::string &reducable, const std::string &reduced)
RPY_EXPORTED std::string ResolveEnum(const std::string &enum_type)
RPY_EXPORTED long long GetEnumDataValue(TCppEnum_t, TCppIndex_t idata)
RPY_EXPORTED bool IsAggregate(TCppType_t type)
RPY_EXPORTED TCppIndex_t GetMethodNumArgs(TCppMethod_t)
RPY_EXPORTED TCppType_t GetActualClass(TCppType_t klass, TCppObject_t obj)
RPY_EXPORTED std::string GetBaseName(TCppType_t type, TCppIndex_t ibase)
RPY_EXPORTED bool IsNamespace(TCppScope_t scope)
void * TCppEnum_t
Definition cpp_cppyy.h:20
RPY_EXPORTED float CallF(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED std::string GetScopedFinalName(TCppType_t type)
RPY_EXPORTED void Deallocate(TCppType_t type, TCppObject_t instance)
RPY_EXPORTED bool IsPublicData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED std::string GetMethodArgType(TCppMethod_t, TCppIndex_t iarg)
RPY_EXPORTED long CallL(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 GetEnumDataName(TCppEnum_t, TCppIndex_t idata)
RPY_EXPORTED void GetAllCppNames(TCppScope_t scope, std::set< std::string > &cppnames)
RPY_EXPORTED bool IsComplete(const std::string &type_name)
RPY_EXPORTED bool IsBuiltin(const std::string &type_name)
RPY_EXPORTED bool IsStaticMethod(TCppMethod_t method)
RPY_EXPORTED TCppIndex_t GetDatamemberIndex(TCppScope_t scope, const std::string &name)
RPY_EXPORTED void CallV(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED LongDouble_t CallLD(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsStaticData(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED std::string GetDatamemberType(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED TCppMethod_t GetMethod(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED bool IsDestructor(TCppMethod_t method)
RPY_EXPORTED bool IsSmartPtr(TCppType_t type)
RPY_EXPORTED std::string GetTemplatedMethodName(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED size_t GetFunctionArgSizeof()
RPY_EXPORTED TCppScope_t GetScope(const std::string &scope_name)
RPY_EXPORTED bool HasVirtualDestructor(TCppType_t type)
RPY_EXPORTED bool IsConstMethod(TCppMethod_t)
RPY_EXPORTED bool HasComplexHierarchy(TCppType_t type)
RPY_EXPORTED std::vector< TCppScope_t > GetUsingNamespaces(TCppScope_t)
size_t TCppScope_t
Definition cpp_cppyy.h:18
RPY_EXPORTED bool IsTemplatedConstructor(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED TCppIndex_t GetGlobalOperator(TCppType_t scope, const std::string &lc, const std::string &rc, const std::string &op)
RPY_EXPORTED TCppFuncAddr_t GetFunctionAddress(TCppMethod_t method, bool check_enabled=true)
RPY_EXPORTED TCppIndex_t GetNumEnumData(TCppEnum_t)
RPY_EXPORTED TCppIndex_t GetNumBases(TCppType_t type)
RPY_EXPORTED TCppIndex_t GetNumBasesLongestBranch(TCppType_t type)
Retrieve number of base classes in the longest branch of the inheritance tree.
RPY_EXPORTED std::string GetMethodPrototype(TCppScope_t scope, TCppMethod_t, bool show_formalargs)
RPY_EXPORTED std::string GetMethodResultType(TCppMethod_t)
RPY_EXPORTED std::string GetFinalName(TCppType_t type)
RPY_EXPORTED char * CallS(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args, size_t *length)
RPY_EXPORTED std::string GetMethodArgDefault(TCppMethod_t, TCppIndex_t iarg)
RPY_EXPORTED bool IsMethodTemplate(TCppScope_t scope, TCppIndex_t imeth)
RPY_EXPORTED std::string GetDatamemberName(TCppScope_t scope, TCppIndex_t idata)
RPY_EXPORTED bool IsPublicMethod(TCppMethod_t method)
RPY_EXPORTED intptr_t GetDatamemberOffset(TCppScope_t scope, TCppIndex_t idata)
void * TCppFuncAddr_t
Definition cpp_cppyy.h:25
RPY_EXPORTED std::string GetMethodFullName(TCppMethod_t)
RPY_EXPORTED short CallH(TCppMethod_t method, TCppObject_t self, size_t nargs, void *args)
RPY_EXPORTED bool IsProtectedMethod(TCppMethod_t method)
RPY_EXPORTED TCppEnum_t GetEnum(TCppScope_t scope, const std::string &enum_name)
#define RPY_EXPORTED