1 /*  RetroArch - A frontend for libretro.
2  *  Copyright (C) 2010-2014 - Hans-Kristian Arntzen
3  *  Copyright (C) 2011-2017 - Daniel De Matteis
4  *  Copyright (C) 2016-2019 - Brad Parker
5  *
6  *  RetroArch is free software: you can redistribute it and/or modify it under the terms
7  *  of the GNU General Public License as published by the Free Software Found-
8  *  ation, either version 3 of the License, or (at your option) any later version.
9  *
10  *  RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
11  *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  *  PURPOSE.  See the GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License along with RetroArch.
15  *  If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __MENU_DRIVER_H__
19 #define __MENU_DRIVER_H__
20 
21 #include <stdint.h>
22 #include <stddef.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <ctype.h>
26 
27 #include <boolean.h>
28 #include <retro_common_api.h>
29 #include <formats/image.h>
30 #include <queues/task_queue.h>
31 
32 #include "menu_defines.h"
33 #include "menu_input.h"
34 #include "menu_entries.h"
35 #include "menu_shader.h"
36 #include "../gfx/gfx_display.h"
37 
38 #include "../gfx/font_driver.h"
39 
40 #ifdef HAVE_CONFIG_H
41 #include "../config.h"
42 #endif
43 
44 RETRO_BEGIN_DECLS
45 
46 #ifndef MAX_COUNTERS
47 #define MAX_COUNTERS 64
48 #endif
49 
50 #ifndef MAX_CHEAT_COUNTERS
51 #define MAX_CHEAT_COUNTERS 6000
52 #endif
53 
54 #define MENU_SETTINGS_CORE_INFO_NONE             0xffff
55 #define MENU_SETTINGS_CORE_OPTION_NONE           0xffff
56 #define MENU_SETTINGS_CHEEVOS_NONE               0xffff
57 #define MENU_SETTINGS_CORE_OPTION_START          0x10000
58 #define MENU_SETTINGS_CHEEVOS_START              0x40000
59 #define MENU_SETTINGS_NETPLAY_ROOMS_START        0x80000
60 
61 enum menu_settings_type
62 {
63    MENU_SETTINGS_NONE       = FILE_TYPE_LAST + 1,
64    MENU_SETTINGS,
65    MENU_SETTINGS_TAB,
66    MENU_HISTORY_TAB,
67    MENU_FAVORITES_TAB,
68    MENU_MUSIC_TAB,
69    MENU_VIDEO_TAB,
70    MENU_IMAGES_TAB,
71    MENU_NETPLAY_TAB,
72    MENU_EXPLORE_TAB,
73    MENU_ADD_TAB,
74    MENU_PLAYLISTS_TAB,
75    MENU_SETTING_DROPDOWN_ITEM,
76    MENU_SETTING_DROPDOWN_ITEM_RESOLUTION,
77    MENU_SETTING_DROPDOWN_ITEM_VIDEO_SHADER_PARAM,
78    MENU_SETTING_DROPDOWN_ITEM_VIDEO_SHADER_PRESET_PARAM,
79    MENU_SETTING_DROPDOWN_ITEM_VIDEO_SHADER_NUM_PASS,
80    MENU_SETTING_DROPDOWN_ITEM_PLAYLIST_DEFAULT_CORE,
81    MENU_SETTING_DROPDOWN_ITEM_PLAYLIST_LABEL_DISPLAY_MODE,
82    MENU_SETTING_DROPDOWN_ITEM_PLAYLIST_RIGHT_THUMBNAIL_MODE,
83    MENU_SETTING_DROPDOWN_ITEM_PLAYLIST_LEFT_THUMBNAIL_MODE,
84    MENU_SETTING_DROPDOWN_ITEM_PLAYLIST_SORT_MODE,
85    MENU_SETTING_DROPDOWN_ITEM_MANUAL_CONTENT_SCAN_SYSTEM_NAME,
86    MENU_SETTING_DROPDOWN_ITEM_MANUAL_CONTENT_SCAN_CORE_NAME,
87    MENU_SETTING_DROPDOWN_ITEM_DISK_INDEX,
88    MENU_SETTING_DROPDOWN_ITEM_INPUT_DEVICE_TYPE,
89    MENU_SETTING_DROPDOWN_ITEM_INPUT_DEVICE_INDEX,
90    MENU_SETTING_DROPDOWN_ITEM_INPUT_DESCRIPTION,
91    MENU_SETTING_DROPDOWN_ITEM_INPUT_DESCRIPTION_KBD,
92    MENU_SETTING_DROPDOWN_SETTING_CORE_OPTIONS_ITEM,
93    MENU_SETTING_DROPDOWN_SETTING_STRING_OPTIONS_ITEM,
94    MENU_SETTING_DROPDOWN_SETTING_FLOAT_ITEM,
95    MENU_SETTING_DROPDOWN_SETTING_INT_ITEM,
96    MENU_SETTING_DROPDOWN_SETTING_UINT_ITEM,
97    MENU_SETTING_DROPDOWN_SETTING_CORE_OPTIONS_ITEM_SPECIAL,
98    MENU_SETTING_DROPDOWN_SETTING_STRING_OPTIONS_ITEM_SPECIAL,
99    MENU_SETTING_DROPDOWN_SETTING_FLOAT_ITEM_SPECIAL,
100    MENU_SETTING_DROPDOWN_SETTING_INT_ITEM_SPECIAL,
101    MENU_SETTING_DROPDOWN_SETTING_UINT_ITEM_SPECIAL,
102    MENU_SETTING_NO_ITEM,
103    MENU_SETTING_DRIVER,
104    MENU_SETTING_ACTION,
105    MENU_SETTING_ACTION_RUN,
106    MENU_SETTING_ACTION_CLOSE,
107    MENU_SETTING_ACTION_CLOSE_HORIZONTAL,
108    MENU_SETTING_ACTION_CORE_OPTIONS,
109    MENU_SETTING_ACTION_CORE_OPTION_OVERRIDE_LIST,
110    MENU_SETTING_ACTION_CORE_INPUT_REMAPPING_OPTIONS,
111    MENU_SETTING_ACTION_CORE_CHEAT_OPTIONS,
112    MENU_SETTING_ACTION_CORE_MANAGER_OPTIONS,
113    MENU_SETTING_ACTION_CORE_DISK_OPTIONS,
114    MENU_SETTING_ACTION_CORE_SHADER_OPTIONS,
115    MENU_SETTING_ACTION_SAVESTATE,
116    MENU_SETTING_ACTION_LOADSTATE,
117    MENU_SETTING_ACTION_SCREENSHOT,
118    MENU_SETTING_ACTION_DELETE_ENTRY,
119    MENU_SETTING_ACTION_RESET,
120    MENU_SETTING_ACTION_CORE_LOCK,
121    MENU_SETTING_ACTION_CORE_DELETE,
122    MENU_SETTING_ACTION_FAVORITES_DIR, /* "Start Directory" */
123    MENU_SETTING_STRING_OPTIONS,
124    MENU_SETTING_GROUP,
125    MENU_SETTING_SUBGROUP,
126    MENU_SETTING_HORIZONTAL_MENU,
127    MENU_SETTING_ACTION_PAUSE_ACHIEVEMENTS,
128    MENU_SETTING_ACTION_RESUME_ACHIEVEMENTS,
129    MENU_SETTING_PLAYLIST_MANAGER_DEFAULT_CORE,
130    MENU_SETTING_PLAYLIST_MANAGER_LABEL_DISPLAY_MODE,
131    MENU_SETTING_PLAYLIST_MANAGER_RIGHT_THUMBNAIL_MODE,
132    MENU_SETTING_PLAYLIST_MANAGER_LEFT_THUMBNAIL_MODE,
133    MENU_SETTING_PLAYLIST_MANAGER_SORT_MODE,
134    MENU_BLUETOOTH,
135    MENU_WIFI,
136    MENU_WIFI_DISCONNECT,
137    MENU_ROOM,
138    MENU_ROOM_LAN,
139    MENU_ROOM_RELAY,
140    MENU_NETPLAY_LAN_SCAN,
141    MENU_INFO_MESSAGE,
142    MENU_SETTINGS_SHADER_PARAMETER_0,
143    MENU_SETTINGS_SHADER_PARAMETER_LAST = MENU_SETTINGS_SHADER_PARAMETER_0 + (GFX_MAX_PARAMETERS - 1),
144    MENU_SETTINGS_SHADER_PRESET_PARAMETER_0,
145    MENU_SETTINGS_SHADER_PRESET_PARAMETER_LAST = MENU_SETTINGS_SHADER_PRESET_PARAMETER_0 + (GFX_MAX_PARAMETERS - 1),
146    MENU_SETTINGS_SHADER_PASS_0,
147    MENU_SETTINGS_SHADER_PASS_LAST = MENU_SETTINGS_SHADER_PASS_0 + (GFX_MAX_SHADERS - 1),
148    MENU_SETTINGS_SHADER_PASS_FILTER_0,
149    MENU_SETTINGS_SHADER_PASS_FILTER_LAST = MENU_SETTINGS_SHADER_PASS_FILTER_0  + (GFX_MAX_SHADERS - 1),
150    MENU_SETTINGS_SHADER_PASS_SCALE_0,
151    MENU_SETTINGS_SHADER_PASS_SCALE_LAST = MENU_SETTINGS_SHADER_PASS_SCALE_0  + (GFX_MAX_SHADERS - 1),
152 
153    MENU_SETTINGS_CORE_DISK_OPTIONS_DISK_INDEX,
154    MENU_SETTINGS_CORE_DISK_OPTIONS_DISK_IMAGE_APPEND,
155    MENU_SETTINGS_CORE_DISK_OPTIONS_DISK_CYCLE_TRAY_STATUS,
156 
157    MENU_SETTINGS_AUDIO_MIXER_STREAM_BEGIN,
158    MENU_SETTINGS_AUDIO_MIXER_STREAM_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
159    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_BEGIN,
160    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
161 
162    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_STOP_BEGIN,
163    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_STOP_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_STOP_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
164    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_REMOVE_BEGIN,
165    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_REMOVE_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_REMOVE_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
166    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_BEGIN,
167    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
168    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_LOOPED_BEGIN,
169    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_LOOPED_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_LOOPED_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
170    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_SEQUENTIAL_BEGIN,
171    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_SEQUENTIAL_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_PLAY_SEQUENTIAL_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
172    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_VOLUME_BEGIN,
173    MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_VOLUME_END = MENU_SETTINGS_AUDIO_MIXER_STREAM_ACTIONS_VOLUME_BEGIN + MENU_SETTINGS_AUDIO_MIXER_MAX_STREAMS,
174    MENU_SETTINGS_BIND_BEGIN,
175    MENU_SETTINGS_BIND_LAST = MENU_SETTINGS_BIND_BEGIN + RARCH_ANALOG_RIGHT_Y_MINUS,
176    MENU_SETTINGS_BIND_ALL_LAST = MENU_SETTINGS_BIND_BEGIN + RARCH_MENU_TOGGLE,
177 
178    MENU_SETTINGS_CUSTOM_BIND,
179    MENU_SETTINGS_CUSTOM_BIND_KEYBOARD,
180    MENU_SETTINGS_CUSTOM_BIND_ALL,
181    MENU_SETTINGS_CUSTOM_BIND_DEFAULT_ALL,
182    MENU_SETTINGS_LIBRETRO_PERF_COUNTERS_BEGIN,
183    MENU_SETTINGS_LIBRETRO_PERF_COUNTERS_END = MENU_SETTINGS_LIBRETRO_PERF_COUNTERS_BEGIN + (MAX_COUNTERS - 1),
184    MENU_SETTINGS_PERF_COUNTERS_BEGIN,
185    MENU_SETTINGS_PERF_COUNTERS_END = MENU_SETTINGS_PERF_COUNTERS_BEGIN + (MAX_COUNTERS - 1),
186    MENU_SETTINGS_CHEAT_BEGIN,
187    MENU_SETTINGS_CHEAT_END = MENU_SETTINGS_CHEAT_BEGIN + (MAX_CHEAT_COUNTERS - 1),
188 
189    MENU_SETTINGS_INPUT_LIBRETRO_DEVICE,
190    MENU_SETTINGS_INPUT_ANALOG_DPAD_MODE,
191    MENU_SETTINGS_INPUT_INPUT_REMAP_PORT,
192    MENU_SETTINGS_INPUT_BEGIN,
193    MENU_SETTINGS_INPUT_END = MENU_SETTINGS_INPUT_BEGIN + RARCH_CUSTOM_BIND_LIST_END + 6,
194    MENU_SETTINGS_INPUT_DESC_BEGIN,
195    MENU_SETTINGS_INPUT_DESC_END = MENU_SETTINGS_INPUT_DESC_BEGIN + ((RARCH_FIRST_CUSTOM_BIND + 8) * MAX_USERS),
196    MENU_SETTINGS_INPUT_DESC_KBD_BEGIN,
197    MENU_SETTINGS_INPUT_DESC_KBD_END = MENU_SETTINGS_INPUT_DESC_KBD_BEGIN + (RARCH_MAX_KEYS * MAX_USERS),
198    MENU_SETTINGS_REMAPPING_PORT_BEGIN,
199    MENU_SETTINGS_REMAPPING_PORT_END = MENU_SETTINGS_REMAPPING_PORT_BEGIN + (MAX_USERS),
200 
201    MENU_SETTINGS_SUBSYSTEM_LOAD,
202    MENU_SETTINGS_SUBSYSTEM_ADD,
203    MENU_SETTINGS_SUBSYSTEM_LAST = MENU_SETTINGS_SUBSYSTEM_ADD + RARCH_MAX_SUBSYSTEMS,
204    MENU_SETTINGS_CHEAT_MATCH,
205 
206    MENU_SET_SCREEN_BRIGHTNESS,
207 
208 #ifdef HAVE_LAKKA_SWITCH
209    MENU_SET_SWITCH_GPU_PROFILE,
210 #endif
211 #if defined(HAVE_LAKKA_SWITCH) || defined(HAVE_LIBNX)
212    MENU_SET_SWITCH_CPU_PROFILE,
213 #endif
214 
215    MENU_SETTINGS_CPU_POLICY_SET_MINFREQ,
216    MENU_SETTINGS_CPU_POLICY_SET_MAXFREQ,
217    MENU_SETTINGS_CPU_POLICY_SET_GOVERNOR,
218    MENU_SETTINGS_CPU_MANAGED_SET_MINFREQ,
219    MENU_SETTINGS_CPU_MANAGED_SET_MAXFREQ,
220 
221    MENU_SET_CDROM_LIST,
222    MENU_SET_LOAD_CDROM_LIST,
223    MENU_SET_CDROM_INFO,
224    MENU_SETTING_ACTION_DELETE_PLAYLIST,
225    MENU_SETTING_ACTION_PLAYLIST_MANAGER_RESET_CORES,
226    MENU_SETTING_ACTION_PLAYLIST_MANAGER_CLEAN_PLAYLIST,
227 
228    MENU_SETTING_MANUAL_CONTENT_SCAN_DIR,
229    MENU_SETTING_MANUAL_CONTENT_SCAN_SYSTEM_NAME,
230    MENU_SETTING_MANUAL_CONTENT_SCAN_CORE_NAME,
231    MENU_SETTING_ACTION_MANUAL_CONTENT_SCAN_START,
232 
233    MENU_SETTING_ACTION_CORE_CREATE_BACKUP,
234    MENU_SETTING_ACTION_CORE_RESTORE_BACKUP,
235    MENU_SETTING_ITEM_CORE_RESTORE_BACKUP,
236    MENU_SETTING_ACTION_CORE_DELETE_BACKUP,
237    MENU_SETTING_ITEM_CORE_DELETE_BACKUP,
238 
239    MENU_SETTING_ACTION_VIDEO_FILTER_REMOVE,
240    MENU_SETTING_ACTION_AUDIO_DSP_PLUGIN_REMOVE,
241 
242    MENU_SETTING_ACTION_GAME_SPECIFIC_CORE_OPTIONS_CREATE,
243    MENU_SETTING_ACTION_GAME_SPECIFIC_CORE_OPTIONS_REMOVE,
244    MENU_SETTING_ACTION_FOLDER_SPECIFIC_CORE_OPTIONS_CREATE,
245    MENU_SETTING_ACTION_FOLDER_SPECIFIC_CORE_OPTIONS_REMOVE,
246    MENU_SETTING_ACTION_CORE_OPTIONS_RESET,
247 
248    MENU_SETTINGS_LAST
249 };
250 
251 typedef struct menu_ctx_driver
252 {
253    /* Set a framebuffer texture. This is used for instance by RGUI. */
254    void  (*set_texture)(void *data);
255    /* Render a messagebox to the screen. */
256    void  (*render_messagebox)(void *data, const char *msg);
257    void  (*render)(void *data, unsigned width, unsigned height, bool is_idle);
258    void  (*frame)(void *data, video_frame_info_t *video_info);
259    /* Initializes the menu driver. (setup) */
260    void* (*init)(void**, bool);
261    /* Frees the menu driver. (teardown) */
262    void  (*free)(void*);
263    /* This will be invoked when we are running a hardware context
264     * and we have just flushed the state. For instance - we have
265     * just toggled fullscreen, the GL driver did a teardown/setup -
266     * we now need to rebuild all of our textures and state for the
267     * menu driver. */
268    void  (*context_reset)(void *data, bool video_is_threaded);
269    /* This will be invoked when we are running a hardware context
270     * and the context in question wants to tear itself down. All
271     * textures and related state on the menu driver will also
272     * be freed up then. */
273    void  (*context_destroy)(void *data);
274    void  (*populate_entries)(void *data,
275          const char *path, const char *label,
276          unsigned k);
277    void  (*toggle)(void *userdata, bool);
278    /* This will clear the navigation position. */
279    void  (*navigation_clear)(void *, bool);
280    /* This will decrement the navigation position by one. */
281    void  (*navigation_decrement)(void *data);
282    /* This will increment the navigation position by one. */
283    void  (*navigation_increment)(void *data);
284    void  (*navigation_set)(void *data, bool);
285    void  (*navigation_set_last)(void *data);
286    /* This will descend the navigation position by one alphabet letter. */
287    void  (*navigation_descend_alphabet)(void *, size_t *);
288    /* This will ascend the navigation position by one alphabet letter. */
289    void  (*navigation_ascend_alphabet)(void *, size_t *);
290    /* Initializes a new menu list. */
291    bool  (*lists_init)(void*);
292    void  (*list_insert)(void *userdata,
293          file_list_t *list, const char *, const char *, const char *, size_t,
294          unsigned);
295    int   (*list_prepend)(void *userdata,
296          file_list_t *list, const char *, const char *, size_t);
297    void  (*list_free)(file_list_t *list, size_t, size_t);
298    void  (*list_clear)(file_list_t *list);
299    void  (*list_cache)(void *data, enum menu_list_type, unsigned);
300    int   (*list_push)(void *data, void *userdata, menu_displaylist_info_t*, unsigned);
301    size_t(*list_get_selection)(void *data);
302    size_t(*list_get_size)(void *data, enum menu_list_type type);
303    void *(*list_get_entry)(void *data, enum menu_list_type type, unsigned i);
304    void  (*list_set_selection)(void *data, file_list_t *list);
305    int   (*bind_init)(menu_file_list_cbs_t *cbs,
306          const char *path, const char *label, unsigned type, size_t idx);
307    /* Load an image for use by the menu driver */
308    bool  (*load_image)(void *userdata, void *data, enum menu_image_type type);
309    const char *ident;
310    int (*environ_cb)(enum menu_environ_cb type, void *data, void *userdata);
311    void (*update_thumbnail_path)(void *data, unsigned i, char pos);
312    void (*update_thumbnail_image)(void *data);
313    void (*refresh_thumbnail_image)(void *data, unsigned i);
314    void (*set_thumbnail_system)(void *data, char* s, size_t len);
315    void (*get_thumbnail_system)(void *data, char* s, size_t len);
316    void (*set_thumbnail_content)(void *data, const char *s);
317    int  (*osk_ptr_at_pos)(void *data, int x, int y, unsigned width, unsigned height);
318    void (*update_savestate_thumbnail_path)(void *data, unsigned i);
319    void (*update_savestate_thumbnail_image)(void *data);
320    int (*pointer_down)(void *data, unsigned x, unsigned y, unsigned ptr,
321          menu_file_list_cbs_t *cbs,
322          menu_entry_t *entry, unsigned action);
323    int (*pointer_up)(void *data, unsigned x, unsigned y, unsigned ptr,
324          enum menu_input_pointer_gesture gesture,
325          menu_file_list_cbs_t *cbs,
326          menu_entry_t *entry, unsigned action);
327    /* This will be invoked whenever a menu entry action
328     * (menu_entry_action()) is performed */
329    int (*entry_action)(void *userdata, menu_entry_t *entry, size_t i, enum menu_action action);
330 } menu_ctx_driver_t;
331 
332 typedef struct
333 {
334    uint64_t state;
335 
336    const menu_ctx_driver_t *driver_ctx;
337    void *userdata;
338    char *core_buf;
339 
340    size_t                     core_len;
341    /* This is used for storing intermediary variables
342     * that get used later on during menu actions -
343     * for instance, selecting a shader pass for a shader
344     * slot */
345    struct
346    {
347       unsigned                unsigned_var;
348    } scratchpad;
349    unsigned rpl_entry_selection_ptr;
350 
351 #if defined(HAVE_CG) || defined(HAVE_GLSL) || defined(HAVE_SLANG) || defined(HAVE_HLSL)
352    /* Used to cache the type and directory
353     * of the last shader preset/pass loaded
354     * via the menu file browser */
355    struct
356    {
357       enum rarch_shader_type preset_type;
358       enum rarch_shader_type pass_type;
359 
360       char preset_dir[PATH_MAX_LENGTH];
361       char preset_file_name[PATH_MAX_LENGTH];
362 
363       char pass_dir[PATH_MAX_LENGTH];
364       char pass_file_name[PATH_MAX_LENGTH];
365    } last_shader_selection;
366 #endif
367 
368    /* Used to cache the last start content
369     * loaded via the menu file browser */
370    struct
371    {
372       char directory[PATH_MAX_LENGTH];
373       char file_name[PATH_MAX_LENGTH];
374    } last_start_content;
375 
376    char menu_state_msg[8192];
377    /* Scratchpad variables. These are used for instance
378     * by the filebrowser when having to store intermediary
379     * paths (subdirs/previous dirs/current dir/path, etc).
380     */
381    char deferred_path[PATH_MAX_LENGTH];
382    char scratch_buf[PATH_MAX_LENGTH];
383    char scratch2_buf[PATH_MAX_LENGTH];
384    char db_playlist_file[PATH_MAX_LENGTH];
385    char filebrowser_label[PATH_MAX_LENGTH];
386    char detect_content_path[PATH_MAX_LENGTH];
387 } menu_handle_t;
388 
389 typedef struct menu_content_ctx_defer_info
390 {
391    void *data;
392    const char *dir;
393    const char *path;
394    const char *menu_label;
395    char *s;
396    size_t len;
397 } menu_content_ctx_defer_info_t;
398 
399 typedef struct menu_ctx_displaylist
400 {
401    menu_displaylist_info_t *info;
402    unsigned type;
403 } menu_ctx_displaylist_t;
404 
405 typedef struct menu_ctx_environment
406 {
407    void *data;
408    enum menu_environ_cb type;
409 } menu_ctx_environment_t;
410 
411 typedef struct menu_ctx_pointer
412 {
413    menu_file_list_cbs_t *cbs;
414    menu_entry_t *entry;
415    unsigned x;
416    unsigned y;
417    unsigned ptr;
418    unsigned action;
419    int retcode;
420    enum menu_input_pointer_gesture gesture;
421 } menu_ctx_pointer_t;
422 
423 typedef struct menu_ctx_bind
424 {
425    menu_file_list_cbs_t *cbs;
426    const char *path;
427    const char *label;
428    size_t idx;
429    unsigned type;
430 } menu_ctx_bind_t;
431 
432 /**
433  * config_get_menu_driver_options:
434  *
435  * Get an enumerated list of all menu driver names,
436  * separated by '|'.
437  *
438  * Returns: string listing of all menu driver names,
439  * separated by '|'.
440  **/
441 const char* config_get_menu_driver_options(void);
442 
443 const char *menu_driver_ident(void);
444 
445 bool menu_driver_ctl(enum rarch_menu_ctl_state state, void *data);
446 
447 void menu_driver_frame(bool menu_is_alive, video_frame_info_t *video_info);
448 
449 int menu_driver_deferred_push_content_list(file_list_t *list);
450 
451 bool menu_driver_list_cache(menu_ctx_list_t *list);
452 
453 void menu_driver_navigation_set(bool scroll);
454 
455 void menu_driver_populate_entries(menu_displaylist_info_t *info);
456 
457 bool menu_driver_push_list(menu_ctx_displaylist_t *disp_list);
458 
459 bool menu_driver_init(bool video_is_threaded);
460 
461 void menu_driver_set_thumbnail_system(char *s, size_t len);
462 
463 void menu_driver_get_thumbnail_system(char *s, size_t len);
464 
465 void menu_driver_set_thumbnail_content(char *s, size_t len);
466 
467 bool menu_driver_list_get_selection(menu_ctx_list_t *list);
468 
469 bool menu_driver_list_get_entry(menu_ctx_list_t *list);
470 
471 bool menu_driver_list_get_size(menu_ctx_list_t *list);
472 
473 bool menu_driver_screensaver_supported(void);
474 
475 retro_time_t menu_driver_get_current_time(void);
476 
477 size_t menu_navigation_get_selection(void);
478 
479 void menu_navigation_set_selection(size_t val);
480 
481 void menu_display_handle_thumbnail_upload(retro_task_t *task,
482       void *task_data,
483       void *user_data, const char *err);
484 
485 void menu_display_handle_left_thumbnail_upload(retro_task_t *task,
486       void *task_data,
487       void *user_data, const char *err);
488 
489 void menu_display_handle_savestate_thumbnail_upload(retro_task_t *task,
490       void *task_data,
491       void *user_data, const char *err);
492 
493 void menu_display_timedate(gfx_display_ctx_datetime_t *datetime);
494 
495 void menu_display_powerstate(gfx_display_ctx_powerstate_t *powerstate);
496 
497 void menu_display_handle_wallpaper_upload(retro_task_t *task,
498       void *task_data,
499       void *user_data, const char *err);
500 
501 #if defined(HAVE_LIBRETRODB)
502 uintptr_t menu_explore_get_entry_icon(unsigned type);
503 void menu_explore_context_init(void);
504 void menu_explore_context_deinit(void);
505 void menu_explore_free(void);
506 #endif
507 
508 /* Returns true if search filter is enabled
509  * for the specified menu list */
510 bool menu_driver_search_filter_enabled(const char *label, unsigned type);
511 
512 #if defined(HAVE_CG) || defined(HAVE_GLSL) || defined(HAVE_SLANG) || defined(HAVE_HLSL)
513 void menu_driver_set_last_shader_preset_path(const char *path);
514 void menu_driver_set_last_shader_pass_path(const char *path);
515 enum rarch_shader_type menu_driver_get_last_shader_preset_type(void);
516 enum rarch_shader_type menu_driver_get_last_shader_pass_type(void);
517 void menu_driver_get_last_shader_preset_path(
518       const char **directory, const char **file_name);
519 void menu_driver_get_last_shader_pass_path(
520       const char **directory, const char **file_name);
521 #endif
522 
523 const char *menu_driver_get_last_start_directory(void);
524 const char *menu_driver_get_last_start_file_name(void);
525 void menu_driver_set_last_start_content(const char *start_content_path);
526 const char *menu_driver_get_pending_selection(void);
527 void menu_driver_set_pending_selection(const char *pending_selection);
528 
529 menu_handle_t *menu_driver_get_ptr(void);
530 
531 enum action_iterate_type
532 {
533    ITERATE_TYPE_DEFAULT = 0,
534    ITERATE_TYPE_HELP,
535    ITERATE_TYPE_INFO,
536    ITERATE_TYPE_BIND
537 };
538 
539 int generic_menu_entry_action(void *userdata, menu_entry_t *entry, size_t i, enum menu_action action);
540 
541 extern menu_ctx_driver_t menu_ctx_ozone;
542 extern menu_ctx_driver_t menu_ctx_xui;
543 extern menu_ctx_driver_t menu_ctx_rgui;
544 extern menu_ctx_driver_t menu_ctx_mui;
545 extern menu_ctx_driver_t menu_ctx_xmb;
546 extern menu_ctx_driver_t menu_ctx_stripes;
547 
548 RETRO_END_DECLS
549 
550 #endif
551