syntax: 'meth' -> 'fun', 'attr' -> 'var'
[nit.git] / lib / nit_common.h
1 #ifndef NIT_COMMON_H
2 #define NIT_COMMON_H
3
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <string.h>
7
8 #ifdef WITH_LIBGC
9 #include <gc/gc.h>
10 #define malloc(x) GC_MALLOC((x))
11 #define calloc(x,y) GC_MALLOC((x)*(y))
12 #endif
13
14
15
16 /* *** Types *** */
17 typedef signed long int bigint; /* standard int value, must be larger that any poiner */
18 typedef bigint (*fun_t) (bigint); /* generic function pointer */
19 typedef bigint cid_t; /* class identifier */
20 typedef bigint val_t; /* value (everything is a val_t) */
21 typedef union obj_tu {union classtable_elt_tu * vft; val_t attr;} *obj_t; /* standard object */
22 typedef union classtable_elt_tu { bigint i; fun_t f; cid_t cid;} classtable_elt_t; /* classtable element */
23
24 typedef classtable_elt_t * classtable_t; /* classtable */
25
26 /*****************************************************************************
27 * Types macros (primitive and less primitives) ******************************
28 *****************************************************************************
29 *
30 * ** types are: **
31 *
32 * OBJ (obj_t) : standard object representation (including boxes + NIL)
33 * Int (int) : integers
34 * Char (car) : characters
35 * Bool (int) : booleans (true or false)
36 *
37 * X (x_t) : generic representatio of the previous four types
38 *
39 * ** macros are: **
40 *
41 * int ISX(val_t v) : true if v is a X
42 * x_t VAL2X(val_t v) : convert a val_t to a primitive type (you should check ISX before)
43 * val_t X2VAL(x_t x) : convert a type to a val_t
44 * int XTAG : numeric identifier of a type
45 * int TAG(val_t v) : return the XTAG (ie TAG(Char2VAL('e')) == CharTag)
46 *
47 * classtable_t VAL2VFT(val_t v): the virtual function table of a value
48 *
49 * val_t NIT_NULL : the instance of the None class
50 *****************************************************************************/
51
52 #define TAG(x) ((int)(x) & 3)
53 #ifndef IntTAG
54 # define IntTAG 1
55 #endif
56 #define TAG_Int(x) ((val_t)(((x)<<2)|IntTAG))
57 #define UNTAG_Int(x) ((bigint)(x)>>2)
58 #ifndef CharTAG
59 # define CharTAG 2
60 #endif
61 #define TAG_Char(x) ((val_t)((((int)(x))<<2)|CharTAG))
62 #define UNTAG_Char(x) ((char)((int)(x)>>2))
63 #ifndef BoolTAG
64 # define BoolTAG 3
65 #endif
66 #define TAG_Bool(x) ((val_t)(((x)<<2)|BoolTAG))
67 #define UNTAG_Bool(x) ((int)(x)>>2)
68 #ifndef OBJTAG
69 # define OBJTAG 0
70 #endif
71
72 #define ISOBJ(x) (TAG((x)) == OBJTAG)
73 #define VAL2OBJ(x) ((obj_t)(x))
74 #define OBJ2VAL(o) ((val_t)(o))
75 #define VAL2VFT(x) (ISOBJ(x) ? VAL2OBJ(x)->vft : TAG2VFT[TAG(x)])
76 /*#define VAL2CID(x) (ISOBJ(x) ? (VAL2OBJ(x)->vft->cid) : (-TAG(x)))*/
77 #define VAL2CID(x) (VAL2OBJ(x)->vft->cid)
78
79 #define NIT_NULL ((val_t)0)
80 #define ISNULL(x) ((x)==NIT_NULL)
81
82 /* Equal comparaison */
83 /* O = Non nil object ; N = Object or nil ; P = Primitive */
84 #define OBJ_IS_BOX(x) ((VAL2OBJ(x)->vft->i) < 0)
85 #define IS_BOX(x) (ISOBJ(x) && OBJ_IS_BOX(x))
86 #define IS_EQUAL_BOX(x, y) (ISOBJ(y) && (VAL2OBJ(x)[1].vft==VAL2OBJ(y)[1].vft) && (VAL2OBJ(x)->vft==VAL2OBJ(y)->vft))
87 #define IS_EQUAL_OO(x, y) ((x)==(y) || (IS_BOX(x) && IS_EQUAL_BOX((x), (y))))
88 #define IS_EQUAL_ON(x, y) ((x)==(y) || (IS_BOX(x) && !ISNULL(y) && IS_EQUAL_BOX((x), (y))))
89 #define IS_EQUAL_NN(x, y) ((x)==(y) || (!ISNULL(x) && IS_BOX(x) && !ISNULL(y) && IS_EQUAL_BOX((x), (y))))
90
91 /* Subclass comparaison */
92 /* check is e is a subtype of c2 */
93 /* Warning, only subclasse comparaison is performed, not subtype */
94 /* e is a val (not nil) */
95 /* c a class name (eg: Int) */
96 #define VALISA(e, c) (VAL2VFT(e)[COLOR_ ## c].cid == (cid_t) ID_ ## c)
97 #define OBJISA(e, c) (VAL2OBJ(e)->vft[COLOR_ ## c].cid == (cid_t) ID_ ## c)
98
99 #define VAL_ISA(e, c, i) (VAL2VFT((e))[(c)].cid == (cid_t)(i))
100
101 void * alloc(size_t);
102 extern val_t G_args;
103 extern val_t G_stdin;
104 extern val_t G_stdout;
105 extern val_t G_stderr;
106 extern val_t G_sys;
107
108 extern int glob_argc;
109 extern char ** glob_argv;
110
111 struct trace_t {
112 struct trace_t *prev; /* previous stack frame */
113 const char *file; /* source filename */
114 int line; /* line number */
115 const char *meth; /* method name */
116 };
117 extern struct trace_t *tracehead;
118 typedef enum {true = (1==1),false = (0==1)} bool;
119
120 void nit_exit(int);
121
122 #define CALL(r,c) ((VAL2VFT(r)[c].f))
123 #define ATTR(r,c) (*(val_t*)(VAL2OBJ(r)+c))
124 #define ATTRS(r,c,o) ((VAL2OBJ(r)+VAL2VFT(r)[c].i)[o].attr)
125
126 void prepare_signals(void);
127 extern classtable_t TAG2VFT[4];
128
129 /* This structure is used to store closure.
130 * Specific closure use a specific fun parameter.
131 */
132 struct WBT_ {fun_t fun; val_t *has_broke; val_t broke_value; val_t *variable; struct WBT_ **closurevariable;};
133 #endif