John McCardle
167636ce8c
closes #72 ref #69 - this resolves the "UICollection" (not "UIEntityCollection", perhaps renamed since the issue opened) and "UIEntityCollection" portion. The Grid point based iterators were not updated. **RPATH updates** Will this RPATH setting allow McRogueFace to execute using its included "lib" subdirectory after being unzipped on a new computer? The change from "./lib" to "$ORIGIN/./lib" improves portability. The $ORIGIN token is a special Linux/Unix convention that refers to the directory containing the executable itself. This makes the path relative to the executable's location rather than the current working directory, which means McRogueFace will correctly find its libraries in the lib subdirectory regardless of where it's run from after being unzipped on a new computer. **New standard object initialization** PyColor, PyVector - Fixed all 15 PyTypeObject definitions to use proper designated initializer syntax - Replaced PyType_GenericAlloc usage in PyColor.cpp and PyVector.cpp - Updated PyObject_New usage in UIEntity.cpp - All object creation now uses module-based type lookups instead of static references - Created centralized utilities in PyObjectUtils.h **RAII Wrappers** automatic reference counting via C++ object lifecycle - Created PyRAII.h with PyObjectRef and PyTypeRef classes - These provide automatic reference counting management - Updated PyColor::from_arg() to demonstrate RAII usage - Prevents memory leaks and reference counting errors **Python object base in type defs:** `.ob_base = {.ob_base = {.ob_refcnt = 1, .ob_type = NULL}, .ob_size = 0}` PyColor, PyTexture, PyVector, UICaption, UICollection, UIEntity, UIFrame, UIGrid **convertDrawableToPython** replace crazy macro to detect the correct Python type of a UIDrawable instance - Removed the problematic macro from UIDrawable.h - Created template-based functions in PyObjectUtils.h - Updated UICollection.cpp to use local helper function - The new approach is cleaner, more debuggable, and avoids static type references **Iterator fixes** tp_iter on UICollection, UIGrid, UIGridPoint, UISprite UIGrid logic improved, standard **List vs Vector usage analysis** there are different use cases that weren't standardized: - UICollection (for Frame children) uses std::vector<std::shared_ptr<UIDrawable>> - UIEntityCollection (for Grid entities) uses std::list<std::shared_ptr<UIEntity>> The rationale is currently connected to frequency of expected changes. * A "UICollection" is likely either all visible or not; it's also likely to be created once and have a static set of contents. They should be contiguous in memory in hopes that this helps rendering speed. * A "UIEntityCollection" is expected to be rendered as a subset within the visible rectangle of the UIGrid. Scrolling the grid or gameplay logic is likely to frequently create and destroy entities. In general I expect Entity collections to have a much higher common size than UICollections. For these reasons I've made them Lists in hopes that they never have to be reallocated or moved during a frame.
90 lines
3.7 KiB
C++
90 lines
3.7 KiB
C++
#pragma once
|
|
#include "Common.h"
|
|
#include "Python.h"
|
|
|
|
#include "UIDrawable.h"
|
|
|
|
class UICollectionIter
|
|
{
|
|
// really more of a namespace: all the members are public and static. But being consistent with other UI objects
|
|
public:
|
|
static int init(PyUICollectionIterObject* self, PyObject* args, PyObject* kwds);
|
|
static PyObject* next(PyUICollectionIterObject* self);
|
|
static PyObject* repr(PyUICollectionIterObject* self);
|
|
};
|
|
|
|
class UICollection
|
|
{
|
|
// really more of a namespace: all the members are public and static. But being consistent with other UI objects
|
|
public:
|
|
static Py_ssize_t len(PyUICollectionObject* self);
|
|
static PyObject* getitem(PyUICollectionObject* self, Py_ssize_t index);
|
|
static PySequenceMethods sqmethods;
|
|
static PyObject* append(PyUICollectionObject* self, PyObject* o);
|
|
static PyObject* remove(PyUICollectionObject* self, PyObject* o);
|
|
static PyMethodDef methods[];
|
|
static PyObject* repr(PyUICollectionObject* self);
|
|
static int init(PyUICollectionObject* self, PyObject* args, PyObject* kwds);
|
|
static PyObject* iter(PyUICollectionObject* self);
|
|
};
|
|
|
|
namespace mcrfpydef {
|
|
static PyTypeObject PyUICollectionIterType = {
|
|
.ob_base = {.ob_base = {.ob_refcnt = 1, .ob_type = NULL}, .ob_size = 0},
|
|
.tp_name = "mcrfpy.UICollectionIter",
|
|
.tp_basicsize = sizeof(PyUICollectionIterObject),
|
|
.tp_itemsize = 0,
|
|
//TODO - as static method, not inline lambda def, please
|
|
.tp_dealloc = (destructor)[](PyObject* self)
|
|
{
|
|
PyUICollectionIterObject* obj = (PyUICollectionIterObject*)self;
|
|
obj->data.reset();
|
|
Py_TYPE(self)->tp_free(self);
|
|
},
|
|
.tp_repr = (reprfunc)UICollectionIter::repr,
|
|
.tp_flags = Py_TPFLAGS_DEFAULT,
|
|
.tp_doc = PyDoc_STR("Iterator for a collection of UI objects"),
|
|
.tp_iter = PyObject_SelfIter,
|
|
.tp_iternext = (iternextfunc)UICollectionIter::next,
|
|
//.tp_getset = PyUICollection_getset,
|
|
.tp_init = (initproc)UICollectionIter::init, // just raise an exception
|
|
.tp_alloc = PyType_GenericAlloc,
|
|
//TODO - as static method, not inline lambda def, please
|
|
.tp_new = [](PyTypeObject* type, PyObject* args, PyObject* kwds) -> PyObject*
|
|
{
|
|
PyErr_SetString(PyExc_TypeError, "UICollection cannot be instantiated: a C++ data source is required.");
|
|
return NULL;
|
|
}
|
|
};
|
|
|
|
static PyTypeObject PyUICollectionType = {
|
|
.ob_base = {.ob_base = {.ob_refcnt = 1, .ob_type = NULL}, .ob_size = 0},
|
|
.tp_name = "mcrfpy.UICollection",
|
|
.tp_basicsize = sizeof(PyUICollectionObject),
|
|
.tp_itemsize = 0,
|
|
//TODO - as static method, not inline lambda def, please
|
|
.tp_dealloc = (destructor)[](PyObject* self)
|
|
{
|
|
PyUICollectionObject* obj = (PyUICollectionObject*)self;
|
|
obj->data.reset();
|
|
Py_TYPE(self)->tp_free(self);
|
|
},
|
|
.tp_repr = (reprfunc)UICollection::repr,
|
|
.tp_as_sequence = &UICollection::sqmethods,
|
|
.tp_flags = Py_TPFLAGS_DEFAULT,
|
|
.tp_doc = PyDoc_STR("Iterable, indexable collection of UI objects"),
|
|
.tp_iter = (getiterfunc)UICollection::iter,
|
|
.tp_methods = UICollection::methods, // append, remove
|
|
//.tp_getset = PyUICollection_getset,
|
|
.tp_init = (initproc)UICollection::init, // just raise an exception
|
|
//TODO - as static method, not inline lambda def, please
|
|
.tp_new = [](PyTypeObject* type, PyObject* args, PyObject* kwds) -> PyObject*
|
|
{
|
|
// Does PyUICollectionType need __new__ if it's not supposed to be instantiable by the user?
|
|
// Should I just raise an exception? Or is the uninitialized shared_ptr enough of a blocker?
|
|
PyErr_SetString(PyExc_TypeError, "UICollection cannot be instantiated: a C++ data source is required.");
|
|
return NULL;
|
|
}
|
|
};
|
|
|
|
}
|