/* src/client/wincontrol.h
*
- * Routines that build on top of the windows library to provide a simple window
- * management API to the game. Also helps managing window-specific keybindings.
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
+ *
+ * Window manipulation functions directly called by user actions.
*/
#ifndef WINCONTROL_H
#define WINCONTROL_H
-#include <stdint.h> /* uint8_t, int16_t */
-#include "keybindings.h" /* struct KeyBindingDB */
-#include "../common/yx_uint16.h" /* yx_uint16 struct */
-struct Win;
-
-
-
-struct WinConfDB
-{
- struct WinConf * winconfs;
- char * ids;
- char * order; /* order of visible windows (identified by IDs) */
- char active; /* id of window selected as active */
-};
-
-/* Window's configuration (like geometry, keybindings) and the Win itself. */
-struct WinConf
-{
- struct Win * win; /* Window / Win struct configured by this WinConf. */
- struct KeyBindingDB kb; /* Window-specific keybindings. */
- struct yx_uint16 center; /* Designated Win.center */
- int16_t height; /* Designated height to pass to init_win(). */
- int16_t width; /* Designated width to pass to init_win(). */
- uint8_t height_type; /* 0: read .height/.width as size in positive cells; */
- uint8_t width_type; /* 1: as negative diff in cells to the screen size. */
- uint8_t view; /* 0: use .draw as Win.draw; 1/2: use draw_winconf()_(1/2). */
- char id; /* Identifier of WinConf, also identifies Win.draw function. */
- char * title; /* Designated title to pass to init_win(). */
-};
-
-
-
-/* Get WinConf fathering "win" / get Win of WinConf of "id". */
-extern struct WinConf * get_winconf_by_win(struct Win * win);
-extern struct Win * get_win_by_id(char id);
-/* Free all WinConf DB data. */
-extern void free_winconfs();
-/* Initialize Win structs for WinConfs in WinConf database. */
-extern void init_wins();
+/* Toggle display of a window of "id". */
+extern void toggle_window(char id);
-/* Toggle windows in order set by world.win_order. Point active window selection
- * to window identified by world.winconf_db.active.
+/* Toggle "window configuration" view for active window. Sets sensible .center
+ * values for each configuration view (for winconf_geometry: y=0, x=0; for
+ * winconf_keys: x=0 (y is set by draw_winconf_keybindings()); stores default
+ * view's .center in .target_center to return to it when toggling back.
*/
-extern void sorted_win_toggle_and_activate();
-
-/* Read/write world.win_order and world.winconf_db.active from/to "file". */
-extern void read_order_wins_visible_active(char * line, uint32_t linemax, FILE * file);
-extern void write_order_wins_visible_active(FILE * file, char * delim);
-
-/* Iterate over chars of world.winconf_db.winconf_ids array. Restart after \0.*/
-extern char get_next_winconf_id();
+extern void toggle_winconfig();
-/* Read/write individual WinConf (identified by "c") from/to file. */
-extern uint8_t read_winconf_from_file(char * line, uint32_t linemax, FILE * file);
-extern void write_winconf_of_id_to_file(FILE * file, char c, char * delim);
+/* Toggle active window's .target_(height/width)_type ("axis" = "y": height;
+ * else: width). Don't toggle to .target_width_type of 1 (saving the width as a
+ * diff to the .t_screen's width) if window's width is larger than .t_screen's
+ * width, for such width is better saved directly with .target_width_type of 0.
+ */
+extern void toggle_win_size_type(char axis);
-/* Toggle "window configuration" view for active window. Sets sensible
- * Win.center values for the various configuration views (for winconf_geometry:
- * y=0, x=0; for winconf_keys: x=0 (y is set by draw_winconf_keybindings()).
+/* Toggle window's line break type. (0: line breaks only at newlines; 1:
+ * linebreaks at newlines and when the text hits the right window border; 2:
+ * linebreaks only when the text hits the right window border, newlines are
+ * replaced by another string).
*/
-extern void toggle_winconfig();
+extern void toggle_linebreak_type();
-/* Toggle WinConf.(height/width)_type ("axis" = "y": height; else: width). Avoid
- * positive diff to screen width (value would be wrongly read as a non-diff),
- * width_type toggles to 1 only if world.wmeta->screen's width >= WinConf.width.
+/* Grow or shrink active window horizontally ("change" = "*"/"_") or vertically
+ * ("change" = "+"/"-") if the new size was at least 1x1, the height at least
+ * one cell smaller than .v_screen's vertical hight (to provide space for the
+ * title bar) and the width max. (2^16) - 1 cells. If a new window width would
+ * surpass that of .t_screen, set active window's .target_width_type to 0.
*/
-extern void toggle_win_size_type(char axis);
+extern void resize_active_win(char c);
-/* Toggle display of a window identified by "id". */
- extern void toggle_window(char id);
+/* Move active window forwards ("dir" == "f") or backwards (any other "dir") in
+ * window chain. Wrap around in the window chain if start / end of it is met.
+ */
+extern void shift_active_win(char dir);
-/* Try scrolling virtual screen left ("dir" = "-") or right ("dir" = "+") to the
- * degree allowed by the window manager's reset_pad_offset().
+/* Sroll .v_screen one cell to the left if "dir" is "-" and .v_screen_offset is
+ * more than 1, or to the right if "dir" is "+" and .v_screen's right edge would
+ * not move (further, if suspension of windows has moved it to the left already)
+ * leftwards to .t_screen's right edge.
*/
-extern void scroll_pad(char dir);
+extern void scroll_v_screen(char dir);
-/* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
- * vertically ("change = "+"/"-") by one cell size to the degree allowed by the
- * window manager's resize_active_win(). If a new window width would surpass
- * that of the terminal screen, set WinConf.width_type to 0.
+/* Cycle active window selection forwards ("dir" == "f") or backwards (any
+ * other "dir"). Wrap around in the windows chain if start / end of it is met.
*/
-extern void growshrink_active_window(char change);
+extern void cycle_active_win(char dir);
projects / plomrogue / blobdiff