class.h

   1 #ifndef _class__h__included__
   2 #define _class__h__included__
   3
   4 #include <stdlib.h>
   5
   6 /* Class table entry. */
   7 struct class;
   8
   9 /******************************************************************************
  10  *
  11  * DESCRIPTION:
  12  *      Search for class with given number.
  13  *
  14  * PARAMETERS:
  15  *      number                  Number of class to search.
  16  *
  17  * RETURN VALUE:
  18  *      Class structure, or NULL if no such class exists.
  19  *
  20  *****************************************************************************/
  21 struct class* class_search(size_t number);
  22
  23 /******************************************************************************
  24  *
  25  * DESCRIPTION:
  26  *      Register new class(es).
  27  *
  28  * PARAMETERS:
  29  *      class                   The class to register.
  30  *
  31  *****************************************************************************/
  32 void class_register(struct class* class);
  33
  34 /******************************************************************************
  35  *
  36  * DESCRIPTION:
  37  *      Unregister all classes.
  38  *
  39  *****************************************************************************/
  40 void class_unregister_all();
  41
  42 /******************************************************************************
  43  *
  44  * DESCRIPTION:
  45  *      Create class.
  46  *
  47  * PARAMETERS:
  48  *      fields                  Number of fields.
  49  *      locals                  Number of locals.
  50  *      instructions            Instructions array.
  51  *      ins_len                 Instructions array length.
  52  *
  53  * RETURN VALUE:
  54  *      The made class object.
  55  *
  56  *****************************************************************************/
  57 struct class* class_make(size_t fields, size_t locals,
  58         unsigned char* instructions, size_t ins_len);
  59
  60 /******************************************************************************
  61  *
  62  * DESCRIPTION:
  63  *      Get number of fields in class.
  64  *
  65  * PARAMETERS:
  66  *      class                   The class to interrogate.
  67  *
  68  * RETURN VALUE:
  69  *      Number of fields.
  70  *
  71  *****************************************************************************/
  72 size_t class_field_count(struct class* class);
  73
  74 /******************************************************************************
  75  *
  76  * DESCRIPTION:
  77  *      Get number of locals in class.
  78  *
  79  * PARAMETERS:
  80  *      class                   The class to interrogate.
  81  *
  82  * RETURN VALUE:
  83  *      Number of locals.
  84  *
  85  *****************************************************************************/
  86 size_t class_local_count(struct class* class);
  87
  88 /******************************************************************************
  89  *
  90  * DESCRIPTION:
  91  *      Get number of instructions in class.
  92  *
  93  * PARAMETERS:
  94  *      class                   The class to interrogate.
  95  *
  96  * RETURN VALUE:
  97  *      Number of instructions.
  98  *
  99  *****************************************************************************/
 100 size_t class_ins_count(struct class* class);
 101
 102 /******************************************************************************
 103  *
 104  * DESCRIPTION:
 105  *      Get instruction from class.
 106  *
 107  * PARAMETERS:
 108  *      class                   The class to interrogate.
 109  *      position                The position of instruction (zero based).
 110  *
 111  * RETURN VALUE:
 112  *      The instruction, or 0 if index is out of range.
 113  *
 114  *****************************************************************************/
 115 unsigned char class_get_ins(struct class* class, size_t position);
 116
 117
 118 #endif