RetroArch/retroarch.h
2015-06-02 18:28:51 +02:00

183 lines
4.7 KiB
C

/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
* Copyright (C) 2011-2015 - Daniel De Matteis
*
* RetroArch 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 Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* RetroArch 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 RetroArch.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __RETROARCH_H
#define __RETROARCH_H
#include <boolean.h>
#include <retro_miscellaneous.h>
#include "core_info.h"
#include "command_event.h"
#ifdef __cplusplus
extern "C" {
#endif
enum action_state
{
RARCH_ACTION_STATE_NONE = 0,
RARCH_ACTION_STATE_LOAD_CONTENT,
RARCH_ACTION_STATE_MENU_RUNNING,
RARCH_ACTION_STATE_MENU_RUNNING_FINISHED,
RARCH_ACTION_STATE_QUIT,
RARCH_ACTION_STATE_FORCE_QUIT,
};
enum rarch_capabilities
{
RARCH_CAPABILITIES_NONE = 0,
RARCH_CAPABILITIES_CPU,
RARCH_CAPABILITIES_COMPILER,
};
struct rarch_main_wrap
{
const char *content_path;
const char *sram_path;
const char *state_path;
const char *config_path;
const char *libretro_path;
bool verbose;
bool no_content;
bool touched;
};
void rarch_main_alloc(void);
void rarch_main_new(void);
void rarch_main_free(void);
void rarch_main_set_state(unsigned action);
/**
* rarch_main_init:
* @argc : Count of (commandline) arguments.
* @argv : (Commandline) arguments.
*
* Initializes RetroArch.
*
* Returns: 0 on success, otherwise 1 if there was an error.
**/
int rarch_main_init(int argc, char *argv[]);
/**
* rarch_main_init_wrap:
* @args : Input arguments.
* @argc : Count of arguments.
* @argv : Arguments.
*
* Generates an @argc and @argv pair based on @args
* of type rarch_main_wrap.
**/
void rarch_main_init_wrap(const struct rarch_main_wrap *args,
int *argc, char **argv);
/**
* rarch_main_deinit:
*
* Deinitializes RetroArch.
**/
void rarch_main_deinit(void);
/**
* rarch_replace_config:
* @path : Path to config file to replace
* current config file with.
*
* Replaces currently loaded configuration file with
* another one. Will load a dummy core to flush state
* properly.
*
* Quite intrusive and error prone.
* Likely to have lots of small bugs.
* Cleanly exit the main loop to ensure that all the tiny details
* get set properly.
*
* This should mitigate most of the smaller bugs.
*
* Returns: true (1) if successful, false (0) if @path was the
* same as the current config file.
**/
bool rarch_replace_config(const char *path);
/**
* rarch_playlist_load_content:
* @playlist : Playlist handle.
* @idx : Index in playlist.
*
* Initializes core and loads content based on playlist entry.
**/
void rarch_playlist_load_content(void *data, unsigned index);
/**
* rarch_defer_core:
* @core_info : Core info list handle.
* @dir : Directory. Gets joined with @path.
* @path : Path. Gets joined with @dir.
* @menu_label : Label identifier of menu setting.
* @s : Deferred core path. Will be filled in
* by function.
* @len : Size of @s.
*
* Gets deferred core.
*
* Returns: 0 if there are multiple deferred cores and a
* selection needs to be made from a list, otherwise
* returns -1 and fills in @s with path to core.
**/
int rarch_defer_core(core_info_list_t *data,
const char *dir, const char *path, const char *menu_label,
char *s, size_t len);
void rarch_fill_pathnames(void);
/*
* rarch_verify_api_version:
*
* Compare libretro core API version against API version
* used by RetroArch.
*
* TODO - when libretro v2 gets added, allow for switching
* between libretro version backend dynamically.
**/
void rarch_verify_api_version(void);
/**
* rarch_init_system_av_info:
*
* Initialize system A/V information by calling the libretro core's
* get_system_av_info function.
**/
void rarch_init_system_av_info(void);
void rarch_set_paths(const char *path);
void set_paths_redirect(const char *path);
int rarch_info_get_capabilities(enum rarch_capabilities type, char *s, size_t len);
char orig_savestate_dir[PATH_MAX_LENGTH];
char orig_savefile_dir[PATH_MAX_LENGTH];
#ifdef __cplusplus
}
#endif
#endif