nanocoat/include/sjme/classy.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  * Handling of classes.
  12  *
  13  * @since 2024/01/01
  14  */
  15
  16 #ifndef SQUIRRELJME_CLASSY_H
  17 #define SQUIRRELJME_CLASSY_H
  18
  19 #include "sjme/nvm.h"
  20 #include "sjme/seekable.h"
  21 #include "sjme/list.h"
  22 #include "sjme/descriptor.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_CLASSY_H
  29 extern "C" {
  30         #endif /* #ifdef SJME_CXX_IS_EXTERNED */
  31 #endif     /* #ifdef __cplusplus */
  32
  33 /*--------------------------------------------------------------------------*/
  34
  35 /**
  36  * Core class information structure.
  37  *
  38  * @since 2024/01/01
  39  */
  40 typedef struct sjme_class_infoCore sjme_class_infoCore;
  41
  42 /**
  43  * Opaque class information structure.
  44  *
  45  * @since 2024/01/01
  46  */
  47 typedef struct sjme_class_infoCore* sjme_class_info;
  48
  49 /**
  50  * Core method information structure.
  51  *
  52  * @since 2024/01/03
  53  */
  54 typedef struct sjme_class_methodInfoCore sjme_class_methodInfoCore;
  55
  56 /**
  57  * Opaque method information structure.
  58  *
  59  * @since 2024/01/03
  60  */
  61 typedef struct sjme_class_methodInfoCore* sjme_class_methodInfo;
  62
  63 /**
  64  * Method list.
  65  *
  66  * @since 2024/01/03
  67  */
  68 SJME_LIST_DECLARE(sjme_class_methodInfo, 0);
  69
  70 /** The basic type of @c sjme_class_methodInfo . */
  71 #define SJME_TYPEOF_BASIC_sjme_class_methodInfo \
  72         SJME_BASIC_TYPE_ID_OBJECT
  73
  74 /**
  75  * Core field information structure.
  76  *
  77  * @since 2024/01/03
  78  */
  79 typedef struct sjme_class_fieldInfoCore sjme_class_fieldInfoCore;
  80
  81 /**
  82  * Opaque field information structure.
  83  *
  84  * @since 2024/01/03
  85  */
  86 typedef struct sjme_class_fieldInfoCore* sjme_class_fieldInfo;
  87
  88 /**
  89  * Field list.
  90  *
  91  * @since 2024/01/03
  92  */
  93 SJME_LIST_DECLARE(sjme_class_fieldInfo, 0);
  94
  95 /** The basic type of @c sjme_class_fieldInfo . */
  96 #define SJME_TYPEOF_BASIC_sjme_class_fieldInfo \
  97         SJME_BASIC_TYPE_ID_OBJECT
  98
  99 /**
 100  * Exception handling information.
 101  *
 102  * @since 2024/01/03
 103  */
 104 typedef struct sjme_class_exceptionHandler
 105 {
 106         /** The range of the exception where it applies. */
 107         sjme_range range;
 108
 109         /** The handler PC address. */
 110         sjme_jint handlerPc;
 111
 112         /** The type that this catches. */
 113         sjme_desc_binaryName handles;
 114 } sjme_class_exceptionHandler;
 115
 116 /** A list of exceptions. */
 117 SJME_LIST_DECLARE(sjme_class_exceptionHandler, 0);
 118
 119 /** The basic type of @c sjme_class_exceptionHandler . */
 120 #define SJME_TYPEOF_BASIC_sjme_class_exceptionHandler \
 121         SJME_BASIC_TYPE_ID_OBJECT
 122
 123 /**
 124  * Method code information structure.
 125  *
 126  * @since 2024/01/03
 127  */
 128 typedef struct sjme_class_codeInfoCore sjme_class_codeInfoCore;
 129
 130 /**
 131  * Opaque method code structure.
 132  *
 133  * @since 2024/01/03
 134  */
 135 typedef struct sjme_class_codeInfoCore* sjme_class_codeInfo;
 136
 137 /**
 138  * Access flags.
 139  *
 140  * @since 2024/01/03
 141  */
 142 typedef struct sjme_class_accessFlags
 143 {
 144         /** Is this public? */
 145         sjme_jboolean public : 1;
 146
 147         /** Is this private? */
 148         sjme_jboolean private : 1;
 149
 150         /** Is this protected? */
 151         sjme_jboolean protected : 1;
 152 } sjme_class_accessFlags;
 153
 154 /**
 155  * Class flags.
 156  *
 157  * @since 2024/01/03
 158  */
 159 typedef struct sjme_class_classFlags
 160 {
 161         /** Access flags. */
 162         sjme_class_accessFlags access;
 163
 164         /** Is the class final? */
 165         sjme_jboolean final : 1;
 166
 167         /** Is the class super? */
 168         sjme_jboolean super : 1;
 169
 170         /** Is the class an interface? */
 171         sjme_jboolean interface : 1;
 172
 173         /** Is the class abstract? */
 174         sjme_jboolean abstract : 1;
 175
 176         /** Is the class synthetic? */
 177         sjme_jboolean synthetic : 1;
 178
 179         /** Is the class an annotation? */
 180         sjme_jboolean annotation : 1;
 181
 182         /** Is the class an enum? */
 183         sjme_jboolean enumeration : 1;
 184 } sjme_class_classFlags;
 185
 186 /**
 187  * Common member flags.
 188  *
 189  * @since 2024/01/03
 190  */
 191 typedef struct sjme_class_memberFlags
 192 {
 193         /** Access flags. */
 194         sjme_class_accessFlags access;
 195
 196         /** Static member? */
 197         sjme_jboolean isStatic : 1;
 198
 199         /** Final member? */
 200         sjme_jboolean final : 1;
 201
 202         /** Synthetic member? */
 203         sjme_jboolean synthetic : 1;
 204 } sjme_class_memberFlags;
 205
 206 /**
 207  * Field flags.
 208  *
 209  * @since 2024/01/03
 210  */
 211 typedef struct sjme_class_fieldFlags
 212 {
 213         /** Common member flags. */
 214         sjme_class_memberFlags member;
 215
 216         /** Is this volatile? */
 217         sjme_jboolean isVolatile : 1;
 218
 219         /** Is this transient? */
 220         sjme_jboolean transient : 1;
 221
 222         /** Is this an enumeration. */
 223         sjme_jboolean enumeration : 1;
 224 } sjme_class_fieldFlags;
 225
 226 /**
 227  * Method flags.
 228  *
 229  * @since 2024/01/03
 230  */
 231 typedef struct sjme_class_methodFlags
 232 {
 233         /** Common member flags. */
 234         sjme_class_memberFlags member;
 235
 236         /** Synchronized, monitor entry/exit on call? */
 237         sjme_jboolean synchronized : 1;
 238
 239         /** Bridge method, generated by the compiler? */
 240         sjme_jboolean bridge : 1;
 241
 242         /** Variadic arguments? */
 243         sjme_jboolean varargs : 1;
 244
 245         /** Is this a native method? */
 246         sjme_jboolean native : 1;
 247
 248         /** Abstract? */
 249         sjme_jboolean abstract : 1;
 250
 251         /** Strict floating point? */
 252         sjme_jboolean strictfp : 1;
 253 } sjme_class_methodFlags;
 254
 255 /**
 256  * The type that a constant pool entry may be.
 257  *
 258  * @since 2024/01/04
 259  */
 260 typedef enum sjme_class_poolType
 261 {
 262         /** Null entry. */
 263         SJME_CLASS_POOL_TYPE_NULL = 0,
 264
 265         /** Modified UTF. */
 266         SJME_CLASS_POOL_TYPE_UTF = 1,
 267
 268         /** Unused 2. */
 269         SJME_CLASS_POOL_TYPE_UNUSED_2 = 2,
 270
 271         /** Integer constant. */
 272         SJME_CLASS_POOL_TYPE_INTEGER = 3,
 273
 274         /** Float constant. */
 275         SJME_CLASS_POOL_TYPE_FLOAT = 4,
 276
 277         /** Long constant. */
 278         SJME_CLASS_POOL_TYPE_LONG = 5,
 279
 280         /** Double constant. */
 281         SJME_CLASS_POOL_TYPE_DOUBLE = 6,
 282
 283         /** Class constant. */
 284         SJME_CLASS_POOL_TYPE_CLASS = 7,
 285
 286         /** String constant. */
 287         SJME_CLASS_POOL_TYPE_STRING = 8,
 288
 289         /** Field reference. */
 290         SJME_CLASS_POOL_TYPE_FIELD = 9,
 291
 292         /** Method reference. */
 293         SJME_CLASS_POOL_TYPE_METHOD = 10,
 294
 295         /** Interface method reference. */
 296         SJME_CLASS_POOL_TYPE_INTERFACE_METHOD = 11,
 297
 298         /** Name and type. */
 299         SJME_CLASS_POOL_TYPE_NAME_AND_TYPE = 12,
 300
 301         /** Unused 13. */
 302         SJME_CLASS_POOL_TYPE_UNUSED_13 = 13,
 303
 304         /** Unused 14. */
 305         SJME_CLASS_POOL_TYPE_UNUSED_14 = 14,
 306
 307         /** Method handle. */
 308         SJME_CLASS_POOL_TYPE_METHOD_HANDLE = 15,
 309
 310         /** Method type. */
 311         SJME_CLASS_POOL_TYPE_METHOD_TYPE = 16,
 312
 313         /** Unused 17. */
 314         SJME_CLASS_POOL_TYPE_UNUSED_17 = 17,
 315
 316         /** Invoke dynamic. */
 317         SJME_CLASS_POOL_TYPE_INVOKE_DYNAMIC = 18,
 318
 319         /** The number of pool types. */
 320         SJME_NUM_CLASS_POOL_TYPE
 321 } sjme_class_poolType;
 322
 323 /**
 324  * A @c SJME_CLASS_POOL_TYPE_CLASS which represents a class or interface.
 325  *
 326  * @since 2024/01/04
 327  */
 328 typedef struct sjme_class_poolEntryClass
 329 {
 330         /** The descriptor this represents. */
 331         sjme_lpcstr descriptor;
 332 } sjme_class_poolEntryClass;
 333
 334 /**
 335  * A @c SJME_CLASS_POOL_TYPE_DOUBLE which represents a double constant.
 336  *
 337  * @since 2024/01/04
 338  */
 339 typedef struct sjme_class_poolEntryDouble
 340 {
 341         /** The constant value. */
 342         sjme_jdouble value;
 343 } sjme_class_poolEntryDouble;
 344
 345 /**
 346  * A @c SJME_CLASS_POOL_TYPE_NAME_AND_TYPE which represents a name and type
 347  * of a member without the class.
 348  *
 349  * @since 2024/01/04
 350  */
 351 typedef struct sjme_class_poolEntryNameAndType sjme_class_poolEntryNameAndType;
 352
 353 /**
 354  * The type of entry
 355  *
 356  * @since 2024/01/16
 357  */
 358 typedef enum sjme_class_poolEntryMemberType
 359 {
 360         /** Reference to field member. */
 361         SJME_CLASS_POOL_ENTRY_MEMBER_TYPE_FIELD,
 362
 363         /** Reference to method member. */
 364         SJME_CLASS_POOL_ENTRY_MEMBER_TYPE_METHOD,
 365
 366         /** Reference to interface method member. */
 367         SJME_CLASS_POOL_ENTRY_MEMBER_TYPE_INTERFACE_METHOD,
 368
 369         /** The number of member types. */
 370         SJME_NUM_CLASS_POOL_ENTRY_MEMBER_TYPE
 371 } sjme_class_poolEntryMemberType;
 372
 373 /**
 374  * Either @c SJME_CLASS_POOL_TYPE_FIELD , @c SJME_CLASS_POOL_TYPE_METHOD ,
 375  * or @c SJME_CLASS_POOL_TYPE_INTERFACE_METHOD which represents a reference
 376  * to a class member.
 377  *
 378  * @since 2024/01/04
 379  */
 380 typedef struct sjme_class_poolEntryMember
 381 {
 382         /** The type of entry this. */
 383         sjme_class_poolEntryMemberType type;
 384
 385         /** The class this refers to. */
 386         sjme_lpcstr inClass;
 387
 388         /** The name and type used. */
 389         const sjme_class_poolEntryNameAndType* nameAndType;
 390 } sjme_class_poolEntryMember;
 391
 392 /**
 393  * A @c SJME_CLASS_POOL_TYPE_FLOAT which represents a float constant.
 394  *
 395  * @since 2024/01/04
 396  */
 397 typedef struct sjme_class_poolEntryFloat
 398 {
 399         /** The constant value. */
 400         sjme_jfloat value;
 401 } sjme_class_poolEntryFloat;
 402
 403 /**
 404  * A @c SJME_CLASS_POOL_TYPE_INTEGER which represents an integer constant.
 405  *
 406  * @since 2024/01/04
 407  */
 408 typedef struct sjme_class_poolEntryInteger
 409 {
 410         /** The constant value. */
 411         sjme_jint value;
 412 } sjme_class_poolEntryInteger;
 413
 414 /**
 415  * A @c SJME_CLASS_POOL_TYPE_LONG which represents a long constant.
 416  *
 417  * @since 2024/01/04
 418  */
 419 typedef struct sjme_class_poolEntryLong
 420 {
 421         /** The constant value. */
 422         sjme_jlong value;
 423 } sjme_class_poolEntryLong;
 424
 425 struct sjme_class_poolEntryNameAndType
 426 {
 427         /** The name. */
 428         sjme_lpcstr name;
 429
 430         /** The type. */
 431         sjme_lpcstr type;
 432 };
 433
 434 /**
 435  * A @c SJME_CLASS_POOL_TYPE_UTF which is a modified UTF-8 entry.
 436  *
 437  * @since 2024/01/04
 438  */
 439 typedef struct sjme_class_poolEntryUtf
 440 {
 441         /** The hash code for the entry. */
 442         sjme_jint hash;
 443
 444         /** The UTF data for this entry. */
 445         sjme_lpcstr utf;
 446 } sjme_class_poolEntryUtf;
 447
 448 /**
 449  * Represents a single constant pool entry.
 450  *
 451  * @since 2024/01/04
 452  */
 453 typedef struct sjme_class_poolEntry
 454 {
 455         /** The type of entry that this is. */
 456         sjme_class_poolType type;
 457
 458         /** The data for the entry. */
 459         union
 460         {
 461                 /** Class. */
 462                 sjme_class_poolEntryClass classRef;
 463
 464                 /** Double. */
 465                 sjme_class_poolEntryDouble constDouble;
 466
 467                 /** Float. */
 468                 sjme_class_poolEntryFloat constFloat;
 469
 470                 /** Integer. */
 471                 sjme_class_poolEntryInteger constInteger;
 472
 473                 /** Long. */
 474                 sjme_class_poolEntryLong constLong;
 475
 476                 /** A class member. */
 477                 sjme_class_poolEntryMember member;
 478
 479                 /** Name and type. */
 480                 sjme_class_poolEntryNameAndType nameAndType;
 481
 482                 /** UTF pool entry. */
 483                 sjme_class_poolEntryUtf utf;
 484         } data;
 485 } sjme_class_poolEntry;
 486
 487 /** A list of constant pool entries. */
 488 SJME_LIST_DECLARE(sjme_class_poolEntry, 0);
 489
 490 struct sjme_class_infoCore
 491 {
 492         /** The constant pool of this class. */
 493         const sjme_list_sjme_class_poolEntry* pool;
 494
 495         /** The name of this class. */
 496         sjme_lpcstr name;
 497
 498         /** The superclass of this class. */
 499         sjme_lpcstr superName;
 500
 501         /** The interfaces this class implements. */
 502         const sjme_list_sjme_lpcstr* interfaceNames;
 503
 504         /** Fields within the method. */
 505         const sjme_list_sjme_class_fieldInfo* fields;
 506
 507         /** Methods within the class. */
 508         const sjme_list_sjme_class_methodInfo* methods;
 509 };
 510
 511 /**
 512  * Represents a field's constant value.
 513  *
 514  * @since 2024/01/08
 515  */
 516 typedef struct sjme_class_fieldConstVal
 517 {
 518         /** The type of value. */
 519         sjme_javaTypeId type;
 520
 521         /** The value of the field. */
 522         union
 523         {
 524                 /** The Java value. */
 525                 sjme_jvalue java;
 526
 527                 /** Constant string. */
 528                 sjme_lpcstr string;
 529         } value;
 530 } sjme_class_fieldConstVal;
 531
 532 struct sjme_class_fieldInfoCore
 533 {
 534         /** The class which contains this field. */
 535         sjme_class_info inClass;
 536
 537         /** Field flags. */
 538         sjme_class_fieldFlags flags;
 539
 540         /** The constant value, if any. */
 541         sjme_class_fieldConstVal constVal;
 542 };
 543
 544 struct sjme_class_methodInfoCore
 545 {
 546         /** The class which contains this method. */
 547         sjme_class_info inClass;
 548
 549         /** Method flags. */
 550         sjme_class_methodFlags flags;
 551
 552         /** The method code, if it is not native. */
 553         sjme_class_codeInfo code;
 554 };
 555
 556 struct sjme_class_codeInfoCore
 557 {
 558         /** The method which contains this code. */
 559         sjme_class_methodInfo inMethod;
 560
 561         /** Maximum number of locals. */
 562         sjme_jint maxLocals;
 563
 564         /** Maximum number of stack entries. */
 565         sjme_jint maxStack;
 566
 567         /** Exception table. */
 568         const sjme_list_sjme_class_exceptionHandler* exceptions;
 569
 570         /** Method byte code. */
 571         sjme_list_sjme_jubyte code;
 572 };
 573
 574 /**
 575  * Stack map table representation.
 576  *
 577  * @since 2024/01/09
 578  */
 579 typedef struct sjme_class_stackMap
 580 {
 581         /** Todo. */
 582         int todo;
 583 } sjme_class_stackMap;
 584
 585 /**
 586  * Parses a single class and loads its class information.
 587  *
 588  * @param inPool The pool to allocate within.
 589  * @param inStream The stream to parse from when reading the class.
 590  * @param outClass The resultant class information
 591  * @return Any resultant error code, if any.
 592  * @since 2024/01/03
 593  */
 594 sjme_errorCode sjme_class_parse(
 595         sjme_attrInNotNull sjme_alloc_pool* inPool,
 596         sjme_attrInNotNull sjme_stream_input inStream,
 597         sjme_attrOutNotNull sjme_class_info* outClass);
 598
 599 sjme_errorCode sjme_class_parseAttributeCode(
 600         sjme_attrInNotNull sjme_stream_input inStream,
 601         sjme_attrInNotNull sjme_class_methodInfo inMethod,
 602         sjme_attrOutNotNull sjme_class_codeInfo* outCode);
 603
 604 sjme_errorCode sjme_class_parseAttributeConstVal(
 605         sjme_attrInNotNull sjme_stream_input inStream,
 606         sjme_attrInNotNull sjme_class_fieldInfo inField,
 607         sjme_attrOutNotNull sjme_class_fieldConstVal* outConstVal);
 608
 609 sjme_errorCode sjme_class_parseAttributeStackMapOld(
 610         sjme_attrInNotNull sjme_stream_input inStream,
 611         sjme_attrOutNotNull sjme_class_codeInfo inCode,
 612         sjme_attrOutNotNull sjme_class_stackMap* outStackMap);
 613
 614 sjme_errorCode sjme_class_parseAttributeStackMapNew(
 615         sjme_attrInNotNull sjme_stream_input inStream,
 616         sjme_attrOutNotNull sjme_class_codeInfo inCode,
 617         sjme_attrOutNotNull sjme_class_stackMap* outStackMap);
 618
 619 sjme_errorCode sjme_class_parseConstantPool(
 620         sjme_attrInNotNull sjme_stream_input inStream,
 621         sjme_attrInNotNull sjme_class_info inClass,
 622         sjme_attrOutNotNull sjme_list_sjme_class_poolEntry* outPool);
 623
 624 sjme_errorCode sjme_class_parseField(
 625         sjme_attrInNotNull sjme_stream_input inStream,
 626         sjme_attrOutNotNull sjme_class_fieldInfo* outField);
 627
 628 sjme_errorCode sjme_class_parseFields(
 629         sjme_attrInNotNull sjme_stream_input inStream,
 630         sjme_attrInNotNull sjme_class_info inClass,
 631         sjme_attrOutNotNull sjme_list_sjme_class_fieldInfo* outFields);
 632
 633 sjme_errorCode sjme_class_parseMethod(
 634         sjme_attrInNotNull sjme_stream_input inStream,
 635         sjme_attrInOutNotNull sjme_class_methodInfo* outMethod);
 636
 637 sjme_errorCode sjme_class_parseMethods(
 638         sjme_attrInNotNull sjme_stream_input inStream,
 639         sjme_attrInNotNull sjme_class_info inClass,
 640         sjme_attrOutNotNull sjme_list_sjme_class_methodInfo* outMethods);
 641
 642 /*--------------------------------------------------------------------------*/
 643
 644 /* Anti-C++. */
 645 #ifdef __cplusplus
 646         #ifdef SJME_CXX_SQUIRRELJME_CLASSY_H
 647 }
 648                 #undef SJME_CXX_SQUIRRELJME_CLASSY_H
 649                 #undef SJME_CXX_IS_EXTERNED
 650         #endif /* #ifdef SJME_CXX_SQUIRRELJME_CLASSY_H */
 651 #endif     /* #ifdef __cplusplus */
 652
 653 #endif /* SQUIRRELJME_CLASSY_H */