2 * Copyright (c) 2001-2014 Devin Teske <dteske@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/types.h>
41 * Counts the number of occurrences of one string that appear in the source
42 * string. Return value is the total count.
44 * An example use would be if you need to know how large a block of memory
45 * needs to be for a replaceall() series.
48 strcount(const char *source, const char *find)
50 const char *p = source;
54 /* Both parameters are required */
55 if (source == NULL || find == NULL)
58 /* Cache the length of find element */
60 if (strlen(source) == 0 || flen == 0)
63 /* Loop until the end of the string */
65 if (strncmp(p, find, flen) == 0) { /* found an instance */
76 * Replaces all occurrences of `find' in `source' with `replace'.
78 * You should not pass a string constant as the first parameter, it needs to be
79 * a pointer to an allocated block of memory. The block of memory that source
80 * points to should be large enough to hold the result. If the length of the
81 * replacement string is greater than the length of the find string, the result
82 * will be larger than the original source string. To allocate enough space for
83 * the result, use the function strcount() declared above to determine the
84 * number of occurrences and how much larger the block size needs to be.
86 * If source is not large enough, the application will crash. The return value
87 * is the length (in bytes) of the result.
89 * When an error occurs, -1 is returned and the global variable errno is set
90 * accordingly. Returns zero on success.
93 replaceall(char *source, const char *find, const char *replace)
103 errno = 0; /* reset global error number */
105 /* Check that we have non-null parameters */
109 return (strlen(source));
111 /* Cache the length of the strings */
112 slen = strlen(source);
114 rlen = replace ? strlen(replace) : 0;
116 /* Cases where no replacements need to be made */
117 if (slen == 0 || flen == 0 || slen < flen)
120 /* If replace is longer than find, we'll need to create a temp copy */
122 temp = malloc(slen + 1);
123 if (temp == NULL) /* could not allocate memory */
125 memcpy(temp, source, slen + 1);
129 /* Reconstruct the string with the replacements */
130 p = source; t = temp; /* position elements */
133 if (strncmp(t, find, flen) == 0) {
134 /* found an occurrence */
135 for (n = 0; replace && replace[n]; n++)
139 *p++ = *t++; /* copy character and increment */
142 /* Terminate the string */
145 /* Free the temporary allocated memory */
149 /* Return the length of the completed string */
150 return (strlen(source));
154 * Expands escape sequences in a buffer pointed to by `source'. This function
155 * steps through each character, and converts escape sequences such as "\n",
156 * "\r", "\t" and others into their respective meanings.
158 * You should not pass a string constant or literal to this function or the
159 * program will likely segmentation fault when it tries to modify the data.
161 * The string length will either shorten or stay the same depending on whether
162 * any escape sequences were converted but the amount of memory allocated does
165 * Interpreted sequences are:
167 * \0NNN character with octal value NNN (0 to 3 digits)
168 * \N character with octal value N (0 thru 7)
176 * \xNN byte with hexadecimal value NN (1 to 2 digits)
178 * All other sequences are unescaped (ie. '\"' and '\#').
180 void strexpand(char *source)
187 /* Initialize position elements */
190 /* Loop until we hit the end of the string */
191 while (*pos != '\0') {
193 *pos = *chr; /* copy character to current offset */
199 /* Replace the backslash with the correct character */
201 case 'a': *pos = '\a'; break; /* bell/alert (BEL) */
202 case 'b': *pos = '\b'; break; /* backspace */
203 case 'f': *pos = '\f'; break; /* form feed */
204 case 'n': *pos = '\n'; break; /* new line */
205 case 'r': *pos = '\r'; break; /* carriage return */
206 case 't': *pos = '\t'; break; /* horizontal tab */
207 case 'v': *pos = '\v'; break; /* vertical tab */
208 case 'x': /* hex value (1 to 2 digits)(\xNN) */
209 d[2] = '\0'; /* pre-terminate the string */
211 /* verify next two characters are hex */
212 d[0] = isxdigit(*(chr+1)) ? *++chr : '\0';
214 d[1] = isxdigit(*(chr+1)) ? *++chr : '\0';
216 /* convert the characters to decimal */
217 c = (uint8_t)strtoul(d, 0, 16);
219 /* assign the converted value */
220 *pos = (c != 0 || d[0] == '0') ? c : *++chr;
222 case '0': /* octal value (0 to 3 digits)(\0NNN) */
223 d[3] = '\0'; /* pre-terminate the string */
225 /* verify next three characters are octal */
226 d[0] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
229 d[1] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
232 d[2] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
235 /* convert the characters to decimal */
236 c = (uint8_t)strtoul(d, 0, 8);
238 /* assign the converted value */
241 default: /* single octal (\0..7) or unknown sequence */
242 if (isdigit(*chr) && *chr < '8') {
245 *pos = (uint8_t)strtoul(d, 0, 8);
250 /* Increment to next offset, possible next escape sequence */
257 * Expand only the escaped newlines in a buffer pointed to by `source'. This
258 * function steps through each character, and converts the "\n" sequence into
259 * a literal newline and the "\\n" sequence into "\n".
261 * You should not pass a string constant or literal to this function or the
262 * program will likely segmentation fault when it tries to modify the data.
264 * The string length will either shorten or stay the same depending on whether
265 * any escaped newlines were converted but the amount of memory allocated does
268 void strexpandnl(char *source)
270 uint8_t backslash = 0;
274 /* Replace '\n' with literal in dprompt */
276 while (*cp2 != '\0') {
280 else if (*cp2 != 'n')
282 else if (backslash > 0) {
283 *(--cp1) = (backslash & 1) == 1 ? '\n' : 'n';
293 * Convert a string to lower case. You should not pass a string constant to
294 * this function. Only pass pointers to allocated memory with null terminated
298 strtolower(char *source)
307 p++; /* would have just used `*p++' but gcc 3.x warns */