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