nanocoat/include/sjme/stdTypes.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  * Standard C types.
  12  *
  13  * @since 2024/08/09
  14  */
  15
  16 #ifndef SQUIRRELJME_STDTYPES_H
  17 #define SQUIRRELJME_STDTYPES_H
  18
  19 #include <stdlib.h>
  20 #include <stdint.h>
  21
  22 #include "sjme/config.h"
  23
  24 /* Anti-C++. */
  25 #ifdef __cplusplus
  26         #ifndef SJME_CXX_IS_EXTERNED
  27                 #define SJME_CXX_IS_EXTERNED
  28                 #define SJME_CXX_SQUIRRELJME_STDTYPES_H
  29 extern "C"
  30 {
  31         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  32 #endif /* #ifdef __cplusplus */
  33
  34 /*--------------------------------------------------------------------------*/
  35
  36 /**
  37  * Basic data type identifier.
  38  *
  39  * @since 2023/07/25
  40  */
  41 typedef enum sjme_basicTypeId
  42 {
  43         /** Integer. */
  44         SJME_BASIC_TYPE_ID_INTEGER = 0,
  45
  46         /** Integer. */
  47         SJME_JAVA_TYPE_ID_INTEGER = SJME_BASIC_TYPE_ID_INTEGER,
  48
  49         /** Long. */
  50         SJME_BASIC_TYPE_ID_LONG = 1,
  51
  52         /** Long. */
  53         SJME_JAVA_TYPE_ID_LONG = SJME_BASIC_TYPE_ID_LONG,
  54
  55         /** Float. */
  56         SJME_BASIC_TYPE_ID_FLOAT = 2,
  57
  58         /** Float. */
  59         SJME_JAVA_TYPE_ID_FLOAT = SJME_BASIC_TYPE_ID_FLOAT,
  60
  61         /** Double. */
  62         SJME_BASIC_TYPE_ID_DOUBLE = 3,
  63
  64         /** Double. */
  65         SJME_JAVA_TYPE_ID_DOUBLE = SJME_BASIC_TYPE_ID_DOUBLE,
  66
  67         /** Object. */
  68         SJME_BASIC_TYPE_ID_OBJECT = 4,
  69
  70         /** Object. */
  71         SJME_JAVA_TYPE_ID_OBJECT = SJME_BASIC_TYPE_ID_OBJECT,
  72
  73         /** The number of Java type IDs. */
  74         SJME_NUM_JAVA_TYPE_IDS = 5,
  75
  76         /** Boolean or byte. */
  77         SJME_JAVA_TYPE_ID_BOOLEAN_OR_BYTE = SJME_NUM_JAVA_TYPE_IDS,
  78
  79         /** Character or short type. */
  80         SJME_JAVA_TYPE_ID_SHORT_OR_CHAR = 6,
  81
  82         /** Void type. */
  83         SJME_BASIC_TYPE_ID_VOID = 7,
  84
  85         /** Void type. */
  86         SJME_JAVA_TYPE_ID_VOID = SJME_BASIC_TYPE_ID_VOID,
  87
  88         /** End of extended Java types. */
  89         SJME_NUM_EXTENDED_JAVA_TYPE_IDS = 8,
  90
  91         /** Short. */
  92         SJME_BASIC_TYPE_ID_SHORT = SJME_NUM_EXTENDED_JAVA_TYPE_IDS,
  93
  94         /** Character. */
  95         SJME_BASIC_TYPE_ID_CHARACTER = 9,
  96
  97         /** Specifically boolean. */
  98         SJME_BASIC_TYPE_ID_BOOLEAN = 10,
  99
 100         /** Specifically jbyte. */
 101         SJME_BASIC_TYPE_ID_BYTE = 11,
 102
 103         /** Number of basic type IDs. */
 104         SJME_NUM_BASIC_TYPE_IDS = 11
 105 } sjme_basicTypeId;
 106
 107 /**
 108  * Boolean type.
 109  *
 110  * @since 2023/07/25
 111  */
 112 typedef enum sjme_jboolean
 113 {
 114         SJME_JNI_FALSE = 0,
 115
 116         SJME_JNI_TRUE = 1
 117 } sjme_jboolean;
 118
 119 /** Basic @c sjme_jboolean type identifier. */
 120 #define SJME_TYPEOF_BASIC_sjme_jboolean SJME_BASIC_TYPE_ID_BOOLEAN
 121
 122 /** Java @c sjme_jboolean type identifier. */
 123 #define SJME_TYPEOF_JAVA_sjme_jboolean SJME_JAVA_TYPE_ID_BOOLEAN_OR_BYTE
 124
 125 /** Is a pointer for @c sjme_jboolean ? */
 126 #define SJME_TYPEOF_IS_POINTER_sjme_jboolean 0
 127
 128 /**
 129  * Byte type.
 130  *
 131  * @since 2023/07/25
 132  */
 133 typedef int8_t sjme_jbyte;
 134
 135 /** Basic @c sjme_jbyte type identifier. */
 136 #define SJME_TYPEOF_BASIC_sjme_jbyte SJME_BASIC_TYPE_ID_BYTE
 137
 138 /** Java @c sjme_jbyte type identifier. */
 139 #define SJME_TYPEOF_JAVA_sjme_jbyte SJME_JAVA_TYPE_ID_BOOLEAN_OR_BYTE
 140
 141 /** Is a pointer for @c sjme_jbyte ? */
 142 #define SJME_TYPEOF_IS_POINTER_sjme_jbyte 0
 143
 144 /**
 145  * Promoted @c sjme_jbyte .
 146  *
 147  * @since 2024/06/20
 148  */
 149 typedef int sjme_jbyte_promoted;
 150
 151 /**
 152  * Unsigned byte type.
 153  *
 154  * @since 2023/08/09
 155  */
 156 typedef uint8_t sjme_jubyte;
 157
 158 /** Basic @c sjme_jubyte type identifier. */
 159 #define SJME_TYPEOF_BASIC_sjme_jubyte SJME_BASIC_TYPE_ID_BYTE
 160
 161 /** Java @c sjme_jubyte type identifier. */
 162 #define SJME_TYPEOF_JAVA_sjme_jubyte SJME_JAVA_TYPE_ID_BOOLEAN_OR_BYTE
 163
 164 /** Is a pointer for @c sjme_jubyte ? */
 165 #define SJME_TYPEOF_IS_POINTER_sjme_jubyte 0
 166
 167 /**
 168  * Promoted @c sjme_jubyte .
 169  *
 170  * @since 2024/06/20
 171  */
 172 typedef int sjme_jubyte_promoted;
 173
 174 /**
 175  * Short type.
 176  *
 177  * @since 2023/07/25
 178  */
 179 typedef int16_t sjme_jshort;
 180
 181 /** Basic @c sjme_jshort type identifier. */
 182 #define SJME_TYPEOF_BASIC_sjme_jshort SJME_BASIC_TYPE_ID_SHORT
 183
 184 /** Java @c sjme_jshort type identifier. */
 185 #define SJME_TYPEOF_JAVA_sjme_jshort SJME_JAVA_TYPE_ID_INTEGER
 186
 187 /** Is a pointer for @c sjme_jshort ? */
 188 #define SJME_TYPEOF_IS_POINTER_sjme_jshort 0
 189
 190 /**
 191  * Promoted @c sjme_jshort .
 192  *
 193  * @since 2024/06/20
 194  */
 195 typedef int sjme_jshort_promoted;
 196
 197 /**
 198  * Character type.
 199  *
 200  * @since 2023/07/25
 201  */
 202 typedef uint16_t sjme_jchar;
 203
 204 /** Basic @c sjme_jchar type identifier. */
 205 #define SJME_TYPEOF_BASIC_sjme_jchar SJME_BASIC_TYPE_ID_CHARACTER
 206
 207 /** Java @c sjme_jchar type identifier. */
 208 #define SJME_TYPEOF_JAVA_sjme_jchar SJME_JAVA_TYPE_ID_INTEGER
 209
 210 /** Is a pointer for @c sjme_jchar ? */
 211 #define SJME_TYPEOF_IS_POINTER_sjme_jchar 0
 212
 213 /**
 214  * Promoted @c sjme_jchar .
 215  *
 216  * @since 2024/06/20
 217  */
 218 typedef int sjme_jchar_promoted;
 219
 220 /**
 221  * Integer type.
 222  *
 223  * @since 2023/07/25
 224  */
 225 typedef int32_t sjme_jint;
 226
 227 /** Basic @c sjme_jint type identifier. */
 228 #define SJME_TYPEOF_BASIC_sjme_jint SJME_BASIC_TYPE_ID_INTEGER
 229
 230 /** Java @c sjme_jint type identifier. */
 231 #define SJME_TYPEOF_JAVA_sjme_jint SJME_JAVA_TYPE_ID_INTEGER
 232
 233 /** Is a pointer for @c sjme_jint ? */
 234 #define SJME_TYPEOF_IS_POINTER_sjme_jint 0
 235
 236 /**
 237  * Unsigned integer type.
 238  *
 239  * @since 2023/11/20
 240  */
 241 typedef uint32_t sjme_juint;
 242
 243 /** Basic @c sjme_juint type identifier. */
 244 #define SJME_TYPEOF_BASIC_sjme_juint SJME_BASIC_TYPE_ID_INTEGER
 245
 246 /** Java @c sjme_juint type identifier. */
 247 #define SJME_TYPEOF_JAVA_sjme_juint SJME_JAVA_TYPE_ID_INTEGER
 248
 249 /** Is a pointer for @c sjme_juint ? */
 250 #define SJME_TYPEOF_IS_POINTER_sjme_juint 0
 251
 252 /**
 253  * Fixed point.
 254  *
 255  * @since 2024/06/27
 256  */
 257 typedef sjme_jint sjme_fixed;
 258
 259 /**
 260  * C Character.
 261  *
 262  * @since 2024/01/03
 263  */
 264 typedef char sjme_cchar;
 265
 266 #if defined(CHAR_BIT) && (CHAR_BIT == 64)
 267         /** Basic @c sjme_cchar type identifier. */
 268         #define SJME_TYPEOF_BASIC_sjme_cchar SJME_BASIC_TYPE_ID_LONG
 269 #elif defined(CHAR_BIT) && (CHAR_BIT == 32)
 270         /** Basic @c sjme_cchar type identifier. */
 271         #define SJME_TYPEOF_BASIC_sjme_cchar SJME_BASIC_TYPE_ID_INTEGER
 272 #elif defined(CHAR_BIT) && (CHAR_BIT == 16)
 273         /** Basic @c sjme_cchar type identifier. */
 274         #define SJME_TYPEOF_BASIC_sjme_cchar SJME_BASIC_TYPE_ID_SHORT
 275 #else
 276         /** Basic @c sjme_cchar type identifier. */
 277         #define SJME_TYPEOF_BASIC_sjme_cchar SJME_BASIC_TYPE_ID_BYTE
 278 #endif
 279
 280 /** Is a pointer for @c sjme_cchar ? */
 281 #define SJME_TYPEOF_IS_POINTER_sjme_cchar 0
 282
 283 #if defined(SJME_CONFIG_HAS_ARCH_IA16)
 284         /**
 285          * Pointer to C string.
 286          *
 287          * @since 2023/12/17
 288          */
 289         typedef sjme_cchar huge* sjme_lpstr;
 290 #else
 291         /**
 292          * Pointer to C string.
 293          *
 294          * @since 2023/12/17
 295          */
 296         typedef sjme_cchar* sjme_lpstr;
 297 #endif
 298
 299 /** Basic @c sjme_lpstr type identifier. */
 300 #define SJME_TYPEOF_BASIC_sjme_lpstr SJME_BASIC_TYPE_ID_OBJECT
 301
 302 /** Is a pointer for @c sjme_lpstr ? */
 303 #define SJME_TYPEOF_IS_POINTER_sjme_lpstr 1
 304
 305 #if defined(SJME_CONFIG_HAS_ARCH_IA16)
 306         /**
 307          * Pointer to constant C string.
 308          *
 309          * @since 2023/12/17
 310          */
 311         typedef const sjme_cchar huge* sjme_lpcstr;
 312 #else
 313         /**
 314          * Pointer to constant C string.
 315          *
 316          * @since 2023/12/17
 317          */
 318         typedef const sjme_cchar* sjme_lpcstr;
 319 #endif
 320
 321 /** Basic @c sjme_lpcstr type identifier. */
 322 #define SJME_TYPEOF_BASIC_sjme_lpcstr SJME_BASIC_TYPE_ID_OBJECT
 323
 324 /** Is a pointer for @c sjme_lpcstr ? */
 325 #define SJME_TYPEOF_IS_POINTER_sjme_lpcstr 1
 326
 327 #if defined(SJME_CONFIG_HAS_ARCH_IA16)
 328         /**
 329          * Generic pointer.
 330          *
 331          * @since 2023/12/27
 332          */
 333         typedef void huge* sjme_pointer;
 334 #else
 335         /**
 336          * Generic pointer.
 337          *
 338          * @since 2023/12/27
 339          */
 340         typedef void* sjme_pointer;
 341 #endif
 342
 343 /** Basic @c sjme_pointer type identifier. */
 344 #define SJME_TYPEOF_BASIC_sjme_pointer SJME_BASIC_TYPE_ID_OBJECT
 345
 346 /** Is a pointer for @c sjme_pointer ? */
 347 #define SJME_TYPEOF_IS_POINTER_sjme_pointer 1
 348
 349 #if defined(SJME_CONFIG_HAS_ARCH_IA16)
 350         /**
 351          * Generic pointer to const data.
 352          *
 353          * @since 2023/12/27
 354          */
 355         typedef const void huge* sjme_cpointer;
 356 #else
 357         /**
 358          * Generic pointer to const data.
 359          *
 360          * @since 2023/12/27
 361          */
 362         typedef const void* sjme_cpointer;
 363 #endif
 364
 365 /** Basic @c sjme_cpointer type identifier. */
 366 #define SJME_TYPEOF_BASIC_sjme_cpointer SJME_BASIC_TYPE_ID_OBJECT
 367
 368 /** Is a pointer for @c sjme_cpointer ? */
 369 #define SJME_TYPEOF_IS_POINTER_sjme_cpointer 1
 370
 371 /**
 372  * Buffer type.
 373  *
 374  * @since 2024/08/13
 375  */
 376 typedef sjme_pointer sjme_buffer;
 377
 378 /**
 379  * Const buffer type.
 380  *
 381  * @since 2024/08/13
 382  */
 383 typedef sjme_cpointer sjme_cbuffer;
 384
 385 /**
 386  * Integer based pointer.
 387  *
 388  * @since 2024/04/06
 389  */
 390 typedef intptr_t sjme_intPointer;
 391
 392 /** Calculates a pointer offset. */
 393 #define SJME_POINTER_OFFSET(base, off) \
 394         (sjme_pointer)(((sjme_intPointer)(base)) + ((sjme_intPointer)(off)))
 395
 396 #if defined(SJME_CONFIG_HAS_POINTER64)
 397         #define SJME_TYPEOF_BASIC_sjme_intPointer SJME_TYPEOF_BASIC_sjme_jpointer
 398 #else
 399         #define SJME_TYPEOF_BASIC_sjme_intPointer SJME_TYPEOF_BASIC_sjme_juint
 400 #endif
 401
 402 #define SJME_TYPEOF_IS_POINTER_sjme_intPointer 0
 403
 404 /**
 405  * Long value.
 406  *
 407  * @since 2023/07/25
 408  */
 409 typedef union sjme_jlong
 410 {
 411         /** Parts of the long. */
 412         struct
 413         {
 414 #if defined(SJME_CONFIG_HAS_LITTLE_ENDIAN)
 415                 /** Low value. */
 416                 sjme_juint lo;
 417
 418                 /** High value. */
 419                 sjme_jint hi;
 420 #else
 421                 /** High value. */
 422                 sjme_jint hi;
 423
 424                 /** Low value. */
 425                 sjme_juint lo;
 426 #endif
 427         } part;
 428
 429         /** The full long. */
 430         int64_t full;
 431 } sjme_jlong;
 432
 433 /** Basic @c sjme_jlong type identifier. */
 434 #define SJME_TYPEOF_BASIC_sjme_jlong SJME_BASIC_TYPE_ID_LONG
 435
 436 /** Java @c sjme_jlong type identifier. */
 437 #define SJME_TYPEOF_JAVA_sjme_jlong SJME_JAVA_TYPE_ID_LONG
 438
 439 /** Is a pointer for @c sjme_jlong ? */
 440 #define SJME_TYPEOF_IS_POINTER_sjme_jlong 0
 441
 442 /**
 443  * Float value.
 444  *
 445  * @sinc 2023/07/25
 446  */
 447 typedef struct sjme_jfloat
 448 {
 449         sjme_jint value;
 450 } sjme_jfloat;
 451
 452 /** Basic @c sjme_jfloat type identifier. */
 453 #define SJME_TYPEOF_BASIC_sjme_jfloat SJME_BASIC_TYPE_ID_FLOAT
 454
 455 /** Java @c sjme_jfloat type identifier. */
 456 #define SJME_TYPEOF_JAVA_sjme_jfloat SJME_JAVA_TYPE_ID_FLOAT
 457
 458 /** Is a pointer for @c sjme_jfloat ? */
 459 #define SJME_TYPEOF_IS_POINTER_sjme_jfloat 0
 460
 461 /**
 462  * Double value.
 463  *
 464  * @sinc 2023/07/25
 465  */
 466 typedef struct sjme_jdouble
 467 {
 468 #if defined(SJME_CONFIG_HAS_LITTLE_ENDIAN)
 469         /** Low value. */
 470         sjme_juint lo;
 471
 472         /** High value. */
 473         sjme_juint hi;
 474 #else
 475         /** High value. */
 476         sjme_juint hi;
 477
 478         /** Low value. */
 479         sjme_juint lo;
 480 #endif
 481 } sjme_jdouble;
 482
 483 /** Basic @c sjme_jdouble type identifier. */
 484 #define SJME_TYPEOF_BASIC_sjme_jdouble SJME_BASIC_TYPE_ID_DOUBLE
 485
 486 /** Java @c sjme_jdouble type identifier. */
 487 #define SJME_TYPEOF_JAVA_sjme_jdouble SJME_JAVA_TYPE_ID_DOUBLE
 488
 489 /** Is a pointer for @c sjme_jdouble ? */
 490 #define SJME_TYPEOF_IS_POINTER_sjme_jdouble 0
 491
 492 /**
 493  * Temporary index.
 494  *
 495  * @since 2023/07/25
 496  */
 497 typedef sjme_jint sjme_tempIndex;
 498
 499 /**
 500  * A range of values.
 501  *
 502  * @since 2024/01/03
 503  */
 504 typedef struct sjme_range
 505 {
 506         /** Start of the range. */
 507         sjme_jint start;
 508
 509         /** End of the range. */
 510         sjme_jint end;
 511 } sjme_range;
 512
 513 /**
 514  * Represents a pointer and a length.
 515  *
 516  * @since 2024/02/04
 517  */
 518 typedef struct sjme_pointerLen
 519 {
 520         /** The pointer to the data. */
 521         sjme_pointer pointer;
 522
 523         /** The length of the pointer. */
 524         sjme_jint length;
 525 } sjme_pointerLen;
 526
 527 /** The Java type ID. */
 528 typedef sjme_basicTypeId sjme_javaTypeId;
 529
 530 /**
 531  * Represents multiple type IDs.
 532  *
 533  * @since 2023/08/09
 534  */
 535 typedef struct sjme_basicTypeIds
 536 {
 537         /** The number of IDs. */
 538         sjme_jint count;
 539
 540         /** The IDs. */
 541         const sjme_javaTypeId ids[sjme_flexibleArrayCount];
 542 } sjme_basicTypeIds;
 543
 544 /**
 545  * Base object information.
 546  *
 547  * @since 2023/07/25
 548  */
 549 typedef struct sjme_jobjectBase sjme_jobjectBase;
 550
 551 /**
 552  * Object type.
 553  *
 554  * @since 2023/07/25
 555  */
 556 typedef sjme_jobjectBase* sjme_jobject;
 557
 558 /** Basic @c sjme_jobject type identifier. */
 559 #define SJME_TYPEOF_BASIC_sjme_jobject SJME_BASIC_TYPE_ID_OBJECT
 560
 561 /** Java @c sjme_jobject type identifier. */
 562 #define SJME_TYPEOF_JAVA_sjme_jobject SJME_BASIC_TYPE_ID_OBJECT
 563
 564 /** Is a pointer for @c sjme_jobject ? */
 565 #define SJME_TYPEOF_IS_POINTER_sjme_jobject 1
 566
 567 /**
 568  * Generic value union.
 569  *
 570  * @since 2024/01/05
 571  */
 572 typedef union sjme_jvalue
 573 {
 574         /** Boolean. */
 575         sjme_jboolean z;
 576
 577         /** Byte. */
 578         sjme_jbyte b;
 579
 580         /** Character. */
 581         sjme_jchar c;
 582
 583         /** Short. */
 584         sjme_jshort s;
 585
 586         /** Integer. */
 587         sjme_jint i;
 588
 589         /** Long. */
 590         sjme_jlong j;
 591
 592         /** Float. */
 593         sjme_jfloat f;
 594
 595         /** Double. */
 596         sjme_jdouble d;
 597
 598         /** Object/Reference. */
 599         sjme_jobject l;
 600 } sjme_jvalue;
 601
 602 /**
 603  * Structure which stores the pooled memory allocator.
 604  *
 605  * @since 2023/11/18
 606  */
 607 typedef struct sjme_alloc_pool sjme_alloc_pool;
 608
 609 /*--------------------------------------------------------------------------*/
 610
 611 /* Anti-C++. */
 612 #ifdef __cplusplus
 613         #ifdef SJME_CXX_SQUIRRELJME_STDTYPES_H
 614 }
 615                 #undef SJME_CXX_SQUIRRELJME_STDTYPES_H
 616                 #undef SJME_CXX_IS_EXTERNED
 617         #endif /* #ifdef SJME_CXX_SQUIRRELJME_STDTYPES_H */
 618 #endif /* #ifdef __cplusplus */
 619
 620 #endif /* SQUIRRELJME_STDTYPES_H */