glib/gpattern.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997, 1999  Peter Mattis, Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21
  22 #include <string.h>
  23
  24 #include "gpattern.h"
  25
  26 #include "gmacros.h"
  27 #include "gmessages.h"
  28 #include "gmem.h"
  29 #include "gunicode.h"
  30 #include "gutils.h"
  31
  32 /**
  33  * SECTION:patterns
  34  * @title: Glob-style pattern matching
  35  * @short_description: matches strings against patterns containing '*'
  36  *                     (wildcard) and '?' (joker)
  37  *
  38  * The <function>g_pattern_match*</function> functions match a string
  39  * against a pattern containing '*' and '?' wildcards with similar
  40  * semantics as the standard glob() function: '*' matches an arbitrary,
  41  * possibly empty, string, '?' matches an arbitrary character.
  42  *
  43  * Note that in contrast to glob(), the '/' character
  44  * <emphasis>can</emphasis> be matched by the wildcards, there are no
  45  * '[...]' character ranges and '*' and '?' can
  46  * <emphasis>not</emphasis> be escaped to include them literally in a
  47  * pattern.
  48  *
  49  * When multiple strings must be matched against the same pattern, it
  50  * is better to compile the pattern to a #GPatternSpec using
  51  * g_pattern_spec_new() and use g_pattern_match_string() instead of
  52  * g_pattern_match_simple(). This avoids the overhead of repeated
  53  * pattern compilation.
  54  **/
  55
  56 /**
  57  * GPatternSpec:
  58  *
  59  * A #GPatternSpec-struct is the 'compiled' form of a pattern. This
  60  * structure is opaque and its fields cannot be accessed directly.
  61  */
  62
  63 /* keep enum and structure of gpattern.c and patterntest.c in sync */
  64 typedef enum
  65 {
  66   G_MATCH_ALL,       /* "*A?A*" */
  67   G_MATCH_ALL_TAIL,  /* "*A?AA" */
  68   G_MATCH_HEAD,      /* "AAAA*" */
  69   G_MATCH_TAIL,      /* "*AAAA" */
  70   G_MATCH_EXACT,     /* "AAAAA" */
  71   G_MATCH_LAST
  72 } GMatchType;
  73
  74 struct _GPatternSpec
  75 {
  76   GMatchType match_type;
  77   guint      pattern_length;
  78   guint      min_length;
  79   guint      max_length;
  80   gchar     *pattern;
  81 };
  82
  83
  84 /* --- functions --- */
  85 static inline gboolean
  86 g_pattern_ph_match (const gchar *match_pattern,
  87                     const gchar *match_string,
  88                     gboolean    *wildcard_reached_p)
  89 {
  90   register const gchar *pattern, *string;
  91   register gchar ch;
  92
  93   pattern = match_pattern;
  94   string = match_string;
  95
  96   ch = *pattern;
  97   pattern++;
  98   while (ch)
  99     {
 100       switch (ch)
 101         {
 102         case '?':
 103           if (!*string)
 104             return FALSE;
 105           string = g_utf8_next_char (string);
 106           break;
 107
 108         case '*':
 109           *wildcard_reached_p = TRUE;
 110           do
 111             {
 112               ch = *pattern;
 113               pattern++;
 114               if (ch == '?')
 115                 {
 116                   if (!*string)
 117                     return FALSE;
 118                   string = g_utf8_next_char (string);
 119                 }
 120             }
 121           while (ch == '*' || ch == '?');
 122           if (!ch)
 123             return TRUE;
 124           do
 125             {
 126               gboolean next_wildcard_reached = FALSE;
 127               while (ch != *string)
 128                 {
 129                   if (!*string)
 130                     return FALSE;
 131                   string = g_utf8_next_char (string);
 132                 }
 133               string++;
 134               if (g_pattern_ph_match (pattern, string, &next_wildcard_reached))
 135                 return TRUE;
 136               if (next_wildcard_reached)
 137                 /* the forthcoming pattern substring up to the next wildcard has
 138                  * been matched, but a mismatch occoured for the rest of the
 139                  * pattern, following the next wildcard.
 140                  * there's no need to advance the current match position any
 141                  * further if the rest pattern will not match.
 142                  */
 143                 return FALSE;
 144             }
 145           while (*string);
 146           break;
 147
 148         default:
 149           if (ch == *string)
 150             string++;
 151           else
 152             return FALSE;
 153           break;
 154         }
 155
 156       ch = *pattern;
 157       pattern++;
 158     }
 159
 160   return *string == 0;
 161 }
 162
 163 /**
 164  * g_pattern_match:
 165  * @pspec: a #GPatternSpec
 166  * @string_length: the length of @string (in bytes, i.e. strlen(),
 167  *                 <emphasis>not</emphasis> g_utf8_strlen())
 168  * @string: the UTF-8 encoded string to match
 169  * @string_reversed: (allow-none): the reverse of @string or %NULL
 170  *
 171  * Matches a string against a compiled pattern. Passing the correct
 172  * length of the string given is mandatory. The reversed string can be
 173  * omitted by passing %NULL, this is more efficient if the reversed
 174  * version of the string to be matched is not at hand, as
 175  * g_pattern_match() will only construct it if the compiled pattern
 176  * requires reverse matches.
 177  *
 178  * Note that, if the user code will (possibly) match a string against a
 179  * multitude of patterns containing wildcards, chances are high that
 180  * some patterns will require a reversed string. In this case, it's
 181  * more efficient to provide the reversed string to avoid multiple
 182  * constructions thereof in the various calls to g_pattern_match().
 183  *
 184  * Note also that the reverse of a UTF-8 encoded string can in general
 185  * <emphasis>not</emphasis> be obtained by g_strreverse(). This works
 186  * only if the string doesn't contain any multibyte characters. GLib
 187  * offers the g_utf8_strreverse() function to reverse UTF-8 encoded
 188  * strings.
 189  *
 190  * Returns: %TRUE if @string matches @pspec
 191  **/
 192 gboolean
 193 g_pattern_match (GPatternSpec *pspec,
 194                  guint         string_length,
 195                  const gchar  *string,
 196                  const gchar  *string_reversed)
 197 {
 198   g_return_val_if_fail (pspec != NULL, FALSE);
 199   g_return_val_if_fail (string != NULL, FALSE);
 200
 201   if (string_length < pspec->min_length ||
 202       string_length > pspec->max_length)
 203     return FALSE;
 204
 205   switch (pspec->match_type)
 206     {
 207       gboolean dummy;
 208     case G_MATCH_ALL:
 209       return g_pattern_ph_match (pspec->pattern, string, &dummy);
 210     case G_MATCH_ALL_TAIL:
 211       if (string_reversed)
 212         return g_pattern_ph_match (pspec->pattern, string_reversed, &dummy);
 213       else
 214         {
 215           gboolean result;
 216           gchar *tmp;
 217           tmp = g_utf8_strreverse (string, string_length);
 218           result = g_pattern_ph_match (pspec->pattern, tmp, &dummy);
 219           g_free (tmp);
 220           return result;
 221         }
 222     case G_MATCH_HEAD:
 223       if (pspec->pattern_length == string_length)
 224         return strcmp (pspec->pattern, string) == 0;
 225       else if (pspec->pattern_length)
 226         return strncmp (pspec->pattern, string, pspec->pattern_length) == 0;
 227       else
 228         return TRUE;
 229     case G_MATCH_TAIL:
 230       if (pspec->pattern_length)
 231         return strcmp (pspec->pattern, string + (string_length - pspec->pattern_length)) == 0;
 232       else
 233         return TRUE;
 234     case G_MATCH_EXACT:
 235       if (pspec->pattern_length != string_length)
 236         return FALSE;
 237       else
 238         return strcmp (pspec->pattern, string) == 0;
 239     default:
 240       g_return_val_if_fail (pspec->match_type < G_MATCH_LAST, FALSE);
 241       return FALSE;
 242     }
 243 }
 244
 245 /**
 246  * g_pattern_spec_new:
 247  * @pattern: a zero-terminated UTF-8 encoded string
 248  *
 249  * Compiles a pattern to a #GPatternSpec.
 250  *
 251  * Returns: a newly-allocated #GPatternSpec
 252  **/
 253 GPatternSpec*
 254 g_pattern_spec_new (const gchar *pattern)
 255 {
 256   GPatternSpec *pspec;
 257   gboolean seen_joker = FALSE, seen_wildcard = FALSE, more_wildcards = FALSE;
 258   gint hw_pos = -1, tw_pos = -1, hj_pos = -1, tj_pos = -1;
 259   gboolean follows_wildcard = FALSE;
 260   guint pending_jokers = 0;
 261   const gchar *s;
 262   gchar *d;
 263   guint i;
 264
 265   g_return_val_if_fail (pattern != NULL, NULL);
 266
 267   /* canonicalize pattern and collect necessary stats */
 268   pspec = g_new (GPatternSpec, 1);
 269   pspec->pattern_length = strlen (pattern);
 270   pspec->min_length = 0;
 271   pspec->max_length = 0;
 272   pspec->pattern = g_new (gchar, pspec->pattern_length + 1);
 273   d = pspec->pattern;
 274   for (i = 0, s = pattern; *s != 0; s++)
 275     {
 276       switch (*s)
 277         {
 278         case '*':
 279           if (follows_wildcard) /* compress multiple wildcards */
 280             {
 281               pspec->pattern_length--;
 282               continue;
 283             }
 284           follows_wildcard = TRUE;
 285           if (hw_pos < 0)
 286             hw_pos = i;
 287           tw_pos = i;
 288           break;
 289         case '?':
 290           pending_jokers++;
 291           pspec->min_length++;
 292           pspec->max_length += 4; /* maximum UTF-8 character length */
 293           continue;
 294         default:
 295           for (; pending_jokers; pending_jokers--, i++) {
 296             *d++ = '?';
 297             if (hj_pos < 0)
 298              hj_pos = i;
 299             tj_pos = i;
 300           }
 301           follows_wildcard = FALSE;
 302           pspec->min_length++;
 303           pspec->max_length++;
 304           break;
 305         }
 306       *d++ = *s;
 307       i++;
 308     }
 309   for (; pending_jokers; pending_jokers--) {
 310     *d++ = '?';
 311     if (hj_pos < 0)
 312       hj_pos = i;
 313     tj_pos = i;
 314   }
 315   *d++ = 0;
 316   seen_joker = hj_pos >= 0;
 317   seen_wildcard = hw_pos >= 0;
 318   more_wildcards = seen_wildcard && hw_pos != tw_pos;
 319   if (seen_wildcard)
 320     pspec->max_length = G_MAXUINT;
 321
 322   /* special case sole head/tail wildcard or exact matches */
 323   if (!seen_joker && !more_wildcards)
 324     {
 325       if (pspec->pattern[0] == '*')
 326         {
 327           pspec->match_type = G_MATCH_TAIL;
 328           memmove (pspec->pattern, pspec->pattern + 1, --pspec->pattern_length);
 329           pspec->pattern[pspec->pattern_length] = 0;
 330           return pspec;
 331         }
 332       if (pspec->pattern_length > 0 &&
 333           pspec->pattern[pspec->pattern_length - 1] == '*')
 334         {
 335           pspec->match_type = G_MATCH_HEAD;
 336           pspec->pattern[--pspec->pattern_length] = 0;
 337           return pspec;
 338         }
 339       if (!seen_wildcard)
 340         {
 341           pspec->match_type = G_MATCH_EXACT;
 342           return pspec;
 343         }
 344     }
 345
 346   /* now just need to distinguish between head or tail match start */
 347   tw_pos = pspec->pattern_length - 1 - tw_pos;  /* last pos to tail distance */
 348   tj_pos = pspec->pattern_length - 1 - tj_pos;  /* last pos to tail distance */
 349   if (seen_wildcard)
 350     pspec->match_type = tw_pos > hw_pos ? G_MATCH_ALL_TAIL : G_MATCH_ALL;
 351   else /* seen_joker */
 352     pspec->match_type = tj_pos > hj_pos ? G_MATCH_ALL_TAIL : G_MATCH_ALL;
 353   if (pspec->match_type == G_MATCH_ALL_TAIL) {
 354     gchar *tmp = pspec->pattern;
 355     pspec->pattern = g_utf8_strreverse (pspec->pattern, pspec->pattern_length);
 356     g_free (tmp);
 357   }
 358   return pspec;
 359 }
 360
 361 /**
 362  * g_pattern_spec_free:
 363  * @pspec: a #GPatternSpec
 364  *
 365  * Frees the memory allocated for the #GPatternSpec.
 366  **/
 367 void
 368 g_pattern_spec_free (GPatternSpec *pspec)
 369 {
 370   g_return_if_fail (pspec != NULL);
 371
 372   g_free (pspec->pattern);
 373   g_free (pspec);
 374 }
 375
 376 /**
 377  * g_pattern_spec_equal:
 378  * @pspec1: a #GPatternSpec
 379  * @pspec2: another #GPatternSpec
 380  *
 381  * Compares two compiled pattern specs and returns whether they will
 382  * match the same set of strings.
 383  *
 384  * Returns: Whether the compiled patterns are equal
 385  **/
 386 gboolean
 387 g_pattern_spec_equal (GPatternSpec *pspec1,
 388                       GPatternSpec *pspec2)
 389 {
 390   g_return_val_if_fail (pspec1 != NULL, FALSE);
 391   g_return_val_if_fail (pspec2 != NULL, FALSE);
 392
 393   return (pspec1->pattern_length == pspec2->pattern_length &&
 394           pspec1->match_type == pspec2->match_type &&
 395           strcmp (pspec1->pattern, pspec2->pattern) == 0);
 396 }
 397
 398 /**
 399  * g_pattern_match_string:
 400  * @pspec: a #GPatternSpec
 401  * @string: the UTF-8 encoded string to match
 402  *
 403  * Matches a string against a compiled pattern. If the string is to be
 404  * matched against more than one pattern, consider using
 405  * g_pattern_match() instead while supplying the reversed string.
 406  *
 407  * Returns: %TRUE if @string matches @pspec
 408  **/
 409 gboolean
 410 g_pattern_match_string (GPatternSpec *pspec,
 411                         const gchar  *string)
 412 {
 413   g_return_val_if_fail (pspec != NULL, FALSE);
 414   g_return_val_if_fail (string != NULL, FALSE);
 415
 416   return g_pattern_match (pspec, strlen (string), string, NULL);
 417 }
 418
 419 /**
 420  * g_pattern_match_simple:
 421  * @pattern: the UTF-8 encoded pattern
 422  * @string: the UTF-8 encoded string to match
 423  *
 424  * Matches a string against a pattern given as a string. If this
 425  * function is to be called in a loop, it's more efficient to compile
 426  * the pattern once with g_pattern_spec_new() and call
 427  * g_pattern_match_string() repeatedly.
 428  *
 429  * Returns: %TRUE if @string matches @pspec
 430  **/
 431 gboolean
 432 g_pattern_match_simple (const gchar *pattern,
 433                         const gchar *string)
 434 {
 435   GPatternSpec *pspec;
 436   gboolean ergo;
 437
 438   g_return_val_if_fail (pattern != NULL, FALSE);
 439   g_return_val_if_fail (string != NULL, FALSE);
 440
 441   pspec = g_pattern_spec_new (pattern);
 442   ergo = g_pattern_match (pspec, strlen (string), string, NULL);
 443   g_pattern_spec_free (pspec);
 444
 445   return ergo;
 446 }