ncsfile.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_NWSCRIPT_NCSFILE_H
#define AURORA_NWSCRIPT_NCSFILE_H

#include <vector>
#include <stack>

#include "src/common/types.h"
#include "src/common/scopedptr.h"

#include "src/aurora/types.h"
#include "src/aurora/aurorafile.h"

#include "src/aurora/nwscript/types.h"
#include "src/aurora/nwscript/variable.h"
#include "src/aurora/nwscript/variablecontainer.h"
#include "src/aurora/nwscript/objectref.h"

namespace Common {
    class UString;
    class SeekableReadStream;
}

namespace Aurora {

namespace NWScript {

class NCSStack : public std::vector<Variable> {
public:
    NCSStack();
    ~NCSStack();

    void reset();

    bool empty() const;

    Variable &top();
    Variable pop();
    void push(const Variable &obj);

    Variable &getRelSP(int32 pos);
    void setRelSP(int32 pos, const Variable &obj);

    Variable &getRelBP(int32 pos);
    void setRelBP(int32 pos, const Variable &obj);

    int32 getStackPtr();
    void  setStackPtr(int32 pos);

    int32 getBasePtr();
    void  setBasePtr(int32 pos);

    void print() const;

private:
    int32 _stackPtr;
    int32 _basePtr;
};

#define DECLARE_OPCODE(x) void x(InstructionType type)

class NCSFile : public AuroraFile {
public:
    NCSFile(Common::SeekableReadStream *ncs);
    NCSFile(const Common::UString &ncs);
    ~NCSFile();

    const Common::UString &getName() const;

    VariableContainer &getEnvironment();
    void setEnvironment(const VariableContainer &env);

    const Variable &run(Object *owner = 0, Object *triggerer = 0);
    const Variable &run(const ObjectReference owner = ObjectReference(),
                        const ObjectReference triggerer = ObjectReference());

    const Variable &run(const ScriptState &state, Object *owner = 0, Object *triggerer = 0);
    const Variable &run(const ScriptState &state,
                        const ObjectReference owner = ObjectReference(),
                        const ObjectReference triggerer = ObjectReference());

    static ScriptState getEmptyState();

private:
    enum InstructionType {
        // Unary
        kInstTypeNone        =  0,
        kInstTypeDirect      =  1,
        kInstTypeInt         =  3,
        kInstTypeFloat       =  4,
        kInstTypeString      =  5,
        kInstTypeObject      =  6,
        kInstTypeResource    = 96,
        kInstTypeEngineType0 = 16, // NWN:     effect        DA: event
        kInstTypeEngineType1 = 17, // NWN:     event         DA: location
        kInstTypeEngineType2 = 18, // NWN:     location      DA: command
        kInstTypeEngineType3 = 19, // NWN:     talent        DA: effect
        kInstTypeEngineType4 = 20, // NWN:     itemproperty  DA: itemproperty
        kInstTypeEngineType5 = 21, // Witcher: mod           DA: player

        // Arrays
        kInstTypeIntArray          = 64,
        kInstTypeFloatArray        = 65,
        kInstTypeStringArray       = 66,
        kInstTypeObjectArray       = 67,
        kInstTypeResourceArray     = 68,
        kInstTypeEngineType0Array  = 80,
        kInstTypeEngineType1Array  = 81,
        kInstTypeEngineType2Array  = 82,
        kInstTypeEngineType3Array  = 83,
        kInstTypeEngineType4Array  = 84,
        kInstTypeEngineType5Array  = 85,

        // Binary
        kInstTypeIntInt                 = 32,
        kInstTypeFloatFloat             = 33,
        kInstTypeObjectObject           = 34,
        kInstTypeStringString           = 35,
        kInstTypeStructStruct           = 36,
        kInstTypeIntFloat               = 37,
        kInstTypeFloatInt               = 38,
        kInstTypeEngineType0EngineType0 = 48,
        kInstTypeEngineType1EngineType1 = 49,
        kInstTypeEngineType2EngineType2 = 50,
        kInstTypeEngineType3EngineType3 = 51,
        kInstTypeEngineType4EngineType4 = 52,
        kInstTypeEngineType5EngineType5 = 53,
        kInstTypeVectorVector           = 58,
        kInstTypeVectorFloat            = 59,
        kInstTypeFloatVector            = 60
    };

    Common::UString _name;

    NCSStack _stack;
    Common::ScopedPtr<Common::SeekableReadStream> _script;

    Variable _return;

    ObjectReference _owner;
    ObjectReference _triggerer;

    VariableContainer _env;

    std::stack<uint32> _returnOffsets;

    Variable _storedState;

    typedef void (NCSFile::*OpcodeProc)(InstructionType type);
    struct Opcode {
        OpcodeProc proc;
        const char *desc;
    };
    const Opcode *_opcodes;
    size_t _opcodeListSize;
    void setupOpcodes();

    void load();

    void reset();

    const Variable &execute(const ObjectReference owner = ObjectReference(),
                            const ObjectReference triggerer = ObjectReference());

    bool executeStep();

    void decompile(); // TODO

    void callEngine(Aurora::NWScript::FunctionContext &ctx, uint32 function, uint8 argCount);

    // Opcode declarations
    DECLARE_OPCODE(o_nop);
    DECLARE_OPCODE(o_cpdownsp);
    DECLARE_OPCODE(o_rsadd);
    DECLARE_OPCODE(o_cptopsp);
    DECLARE_OPCODE(o_const);
    DECLARE_OPCODE(o_action);
    DECLARE_OPCODE(o_logand);
    DECLARE_OPCODE(o_logor);
    DECLARE_OPCODE(o_incor);
    DECLARE_OPCODE(o_excor);
    DECLARE_OPCODE(o_booland);
    DECLARE_OPCODE(o_eq);
    DECLARE_OPCODE(o_neq);
    DECLARE_OPCODE(o_geq);
    DECLARE_OPCODE(o_gt);
    DECLARE_OPCODE(o_lt);
    DECLARE_OPCODE(o_leq);
    DECLARE_OPCODE(o_shleft);
    DECLARE_OPCODE(o_shright);
    DECLARE_OPCODE(o_ushright);
    DECLARE_OPCODE(o_add);
    DECLARE_OPCODE(o_sub);
    DECLARE_OPCODE(o_mul);
    DECLARE_OPCODE(o_div);
    DECLARE_OPCODE(o_mod);
    DECLARE_OPCODE(o_neg);
    DECLARE_OPCODE(o_comp);
    DECLARE_OPCODE(o_movsp);
    DECLARE_OPCODE(o_storestateall);
    DECLARE_OPCODE(o_jmp);
    DECLARE_OPCODE(o_jsr);
    DECLARE_OPCODE(o_jz);
    DECLARE_OPCODE(o_retn);
    DECLARE_OPCODE(o_destruct);
    DECLARE_OPCODE(o_not);
    DECLARE_OPCODE(o_decsp);
    DECLARE_OPCODE(o_incsp);
    DECLARE_OPCODE(o_jnz);
    DECLARE_OPCODE(o_cpdownbp);
    DECLARE_OPCODE(o_cptopbp);
    DECLARE_OPCODE(o_decbp);
    DECLARE_OPCODE(o_incbp);
    DECLARE_OPCODE(o_savebp);
    DECLARE_OPCODE(o_restorebp);
    DECLARE_OPCODE(o_storestate);
    DECLARE_OPCODE(o_writearray);
    DECLARE_OPCODE(o_readarray);
    DECLARE_OPCODE(o_getref);
    DECLARE_OPCODE(o_getrefarray);
};

#undef DECLARE_OPCODE

} // End of namespace NWScript

} // End of namespace Aurora

#endif // AURORA_NWSCRIPT_NCSFILE_H