Pileus Git - wmpus/blob - sys.h

   1 /*
   2  * Copyright (c) 2011-2012, Andy Spencer <andy753421@gmail.com>
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  */
  15
  16 /* Windowing system interface:
  17  *
  18  * The sys provides input to the window manager. It creates
  19  * the main loop and responds to input events from the user,
  20  * generally by converting them to a system independent form
  21  * and then passing them to the wm.
  22  *
  23  * The sys also provides the API used by the wm to position
  24  * and control windows. */
  25
  26
  27 /* Window states */
  28 typedef enum {
  29         ST_HIDE,  // completely hidden
  30         ST_SHOW,  // show as regular window
  31         ST_FULL,  // fullscreen (without decorations)
  32         ST_MAX,   // maximized (with decorations)
  33         ST_SHADE, // show titlebar only
  34         ST_ICON,  // iconified/minimized
  35         ST_CLOSE, // close the window
  36 } state_t;
  37
  38 /* Basic window type */
  39 typedef struct win_sys win_sys_t;
  40 typedef struct win_wm  win_wm_t;
  41 typedef struct {
  42         int x, y, z;
  43         int w, h;
  44         state_t    state;
  45         win_sys_t *sys;
  46         win_wm_t  *wm;
  47 } win_t;
  48
  49 /* Generic key codes, also used for some other events
  50  * Keys map to their Unicode value */
  51 typedef int event_t;
  52 enum {
  53         EV_ALERT       = '\a',
  54         EV_BACKSPACE   = '\b',
  55         EV_FORMFEED    = '\f',
  56         EV_NEWLINE     = '\n',
  57         EV_RETURN      = '\r',
  58         EV_TAB         = '\t',
  59         EV_VTAB        = '\v',
  60         EV_SINGLEQUOTE = '\'',
  61         EV_DOUBLEQUOTE = '\"',
  62         EV_BACKSLASH   = '\\',
  63         EV_QUESTION    = '\?',
  64         EV_NONE        = 0xF0000, // unused Unicode space
  65         EV_MOUSE0, EV_MOUSE1, EV_MOUSE2, EV_MOUSE3,
  66         EV_MOUSE4, EV_MOUSE5, EV_MOUSE6, EV_MOUSE7,
  67         EV_LEFT, EV_RIGHT, EV_UP,     EV_DOWN,
  68         EV_HOME, EV_END,   EV_PAGEUP, EV_PAGEDOWN,
  69         EV_F1, EV_F2,  EV_F3,  EV_F4,
  70         EV_F5, EV_F6,  EV_F7,  EV_F8,
  71         EV_F9, EV_F10, EV_F11, EV_F12,
  72         EV_ALT, EV_CTRL, EV_SHIFT, EV_WIN,
  73         EV_ENTER, EV_LEAVE, EV_FOCUS, EV_UNFOCUS,
  74 };
  75
  76 /* Key modifiers, up is for button release */
  77 typedef struct {
  78         unsigned char alt   : 1;
  79         unsigned char ctrl  : 1;
  80         unsigned char shift : 1;
  81         unsigned char win   : 1;
  82         unsigned char up    : 1;
  83 } mod_t;
  84 #define MOD(...)     ((mod_t){__VA_ARGS__})
  85 #define mod2int(mod) (*((unsigned char*)&(mod)))
  86
  87 /* Mouse movement */
  88 typedef struct {
  89         int  x,  y;
  90         int rx, ry;
  91 } ptr_t;
  92 #define PTR(...) ((ptr_t){__VA_ARGS__})
  93
  94
  95 /* Move the window to the specified location and set it's
  96  * geometry. The position and size include borders and
  97  * window decorations. */
  98 void sys_move(win_t *win, int x, int y, int w, int h);
  99
 100 /* Rise the window above all other windows */
 101 void sys_raise(win_t *win);
 102
 103 /* Give keyboard focus to the window and update window
 104  * decorations. */
 105 void sys_focus(win_t *win);
 106
 107 /* Set the windows drawing state */
 108 void sys_show(win_t *win, state_t st);
 109
 110 /* Start watching for an event. The sys subsequently
 111  * calls wm_handle_event whenever the event occurs. */
 112 void sys_watch(win_t *win, event_t ev, mod_t mod);
 113
 114 /* Stop watching an event */
 115 void sys_unwatch(win_t *win, event_t event, mod_t mod);
 116
 117 /* Return a list of windows representing the geometry of the
 118  * physical displays attached to the computer. */
 119 list_t *sys_info(win_t *root);
 120
 121 /* First call, calls wm_insert for each existing window */
 122 win_t *sys_init(void);
 123
 124 /* Starts the main loop */
 125 void sys_run(win_t *root);
 126
 127 /* Exit main loop */
 128 void sys_exit(void);
 129
 130 /* Free all static data, for memory debugging */
 131 void sys_free(win_t *root);