1 /*************************************************************************************************** 2 3 Zyan Core Library (Zycore-C) 4 5 Original Author : Florian Bernd 6 7 * Permission is hereby granted, free of charge, to any person obtaining a copy 8 * of this software and associated documentation files (the "Software"), to deal 9 * in the Software without restriction, including without limitation the rights 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 * copies of the Software, and to permit persons to whom the Software is 12 * furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in all 15 * copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 * SOFTWARE. 24 25 ***************************************************************************************************/ 26 27 /** 28 * @file 29 * Defines some generic object-related datatypes. 30 */ 31 32 #ifndef ZYCORE_OBJECT_H 33 #define ZYCORE_OBJECT_H 34 35 #include <Zycore/Status.h> 36 #include <Zycore/Types.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* ============================================================================================== */ 43 /* Enums and types */ 44 /* ============================================================================================== */ 45 46 /** 47 * Defines the `ZyanMemberProcedure` function prototype. 48 * 49 * @param object A pointer to the object. 50 */ 51 typedef void (*ZyanMemberProcedure)(void* object); 52 53 /** 54 * Defines the `ZyanConstMemberProcedure` function prototype. 55 * 56 * @param object A pointer to the object. 57 */ 58 typedef void (*ZyanConstMemberProcedure)(const void* object); 59 60 /** 61 * Defines the `ZyanMemberFunction` function prototype. 62 * 63 * @param object A pointer to the object. 64 * 65 * @return A zyan status code. 66 */ 67 typedef ZyanStatus (*ZyanMemberFunction)(void* object); 68 69 /** 70 * Defines the `ZyanConstMemberFunction` function prototype. 71 * 72 * @param object A pointer to the object. 73 * 74 * @return A zyan status code. 75 */ 76 typedef ZyanStatus (*ZyanConstMemberFunction)(const void* object); 77 78 /* ============================================================================================== */ 79 80 #ifdef __cplusplus 81 } 82 #endif 83 84 #endif /* ZYCORE_OBJECT_H */ 85