// Copyright (c) 2012- PPSSPP Project.

// 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, version 2.0 or later versions.

// 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 2.0 for more details.

// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/

// Official git repository and contact information can be found at
// https://github.com/hrydgard/ppsspp and http://www.ppsspp.org/.

#pragma once
#include <string>
#include <cstdio>

#include "Common/CommonTypes.h"
#include "Common/Math/expression_parser.h"

struct MemMap;

class DebugInterface {
public:
	virtual int getInstructionSize(int instruction) = 0;

	virtual bool isAlive() = 0;
	virtual bool isBreakpoint(unsigned int address) = 0;
	virtual void setBreakpoint(unsigned int address) = 0;
	virtual void clearBreakpoint(unsigned int address) = 0;
	virtual void clearAllBreakpoints() = 0;
	virtual void toggleBreakpoint(unsigned int address) = 0;
	virtual unsigned int readMemory(unsigned int address) {return 0;}
	virtual unsigned int getPC() = 0;
	virtual void setPC(unsigned int address) {}
	virtual void step() {}
	virtual void runToBreakpoint() {}
	virtual int getColor(unsigned int address, bool darkMode) const {return darkMode ? 0xFF101010 : 0xFFFFFFFF;}
	virtual std::string getDescription(unsigned int address) {return "";}
	virtual bool initExpression(const char* exp, PostfixExpression& dest) { return false; };
	virtual bool parseExpression(PostfixExpression& exp, u32& dest) { return false; };

	virtual u32 GetHi() = 0;
	virtual u32 GetLo() = 0;
	virtual u32 GetLLBit() = 0;
	virtual u32 GetFPCond() = 0;

	virtual void SetHi(u32 val) { };
	virtual void SetLo(u32 val) { };
	virtual const char *GetName() = 0;
	virtual u32 GetGPR32Value(int reg) = 0;
	virtual void SetGPR32Value(int reg, u32 value) = 0;
	virtual float GetFPR32Value(int reg) { return -1.0f; }
	virtual float GetVPR32Value(int reg) { return -1.0f; }

	virtual u32 GetPC() = 0;
	virtual void SetPC(u32 _pc) = 0;
	virtual u32 GetLR() = 0;

	virtual void DisAsm(u32 pc, char *out, size_t outSize) = 0;

	// More stuff for debugger
	virtual int GetNumCategories() = 0;
	virtual int GetNumRegsInCategory(int cat) = 0;
	virtual const char *GetCategoryName(int cat) = 0;
	virtual std::string GetRegName(int cat, int index) = 0;
	virtual void PrintRegValue(int cat, int index, char *out, size_t outSize) {
		snprintf(out, outSize, "%08X", GetGPR32Value(index));
	}
	virtual u32 GetRegValue(int cat, int index) = 0;
	virtual void SetRegValue(int cat, int index, u32 value) {}
};