git.sur5r.net Git - i3/i3/blob - include/match.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * A "match" is a data structure which acts like a mask or expression to match
   8  * certain windows or not. For example, when using commands, you can specify a
   9  * command like this: [title="*Firefox*"] kill. The title member of the match
  10  * data structure will then be filled and i3 will check each window using
  11  * match_matches_window() to find the windows affected by this command.
  12  *
  13  */
  14 #pragma once
  15
  16 /*
  17  * Initializes the Match data structure. This function is necessary because the
  18  * members representing boolean values (like dock) need to be initialized with
  19  * -1 instead of 0.
  20  *
  21  */
  22 void match_init(Match *match);
  23
  24 /**
  25  * Check if a match is empty. This is necessary while parsing commands to see
  26  * whether the user specified a match at all.
  27  *
  28  */
  29 bool match_is_empty(Match *match);
  30
  31 /**
  32  * Copies the data of a match from src to dest.
  33  *
  34  */
  35 void match_copy(Match *dest, Match *src);
  36
  37 /**
  38  * Check if a match data structure matches the given window.
  39  *
  40  */
  41 bool match_matches_window(Match *match, i3Window *window);
  42
  43 /**
  44  * Frees the given match. It must not be used afterwards!
  45  *
  46  */
  47 void match_free(Match *match);