nanocoat/include/sjme/vmConfig.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  * Virtual machine configuration.
  12  *
  13  * @since 2023/12/03
  14  */
  15
  16 #ifndef SQUIRRELJME_VMCONFIG_H
  17 #define SQUIRRELJME_VMCONFIG_H
  18
  19 #include "sjme/nvm.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_VMCONFIG_H
  26 extern "C" {
  27         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  28 #endif     /* #ifdef __cplusplus */
  29
  30 /*--------------------------------------------------------------------------*/
  31
  32 /**
  33  * The type of setting this is.
  34  *
  35  * @since 2023/12/08
  36  */
  37 typedef enum sjme_vmConfig_settingType
  38 {
  39         /** The number of setting types. */
  40         SJME_NUM_VM_CONFIG_SETTING_TYPES
  41 } sjme_vmConfig_settingType;
  42
  43 /**
  44  * Indicates the category a given configuration setting is in.
  45  *
  46  * @since 2023/12/08
  47  */
  48 typedef enum sjme_vmConfig_categoryType
  49 {
  50         /** The number of category types available. */
  51         SJME_NUM_VM_CONFIG_CATEGORY_TYPES
  52 } sjme_vmConfig_categoryType;
  53
  54 /**
  55  * A flag used for the configuration.
  56  *
  57  * @since 2023/12/08
  58  */
  59 typedef enum sjme_vmConfig_flag
  60 {
  61         /** Default value is defined. */
  62         SJME_VM_CONFIG_FLAG_DEFAULT = 1,
  63
  64         /** Min/Max is defined. */
  65         SJME_VM_CONFIG_FLAG_MIN_MAX = 2,
  66
  67         /** Ticks are defined. */
  68         SJME_VM_CONFIG_FLAG_TICKS = 4,
  69 } sjme_vmConfig_flag;
  70
  71 /**
  72  * Represents a single value.
  73  *
  74  * @since 2023/12/08
  75  */
  76 typedef union sjme_vmConfig_value
  77 {
  78         /** Integer value. */
  79         sjme_jint jint;
  80
  81         /** String value. */
  82         sjme_lpcstr jstring;
  83 } sjme_vmConfig_value;
  84
  85 /**
  86  * Represents a single virtual machine configuration.
  87  *
  88  * @since 2023/12/08
  89  */
  90 typedef struct sjme_vmConfig_setting
  91 {
  92         /** The category this setting is in. */
  93         sjme_vmConfig_categoryType category;
  94
  95         /** The name of this setting. */
  96         sjme_lpcstr name;
  97
  98         /** The type of setting this is. */
  99         sjme_vmConfig_settingType type;
 100
 101         /** Flags for the configuration setting. */
 102         sjme_vmConfig_flag flags;
 103
 104         /** Contains the various values within. */
 105         struct
 106         {
 107                 /** The default value, if any. */
 108                 const sjme_vmConfig_value initial;
 109
 110                 /** The minimum value, if applicable. */
 111                 const sjme_vmConfig_value min;
 112
 113                 /** The maximum value, if applicable. */
 114                 const sjme_vmConfig_value max;
 115
 116                 /** The option tick values that are possible, if applicable. */
 117                 const sjme_vmConfig_value ticks[sjme_flexibleArrayCount];
 118         } value;
 119 } sjme_vmConfig_setting;
 120
 121 /*--------------------------------------------------------------------------*/
 122
 123 /* Anti-C++. */
 124 #ifdef __cplusplus
 125         #ifdef SJME_CXX_SQUIRRELJME_VMCONFIG_H
 126 }
 127                 #undef SJME_CXX_SQUIRRELJME_VMCONFIG_H
 128                 #undef SJME_CXX_IS_EXTERNED
 129         #endif /* #ifdef SJME_CXX_SQUIRRELJME_VMCONFIG_H */
 130 #endif     /* #ifdef __cplusplus */
 131
 132 #endif /* SQUIRRELJME_VMCONFIG_H */