RetroArch/settings_list.h

/*  RetroArch - A frontend for libretro.
 *  Copyright (C) 2013-2014 - Jason Fetters
 *  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 _SETTINGS_LIST_H
#define _SETTINGS_LIST_H

#include <stdint.h>
#include <stdlib.h>
#include <boolean.h>

#ifdef __cplusplus
extern "C" {
#endif

enum setting_type
{
   ST_NONE = 0,
   ST_ACTION,
   ST_BOOL,
   ST_INT,
   ST_UINT,
   ST_FLOAT,
   ST_PATH,
   ST_DIR,
   ST_STRING,
   ST_HEX,
   ST_BIND,
   ST_GROUP,
   ST_SUB_GROUP,
   ST_END_GROUP,
   ST_END_SUB_GROUP
};

enum setting_flags
{
   SD_FLAG_PATH_DIR       = (1 << 0),
   SD_FLAG_PATH_FILE      = (1 << 1),
   SD_FLAG_ALLOW_EMPTY    = (1 << 2),
   SD_FLAG_VALUE_DESC     = (1 << 3),
   SD_FLAG_HAS_RANGE      = (1 << 4),
   SD_FLAG_ALLOW_INPUT    = (1 << 5),
   SD_FLAG_IS_DRIVER      = (1 << 6),
   SD_FLAG_EXIT           = (1 << 7),
   SD_FLAG_CMD_APPLY_AUTO = (1 << 8),
   SD_FLAG_IS_DEFERRED    = (1 << 9),
   SD_FLAG_BROWSER_ACTION = (1 << 10),
   SD_FLAG_ADVANCED       = (1 << 11)
};

enum setting_list_flags
{
   SL_FLAG_MAIN_MENU             =  (1 << 0),
   SL_FLAG_DRIVER_OPTIONS        =  (1 << 1),
   SL_FLAG_GENERAL_OPTIONS       =  (1 << 2),
   SL_FLAG_VIDEO_OPTIONS         =  (1 << 3),
   SL_FLAG_SHADER_OPTIONS        =  (1 << 4),
   SL_FLAG_FONT_OPTIONS          =  (1 << 5),
   SL_FLAG_AUDIO_OPTIONS         =  (1 << 6),
   SL_FLAG_INPUT_OPTIONS         =  (1 << 7),
   SL_FLAG_OVERLAY_OPTIONS       =  (1 << 8),
   SL_FLAG_OSK_OVERLAY_OPTIONS   =  (1 << 9),
   SL_FLAG_MENU_OPTIONS          =  (1 << 10),
   SL_FLAG_UI_OPTIONS            =  (1 << 11),
   SL_FLAG_CORE_UPDATER_OPTIONS  =  (1 << 12),
   SL_FLAG_NETPLAY_OPTIONS       =  (1 << 13),
   SL_FLAG_USER_OPTIONS          =  (1 << 14),
   SL_FLAG_PATH_OPTIONS          =  (1 << 15),
   SL_FLAG_PRIVACY_OPTIONS       =  (1 << 16),
   SL_FLAG_PLAYLIST_OPTIONS      =  (1 << 17),
   SL_FLAG_ARCHIVE_OPTIONS       =  (1 << 18),
   SL_FLAG_PATCH_OPTIONS         =  (1 << 19),
   SL_FLAG_ALL                   =  (1 << 20),
};

#define SL_FLAG_ALL_SETTINGS (SL_FLAG_ALL - SL_FLAG_MAIN_MENU)

typedef void (*change_handler_t               )(void *data);
typedef int  (*action_toggle_handler_t        )(void *data, unsigned action, bool wraparound);
typedef int  (*action_up_or_down_handler_t    )(void *data, unsigned action);
typedef int  (*action_start_handler_t         )(void *data);
typedef int  (*action_iterate_handler_t       )(unsigned action);
typedef int  (*action_cancel_handler_t        )(void *data, unsigned action);
typedef int  (*action_ok_handler_t            )(void *data, unsigned action);
typedef void (*get_string_representation_t    )(void *data, char *buf, size_t sizeof_buf);

typedef struct rarch_setting_info
{
   int index;
   int size;
} rarch_setting_info_t;

typedef struct rarch_setting_group_info
{
   const char *name;
} rarch_setting_group_info_t;

typedef struct rarch_setting
{
   enum setting_type type;

   const char *name;
   uint32_t size;
   
   const char* short_description;
   const char* group;
   const char* subgroup;

   uint32_t index;
   uint32_t index_offset;

   double min;
   double max;
   
   const char* values;
   uint64_t flags;
   
   change_handler_t change_handler;
   change_handler_t deferred_handler;
   change_handler_t read_handler;
   action_start_handler_t action_start;
   action_iterate_handler_t action_iterate;
   action_toggle_handler_t action_toggle;
   action_up_or_down_handler_t action_up_or_down;
   action_cancel_handler_t action_cancel;
   action_ok_handler_t action_ok;
   get_string_representation_t get_string_representation;

   union
   {
      bool boolean;
      int integer;
      unsigned int unsigned_integer;
      float fraction;
      const char* string;
      const struct retro_keybind* keybind;
   } default_value;
   
   union
   {
      bool* boolean;
      int* integer;
      unsigned int* unsigned_integer;
      float* fraction;
      char* string;
      struct retro_keybind* keybind;
   } value;

   union
   {
      bool boolean;
      int integer;
      unsigned int unsigned_integer;
      float fraction;
   } original_value;

   struct
   {
      const char *empty_path;
   } dir;

   struct
   {
      unsigned idx;
      bool triggered;
   } cmd_trigger;

   struct
   {
      const char *off_label;
      const char *on_label;
   } boolean;

   unsigned bind_type;
   unsigned browser_selection_type;
   float step;
   const char *rounding_fraction;
   bool enforce_minrange;
   bool enforce_maxrange;
}  rarch_setting_t;


bool settings_list_append(rarch_setting_t **list,
      rarch_setting_info_t *list_info, rarch_setting_t value);

void settings_list_current_add_flags(
      rarch_setting_t **list,
      rarch_setting_info_t *list_info,
      unsigned values);

void settings_list_current_add_bind_type(
      rarch_setting_t **list,
      rarch_setting_info_t *list_info,
      unsigned type);

void settings_list_current_add_range(
      rarch_setting_t **list,
      rarch_setting_info_t *list_info,
      float min, float max, float step,
      bool enforce_minrange_enable, bool enforce_maxrange_enable);

void settings_list_current_add_values(
      rarch_setting_t **list,
      rarch_setting_info_t *list_info,
      const char *values);

void settings_list_current_add_cmd(
      rarch_setting_t **list,
      rarch_setting_info_t *list_info,
      unsigned values);

void settings_info_list_free(rarch_setting_info_t *list_info);

void settings_list_free(rarch_setting_t *list);

rarch_setting_info_t *settings_info_list_new(void);

rarch_setting_t *settings_list_new(unsigned size);

#ifdef __cplusplus
}
#endif

#endif