rofi/include/x11-helper.h

270 lines
6.3 KiB
C
Raw Normal View History

2015-07-27 08:17:12 +00:00
#ifndef X11_ROFI_HELPER_H
#define X11_ROFI_HELPER_H
#include <glib.h>
#include <cairo.h>
#include <xcb/xcb.h>
#include <xkbcommon/xkbcommon.h>
2015-02-09 18:35:51 +00:00
#include "xkb.h"
2016-01-07 07:54:24 +00:00
/**
* @defgroup X11Helper X11Helper
* @ingroup HELPERS
* @{
*/
2015-02-09 18:35:51 +00:00
/**
* @param w The xcb_window_t to read property from.
2015-02-09 18:35:51 +00:00
* @param atom The property identifier
*
* Get text property defined by atom from window.
* Support utf8.
*
* @returns a newly allocated string with the result or NULL
*/
2016-03-01 17:11:55 +00:00
char* window_get_text_prop ( xcb_window_t w, xcb_atom_t atom );
2015-02-09 18:35:51 +00:00
/**
2016-10-14 14:46:54 +00:00
* @param w The xcb_window_t to set property on
* @param prop Atom of the property to change
* @param atoms List of atoms to change the property too
2016-11-15 20:54:31 +00:00
* @param count The length of the atoms list.
2016-10-14 14:46:54 +00:00
*
* Set property on window.
2015-02-09 18:35:51 +00:00
*/
2016-10-14 14:46:54 +00:00
void window_set_atom_prop ( xcb_window_t w, xcb_atom_t prop, xcb_atom_t *atoms, int count );
/** For getting the atoms in an enum */
2015-02-09 18:35:51 +00:00
#define ATOM_ENUM( x ) x
2016-10-14 14:46:54 +00:00
/** Get the atoms as strings. */
2015-02-09 18:35:51 +00:00
#define ATOM_CHAR( x ) # x
2016-10-14 14:46:54 +00:00
/** Atoms we want to pre-load */
2016-02-28 14:32:53 +00:00
#define EWMH_ATOMS( X ) \
X ( _NET_WM_WINDOW_OPACITY ), \
X ( I3_SOCKET_PATH ), \
X ( UTF8_STRING ), \
X ( STRING ), \
X ( CLIPBOARD ), \
X ( WM_WINDOW_ROLE ), \
X ( _XROOTPMAP_ID ), \
X ( _MOTIF_WM_HINTS ), \
X ( ESETROOT_PMAP_ID )
2015-02-09 18:35:51 +00:00
2016-10-14 14:46:54 +00:00
/** enumeration of the atoms. */
2015-02-09 18:35:51 +00:00
enum { EWMH_ATOMS ( ATOM_ENUM ), NUM_NETATOMS };
2016-10-14 14:46:54 +00:00
/** atoms as string */
2015-02-09 18:35:51 +00:00
extern const char *netatom_names[];
2016-10-14 14:46:54 +00:00
/** atoms */
extern xcb_atom_t netatoms[NUM_NETATOMS];
2016-10-14 14:46:54 +00:00
/**
* Enumerator describing the different modifier keys.
*/
enum
{
2016-10-14 14:46:54 +00:00
/** Shift key */
X11MOD_SHIFT,
2016-10-14 14:46:54 +00:00
/** Control Key */
X11MOD_CONTROL,
2016-10-14 14:46:54 +00:00
/** Alt key */
X11MOD_ALT,
2016-10-14 14:46:54 +00:00
/** Meta key */
X11MOD_META,
2016-10-14 14:46:54 +00:00
/** Super (window) key */
X11MOD_SUPER,
2016-10-14 14:46:54 +00:00
/** Hyper key */
X11MOD_HYPER,
2016-10-14 14:46:54 +00:00
/** Any modifier */
X11MOD_ANY,
2016-10-14 14:46:54 +00:00
/** Number of modifier keys */
NUM_X11MOD
};
2016-10-14 14:46:54 +00:00
/**
* Structure describing a workarea/monitor.
*/
typedef struct _workarea
2015-02-09 18:35:51 +00:00
{
2016-10-14 14:46:54 +00:00
/** numeric monitor id. */
int monitor_id;
2016-10-14 14:46:54 +00:00
/** if monitor is set as primary monitor. */
int primary;
2016-10-14 14:46:54 +00:00
/** Horizontal location (in pixels) of the monitor. */
int x;
/** Vertical location (in pixels) of the monitor. */
int y;
/** Width of the monitor. */
int w;
/** Height of the monitor */
int h;
2017-01-21 11:58:52 +00:00
int mw, mh;
2016-10-14 14:46:54 +00:00
/** Output name of the monitor, e.g. eDP1 or VGA-1 */
char *name;
2016-10-14 14:46:54 +00:00
/** Pointer to next monitor */
struct _workarea *next;
2015-02-09 18:35:51 +00:00
} workarea;
2016-10-14 14:46:54 +00:00
/**
* @param mon workarea to be filled in.
*
* Fills in #mon with the information about the monitor rofi should show on.
*
* @returns TRUE if monitor is found, FALSE if no monitor could be detected.
*/
int monitor_active ( workarea *mon );
2015-02-09 18:35:51 +00:00
/**
2016-10-14 14:46:54 +00:00
* Release keyboard grab on root window.
2015-02-09 18:35:51 +00:00
*/
2016-03-01 17:11:55 +00:00
void release_keyboard ( void );
2016-10-14 14:46:54 +00:00
/**
* Release pointer grab on root window.
*/
2016-05-09 06:47:28 +00:00
void release_pointer ( void );
2015-02-09 18:35:51 +00:00
/**
* @param w xcb_window_t we want to grab keyboard on.
* @param iters Number of retries.
2015-02-09 18:35:51 +00:00
*
2016-10-14 14:46:54 +00:00
* Grab keyboard.
2015-02-09 18:35:51 +00:00
*
* @return 1 when keyboard is grabbed, 0 not.
*/
int take_keyboard ( xcb_window_t w, int iters );
2016-10-14 14:46:54 +00:00
/**
* @param w xcb_window_t we want to grab mouse on.
* @param iters Number of retries.
2016-10-14 14:46:54 +00:00
*
* Grab mouse.
*
* @return 1 when mouse is grabbed, 0 not.
*/
int take_pointer ( xcb_window_t w, int iters );
2015-02-09 18:35:51 +00:00
/**
* @param mask The mask to canonilize
*
* @return The canonilized mask
*/
unsigned int x11_canonalize_mask ( unsigned int mask );
2016-10-14 14:46:54 +00:00
/**
* @param xkb the xkb structure.
*
* Calculates the mask of all active modifier keys.
*
* @returns the mask describing all active modifier keys.
*/
unsigned int x11_get_current_mask ( xkb_stuff *xkb );
2015-02-09 19:05:30 +00:00
/**
* @param combo String representing the key combo
* @param mod [out] The modifier specified (or AnyModifier if not specified)
* @param key [out] The key specified
2016-07-29 06:32:34 +00:00
* @param release [out] If it should react on key-release, not key-press
2015-02-09 19:05:30 +00:00
*
* Parse key from user input string.
*/
gboolean x11_parse_key ( const char *combo, unsigned int *mod, xkb_keysym_t *key, gboolean *release, GString * );
2015-02-09 18:35:51 +00:00
/**
* Setup several items required.
* * Error handling,
* * Numlock detection
* * Cache
*/
2016-03-01 17:11:55 +00:00
void x11_setup ( xkb_stuff *xkb );
2015-02-14 18:42:04 +00:00
2016-10-14 14:46:54 +00:00
/**
* Depth of visual
*/
extern xcb_depth_t *depth;
/**
* Visual to use for creating window
*/
extern xcb_visualtype_t *visual;
2016-10-14 14:46:54 +00:00
/**
* Color map to use for creating window
*/
extern xcb_colormap_t map;
2016-11-15 07:24:06 +00:00
2015-02-14 18:42:04 +00:00
/**
* This function tries to create a 32bit TrueColor colormap.
* If this fails, it falls back to the default for the connected display.
*/
2016-03-01 17:11:55 +00:00
void x11_create_visual_and_colormap ( void );
2015-02-14 18:42:04 +00:00
/**
* Gets a surface containing the background image of the desktop.
*
2016-07-29 06:32:34 +00:00
* @returns a cairo surface with the background image of the desktop.
*/
cairo_surface_t * x11_helper_get_bg_surface ( void );
2016-11-15 07:24:06 +00:00
/**
* Gets a surface for the root window of the desktop.
*
* Can be used to take screenshot.
*
* @returns a cairo surface for the root window of the desktop.
*/
cairo_surface_t *x11_helper_get_screenshot_surface ( void );
/**
* Creates an internal represenation of the available monitors.
* Used for positioning rofi.
*/
void x11_build_monitor_layout ( void );
2016-10-14 14:46:54 +00:00
/**
* Dump the monitor layout to stdout.
*/
void x11_dump_monitor_layout ( void );
2016-10-14 14:46:54 +00:00
/**
* @param mask the mask to check for key
* @param key the key to check in mask
*
* Check if key is in the modifier mask.
*
* @returns TRUE if key is in the modifier mask
*/
int x11_modifier_active ( unsigned int mask, int key );
/**
* @param window The X11 window to modify
*
* Set the right hints to disable the window decoration.
* (Set MOTIF_WM_HINTS, decoration field)
*/
void x11_disable_decoration ( xcb_window_t window );
2017-03-11 12:20:46 +00:00
/**
* List of window managers that need different behaviour to functioning.
*/
2017-03-04 18:41:06 +00:00
typedef enum
{
/** Default EWHM compatible window manager */
2017-03-04 18:41:06 +00:00
WM_EWHM = 0,
/** I3 Window manager */
2017-03-04 18:41:06 +00:00
WM_I3 = 1,
/** Awesome window manager */
2017-03-04 18:41:06 +00:00
WM_AWESOME = 2,
2017-02-18 09:47:53 +00:00
/** Openbox window manager */
2017-03-04 18:41:06 +00:00
WM_OPENBOX = 4
} WindowManager;
/**
* Indicates the current window manager.
* This is used for work-arounds.
*/
extern WindowManager current_window_manager;
/**
* discover the window manager.
*/
void x11_helper_discover_window_manager ( void );
2016-01-07 07:54:24 +00:00
/*@}*/
2015-02-09 18:35:51 +00:00
#endif