nanocoat/include/lib/scritchui/core/coreGeneric.h

   1 /* -*- Mode: C; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // -------------------------------------------------------------------------*/
   9
  10 /**
  11  * Generic core functions.
  12  *
  13  * @since 2024/07/22
  14  */
  15
  16 #ifndef SQUIRRELJME_COREGENERIC_H
  17 #define SQUIRRELJME_COREGENERIC_H
  18
  19 #include "lib/scritchui/scritchui.h"
  20 #include "lib/scritchui/scritchuiTypes.h"
  21
  22 /* Anti-C++. */
  23 #ifdef __cplusplus
  24         #ifndef SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_IS_EXTERNED
  26                 #define SJME_CXX_SQUIRRELJME_COREGENERIC_H
  27 extern "C"
  28 {
  29         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  30 #endif /* #ifdef __cplusplus */
  31
  32 /*--------------------------------------------------------------------------*/
  33
  34 /**
  35  * Base function for common initialization logic.
  36  *
  37  * @param inState The input state.
  38  * @param inCommon The common item to be initialized.
  39  * @param inData Any data to use for initialization.
  40  * @return Any resultant error, if any.
  41  * @since 2024/07/22
  42  */
  43 typedef sjme_errorCode (*sjme_scritchui_coreGeneric_commonNewImplFunc)(
  44         sjme_attrInNotNull sjme_scritchui inState,
  45         sjme_attrInNotNull sjme_scritchui_uiCommon inCommon,
  46         sjme_attrInNullable sjme_pointer inData);
  47
  48 /**
  49  * Base function for component initialization logic.
  50  *
  51  * @param inState The input state.
  52  * @param inCommon The component item to be initialized.
  53  * @param inData Any data to use for initialization.
  54  * @return Any resultant error, if any.
  55  * @since 2024/07/24
  56  */
  57 typedef sjme_errorCode (*sjme_scritchui_coreGeneric_componentNewImplFunc)(
  58         sjme_attrInNotNull sjme_scritchui inState,
  59         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
  60         sjme_attrInNullable sjme_pointer inData);
  61
  62 /**
  63  * Basic core common initialization logic.
  64  *
  65  * @param inState The input state.
  66  * @param outCommon The resultant common.
  67  * @param outCommonSize The size of the resultant common.
  68  * @param uiType The UI type to initialize.
  69  * @param implNew The implementation new for this type.
  70  * @param inData Any data to pass to @c implNew .
  71  * @return Any resultant error, if any.
  72  * @since 2024/07/22
  73  */
  74 sjme_errorCode sjme_scritchui_coreGeneric_commonNew(
  75         sjme_attrInNotNull sjme_scritchui inState,
  76         sjme_attrInOutNotNull sjme_scritchui_uiCommon* outCommon,
  77         sjme_attrInPositiveNonZero sjme_jint outCommonSize,
  78         sjme_attrInRange(0, SJME_NUM_SCRITCHUI_UI_TYPES)
  79                 sjme_scritchui_uiType uiType,
  80         sjme_attrInNotNull sjme_scritchui_coreGeneric_commonNewImplFunc implNew,
  81         sjme_attrInNullable sjme_pointer inData);
  82
  83 /**
  84  * Basic core component initialization logic.
  85  *
  86  * @param inState The input state.
  87  * @param outComponent The resultant component.
  88  * @param outComponentSize The size of the resultant component.
  89  * @param uiType The UI type to initialize.
  90  * @param implNew The implementation new for this type.
  91  * @param inData Any data to pass to @c implNew .
  92  * @return Any resultant error, if any.
  93  * @since 2024/07/24
  94  */
  95 sjme_errorCode sjme_scritchui_coreGeneric_componentNew(
  96         sjme_attrInNotNull sjme_scritchui inState,
  97         sjme_attrInOutNotNull sjme_scritchui_uiComponent* outComponent,
  98         sjme_attrInPositiveNonZero sjme_jint outComponentSize,
  99         sjme_attrInRange(0, SJME_NUM_SCRITCHUI_UI_TYPES)
 100                 sjme_scritchui_uiType uiType,
 101         sjme_attrInNotNull sjme_scritchui_coreGeneric_componentNewImplFunc implNew,
 102         sjme_attrInNullable sjme_pointer inData);
 103
 104 /*--------------------------------------------------------------------------*/
 105
 106 /* Anti-C++. */
 107 #ifdef __cplusplus
 108         #ifdef SJME_CXX_SQUIRRELJME_COREGENERIC_H
 109 }
 110                 #undef SJME_CXX_SQUIRRELJME_COREGENERIC_H
 111                 #undef SJME_CXX_IS_EXTERNED
 112         #endif /* #ifdef SJME_CXX_SQUIRRELJME_COREGENERIC_H */
 113 #endif /* #ifdef __cplusplus */
 114
 115 #endif /* SQUIRRELJME_COREGENERIC_H */