* that thrones over enough space to fit them in; failing that, they are placed
* to the right of the window with the rightmost border.
*
- * Functions that return uint8_t return these error codes:
- * 0 - success
- * 1 - memory allocation error
- * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
- *
- * TODO: Expose less internals to the API.
- *
* TODO: Think up a more intuitive window positioning algorithm or at least make
* the chain that windows are positioned by visible.
*/
#ifndef WINDOWS_H
#define WINDOWS_H
-
-
#include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
#include <ncurses.h> /* for the WINDOW and chtype typedefs */
#include "yx_uint16.h" /* for yx_uint16 struct */
struct yx_uint16 center; /* window content center to focus window on */
char * title; /* title to be used in window title bar */
void (* draw) (struct Win *); /* how to draw window content ("data") */
- void * data; /* window content to be drawn by _draw() */
chtype * winmap; /* sequence of cells, sorted into lines ... */
struct yx_uint16 winmapsize; /* ... with these geometry infos */
};
* initialized 0, except for the virtual screen (height = that of the terminal
* screen; width = 1) sized to the size of the terminal screen.
*/
-extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta ** wmeta);
+extern void init_win_meta(WINDOW * screen);
/* Initialize a window child of "wmeta" to "title", "height" and "width" and
- * appointing "func"() to interpret and draw the content stored at "data" when
- * the window is visible.
+ * appointing "func"() to interpret and draw the window when it's visible.
*
* Pass 0 for "width" to make the window as wide as the terminal screen. Pass
* negative values for "width" to make the width so many cells smaller than that
*
* Other members of the Win struct are initialized to 0.
*/
-extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title,
- int16_t height, int16_t width,
- void * data, void * func);
-
-
+extern void init_win(struct Win ** wp, char * title, int16_t height,
+ int16_t width, void * func);
/* Free allocated memory for an initialized Win / WinMeta structs. */
-extern void free_winmeta(struct WinMeta * wmeta);
+extern void free_winmeta();
extern void free_win(struct Win * win);
-
-
/* Append/suspend window "w" to/from chain of visible windows below "wmeta".
* Appended windows will become active. Suspended active windows will move the
* active window selection to their successor in the window chain or, failing
* that, their predecessor; if no window remains, none will be active.
*/
-extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w);
-extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w);
-
-
+extern void append_win(struct Win * w);
+extern void suspend_win(struct Win * w);
/* Apply scrolling offset "new_offset" to virtual screen if it is sane, i.e.
* it's equal/greater zero and does not push the view (further) beyond the
* border due to it having shrunk after suspension of windows, only allow view
* movement leftwards.
*/
-extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
-
-
+extern void reset_pad_offset(uint16_t new_offset);
/* Apply new size "size" to the active window, but only if it provides for at
* least one cell width/height and is in height at least one cell smaller than
* the screen's vertical height (to provide space for the title bar). Does
* nothing if no window is active.
*/
-extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
-
-
+extern void resize_active_win(struct yx_uint16 size);
/* 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.
* Does nothing if no window is active.
*/
-extern void cycle_active_win(struct WinMeta * wmeta, char dir);
-
-
+extern void cycle_active_win(char dir);
/* Move active window forwards ("dir" == "f") or backwards (any other "dir").
* Wrap around in the window chain if start / end of it is met. Does nothing if
* no window is active.
*/
-extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
-
-
+extern void shift_active_win(char dir);
/* Draw virtual screen including all windows. Also add scroll hints for where
* the edges of the terminal screen hit non-edges of and inside the virtual
* screen. Then update the terminal screen.
*/
-extern uint8_t draw_all_wins(struct WinMeta * wm);
+extern void draw_all_wins();
projects / plomrogue / blobdiff