nanocoat/include/lib/scritchui/scritchuiImpl.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  * ScritchUI implementation interface.
  12  *
  13  * @since 2024/04/06
  14  */
  15
  16 #ifndef SQUIRRELJME_SCRITCHUIIMPL_H
  17 #define SQUIRRELJME_SCRITCHUIIMPL_H
  18
  19 #include "lib/scritchui/scritchui.h"
  20
  21 /* Anti-C++. */
  22 #ifdef __cplusplus
  23         #ifndef SJME_CXX_IS_EXTERNED
  24                 #define SJME_CXX_IS_EXTERNED
  25                 #define SJME_CXX_SQUIRRELJME_SCRITCHUIIMPL_H
  26 extern "C" {
  27         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  28 #endif     /* #ifdef __cplusplus */
  29
  30 /*--------------------------------------------------------------------------*/
  31
  32 /**
  33  * Obtains the core listener for the given type.
  34  *
  35  * @param item The structure to access.
  36  * @param specific The specific listener that is wanted.
  37  * @return A pointer to the listener info.
  38  * @since 2024/05/01
  39  */
  40 #define SJME_SCRITCHUI_LISTENER_CORE(item, specific) \
  41         ((item)->listeners[SJME_SCRITCHUI_LISTENER_CORE].specific)
  42
  43 /**
  44  * Obtains the user listener for the given type.
  45  *
  46  * @param item The structure to access.
  47  * @param specific The specific listener that is wanted.
  48  * @return A pointer to the listener info.
  49  * @since 2024/05/01
  50  */
  51 #define SJME_SCRITCHUI_LISTENER_USER(item, specific) \
  52         ((item)->listeners[SJME_SCRITCHUI_LISTENER_USER].specific)
  53
  54 /**
  55  * Implementation specific initialization.
  56  *
  57  * @param inState The state being initialized.
  58  * @return Any resultant error, if any.
  59  * @since 2024/04/15
  60  */
  61 typedef sjme_errorCode (*sjme_scritchui_impl_apiInitFunc)(
  62         sjme_attrInNotNull sjme_scritchui inState);
  63
  64 /**
  65  * Adds the given component to the specified container.
  66  *
  67  * @param inState The input state.
  68  * @param inContainer The container to place the component within.
  69  * @param addComponent The component to add to the container.
  70  * @return Any error code if applicable.
  71  * @since 2024/04/20
  72  */
  73 typedef sjme_errorCode (*sjme_scritchui_impl_containerAddFunc)(
  74         sjme_attrInNotNull sjme_scritchui inState,
  75         sjme_attrInNotNull sjme_scritchui_uiComponent inContainer,
  76         sjme_attrInNotNull sjme_scritchui_uiContainer inContainerData,
  77         sjme_attrInNotNull sjme_scritchui_uiComponent addComponent);
  78
  79 /**
  80  * Removes the given component from the specified container.
  81  *
  82  * @param inState The input state.
  83  * @param inContainer The container to remove the component within.
  84  * @param removeComponent The component to remove from the container.
  85  * @return Any error code if applicable.
  86  * @since 2024/07/15
  87  */
  88 typedef sjme_errorCode (*sjme_scritchui_impl_containerRemoveFunc)(
  89         sjme_attrInNotNull sjme_scritchui inState,
  90         sjme_attrInNotNull sjme_scritchui_uiComponent inContainer,
  91         sjme_attrInNotNull sjme_scritchui_uiContainer inContainerData,
  92         sjme_attrInNotNull sjme_scritchui_uiComponent removeComponent);
  93
  94 /**
  95  * Creates a new native list.
  96  *
  97  * @param inState The input ScritchUI state.
  98  * @param inList The list that was created.
  99  * @return Any error code as per implementation.
 100  * @since 2024/04/06
 101  */
 102 typedef sjme_errorCode (*sjme_scritchui_impl_listNewFunc)(
 103         sjme_attrInNotNull sjme_scritchui inState,
 104         sjme_attrInNotNull sjme_scritchui_uiList inList,
 105         sjme_attrInValue sjme_scritchui_choiceType inChoiceType);
 106
 107 /**
 108  * Creates a new native panel.
 109  *
 110  * @param inState The input ScritchUI state.
 111  * @param inPanel The panel that was created.
 112  * @return Any error code as per implementation.
 113  * @since 2024/04/06
 114  */
 115 typedef sjme_errorCode (*sjme_scritchui_impl_panelNewFunc)(
 116         sjme_attrInNotNull sjme_scritchui inState,
 117         sjme_attrInNotNull sjme_scritchui_uiPanel inPanel);
 118
 119 /**
 120  * Creates a new window.
 121  *
 122  * @param inState The input state.
 123  * @param inWindow The window that was created.
 124  * @return Any resultant error, if any.
 125  * @since 2024/04/24
 126  */
 127 typedef sjme_errorCode (*sjme_scritchui_impl_windowNewFunc)(
 128         sjme_attrInNotNull sjme_scritchui inState,
 129         sjme_attrInNotNull sjme_scritchui_uiWindow inWindow);
 130
 131 #define SJME_SCRITCHUI_QUICK_IMPL(x) \
 132         SJME_TOKEN_PASTE3(sjme_scritchui_impl_, x, Func) x
 133
 134 /** Uses the same main implementation. */
 135 #define SJME_SCRITCHUI_QUICK_SAME(x) \
 136         SJME_TOKEN_PASTE3(sjme_scritchui_, x, Func) x
 137
 138 struct sjme_scritchui_implFunctions
 139 {
 140         /** Initialize implementation API instance. */
 141         SJME_SCRITCHUI_QUICK_IMPL(apiInit);
 142
 143         /** Repaint component. */
 144         SJME_SCRITCHUI_QUICK_SAME(componentRepaint);
 145
 146         /** Revalidate component. */
 147         SJME_SCRITCHUI_QUICK_SAME(componentRevalidate);
 148
 149         /** Sets the input listener for a component. */
 150         SJME_SCRITCHUI_QUICK_SAME(componentSetInputListener);
 151
 152         /** Set paint listener for component. */
 153         SJME_SCRITCHUI_QUICK_SAME(componentSetPaintListener);
 154
 155         /** Set size listener for component. */
 156         SJME_SCRITCHUI_QUICK_SAME(componentSetSizeListener);
 157
 158         /** Sets the listener for component visible events. */
 159         SJME_SCRITCHUI_QUICK_SAME(componentSetVisibleListener);
 160
 161         /** Get size of component. */
 162         SJME_SCRITCHUI_QUICK_SAME(componentSize);
 163
 164         /** Add component to container. */
 165         SJME_SCRITCHUI_QUICK_IMPL(containerAdd);
 166
 167         /** Remove component from container. */
 168         SJME_SCRITCHUI_QUICK_IMPL(containerRemove);
 169
 170         /** Set bounds of component in container. */
 171         SJME_SCRITCHUI_QUICK_SAME(containerSetBounds);
 172
 173         /** Hardware graphics support on arbitrary buffers. */
 174         SJME_SCRITCHUI_QUICK_SAME(hardwareGraphics);
 175
 176         /** Creates a new native list. */
 177         SJME_SCRITCHUI_QUICK_IMPL(listNew);
 178
 179         /** Execute callback within the event loop or schedule later. */
 180         SJME_SCRITCHUI_QUICK_SAME(loopExecute);
 181
 182         /** Execute call later in the loop. */
 183         sjme_scritchui_loopExecuteFunc loopExecuteLater;
 184
 185         /** Execute callback within the event loop and wait until termination. */
 186         sjme_scritchui_loopExecuteFunc loopExecuteWait;
 187
 188         /** Enable/disable focus on a panel. */
 189         SJME_SCRITCHUI_QUICK_SAME(panelEnableFocus);
 190
 191         /** Creates a new native panel. */
 192         SJME_SCRITCHUI_QUICK_IMPL(panelNew);
 193
 194         /** The available screens. */
 195         SJME_SCRITCHUI_QUICK_SAME(screens);
 196
 197         /** Set minimum size of content window. */
 198         SJME_SCRITCHUI_QUICK_SAME(windowContentMinimumSize);
 199
 200         /** Creates a new window. */
 201         SJME_SCRITCHUI_QUICK_IMPL(windowNew);
 202
 203         /** Set close listener for a window. */
 204         SJME_SCRITCHUI_QUICK_SAME(windowSetCloseListener);
 205
 206         /** Sets visibility of the window. */
 207         SJME_SCRITCHUI_QUICK_SAME(windowSetVisible);
 208 };
 209
 210 #undef SJME_SCRITCHUI_QUICK_IMPL
 211 #undef SJME_SCRITCHUI_QUICK_SAME
 212
 213 /**
 214  * Returns the choice for the given component.
 215  *
 216  * @param inState The input state.
 217  * @param inComponent The input component.
 218  * @param outChoice The resultant choice.
 219  * @return Any error code if applicable, such as the component is not valid.
 220  * @since 2024/07/16
 221  */
 222 typedef sjme_errorCode (*sjme_scritchui_intern_getChoiceFunc)(
 223         sjme_attrInNotNull sjme_scritchui inState,
 224         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 225         sjme_attrInOutNotNull sjme_scritchui_uiChoice* outChoice);
 226
 227 /**
 228  * Returns the container for the given component.
 229  *
 230  * @param inState The input state.
 231  * @param inComponent The input component.
 232  * @param outContainer The resultant container.
 233  * @return Any error code if applicable, such as the component is not valid.
 234  * @since 2024/04/20
 235  */
 236 typedef sjme_errorCode (*sjme_scritchui_intern_getContainerFunc)(
 237         sjme_attrInNotNull sjme_scritchui inState,
 238         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 239         sjme_attrInOutNotNull sjme_scritchui_uiContainer* outContainer);
 240
 241 /**
 242  * Returns the container for the given component.
 243  *
 244  * @param inState The input state.
 245  * @param inComponent The input component.
 246  * @param outContainer The resultant container.
 247  * @return Any error code if applicable, such as the component is not valid.
 248  * @since 2024/04/20
 249  */
 250 typedef sjme_errorCode (*sjme_scritchui_intern_getPaintableFunc)(
 251         sjme_attrInNotNull sjme_scritchui inState,
 252         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 253         sjme_attrInOutNotNull sjme_scritchui_uiPaintable* outPaintable);
 254
 255 /**
 256  * Common base common initialization for before and after create.
 257  *
 258  * @param inState The input state.
 259  * @param inCommon The input common.
 260  * @param postCreate Is this after the create call?
 261  * @param uiType The type of common this is.
 262  * @return Any resultant error, if any.
 263  * @since 2024/07/19
 264  */
 265 typedef sjme_errorCode (*sjme_scritchui_intern_initCommonFunc)(
 266         sjme_attrInNotNull sjme_scritchui inState,
 267         sjme_attrInNotNull sjme_scritchui_uiCommon inCommon,
 268         sjme_attrInValue sjme_jboolean postCreate,
 269         sjme_attrInRange(0, SJME_NUM_SCRITCHUI_UI_TYPES)
 270                 sjme_scritchui_uiType uiType);
 271
 272 /**
 273  * Common component initialization function for before and after create.
 274  *
 275  * @param inState The input state.
 276  * @param inComponent The input component.
 277  * @param postCreate Is this after the create call?
 278  * @param uiType The type of component this is.
 279  * @return Any resultant error, if any.
 280  * @since 2024/04/26
 281  */
 282 typedef sjme_errorCode (*sjme_scritchui_intern_initComponentFunc)(
 283         sjme_attrInNotNull sjme_scritchui inState,
 284         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 285         sjme_attrInValue sjme_jboolean postCreate,
 286         sjme_attrInRange(0, SJME_NUM_SCRITCHUI_UI_TYPES)
 287                 sjme_scritchui_uiType uiType);
 288
 289 /**
 290  * Maps the given screen internally.
 291  *
 292  * @param inState The input state.
 293  * @param screenId The screen ID to map.
 294  * @param outScreen The resultant screen, may be newly created or one that
 295  * already exists.
 296  * @param updateHandle If not @c NULL then the handle is updated to this.
 297  * @return Any resultant error, if any.
 298  * @since 2024/04/15
 299  */
 300 typedef sjme_errorCode (*sjme_scritchui_intern_mapScreenFunc)(
 301         sjme_attrInNotNull sjme_scritchui inState,
 302         sjme_attrInValue sjme_jint screenId,
 303         sjme_attrInOutNotNull sjme_scritchui_uiScreen* outScreen,
 304         sjme_attrInNullable sjme_scritchui_handle updateHandle);
 305
 306 /**
 307  * Updates the visibility state of a container.
 308  *
 309  * @param inState The input state.
 310  * @param inContainer The input container.
 311  * @param isVisible Is this now visible?
 312  * @since 2024/06/28
 313  */
 314 typedef sjme_errorCode (*sjme_scritchui_intern_updateVisibleContainerFunc)(
 315         sjme_attrInNotNull sjme_scritchui inState,
 316         sjme_attrInNotNull sjme_scritchui_uiComponent inContainer,
 317         sjme_attrInValue sjme_jboolean isVisible);
 318
 319 /**
 320  * Updates the visibility state of a container.
 321  *
 322  * @param inState The input state.
 323  * @param inComponent The input component.
 324  * @param isVisible Is this now visible?
 325  * @since 2024/06/28
 326  */
 327 typedef sjme_errorCode (*sjme_scritchui_intern_updateVisibleComponentFunc)(
 328         sjme_attrInNotNull sjme_scritchui inState,
 329         sjme_attrInNotNull sjme_scritchui_uiComponent inComponent,
 330         sjme_attrInValue sjme_jboolean isVisible);
 331
 332 /**
 333  * Updates the visibility state of a window.
 334  *
 335  * @param inState The input state.
 336  * @param inWindow The input window.
 337  * @param isVisible Is this now visible?
 338  * @since 2024/06/28
 339  */
 340 typedef sjme_errorCode (*sjme_scritchui_intern_updateVisibleWindowFunc)(
 341         sjme_attrInNotNull sjme_scritchui inState,
 342         sjme_attrInNotNull sjme_scritchui_uiWindow inWindow,
 343         sjme_attrInValue sjme_jboolean isVisible);
 344
 345 struct sjme_scritchui_internFunctions
 346 {
 347         /** Returns the built-in font, this can handle layers. */
 348         sjme_scritchui_fontBuiltinFunc fontBuiltin;
 349
 350         /** Returns the choice for the given component. */
 351         sjme_scritchui_intern_getChoiceFunc getChoice;
 352
 353         /** Returns the container for the given component. */
 354         sjme_scritchui_intern_getContainerFunc getContainer;
 355
 356         /** Returns the paintable for the given component. */
 357         sjme_scritchui_intern_getPaintableFunc getPaintable;
 358
 359         /** Common "common" initialization. */
 360         sjme_scritchui_intern_initCommonFunc initCommon;
 361
 362         /** Common component initialization. */
 363         sjme_scritchui_intern_initComponentFunc initComponent;
 364
 365         /** Maps the given screen. */
 366         sjme_scritchui_intern_mapScreenFunc mapScreen;
 367
 368         /** Update visibility recursively on container. */
 369         sjme_scritchui_intern_updateVisibleContainerFunc updateVisibleContainer;
 370
 371         /** Update visibility on component. */
 372         sjme_scritchui_intern_updateVisibleComponentFunc updateVisibleComponent;
 373
 374         /** Update visibility recursively on window. */
 375         sjme_scritchui_intern_updateVisibleWindowFunc updateVisibleWindow;
 376 };
 377
 378 /*--------------------------------------------------------------------------*/
 379
 380 /* Anti-C++. */
 381 #ifdef __cplusplus
 382         #ifdef SJME_CXX_SQUIRRELJME_SCRITCHUIIMPL_H
 383 }
 384                 #undef SJME_CXX_SQUIRRELJME_SCRITCHUIIMPL_H
 385                 #undef SJME_CXX_IS_EXTERNED
 386         #endif /* #ifdef SJME_CXX_SQUIRRELJME_SCRITCHUIIMPL_H */
 387 #endif     /* #ifdef __cplusplus */
 388
 389 #endif /* SQUIRRELJME_SCRITCHUIIMPL_H */