The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-04-04 23:56:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Robin Jones 2025-02-21 23:30:47 +00:00
parent 9bbee1e24a
commit 960eacabd9
11 changed files with 501 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/menu/actions.h
View File

@ -7,14 +7,18 @@
#ifndef ACTIONS_H__
#define ACTIONS_H__
#include "menu_state.h"
/**
* @brief Initialize the actions module
* @brief Initialize the actions module.
*/
void actions_init (void);
/**
* @brief Update the actions based on the current menu state.
*
* @param menu Pointer to the menu structure.
*/
void actions_update (menu_t *menu);
#endif
#endif /* ACTIONS_H__ */

40
src/menu/menu.c
View File

@ -1,3 +1,9 @@
/**
* @file menu.c
* @brief Menu system implementation
* @ingroup menu
*/
#include <stdbool.h>
#include <stdlib.h>
#include <time.h>
@ -19,7 +25,6 @@
#include "utils/fs.h"
#include "views/views.h"
#define MENU_DIRECTORY "/menu"
#define MENU_SETTINGS_FILE "config.ini"
#define MENU_CUSTOM_FONT_FILE "custom.font64"
@ -31,10 +36,13 @@
#define INTERLACED (true)
#define FPS_LIMIT (30.0f)
static menu_t *menu;
/**
* @brief Initialize the menu system.
*
* @param boot_params Pointer to the boot parameters structure.
*/
static void menu_init (boot_params_t *boot_params) {
menu = calloc(1, sizeof(menu_t));
assert(menu != NULL);
@ -108,6 +116,11 @@ static void menu_init (boot_params_t *boot_params) {
}
}
/**
* @brief Deinitialize the menu system.
*
* @param menu Pointer to the menu structure.
*/
static void menu_deinit (menu_t *menu) {
hdmi_send_game_id(menu->boot_params);
@ -135,10 +148,13 @@ static void menu_deinit (menu_t *menu) {
flashcart_deinit();
}
/**
* @brief View structure containing initialization and display functions.
*/
typedef const struct {
menu_mode_t id;
void (*init) (menu_t *menu);
void (*show) (menu_t *menu, surface_t *display);
menu_mode_t id; /**< View ID */
void (*init) (menu_t *menu); /**< Initialization function */
void (*show) (menu_t *menu, surface_t *display); /**< Display function */
} view_t;
static view_t menu_views[] = {
@ -162,6 +178,12 @@ static view_t menu_views[] = {
{ MENU_MODE_HISTORY, view_history_init, view_history_display }
};
/**
* @brief Get the view structure for the specified menu mode.
*
* @param id The menu mode ID.
* @return view_t* Pointer to the view structure.
*/
static view_t *menu_get_view (menu_mode_t id) {
for (int i = 0; i < sizeof(menu_views) / sizeof(view_t); i++) {
if (menu_views[i].id == id) {
@ -171,7 +193,11 @@ static view_t *menu_get_view (menu_mode_t id) {
return NULL;
}
/**
* @brief Run the menu system.
*
* @param boot_params Pointer to the boot parameters structure.
*/
void menu_run (boot_params_t *boot_params) {
menu_init(boot_params);

135
src/menu/mp3_player.c
View File

@ -1,3 +1,9 @@
/**
* @file mp3_player.c
* @brief MP3 Player component implementation
* @ingroup ui_components
*/
#include <stdio.h>
#include <sys/stat.h>
@ -13,34 +19,34 @@
#include <minimp3/minimp3_ex.h>
#include <minimp3/minimp3.h>
#define SEEK_PREDECODE_FRAMES (5)
/** @brief MP3 File Information Structure. */
typedef struct {
bool loaded;
bool loaded; /**< Indicates if the MP3 file is loaded */
FILE *f;
size_t file_size;
size_t data_start;
uint8_t buffer[16 * 1024];
uint8_t *buffer_ptr;
size_t buffer_left;
FILE *f; /**< File pointer */
size_t file_size; /**< Size of the file */
size_t data_start; /**< Start position of the data */
uint8_t buffer[16 * 1024]; /**< Buffer for reading data */
uint8_t *buffer_ptr; /**< Pointer to the current position in the buffer */
size_t buffer_left; /**< Amount of data left in the buffer */
mp3dec_t dec;
mp3dec_frame_info_t info;
mp3dec_t dec; /**< MP3 decoder */
mp3dec_frame_info_t info; /**< MP3 frame information */
int seek_predecode_frames;
float duration;
float bitrate;
int seek_predecode_frames; /**< Number of frames to pre-decode when seeking */
float duration; /**< Duration of the MP3 file */
float bitrate; /**< Bitrate of the MP3 file */
waveform_t wave;
waveform_t wave; /**< Waveform structure for playback */
} mp3player_t;
static mp3player_t *p = NULL;
/**
* @brief Reset the MP3 decoder.
*/
static void mp3player_reset_decoder (void) {
mp3dec_init(&p->dec);
p->seek_predecode_frames = 0;
@ -48,6 +54,9 @@ static void mp3player_reset_decoder (void) {
p->buffer_left = 0;
}
/**
* @brief Fill the buffer with data from the MP3 file.
*/
static void mp3player_fill_buffer (void) {
if (feof(p->f)) {
return;
@ -65,6 +74,15 @@ static void mp3player_fill_buffer (void) {
p->buffer_left += fread(p->buffer + p->buffer_left, 1, sizeof(p->buffer) - p->buffer_left, p->f);
}
/**
* @brief Read waveform data for playback.
*
* @param ctx Context pointer.
* @param sbuf Sample buffer.
* @param wpos Write position.
* @param wlen Write length.
* @param seeking Indicates if seeking is in progress.
*/
static void mp3player_wave_read (void *ctx, samplebuffer_t *sbuf, int wpos, int wlen, bool seeking) {
while (wlen > 0) {
mp3player_fill_buffer();
@ -100,6 +118,11 @@ static void mp3player_wave_read (void *ctx, samplebuffer_t *sbuf, int wpos, int
}
}
/**
* @brief Calculate the duration of the MP3 file.
*
* @param samples Number of samples.
*/
static void mp3player_calculate_duration (int samples) {
uint32_t frames;
int delay, padding;
@ -114,7 +137,9 @@ static void mp3player_calculate_duration (int samples) {
}
}
/**
* @brief Initialize the MP3 player mixer.
*/
void mp3player_mixer_init (void) {
// NOTE: Deliberately setting max_frequency to twice of actual maximum samplerate of mp3 file.
// It's tricking mixer into creating buffer long enough for appending data created by mp3dec_decode_frame.
@ -122,6 +147,11 @@ void mp3player_mixer_init (void) {
mixer_ch_set_limits(SOUND_MP3_PLAYER_CHANNEL, 16, 96000, 0);
}
/**
* @brief Initialize the MP3 player.
*
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_init (void) {
p = calloc(1, sizeof(mp3player_t));
@ -147,12 +177,21 @@ mp3player_err_t mp3player_init (void) {
return MP3PLAYER_OK;
}
/**
* @brief Deinitialize the MP3 player.
*/
void mp3player_deinit (void) {
mp3player_unload();
free(p);
p = NULL;
}
/**
* @brief Load an MP3 file.
*
* @param path Path to the MP3 file.
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_load (char *path) {
if (p->loaded) {
mp3player_unload();
@ -217,6 +256,9 @@ mp3player_err_t mp3player_load (char *path) {
return MP3PLAYER_ERR_INVALID_FILE;
}
/**
* @brief Unload the MP3 file.
*/
void mp3player_unload (void) {
mp3player_stop();
if (p->loaded) {
@ -225,6 +267,11 @@ void mp3player_unload (void) {
}
}
/**
* @brief Process the MP3 player.
*
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_process (void) {
if (ferror(p->f)) {
mp3player_unload();
@ -238,14 +285,29 @@ mp3player_err_t mp3player_process (void) {
return MP3PLAYER_OK;
}
/**
* @brief Check if the MP3 player is playing.
*
* @return true if playing, false otherwise.
*/
bool mp3player_is_playing (void) {
return mixer_ch_playing(SOUND_MP3_PLAYER_CHANNEL);
}
/**
* @brief Check if the MP3 player has finished playing.
*
* @return true if finished, false otherwise.
*/
bool mp3player_is_finished (void) {
return p->loaded && feof(p->f) && (p->buffer_left == 0);
}
/**
* @brief Play the MP3 file.
*
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_play (void) {
if (!p->loaded) {
return MP3PLAYER_ERR_NO_FILE;
@ -262,12 +324,20 @@ mp3player_err_t mp3player_play (void) {
return MP3PLAYER_OK;
}
/**
* @brief Stop the MP3 player.
*/
void mp3player_stop (void) {
if (mp3player_is_playing()) {
mixer_ch_stop(SOUND_MP3_PLAYER_CHANNEL);
}
}
/**
* @brief Toggle the MP3 player between play and stop.
*
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_toggle (void) {
if (mp3player_is_playing()) {
mp3player_stop();
@ -277,11 +347,22 @@ mp3player_err_t mp3player_toggle (void) {
return MP3PLAYER_OK;
}
/**
* @brief Mute or unmute the MP3 player.
*
* @param mute True to mute, false to unmute.
*/
void mp3player_mute (bool mute) {
float volume = mute ? 0.0f : 1.0f;
mixer_ch_set_vol(SOUND_MP3_PLAYER_CHANNEL, volume, volume);
}
/**
* @brief Seek to a specific position in the MP3 file.
*
* @param seconds Number of seconds to seek.
* @return mp3player_err_t Error code.
*/
mp3player_err_t mp3player_seek (int seconds) {
// NOTE: Rough approximation using average bitrate to calculate number of bytes to be skipped.
// Good enough but not very accurate for variable bitrate files.
@ -316,6 +397,11 @@ mp3player_err_t mp3player_seek (int seconds) {
return MP3PLAYER_OK;
}
/**
* @brief Get the duration of the MP3 file.
*
* @return float Duration in seconds.
*/
float mp3player_get_duration (void) {
if (!p->loaded) {
return 0.0f;
@ -324,6 +410,11 @@ float mp3player_get_duration (void) {
return p->duration;
}
/**
* @brief Get the bitrate of the MP3 file.
*
* @return float Bitrate in kbps.
*/
float mp3player_get_bitrate (void) {
if (!p->loaded) {
return 0.0f;
@ -332,6 +423,11 @@ float mp3player_get_bitrate (void) {
return p->bitrate;
}
/**
* @brief Get the sample rate of the MP3 file.
*
* @return int Sample rate in Hz.
*/
int mp3player_get_samplerate (void) {
if (!p->loaded) {
return 0;
@ -340,6 +436,11 @@ int mp3player_get_samplerate (void) {
return p->info.hz;
}
/**
* @brief Get the progress of the MP3 file playback.
*
* @return float Progress as a percentage.
*/
float mp3player_get_progress (void) {
// NOTE: Rough approximation using file pointer instead of processed samples.
// Good enough but not very accurate for variable bitrate files.

56
src/menu/png_decoder.c
View File

@ -1,29 +1,33 @@
/**
* @file png_decoder.c
* @brief PNG Decoder component implementation
* @ingroup ui_components
*/
#include <stdio.h>
#include <libspng/spng/spng.h>
#include "png_decoder.h"
#include "utils/fs.h"
/** @brief PNG File Information Structure. */
typedef struct {
FILE *f;
spng_ctx *ctx;
struct spng_ihdr ihdr;
surface_t *image;
uint8_t *row_buffer;
int decoded_rows;
png_callback_t *callback;
void *callback_data;
FILE *f; /**< File pointer */
spng_ctx *ctx; /**< SPNG context */
struct spng_ihdr ihdr; /**< SPNG image header */
surface_t *image; /**< Image surface */
uint8_t *row_buffer; /**< Row buffer */
int decoded_rows; /**< Number of decoded rows */
png_callback_t *callback; /**< Callback function */
void *callback_data; /**< Callback data */
} png_decoder_t;
static png_decoder_t *decoder;
/**
* @brief Deinitialize the PNG decoder.
*
* @param free_image Flag indicating whether to free the image.
*/
static void png_decoder_deinit (bool free_image) {
if (decoder != NULL) {
fclose(decoder->f);
@ -42,7 +46,16 @@ static void png_decoder_deinit (bool free_image) {
}
}
/**
* @brief Start decoding a PNG file.
*
* @param path Path to the PNG file.
* @param max_width Maximum width of the image.
* @param max_height Maximum height of the image.
* @param callback Callback function to be called upon completion.
* @param callback_data Data to be passed to the callback function.
* @return png_err_t Error code.
*/
png_err_t png_decoder_start (char *path, int max_width, int max_height, png_callback_t *callback, void *callback_data) {
if (decoder != NULL) {
return PNG_ERR_BUSY;
@ -122,10 +135,18 @@ png_err_t png_decoder_start (char *path, int max_width, int max_height, png_call
return PNG_OK;
}
/**
* @brief Abort the PNG decoding process.
*/
void png_decoder_abort (void) {
png_decoder_deinit(true);
}
/**
* @brief Get the progress of the PNG decoding process.
*
* @return float Progress as a percentage.
*/
float png_decoder_get_progress (void) {
if (!decoder) {
return 0.0f;
@ -134,6 +155,9 @@ float png_decoder_get_progress (void) {
return (float) (decoder->decoded_rows) / (decoder->ihdr.height);
}
/**
* @brief Poll the PNG decoder to process the next row.
*/
void png_decoder_poll (void) {
if (!decoder) {
return;

63
src/menu/ui_components/background.c
View File

@ -1,3 +1,9 @@
/**
* @file background.c
* @brief Background component implementation
* @ingroup ui_components
*/
#include <stdio.h>
#include <stdlib.h>
@ -5,27 +11,30 @@
#include "constants.h"
#include "utils/fs.h"
#define CACHE_METADATA_MAGIC (0x424B4731)
/** @brief Background component structure */
typedef struct {
char *cache_location;
surface_t *image;
rspq_block_t *image_display_list;
char *cache_location; /**< Cache location */
surface_t *image; /**< Image surface */
rspq_block_t *image_display_list; /**< Image display list */
} component_background_t;
/** @brief Cache metadata structure */
typedef struct {
uint32_t magic;
uint32_t width;
uint32_t height;
uint32_t size;
uint32_t magic; /**< Magic number */
uint32_t width; /**< Image width */
uint32_t height; /**< Image height */
uint32_t size; /**< Image size */
} cache_metadata_t;
static component_background_t *background = NULL;
/**
* @brief Load background image from cache.
*
* @param c Pointer to the background component structure.
*/
static void load_from_cache (component_background_t *c) {
if (!c->cache_location) {
return;
@ -69,6 +78,11 @@ static void load_from_cache (component_background_t *c) {
fclose(f);
}
/**
* @brief Save background image to cache.
*
* @param c Pointer to the background component structure.
*/
static void save_to_cache (component_background_t *c) {
if (!c->cache_location || !c->image) {
return;
@ -93,6 +107,11 @@ static void save_to_cache (component_background_t *c) {
fclose(f);
}
/**
* @brief Prepare the background image for display.
*
* @param c Pointer to the background component structure.
*/
static void prepare_background (component_background_t *c) {
if (!c->image || c->image->width == 0 || c->image->height == 0) {
return;
@ -152,11 +171,20 @@ static void prepare_background (component_background_t *c) {
c->image_display_list = rspq_block_end();
}
/**
* @brief Free the display list.
*
* @param arg Pointer to the display list.
*/
static void display_list_free (void *arg) {
rspq_block_free((rspq_block_t *) (arg));
}
/**
* @brief Initialize the background component.
*
* @param cache_location The cache location.
*/
void ui_components_background_init (char *cache_location) {
if (!background) {
background = calloc(1, sizeof(component_background_t));
@ -166,6 +194,9 @@ void ui_components_background_init (char *cache_location) {
}
}
/**
* @brief Free the background component.
*/
void ui_components_background_free (void) {
if (background) {
if (background->image) {
@ -185,6 +216,11 @@ void ui_components_background_free (void) {
}
}
/**
* @brief Replace the background image.
*
* @param image The new background image.
*/
void ui_components_background_replace_image (surface_t *image) {
if (!background) {
return;
@ -206,6 +242,9 @@ void ui_components_background_replace_image (surface_t *image) {
prepare_background(background);
}
/**
* @brief Draw the background.
*/
void ui_components_background_draw (void) {
if (background && background->image_display_list) {
rspq_block_run(background->image_display_list);

42
src/menu/ui_components/boxart.c
View File

@ -1,3 +1,9 @@
/**
* @file boxart.c
* @brief Boxart component implementation
* @ingroup ui_components
*/
#include <stdlib.h>
#include "../ui_components.h"
@ -6,17 +12,29 @@
#include "constants.h"
#include "utils/fs.h"
#define BOXART_DIRECTORY "menu/boxart"
/**
* @brief PNG decoder callback function.
*
* @param err PNG decoder error code.
* @param decoded_image Pointer to the decoded image surface.
* @param callback_data Pointer to the callback data.
*/
static void png_decoder_callback (png_err_t err, surface_t *decoded_image, void *callback_data) {
component_boxart_t *b = (component_boxart_t *) (callback_data);
b->loading = false;
b->image = decoded_image;
}
/**
* @brief Initialize the boxart component.
*
* @param storage_prefix The storage prefix.
* @param game_code The game code.
* @param current_image_view The current image view type.
* @return component_boxart_t* Pointer to the initialized boxart component.
*/
component_boxart_t *ui_components_boxart_init (const char *storage_prefix, char *game_code, file_image_type_t current_image_view) {
component_boxart_t *b;
char boxart_id_path[8];
@ -70,8 +88,7 @@ component_boxart_t *ui_components_boxart_init (const char *storage_prefix, char
return b;
}
}
}
else { // compatibility mode
} else { // compatibility mode
char file_name[9];
@ -98,8 +115,7 @@ component_boxart_t *ui_components_boxart_init (const char *storage_prefix, char
path_free(path);
return b;
}
}
else {
} else {
path_pop(path);
snprintf(file_name, sizeof(file_name), "%c%c.png", game_code[1], game_code[2]);
@ -120,6 +136,11 @@ component_boxart_t *ui_components_boxart_init (const char *storage_prefix, char
return NULL;
}
/**
* @brief Free the boxart component.
*
* @param b Pointer to the boxart component.
*/
void ui_components_boxart_free (component_boxart_t *b) {
if (b) {
if (b->loading) {
@ -133,11 +154,16 @@ void ui_components_boxart_free (component_boxart_t *b) {
}
}
/**
* @brief Draw the boxart component.
*
* @param b Pointer to the boxart component.
*/
void ui_components_boxart_draw (component_boxart_t *b) {
int box_x = BOXART_X;
int box_y = BOXART_Y;
if (b && b->image && b->image->width <= BOXART_WIDTH_MAX && b->image->height <= BOXART_HEIGHT_MAX) {
if (b && b->image && b->image->width <= BOXART_WIDTH_MAX && b->image->height <= BOXART_HEIGHT_MAX) {
rdpq_mode_push();
rdpq_set_mode_copy(false);
if (b->image->height == BOXART_HEIGHT_MAX) {

117
src/menu/ui_components/common.c
View File

@ -1,35 +1,65 @@
/**
* @file common.c
* @brief Common UI components implementation
* @ingroup ui_components
*/
#include <stdarg.h>
#include "../ui_components.h"
#include "../fonts.h"
#include "constants.h"
/**
* @brief Draw a box with the specified color.
*
* @param x0 The x-coordinate of the top-left corner.
* @param y0 The y-coordinate of the top-left corner.
* @param x1 The x-coordinate of the bottom-right corner.
* @param y1 The y-coordinate of the bottom-right corner.
* @param color The color of the box.
*/
void ui_components_box_draw (int x0, int y0, int x1, int y1, color_t color) {
rdpq_mode_push();
rdpq_set_mode_fill(color);
rdpq_fill_rectangle(x0, y0, x1, y1);
rdpq_mode_pop();
}
/**
* @brief Draw a border with the specified color.
*
* @param x0 The x-coordinate of the top-left corner.
* @param y0 The y-coordinate of the top-left corner.
* @param x1 The x-coordinate of the bottom-right corner.
* @param y1 The y-coordinate of the bottom-right corner.
* @param color The color of the border.
*/
static void ui_components_border_draw_internal (int x0, int y0, int x1, int y1, color_t color) {
rdpq_mode_push();
rdpq_set_mode_fill(color);
rdpq_fill_rectangle(x0 - BORDER_THICKNESS, y0 - BORDER_THICKNESS, x1 + BORDER_THICKNESS, y0);
rdpq_fill_rectangle(x0 - BORDER_THICKNESS, y1, x1 + BORDER_THICKNESS, y1 + BORDER_THICKNESS);
rdpq_fill_rectangle(x0 - BORDER_THICKNESS, y0, x0, y1);
rdpq_fill_rectangle(x1, y0, x1 + BORDER_THICKNESS, y1);
rdpq_mode_pop();
}
/**
* @brief Draw a border with the default border color.
*
* @param x0 The x-coordinate of the top-left corner.
* @param y0 The y-coordinate of the top-left corner.
* @param x1 The x-coordinate of the bottom-right corner.
* @param y1 The y-coordinate of the bottom-right corner.
*/
void ui_components_border_draw (int x0, int y0, int x1, int y1) {
ui_components_border_draw_internal(x0, y0, x1, y1, BORDER_COLOR);
}
/**
* @brief Draw the layout with tabs.
*/
void ui_components_layout_draw_tabbed (void) {
ui_components_border_draw(
VISIBLE_AREA_X0,
@ -47,6 +77,9 @@ void ui_components_layout_draw_tabbed (void) {
);
}
/**
* @brief Draw the layout.
*/
void ui_components_layout_draw (void) {
ui_components_border_draw(
VISIBLE_AREA_X0,
@ -63,6 +96,15 @@ void ui_components_layout_draw (void) {
);
}
/**
* @brief Draw a progress bar.
*
* @param x0 The x-coordinate of the top-left corner.
* @param y0 The y-coordinate of the top-left corner.
* @param x1 The x-coordinate of the bottom-right corner.
* @param y1 The y-coordinate of the bottom-right corner.
* @param progress The progress value (0.0 to 1.0).
*/
void ui_components_progressbar_draw (int x0, int y0, int x1, int y1, float progress) {
float progress_width = progress * (x1 - x0);
@ -70,6 +112,11 @@ void ui_components_progressbar_draw (int x0, int y0, int x1, int y1, float progr
ui_components_box_draw(x0 + progress_width, y0, x1, y1, PROGRESSBAR_BG_COLOR);
}
/**
* @brief Draw a seek bar.
*
* @param position The position value (0.0 to 1.0).
*/
void ui_components_seekbar_draw (float position) {
int x0 = SEEKBAR_X;
int y0 = SEEKBAR_Y;
@ -80,6 +127,11 @@ void ui_components_seekbar_draw (float position) {
ui_components_progressbar_draw(x0, y0, x1, y1, position);
}
/**
* @brief Draw a loader.
*
* @param progress The progress value (0.0 to 1.0).
*/
void ui_components_loader_draw (float progress) {
int x0 = LOADER_X;
int y0 = LOADER_Y;
@ -90,6 +142,17 @@ void ui_components_loader_draw (float progress) {
ui_components_progressbar_draw(x0, y0, x1, y1, progress);
}
/**
* @brief Draw a scrollbar.
*
* @param x The x-coordinate of the top-left corner.
* @param y The y-coordinate of the top-left corner.
* @param width The width of the scrollbar.
* @param height The height of the scrollbar.
* @param position The current position.
* @param items The total number of items.
* @param visible_items The number of visible items.
*/
void ui_components_scrollbar_draw (int x, int y, int width, int height, int position, int items, int visible_items) {
if (items <= 1 || items <= visible_items) {
ui_components_box_draw(x, y, x + width, y + height, SCROLLBAR_INACTIVE_COLOR);
@ -102,6 +165,13 @@ void ui_components_scrollbar_draw (int x, int y, int width, int height, int posi
}
}
/**
* @brief Draw a list scrollbar.
*
* @param position The current position.
* @param items The total number of items.
* @param visible_items The number of visible items.
*/
void ui_components_list_scrollbar_draw (int position, int items, int visible_items) {
ui_components_scrollbar_draw(
LIST_SCROLLBAR_X,
@ -114,6 +184,12 @@ void ui_components_list_scrollbar_draw (int position, int items, int visible_ite
);
}
/**
* @brief Draw a dialog box.
*
* @param width The width of the dialog box.
* @param height The height of the dialog box.
*/
void ui_components_dialog_draw (int width, int height) {
int x0 = DISPLAY_CENTER_X - (width / 2);
int y0 = DISPLAY_CENTER_Y - (height / 2);
@ -124,6 +200,12 @@ void ui_components_dialog_draw (int width, int height) {
ui_components_box_draw(x0, y0, x1, y1, DIALOG_BG_COLOR);
}
/**
* @brief Draw a message box with formatted text.
*
* @param fmt The format string.
* @param ... The format arguments.
*/
void ui_components_messagebox_draw (char *fmt, ...) {
char buffer[512];
size_t nbytes = sizeof(buffer);
@ -158,6 +240,14 @@ void ui_components_messagebox_draw (char *fmt, ...) {
rdpq_paragraph_free(paragraph);
}
/**
* @brief Draw the main text with formatted content.
*
* @param align The horizontal alignment.
* @param valign The vertical alignment.
* @param fmt The format string.
* @param ... The format arguments.
*/
void ui_components_main_text_draw (rdpq_align_t align, rdpq_valign_t valign, char *fmt, ...) {
char buffer[1024];
size_t nbytes = sizeof(buffer);
@ -188,6 +278,14 @@ void ui_components_main_text_draw (rdpq_align_t align, rdpq_valign_t valign, cha
}
}
/**
* @brief Draw the actions bar text with formatted content.
*
* @param align The horizontal alignment.
* @param valign The vertical alignment.
* @param fmt The format string.
* @param ... The format arguments.
*/
void ui_components_actions_bar_text_draw (rdpq_align_t align, rdpq_valign_t valign, char *fmt, ...) {
char buffer[256];
size_t nbytes = sizeof(buffer);
@ -218,6 +316,14 @@ void ui_components_actions_bar_text_draw (rdpq_align_t align, rdpq_valign_t vali
}
}
/**
* @brief Draw the tabs.
*
* @param text Array of tab text.
* @param count Number of tabs.
* @param selected Index of the selected tab.
* @param width Width of each tab.
*/
void ui_components_tabs_draw(const char **text, int count, int selected, float width ) {
float starting_x = VISIBLE_AREA_X0;
@ -228,7 +334,6 @@ void ui_components_tabs_draw(const char **text, int count, int selected, float w
// first draw the tabs that are not selected
for(int i=0;i< count;i++) {
if(i != selected) {
ui_components_box_draw(
x,
y,

36
src/menu/ui_components/context_menu.c
View File

@ -1,9 +1,20 @@
/**
* @file context_menu.c
* @brief Context menu component implementation
* @ingroup ui_components
*/
#include "../ui_components.h"
#include "../fonts.h"
#include "../sound.h"
#include "constants.h"
/**
* @brief Get the current submenu.
*
* @param cm Pointer to the context menu component.
* @return component_context_menu_t* Pointer to the current submenu.
*/
static component_context_menu_t *get_current_submenu (component_context_menu_t *cm) {
while (cm->submenu != NULL) {
cm = cm->submenu;
@ -11,7 +22,11 @@ static component_context_menu_t *get_current_submenu (component_context_menu_t *
return cm;
}
/**
* @brief Initialize the context menu component.
*
* @param cm Pointer to the context menu component.
*/
void ui_components_context_menu_init (component_context_menu_t *cm) {
cm->row_selected = -1;
cm->row_count = 0;
@ -22,11 +37,23 @@ void ui_components_context_menu_init (component_context_menu_t *cm) {
}
}
/**
* @brief Show the context menu component.
*
* @param cm Pointer to the context menu component.
*/
void ui_components_context_menu_show (component_context_menu_t *cm) {
cm->row_selected = 0;
cm->submenu = NULL;
}
/**
* @brief Process the context menu actions.
*
* @param menu Pointer to the menu structure.
* @param cm Pointer to the context menu component.
* @return true if the context menu is processed, false otherwise.
*/
bool ui_components_context_menu_process (menu_t *menu, component_context_menu_t *cm) {
if (!cm || (cm->row_selected < 0)) {
return false;
@ -71,6 +98,11 @@ bool ui_components_context_menu_process (menu_t *menu, component_context_menu_t
return true;
}
/**
* @brief Draw the context menu component.
*
* @param cm Pointer to the context menu component.
*/
void ui_components_context_menu_draw (component_context_menu_t *cm) {
if (!cm || (cm->row_selected < 0)) {
return;

23
src/menu/ui_components/file_list.c
View File

@ -1,13 +1,24 @@
/**
* @file file_list.c
* @brief File list component implementation
* @ingroup ui_components
*/
#include <stdlib.h>
#include "../ui_components.h"
#include "../fonts.h"
#include "constants.h"
static const char *dir_prefix = "/";
/**
* @brief Format the file size into a human-readable string.
*
* @param buffer Buffer to store the formatted string.
* @param size Size of the file.
* @return int Number of characters written to the buffer.
*/
static int format_file_size (char *buffer, int64_t size) {
if (size < 0) {
return sprintf(buffer, "unknown");
@ -24,7 +35,13 @@ static int format_file_size (char *buffer, int64_t size) {
}
}
/**
* @brief Draw the file list component.
*
* @param list Pointer to the list of entries.
* @param entries Number of entries in the list.
* @param selected Index of the currently selected entry.
*/
void ui_components_file_list_draw (entry_t *list, int entries, int selected) {
int starting_position = 0;

11
src/menu/ui_components/tabs.c
View File

@ -1,8 +1,13 @@
/**
* @file tabs.c
* @brief Tabs component implementation
* @ingroup ui_components
*/
#include "../ui_components.h"
#include "constants.h"
/* Common tabs used for the main menu */
/** @brief Common tabs used for the main menu */
static const char *tabs[] = {
"Files",
"History",
@ -11,7 +16,7 @@ static const char *tabs[] = {
};
/**
* Draws the common tabs used for the main menu.
* @brief Draws the common tabs used for the main menu.
*
* @param selected The index of the currently selected tab.
*/

56
src/menu/views/text_viewer.c
View File

@ -1,3 +1,9 @@
/**
* @file text_viewer.c
* @brief Text Viewer component implementation
* @ingroup ui_components
*/
#include <stdio.h>
#include <sys/stat.h>
@ -7,23 +13,26 @@
#include "utils/utils.h"
#include "views.h"
#define MAX_FILE_SIZE KiB(128)
/** @brief Text file structure */
typedef struct {
FILE *f;
char *contents;
size_t length;
int lines;
int current_line;
int offset;
bool vertical_scroll_possible;
FILE *f; /**< File pointer */
char *contents; /**< File contents */
size_t length; /**< File length */
int lines; /**< Number of lines */
int current_line; /**< Current line */
int offset; /**< Offset in the file */
bool vertical_scroll_possible; /**< Flag indicating if vertical scroll is possible */
} text_file_t;
static text_file_t *text;
/**
* @brief Perform vertical scroll in the text file.
*
* @param lines Number of lines to scroll.
*/
static void perform_vertical_scroll (int lines) {
if (!text->vertical_scroll_possible) {
return;
@ -52,7 +61,11 @@ static void perform_vertical_scroll (int lines) {
}
}
/**
* @brief Process user actions for the text viewer.
*
* @param menu Pointer to the menu structure.
*/
static void process (menu_t *menu) {
if (menu->actions.back) {
sound_play_effect(SFX_EXIT);
@ -66,6 +79,12 @@ static void process (menu_t *menu) {
}
}
/**
* @brief Draw the text viewer.
*
* @param menu Pointer to the menu structure.
* @param d Pointer to the display surface.
*/
static void draw (menu_t *menu, surface_t *d) {
rdpq_attach(d, NULL);
@ -91,6 +110,9 @@ static void draw (menu_t *menu, surface_t *d) {
rdpq_detach_show();
}
/**
* @brief Deinitialize the text viewer.
*/
static void deinit (void) {
if (text) {
if (text->f) {
@ -104,7 +126,11 @@ static void deinit (void) {
}
}
/**
* @brief Initialize the text viewer.
*
* @param menu Pointer to the menu structure.
*/
void view_text_viewer_init (menu_t *menu) {
if ((text = calloc(1, sizeof(text_file_t))) == NULL) {
return menu_show_error(menu, "Couldn't allocate memory for the text file");
@ -163,6 +189,12 @@ void view_text_viewer_init (menu_t *menu) {
text->vertical_scroll_possible = (text->lines > LIST_ENTRIES);
}
/**
* @brief Display the text viewer.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_text_viewer_display (menu_t *menu, surface_t *display) {
process(menu);