Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
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// import/export (after precommondefs.h from PyPy)
12#define CPPYY_IMPORT extern
13
14// some more types; assumes Cppyy.h follows Python.h
15#ifndef PY_LONG_LONG
16#ifdef _WIN32
17typedef __int64 PY_LONG_LONG;
18#else
19typedef long long PY_LONG_LONG;
20#endif
21#endif
22
23#ifndef PY_ULONG_LONG
24#ifdef _WIN32
25typedef unsigned __int64 PY_ULONG_LONG;
26#else
27typedef unsigned long long PY_ULONG_LONG;
28#endif
29#endif
30
31#ifndef PY_LONG_DOUBLE
32typedef long double PY_LONG_DOUBLE;
33#endif
34
35
36namespace Cppyy {
37
38 typedef size_t TCppScope_t;
39 typedef TCppScope_t TCppType_t;
40 typedef void* TCppEnum_t;
41 typedef void* TCppObject_t;
42 typedef intptr_t TCppMethod_t;
43
44 typedef size_t TCppIndex_t;
45 typedef void* TCppFuncAddr_t;
46
47// direct interpreter access -------------------------------------------------
49 bool Compile(const std::string& code, bool silent = false);
51 std::string ToString(TCppType_t klass, TCppObject_t obj);
52
53// name to opaque C++ scope representation -----------------------------------
55 std::string ResolveName(const std::string& cppitem_name);
57 std::string ResolveEnum(const std::string& enum_type);
59 TCppScope_t GetScope(const std::string& scope_name);
61 TCppType_t GetActualClass(TCppType_t klass, TCppObject_t obj);
63 size_t SizeOf(TCppType_t klass);
65 size_t SizeOf(const std::string& type_name);
66
68 bool IsBuiltin(const std::string& type_name);
70 bool IsComplete(const std::string& type_name);
71
73 TCppScope_t gGlobalScope; // for fast access
74
75// memory management ---------------------------------------------------------
77 TCppObject_t Allocate(TCppType_t type);
79 void Deallocate(TCppType_t type, TCppObject_t instance);
81 TCppObject_t Construct(TCppType_t type, void* arena = nullptr);
83 void Destruct(TCppType_t type, TCppObject_t instance);
84
85// method/function dispatching -----------------------------------------------
87 void CallV(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
89 unsigned char CallB(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
91 char CallC(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
93 short CallH(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
95 int CallI(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
97 long CallL(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
101 float CallF(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
103 double CallD(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
107 void* CallR(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args);
109 char* CallS(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, size_t* length);
111 TCppObject_t CallConstructor(TCppMethod_t method, TCppType_t type, size_t nargs, void* args);
113 void CallDestructor(TCppType_t type, TCppObject_t self);
115 TCppObject_t CallO(TCppMethod_t method, TCppObject_t self, size_t nargs, void* args, TCppType_t result_type);
116
119
120// handling of function argument buffer --------------------------------------
122 void* AllocateFunctionArgs(size_t nargs);
124 void DeallocateFunctionArgs(void* args);
126 size_t GetFunctionArgSizeof();
129
130// scope reflection information ----------------------------------------------
132 bool IsNamespace(TCppScope_t scope);
134 bool IsTemplate(const std::string& template_name);
136 bool IsAbstract(TCppType_t type);
138 bool IsEnum(const std::string& type_name);
140 bool IsAggregate(TCppType_t type);
142 bool IsDefaultConstructable(TCppType_t type);
143
145 void GetAllCppNames(TCppScope_t scope, std::set<std::string>& cppnames);
146
147// namespace reflection information ------------------------------------------
149 std::vector<TCppScope_t> GetUsingNamespaces(TCppScope_t);
150
151// class reflection information ----------------------------------------------
153 std::string GetFinalName(TCppType_t type);
155 std::string GetScopedFinalName(TCppType_t type);
157 bool HasVirtualDestructor(TCppType_t type);
159 bool HasComplexHierarchy(TCppType_t type);
161 TCppIndex_t GetNumBases(TCppType_t type);
165 std::string GetBaseName(TCppType_t type, TCppIndex_t ibase);
167 bool IsSubtype(TCppType_t derived, TCppType_t base);
169 bool IsSmartPtr(TCppType_t type);
171 bool GetSmartPtrInfo(const std::string&, TCppType_t* raw, TCppMethod_t* deref);
173 void AddSmartPtrType(const std::string&);
174
176 void AddTypeReducer(const std::string& reducable, const std::string& reduced);
177
178// calculate offsets between declared and actual type, up-cast: direction > 0; down-cast: direction < 0
180 ptrdiff_t GetBaseOffset(
181 TCppType_t derived, TCppType_t base, TCppObject_t address, int direction, bool rerror = false);
182
183// method/function reflection information ------------------------------------
185 TCppIndex_t GetNumMethods(TCppScope_t scope, bool accept_namespace = false);
187 std::vector<TCppIndex_t> GetMethodIndicesFromName(TCppScope_t scope, const std::string& name);
188
191
193 std::string GetMethodName(TCppMethod_t);
195 std::string GetMethodFullName(TCppMethod_t);
215 std::string GetMethodPrototype(TCppScope_t scope, TCppMethod_t, bool show_formalargs);
218
220 TCppIndex_t GetNumTemplatedMethods(TCppScope_t scope, bool accept_namespace = false);
222 std::string GetTemplatedMethodName(TCppScope_t scope, TCppIndex_t imeth);
226 bool ExistsMethodTemplate(TCppScope_t scope, const std::string& name);
228 bool IsStaticTemplate(TCppScope_t scope, const std::string& name);
230 bool IsMethodTemplate(TCppScope_t scope, TCppIndex_t imeth);
233 TCppScope_t scope, const std::string& name, const std::string& proto);
234
237 TCppType_t scope, const std::string& lc, const std::string& rc, const std::string& op);
238
239// method properties ---------------------------------------------------------
252
253// data member reflection information ----------------------------------------
255 TCppIndex_t GetNumDatamembers(TCppScope_t scope, bool accept_namespace = false);
257 std::string GetDatamemberName(TCppScope_t scope, TCppIndex_t idata);
259 std::string GetDatamemberType(TCppScope_t scope, TCppIndex_t idata);
261 intptr_t GetDatamemberOffset(TCppScope_t scope, TCppIndex_t idata);
263 TCppIndex_t GetDatamemberIndex(TCppScope_t scope, const std::string& name);
264
265// data member properties ----------------------------------------------------
267 bool IsPublicData(TCppScope_t scope, TCppIndex_t idata);
269 bool IsProtectedData(TCppScope_t scope, TCppIndex_t idata);
271 bool IsStaticData(TCppScope_t scope, TCppIndex_t idata);
273 bool IsConstData(TCppScope_t scope, TCppIndex_t idata);
275 bool IsEnumData(TCppScope_t scope, TCppIndex_t idata);
277 int GetDimensionSize(TCppScope_t scope, TCppIndex_t idata, int dimension);
278
279// enum properties -----------------------------------------------------------
281 TCppEnum_t GetEnum(TCppScope_t scope, const std::string& enum_name);
288
289} // namespace Cppyy
290
291#endif // !CPYCPPYY_CPPYY_H
long double PY_LONG_DOUBLE
Definition Cppyy.h:32
unsigned long long PY_ULONG_LONG
Definition Cppyy.h:27
long long PY_LONG_LONG
Definition Cppyy.h:19
#define CPPYY_IMPORT
Definition Cppyy.h:12
static Roo_reg_AGKInteg1D instance
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:18822
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 IsStaticTemplate(TCppScope_t scope, const std::string &name)
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 bool IsExplicit(TCppMethod_t method)
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)