lg_wins.h

/*
 *      LibGame - Copyright (C) Emmanuel Thomas-Maurin 2011-2026
 *      All rights reserved
 */
 
#ifndef LG_WINS_H
#define LG_WINS_H
 
/* A few helpers for wins funcs: */
#define BLOCK           TRUE
#define NO_BLOCK        (!BLOCK)
 
#define WITH_FRAME      TRUE
#define NO_FRAME        (!WITH_FRAME)
 
#define SWAP_FB         TRUE
#define NO_SWAP         (!SWAP_FB)
 
#define LOG             TRUE
#define NO_LOG          (!LOG)
 
#if defined(LINUX_V) || defined(WIN32_V)
  #define PRESS_OR_TAP_ANYTHING         "Press any key ..."
#elif defined(ANDROID_V)
  #define PRESS_OR_TAP_ANYTHING         "Tap anywhere to continue ..."
#endif
 
/* Fully transparent colors actually */
#define UNUSED_SDL_COLOR                ((SDL_Color){0, 0, 0, 0})
#define UNUSED_LG_COLOR_U               ((LG_Color_u){0, 0, 0, 0})
 
#define H_PADDING                       12
#define V_PADDING                       8
#define BORDER_WIDTH                    2
 
#define LG_WIN_N_LINES_MAX              200
 
#define LG_LEFT_MARGIN                  5
#define LG_BOTTOM_MARGIN                5
 
#define SCROLL_V_SHIFT_IN_PIXELS        8
 
#define TIMESTAMP_MAXLEN                (64 - 1)
 
typedef struct {
        int             id;                                     /* (So far) 0 -> OK, -1 -> invalid win */
        LG_Texture      *tex;                                   /* Used inside new/open/free_win(), don't modify elsewhere */
        uint32_t        tex_w;
        uint32_t        tex_h;
        int             last_open_x;                            /* Set by lg_win_open() */
        int             last_open_y;                            /* Set by lg_win_open() */
        Rec2Di          layout_rec[LG_WIN_N_LINES_MAX];         /* Clickable areas for menu items */
        uint32_t        h_margin;
        uint32_t        v_margin;
        Rec2Di          visible_area;
        char            timestamp[TIMESTAMP_MAXLEN + 1];
} LG_Window;
 
/* UD_FONTNAME_MAX_LEN is defined in lg_fonts.h */
 
typedef struct {
        zboolean        with_frame;
        LG_Color_u      text_color;
        LG_Color_u      bg_color;
        LG_Color_u      border_color;
        LG_Color_u      highlight_text_color;                   /* Should be highlighted_text_color */
        LG_Color_u      highlight_bg_color;                     /* Should be highlighted_bg_color */
        int             frame_line;                             /* NONE, TZW_RECTANGLE, or TZW_RECT_CORNERS */
        LG_Color_u      frame_line_color;
        char            ud_font_name[UD_FONTNAME_MAX_LEN + 1];  /* User-defined name, like "dejavu_sans_bold_18" */
} LG_Win_Style;
 
/* lg_menu_win() global extra params, all initialized to FALSE or NULL */
typedef struct {
        zboolean        with_frame;
        zboolean        loop;
        zboolean        no_swap;                /* No swap and no bg draw */
        LG_Texture      *orig_bg;               /* (if !no_swap) lg_take_screenshot(); */
        zboolean        disable_h_arrows;       /* Left and right arrows */
} LG_MenuWinParams;
 
typedef struct {
        const char      *str;
        void            (*func)();
} LG_ActionFunc;
 
typedef struct {
        const char      *str;
        int             (*func)();
} LG_ActionFunc2;
 
#define MENUWIN_KEY_ESC         (-1)
#define MENUWIN_KEY_LEFT        (-2)
#define MENUWIN_KEY_RIGHT       (-3)
#define MENUWIN_KEY_SPACE       (-4)
#define MENUWIN_ERROR           (-5)
 
typedef enum {MENUWIN_CONTINUE, MENUWIN_CLOSE, MENUWIN_EXIT, MENUWIN_SPACE_PRESSED} menuwin_exit;
 
/* TZW stuff used in lg_ui.c/h */
#define N_TZW_MAX       1024
 
typedef struct {
        LG_Window       win;
        LG_Color_u      color;
        Rec2Di          area;
} LG_TouchZoneWindow;
 
/* Array of all TZ wins for one frame */
typedef struct {
        LG_TouchZoneWindow      *tzw[N_TZW_MAX];
} LG_TZW_Array;
 
void                    lg_info_win(LG_Win_Style *style, const char *format, ...);                      /* Swap fb */
 
void                    lg_info_win_no_block(zboolean, zboolean, const char *);                         /* May swap fb */
 
void                    lg_error_win(LG_Win_Style *style, zboolean log, const char *format, ...);       /* Swap fb */
 
int                     lg_question_win(LG_Win_Style *, const char *, ...);                             /* Swap fb */
 
char                    *lg_entry_win(LG_Win_Style *, int, int, const char *);                          /* Swap fb */
 
int                     lg_win_open_centered(LG_Window *, uint32_t *);
 
LG_Window               lg_win(const char *, LG_Color_u, LG_Color_u, zboolean, LG_Color_u, TTF_Font *, int, LG_Color_u, LG_Color_u);
 
LG_MenuWinParams        *lg_get_menu_wins_params();
 
int                     lg_menu_win(const char *, LG_Color_u, LG_Color_u, LG_Color_u, LG_Color_u, TTF_Font *, int, int, int);   /* May swap fb */
 
char                    *lg_action_func_to_str(LG_ActionFunc []);
 
char                    *lg_action_func_to_str2(LG_ActionFunc2 []);
 
void                    lg_scrollable_win(LG_Win_Style *, int, int, int,  const char *);
 
void                    lg_set_scrolling_v_shift(uint32_t);
 
void                    lg_reset_scrolling_v_shift();
 
void                    lg_win_show_annoying_errors();
 
void                    lg_win_no_annoying_errors();
 
int                     lg_win_open(LG_Window *, int, int, uint32_t *);
 
int                     lg_win_close(LG_Window *);
 
void                    lg_win_free_tex(LG_Window *);
 
zboolean                is_lg_win(LG_Window *);
 
Rec2Di                  lg_get_centered_win_rec(LG_Window *);
 
int                     lg_win_get_w(LG_Window *);
 
int                     lg_win_get_h(LG_Window *);
 
int                     lg_text_get_n_lines(const char *);
 
char                    *lg_text_format_for_win(const char *, TTF_Font *);
 
char                    *lg_wrap_lines(const char *, TTF_Font *, int);
 
#endif /* LG_WINS_H */