src/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 #define PTH_TOK  "/"
  29
  30 typedef enum {
  31         DOMAIN_TREE,
  32         DOMAIN_MONITOR,
  33         DOMAIN_DESKTOP,
  34         DOMAIN_NODE
  35 } domain_t;
  36
  37 enum {
  38         SELECTOR_OK,
  39         SELECTOR_INVALID,
  40         SELECTOR_BAD_MODIFIERS,
  41         SELECTOR_BAD_DESCRIPTOR
  42 };
  43
  44 typedef void (*monitor_printer_t)(monitor_t *m, FILE *rsp);
  45 typedef void (*desktop_printer_t)(desktop_t *m, FILE *rsp);
  46
  47 void query_state(FILE *rsp);
  48 void query_monitor(monitor_t *m, FILE *rsp);
  49 void query_desktop(desktop_t *d, FILE *rsp);
  50 void query_node(node_t *n, FILE *rsp);
  51 void query_presel(presel_t *p, FILE *rsp);
  52 void query_client(client_t *c, FILE *rsp);
  53 void query_rectangle(xcb_rectangle_t r, FILE *rsp);
  54 void query_constraints(constraints_t c, FILE *rsp);
  55 void query_padding(padding_t p, FILE *rsp);
  56 void query_history(FILE *rsp);
  57 void query_coordinates(coordinates_t *loc, FILE *rsp);
  58 void query_stack(FILE *rsp);
  59 void query_subscribers(FILE *rsp);
  60 int query_node_ids(coordinates_t *ref, coordinates_t *trg, monitor_select_t *mon_sel, desktop_select_t *desk_sel, node_select_t *sel, FILE *rsp);
  61 int query_node_ids_in(node_t *n, desktop_t *d, monitor_t *m, coordinates_t *ref, coordinates_t *trg, node_select_t *sel, FILE *rsp);
  62 int query_desktop_ids(coordinates_t *ref, coordinates_t *trg, monitor_select_t *mon_sel, desktop_select_t *sel, desktop_printer_t printer, FILE *rsp);
  63 int query_monitor_ids(coordinates_t *ref, coordinates_t *trg, monitor_select_t *sel, monitor_printer_t printer, FILE *rsp);
  64 void fprint_monitor_id(monitor_t *m, FILE *rsp);
  65 void fprint_monitor_name(monitor_t *m, FILE *rsp);
  66 void fprint_desktop_id(desktop_t *d, FILE *rsp);
  67 void fprint_desktop_name(desktop_t *d, FILE *rsp);
  68 void print_ignore_request(state_transition_t st, FILE *rsp);
  69 void print_modifier_mask(uint16_t m, FILE *rsp);
  70 void print_button_index(int8_t b, FILE *rsp);
  71 void print_pointer_action(pointer_action_t a, FILE *rsp);
  72 void print_rule_consequence(char **buf, rule_consequence_t *csq);
  73 void print_rectangle(char **buf, xcb_rectangle_t *rect);
  74 node_select_t make_node_select(void);
  75 desktop_select_t make_desktop_select(void);
  76 monitor_select_t make_monitor_select(void);
  77 int node_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
  78 int desktop_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
  79 int monitor_from_desc(char *desc, coordinates_t *ref, coordinates_t *dst);
  80 bool locate_window(xcb_window_t win, coordinates_t *loc);
  81 bool locate_desktop(char *name, coordinates_t *loc);
  82 bool locate_monitor(char *name, coordinates_t *loc);
  83 bool desktop_from_id(uint32_t id, coordinates_t *loc, monitor_t *mm);
  84 bool desktop_from_name(char *name, coordinates_t *ref, coordinates_t *dst, desktop_select_t *sel, int *hits);
  85 bool desktop_from_index(uint16_t idx, coordinates_t *loc, monitor_t *mm);
  86 bool monitor_from_id(uint32_t id, coordinates_t *loc);
  87 bool monitor_from_index(int idx, coordinates_t *loc);
  88 bool node_matches(coordinates_t *loc, coordinates_t *ref, node_select_t *sel);
  89 bool desktop_matches(coordinates_t *loc, coordinates_t *ref, desktop_select_t *sel);
  90 bool monitor_matches(coordinates_t *loc, __attribute__((unused)) coordinates_t *ref, monitor_select_t *sel);
  91
  92 #endif