lsnes/include/core/project.hpp

#ifndef _project__hpp__included__
#define _project__hpp__included__

#include <string>
#include <map>
#include <list>
#include <vector>
#include "library/json.hpp"
#include "core/controller.hpp"
#include "core/rom.hpp"

//A branch.
struct project_branch_info
{
	//Parent branch ID.
	uint64_t pbid;
	//Name.
	std::string name;
};

//Information about project.
struct project_info
{
	//Internal ID of the project.
	std::string id;
	//Name of the project.
	std::string name;
	//Bundle ROM used.
	std::string rom;
	//ROMs used.
	std::string roms[ROM_SLOT_COUNT];
	//Last savestate.
	std::string last_save;
	//Directory for save/load dialogs.
	std::string directory;
	//Prefix for save/load dialogs.
	std::string prefix;
	//List of Lua scripts to run at startup.
	std::list<std::string> luascripts;
	//Memory watches.
	std::map<std::string, std::string> watches;
	//Macros.
	std::map<std::string, JSON::node> macros;
	//Branches.
	std::map<uint64_t, project_branch_info> branches;
	uint64_t active_branch;
	uint64_t next_branch;
	//Stub movie data.
	std::string gametype;
	std::map<std::string, std::string> settings;
	std::string coreversion;
	std::string gamename;
	std::string projectid;
	std::string romimg_sha256[ROM_SLOT_COUNT];
	std::string romxml_sha256[ROM_SLOT_COUNT];
	std::string namehint[ROM_SLOT_COUNT];
	std::vector<std::pair<std::string, std::string>> authors;
	std::map<std::string, std::vector<char>> movie_sram;
	std::vector<char> anchor_savestate;
	int64_t movie_rtc_second;
	int64_t movie_rtc_subsecond;
/**
 * Obtain parent of branch.
 *
 * Parameter bid: The branch ID.
 * Returns: The parent branch ID.
 * Throws std::runtime_error: Invalid branch ID.
 *
 * Note: bid 0 is root. Calling this on root always gives 0.
 */
	uint64_t get_parent_branch(uint64_t bid);
/**
 * Get current branch id.
 *
 * Returns: The branch id.
 */
	uint64_t get_current_branch() { return active_branch; }
/**
 * Set current branch.
 *
 * Parameter bid: The branch id.
 * Throws std::runtime_error: Invalid branch ID.
 */
	void set_current_branch(uint64_t bid);
/**
 * Get name of branch.
 *
 * Parameter bid: The branch id.
 * Throws std::runtime_error: Invalid branch ID.
 * Note: The name of ROOT branch is always empty string.
 */
	const std::string& get_branch_name(uint64_t bid);
/**
 * Set name of branch.
 *
 * Parameter bid: The branch id.
 * Parameter name: The new name
 * Throws std::runtime_error: Invalid branch ID.
 * Note: The name of ROOT branch can't be changed.
 */
	void set_branch_name(uint64_t bid, const std::string& name);
/**
 * Set parent branch of branch.
 *
 * Parameter bid: The branch id.
 * Parameter pbid: The new parent branch id.
 * Throws std::runtime_error: Invalid branch ID, or cyclic dependency.
 * Note: The parent of ROOT branch can't be set.
 */
	void set_parent_branch(uint64_t bid, uint64_t pbid);
/**
 * Enumerate child branches of specified branch.
 *
 * Parameter bid: The branch id.
 * Returns: The set of chilid branch IDs.
 * Throws std::runtime_error: Invalid branch ID.
 */
	std::set<uint64_t> branch_children(uint64_t bid);
/**
 * Create a new branch.
 *
 * Parameter pbid: Parent of the new branch.
 * Parameter name: Name of new branch.
 * Returns: Id of new branch.
 * Throws std::runtime_error: Invalid branch ID.
 */
	uint64_t create_branch(uint64_t pbid, const std::string& name);
/**
 * Delete a branch.
 *
 * Parameter bid: The branch id.
 * Throws std::runtime_error: Invalid branch ID or branch has children.
 */
	void delete_branch(uint64_t bid);
/**
 * Get name of current branch as string.
 */
	std::string get_branch_string();
/**
 * Flush the project to disk.
 */
	void flush();
private:
	void write(std::ostream& s);
};

/**
 * Get currently active project.
 *
 * Returns: The currently active project or NULL if none.
 */
project_info* project_get();
/**
 * Change currently active project. This reloads Lua VM, ROM and savestate.
 *
 * Parameter p: The new currently active project, or NULL to switch out of any project.
 * Parameter current: If true, do not reload ROM, movie nor state.
 */
bool project_set(project_info* p, bool current = false);
/**
 * Enumerate all known projects.
 *
 * Returns: Map from IDs of projects to project names.
 */
std::map<std::string, std::string> project_enumerate();
/**
 * Load a given project.
 *
 * Parameter id: The ID of project to load.
 * Returns: The project information.
 */
project_info& project_load(const std::string& id);
/**
 * Get project movie path.
 *
 * Returns: The movie path.
 */
std::string project_moviepath();
/**
 * Get project other path.
 *
 * Returns: The other path.
 */
std::string project_otherpath();
/**
 * Get project savestate extension.
 *
 * Returns: The savestate extension.
 */
std::string project_savestate_ext();
/**
 * Copy watches to project
 */
void project_copy_watches(project_info& p);
/**
 * Copy macros to project.
 */
void project_copy_macros(project_info& p, controller_state& s);

#endif