RetroArch/ui/ui_companion_driver.h
gblues 6904101c44 Clean up trailing whitespace
== DETAILS

Really simple code cleanup, because my editor flags trailing whitespaces
and it's pretty annoying.
2017-12-12 00:24:18 -08:00

226 lines
6.5 KiB
C

/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
* Copyright (C) 2011-2017 - 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 __UI_COMPANION_DRIVER_H
#define __UI_COMPANION_DRIVER_H
#include <stddef.h>
#include <boolean.h>
#include <retro_common_api.h>
#include <lists/file_list.h>
#ifdef HAVE_CONFIG_H
#include "../config.h"
#endif
#include "../command.h"
RETRO_BEGIN_DECLS
enum ui_msg_window_buttons
{
UI_MSG_WINDOW_OK = 0,
UI_MSG_WINDOW_OKCANCEL,
UI_MSG_WINDOW_YESNO,
UI_MSG_WINDOW_YESNOCANCEL
};
enum ui_msg_window_response
{
UI_MSG_RESPONSE_NA = 0,
UI_MSG_RESPONSE_OK,
UI_MSG_RESPONSE_CANCEL,
UI_MSG_RESPONSE_YES,
UI_MSG_RESPONSE_NO
};
enum ui_msg_window_type
{
UI_MSG_WINDOW_TYPE_ERROR = 0,
UI_MSG_WINDOW_TYPE_INFORMATION,
UI_MSG_WINDOW_TYPE_QUESTION,
UI_MSG_WINDOW_TYPE_WARNING
};
typedef struct ui_msg_window_state
{
enum ui_msg_window_buttons buttons;
char *text;
char *title;
void *window;
} ui_msg_window_state;
typedef struct ui_browser_window_state
{
struct
{
bool can_choose_directories;
bool can_choose_directories_val;
bool can_choose_files;
bool can_choose_files_val;
bool allows_multiple_selection;
bool allows_multiple_selection_val;
bool treat_file_packages_as_directories;
bool treat_file_packages_as_directories_val;
} capabilities;
void *window;
char *filters;
char *filters_title;
char *startdir;
char *path;
char *title;
char *result;
} ui_browser_window_state_t;
typedef struct ui_browser_window
{
bool (*open)(ui_browser_window_state_t *state);
bool (*save)(ui_browser_window_state_t *state);
const char *ident;
} ui_browser_window_t;
typedef struct ui_msg_window
{
enum ui_msg_window_response (*error )(ui_msg_window_state *state);
enum ui_msg_window_response (*information)(ui_msg_window_state *state);
enum ui_msg_window_response (*question )(ui_msg_window_state *state);
enum ui_msg_window_response (*warning )(ui_msg_window_state *state);
const char *ident;
} ui_msg_window_t;
typedef struct ui_application
{
bool (*initialize)(void);
bool (*pending_events)(void);
void (*process_events)(void);
const char *ident;
} ui_application_t;
typedef struct ui_window
{
void (*destroy)(void *data);
void (*set_focused)(void *data);
void (*set_visible)(void *data, bool visible);
void (*set_title)(void *data, char *buf);
void (*set_droppable)(void *data, bool droppable);
bool (*focused)(void *data);
const char *ident;
} ui_window_t;
typedef struct ui_companion_driver
{
void *(*init)(void);
void (*deinit)(void *data);
int (*iterate)(void *data, unsigned action);
void (*toggle)(void *data);
void (*event_command)(void *data, enum event_command action);
void (*notify_content_loaded)(void *data);
void (*notify_list_loaded)(void *data, file_list_t *list, file_list_t *menu_list);
void (*notify_refresh)(void *data);
void (*msg_queue_push)(const char *msg, unsigned priority, unsigned duration, bool flush);
void (*render_messagebox)(const char *msg);
void *(*get_main_window)(void *data);
const ui_browser_window_t *browser_window;
const ui_msg_window_t *msg_window;
const ui_window_t *window;
const ui_application_t *application;
const char *ident;
} ui_companion_driver_t;
extern const ui_browser_window_t ui_browser_window_null;
extern const ui_browser_window_t ui_browser_window_cocoa;
extern const ui_browser_window_t ui_browser_window_qt;
extern const ui_browser_window_t ui_browser_window_win32;
extern const ui_window_t ui_window_null;
extern const ui_window_t ui_window_cocoa;
extern const ui_window_t ui_window_qt;
extern const ui_window_t ui_window_win32;
extern const ui_msg_window_t ui_msg_window_null;
extern const ui_msg_window_t ui_msg_window_win32;
extern const ui_msg_window_t ui_msg_window_qt;
extern const ui_msg_window_t ui_msg_window_cocoa;
extern const ui_application_t ui_application_null;
extern const ui_application_t ui_application_cocoa;
extern const ui_application_t ui_application_qt;
extern const ui_application_t ui_application_win32;
extern const ui_companion_driver_t ui_companion_null;
extern const ui_companion_driver_t ui_companion_cocoa;
extern const ui_companion_driver_t ui_companion_cocoatouch;
extern const ui_companion_driver_t ui_companion_qt;
extern const ui_companion_driver_t ui_companion_win32;
/**
* ui_companion_find_driver:
* @ident : Identifier name of driver to find.
*
* Finds driver with @ident. Does not initialize.
*
* Returns: pointer to driver if successful, otherwise NULL.
**/
const ui_companion_driver_t *ui_companion_find_driver(const char *ident);
const ui_companion_driver_t *ui_companion_get_ptr(void);
/**
* ui_companion_init_first:
*
* Finds first suitable driver and initialize.
*
* Returns: pointer to first suitable driver, otherwise NULL.
**/
const ui_companion_driver_t *ui_companion_init_first(void);
void ui_companion_driver_init_first(void);
bool ui_companion_is_on_foreground(void);
void ui_companion_set_foreground(unsigned enable);
void ui_companion_event_command(enum event_command action);
void ui_companion_driver_deinit(void);
void ui_companion_driver_notify_refresh(void);
void ui_companion_driver_notify_list_loaded(file_list_t *list, file_list_t *menu_list);
void ui_companion_driver_notify_content_loaded(void);
void ui_companion_driver_toggle(void);
void ui_companion_driver_free(void);
const ui_msg_window_t *ui_companion_driver_get_msg_window_ptr(void);
const ui_browser_window_t *ui_companion_driver_get_browser_window_ptr(void);
const ui_window_t *ui_companion_driver_get_window_ptr(void);
const ui_application_t *ui_companion_driver_get_application_ptr(void);
void *ui_companion_driver_get_main_window(void);
const char *ui_companion_driver_get_ident(void);
RETRO_END_DECLS
#endif