1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef BASEWRAPPER_P_H
#define BASEWRAPPER_P_H
#include "sbkpython.h"
#include "basewrapper.h"
#include <unordered_map>
#include <set>
#include <string>
#include <vector>
#include <iosfwd>
struct SbkObject;
struct SbkConverter;
namespace Shiboken
{
/**
* This mapping associates a method and argument of an wrapper object with the wrapper of
* said argument when it needs the binding to help manage its reference count.
*/
using RefCountMap = std::unordered_multimap<std::string, PyObject *> ;
/// Linked list of SbkBaseWrapper pointers
using ChildrenList = std::set<SbkObject *>;
/// Structure used to store information about object parent and children.
struct ParentInfo
{
/// Pointer to parent object.
SbkObject *parent = nullptr;
/// List of object children.
ChildrenList children;
/// has internal ref
bool hasWrapperRef = false;
};
} // namespace Shiboken
extern "C"
{
/**
* \internal
* Private data for SbkBaseWrapper
*/
struct SbkObjectPrivate
{
SbkObjectPrivate() noexcept = default;
SbkObjectPrivate(const SbkObjectPrivate &) = delete;
SbkObjectPrivate(SbkObjectPrivate &&o) = delete;
SbkObjectPrivate &operator=(const SbkObjectPrivate &) = delete;
SbkObjectPrivate &operator=(SbkObjectPrivate &&o) = delete;
/// Pointer to the C++ class.
void ** cptr;
/// True when Python is responsible for freeing the used memory.
unsigned int hasOwnership : 1;
/// This is true when the C++ class of the wrapped object has a virtual destructor AND was created by Python.
unsigned int containsCppWrapper : 1;
/// Marked as false when the object is lost to C++ and the binding can not know if it was deleted or not.
unsigned int validCppObject : 1;
/// Marked as true when the object constructor was called
unsigned int cppObjectCreated : 1;
/// PYSIDE-1470: Marked as true if this is the Q*Application singleton.
/// This bit allows app deletion from shiboken?.delete() .
unsigned int isQAppSingleton : 1;
/// Information about the object parents and children, may be null.
Shiboken::ParentInfo *parentInfo;
/// Manage reference count of objects that are referred to but not owned from.
Shiboken::RefCountMap *referredObjects;
~SbkObjectPrivate()
{
delete parentInfo;
parentInfo = nullptr;
delete referredObjects;
referredObjects = nullptr;
}
};
// TODO-CONVERTERS: to be deprecated/removed
/// The type behaviour was not defined yet
#define BEHAVIOUR_UNDEFINED 0
/// The type is a value type
#define BEHAVIOUR_VALUETYPE 1
/// The type is an object type
#define BEHAVIOUR_OBJECTTYPE 2
struct SbkObjectTypePrivate
{
SbkConverter *converter;
int *mi_offsets;
MultipleInheritanceInitFunction mi_init;
/// Special cast function, null if this class doesn't have multiple inheritance.
SpecialCastFunction mi_specialcast;
TypeDiscoveryFuncV2 type_discovery;
/// Pointer to a function responsible for deletion of the C++ instance calling the proper destructor.
ObjectDestructor cpp_dtor;
/// C++ name
char *original_name;
/// Type user data
void *user_data;
DeleteUserDataFunc d_func;
void (*subtype_init)(PyTypeObject *, PyObject *, PyObject *);
const char **propertyStrings;
const char **enumFlagInfo;
PyObject *enumFlagsDict;
PyObject *enumTypeDict;
/// True if this type holds two or more C++ instances, e.g.: a Python class which inherits from two C++ classes.
unsigned int is_multicpp : 1;
/// True if this type was defined by the user (a class written in Python inheriting
/// a class provided by a Shiboken binding).
unsigned int is_user_type : 1;
/// Tells is the type is a value type or an object-type, see BEHAVIOUR_ *constants.
unsigned int type_behaviour : 2;
unsigned int delete_in_main_thread : 1;
};
} // extern "C"
namespace Shiboken
{
/**
* \internal
* Data required to invoke a C++ destructor
*/
struct DestructorEntry
{
ObjectDestructor destructor;
void *cppInstance;
};
/**
* Utility function used to transform a PyObject that implements sequence protocol into a std::list.
**/
std::vector<SbkObject *> splitPyObject(PyObject *pyObj);
int getNumberOfCppBaseClasses(PyTypeObject *baseType);
namespace Object
{
/**
* Decrements the reference counters of every object referred by self.
* \param self the wrapper instance that keeps references to other objects.
*/
void clearReferences(SbkObject *self);
/**
* Destroy internal data
**/
void deallocData(SbkObject *self, bool doCleanup);
void _debugFormat(std::ostream &str, SbkObject *self);
} // namespace Object
} // namespace Shiboken
#endif
|