aboutsummaryrefslogtreecommitdiffstats
path: root/include/sway/criteria.h
diff options
context:
space:
mode:
authorLibravatar Ryan Dwyer <ryandwyer1@gmail.com>2018-05-09 14:23:20 +1000
committerLibravatar Ryan Dwyer <ryandwyer1@gmail.com>2018-05-11 09:38:53 +1000
commit3b0c26d149dfe5e05df338692db8255a01f0998d (patch)
treec39e377cb96297df8547311a0aa4cfe8fa85b517 /include/sway/criteria.h
parentMerge pull request #1948 from RyanDwyer/focus-parent-border (diff)
downloadsway-3b0c26d149dfe5e05df338692db8255a01f0998d.tar.gz
sway-3b0c26d149dfe5e05df338692db8255a01f0998d.tar.zst
sway-3b0c26d149dfe5e05df338692db8255a01f0998d.zip
Overhaul criteria implementation
The criteria struct now uses properties for each token type rather than the list_t list of tokens. The reason for this is that different token types have different data types: pcre, string and number to name a few. This solution should be more flexible moving forward. A bonus of this is that criteria is now easier to understand when looking at the struct definition. The criteria parser has been rewritten because the previous one didn't support valueless pairs (eg. [class="foo" floating]). Criteria now has types. Types at the moment are CT_COMMAND, CT_ASSIGN_WORKSPACE and CT_ASSIGN_OUTPUT. i3 uses types as well. Previously the assign command was creating a criteria with 'move to workspace <name>' as its command, but this caused the window to appear briefly on the focused workspace before being moved to the assigned workspace. It now creates the view directly in the assigned workspace. Each view will only execute a given criteria once. This is achieved by storing a list of executed criteria in the view. This is the same strategy used by i3. Escaping now works properly. Previously you could do things like [class="Fire\"fox"] and the stored value would be 'Fire\"fox', but it should be (and now is) 'Fire"fox'. The public functions in criteria.c are now all prefixed with criteria_. Xwayland views now listen to the set_title, set_class and set_window_type events and criteria will be run when these happen. XDG shell has none of these events so it continues to update the title in handle_commit. Each view type's get_prop function has been split into get_string_prop and get_int_prop because some properties like the X11 window ID and window type are numeric. The following new criteria tokens are now supported: * id (X11 window ID) * instance * tiling * workspace
Diffstat (limited to 'include/sway/criteria.h')
-rw-r--r--include/sway/criteria.h73
1 files changed, 46 insertions, 27 deletions
diff --git a/include/sway/criteria.h b/include/sway/criteria.h
index ec256ddb..74da132c 100644
--- a/include/sway/criteria.h
+++ b/include/sway/criteria.h
@@ -1,42 +1,61 @@
1#ifndef _SWAY_CRITERIA_H 1#ifndef _SWAY_CRITERIA_H
2#define _SWAY_CRITERIA_H 2#define _SWAY_CRITERIA_H
3 3
4#include "tree/container.h" 4#include <pcre.h>
5#include "list.h" 5#include "list.h"
6#include "tree/view.h"
6 7
7/** 8enum criteria_type {
8 * Maps criteria (as a list of criteria tokens) to a command list. 9 CT_COMMAND = 1 << 0,
9 * 10 CT_ASSIGN_OUTPUT = 1 << 1,
10 * A list of tokens together represent a single criteria string (e.g. 11 CT_ASSIGN_WORKSPACE = 1 << 2,
11 * '[class="abc" title="xyz"]' becomes two criteria tokens). 12};
12 *
13 * for_window: Views matching all criteria will have the bound command list
14 * executed on them.
15 *
16 * Set via `for_window <criteria> <cmd list>`.
17 */
18struct criteria {
19 list_t *tokens; // struct crit_token, contains compiled regex.
20 char *crit_raw; // entire criteria string (for logging)
21 13
14struct criteria {
15 enum criteria_type type;
16 char *raw; // entire criteria string (for logging)
22 char *cmdlist; 17 char *cmdlist;
18 char *target; // workspace or output name for `assign` criteria
19
20 pcre *title;
21 pcre *app_id;
22 pcre *class;
23 pcre *instance;
24 pcre *con_mark;
25 uint32_t con_id; // internal ID
26 uint32_t id; // X11 window ID
27 pcre *window_role;
28 uint32_t window_type;
29 bool floating;
30 bool tiling;
31 char urgent; // 'l' for latest or 'o' for oldest
32 char *workspace;
23}; 33};
24 34
25int criteria_cmp(const void *item, const void *data); 35bool criteria_is_empty(struct criteria *criteria);
26void free_criteria(struct criteria *crit);
27 36
28// Pouplate list with crit_tokens extracted from criteria string, returns error 37void criteria_destroy(struct criteria *criteria);
29// string or NULL if successful.
30char *extract_crit_tokens(list_t *tokens, const char *criteria);
31 38
32// Returns list of criteria that match given container. These criteria have 39/**
33// been set with `for_window` commands and have an associated cmdlist. 40 * Generate a criteria struct from a raw criteria string such as
34list_t *criteria_for(struct sway_container *cont); 41 * [class="foo" instance="bar"] (brackets inclusive).
42 *
43 * The error argument is expected to be an address of a null pointer. If an
44 * error is encountered, the function will return NULL and the pointer will be
45 * changed to point to the error string. This string should be freed afterwards.
46 */
47struct criteria *criteria_parse(char *raw, char **error);
35 48
36// Returns a list of all containers that match the given list of tokens. 49/**
37list_t *container_for_crit_tokens(list_t *tokens); 50 * Compile a list of criterias matching the given view.
51 *
52 * Criteria types can be bitwise ORed.
53 */
54list_t *criteria_for_view(struct sway_view *view, enum criteria_type types);
38 55
39// Returns true if any criteria in the given list matches this container 56/**
40bool criteria_any(struct sway_container *cont, list_t *criteria); 57 * Compile a list of views matching the given criteria.
58 */
59list_t *criteria_get_views(struct criteria *criteria);
41 60
42#endif 61#endif