(x)memcoll: speedup when input is known to be NUL delimited
[gnulib.git] / lib / memcoll.c
1 /* Locale-specific memory comparison.
2
3    Copyright (C) 1999, 2002-2004, 2006, 2009-2010 Free Software Foundation,
4    Inc.
5
6    This program is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* Contributed by Paul Eggert <eggert@twinsun.com>.  */
20
21 #include <config.h>
22
23 #include "memcoll.h"
24
25 #include <errno.h>
26 #include <stdlib.h>
27 #include <string.h>
28
29 /* Ensure strcoll operates on the entire input strings, in case they contain
30    NUL bytes. */
31
32 static inline int
33 strcoll_loop (const char *s1, size_t s1len, const char *s2, size_t s2len)
34 {
35   int diff;
36   while (! (errno = 0, (diff = strcoll (s1, s2)) || errno))
37     {
38       /* strcoll found no difference, but perhaps it was fooled by NUL
39          characters in the data.  Work around this problem by advancing
40          past the NUL chars.  */
41       size_t size1 = strlen (s1) + 1;
42       size_t size2 = strlen (s2) + 1;
43       s1 += size1;
44       s2 += size2;
45       s1len -= size1;
46       s2len -= size2;
47
48       if (s1len == 0)
49         {
50           if (s2len != 0)
51             diff = -1;
52           break;
53         }
54       else if (s2len == 0)
55         {
56           diff = 1;
57           break;
58         }
59     }
60   return diff;
61 }
62
63 /* Compare S1 (with length S1LEN) and S2 (with length S2LEN) according
64    to the LC_COLLATE locale.  S1 and S2 do not overlap, and are not
65    adjacent.  Perhaps temporarily modify the bytes after S1 and S2,
66    but restore their original contents before returning.  Set errno to an
67    error number if there is an error, and to zero otherwise.  */
68
69 int
70 memcoll (char *s1, size_t s1len, char *s2, size_t s2len)
71 {
72   int diff;
73
74   /* strcoll is slow on many platforms, so check for the common case
75      where the arguments are bytewise equal.  Otherwise, walk through
76      the buffers using strcoll on each substring.  */
77
78   if (s1len == s2len && memcmp (s1, s2, s1len) == 0)
79     {
80       errno = 0;
81       diff = 0;
82     }
83   else
84     {
85       char n1 = s1[s1len];
86       char n2 = s2[s2len];
87
88       s1[s1len++] = '\0';
89       s2[s2len++] = '\0';
90
91       diff = strcoll_loop (s1, s1len, s2, s2len);
92
93       s1[s1len - 1] = n1;
94       s2[s2len - 1] = n2;
95     }
96
97   return diff;
98 }
99
100 /* Like memcoll, but S1 and S2 are known to be NUL delimited, thus no
101    modification to S1 or S2 are needed. */
102 int
103 memcoll0 (const char *s1, size_t s1len, const char *s2, size_t s2len)
104 {
105   int diff;
106   if (!(s1len > 0 && s1[s1len] == '\0'))
107     abort ();
108   if (!(s2len > 0 && s2[s2len] == '\0'))
109     abort ();
110
111   if (s1len == s2len && memcmp (s1, s2, s1len) == 0)
112     {
113       errno = 0;
114       diff = 0;
115     }
116   else
117     diff = strcoll_loop (s1, s1len, s2, s2len);
118
119   return diff;
120 }