plomlompom.com Git - plomrogue/blob - src/wincontrol.h

   1 /* wincontrol.h
   2  *
   3  * Routines that build on top of the windows library to provide a simple window
   4  * management API to the game.
   5  */
   6
   7 #ifndef WINCONTROL_H
   8 #define WINCONTROL_H
   9
  10
  11
  12 #include <stdint.h> /* for uint8_t, int16_t */
  13 #include "keybindings.h" /* for KeyBiData struct */
  14 struct Win;
  15 struct WinMeta;
  16 struct World;
  17
  18
  19
  20 /* Stores a window's configuration (like geometry, keybindings) and a pointer to
  21  * the respective Win struct itself.
  22  */
  23 struct WinConf
  24 {
  25     char id; /* unique identifier of WinConf, abused as ID for ->win and  */
  26              /* equivalent to the char following its "Win_" conffile name */
  27     struct Win * win; /* window configured by this WinConf */
  28     char * title; /* designated title as passed to init_win() */
  29     int16_t height; /* designated height as interpreted by init_win()*/
  30     int16_t width; /* designated width as interpreted by init_win() */
  31     char draw; /* identifier of designated Win->_draw; to be returned to */
  32                /* after toggling window configuration view */
  33     uint8_t view; /* 0: use ->draw as Win->_draw; 1: use draw_winconf()*/
  34     uint8_t height_type; /* both: 0: interpret ->height/->width as size in   */
  35     uint8_t width_type;  /* positive cells; 1: as negative diff to max width */
  36     struct KeyBiData kb; /* the window's specific keybindings */
  37 };
  38
  39
  40
  41 /* Get WinConf fathering "win"; get Win of WinConf of "id". */
  42 extern struct WinConf * get_winconf_by_win(struct World * world,
  43                                            struct Win * win);
  44 extern struct Win * get_win_by_id(struct World * world, char id);
  45
  46
  47
  48 /* Create/initialize (from config files)/free Winconf structs. */
  49 extern void init_winconfs(struct World * world);
  50 extern void free_winconfs(struct World * world);
  51 extern void init_wins(struct World * world);
  52
  53
  54
  55 /* Toggle windows in world->wins in the order desribed by the first line of
  56  * config/windows/toggled_win_order, wherein each character should correspond to
  57  * one window the ID of which is found in world->winconf_ids. Unknown characters
  58  * are silently ignored.
  59  */
  60 extern void sorted_wintoggle(struct World * world);
  61
  62 /* Reload windows in order and sizes defined in win config. */
  63 extern void reload_win_config(struct World * world);
  64
  65 /* Save all window's configurations to their configuration files. */
  66 extern void save_win_configs(struct World * world);
  67
  68
  69
  70 /* Toggle "window configuration" view for "win". */
  71 extern void toggle_winconfig(struct World * world, struct Win * win);
  72
  73 /* Toggle interpretation type for Win's width/height of Win in WinConf. Width
  74  * only toggles to 1 if terminal window is at least as wide as WinConf->width.
  75  */
  76 extern void toggle_win_height_type(struct World * world, struct Win * win);
  77 extern void toggle_win_width_type(struct World * world, struct Win * win);
  78
  79
  80
  81 /* Toggle display of a window "win".
  82  *
  83  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
  84  */
  85 extern uint8_t toggle_window(struct WinMeta * win_meta, struct Win * win);
  86
  87
  88
  89 /* Try to scroll virtual screen left ("dir" = "-") or right ("dir" = "+"),
  90  * subject to the limitations provided by the window manager via
  91  * reset_pad_offset().
  92  */
  93 extern void scroll_pad(struct WinMeta * win_meta, char dir);
  94
  95
  96
  97 /* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
  98  * vertically ("change = "+"/"-") by one cell size, subject to the limitations
  99  * provided by the window manager via resize_active_win().
 100  *
 101  * Forces WinConf->width_type = 0 if new width surpasses that of terminal win.
 102  *
 103  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
 104  */
 105 extern uint8_t growshrink_active_window(struct World * world, char change);
 106
 107
 108
 109 #endif