lib/strcasestr.c

   1 /* Case-insensitive searching in a string.
   2    Copyright (C) 2005-2007 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2005.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #include <config.h>
  20
  21 /* Specification.  */
  22 #include <string.h>
  23
  24 #include <ctype.h>
  25 #include <stdbool.h>
  26 #include <stddef.h>  /* for NULL, in case a nonstandard string.h lacks it */
  27
  28 #define TOLOWER(Ch) (isupper (Ch) ? tolower (Ch) : (Ch))
  29
  30 /* Knuth-Morris-Pratt algorithm.
  31    See http://en.wikipedia.org/wiki/Knuth-Morris-Pratt_algorithm
  32    Return a boolean indicating success.  */
  33 static bool
  34 knuth_morris_pratt (const char *haystack, const char *needle,
  35                     const char **resultp)
  36 {
  37   size_t m = strlen (needle);
  38
  39   /* Allocate the table.  */
  40   size_t *table = (size_t *) malloc (m * sizeof (size_t));
  41   if (table == NULL)
  42     return false;
  43   /* Fill the table.
  44      For 0 < i < m:
  45        0 < table[i] <= i is defined such that
  46        rhaystack[0..i-1] == needle[0..i-1] and rhaystack[i] != needle[i]
  47        implies
  48        forall 0 <= x < table[i]: rhaystack[x..x+m-1] != needle[0..m-1],
  49        and table[i] is as large as possible with this property.
  50      table[0] remains uninitialized.  */
  51   {
  52     size_t i, j;
  53
  54     table[1] = 1;
  55     j = 0;
  56     for (i = 2; i < m; i++)
  57       {
  58         unsigned char b = TOLOWER ((unsigned char) needle[i - 1]);
  59
  60         for (;;)
  61           {
  62             if (b == TOLOWER ((unsigned char) needle[j]))
  63               {
  64                 table[i] = i - ++j;
  65                 break;
  66               }
  67             if (j == 0)
  68               {
  69                 table[i] = i;
  70                 break;
  71               }
  72             j = j - table[j];
  73           }
  74       }
  75   }
  76
  77   /* Search, using the table to accelerate the processing.  */
  78   {
  79     size_t j;
  80     const char *rhaystack;
  81     const char *phaystack;
  82
  83     *resultp = NULL;
  84     j = 0;
  85     rhaystack = haystack;
  86     phaystack = haystack;
  87     /* Invariant: phaystack = rhaystack + j.  */
  88     while (*phaystack != '\0')
  89       if (TOLOWER ((unsigned char) needle[j])
  90           == TOLOWER ((unsigned char) *phaystack))
  91         {
  92           j++;
  93           phaystack++;
  94           if (j == m)
  95             {
  96               /* The entire needle has been found.  */
  97               *resultp = rhaystack;
  98               break;
  99             }
 100         }
 101       else if (j > 0)
 102         {
 103           /* Found a match of needle[0..j-1], mismatch at needle[j].  */
 104           rhaystack += table[j];
 105           j -= table[j];
 106         }
 107       else
 108         {
 109           /* Found a mismatch at needle[0] already.  */
 110           rhaystack++;
 111           phaystack++;
 112         }
 113   }
 114
 115   free (table);
 116   return true;
 117 }
 118
 119 /* Find the first occurrence of NEEDLE in HAYSTACK, using case-insensitive
 120    comparison.
 121    Note: This function may, in multibyte locales, return success even if
 122    strlen (haystack) < strlen (needle) !  */
 123 char *
 124 strcasestr (const char *haystack, const char *needle)
 125 {
 126   if (*needle != '\0')
 127     {
 128       /* Minimizing the worst-case complexity:
 129          Let n = strlen(haystack), m = strlen(needle).
 130          The naïve algorithm is O(n*m) worst-case.
 131          The Knuth-Morris-Pratt algorithm is O(n) worst-case but it needs a
 132          memory allocation.
 133          To achieve linear complexity and yet amortize the cost of the memory
 134          allocation, we activate the Knuth-Morris-Pratt algorithm only once
 135          the naïve algorithm has already run for some time; more precisely,
 136          when
 137            - the outer loop count is >= 10,
 138            - the average number of comparisons per outer loop is >= 5,
 139            - the total number of comparisons is >= m.
 140          But we try it only once.  If the memory allocation attempt failed,
 141          we don't retry it.  */
 142       bool try_kmp = true;
 143       size_t outer_loop_count = 0;
 144       size_t comparison_count = 0;
 145       size_t last_ccount = 0;                   /* last comparison count */
 146       const char *needle_last_ccount = needle;  /* = needle + last_ccount */
 147
 148       /* Speed up the following searches of needle by caching its first
 149          character.  */
 150       unsigned char b = TOLOWER ((unsigned char) *needle);
 151
 152       needle++;
 153       for (;; haystack++)
 154         {
 155           if (*haystack == '\0')
 156             /* No match.  */
 157             return NULL;
 158
 159           /* See whether it's advisable to use an asymptotically faster
 160              algorithm.  */
 161           if (try_kmp
 162               && outer_loop_count >= 10
 163               && comparison_count >= 5 * outer_loop_count)
 164             {
 165               /* See if needle + comparison_count now reaches the end of
 166                  needle.  */
 167               if (needle_last_ccount != NULL)
 168                 {
 169                   needle_last_ccount +=
 170                     strnlen (needle_last_ccount, comparison_count - last_ccount);
 171                   if (*needle_last_ccount == '\0')
 172                     needle_last_ccount = NULL;
 173                   last_ccount = comparison_count;
 174                 }
 175               if (needle_last_ccount == NULL)
 176                 {
 177                   /* Try the Knuth-Morris-Pratt algorithm.  */
 178                   const char *result;
 179                   bool success =
 180                     knuth_morris_pratt (haystack, needle - 1, &result);
 181                   if (success)
 182                     return (char *) result;
 183                   try_kmp = false;
 184                 }
 185             }
 186
 187           outer_loop_count++;
 188           comparison_count++;
 189           if (TOLOWER ((unsigned char) *haystack) == b)
 190             /* The first character matches.  */
 191             {
 192               const char *rhaystack = haystack + 1;
 193               const char *rneedle = needle;
 194
 195               for (;; rhaystack++, rneedle++)
 196                 {
 197                   if (*rneedle == '\0')
 198                     /* Found a match.  */
 199                     return (char *) haystack;
 200                   if (*rhaystack == '\0')
 201                     /* No match.  */
 202                     return NULL;
 203                   comparison_count++;
 204                   if (TOLOWER ((unsigned char) *rhaystack)
 205                       != TOLOWER ((unsigned char) *rneedle))
 206                     /* Nothing in this round.  */
 207                     break;
 208                 }
 209             }
 210         }
 211     }
 212   else
 213     return (char *) haystack;
 214 }