libxdo
Loading...
Searching...
No Matches
xdo.h
Go to the documentation of this file.
1
4#ifndef _XDO_H_
5#define _XDO_H_
6
7#ifndef __USE_XOPEN
8#define __USE_XOPEN
9#endif /* __USE_XOPEN */
10
11#include <sys/types.h>
12#include <X11/Xlib.h>
13#include <X11/X.h>
14#include <unistd.h>
15#include <wchar.h>
16
37#define SIZE_USEHINTS (1L << 0)
38#define SIZE_USEHINTS_X (1L << 1)
39#define SIZE_USEHINTS_Y (1L << 2)
40
49#define CURRENTWINDOW (0)
50
56typedef struct charcodemap {
57 wchar_t key;
58 KeyCode code;
59 KeySym symbol;
60 int group;
61 int modmask;
66
67typedef enum {
68 XDO_FEATURE_XTEST,
69} XDO_FEATURES;
70
74typedef struct xdo {
75
77 Display *xdpy;
78
81
83 charcodemap_t *charcodes;
84
86 int charcodes_len;
87
89 XModifierKeymap *modmap;
90
92 KeySym *keymap;
93
95 int keycode_high; /* highest and lowest keycodes */
96
98 int keycode_low; /* used by this X server */
99
101 int keysyms_per_keycode;
102
105
107 int quiet;
108
110 int debug;
111
114
116
117
122#define SEARCH_TITLE (1UL << 0)
123
128#define SEARCH_CLASS (1UL << 1)
129
134#define SEARCH_NAME (1UL << 2)
135
140#define SEARCH_PID (1UL << 3)
141
146#define SEARCH_ONLYVISIBLE (1UL << 4)
147
153#define SEARCH_SCREEN (1UL << 5)
154
159#define SEARCH_CLASSNAME (1UL << 6)
160
166#define SEARCH_DESKTOP (1UL << 7)
167
168
174typedef struct xdo_search {
175 const char *title;
176 const char *winclass;
177 const char *winclassname;
178 const char *winname;
179 int pid;
182 int screen;
187 enum { SEARCH_ANY, SEARCH_ALL } require;
188
192 unsigned int searchmask;
193
196
198 unsigned int limit;
200
201#define XDO_ERROR 1
202#define XDO_SUCCESS 0
203
212xdo_t* xdo_new(const char *display);
213
222xdo_t* xdo_new_with_opened_display(Display *xdpy, const char *display,
223 int close_display_when_freed);
224
228const char *xdo_version(void);
229
235void xdo_free(xdo_t *xdo);
236
244int xdo_move_mouse(const xdo_t *xdo, int x, int y, int screen);
245
253int xdo_move_mouse_relative_to_window(const xdo_t *xdo, Window window, int x, int y);
254
261int xdo_move_mouse_relative(const xdo_t *xdo, int x, int y);
262
271int xdo_mouse_down(const xdo_t *xdo, Window window, int button);
272
281int xdo_mouse_up(const xdo_t *xdo, Window window, int button);
282
290int xdo_get_mouse_location(const xdo_t *xdo, int *x, int *y, int *screen_num);
291
297int xdo_get_window_at_mouse(const xdo_t *xdo, Window *window_ret);
298
311int xdo_get_mouse_location2(const xdo_t *xdo, int *x_ret, int *y_ret,
312 int *screen_num_ret, Window *window_ret);
313
321int xdo_wait_for_mouse_move_from(const xdo_t *xdo, int origin_x, int origin_y);
322
330int xdo_wait_for_mouse_move_to(const xdo_t *xdo, int dest_x, int dest_y);
331
339int xdo_click_window(const xdo_t *xdo, Window window, int button);
340
349int xdo_click_window_multiple(const xdo_t *xdo, Window window, int button,
350 int repeat, useconds_t delay);
351
363int xdo_enter_text_window(const xdo_t *xdo, Window window, const char *string, useconds_t delay);
364
386int xdo_send_keysequence_window(const xdo_t *xdo, Window window,
387 const char *keysequence, useconds_t delay);
388
394int xdo_send_keysequence_window_up(const xdo_t *xdo, Window window,
395 const char *keysequence, useconds_t delay);
396
402int xdo_send_keysequence_window_down(const xdo_t *xdo, Window window,
403 const char *keysequence, useconds_t delay);
404
416int xdo_send_keysequence_window_list_do(const xdo_t *xdo, Window window,
417 charcodemap_t *keys, int nkeys,
418 int pressed, int *modifier, useconds_t delay);
419
428 int *nkeys);
429
442int xdo_wait_for_window_map_state(const xdo_t *xdo, Window wid, int map_state);
443
444#define SIZE_TO 0
445#define SIZE_FROM 1
446int xdo_wait_for_window_size(const xdo_t *xdo, Window window, unsigned int width,
447 unsigned int height, int flags, int to_or_from);
448
449
459int xdo_move_window(const xdo_t *xdo, Window wid, int x, int y);
460
473int xdo_translate_window_with_sizehint(const xdo_t *xdo, Window window,
474 unsigned int width, unsigned int height,
475 unsigned int *width_ret, unsigned int *height_ret);
476
486int xdo_set_window_size(const xdo_t *xdo, Window wid, int w, int h, int flags);
487
497int xdo_set_window_property(const xdo_t *xdo, Window wid, const char *property,
498 const char *value);
499
506int xdo_set_window_class(const xdo_t *xdo, Window wid, const char *name,
507 const char *_class);
508
512int xdo_set_window_urgency (const xdo_t *xdo, Window wid, int urgency);
513
523int xdo_set_window_override_redirect(const xdo_t *xdo, Window wid,
524 int override_redirect);
525
532int xdo_focus_window(const xdo_t *xdo, Window wid);
533
540int xdo_raise_window(const xdo_t *xdo, Window wid);
541
548int xdo_get_focused_window(const xdo_t *xdo, Window *window_ret);
549
556int xdo_wait_for_window_focus(const xdo_t *xdo, Window window, int want_focus);
557
565int xdo_get_pid_window(const xdo_t *xdo, Window window);
566
576int xdo_get_focused_window_sane(const xdo_t *xdo, Window *window_ret);
577
589int xdo_activate_window(const xdo_t *xdo, Window wid);
590
600int xdo_wait_for_window_active(const xdo_t *xdo, Window window, int active);
601
608int xdo_map_window(const xdo_t *xdo, Window wid);
609
615int xdo_unmap_window(const xdo_t *xdo, Window wid);
616
620int xdo_minimize_window(const xdo_t *xdo, Window wid);
621
628int xdo_reparent_window(const xdo_t *xdo, Window wid_source, Window wid_target);
629
641int xdo_get_window_location(const xdo_t *xdo, Window wid,
642 int *x_ret, int *y_ret, Screen **screen_ret);
643
651int xdo_get_window_size(const xdo_t *xdo, Window wid, unsigned int *width_ret,
652 unsigned int *height_ret);
653
654/* pager-like behaviors */
655
663int xdo_get_active_window(const xdo_t *xdo, Window *window_ret);
664
671int xdo_select_window_with_click(const xdo_t *xdo, Window *window_ret);
672
679int xdo_set_number_of_desktops(const xdo_t *xdo, long ndesktops);
680
688int xdo_get_number_of_desktops(const xdo_t *xdo, long *ndesktops);
689
696int xdo_set_current_desktop(const xdo_t *xdo, long desktop);
697
704int xdo_get_current_desktop(const xdo_t *xdo, long *desktop);
705
713int xdo_set_desktop_for_window(const xdo_t *xdo, Window wid, long desktop);
714
725int xdo_get_desktop_for_window(const xdo_t *xdo, Window wid, long *desktop);
726
735int xdo_search_windows(const xdo_t *xdo, const xdo_search_t *search,
736 Window **windowlist_ret, unsigned int *nwindows_ret);
737
749unsigned char *xdo_get_window_property_by_atom(const xdo_t *xdo, Window window, Atom atom,
750 long *nitems, Atom *type, int *size);
751
763int xdo_get_window_property(const xdo_t *xdo, Window window, const char *property,
764 unsigned char **value, long *nitems, Atom *type, int *size);
765
773unsigned int xdo_get_input_state(const xdo_t *xdo);
774
783const char **xdo_get_symbol_map(void);
784
785/* active modifiers stuff */
786
795 int *nkeys);
796
802int xdo_clear_active_modifiers(const xdo_t *xdo, Window window,
803 charcodemap_t *active_mods,
804 int active_mods_n);
805
811int xdo_set_active_modifiers(const xdo_t *xdo, Window window,
812 charcodemap_t *active_mods,
813 int active_mods_n);
814
821int xdo_get_desktop_viewport(const xdo_t *xdo, int *x_ret, int *y_ret);
822
829int xdo_set_desktop_viewport(const xdo_t *xdo, int x, int y);
830
835int xdo_kill_window(const xdo_t *xdo, Window window);
836
841int xdo_close_window(const xdo_t *xdo, Window window);
842
846#define XDO_FIND_PARENTS (0)
847
851#define XDO_FIND_CHILDREN (1)
852
857int xdo_find_window_client(const xdo_t *xdo, Window window, Window *window_ret,
858 int direction);
859
865int xdo_get_window_name(const xdo_t *xdo, Window window,
866 unsigned char **name_ret, int *name_len_ret,
867 int *name_type);
868
877void xdo_disable_feature(xdo_t *xdo, int feature);
878
887void xdo_enable_feature(xdo_t *xdo, int feature);
888
897int xdo_has_feature(xdo_t *xdo, int feature);
898
906int xdo_get_viewport_dimensions(xdo_t *xdo, unsigned int *width,
907 unsigned int *height, int screen);
908#endif /* ifndef _XDO_H_ */
Definition xdo.h:56
int modmask
the keyboard group that has this key in it
Definition xdo.h:61
int group
the symbol representing this key
Definition xdo.h:60
KeySym symbol
the keycode that this key is on
Definition xdo.h:59
KeyCode code
the letter for this key, like 'a'
Definition xdo.h:58
int needs_binding
the modifiers to apply when sending this key
Definition xdo.h:64
The window search query structure.
Definition xdo.h:174
long desktop
What desktop to search, if any.
Definition xdo.h:195
unsigned int limit
How many results to return? If 0, return all.
Definition xdo.h:198
const char * winclassname
pattern to test against a window class
Definition xdo.h:177
int screen
boolean; set true to search only visible windows
Definition xdo.h:182
enum xdo_search::@0 require
what screen to search, if any.
unsigned int searchmask
bitmask of things you are searching for, such as SEARCH_NAME, etc.
Definition xdo.h:192
int only_visible
depth of search.
Definition xdo.h:181
int pid
pattern to test against a window name
Definition xdo.h:179
const char * winclass
pattern to test against a window title
Definition xdo.h:176
long max_depth
window pid (From window atom _NET_WM_PID)
Definition xdo.h:180
const char * winname
pattern to test against a window class
Definition xdo.h:178
The main context.
Definition xdo.h:74
int debug
Enable debug output?
Definition xdo.h:110
int features_mask
Feature flags, such as XDO_FEATURE_XTEST, etc...
Definition xdo.h:113
int quiet
Be extra quiet? (omits some error/message output)
Definition xdo.h:107
int close_display_when_freed
Should we close the display when calling xdo_free?
Definition xdo.h:104
Display * xdpy
The Display for Xlib.
Definition xdo.h:77
char * display_name
The display name, if any.
Definition xdo.h:80
int xdo_set_desktop_for_window(const xdo_t *xdo, Window wid, long desktop)
Move a window to another desktop Uses _NET_WM_DESKTOP of the EWMH spec.
Definition xdo.c:625
int xdo_kill_window(const xdo_t *xdo, Window window)
Kill a window and the client owning it.
Definition xdo.c:1832
void xdo_disable_feature(xdo_t *xdo, int feature)
Disable an xdo feature.
Definition xdo.c:1923
int xdo_set_window_override_redirect(const xdo_t *xdo, Window wid, int override_redirect)
Set the override_redirect value for a window.
Definition xdo.c:326
int xdo_get_desktop_viewport(const xdo_t *xdo, int *x_ret, int *y_ret)
Get the position of the current viewport.
Definition xdo.c:1772
struct xdo xdo_t
The main context.
int xdo_get_window_size(const xdo_t *xdo, Window wid, unsigned int *width_ret, unsigned int *height_ret)
Get a window's size.
Definition xdo.c:233
int xdo_click_window(const xdo_t *xdo, Window window, int button)
Send a click for a specific mouse button at the current mouse location.
Definition xdo.c:927
int xdo_clear_active_modifiers(const xdo_t *xdo, Window window, charcodemap_t *active_mods, int active_mods_n)
Send any events necessary to clear the active modifiers.
Definition xdo.c:1664
int xdo_get_mouse_location(const xdo_t *xdo, int *x, int *y, int *screen_num)
Get the current mouse location (coordinates and screen number).
Definition xdo.c:863
int xdo_set_window_size(const xdo_t *xdo, Window wid, int w, int h, int flags)
Change the window size.
Definition xdo.c:291
const char ** xdo_get_symbol_map(void)
If you need the symbol map, use this method.
Definition xdo.c:1660
int xdo_get_focused_window_sane(const xdo_t *xdo, Window *window_ret)
Like xdo_get_focused_window, but return the first ancestor-or-self window * having a property of WM_C...
Definition xdo.c:1173
int xdo_get_number_of_desktops(const xdo_t *xdo, long *ndesktops)
Get the current number of desktops.
Definition xdo.c:530
int xdo_map_window(const xdo_t *xdo, Window wid)
Map a window.
Definition xdo.c:168
unsigned int xdo_get_input_state(const xdo_t *xdo)
Get the current input state.
Definition xdo.c:1648
int xdo_move_mouse_relative(const xdo_t *xdo, int x, int y)
Move the mouse relative to it's current position.
Definition xdo.c:795
xdo_t * xdo_new_with_opened_display(Display *xdpy, const char *display, int close_display_when_freed)
Create a new xdo_t instance with an existing X11 Display instance.
Definition xdo.c:99
int xdo_click_window_multiple(const xdo_t *xdo, Window window, int button, int repeat, useconds_t delay)
Send a one or more clicks for a specific mouse button at the current mouse location.
Definition xdo.c:939
int xdo_get_current_desktop(const xdo_t *xdo, long *desktop)
Get the current desktop.
Definition xdo.c:593
int xdo_reparent_window(const xdo_t *xdo, Window wid_source, Window wid_target)
Reparents a window.
Definition xdo.c:182
int xdo_set_active_modifiers(const xdo_t *xdo, Window window, charcodemap_t *active_mods, int active_mods_n)
Send any events necessary to make these modifiers active.
Definition xdo.c:1692
int xdo_unmap_window(const xdo_t *xdo, Window wid)
Unmap a window.
Definition xdo.c:175
void xdo_free(xdo_t *xdo)
Free and destroy an xdo_t instance.
Definition xdo.c:138
int xdo_get_active_window(const xdo_t *xdo, Window *window_ret)
Get the currently-active window.
Definition xdo.c:686
int xdo_send_keysequence_window_up(const xdo_t *xdo, Window window, const char *keysequence, useconds_t delay)
Send key release (up) events for the given key sequence.
Definition xdo.c:1115
int xdo_get_window_name(const xdo_t *xdo, Window window, unsigned char **name_ret, int *name_len_ret, int *name_type)
Get a window's name, if any.
Definition xdo.c:1844
int xdo_has_feature(xdo_t *xdo, int feature)
Check if a feature is enabled.
Definition xdo.c:1927
int xdo_activate_window(const xdo_t *xdo, Window wid)
Activate a window.
Definition xdo.c:459
int xdo_mouse_down(const xdo_t *xdo, Window window, int button)
Send a mouse press (aka mouse down) for a given button at the current mouse location.
Definition xdo.c:859
xdo_t * xdo_new(const char *display)
Create a new xdo_t instance.
Definition xdo.c:83
int xdo_send_keysequence_window_down(const xdo_t *xdo, Window window, const char *keysequence, useconds_t delay)
Send key press (down) events for the given key sequence.
Definition xdo.c:1110
int xdo_get_desktop_for_window(const xdo_t *xdo, Window wid, long *desktop)
Get the desktop a window is on.
Definition xdo.c:656
int xdo_wait_for_window_active(const xdo_t *xdo, Window window, int active)
Wait for a window to be active or not active.
Definition xdo.c:439
int xdo_send_keysequence_window(const xdo_t *xdo, Window window, const char *keysequence, useconds_t delay)
Send a keysequence to the specified window.
Definition xdo.c:1120
int xdo_translate_window_with_sizehint(const xdo_t *xdo, Window window, unsigned int width, unsigned int height, unsigned int *width_ret, unsigned int *height_ret)
Apply a window's sizing hints (if any) to a given width and height.
Definition xdo.c:260
int xdo_wait_for_mouse_move_from(const xdo_t *xdo, int origin_x, int origin_y)
Wait for the mouse to move from a location.
Definition xdo.c:1741
int xdo_set_current_desktop(const xdo_t *xdo, long desktop)
Switch to another desktop.
Definition xdo.c:561
struct xdo_search xdo_search_t
The window search query structure.
int xdo_get_pid_window(const xdo_t *xdo, Window window)
Get the PID owning a window.
Definition xdo.c:1719
int xdo_select_window_with_click(const xdo_t *xdo, Window *window_ret)
Get a window ID by clicking on it.
Definition xdo.c:716
int xdo_get_focused_window(const xdo_t *xdo, Window *window_ret)
Get the window currently having focus.
Definition xdo.c:1131
int xdo_focus_window(const xdo_t *xdo, Window wid)
Focus a window.
Definition xdo.c:392
int xdo_send_keysequence_window_list_do(const xdo_t *xdo, Window window, charcodemap_t *keys, int nkeys, int pressed, int *modifier, useconds_t delay)
Send a series of keystrokes.
Definition xdo.c:1027
int xdo_move_window(const xdo_t *xdo, Window wid, int x, int y)
Move a window to a specific location.
Definition xdo.c:250
int xdo_close_window(const xdo_t *xdo, Window window)
Close a window without trying to kill the client.
Definition xdo.c:1838
int xdo_set_window_class(const xdo_t *xdo, Window wid, const char *name, const char *_class)
Change the window's classname and or class.
Definition xdo.c:337
void xdo_enable_feature(xdo_t *xdo, int feature)
Enable an xdo feature.
Definition xdo.c:1919
int xdo_get_mouse_location2(const xdo_t *xdo, int *x_ret, int *y_ret, int *screen_num_ret, Window *window_ret)
Get all mouse location-related data.
Definition xdo.c:872
int xdo_minimize_window(const xdo_t *xdo, Window wid)
Minimize a window.
Definition xdo.c:1882
int xdo_get_window_at_mouse(const xdo_t *xdo, Window *window_ret)
Get the window the mouse is currently over.
Definition xdo.c:868
int xdo_search_windows(const xdo_t *xdo, const xdo_search_t *search, Window **windowlist_ret, unsigned int *nwindows_ret)
Search for windows.
Definition xdo_search.c:31
int xdo_get_viewport_dimensions(xdo_t *xdo, unsigned int *width, unsigned int *height, int screen)
Query the viewport (your display) dimensions.
Definition xdo.c:1931
int xdo_move_mouse_relative_to_window(const xdo_t *xdo, Window window, int x, int y)
Move the mouse to a specific location relative to the top-left corner of a window.
Definition xdo.c:784
int xdo_enter_text_window(const xdo_t *xdo, Window window, const char *string, useconds_t delay)
Type a string to the specified window.
Definition xdo.c:958
int xdo_wait_for_window_map_state(const xdo_t *xdo, Window wid, int map_state)
Wait for a window to have a specific map state.
Definition xdo.c:156
int xdo_move_mouse(const xdo_t *xdo, int x, int y, int screen)
Move the mouse to a specific location.
Definition xdo.c:770
int xdo_set_number_of_desktops(const xdo_t *xdo, long ndesktops)
Set the number of desktops.
Definition xdo.c:499
unsigned char * xdo_get_window_property_by_atom(const xdo_t *xdo, Window window, Atom atom, long *nitems, Atom *type, int *size)
Generic property fetch.
Definition xdo.c:1430
int xdo_set_window_property(const xdo_t *xdo, Window wid, const char *property, const char *value)
Change a window property.
Definition xdo.c:369
int xdo_raise_window(const xdo_t *xdo, Window wid)
Raise a window to the top of the window stack.
Definition xdo.c:763
int xdo_wait_for_mouse_move_to(const xdo_t *xdo, int dest_x, int dest_y)
Wait for the mouse to move to a location.
Definition xdo.c:1757
int xdo_mouse_up(const xdo_t *xdo, Window window, int button)
Send a mouse release (aka mouse up) for a given button at the current mouse location.
Definition xdo.c:855
int xdo_get_window_location(const xdo_t *xdo, Window wid, int *x_ret, int *y_ret, Screen **screen_ret)
Get a window's location.
Definition xdo.c:189
int xdo_get_active_modifiers(const xdo_t *xdo, charcodemap_t **keys, int *nkeys)
Get a list of active keys.
Definition xdo.c:1604
const char * xdo_version(void)
Return a string representing the version of this library.
Definition xdo.c:152
int xdo_get_window_property(const xdo_t *xdo, Window window, const char *property, unsigned char **value, long *nitems, Atom *type, int *size)
Get property of window by name of atom.
Definition xdo.c:1419
int xdo_set_window_urgency(const xdo_t *xdo, Window wid, int urgency)
Sets the urgency hint for a window.
Definition xdo.c:353
int xdo_wait_for_window_focus(const xdo_t *xdo, Window window, int want_focus)
Wait for a window to have or lose focus.
Definition xdo.c:1148
int xdo_get_active_keys_to_keycode_list(const xdo_t *xdo, charcodemap_t **keys, int *nkeys)
Get a list of active keys.
int xdo_find_window_client(const xdo_t *xdo, Window window, Window *window_ret, int direction)
Find a client window (child) in a given window.
Definition xdo.c:1179
int xdo_set_desktop_viewport(const xdo_t *xdo, int x, int y)
Set the position of the current viewport.
Definition xdo.c:1809