Instruction.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears 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.
 */
 
#pragma once
 
#include <string>
#include <vector>
#include <boost/format.hpp>
#include <boost/intrusive_ptr.hpp>
#include "installer/decompiler/RefCounted.h"
#include "installer/decompiler/Value.h"
#include "installer/common/scummsys.h"
#include "installer/decompiler/DecompilerException.h"
 
class CodeGenerator;
 
class Engine;
 
void SetOutputStackEffect(bool value);
 
class Instruction;
 
typedef boost::intrusive_ptr<Instruction> InstPtr;
 
class Function;
 
class Instruction : public RefCounted {
 
    public:
 
        static int INST_TYPE_BINARY_OP;
 
        static int INST_TYPE_BOOL_NEGATE;
 
        static int INST_TYPE_CALL;
 
        static int INST_TYPE_COND_JUMP;
 
        static int INST_TYPE_DUP;
 
        static int INST_TYPE_JUMP;
 
        static int INST_TYPE_KERNEL_CALL;
 
        static int INST_TYPE_LOAD;
 
        static int INST_TYPE_RETURN;
 
        static int INST_TYPE_STACK;
 
        static int INST_TYPE_STORE;
 
        static int INST_TYPE_UNARY_OP_PRE;
 
        static int INST_TYPE_UNARY_OP_POST;
 
        friend std::ostream& operator<<(std::ostream &output, const Instruction *inst) {
            return inst->Print(output);
        }
 
        virtual std::ostream& Print(std::ostream &output) const;
 
        virtual bool IsJump() const;
 
        virtual bool IsCondJump() const;
 
        virtual bool IsUncondJump() const;
 
        virtual bool IsStackOp() const;
 
        virtual bool IsFuncCall() const;
 
        virtual bool IsReturn() const;
 
        virtual bool IsKernelCall() const;
 
        virtual bool IsLoad() const;
 
        virtual bool IsStore() const;
 
        virtual uint32 GetDestAddress() const;
 
        virtual void ProcessInst(
          Function& function, ValueStack& stack, Engine* engine, CodeGenerator* code_gen
        ) = 0;
 
        uint32 GetOpcode() const;
 
        void SetOpcode(uint32 opcode);
 
        uint32 GetAddress() const;
 
        void SetAddress(uint32 address);
 
        std::string GetName() const;
 
        void SetName(std::string name);
 
        int16 GetStackChange() const;
 
        void SetStackChange(int16 stack_change);
 
        std::vector<ValuePtr> GetParams() const;
 
        ValuePtr GetParam(uint32 index) const;
 
        void SetParams(std::vector<ValuePtr> params);
 
        void AddParam(ValuePtr value);
 
        std::string GetCodeGenData() const;
 
        void SetCodeGenData(std::string code_gen_data);
 
        bool LabelRequired() const;
 
        void SetLabelRequired(bool required);
 
    protected:
 
        uint32 opcode_;
 
        uint32 address_;
 
        std::string name_;
 
        int16 stack_change_;
 
        std::vector<ValuePtr> params_;
 
        std::string code_gen_data_;
 
        bool label_required_ = false;
};
 
typedef std::vector<InstPtr> InstVec;
 
typedef InstVec::iterator InstIterator;
 
typedef InstVec::const_iterator ConstInstIterator;