/* * Python object definition of the sequence and iterator object of extension blocks * * Copyright (C) 2010-2024, Joachim Metz * * Refer to AUTHORS for acknowledgements. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see . */ #include #include #if defined( HAVE_STDLIB_H ) || defined( HAVE_WINAPI ) #include #endif #include "pyfwsi_extension_block.h" #include "pyfwsi_extension_blocks.h" #include "pyfwsi_libcerror.h" #include "pyfwsi_libfwsi.h" #include "pyfwsi_python.h" PySequenceMethods pyfwsi_extension_blocks_sequence_methods = { /* sq_length */ (lenfunc) pyfwsi_extension_blocks_len, /* sq_concat */ 0, /* sq_repeat */ 0, /* sq_item */ (ssizeargfunc) pyfwsi_extension_blocks_getitem, /* sq_slice */ 0, /* sq_ass_item */ 0, /* sq_ass_slice */ 0, /* sq_contains */ 0, /* sq_inplace_concat */ 0, /* sq_inplace_repeat */ 0 }; PyTypeObject pyfwsi_extension_blocks_type_object = { PyVarObject_HEAD_INIT( NULL, 0 ) /* tp_name */ "pyfwsi.extension_blocks", /* tp_basicsize */ sizeof( pyfwsi_extension_blocks_t ), /* tp_itemsize */ 0, /* tp_dealloc */ (destructor) pyfwsi_extension_blocks_free, /* tp_print */ 0, /* tp_getattr */ 0, /* tp_setattr */ 0, /* tp_compare */ 0, /* tp_repr */ 0, /* tp_as_number */ 0, /* tp_as_sequence */ &pyfwsi_extension_blocks_sequence_methods, /* tp_as_mapping */ 0, /* tp_hash */ 0, /* tp_call */ 0, /* tp_str */ 0, /* tp_getattro */ 0, /* tp_setattro */ 0, /* tp_as_buffer */ 0, /* tp_flags */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER, /* tp_doc */ "pyfwsi sequence and iterator object of extension blocks", /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ 0, /* tp_weaklistoffset */ 0, /* tp_iter */ (getiterfunc) pyfwsi_extension_blocks_iter, /* tp_iternext */ (iternextfunc) pyfwsi_extension_blocks_iternext, /* tp_methods */ 0, /* tp_members */ 0, /* tp_getset */ 0, /* tp_base */ 0, /* tp_dict */ 0, /* tp_descr_get */ 0, /* tp_descr_set */ 0, /* tp_dictoffset */ 0, /* tp_init */ (initproc) pyfwsi_extension_blocks_init, /* tp_alloc */ 0, /* tp_new */ 0, /* tp_free */ 0, /* tp_is_gc */ 0, /* tp_bases */ NULL, /* tp_mro */ NULL, /* tp_cache */ NULL, /* tp_subclasses */ NULL, /* tp_weaklist */ NULL, /* tp_del */ 0 }; /* Creates a new extension blocks sequence and iterator object * Returns a Python object if successful or NULL on error */ PyObject *pyfwsi_extension_blocks_new( PyObject *parent_object, PyObject* (*get_item_by_index)( PyObject *parent_object, int index ), int number_of_items ) { pyfwsi_extension_blocks_t *sequence_object = NULL; static char *function = "pyfwsi_extension_blocks_new"; if( parent_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid parent object.", function ); return( NULL ); } if( get_item_by_index == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid get item by index function.", function ); return( NULL ); } /* Make sure the extension blocks values are initialized */ sequence_object = PyObject_New( struct pyfwsi_extension_blocks, &pyfwsi_extension_blocks_type_object ); if( sequence_object == NULL ) { PyErr_Format( PyExc_MemoryError, "%s: unable to create sequence object.", function ); goto on_error; } sequence_object->parent_object = parent_object; sequence_object->get_item_by_index = get_item_by_index; sequence_object->current_index = 0; sequence_object->number_of_items = number_of_items; Py_IncRef( (PyObject *) sequence_object->parent_object ); return( (PyObject *) sequence_object ); on_error: if( sequence_object != NULL ) { Py_DecRef( (PyObject *) sequence_object ); } return( NULL ); } /* Initializes an extension blocks sequence and iterator object * Returns 0 if successful or -1 on error */ int pyfwsi_extension_blocks_init( pyfwsi_extension_blocks_t *sequence_object ) { static char *function = "pyfwsi_extension_blocks_init"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return( -1 ); } /* Make sure the extension blocks values are initialized */ sequence_object->parent_object = NULL; sequence_object->get_item_by_index = NULL; sequence_object->current_index = 0; sequence_object->number_of_items = 0; PyErr_Format( PyExc_NotImplementedError, "%s: initialize of extension blocks not supported.", function ); return( -1 ); } /* Frees an extension blocks sequence object */ void pyfwsi_extension_blocks_free( pyfwsi_extension_blocks_t *sequence_object ) { struct _typeobject *ob_type = NULL; static char *function = "pyfwsi_extension_blocks_free"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return; } ob_type = Py_TYPE( sequence_object ); if( ob_type == NULL ) { PyErr_Format( PyExc_ValueError, "%s: missing ob_type.", function ); return; } if( ob_type->tp_free == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid ob_type - missing tp_free.", function ); return; } if( sequence_object->parent_object != NULL ) { Py_DecRef( (PyObject *) sequence_object->parent_object ); } ob_type->tp_free( (PyObject*) sequence_object ); } /* The extension blocks len() function */ Py_ssize_t pyfwsi_extension_blocks_len( pyfwsi_extension_blocks_t *sequence_object ) { static char *function = "pyfwsi_extension_blocks_len"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return( -1 ); } return( (Py_ssize_t) sequence_object->number_of_items ); } /* The extension blocks getitem() function */ PyObject *pyfwsi_extension_blocks_getitem( pyfwsi_extension_blocks_t *sequence_object, Py_ssize_t item_index ) { PyObject *extension_block_object = NULL; static char *function = "pyfwsi_extension_blocks_getitem"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return( NULL ); } if( sequence_object->get_item_by_index == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object - missing get item by index function.", function ); return( NULL ); } if( sequence_object->number_of_items < 0 ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object - invalid number of items.", function ); return( NULL ); } if( ( item_index < 0 ) || ( item_index >= (Py_ssize_t) sequence_object->number_of_items ) ) { PyErr_Format( PyExc_ValueError, "%s: invalid invalid item index value out of bounds.", function ); return( NULL ); } extension_block_object = sequence_object->get_item_by_index( sequence_object->parent_object, (int) item_index ); return( extension_block_object ); } /* The extension blocks iter() function */ PyObject *pyfwsi_extension_blocks_iter( pyfwsi_extension_blocks_t *sequence_object ) { static char *function = "pyfwsi_extension_blocks_iter"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return( NULL ); } Py_IncRef( (PyObject *) sequence_object ); return( (PyObject *) sequence_object ); } /* The extension blocks iternext() function */ PyObject *pyfwsi_extension_blocks_iternext( pyfwsi_extension_blocks_t *sequence_object ) { PyObject *extension_block_object = NULL; static char *function = "pyfwsi_extension_blocks_iternext"; if( sequence_object == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object.", function ); return( NULL ); } if( sequence_object->get_item_by_index == NULL ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object - missing get item by index function.", function ); return( NULL ); } if( sequence_object->current_index < 0 ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object - invalid current index.", function ); return( NULL ); } if( sequence_object->number_of_items < 0 ) { PyErr_Format( PyExc_ValueError, "%s: invalid sequence object - invalid number of items.", function ); return( NULL ); } if( sequence_object->current_index >= sequence_object->number_of_items ) { PyErr_SetNone( PyExc_StopIteration ); return( NULL ); } extension_block_object = sequence_object->get_item_by_index( sequence_object->parent_object, sequence_object->current_index ); if( extension_block_object != NULL ) { sequence_object->current_index++; } return( extension_block_object ); }