libxdo
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 
56 typedef struct charcodemap {
57  wchar_t key;
58  KeyCode code;
59  KeySym symbol;
60  int group;
61  int modmask;
66 
67 typedef enum {
68  XDO_FEATURE_XTEST,
69 } XDO_FEATURES;
70 
74 typedef struct xdo {
75 
77  Display *xdpy;
78 
80  char *display_name;
81 
83  charcodemap_t *charcodes;
84 
86  int charcodes_len;
87 
89  int keycode_high; /* highest and lowest keycodes */
90 
92  int keycode_low; /* used by this X server */
93 
95  int keysyms_per_keycode;
96 
99 
101  int quiet;
102 
104  int debug;
105 
108 
109 } xdo_t;
110 
111 
116 #define SEARCH_TITLE (1UL << 0)
117 
122 #define SEARCH_CLASS (1UL << 1)
123 
128 #define SEARCH_NAME (1UL << 2)
129 
134 #define SEARCH_PID (1UL << 3)
135 
140 #define SEARCH_ONLYVISIBLE (1UL << 4)
141 
147 #define SEARCH_SCREEN (1UL << 5)
148 
153 #define SEARCH_CLASSNAME (1UL << 6)
154 
160 #define SEARCH_DESKTOP (1UL << 7)
161 
162 
168 typedef struct xdo_search {
169  const char *title;
170  const char *winclass;
171  const char *winclassname;
172  const char *winname;
173  int pid;
174  long max_depth;
176  int screen;
181  enum { SEARCH_ANY, SEARCH_ALL } require;
182 
186  unsigned int searchmask;
187 
189  long desktop;
190 
192  unsigned int limit;
193 } xdo_search_t;
194 
195 #define XDO_ERROR 1
196 #define XDO_SUCCESS 0
197 
206 xdo_t* xdo_new(const char *display);
207 
216 xdo_t* xdo_new_with_opened_display(Display *xdpy, const char *display,
217  int close_display_when_freed);
218 
222 const char *xdo_version(void);
223 
229 void xdo_free(xdo_t *xdo);
230 
238 int xdo_move_mouse(const xdo_t *xdo, int x, int y, int screen);
239 
247 int xdo_move_mouse_relative_to_window(const xdo_t *xdo, Window window, int x, int y);
248 
255 int xdo_move_mouse_relative(const xdo_t *xdo, int x, int y);
256 
265 int xdo_mouse_down(const xdo_t *xdo, Window window, int button);
266 
275 int xdo_mouse_up(const xdo_t *xdo, Window window, int button);
276 
284 int xdo_get_mouse_location(const xdo_t *xdo, int *x, int *y, int *screen_num);
285 
291 int xdo_get_window_at_mouse(const xdo_t *xdo, Window *window_ret);
292 
305 int xdo_get_mouse_location2(const xdo_t *xdo, int *x_ret, int *y_ret,
306  int *screen_num_ret, Window *window_ret);
307 
315 int xdo_wait_for_mouse_move_from(const xdo_t *xdo, int origin_x, int origin_y);
316 
324 int xdo_wait_for_mouse_move_to(const xdo_t *xdo, int dest_x, int dest_y);
325 
333 int xdo_click_window(const xdo_t *xdo, Window window, int button);
334 
343 int xdo_click_window_multiple(const xdo_t *xdo, Window window, int button,
344  int repeat, useconds_t delay);
345 
357 int xdo_enter_text_window(const xdo_t *xdo, Window window, const char *string, useconds_t delay);
358 
380 int xdo_send_keysequence_window(const xdo_t *xdo, Window window,
381  const char *keysequence, useconds_t delay);
382 
388 int xdo_send_keysequence_window_up(const xdo_t *xdo, Window window,
389  const char *keysequence, useconds_t delay);
390 
396 int xdo_send_keysequence_window_down(const xdo_t *xdo, Window window,
397  const char *keysequence, useconds_t delay);
398 
410 int xdo_send_keysequence_window_list_do(const xdo_t *xdo, Window window,
411  charcodemap_t *keys, int nkeys,
412  int pressed, int *modifier, useconds_t delay);
413 
422  int *nkeys);
423 
436 int xdo_wait_for_window_map_state(const xdo_t *xdo, Window wid, int map_state);
437 
438 #define SIZE_TO 0
439 #define SIZE_FROM 1
440 int xdo_wait_for_window_size(const xdo_t *xdo, Window window, unsigned int width,
441  unsigned int height, int flags, int to_or_from);
442 
443 
453 int xdo_move_window(const xdo_t *xdo, Window wid, int x, int y);
454 
467 int xdo_translate_window_with_sizehint(const xdo_t *xdo, Window window,
468  unsigned int width, unsigned int height,
469  unsigned int *width_ret, unsigned int *height_ret);
470 
480 int xdo_set_window_size(const xdo_t *xdo, Window wid, int w, int h, int flags);
481 
491 int xdo_set_window_property(const xdo_t *xdo, Window wid, const char *property,
492  const char *value);
493 
500 int xdo_set_window_class(const xdo_t *xdo, Window wid, const char *name,
501  const char *_class);
502 
506 int xdo_set_window_urgency (const xdo_t *xdo, Window wid, int urgency);
507 
517 int xdo_set_window_override_redirect(const xdo_t *xdo, Window wid,
518  int override_redirect);
519 
526 int xdo_focus_window(const xdo_t *xdo, Window wid);
527 
534 int xdo_raise_window(const xdo_t *xdo, Window wid);
535 
542 int xdo_get_focused_window(const xdo_t *xdo, Window *window_ret);
543 
550 int xdo_wait_for_window_focus(const xdo_t *xdo, Window window, int want_focus);
551 
559 int xdo_get_pid_window(const xdo_t *xdo, Window window);
560 
570 int xdo_get_focused_window_sane(const xdo_t *xdo, Window *window_ret);
571 
583 int xdo_activate_window(const xdo_t *xdo, Window wid);
584 
594 int xdo_wait_for_window_active(const xdo_t *xdo, Window window, int active);
595 
602 int xdo_map_window(const xdo_t *xdo, Window wid);
603 
609 int xdo_unmap_window(const xdo_t *xdo, Window wid);
610 
614 int xdo_minimize_window(const xdo_t *xdo, Window wid);
615 
622 int xdo_reparent_window(const xdo_t *xdo, Window wid_source, Window wid_target);
623 
635 int xdo_get_window_location(const xdo_t *xdo, Window wid,
636  int *x_ret, int *y_ret, Screen **screen_ret);
637 
645 int xdo_get_window_size(const xdo_t *xdo, Window wid, unsigned int *width_ret,
646  unsigned int *height_ret);
647 
648 /* pager-like behaviors */
649 
657 int xdo_get_active_window(const xdo_t *xdo, Window *window_ret);
658 
665 int xdo_select_window_with_click(const xdo_t *xdo, Window *window_ret);
666 
673 int xdo_set_number_of_desktops(const xdo_t *xdo, long ndesktops);
674 
682 int xdo_get_number_of_desktops(const xdo_t *xdo, long *ndesktops);
683 
690 int xdo_set_current_desktop(const xdo_t *xdo, long desktop);
691 
698 int xdo_get_current_desktop(const xdo_t *xdo, long *desktop);
699 
707 int xdo_set_desktop_for_window(const xdo_t *xdo, Window wid, long desktop);
708 
719 int xdo_get_desktop_for_window(const xdo_t *xdo, Window wid, long *desktop);
720 
729 int xdo_search_windows(const xdo_t *xdo, const xdo_search_t *search,
730  Window **windowlist_ret, unsigned int *nwindows_ret);
731 
743 unsigned char *xdo_get_window_property_by_atom(const xdo_t *xdo, Window window, Atom atom,
744  long *nitems, Atom *type, int *size);
745 
757 int xdo_get_window_property(const xdo_t *xdo, Window window, const char *property,
758  unsigned char **value, long *nitems, Atom *type, int *size);
759 
767 unsigned int xdo_get_input_state(const xdo_t *xdo);
768 
777 const char **xdo_get_symbol_map(void);
778 
779 /* active modifiers stuff */
780 
789  int *nkeys);
790 
796 int xdo_clear_active_modifiers(const xdo_t *xdo, Window window,
797  charcodemap_t *active_mods,
798  int active_mods_n);
799 
805 int xdo_set_active_modifiers(const xdo_t *xdo, Window window,
806  charcodemap_t *active_mods,
807  int active_mods_n);
808 
815 int xdo_get_desktop_viewport(const xdo_t *xdo, int *x_ret, int *y_ret);
816 
823 int xdo_set_desktop_viewport(const xdo_t *xdo, int x, int y);
824 
829 int xdo_kill_window(const xdo_t *xdo, Window window);
830 
835 int xdo_close_window(const xdo_t *xdo, Window window);
836 
840 #define XDO_FIND_PARENTS (0)
841 
845 #define XDO_FIND_CHILDREN (1)
846 
851 int xdo_find_window_client(const xdo_t *xdo, Window window, Window *window_ret,
852  int direction);
853 
859 int xdo_get_window_name(const xdo_t *xdo, Window window,
860  unsigned char **name_ret, int *name_len_ret,
861  int *name_type);
862 
871 void xdo_disable_feature(xdo_t *xdo, int feature);
872 
881 void xdo_enable_feature(xdo_t *xdo, int feature);
882 
891 int xdo_has_feature(xdo_t *xdo, int feature);
892 
900 int xdo_get_viewport_dimensions(xdo_t *xdo, unsigned int *width,
901  unsigned int *height, int screen);
902 #endif /* ifndef _XDO_H_ */
int xdo_activate_window(const xdo_t *xdo, Window wid)
Activate a window.
Definition: xdo.c:459
int xdo_focus_window(const xdo_t *xdo, Window wid)
Focus a window.
Definition: xdo.c:392
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
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_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_close_window(const xdo_t *xdo, Window window)
Close a window without trying to kill the client.
Definition: xdo.c:1838
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_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_move_window(const xdo_t *xdo, Window wid, int x, int y)
Move a window to a specific location.
Definition: xdo.c:250
int pid
pattern to test against a window name
Definition: xdo.h:173
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_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
const char * xdo_version(void)
Return a string representing the version of this library.
Definition: xdo.c:152
void xdo_disable_feature(xdo_t *xdo, int feature)
Disable an xdo feature.
Definition: xdo.c:1923
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_search xdo_search_t
The window search query structure.
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_select_window_with_click(const xdo_t *xdo, Window *window_ret)
Get a window ID by clicking on it.
Definition: xdo.c:716
int close_display_when_freed
Should we close the display when calling xdo_free?
Definition: xdo.h:98
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
unsigned int limit
How many results to return? If 0, return all.
Definition: xdo.h:192
KeyCode code
the letter for this key, like 'a'
Definition: xdo.h:58
int xdo_has_feature(xdo_t *xdo, int feature)
Check if a feature is enabled.
Definition: xdo.c:1927
int screen
boolean; set true to search only visible windows
Definition: xdo.h:176
int xdo_map_window(const xdo_t *xdo, Window wid)
Map a window.
Definition: xdo.c:168
int debug
Enable debug output?
Definition: xdo.h:104
int xdo_get_number_of_desktops(const xdo_t *xdo, long *ndesktops)
Get the current number of desktops.
Definition: xdo.c:530
struct xdo xdo_t
The main context.
Definition: xdo.h:56
int xdo_minimize_window(const xdo_t *xdo, Window wid)
Minimize a window.
Definition: xdo.c:1882
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_kill_window(const xdo_t *xdo, Window window)
Kill a window and the client owning it.
Definition: xdo.c:1832
void xdo_enable_feature(xdo_t *xdo, int feature)
Enable an xdo feature.
Definition: xdo.c:1919
int needs_binding
the modifiers to apply when sending this key
Definition: xdo.h:64
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_get_current_desktop(const xdo_t *xdo, long *desktop)
Get the current desktop.
Definition: xdo.c:593
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 modmask
the keyboard group that has this key in it
Definition: xdo.h:61
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_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
enum xdo_search::@0 require
what screen to search, if any.
const char * winname
pattern to test against a window class
Definition: xdo.h:172
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_get_active_window(const xdo_t *xdo, Window *window_ret)
Get the currently-active window.
Definition: xdo.c:686
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 group
the symbol representing this key
Definition: xdo.h:60
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
char * display_name
The display name, if any.
Definition: xdo.h:80
int xdo_get_pid_window(const xdo_t *xdo, Window window)
Get the PID owning a window.
Definition: xdo.c:1719
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
int features_mask
Feature flags, such as XDO_FEATURE_XTEST, etc...
Definition: xdo.h:107
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_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
The window search query structure.
Definition: xdo.h:168
int only_visible
depth of search.
Definition: xdo.h:175
int xdo_get_active_modifiers(const xdo_t *xdo, charcodemap_t **keys, int *nkeys)
Get a list of active keys.
Definition: xdo.c:1604
unsigned int xdo_get_input_state(const xdo_t *xdo)
Get the current input state.
Definition: xdo.c:1648
KeySym symbol
the keycode that this key is on
Definition: xdo.h:59
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
long desktop
What desktop to search, if any.
Definition: xdo.h:189
int quiet
Be extra quiet? (omits some error/message output)
Definition: xdo.h:101
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
unsigned int searchmask
bitmask of things you are searching for, such as SEARCH_NAME, etc.
Definition: xdo.h:186
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_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_raise_window(const xdo_t *xdo, Window wid)
Raise a window to the top of the window stack.
Definition: xdo.c:763
xdo_t * xdo_new(const char *display)
Create a new xdo_t instance.
Definition: xdo.c:83
int xdo_unmap_window(const xdo_t *xdo, Window wid)
Unmap a window.
Definition: xdo.c:175
int xdo_set_desktop_viewport(const xdo_t *xdo, int x, int y)
Set the position of the current viewport.
Definition: xdo.c:1809
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
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_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_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_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 * winclass
pattern to test against a window title
Definition: xdo.h:170
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_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_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
Display * xdpy
The Display for Xlib.
Definition: xdo.h:77
const char * winclassname
pattern to test against a window class
Definition: xdo.h:171
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_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
long max_depth
window pid (From window atom _NET_WM_PID)
Definition: xdo.h:174
int xdo_reparent_window(const xdo_t *xdo, Window wid_source, Window wid_target)
Reparents a window.
Definition: xdo.c:182
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_relative(const xdo_t *xdo, int x, int y)
Move the mouse relative to it's current position.
Definition: xdo.c:795
void xdo_free(xdo_t *xdo)
Free and destroy an xdo_t instance.
Definition: xdo.c:138
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_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_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_set_current_desktop(const xdo_t *xdo, long desktop)
Switch to another desktop.
Definition: xdo.c:561
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_get_focused_window(const xdo_t *xdo, Window *window_ret)
Get the window currently having focus.
Definition: xdo.c:1131
const char ** xdo_get_symbol_map(void)
If you need the symbol map, use this method.
Definition: xdo.c:1660
int xdo_set_number_of_desktops(const xdo_t *xdo, long ndesktops)
Set the number of desktops.
Definition: xdo.c:499
The main context.
Definition: xdo.h:74