/* NetHack 5.0	winX.h	$NHDT-Date: 1740795096 2025/02/28 18:11:36 $  $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.65 $ */
/* Copyright (c) Dean Luick, 1992                                 */
/* NetHack may be freely redistributed.  See license for details. */

/*
 * Definitions for the X11 window-port.  See doc/window.txt for details on
 * the window interface.
 */
#ifndef WINX_H
#define WINX_H

#ifndef COLOR_H
#include "color.h"      /* CLR_MAX */
#endif
#ifndef WINTYPE_H
#include "wintype.h"    /* winid */
#endif

#if defined(BOS) || defined(NHSTDC)
#define DIMENSION_P int
#else
#ifdef WIDENED_PROTOTYPES
#define DIMENSION_P unsigned int
#else
#define DIMENSION_P Dimension
#endif
#endif

/* winX.c uses XtOffset() and the way that that macro is defined in
   <X11/Intrinsic.h> triggers "performing pointer subtraction with
   a null pointer has undefined behavior" warnings; this modified
   edition doesn't guarantee defined behavior but does silence those
   warnings without needing to know whether current compiler version
   supports the '-Wno-null-pointer-subtraction' option */
#ifdef XtOffset
#undef XtOffset
#define XtOffset(p_type,field) \
    ((Cardinal) (((ptrdiff_t) (char *) (&(((p_type) NULL)->field)))     \
                 - ((ptrdiff_t) (char *) NULL)))
#endif

/*
 * Generic text buffer.
 */
#define START_SIZE 512 /* starting text buffer size */
struct text_buffer {
    char *text;
    int text_size;
    int text_last;
    int num_lines;
};

/*
 * Information specific to a map window.
 */
#ifdef ENHANCED_SYMBOLS
typedef uint32 X11_map_symbol;
typedef uint32 X11_color;
#else
typedef char X11_map_symbol;
typedef unsigned char X11_color;
#endif
struct text_map_info_t {
    X11_map_symbol text[ROWNO][COLNO];  /* Actual displayed screen. */
    X11_color colors[ROWNO][COLNO];     /* Color of each character. */
    X11_color framecolors[ROWNO][COLNO];  /* Color of background
                                                 behind text */
    GC color_gcs[CLR_MAX],              /* GC for each color */
        inv_color_gcs[CLR_MAX];         /* GC for each inverse color */
#define copy_gc color_gcs[NO_COLOR]
#define inv_copy_gc inv_color_gcs[NO_COLOR]
#if 0
    /* was else from old textcolor days */
    GC copy_gc,      /* Drawing GC */
        inv_copy_gc; /* Inverse drawing GC */
#endif

    int square_width,  /* Saved font information so      */
        square_height, /*   we can calculate the correct */
        square_ascent, /*   placement of changes.        */
        square_lbearing;

#ifdef ENHANCED_SYMBOLS
    XFontStruct *font;
#endif
};

struct tile_glyph_info_t {
    unsigned short glyph;
    unsigned short tileidx;
    unsigned glyphflags;
    uint32 framecolor;
};

struct tile_map_info_t {
    struct tile_glyph_info_t glyphs[ROWNO][COLNO]; /* Saved glyph numbers. */
    GC white_gc;
    GC black_gc;
    unsigned long image_width; /* dimensions of tile image */
    unsigned long image_height;

    int square_width,  /* Saved tile information so      */
        square_height, /*   we can calculate the correct */
        square_ascent, /*   placement of changes.        */
        square_lbearing;
};

struct map_info_t {
    Dimension viewport_width,     /* Saved viewport size, so we can */
        viewport_height;          /*   clip to cursor on a resize.  */
    coordxy t_start[ROWNO],         /* Starting column for new info. */
        t_stop[ROWNO];            /* Ending column for new info. */

    boolean is_tile; /* true if currently using tiles */
    struct text_map_info_t text_map;
    struct tile_map_info_t tile_map;
};

/*
 * Information specific to a message window.
 */
struct line_element {
    struct line_element *next;
    char *line;     /* char buffer */
    int buf_length; /* length of buffer */
    int str_length; /* length of string in buffer */
};

struct mesg_info_t {
    XFontStruct *fs;                 /* Font for the window. */
    int num_lines;                   /* line count */
    struct line_element *head;       /* head of circular line queue */
    struct line_element *line_here;  /* current drawn line position */
    struct line_element *last_pause; /* point to the line after the prev */
                                     /*     bottom of screen             */
    struct line_element *last_pause_head; /* pointer to head of previous */
                                          /* turn                        */
    GC gc;           /* GC for text drawing */
    int char_width,  /* Saved font information so we can  */
        char_height, /*   calculate the correct placement */
        char_ascent, /*   of changes.                     */
        char_lbearing;
    Dimension viewport_width,  /* Saved viewport size, so we can adjust */
              viewport_height; /*   the slider on a resize.             */
    Boolean dirty;            /* Lines have been added to the window. */
};

/*
 * Information specific to "fancy", "text", or "tty-style" status window.
 * (Tty-style supports status highlighting and effectively makes "text"
 * obsolete.)
 */
struct status_info_t {
    struct text_buffer text; /* Just a text buffer. */
    Pixel fg, bg;          /* foreground and background */
    XFontStruct *fs;       /* Status window font structure. */
    Dimension spacew;      /* width of one space */
    Position x, y[3];      /* x coord (not used), y for up to three lines */
    Dimension wd, ht;      /* width (not used), height (same for all lines) */
    Dimension brd, in_wd;  /* border width, internal width */
};

/*
 * Information specific to a menu window.  First a structure for each
 * menu entry, then the structure for each menu window.
 */
typedef struct x11_mi {
    struct x11_mi *next;
    anything identifier; /* Opaque type to identify this selection */
    long pick_count;     /* specific selection count; -1 if none */
    char *str;           /* The text of the item. */
    int attr;            /* Attribute for the line. */
    int color;           /* Color for the line. */
    boolean selected;    /* Been selected? */
    boolean preselected; /*   in advance?  */
    unsigned itemflags;  /* MENU_ITEMFLAGS_foo */
    char selector;       /* Char used to select this entry. */
    char gselector;      /* Group selector. */
    Widget w;
    int window;
} x11_menu_item;

struct menu {
    x11_menu_item *base;  /* Starting pointer for item list. */
    x11_menu_item *last;  /* End pointer for item list. */
    const char *query;    /* Query string. */
    const char *gacc;     /* Group accelerators. */
    int count;            /* Number of strings. */
    char curr_selector;   /* Next keyboard accelerator to assign, */
                          /*   if 0, then we're out.              */
};

struct menu_info_t {
    struct menu curr_menu; /* Menu being displayed. */
    struct menu new_menu;  /* New menu being built. */

    XFontStruct *fs;           /* Font for the window. */
    long menu_count;           /* number entered by user */
    Dimension line_height;     /* Total height of a line of text. */
    Dimension internal_height; /* Internal height between widget & border */
    Dimension internal_width;  /* Internal width between widget & border */
    short how;                 /* Menu mode PICK_NONE, PICK_ONE, PICK_ANY */
    boolean is_menu;   /* Has been confirmed to being a menu window. */
    boolean is_active; /* TRUE when waiting for user input. */
    boolean is_up;     /* TRUE when window is popped-up. */
    boolean cancelled; /* Menu has been explicitly cancelled. */
    boolean counting;  /* true when menu_count has a valid value */
    boolean permi;
    boolean disable_mcolors; /* disable menucolors */

    int permi_x, permi_y; /* perm_invent window x,y */
    int permi_w, permi_h; /* perm_invent window wid, hei */
};

/*
 * Information specific to a text window.
 */
struct text_info_t {
    struct text_buffer text;
    XFontStruct *fs;        /* Font for the text window. */
    int max_width;          /* Width of widest line so far. */
    int extra_width,        /* Sum of left and right border widths. */
        extra_height;       /* Sum of top and bottom border widths. */
    boolean blocked;        /*  */
    boolean destroy_on_ack; /* Destroy this window when acknowledged. */
#ifdef GRAPHIC_TOMBSTONE
    boolean is_rip; /* This window needs a tombstone. */
#endif
};

/*
 * Basic window structure.
 */
struct xwindow {
    int type;              /* type of nethack window */
    Widget popup;          /* direct parent of widget w or viewport */
    Widget w;              /* the widget that does things */
    Dimension pixel_width; /* window size, in pixels */
    Dimension pixel_height;
    int prevx, cursx; /* Cursor position, only used by    */
    int prevy, cursy; /*   map and "plain" status windows.*/

    boolean nh_colors_inited;
    XColor nh_colors[CLR_MAX];
    XFontStruct *boldfs;       /* Bold font */
    Display *boldfs_dpy;       /* Bold font display */
    char *title;

    union {
        struct map_info_t *Map_info;       /* map window info */
        struct mesg_info_t *Mesg_info;     /* message window info */
        struct status_info_t *Status_info; /* status window info */
        struct menu_info_t *Menu_info;     /* menu window info */
        struct text_info_t *Text_info;     /* menu window info */
    } Win_info;
    boolean keep_window;
};

/* Defines to use for the window information union. */
#define map_information Win_info.Map_info
#define mesg_information Win_info.Mesg_info
#define status_information Win_info.Status_info
#define menu_information Win_info.Menu_info
#define text_information Win_info.Text_info

#define MAX_WINDOWS 20 /* max number of open windows */

#define NHW_NONE 0 /* Unallocated window type.  Must be    */
                   /* different from any other NHW_* type. */

#define NO_CLICK 0 /* No click occurred on the map window. Must */
                   /* be different than CLICK_1 and CLICK_2.    */

#define DEFAULT_MESSAGE_WIDTH 60 /* width in chars of the message window */

#define DISPLAY_FILE_SIZE 35 /* Max number of lines in the default */
                             /* file display window.               */

#define MAX_KEY_STRING 64 /* String size for converting a keypress */
                          /* event into a character(s)             */

#define DEFAULT_LINES_DISPLAYED 12 /* # of lines displayed message window */

/* flags for X11_yn_function_core() */
#define YN_NORMAL     0U /* no flags */
#define YN_NO_LOGMESG 1U /* suppress echo of prompt+response to message window
                          * and dumplog message history */
#define YN_NO_DEFAULT 2U /* don't convert quitchars to 0 or ESC to q/n/def */

/* Window variables (winX.c). */
extern struct xwindow window_list[MAX_WINDOWS];
extern XtAppContext app_context; /* context of application */
extern Widget toplevel;          /* toplevel widget */
extern Atom wm_delete_window;    /* delete window protocol */
extern boolean exit_x_event;     /* exit condition for event loop */
#define EXIT_ON_KEY_PRESS 0 /* valid values for exit_x_event */
#define EXIT_ON_KEY_OR_BUTTON_PRESS 1
#define EXIT_ON_EXIT 2
#define EXIT_ON_SENT_EVENT 3
extern int click_x, click_y, click_button, updated_inventory;
extern boolean plsel_ask_name;

typedef struct {
    Boolean slow;             /* issue prompts between map and message wins */
    Boolean fancy_status;     /* use "fancy" status vs. TTY-style status */
    Boolean autofocus;        /* grab pointer focus for popup windows */
    Boolean message_line;     /* separate current turn mesgs from prev ones */
    Boolean highlight_prompt; /* if 'slow', highlight yn prompts */
    Boolean double_tile_size; /* double tile size */
    String tile_file;         /* name of file to open for tiles */
    String icon;              /* name of desired icon */
    int message_lines;        /* number of lines to attempt to show */
    int extcmd_height_delta;  /* bottom margin for extended command menu */
    String pet_mark_bitmap;   /* X11 bitmap file used to mark pets */
    Pixel pet_mark_color;     /* color of pet mark */
    String pilemark_bitmap;   /* X11 bitmap file used to mark item piles */
    Pixel pilemark_color;     /* color of item pile mark */
#ifdef GRAPHIC_TOMBSTONE
    String tombstone; /* name of XPM file for tombstone */
    int tombtext_x;   /* x-coord of center of first tombstone text */
    int tombtext_y;   /* y-coord of center of first tombstone text */
    int tombtext_dx;  /* x-displacement between tombstone line */
    int tombtext_dy;  /* y-displacement between tombstone line */
#endif
} AppResources;

extern AppResources appResources;
extern void (*input_func)(Widget, XEvent *, String *, Cardinal *);

extern struct window_procs X11_procs;

/* Check for an invalid window id. */
#define check_winid(window) \
    do {                                                        \
        if ((window) < 0 || (window) >= MAX_WINDOWS)            \
            panic("illegal windid [%d] in %s at line %d",       \
                  window, __FILE__, __LINE__);                  \
    } while (0)

/* ### Window.c ### */
extern Font WindowFont(Widget);
extern XFontStruct *WindowFontStruct(Widget);

/* ### dialogs.c ### */
extern Widget CreateDialog(Widget, String, XtCallbackProc, XtCallbackProc);
extern void SetDialogPrompt(Widget, String);
extern String GetDialogResponse(Widget);
extern void SetDialogResponse(Widget, String, unsigned);
extern void positionpopup(Widget, boolean);

/* ### winX.c ### */
extern struct xwindow *find_widget(Widget);
extern XColor get_nhcolor(struct xwindow *, int);
extern void init_menu_nhcolors(struct xwindow *);
extern void load_boldfont(struct xwindow *, Widget);
extern Boolean nhApproxColor(Screen *, Colormap, char *, XColor *);
extern Boolean nhCvtStringToPixel(Display *, XrmValuePtr, Cardinal *,
                                  XrmValuePtr, XrmValuePtr, XtPointer *);
extern void get_window_frame_extents(Widget, long *, long *, long *, long *);
extern void get_widget_window_geometry(Widget, int *, int *, int *, int *);
extern char *fontname_boldify(const char *);
extern Dimension nhFontHeight(Widget);
extern char key_event_to_char(XKeyEvent *);
extern void msgkey(Widget, XtPointer, XEvent *, Boolean *);
extern void highlight_yn(boolean);
extern void nh_XtPopup(Widget, int, Widget);
extern void nh_XtPopdown(Widget);
extern void win_X11_init(int);
extern void find_scrollbars(Widget, Widget, Widget *, Widget *);
extern void nh_keyscroll(Widget, XEvent *, String *, Cardinal *);

/* ### winmesg.c ### */
extern void set_message_slider(struct xwindow *);
extern void create_message_window(struct xwindow *, boolean, Widget);
extern void destroy_message_window(struct xwindow *);
extern void display_message_window(struct xwindow *);
extern void append_message(struct xwindow *, const char *);
extern void set_last_pause(struct xwindow *);

/* ### winmap.c ### */
extern void post_process_tiles(void);
extern void check_cursor_visibility(struct xwindow *);
extern void display_map_window(struct xwindow *);
extern void clear_map_window(struct xwindow *);
extern void map_input(Widget, XEvent *, String *, Cardinal *);
extern void set_map_size(struct xwindow *, Dimension, Dimension);
extern void create_map_window(struct xwindow *, boolean, Widget);
extern void destroy_map_window(struct xwindow *);
extern int x_event(int);

/* ### winmenu.c ### */
extern void menu_delete(Widget, XEvent *, String *, Cardinal *);
extern void menu_key(Widget, XEvent *, String *, Cardinal *);
extern void x11_no_perminv(struct xwindow *);
extern void x11_scroll_perminv(int);
extern void create_menu_window(struct xwindow *);
extern void destroy_menu_window(struct xwindow *);

/* ### winmisc.c ### */
extern XtPointer i2xtp(int);
extern int xtp2i(XtPointer);
extern void ps_key(Widget, XEvent *, String *,
                   Cardinal *); /* player selection action */
extern void race_key(Widget, XEvent *, String *,
                     Cardinal *); /* race selection action */
extern void gend_key(Widget, XEvent *, String *, Cardinal *); /* gender */
extern void algn_key(Widget, XEvent *, String *, Cardinal *); /* alignment */
extern void ec_delete(Widget, XEvent *, String *, Cardinal *);
extern void ec_key(Widget, XEvent *, String *,
                   Cardinal *); /* extended command action */
extern void plsel_quit(Widget, XEvent *, String *,
                       Cardinal *); /* player selection dialog */
extern void plsel_play(Widget, XEvent *, String *,
                       Cardinal *); /* player selection dialog */
extern void plsel_randomize(Widget, XEvent *, String *,
                            Cardinal *); /* player selection dialog */
extern void release_extended_cmds(void);

/* ### winstatus.c ### */
extern void create_status_window(struct xwindow *, boolean, Widget);
extern void destroy_status_window(struct xwindow *);
extern void adjust_status(struct xwindow *, const char *);
extern void null_out_status(void);
extern void check_turn_events(void);

/* ### wintext.c ### */
extern void delete_text(Widget, XEvent *, String *, Cardinal *);
extern void dismiss_text(Widget, XEvent *, String *, Cardinal *);
extern void key_dismiss_text(Widget, XEvent *, String *, Cardinal *);
#ifdef GRAPHIC_TOMBSTONE
extern void rip_dismiss_text(Widget, XEvent *, String *, Cardinal *);
#endif
extern void add_to_text_window(struct xwindow *, int, const char *);
extern void display_text_window(struct xwindow *, boolean);
extern void create_text_window(struct xwindow *);
extern void destroy_text_window(struct xwindow *);
extern void clear_text_window(struct xwindow *);
extern void append_text_buffer(struct text_buffer *, const char *,
                               boolean); /* text buffer routines */
extern void init_text_buffer(struct text_buffer *);
extern void clear_text_buffer(struct text_buffer *);
extern void free_text_buffer(struct text_buffer *);
#ifdef GRAPHIC_TOMBSTONE
extern void calculate_rip_text(int, time_t);
#endif

/* ### winval.c ### */
extern Widget create_value(Widget, const char *);
extern void set_name(Widget, const char *);
extern void set_name_width(Widget, int);
extern int get_name_width(Widget);
extern Widget get_value_widget(Widget);
extern void set_value_width(Widget, int);
extern int get_value_width(Widget);
extern void hilight_value(Widget);
extern void swap_fg_bg(Widget);
extern void set_value(Widget w, const char *new_value);
/* external declarations */
extern char *X11_getmsghistory(boolean);
extern void X11_putmsghistory(const char *, boolean);
extern void X11_init_nhwindows(int *, char **);
extern void X11_player_selection(void);
extern void X11_askname(void);
extern void X11_get_nh_event(void);
extern void X11_exit_nhwindows(const char *);
extern void X11_suspend_nhwindows(const char *);
extern void X11_resume_nhwindows(void);
extern winid X11_create_nhwindow(int);
extern void X11_clear_nhwindow(winid);
extern void X11_display_nhwindow(winid, boolean);
extern void X11_destroy_nhwindow(winid);
extern void X11_curs(winid, int, int);
extern void X11_putstr(winid, int, const char *);
extern void X11_display_file(const char *, boolean);
extern void X11_start_menu(winid, unsigned long);
extern void X11_add_menu(winid, const glyph_info *, const ANY_P *, char,
                         char, int, int, const char *, unsigned int);
extern void X11_end_menu(winid, const char *);
extern int X11_select_menu(winid, int, MENU_ITEM_P **);
extern void X11_mark_synch(void);
extern void X11_wait_synch(void);
#ifdef CLIPPING
extern void X11_cliparound(int, int);
#endif
extern void X11_print_glyph(winid, coordxy, coordxy, const glyph_info *,
                            const glyph_info *);
extern void X11_raw_print(const char *);
extern void X11_raw_print_bold(const char *);
extern int X11_nhgetch(void);
extern int X11_nh_poskey(coordxy *, coordxy *, int *);
extern void X11_nhbell(void);
extern int X11_doprev_message(void);
extern char X11_yn_function_core(const char *, const char *, char, unsigned);
extern char X11_yn_function(const char *, const char *, char);
extern void X11_getlin(const char *, char *);
extern int X11_get_ext_cmd(void);
extern void X11_number_pad(int);
extern void X11_delay_output(void);
extern void X11_status_init(void);
extern void X11_status_finish(void);
extern void X11_status_enablefield(int, const char *, const char *, boolean);
extern void X11_status_update(int, genericptr_t, int, int, int,
                              unsigned long *);

#ifdef GRAPHIC_TOMBSTONE
extern void X11_outrip(winid, int, time_t);
#else
extern void genl_outrip(winid, int, time_t);
#endif

extern void X11_preference_update(const char *);
extern void X11_update_inventory(int);
extern win_request_info *X11_ctrl_nhwindow(winid, int, win_request_info *);

#endif /* WINX_H */
