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 #define TRAIT_ATTR_FINAL 0x10
  88 #define TRAIT_ATTR_OVERRIDE 0x20
  89 #define TRAIT_ATTR_METADATA 0x40
  90
  91
  92 struct _trait {
  93     unsigned char kind;
  94     unsigned char attributes;
  95     multiname_t*name;
  96
  97     union {
  98         int disp_id;
  99         int slot_id;
 100         int data1;
 101     };
 102     union {
 103         abc_method_t*method;
 104         abc_class_t*cls;
 105         multiname_t*type_name;
 106         int data2;
 107     };
 108     constant_t*value;
 109 };
 110
 111 trait_t*trait_new_method(trait_list_t**traits, multiname_t*name, abc_method_t*m);
 112 trait_t*trait_new_member(trait_list_t**traits, multiname_t*type, multiname_t*name, constant_t*v);
 113
 114 #define CLASS_SEALED 1
 115 #define CLASS_FINAL 2
 116 #define CLASS_INTERFACE 4
 117 #define CLASS_PROTECTED_NS 8
 118
 119 struct _abc_class {
 120     abc_file_t*file;
 121
 122     multiname_t*classname;
 123     multiname_t*superclass;
 124     namespace_t*protectedNS;
 125
 126     multiname_list_t*interfaces;
 127
 128     abc_method_t*constructor;
 129     trait_list_t*traits;
 130
 131     abc_method_t*static_constructor;
 132     trait_list_t*static_traits;
 133
 134     U8 flags;
 135
 136     int init_scope_depth; // volatile, might be increased during code verification
 137
 138     int index; //filled in during writing
 139 };
 140
 141 void abc_method_init(abc_method_t*m, abc_file_t*file, multiname_t*returntype, char body);
 142 abc_method_t* abc_method_new(abc_file_t*file, multiname_t*returntype, char body);
 143
 144 abc_class_t* abc_class_new(abc_file_t*file, multiname_t*classname, multiname_t*superclass);
 145 abc_class_t* abc_class_new2(abc_file_t*file, char*classname, char*superclass);
 146 void abc_class_sealed(abc_class_t*c);
 147 void abc_class_final(abc_class_t*c);
 148 void abc_class_interface(abc_class_t*c);
 149 void abc_class_protectedNS(abc_class_t*c, char*namespace);
 150 void abc_class_add_interface(abc_class_t*c, multiname_t*interface);
 151
 152 trait_t* abc_class_find_slotid(abc_class_t*c, int slotid);
 153
 154 abc_method_t* abc_class_getconstructor(abc_class_t*cls, multiname_t*returntype);
 155 abc_method_t* abc_class_getstaticconstructor(abc_class_t*cls, multiname_t*returntype);
 156
 157 abc_method_t* abc_class_method(abc_class_t*cls, multiname_t*returntype, multiname_t*name);
 158 abc_method_t* abc_class_staticmethod(abc_class_t*cls, multiname_t*returntype, multiname_t*name);
 159 trait_t*      abc_class_slot(abc_class_t*cls, multiname_t*name, multiname_t*type);
 160 trait_t*      abc_class_staticslot(abc_class_t*cls, multiname_t*name, multiname_t*type);
 161
 162 struct _abc_exception {
 163     code_t*from;
 164     code_t*to;
 165     code_t*target;
 166     multiname_t*exc_type;
 167     multiname_t*var_name;
 168 };
 169
 170 struct _abc_method_body {
 171     abc_file_t*file;
 172     //abc_class_t*cls;
 173     abc_method_t*method;
 174     code_t*code;
 175
 176     struct {
 177         //for dumping: filled in during parsing
 178         int max_stack;
 179         int local_count;
 180         int max_scope_depth;
 181         int init_scope_depth;
 182     } old;
 183
 184     int init_scope_depth; // volatile, might be increased during code verification
 185
 186     abc_exception_list_t* exceptions;
 187
 188     trait_list_t*traits;
 189
 190     int index; // filled in during writing
 191     codestats_t*stats; //filled in during writing
 192 };
 193
 194 typedef struct _abc_script {
 195     abc_method_t*method;
 196     abc_file_t*file;
 197     trait_list_t*traits;
 198 } abc_script_t;
 199
 200 abc_method_t* abc_nullmethod(abc_file_t*file);
 201 abc_script_t* abc_initscript(abc_file_t*file);
 202 int abc_initscript_addClassTrait(abc_script_t*script, multiname_t*multiname, abc_class_t*cls);
 203
 204 #define __
 205
 206 #endif