Various icccm and ewmh properties

[wmpus] / sys.h

diff --git a/sys.h b/sys.h
index a30255994e04d2c3a0004d7d3270129e26a11ea2..60d705efaf03015d0816cf343dad466b1a33a4f6 100644 (file)
--- a/sys.h
+++ b/sys.h
@@ -1,55 +1,62 @@
-typedef struct win_sys win_sys_t;
-typedef struct win_wm  win_wm_t;
-typedef struct {
-       int x, y, z;
-       int w, h;
-       win_sys_t *sys;
-       win_wm_t  *wm;
-} win_t;
-
-typedef enum {
-       // 'char' = unicode,
-       key_alert       = '\a',    // Bell (alert)
-       key_backspace   = '\b',    // Backspace
-       key_formfeed    = '\f',    // Formfeed
-       key_newline     = '\n',    // New line
-       key_return      = '\r',    // Carriage return
-       key_tab         = '\t',    // Horizontal tab
-       key_vtab        = '\v',    // Vertical tab
-       key_singlequote = '\'',    // Single quotation mark
-       key_doublequote = '\"',    // Double quotation mark
-       key_backslash   = '\\',    // Backslash
-       key_question    = '\?',    // Literal question mark
-       key_none        = 0xF0000, // unused unicode space
-       key_mouse0, key_mouse1, key_mouse2, key_mouse3,
-       key_mouse4, key_mouse5, key_mouse6, key_mouse7,
-       key_left, key_right, key_up,     key_down,
-       key_home, key_end,   key_pageup, key_pagedown,
-       key_f1, key_f2,  key_f3,  key_f4,
-       key_f5, key_f6,  key_f7,  key_f8,
-       key_f9, key_f10, key_f11, key_f12,
-} Key_t;
-
-typedef struct {
-       int up    : 1;
-       int alt   : 1;
-       int ctrl  : 1;
-       int shift : 1;
-       int win   : 1;
-} mod_t;
-#define MOD(...) ((mod_t){__VA_ARGS__})
-
-typedef struct {
-       int  x,  y;
-       int rx, ry;
-} ptr_t;
-
-void sys_watch(win_t *win, Key_t key, mod_t mod);
-
+/*
+ * Copyright (c) 2011-2012, Andy Spencer <andy753421@gmail.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ */
+
+/* Windowing system interface:
+ *
+ * The sys provides input to the window manager. It creates
+ * the main loop and responds to input events from the user,
+ * generally by converting them to a system independent form
+ * and then passing them to the wm.
+ *
+ * The sys also provides the API used by the wm to position
+ * and control windows. */
+
+/* Move the window to the specified location and set it's
+ * geometry. The position and size include borders and
+ * window decorations. */
 void sys_move(win_t *win, int x, int y, int w, int h);
 
+/* Rise the window above all other windows */
 void sys_raise(win_t *win);
 
-win_t *sys_init(void);
+/* Give keyboard focus to the window and update window
+ * decorations. */
+void sys_focus(win_t *win);
+
+/* Set the windows drawing state */
+void sys_show(win_t *win, state_t st);
+
+/* Start watching for an event. The sys subsequently
+ * calls wm_handle_event whenever the event occurs. */
+void sys_watch(win_t *win, event_t ev, mod_t mod);
+
+/* Stop watching an event */
+void sys_unwatch(win_t *win, event_t event, mod_t mod);
+
+/* Return a list of windows representing the geometry of the
+ * physical displays attached to the computer. */
+list_t *sys_info(void);
+
+/* First call, calls wm_insert for each existing window */
+void sys_init(void);
+
+/* Starts the main loop */
+void sys_run(void);
+
+/* Exit main loop */
+void sys_exit(void);
 
-void sys_run(win_t *root);
+/* Free all static data, for memory debugging */
+void sys_free(void);