git.sur5r.net Git - i3/i3/blob - src/regex.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * regex.c: Interface to libPCRE (perl compatible regular expressions).
   8  *
   9  */
  10 #include "all.h"
  11
  12 /*
  13  * Creates a new 'regex' struct containing the given pattern and a PCRE
  14  * compiled regular expression. Also, calls pcre_study because this regex will
  15  * most likely be used often (like for every new window and on every relevant
  16  * property change of existing windows).
  17  *
  18  * Returns NULL if the pattern could not be compiled into a regular expression
  19  * (and ELOGs an appropriate error message).
  20  *
  21  */
  22 struct regex *regex_new(const char *pattern) {
  23     const char *error;
  24     int errorcode, offset;
  25
  26     struct regex *re = scalloc(1, sizeof(struct regex));
  27     re->pattern = sstrdup(pattern);
  28     int options = PCRE_UTF8;
  29     /* We use PCRE_UCP so that \B, \b, \D, \d, \S, \s, \W, \w and some POSIX
  30      * character classes play nicely with Unicode */
  31     options |= PCRE_UCP;
  32     while (!(re->regex = pcre_compile2(pattern, options, &errorcode, &error, &offset, NULL))) {
  33         /* If the error is that PCRE was not compiled with UTF-8 support we
  34          * disable it and try again */
  35         if (errorcode == 32) {
  36             options &= ~PCRE_UTF8;
  37             continue;
  38         }
  39         ELOG("PCRE regular expression compilation failed at %d: %s\n",
  40              offset, error);
  41         return NULL;
  42     }
  43     re->extra = pcre_study(re->regex, 0, &error);
  44     /* If an error happened, we print the error message, but continue.
  45      * Studying the regular expression leads to faster matching, but it’s not
  46      * absolutely necessary. */
  47     if (error) {
  48         ELOG("PCRE regular expression studying failed: %s\n", error);
  49     }
  50     return re;
  51 }
  52
  53 /*
  54  * Frees the given regular expression. It must not be used afterwards!
  55  *
  56  */
  57 void regex_free(struct regex *regex) {
  58     if (!regex)
  59         return;
  60     FREE(regex->pattern);
  61     FREE(regex->regex);
  62     FREE(regex->extra);
  63     FREE(regex);
  64 }
  65
  66 /*
  67  * Checks if the given regular expression matches the given input and returns
  68  * true if it does. In either case, it logs the outcome using LOG(), so it will
  69  * be visible without debug logging.
  70  *
  71  */
  72 bool regex_matches(struct regex *regex, const char *input) {
  73     int rc;
  74
  75     /* We use strlen() because pcre_exec() expects the length of the input
  76      * string in bytes */
  77     if ((rc = pcre_exec(regex->regex, regex->extra, input, strlen(input), 0, 0, NULL, 0)) == 0) {
  78         LOG("Regular expression \"%s\" matches \"%s\"\n",
  79             regex->pattern, input);
  80         return true;
  81     }
  82
  83     if (rc == PCRE_ERROR_NOMATCH) {
  84         LOG("Regular expression \"%s\" does not match \"%s\"\n",
  85             regex->pattern, input);
  86         return false;
  87     }
  88
  89     ELOG("PCRE error %d while trying to use regular expression \"%s\" on input \"%s\", see pcreapi(3)\n",
  90          rc, regex->pattern, input);
  91     return false;
  92 }