]> git.lizzy.rs Git - bspwm.git/blob - query.h
Update the documentation regarding query/restore
[bspwm.git] / query.h
1 /* Copyright (c) 2012, Bastien Dejean
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  *    list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  *    this list of conditions and the following disclaimer in the documentation
11  *    and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
17  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
20  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef BSPWM_QUERY_H
26 #define BSPWM_QUERY_H
27
28 typedef enum {
29         DOMAIN_MONITOR,
30         DOMAIN_DESKTOP,
31         DOMAIN_WINDOW,
32         DOMAIN_TREE,
33         DOMAIN_HISTORY,
34         DOMAIN_STACK
35 } domain_t;
36
37 void query_tree(FILE *rsp);
38 void query_monitor(monitor_t *m, FILE *rsp);
39 void query_desktop(desktop_t *d, FILE *rsp);
40 void query_node(node_t *n, FILE *rsp);
41 void query_client(client_t *c, FILE *rsp);
42 void query_rectangle(xcb_rectangle_t r, FILE *rsp);
43 void query_wm_state(xcb_atom_t *wm_state, int num_states, FILE *rsp);
44 void query_history(coordinates_t loc, FILE *rsp);
45 void query_stack(FILE *rsp);
46 void query_windows(coordinates_t loc, FILE *rsp);
47 void query_names(domain_t dom, coordinates_t loc, FILE *rsp);
48 client_select_t make_client_select(void);
49 desktop_select_t make_desktop_select(void);
50 void cleanup_client_select(client_select_t *sel);
51 bool node_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
52 bool desktop_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
53 bool monitor_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
54 bool locate_window(xcb_window_t win, coordinates_t *loc);
55 bool locate_desktop(char *name, coordinates_t *loc);
56 bool locate_monitor(char *name, coordinates_t *loc);
57 bool desktop_from_index(int i, coordinates_t *loc, monitor_t *mm);
58 bool monitor_from_index(int i, coordinates_t *loc);
59 bool node_matches(coordinates_t *loc, coordinates_t *ref, client_select_t sel);
60 bool desktop_matches(coordinates_t *loc, coordinates_t *ref, desktop_select_t sel);
61
62 #endif