]> git.sur5r.net Git - i3/i3/blobdiff - include/match.h
normalize file headers across **/*.{h,c}
[i3/i3] / include / match.h
index 2786c66a8be7792cd25485f48ca7ea971b8d0667..6d9cb91539f4219cbfd5fc8ed9081dca2e5591db 100644 (file)
@@ -1,3 +1,16 @@
+/*
+ * vim:ts=4:sw=4:expandtab
+ *
+ * i3 - an improved dynamic tiling window manager
+ * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ *
+ * A "match" is a data structure which acts like a mask or expression to match
+ * certain windows or not. For example, when using commands, you can specify a
+ * command like this: [title="*Firefox*"] kill. The title member of the match
+ * data structure will then be filled and i3 will check each window using
+ * match_matches_window() to find the windows affected by this command.
+ *
+ */
 #ifndef _MATCH_H
 #define _MATCH_H
 
@@ -28,4 +41,10 @@ void match_copy(Match *dest, Match *src);
  */
 bool match_matches_window(Match *match, i3Window *window);
 
+/**
+ * Frees the given match. It must not be used afterwards!
+ *
+ */
+void match_free(Match *match);
+
 #endif