Global_as.h

Go to the documentation of this file.

// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   Free Software Foundation, Inc
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//

#ifndef GNASH_GLOBAL_H
#define GNASH_GLOBAL_H

#include <string>
#include <memory>

#include "as_object.h" 
#include "fn_call.h"
#include "log.h"
#include "ClassHierarchy.h"
#include "dsodefs.h" // for DSOTEXPORT

// Forward declarations
namespace gnash {
    class as_value;
    class VM;
    class Extension;
}

namespace gnash {

//
//
class Global_as : public as_object
{
public:

    typedef as_value(*ASFunction)(const fn_call& fn);
    typedef void(*Properties)(as_object&);

        explicit Global_as(VM& vm);
        virtual ~Global_as();
    
    void registerClasses();

    as_object* createArray();

    VM& getVM() const {
        return vm();
    }
    
    as_function* createFunction(Global_as::ASFunction function);

    //
    as_object* createClass(Global_as::ASFunction ctor,
            as_object* prototype);

    void makeObject(as_object& o) const;

protected:
    
    virtual void markReachableResources() const;

private:

    void loadExtensions();
    std::unique_ptr<Extension> _et;

    ClassHierarchy _classes;
    
    as_object* _objectProto;

};

DSOTEXPORT as_object* createObject(const Global_as& gl);
    

//
//
//
//
inline as_object*
registerBuiltinObject(as_object& where, Global_as::Properties p,
        const ObjectURI& uri)
{
    Global_as& gl = getGlobal(where);
    as_object* obj = createObject(gl);
    if (p) p(*obj);
    
    where.init_member(uri, obj, as_object::DefaultFlags);

    return obj;
}

//
//
//
inline as_object*
registerBuiltinClass(as_object& where, Global_as::ASFunction ctor,
        Global_as::Properties p, Global_as::Properties c, const ObjectURI& uri)
{
    Global_as& gl = getGlobal(where);
    as_object* proto = createObject(gl);
    as_object* cl = gl.createClass(ctor, proto);
 
    // Attach class properties to class
    if (c) c(*cl);

    // Attach prototype properties to prototype
    if (p) p(*proto);

    // Register class with specified object.
    where.init_member(uri, cl, as_object::DefaultFlags);
    return cl;
}

//
inline DSOEXPORT as_value
invoke(const as_value& method, const as_environment& env, as_object* this_ptr,
        fn_call::Args& args, as_object* super = nullptr,
        const movie_definition* callerDef = nullptr)
{

        as_value val;
        fn_call call(this_ptr, env, args);
        call.super = super;
    call.callerDef = callerDef;

        try {
                if (as_object* func = toObject(method, getVM(env))) {
            // Call function.
                    val = func->call(call);
                }
                else {
            IF_VERBOSE_ASCODING_ERRORS(
                log_aserror("Attempt to call a value which is not "
                    "a function (%s)", method);
            );
            return val;
                }
        }
        catch (ActionTypeError& e) {
                assert(val.is_undefined());
                IF_VERBOSE_ASCODING_ERRORS(
            log_aserror("%s", e.what());
                );
        }
        return val;
}

//
//
//
//

inline as_value
callMethod(fn_call::Args& args, as_object* obj, const ObjectURI& uri)
{
    if (!obj) return as_value();
    as_value func;
    if (!obj->get_member(uri, &func)) return as_value();

    return invoke(func, as_environment(getVM(*obj)), obj, args);
}

template <typename Param, typename... Params>
inline as_value
callMethod(fn_call::Args& args, as_object* obj, const ObjectURI& uri, Param param, Params... params)
{
    args += param;
    return callMethod(args, obj, uri, params...);
}


template <typename... Params>
inline as_value
callMethod(as_object* obj, const ObjectURI& uri, Params... params)
{
    fn_call::Args args;
    return callMethod(args, obj, uri, params...);
}

//
inline as_function*
getClassConstructor(const fn_call& fn, const std::string& s)
{
    const as_value ctor(findObject(fn.env(), s));
    return ctor.to_function();
}

inline as_value
emptyFunction(const fn_call&)
{
    return as_value();
}

} // namespace gnash

#endif