Function.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_SWF_FUNCTION_H
#define GNASH_SWF_FUNCTION_H

#include <vector>
#include <cassert>
#include <string>

#include "ConstantPool.h"
#include "UserFunction.h"
#include "ObjectURI.h"

// Forward declarations
namespace gnash {
    class action_buffer;
    class as_object;
    class VM;
}

namespace gnash {

class TargetGuard
{
public:

        // @param ch : target to set temporarely
        // @param och : original target to set temporarily
        TargetGuard(as_environment& e, DisplayObject* ch, DisplayObject* och);
        ~TargetGuard();

private:

    as_environment& env;
    DisplayObject* from;
    DisplayObject* from_orig;

};

//
//
class Function : public UserFunction
{

public:

        typedef std::vector<as_object*> ScopeStack;

        //
        Function(const action_buffer& ab, as_environment& env, size_t start,
                ScopeStack with_stack);

        virtual ~Function() {}

        const ScopeStack& getScopeStack() const {
                return _scopeStack;
        }

        const action_buffer& getActionBuffer() const {
                return _action_buffer;
        }

        size_t getStartPC() const {
                return _startPC;
        }

        size_t getLength() const {
                return _length;
        }

    //
    virtual std::uint8_t registers() const {
        return 0;
    }

    //
    //
    //
        void add_arg(std::uint8_t reg, const ObjectURI& name) {
            _args.emplace_back(reg, name);
        }

        void setLength(size_t len);

        virtual as_value call(const fn_call& fn);

        //
        virtual void markReachableResources() const;

protected:
        
    struct Argument
        {
        Argument(std::uint8_t r, ObjectURI n) : reg(r), name(std::move(n)) {}
        std::uint8_t reg;
        ObjectURI name;
        };

        std::vector<Argument> _args;

        as_environment& _env;

    const ConstantPool* _pool;

private:

        const action_buffer& _action_buffer;

        ScopeStack _scopeStack;

        size_t  _startPC;

        //
        size_t _length;

};

//
as_object* getArguments(Function& callee, as_object& args, 
        const fn_call& fn, as_object* caller);


} // end of gnash namespace

#endif