compiled_cell.h

//     Copyright 2026, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
 
#ifndef __NUITKA_COMPILED_CELL_H__
#define __NUITKA_COMPILED_CELL_H__
 
/* This is a clone of the normal PyCell structure. We should keep it binary
 * compatible, just in case somebody crazy insists on it.
 */
 
extern PyTypeObject Nuitka_Cell_Type;
 
static inline bool Nuitka_Cell_Check(PyObject *object) { return Py_TYPE(object) == &Nuitka_Cell_Type; }
static inline bool Nuitka_CellOrPyCell_Check(PyObject *object) {
    return Nuitka_Cell_Check(object) || PyCell_Check(object);
}
 
struct Nuitka_CellObject {
    /* Python object folklore: */
    PyObject_HEAD
 
        /* Content of the cell or NULL when empty */
        PyObject *ob_ref;
};
 
// Create cell with out value, and with or without reference given.
extern struct Nuitka_CellObject *Nuitka_Cell_NewEmpty(void);
extern struct Nuitka_CellObject *Nuitka_Cell_New0(PyObject *value);
extern struct Nuitka_CellObject *Nuitka_Cell_New1(PyObject *value);
 
// Check stuff while accessing a compile cell in debug mode.
#ifdef __NUITKA_NO_ASSERT__
#define Nuitka_Cell_GET(cell) (((struct Nuitka_CellObject *)(cell))->ob_ref)
#else
#define Nuitka_Cell_GET(cell)                                                                                          \
    (CHECK_OBJECT(cell), assert(Nuitka_Cell_Check((PyObject *)cell)), (((struct Nuitka_CellObject *)(cell))->ob_ref))
#endif
 
NUITKA_MAY_BE_UNUSED static inline PyObject *Nuitka_CellOrPyCell_GET(PyObject *cell) {
    CHECK_OBJECT(cell);
    assert(Nuitka_CellOrPyCell_Check(cell));
 
    return ((struct Nuitka_CellObject *)cell)->ob_ref;
}
 
#if _DEBUG_REFCOUNTS
extern int count_active_Nuitka_Cell_Type;
extern int count_allocated_Nuitka_Cell_Type;
extern int count_released_Nuitka_Cell_Type;
#endif
 
NUITKA_MAY_BE_UNUSED static inline void Nuitka_Cell_SET(struct Nuitka_CellObject *cell_object, PyObject *value) {
    CHECK_OBJECT_X(value);
    CHECK_OBJECT(cell_object);
 
    assert(Nuitka_Cell_Check((PyObject *)cell_object));
    cell_object->ob_ref = value;
}
 
#endif
 
//     Part of "Nuitka", an optimizing Python compiler that is compatible and
//     integrates with CPython, but also works on its own.
//
//     Licensed under the GNU Affero General Public License, Version 3 (the "License");
//     you may not use this file except in compliance with the License.
//     You may obtain a copy of the License at
//
//        http://www.gnu.org/licenses/agpl.txt
//
//     Unless required by applicable law or agreed to in writing, software
//     distributed under the License is distributed on an "AS IS" BASIS,
//     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//     See the License for the specific language governing permissions and
//     limitations under the License.