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 #include <stdint.h> /* for uint8_t, int16_t */
  11 #include "keybindings.h" /* for KeyBiData struct */
  12 #include "yx_uint16.h" /* for yx_uint16 struct */
  13 struct Win;
  14 struct WinMeta;
  15
  16
  17
  18 /* Stores a window's configuration (like geometry, keybindings) and a pointer to
  19  * the respective Win struct itself.
  20  */
  21 struct WinConf
  22 {
  23     char id; /* unique identifier of WinConf, abused as ID for ->win and  */
  24              /* equivalent to the char following its "Win_" conffile name */
  25     struct Win * win; /* window configured by this WinConf */
  26     char * title; /* designated title as passed to init_win() */
  27     int16_t height; /* designated height as interpreted by init_win()*/
  28     int16_t width; /* designated width as interpreted by init_win() */
  29     char draw; /* identifier of designated Win->draw; to be returned to */
  30                /* after toggling window configuration view */
  31     struct yx_uint16 center; /* designated center for Win->draw view; to be */
  32                              /* returned to after toggling winconf view */
  33     uint8_t view; /* 0: use ->draw as Win->draw; 1, 2: 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 Win * win);
  43 extern struct Win * get_win_by_id(char id);
  44
  45 /* Create/initialize (from config files)/free Winconf structs. */
  46 extern void init_winconfs();
  47 extern void free_winconfs();
  48 extern void init_wins();
  49
  50 /* Toggle windows in world.wins in the order desribed by the first line of
  51  * config/windows/toggle_order_and_active, wherein each character should
  52  * correspond to one window whose ID is found in world.winconf_ids. Unknown
  53  * characters are silently ignored. The first character of the second line of
  54  * the file is also read to determine which window to focus as active (but only
  55  * if it fits the ID of a window thus toggled visible).
  56  */
  57 extern void sorted_wintoggle_and_activate();
  58
  59 /* Save all window's configurations to their configuration files. */
  60 extern void save_win_configs();
  61
  62 /* Toggle "window configuration" view for active window. This also sets sensible
  63  * values for Win->center for the various configuration views (y=0, x=0 for
  64  * winconf_geometry and x= for winconf_keys).
  65  */
  66 extern void toggle_winconfig();
  67
  68 /* Toggle interpretation type for active Win's width/height in WinConf. Width
  69  * only toggles to 1 if terminal window is at least as wide as WinConf->width.
  70  */
  71 extern void toggle_win_height_type();
  72 extern void toggle_win_width_type();
  73
  74 /* Toggle display of a window identified by "id". */
  75 extern void toggle_window(char id);
  76
  77 /* Try to scroll virtual screen left ("dir" = "-") or right ("dir" = "+"),
  78  * subject to the limitations provided by the window manager via
  79  * reset_pad_offset().
  80  */
  81 extern void scroll_pad(char dir);
  82
  83 /* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
  84  * vertically ("change = "+"/"-") by one cell size, subject to the limitations
  85  * provided by the window manager via resize_active_win().
  86  *
  87  * Forces WinConf->width_type = 0 if new width surpasses that of terminal win.
  88  */
  89 extern void growshrink_active_window(char change);
  90
  91
  92
  93 #endif