avm1: clean-up global definitions

- Adds a new `DeclContext` with convenience methods for defining classes
- Use the same function names for each global (`create_class` for classes, `create` for objects)

Author: moulins

core/src/avm1/globals.rs

@@ -2,17 +2,22 @@
 
 use crate::avm1::activation::Activation;
 use crate::avm1::error::Error;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration};
 use crate::avm1::{Object, Value};
 use crate::avm1_stub;
-use crate::string::StringContext;
 
 const OBJECT_DECLS: &[Declaration] = declare_properties! {
     "isActive" => method(is_active; DONT_DELETE | READ_ONLY);
     "sendEvent" => method(send_event; DONT_DELETE | READ_ONLY);
     "updateProperties" => method(update_properties; DONT_DELETE | READ_ONLY);
 };
 
+pub fn create<'gc>(context: &mut DeclContext<'_, 'gc>) -> Object<'gc> {
+    let accessibility = Object::new(context.strings, Some(context.object_proto));
+    context.define_properties_on(accessibility, OBJECT_DECLS);
+    accessibility
+}
+
 pub fn is_active<'gc>(
     activation: &mut Activation<'_, 'gc>,
     _this: Object<'gc>,
@@ -39,13 +44,3 @@ pub fn update_properties<'gc>(
     avm1_stub!(activation, "Accessibility", "updateProperties");
     Ok(Value::Undefined)
 }
-
-pub fn create_accessibility_object<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let accessibility = Object::new(context, Some(proto));
-    define_properties_on(OBJECT_DECLS, context, accessibility, fn_proto);
-    accessibility
-}

core/src/avm1/globals/accessibility.rs

@@ -3,8 +3,7 @@
 use crate::avm1::activation::Activation;
 use crate::avm1::clamp::Clamp;
 use crate::avm1::error::Error;
-use crate::avm1::function::FunctionObject;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Attribute, NativeObject, Object, Value};
 use crate::ecma_conversions::f64_to_wrapping_i32;
 use crate::string::{AvmString, StringContext};
@@ -62,6 +61,22 @@ const OBJECT_DECLS: &[Declaration] = declare_properties! {
     "NUMERIC" => int(SortOptions::NUMERIC.bits());
 };
 
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> SystemClass<'gc> {
+    let proto = ArrayBuilder::new_with_proto(context.strings, super_proto).with([]);
+    let class = context.native_class_with_proto(constructor, Some(array), proto);
+    context.define_properties_on(proto, PROTO_DECLS);
+
+    // TODO: These were added in Flash Player 7, but are available even to SWFv6 and lower
+    // when run in Flash Player 7. Make these conditional if we add a parameter to control
+    // target Flash Player version.
+    context.define_properties_on(class.constr, OBJECT_DECLS);
+
+    class
+}
+
 /// Intermediate builder for constructing `ArrayObject`,
 /// used to work around borrow-checker issues.
 pub struct ArrayBuilder<'gc> {
@@ -121,23 +136,8 @@ impl<'gc> ArrayBuilder<'gc> {
     }
 }
 
-pub fn create_array_object<'gc>(
-    context: &mut StringContext<'gc>,
-    array_proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let array =
-        FunctionObject::constructor(context, constructor, Some(array), fn_proto, array_proto);
-
-    // TODO: These were added in Flash Player 7, but are available even to SWFv6 and lower
-    // when run in Flash Player 7. Make these conditional if we add a parameter to control
-    // target Flash Player version.
-    define_properties_on(OBJECT_DECLS, context, array, fn_proto);
-    array
-}
-
 /// Implements `Array` constructor
-pub fn constructor<'gc>(
+fn constructor<'gc>(
     activation: &mut Activation<'_, 'gc>,
     this: Object<'gc>,
     args: &[Value<'gc>],
@@ -792,13 +792,3 @@ fn qsort<'gc>(
 
     Ok(())
 }
-
-pub fn create_proto<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let array = ArrayBuilder::new_with_proto(context, proto).with([]);
-    define_properties_on(PROTO_DECLS, context, array, fn_proto);
-    array
-}

core/src/avm1/globals/array.rs

@@ -2,9 +2,8 @@
 
 use crate::avm1::error::Error;
 use crate::avm1::function::ExecutionReason;
-use crate::avm1::function::FunctionObject;
 use crate::avm1::property::Attribute;
-use crate::avm1::property_decl::Declaration;
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Activation, ArrayBuilder, Object, Value};
 use crate::string::{AvmString, StringContext};
 use gc_arena::Collect;
@@ -17,19 +16,17 @@ const OBJECT_DECLS: &[Declaration] = declare_properties! {
     "broadcastMessage" => function(broadcast_message; DONT_ENUM | DONT_DELETE);
 };
 
-pub fn create<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> (BroadcasterFunctions<'gc>, Object<'gc>) {
-    let as_broadcaster_proto = Object::new(context, Some(proto));
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> (BroadcasterFunctions<'gc>, SystemClass<'gc>) {
     // Despite the documentation says that there is no constructor function for the `AsBroadcaster`
     // class, Flash accepts expressions like `new AsBroadcaster()`, and a newly-created object is
     // returned in such cases.
-    let as_broadcaster = FunctionObject::empty(context, fn_proto, as_broadcaster_proto);
+    let class = context.empty_class(super_proto);
 
     let mut define_as_object = |index: usize| -> Object<'gc> {
-        match OBJECT_DECLS[index].define_on(context, as_broadcaster, fn_proto) {
+        match OBJECT_DECLS[index].define_on(context.strings, class.constr, context.fn_proto) {
             Value::Object(o) => o,
             _ => panic!("expected object for broadcaster function"),
         }
@@ -42,7 +39,7 @@ pub fn create<'gc>(
             remove_listener: define_as_object(2),
             broadcast_message: define_as_object(3),
         },
-        as_broadcaster,
+        class,
     )
 }
 

core/src/avm1/globals/as_broadcaster.rs

@@ -1,10 +1,8 @@
 //! flash.filters.BevelFilter object
 
-use crate::avm1::function::FunctionObject;
 use crate::avm1::object::NativeObject;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Activation, Error, Object, Value};
-use crate::string::StringContext;
 use gc_arena::{Collect, Gc, Mutation};
 use ruffle_macros::istr;
 use std::cell::Cell;
@@ -405,6 +403,15 @@ const PROTO_DECLS: &[Declaration] = declare_properties! {
     "type" => property(bevel_filter_method!(23), bevel_filter_method!(24); VERSION_8);
 };
 
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> SystemClass<'gc> {
+    let class = context.native_class(bevel_filter_method!(0), None, super_proto);
+    context.define_properties_on(class.proto, PROTO_DECLS);
+    class
+}
+
 fn method<'gc>(
     activation: &mut Activation<'_, 'gc>,
     this: Object<'gc>,
@@ -520,21 +527,3 @@ fn method<'gc>(
         _ => Value::Undefined,
     })
 }
-
-pub fn create_proto<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let bevel_filter_proto = Object::new(context, Some(proto));
-    define_properties_on(PROTO_DECLS, context, bevel_filter_proto, fn_proto);
-    bevel_filter_proto
-}
-
-pub fn create_constructor<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    FunctionObject::constructor(context, bevel_filter_method!(0), None, fn_proto, proto)
-}

core/src/avm1/globals/bevel_filter.rs

@@ -1,19 +1,17 @@
 //! flash.display.BitmapData object
 
 use super::matrix::object_to_matrix;
-use crate::avm1::function::FunctionObject;
 use crate::avm1::globals::bitmap_filter;
 use crate::avm1::globals::color_transform::ColorTransformObject;
 use crate::avm1::object::NativeObject;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Activation, Attribute, Error, Object, Value};
 use crate::bitmap::bitmap_data::BitmapData;
 use crate::bitmap::bitmap_data::{BitmapDataDrawError, IBitmapDrawable};
 use crate::bitmap::bitmap_data::{ChannelOptions, ThresholdOperation};
 use crate::bitmap::{is_size_valid, operations};
 use crate::character::Character;
 use crate::display_object::DisplayObject;
-use crate::string::StringContext;
 use crate::swf::BlendMode;
 use crate::{avm1_stub, avm_error};
 use ruffle_macros::istr;
@@ -54,6 +52,16 @@ const OBJECT_DECLS: &[Declaration] = declare_properties! {
     "loadBitmap" => method(load_bitmap);
 };
 
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> SystemClass<'gc> {
+    let class = context.native_class(constructor, None, super_proto);
+    context.define_properties_on(class.proto, PROTO_DECLS);
+    context.define_properties_on(class.constr, OBJECT_DECLS);
+    class
+}
+
 fn new_bitmap_data<'gc>(
     proto: Option<Value<'gc>>,
     bitmap_data: BitmapData<'gc>,
@@ -1561,16 +1569,3 @@ fn load_bitmap<'gc>(
     )
     .into())
 }
-
-pub fn create_constructor<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    define_properties_on(PROTO_DECLS, context, proto, fn_proto);
-
-    let bitmap_data_constructor =
-        FunctionObject::constructor(context, constructor, None, fn_proto, proto);
-    define_properties_on(OBJECT_DECLS, context, bitmap_data_constructor, fn_proto);
-    bitmap_data_constructor
-}

core/src/avm1/globals/bitmap_data.rs

@@ -11,17 +11,25 @@ use crate::avm1::globals::drop_shadow_filter::DropShadowFilter;
 use crate::avm1::globals::glow_filter::GlowFilter;
 use crate::avm1::globals::gradient_filter::GradientFilter;
 use crate::avm1::object::NativeObject;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Attribute, Object, Value};
 use crate::context::UpdateContext;
-use crate::string::StringContext;
 use ruffle_macros::istr;
 use ruffle_render::filters::Filter;
 
 const PROTO_DECLS: &[Declaration] = declare_properties! {
     "clone" => method(clone);
 };
 
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> SystemClass<'gc> {
+    let class = context.empty_class(super_proto);
+    context.define_properties_on(class.proto, PROTO_DECLS);
+    class
+}
+
 pub fn clone<'gc>(
     activation: &mut Activation<'_, 'gc>,
     this: Object<'gc>,
@@ -164,13 +172,3 @@ pub fn create_instance<'gc>(
     result.set_native(activation.gc(), native);
     result
 }
-
-pub fn create_proto<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let object = Object::new(context, Some(proto));
-    define_properties_on(PROTO_DECLS, context, object, fn_proto);
-    object
-}

core/src/avm1/globals/bitmap_filter.rs

@@ -1,10 +1,7 @@
 //! flash.filters.BlurFilter object
-
-use crate::avm1::function::FunctionObject;
 use crate::avm1::object::NativeObject;
-use crate::avm1::property_decl::{define_properties_on, Declaration};
+use crate::avm1::property_decl::{DeclContext, Declaration, SystemClass};
 use crate::avm1::{Activation, Error, Object, Value};
-use crate::string::StringContext;
 use gc_arena::{Collect, Gc, Mutation};
 use std::cell::Cell;
 use swf::{BlurFilterFlags, Fixed16};
@@ -134,6 +131,15 @@ const PROTO_DECLS: &[Declaration] = declare_properties! {
     "quality" => property(blur_filter_method!(5), blur_filter_method!(6); VERSION_8);
 };
 
+pub fn create_class<'gc>(
+    context: &mut DeclContext<'_, 'gc>,
+    super_proto: Object<'gc>,
+) -> SystemClass<'gc> {
+    let class = context.native_class(blur_filter_method!(0), None, super_proto);
+    context.define_properties_on(class.proto, PROTO_DECLS);
+    class
+}
+
 fn method<'gc>(
     activation: &mut Activation<'_, 'gc>,
     this: Object<'gc>,
@@ -178,21 +184,3 @@ fn method<'gc>(
         _ => Value::Undefined,
     })
 }
-
-pub fn create_proto<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    let blur_filter_proto = Object::new(context, Some(proto));
-    define_properties_on(PROTO_DECLS, context, blur_filter_proto, fn_proto);
-    blur_filter_proto
-}
-
-pub fn create_constructor<'gc>(
-    context: &mut StringContext<'gc>,
-    proto: Object<'gc>,
-    fn_proto: Object<'gc>,
-) -> Object<'gc> {
-    FunctionObject::constructor(context, blur_filter_method!(0), None, fn_proto, proto)
-}