ruffle/core/src/avm2/function.rs

//! AVM2 executables.

use crate::avm2::activation::Activation;
use crate::avm2::method::{BytecodeMethod, Method, NativeMethod};
use crate::avm2::object::{ClassObject, Object};
use crate::avm2::scope::ScopeChain;
use crate::avm2::traits::TraitKind;
use crate::avm2::value::Value;
use crate::avm2::Error;
use crate::string::WString;
use gc_arena::{Collect, Gc};
use std::fmt;

/// Represents code written in AVM2 bytecode that can be executed by some
/// means.
#[derive(Clone, Collect)]
#[collect(no_drop)]
pub struct BytecodeExecutable<'gc> {
    /// The method code to execute from a given ABC file.
    method: Gc<'gc, BytecodeMethod<'gc>>,

    /// The scope this method was defined in.
    scope: ScopeChain<'gc>,

    /// The receiver that this function is always called with.
    ///
    /// If `None`, then the receiver provided by the caller is used. A
    /// `Some` value indicates a bound executable.
    receiver: Option<Object<'gc>>,

    /// The bound superclass for this method.
    ///
    /// The `superclass` is the class that defined this method. If `None`,
    /// then there is no defining superclass and `super` operations should fall
    /// back to the `receiver`.
    bound_superclass: Option<ClassObject<'gc>>,
}

#[derive(Clone, Collect)]
#[collect(no_drop)]
pub struct NativeExecutable<'gc> {
    /// The method associated with the executable.
    method: Gc<'gc, NativeMethod<'gc>>,

    /// The scope this method was defined in.
    scope: ScopeChain<'gc>,

    /// The bound reciever for this method.
    bound_receiver: Option<Object<'gc>>,

    /// The bound superclass for this method.
    ///
    /// The `superclass` is the class that defined this method. If `None`,
    /// then there is no defining superclass and `super` operations should fall
    /// back to the `receiver`.
    bound_superclass: Option<ClassObject<'gc>>,
}

/// Represents code that can be executed by some means.
#[derive(Clone, Collect)]
#[collect(no_drop)]
pub enum Executable<'gc> {
    /// Code defined in Ruffle's binary.
    Native(NativeExecutable<'gc>),

    /// Code defined in a loaded ABC file.
    Action(BytecodeExecutable<'gc>),
}

impl<'gc> Executable<'gc> {
    /// Convert a method into an executable.
    pub fn from_method(
        method: Method<'gc>,
        scope: ScopeChain<'gc>,
        receiver: Option<Object<'gc>>,
        superclass: Option<ClassObject<'gc>>,
    ) -> Self {
        match method {
            Method::Native(method) => Self::Native(NativeExecutable {
                method,
                scope,
                bound_receiver: receiver,
                bound_superclass: superclass,
            }),
            Method::Bytecode(method) => Self::Action(BytecodeExecutable {
                method,
                scope,
                receiver,
                bound_superclass: superclass,
            }),
        }
    }

    /// Execute a method.
    ///
    /// The function will either be called directly if it is a Rust builtin, or
    /// executed on the same AVM2 instance as the activation passed in here.
    /// The value returned in either case will be provided here.
    ///
    /// It is a panicking logic error to attempt to execute user code while any
    /// reachable object is currently under a GcCell write lock.
    ///
    /// Passed-in arguments will be conformed to the set of method parameters
    /// declared on the function.
    pub fn exec(
        &self,
        unbound_receiver: Option<Object<'gc>>,
        mut arguments: &[Value<'gc>],
        activation: &mut Activation<'_, 'gc, '_>,
        callee: Object<'gc>,
    ) -> Result<Value<'gc>, Error> {
        let ret = match self {
            Executable::Native(bm) => {
                let method = bm.method.method;
                let receiver = bm.bound_receiver.or(unbound_receiver);
                let caller_domain = activation.caller_domain();
                let subclass_object = bm.bound_superclass;
                let mut activation = Activation::from_builtin(
                    activation.context.reborrow(),
                    receiver,
                    subclass_object,
                    bm.scope,
                    caller_domain,
                )?;

                if arguments.len() > bm.method.signature.len() && !bm.method.is_variadic {
                    return Err(format!(
                        "Attempted to call {:?} with {} arguments (more than {} is prohibited)",
                        bm.method.name,
                        arguments.len(),
                        bm.method.signature.len()
                    )
                    .into());
                }

                let arguments = activation.resolve_parameters(
                    &bm.method.name,
                    arguments,
                    &bm.method.signature,
                )?;
                activation
                    .context
                    .avm2
                    .push_call(activation.context.gc_context, self.clone());
                method(&mut activation, receiver, &arguments)
            }
            Executable::Action(bm) => {
                if bm.method.is_unchecked() {
                    let max_args = bm.method.signature().len();
                    if arguments.len() > max_args && !bm.method.is_variadic() {
                        arguments = &arguments[..max_args];
                    }
                }

                let receiver = bm.receiver.or(unbound_receiver);
                let subclass_object = bm.bound_superclass;

                let mut activation = Activation::from_method(
                    activation.context.reborrow(),
                    bm.method,
                    bm.scope,
                    receiver,
                    arguments,
                    subclass_object,
                    callee,
                )?;
                activation
                    .context
                    .avm2
                    .push_call(activation.context.gc_context, self.clone());
                activation.run_actions(bm.method)
            }
        };
        activation
            .context
            .avm2
            .pop_call(activation.context.gc_context);
        ret
    }

    pub fn bound_superclass(&self) -> Option<ClassObject<'gc>> {
        match self {
            Executable::Native(NativeExecutable {
                bound_superclass, ..
            }) => *bound_superclass,
            Executable::Action(BytecodeExecutable {
                bound_superclass, ..
            }) => *bound_superclass,
        }
    }

    pub fn write_full_name(&self, output: &mut WString) {
        let class_def = self.bound_superclass().map(|superclass| {
            let class_def = superclass.inner_class_definition();
            let name = class_def.read().name().to_qualified_name_no_mc();
            output.push_str(&name);
            class_def
        });
        match self {
            Executable::Native(NativeExecutable { method, .. }) => {
                output.push_char('/');
                output.push_utf8(&method.name)
            }
            Executable::Action(BytecodeExecutable { method, .. }) => {
                // NOTE: The name of a bytecode method refers to the name of the trait that contains the method,
                // rather than the name of the method itself.
                if let Some(class_def) = class_def {
                    if class_def
                        .read()
                        .class_init()
                        .into_bytecode()
                        .map(|b| Gc::ptr_eq(b, *method))
                        .unwrap_or(false)
                    {
                        output.push_utf8("$cinit");
                    } else if !class_def
                        .read()
                        .instance_init()
                        .into_bytecode()
                        .map(|b| Gc::ptr_eq(b, *method))
                        .unwrap_or(false)
                    {
                        // TODO: Ideally, the declaring trait of this executable should already be attached here, that way
                        // we can avoid needing to lookup the trait like this.
                        let class_def = class_def.read();
                        let mut method_trait = None;
                        // First search instance traits for the method
                        for t in class_def.instance_traits() {
                            if let Some(b) = t.as_method().and_then(|m| m.into_bytecode().ok()) {
                                if Gc::ptr_eq(b, *method) {
                                    method_trait = Some(t);
                                    break;
                                }
                            }
                        }
                        if method_trait.is_none() {
                            // If we can't find it in instance traits, search class traits instead
                            for t in class_def.class_traits() {
                                if let Some(b) = t.as_method().and_then(|m| m.into_bytecode().ok())
                                {
                                    if Gc::ptr_eq(b, *method) {
                                        // Class traits always start with $
                                        output.push_char('$');
                                        method_trait = Some(t);
                                        break;
                                    }
                                }
                            }
                        }
                        if let Some(method_trait) = method_trait {
                            output.push_char('/');
                            match method_trait.kind() {
                                TraitKind::Setter { .. } => output.push_utf8("set "),
                                TraitKind::Getter { .. } => output.push_utf8("get "),
                                _ => (),
                            }
                            if method_trait.name().namespace().is_namespace() {
                                output.push_str(&method_trait.name().to_qualified_name_no_mc());
                            } else {
                                output.push_str(&method_trait.name().local_name());
                            }
                        }
                        // TODO: What happens if we can't find the trait?
                    }
                    // We purposely do nothing for instance initializers
                } else if method.is_function && !method.method_name().is_empty() {
                    output.push_utf8("Function/");
                    output.push_utf8(method.method_name());
                } else {
                    output.push_utf8("MethodInfo-");
                    output.push_utf8(&method.abc_method.to_string());
                }
            }
        }
        output.push_utf8("()");
    }
}

impl<'gc> fmt::Debug for Executable<'gc> {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Action(be) => fmt
                .debug_struct("Executable::Action")
                .field("method", &be.method)
                .field("scope", &be.scope)
                .field("receiver", &be.receiver)
                .finish(),
            Self::Native(bm) => fmt
                .debug_struct("Executable::Native")
                .field("method", &bm.method)
                .field("bound_receiver", &bm.bound_receiver)
                .finish(),
        }
    }
}