nanocoat/include/sjme/error.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  * Error codes.
  12  *
  13  * @since 2024/08/09
  14  */
  15
  16 #ifndef SQUIRRELJME_ERROR_H
  17 #define SQUIRRELJME_ERROR_H
  18
  19 #include "sjme/stdTypes.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_ERROR_H
  26 extern "C"
  27 {
  28         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  29 #endif /* #ifdef __cplusplus */
  30
  31 /*--------------------------------------------------------------------------*/
  32
  33 /**
  34  * Error codes.
  35  *
  36  * @since 2023/11/14
  37  */
  38 typedef enum sjme_errorCode
  39 {
  40         /** No error. */
  41         SJME_ERROR_NONE = 1,
  42
  43         /** Generic unknown error. */
  44         SJME_ERROR_UNKNOWN = 0,
  45
  46         /** Generic unknown error. */
  47         SJME_ERROR_UNKNOWN_NEGATIVE = -1,
  48
  49         /** Null arguments. */
  50         SJME_ERROR_NULL_ARGUMENTS = -2,
  51
  52         /** Local variable out of bounds. */
  53         SJME_ERROR_LOCAL_INDEX_INVALID = -3,
  54
  55         /** Stack variable out of bounds. */
  56         SJME_ERROR_STACK_INDEX_INVALID = -4,
  57
  58         /** Stack underflow. */
  59         SJME_ERROR_STACK_UNDERFLOW = -5,
  60
  61         /** Stack overflow. */
  62         SJME_ERROR_STACK_OVERFLOW = -6,
  63
  64         /** Top is not an integer type. */
  65         SJME_ERROR_TOP_NOT_INTEGER = -7,
  66
  67         /** Top is not a long type. */
  68         SJME_ERROR_TOP_NOT_LONG = -8,
  69
  70         /** Top is not a float type. */
  71         SJME_ERROR_TOP_NOT_FLOAT = -9,
  72
  73         /** Top is not a double type. */
  74         SJME_ERROR_TOP_NOT_DOUBLE = -10,
  75
  76         /** Top is not a object type. */
  77         SJME_ERROR_TOP_NOT_OBJECT = -11,
  78
  79         /** Frame is missing stack treads. */
  80         SJME_ERROR_FRAME_MISSING_STACK_TREADS = -12,
  81
  82         /** Invalid read of stack. */
  83         SJME_ERROR_STACK_INVALID_READ = -13,
  84
  85         /** Invalid write of stack. */
  86         SJME_ERROR_STACK_INVALID_WRITE = -14,
  87
  88         /** Invalid read of stack. */
  89         SJME_ERROR_LOCAL_INVALID_READ = -15,
  90
  91         /** Invalid write of stack. */
  92         SJME_ERROR_LOCAL_INVALID_WRITE = -16,
  93
  94         /** Invalid reference pop. */
  95         SJME_ERROR_INVALID_REFERENCE_POP = -17,
  96
  97         /** Invalid reference push. */
  98         SJME_ERROR_INVALID_REFERENCE_PUSH = -18,
  99
 100         /** Failed to garbage collect object. */
 101         SJME_ERROR_COULD_NOT_GC_OBJECT = -19,
 102
 103         /** Object reference count is not zero. */
 104         SJME_ERROR_OBJECT_REFCOUNT_NOT_ZERO = -20,
 105
 106         /** Garbage collection of object cancelled. */
 107         SJME_ERROR_OBJECT_GC_CANCELLED = -21,
 108
 109         /** Out of memory. */
 110         SJME_ERROR_OUT_OF_MEMORY = -22,
 111
 112         /** Pool initialization failed. */
 113         SJME_ERROR_POOL_INIT_FAILED = -23,
 114
 115         /** Invalid argument. */
 116         SJME_ERROR_INVALID_ARGUMENT = -24,
 117
 118         /** Not implemented. */
 119         SJME_ERROR_NOT_IMPLEMENTED = -25,
 120
 121         /** Invalid tread read. */
 122         SJME_ERROR_TREAD_INVALID_READ = -26,
 123
 124         /** Invalid tread write. */
 125         SJME_ERROR_TREAD_INVALID_WRITE = -27,
 126
 127         /** There are no suites available. */
 128         SJME_ERROR_NO_SUITES = -28,
 129
 130         /** Classpath cannot be obtained by both ID and Name. */
 131         SJME_ERROR_CLASS_PATH_BY_BOTH = -29,
 132
 133         /** Illegal state. */
 134         SJME_ERROR_ILLEGAL_STATE = -30,
 135
 136         /** A library was not found. */
 137         SJME_ERROR_LIBRARY_NOT_FOUND = -31,
 138
 139         /** Boot failure. */
 140         SJME_ERROR_BOOT_FAILURE = -32,
 141
 142         /** Generic JNI exception. */
 143         SJME_ERROR_JNI_EXCEPTION = -33,
 144
 145         /** Memory has been corrupted. */
 146         SJME_ERROR_MEMORY_CORRUPTION = -34,
 147
 148         /** Index out of bounds. */
 149         SJME_ERROR_INDEX_OUT_OF_BOUNDS = -35,
 150
 151         /** Unsupported operation. */
 152         SJME_ERROR_UNSUPPORTED_OPERATION = -36,
 153
 154         /** Resource not found. */
 155         SJME_ERROR_RESOURCE_NOT_FOUND = -37,
 156
 157         /** Unexpected end of file. */
 158         SJME_ERROR_UNEXPECTED_EOF = -38,
 159
 160         /** Invalid identifier. */
 161         SJME_ERROR_INVALID_IDENTIFIER = -39,
 162
 163         /** Invalid binary name. */
 164         SJME_ERROR_INVALID_BINARY_NAME = -40,
 165
 166         /** Invalid field type. */
 167         SJME_ERROR_INVALID_FIELD_TYPE = -41,
 168
 169         /** Invalid method type. */
 170         SJME_ERROR_INVALID_METHOD_TYPE = -42,
 171
 172         /** Invalid class name. */
 173         SJME_ERROR_INVALID_CLASS_NAME = -43,
 174
 175         /** Could not load library. */
 176         SJME_ERROR_COULD_NOT_LOAD_LIBRARY = -44,
 177
 178         /** Invalid library symbol. */
 179         SJME_ERROR_INVALID_LIBRARY_SYMBOL = -45,
 180
 181         /** There is no graphics display. */
 182         SJME_ERROR_HEADLESS_DISPLAY = -46,
 183
 184         /** Cannot create something. */
 185         SJME_ERROR_CANNOT_CREATE = -47,
 186
 187         /** Invalid thread state. */
 188         SJME_ERROR_INVALID_THREAD_STATE = -48,
 189
 190         /** Component is already in a container. */
 191         SJME_ERROR_ALREADY_IN_CONTAINER = -49,
 192
 193         /** Not a sub component. */
 194         SJME_ERROR_NOT_SUB_COMPONENT = -50,
 195
 196         /** No such class exists. */
 197         SJME_ERROR_NO_CLASS = -51,
 198
 199         /** No such method exists. */
 200         SJME_ERROR_NO_METHOD = -52,
 201
 202         /** There is no listener. */
 203         SJME_ERROR_NO_LISTENER = -53,
 204
 205         /** Cancel close of window. */
 206         SJME_ERROR_CANCEL_WINDOW_CLOSE = -54,
 207
 208         /** The class cannot be casted. */
 209         SJME_ERROR_CLASS_CAST = -55,
 210
 211         /** The font is not valid. */
 212         SJME_ERROR_INVALID_FONT = -56,
 213
 214         /** There is no Java environment. */
 215         SJME_ERROR_NO_JAVA_ENVIRONMENT = -57,
 216
 217         /** Font has negative height. */
 218         SJME_ERROR_FONT_NEGATIVE_HEIGHT = -58,
 219
 220         /** Could not create native widget. */
 221         SJME_ERROR_NATIVE_WIDGET_CREATE_FAILED = -59,
 222
 223         /** Clock failure. */
 224         SJME_ERROR_NATIVE_SYSTEM_CLOCK_FAILURE = -60,
 225
 226         /** A weak reference it attached. */
 227         SJME_ERROR_WEAK_REFERENCE_ATTACHED = -61,
 228
 229         /** An enqueue has already been set for the weak reference. */
 230         SJME_ERROR_ENQUEUE_ALREADY_SET = -62,
 231
 232         /** Native error. */
 233         SJME_ERROR_NATIVE_ERROR = -63,
 234
 235         /** Not a weak reference. */
 236         SJME_ERROR_NOT_WEAK_REFERENCE = -64,
 237
 238         /** Could not access array natively. */
 239         SJME_ERROR_NATIVE_ARRAY_ACCESS_FAILED = -65,
 240
 241         /** The graphics buffer is not locked. */
 242         SJME_ERROR_BUFFER_NOT_LOCKED = -66,
 243
 244         /** Component is not in this container. */
 245         SJME_ERROR_NOT_IN_CONTAINER = -67,
 246
 247         /** Invalid link. */
 248         SJME_ERROR_INVALID_LINK = -68,
 249
 250         /** We are not the owner of the lock. */
 251         SJME_ERROR_NOT_LOCK_OWNER = -69,
 252
 253         /** Item already has a parent. */
 254         SJME_ERROR_HAS_PARENT = -70,
 255
 256         /** Member already exists. */
 257         SJME_ERROR_MEMBER_EXISTS = -71,
 258
 259         /** The native widget system failed for some reason. */
 260         SJME_ERROR_NATIVE_WIDGET_FAILURE = -72,
 261
 262         /** Scan out of bounds. */
 263         SJME_ERROR_SCAN_OUT_OF_BOUNDS = -73,
 264
 265         /** Native graphics access not yet valid. */
 266         SJME_ERROR_FRAMEBUFFER_NOT_READY = -74,
 267
 268         /** Could not unload native library. */
 269         SJME_ERROR_COULD_NOT_UNLOAD_LIBRARY = -75,
 270
 271         /** Could not enqueue onto the message loop. */
 272         SJME_ERROR_LOOP_ENQUEUE_FAILED = -76,
 273
 274         /** Use fallback. */
 275         SJME_ERROR_USE_FALLBACK = -77,
 276
 277         /** Continue operation. */
 278         SJME_ERROR_CONTINUE = -78,
 279
 280         /** Interrupted. */
 281         SJME_ERROR_INTERRUPTED = -79,
 282
 283         /** Exit. */
 284         SJME_ERROR_EXIT = -80,
 285
 286         /** Input/Output Exception. */
 287         SJME_ERROR_IO_EXCEPTION = -81,
 288
 289         /** No such element exists. */
 290         SJME_ERROR_NO_SUCH_ELEMENT = -82,
 291
 292         /** Path too long. */
 293         SJME_ERROR_PATH_TOO_LONG = -83,
 294
 295         /** File not found. */
 296         SJME_ERROR_FILE_NOT_FOUND = -84,
 297
 298         /** Input is too short. */
 299         SJME_ERROR_TOO_SHORT = -85,
 300
 301         /** Not a Zip. */
 302         SJME_ERROR_NOT_ZIP = -86,
 303
 304         /** Access it not aligned. */
 305         SJME_ERROR_UNALIGNED_ACCESS = -87,
 306
 307         /** Zip is corrupt. */
 308         SJME_ERROR_CORRUPT_ZIP = -88,
 309
 310         /** Unsupported Zip format. */
 311         SJME_ERROR_UNSUPPORTED_ZIP_FORMAT = -89,
 312
 313         /** Path is a directory. */
 314         SJME_ERROR_IS_DIRECTORY = -90,
 315
 316         /** Invalid literal length values in inflate. */
 317         SJME_ERROR_INFLATE_INVALID_INVERT = -91,
 318
 319         /** Invalid block type in inflate stream. */
 320         SJME_ERROR_INFLATE_INVALID_BTYPE = -92,
 321
 322         /** Invalid dynamic tree length in inflate stream. */
 323         SJME_ERROR_INFLATE_INVALID_TREE_LENGTH = -93,
 324
 325         /** The code length is invalid. */
 326         SJME_ERROR_INFLATE_INVALID_CODE_LENGTH = -94,
 327
 328         /** Huffman tree is full. */
 329         SJME_ERROR_TRAVERSE_FULL = -95,
 330
 331         /** There is a collision in the huffman tree, which means bad data! */
 332         SJME_ERROR_TREE_COLLISION = -96,
 333
 334         /** The buffer is full. */
 335         SJME_ERROR_BUFFER_FULL = -97,
 336
 337         /** Huffman tree is incomplete. */
 338         SJME_ERROR_INFLATE_HUFF_TREE_INCOMPLETE = -98,
 339
 340         /** Tree value has invalid code. */
 341         SJME_ERROR_INFLATE_INVALID_CODE = -99,
 342
 343         /** Stop operation. */
 344         SJME_ERROR_STOP = -100,
 345
 346         /** Buffer is saturated. */
 347         SJME_ERROR_BUFFER_SATURATED = -101,
 348
 349         /** Window distance out of range. */
 350         SJME_ERROR_INFLATE_DISTANCE_OUT_OF_RANGE = -102,
 351
 352         /** Invalid code length count. */
 353         SJME_ERROR_INFLATE_INVALID_CODE_LENGTH_COUNT = -103,
 354
 355         /** Invalid repeat of first entry. */
 356         SJME_ERROR_INFLATE_INVALID_FIRST_REPEAT = -104,
 357
 358         /** Inflation index overflow. */
 359         SJME_ERROR_INFLATE_INDEX_OVERFLOW = -105,
 360
 361         /** End of file reached. */
 362         SJME_ERROR_END_OF_FILE = -106,
 363
 364         /** Element already exists. */
 365         SJME_ERROR_ELEMENT_EXISTS = -107,
 366
 367         /** Capacity exceeded? */
 368         SJME_ERROR_CAPACITY_EXCEEDED = -108,
 369
 370         /** Tree traversal is too deep. */
 371         SJME_ERROR_TREE_TOO_DEEP = -109,
 372
 373         /** Invalid class magic number. */
 374         SJME_ERROR_INVALID_CLASS_MAGIC = -110,
 375
 376         /** Invalid class version. */
 377         SJME_ERROR_INVALID_CLASS_VERSION = -111,
 378
 379         /** Invalid class pool count. */
 380         SJME_ERROR_INVALID_CLASS_POOL_COUNT = -112,
 381
 382         /** Invalid class pool index reference. */
 383         SJME_ERROR_INVALID_CLASS_POOL_INDEX = -113,
 384
 385         /** Reference to class pool index is the wrong type. */
 386         SJME_ERROR_WRONG_CLASS_POOL_INDEX_TYPE = -114,
 387
 388         /** Class flags are invalid. */
 389         SJME_ERROR_INVALID_CLASS_FLAGS = -115,
 390
 391         /** Method flags are invalid. */
 392         SJME_ERROR_INVALID_METHOD_FLAGS = -116,
 393
 394         /** Method has multiple code attributes. */
 395         SJME_ERROR_METHOD_MULTIPLE_CODE = -117,
 396
 397         /** Invalid field flags. */
 398         SJME_ERROR_INVALID_FIELD_FLAGS = -118,
 399
 400         /** The number of error codes. */
 401         SJME_NUM_ERROR_CODES = -119,
 402 } sjme_errorCode;
 403
 404 /**
 405  * Propagates an error code which allows others to run accordingly.
 406  *
 407  * @param error The current error code.
 408  * @param expression The result from the expression.
 409  * @return If @c expression is an error, that will be returned otherwise
 410  * the value in @c error provided @c error is not an error.
 411  * @since 2024/01/18
 412  */
 413 sjme_errorCode sjme_error_also(
 414         sjme_errorCode error, sjme_errorCode expression);
 415
 416 /**
 417  * Similar to @c sjme_error_also except this allows multiple error expressions
 418  * to be passed until the final is done via @c sjme_error_alsoVEnd() .
 419  *
 420  * @param error The current error state.
 421  * @param ... All of the expressions, ends on @c sjme_error_alsoVEnd() .
 422  * @return The resultant error code.
 423  * @since 2024/01/18
 424  */
 425 sjme_errorCode sjme_error_alsoV(
 426         sjme_errorCode error, ...);
 427
 428 /**
 429  * The end expression for @c sjme_error_alsoV() .
 430  *
 431  * @return The ending sequence for error codes.
 432  * @since 2024/01/18
 433  */
 434 sjme_errorCode sjme_error_alsoVEnd(void);
 435
 436 /**
 437  * Is this expression considered an error?
 438  *
 439  * @param error The expression.
 440  * @since 2023/12/08
 441  */
 442 sjme_jboolean sjme_error_is(
 443         sjme_errorCode error);
 444
 445 /**
 446  * Determines the default error code to use.
 447  *
 448  * @param error The error code.
 449  * @return Either @c error or a default error.
 450  * @since 2023/12/29
 451  */
 452 sjme_errorCode sjme_error_default(
 453         sjme_errorCode error);
 454
 455 /**
 456  * Determines the default error code to use.
 457  *
 458  * @param error The error code.
 459  * @param otherwise The other error code rather than @c SJME_ERROR_UNKNOWN.
 460  * @return Either @c error or @c otherwise if the former is not valid.
 461  * @since 2023/12/29
 462  */
 463 sjme_errorCode sjme_error_defaultOr(
 464         sjme_errorCode error, sjme_errorCode otherwise);
 465
 466 /*--------------------------------------------------------------------------*/
 467
 468 /* Anti-C++. */
 469 #ifdef __cplusplus
 470         #ifdef SJME_CXX_SQUIRRELJME_ERROR_H
 471 }
 472                 #undef SJME_CXX_SQUIRRELJME_ERROR_H
 473                 #undef SJME_CXX_IS_EXTERNED
 474         #endif /* #ifdef SJME_CXX_SQUIRRELJME_ERROR_H */
 475 #endif /* #ifdef __cplusplus */
 476
 477 #endif /* SQUIRRELJME_ERROR_H */