lsnes/include/core/memorywatch.hpp

#ifndef _memorywatch__hpp__included__
#define _memorywatch__hpp__included__

#include <string>
#include <stdexcept>
#include <set>
#include "library/memorywatch.hpp"
#include "library/json.hpp"

class memory_space;
class project_state;
class emu_framebuffer;
namespace framebuffer { class queue; }

/**
 * lsnes memory watch printer variables.
 */
struct memwatch_printer
{
/**
 * Ctor.
 */
	memwatch_printer();
/**
 * Serialize the printer to JSON value.
 */
	JSON::node serialize();
/**
 * Unserialize the printer from JSON value.
 */
	void unserialize(const JSON::node& node);
/**
 * Get a printer object corresponding to this object.
 */
	gcroot_pointer<memorywatch::item_printer> get_printer_obj(
		std::function<gcroot_pointer<mathexpr::mathexpr>(const std::string& n)> vars);
	//Fields.
	enum position_category {
		PC_DISABLED,
		PC_MEMORYWATCH,
		PC_ONSCREEN
	} position;
	bool cond_enable;			//Ignored for disabled.
	std::string enabled;			//Ignored for disabled.
	std::string onscreen_xpos;
	std::string onscreen_ypos;
	bool onscreen_alt_origin_x;
	bool onscreen_alt_origin_y;
	bool onscreen_cliprange_x;
	bool onscreen_cliprange_y;
	std::string onscreen_font;		//"" is system default.
	int64_t onscreen_fg_color;
	int64_t onscreen_bg_color;
	int64_t onscreen_halo_color;
};

/**
 * lsnes memory watch item.
 */
struct memwatch_item
{
/**
 * Ctor.
 */
	memwatch_item(memory_space& memory);
/**
 * Serialize the item to JSON value.
 */
	JSON::node serialize();
/**
 * Unserialize the item from JSON value.
 */
	void unserialize(const JSON::node& node);
/**
 * Get memory read operator.
 *
 * If bytes == 0, returns NULL.
 */
	memorywatch::memread_oper* get_memread_oper();
/**
 * Translate compatiblity item.
 */
	void compatiblity_unserialize(memory_space& memory, const std::string& item);
	//Fields
	memwatch_printer printer;	//The printer.
	std::string expr;			//The main expression.
	std::string format;			//Format.
	unsigned bytes;				//Number of bytes to read (0 => Not memory read operator).
	bool signed_flag;			//Is signed?
	bool float_flag;			//Is float?
	int endianess;				//Endianess (-1 => little, 0 => host, 1 => Big).
	uint64_t scale_div;			//Scale divisor.
	uint64_t addr_base;			//Address base.
	uint64_t addr_size;			//Address size (0 => All).
	memory_space* mspace;			//Memory space to read.
};

struct memwatch_set
{
	memwatch_set(memory_space& _memory, project_state& _project, emu_framebuffer& _fbuf);
/**
 * Get the specified memory watch item.
 */
	memwatch_item& get(const std::string& name);
/**
 * Get the specified memory watch item as JSON serialization.
 *
 * Parameter name: The item name.
 * Parameter printer: JSON pretty-printer to use.
 */
	std::string get_string(const std::string& name, JSON::printer* printer = NULL);
/**
 * Set the specified memory watch item. Fills the runtime variables.
 *
 * Parameter name: The name of the new item.
 * Parameter item: The item to insert. Fields are shallow-copied.
 */
	void set(const std::string& name, memwatch_item& item);
/**
 * Set the specified memory watch item from JSON serialization. Fills the runtime variables.
 *
 * Parameter name: The name of the new item.
 * Parameter item: The serialization of item to insert.
 */
	void set(const std::string& name, const std::string& item);
/**
 * Set multiple items at once.
 *
 * Parameter list: The list of items.
 */
	void set_multi(std::list<std::pair<std::string, memwatch_item>>& list);
/**
 * Set multiple items at once from JSON descriptions.
 *
 * Parameter list: The list of items.
 */
	void set_multi(std::list<std::pair<std::string, std::string>>& list);
/**
 * Rename a memory watch item.
 *
 * Parameter oname: The old name.
 * Parameter newname: The new name.
 * Returns: True on success, false if failed (new item already exists).
 */
	bool rename(const std::string& oname, const std::string& newname);
/**
 * Delete an item.
 *
 * Parameter name: The name of the item to delete.
 */
	void clear(const std::string& name);
/**
 * Delete multiple items.
 *
 * Parameter names: The names of the items to delete.
 */
	void clear_multi(const std::set<std::string>& name);
/**
 * Enumerate item names.
 */
	std::set<std::string> enumerate();
/**
 * Get value of specified memory watch as a string.
 */
	std::string get_value(const std::string& name);
/**
 * Watch all the items.
 *
 * Parameter rq: The render queue to use.
 */
	void watch(struct framebuffer::queue& rq);
/**
 * Get memory watch vars that go to window.
 */
	const std::map<std::string, std::u32string>& get_window_vars() { return window_vars; }
private:
	void rebuild(std::map<std::string, memwatch_item>& nitems);
	std::map<std::string, memwatch_item> items;
	std::map<std::string, std::u32string> window_vars;
	std::map<std::string, bool> used_memorywatches;
	void erase_unused_watches();
	void watch_output(const std::string& name, const std::string& value);
	memorywatch::set watch_set;
	memory_space& memory;
	project_state& project;
	emu_framebuffer& fbuf;
};

#endif