cross-linked traits with methods, start trait indexes at 1
[swftools.git] / lib / as3 / abc.h
1 /* abc.h
2
3    Routines for handling Flash2 AVM2 ABC Actionscript (header file)
4
5    Extension module for the rfxswf library.
6    Part of the swftools package.
7
8    Copyright (c) 2008 Matthias Kramm <kramm@quiss.org>
9  
10    This program is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2 of the License, or
13    (at your option) any later version.
14
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
23
24 #ifndef __swfabc_h__
25 #define __swfabc_h__
26
27 #include "../q.h"
28 #include "pool.h"
29
30 DECLARE(abc_file);
31 DECLARE(abc_method);
32 DECLARE(abc_method_body);
33 DECLARE(abc_interface);
34 DECLARE(abc_class);
35 DECLARE(abc_exception);
36 DECLARE_LIST(abc_exception);
37
38 #include "code.h"
39 #include "opcodes.h"
40
41 DECLARE(trait);
42
43
44 #define METHOD_NEED_ARGUMENTS 1
45 #define METHOD_NEED_ACTIVATION 2
46 #define METHOD_NEED_REST 4
47 #define METHOD_HAS_OPTIONAL 8
48 #define METHOD_SET_DXNS 0x40
49 #define METHOD_HAS_PARAM_NAMES 0x80
50
51 struct _abc_method {
52     multiname_t*return_type;
53     multiname_list_t*parameters;
54     constant_list_t*optional_parameters;
55     const char*name;
56     U8 flags;
57     abc_method_body_t*body;
58
59     trait_t*trait;
60     
61     int index; //filled in during writing
62 };
63
64 #define ABCFILE_LAZY 1
65 struct _abc_file {
66     // abc_file
67
68     const char*name;
69     U32 flags;
70     array_t*metadata;
71     array_t*methods;
72     array_t*classes;
73     array_t*scripts;
74     array_t*method_bodies;
75 };
76
77 abc_file_t*abc_file_new();
78
79 #define TRAIT_SLOT 0
80 #define TRAIT_METHOD 1
81 #define TRAIT_GETTER 2
82 #define TRAIT_SETTER 3
83 #define TRAIT_CLASS 4
84 #define TRAIT_FUNCTION 5
85 #define TRAIT_CONST 6
86
87
88 struct _trait {
89     unsigned char kind;
90     unsigned char attributes;
91     multiname_t*name;
92
93     union {
94         int disp_id;
95         int slot_id;
96         int data1;
97     };
98     union {
99         abc_method_t*method;
100         abc_class_t*cls;
101         multiname_t*type_name;
102         int data2;
103     };
104     constant_t*value;
105 };
106
107 #define CLASS_SEALED 1
108 #define CLASS_FINAL 2
109 #define CLASS_INTERFACE 4
110 #define CLASS_PROTECTED_NS 8
111
112 struct _abc_class {
113     abc_file_t*file;
114     
115     multiname_t*classname;
116     multiname_t*superclass;
117     namespace_t*protectedNS;
118
119     multiname_list_t*interfaces;
120
121     abc_method_t*constructor;
122     trait_list_t*traits;
123     
124     abc_method_t*static_constructor;
125     trait_list_t*static_traits;
126     
127     U8 flags;
128
129     int init_scope_depth; // volatile, might be increased during code verification
130     
131     int index; //filled in during writing
132 };
133
134 abc_class_t* abc_class_new(abc_file_t*file, multiname_t*classname, multiname_t*superclass);
135 abc_class_t* abc_class_new2(abc_file_t*file, char*classname, char*superclass);
136 void abc_class_sealed(abc_class_t*c);
137 void abc_class_final(abc_class_t*c);
138 void abc_class_interface(abc_class_t*c);
139 void abc_class_protectedNS(abc_class_t*c, char*namespace);
140 void abc_class_add_interface(abc_class_t*c, multiname_t*interface);
141
142 trait_t* abc_class_find_slotid(abc_class_t*c, int slotid);
143
144 abc_method_body_t* abc_class_staticconstructor(abc_class_t*cls, multiname_t*returntype, int num_params, ...);
145 abc_method_body_t* abc_class_constructor(abc_class_t*cls, multiname_t*returntype, int num_params, ...);
146 abc_method_body_t* abc_class_method(abc_class_t*cls, multiname_t*returntype, char*name, int num_params, ...);
147 trait_t*           abc_class_slot(abc_class_t*cls, char*name, multiname_t*type);
148
149 struct _abc_exception {
150     code_t*from;
151     code_t*to;
152     code_t*target;
153     multiname_t*exc_type;
154     multiname_t*var_name;
155 };
156
157 struct _abc_method_body {
158     abc_file_t*file;
159     //abc_class_t*cls;
160     abc_method_t*method;
161     code_t*code;
162
163     struct {
164         //for dumping: filled in during parsing
165         int max_stack;
166         int local_count;
167         int max_scope_depth;
168         int init_scope_depth;
169     } old;
170
171     int init_scope_depth; // volatile, might be increased during code verification
172
173     abc_exception_list_t* exceptions;
174
175     trait_list_t*traits;
176     
177     int index; // filled in during writing
178     codestats_t*stats; //filled in during writing
179 };
180
181 typedef struct _abc_script {
182     abc_method_t*method;
183     abc_file_t*file;
184     trait_list_t*traits;
185 } abc_script_t;
186
187 abc_method_t* abc_nullmethod(abc_file_t*file);
188 abc_script_t* abc_initscript(abc_file_t*file, multiname_t*returntype, int num_params, ...);
189
190 #define __ 
191
192 #endif