lib/libfigpar/string_m.c

   1 /*-
   2  * Copyright (c) 2001-2014 Devin Teske <dteske@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  *
  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
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/types.h>
  31
  32 #include <ctype.h>
  33 #include <errno.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37
  38 #include "string_m.h"
  39
  40 /*
  41  * Counts the number of occurrences of one string that appear in the source
  42  * string. Return value is the total count.
  43  *
  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.
  46  */
  47 unsigned int
  48 strcount(const char *source, const char *find)
  49 {
  50         const char *p = source;
  51         size_t flen;
  52         unsigned int n = 0;
  53
  54         /* Both parameters are required */
  55         if (source == NULL || find == NULL)
  56                 return (0);
  57
  58         /* Cache the length of find element */
  59         flen = strlen(find);
  60         if (strlen(source) == 0 || flen == 0)
  61                 return (0);
  62
  63         /* Loop until the end of the string */
  64         while (*p != '\0') {
  65                 if (strncmp(p, find, flen) == 0) { /* found an instance */
  66                         p += flen;
  67                         n++;
  68                 } else
  69                         p++;
  70         }
  71
  72         return (n);
  73 }
  74
  75 /*
  76  * Replaces all occurrences of `find' in `source' with `replace'.
  77  *
  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.
  85  *
  86  * If source is not large enough, the application will crash. The return value
  87  * is the length (in bytes) of the result.
  88  *
  89  * When an error occurs, -1 is returned and the global variable errno is set
  90  * accordingly. Returns zero on success.
  91  */
  92 int
  93 replaceall(char *source, const char *find, const char *replace)
  94 {
  95         char *p;
  96         char *t;
  97         char *temp;
  98         size_t flen;
  99         size_t rlen;
 100         size_t slen;
 101         uint32_t n = 0;
 102
 103         errno = 0; /* reset global error number */
 104
 105         /* Check that we have non-null parameters */
 106         if (source == NULL)
 107                 return (0);
 108         if (find == NULL)
 109                 return (strlen(source));
 110
 111         /* Cache the length of the strings */
 112         slen = strlen(source);
 113         flen = strlen(find);
 114         rlen = replace ? strlen(replace) : 0;
 115
 116         /* Cases where no replacements need to be made */
 117         if (slen == 0 || flen == 0 || slen < flen)
 118                 return (slen);
 119
 120         /* If replace is longer than find, we'll need to create a temp copy */
 121         if (rlen > flen) {
 122                 temp = strdup(source);
 123                 if (temp == NULL) /* could not allocate memory */
 124                         return (-1);
 125         } else
 126                 temp = source;
 127
 128         /* Reconstruct the string with the replacements */
 129         p = source; t = temp; /* position elements */
 130
 131         while (*t != '\0') {
 132                 if (strncmp(t, find, flen) == 0) {
 133                         /* found an occurrence */
 134                         for (n = 0; replace && replace[n]; n++)
 135                                 *p++ = replace[n];
 136                         t += flen;
 137                 } else
 138                         *p++ = *t++; /* copy character and increment */
 139         }
 140
 141         /* Terminate the string */
 142         *p = '\0';
 143
 144         /* Free the temporary allocated memory */
 145         if (temp != source)
 146                 free(temp);
 147
 148         /* Return the length of the completed string */
 149         return (strlen(source));
 150 }
 151
 152 /*
 153  * Expands escape sequences in a buffer pointed to by `source'. This function
 154  * steps through each character, and converts escape sequences such as "\n",
 155  * "\r", "\t" and others into their respective meanings.
 156  *
 157  * You should not pass a string constant or literal to this function or the
 158  * program will likely segmentation fault when it tries to modify the data.
 159  *
 160  * The string length will either shorten or stay the same depending on whether
 161  * any escape sequences were converted but the amount of memory allocated does
 162  * not change.
 163  *
 164  * Interpreted sequences are:
 165  *
 166  *      \0NNN   character with octal value NNN (0 to 3 digits)
 167  *      \N      character with octal value N (0 thru 7)
 168  *      \a      alert (BEL)
 169  *      \b      backslash
 170  *      \f      form feed
 171  *      \n      new line
 172  *      \r      carriage return
 173  *      \t      horizontal tab
 174  *      \v      vertical tab
 175  *      \xNN    byte with hexadecimal value NN (1 to 2 digits)
 176  *
 177  * All other sequences are unescaped (ie. '\"' and '\#').
 178  */
 179 void strexpand(char *source)
 180 {
 181         uint8_t c;
 182         char *chr;
 183         char *pos;
 184         char d[4];
 185
 186         /* Initialize position elements */
 187         pos = chr = source;
 188
 189         /* Loop until we hit the end of the string */
 190         while (*pos != '\0') {
 191                 if (*chr != '\\') {
 192                         *pos = *chr; /* copy character to current offset */
 193                         pos++;
 194                         chr++;
 195                         continue;
 196                 }
 197
 198                 /* Replace the backslash with the correct character */
 199                 switch (*++chr) {
 200                 case 'a': *pos = '\a'; break; /* bell/alert (BEL) */
 201                 case 'b': *pos = '\b'; break; /* backspace */
 202                 case 'f': *pos = '\f'; break; /* form feed */
 203                 case 'n': *pos = '\n'; break; /* new line */
 204                 case 'r': *pos = '\r'; break; /* carriage return */
 205                 case 't': *pos = '\t'; break; /* horizontal tab */
 206                 case 'v': *pos = '\v'; break; /* vertical tab */
 207                 case 'x': /* hex value (1 to 2 digits)(\xNN) */
 208                         d[2] = '\0'; /* pre-terminate the string */
 209
 210                         /* verify next two characters are hex */
 211                         d[0] = isxdigit(*(chr+1)) ? *++chr : '\0';
 212                         if (d[0] != '\0')
 213                                 d[1] = isxdigit(*(chr+1)) ? *++chr : '\0';
 214
 215                         /* convert the characters to decimal */
 216                         c = (uint8_t)strtoul(d, 0, 16);
 217
 218                         /* assign the converted value */
 219                         *pos = (c != 0 || d[0] == '0') ? c : *++chr;
 220                         break;
 221                 case '0': /* octal value (0 to 3 digits)(\0NNN) */
 222                         d[3] = '\0'; /* pre-terminate the string */
 223
 224                         /* verify next three characters are octal */
 225                         d[0] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
 226                             *++chr : '\0';
 227                         if (d[0] != '\0')
 228                                 d[1] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
 229                                     *++chr : '\0';
 230                         if (d[1] != '\0')
 231                                 d[2] = (isdigit(*(chr+1)) && *(chr+1) < '8') ?
 232                                     *++chr : '\0';
 233
 234                         /* convert the characters to decimal */
 235                         c = (uint8_t)strtoul(d, 0, 8);
 236
 237                         /* assign the converted value */
 238                         *pos = c;
 239                         break;
 240                 default: /* single octal (\0..7) or unknown sequence */
 241                         if (isdigit(*chr) && *chr < '8') {
 242                                 d[0] = *chr;
 243                                 d[1] = '\0';
 244                                 *pos = (uint8_t)strtoul(d, 0, 8);
 245                         } else
 246                                 *pos = *chr;
 247                 }
 248
 249                 /* Increment to next offset, possible next escape sequence */
 250                 pos++;
 251                 chr++;
 252         }
 253 }
 254
 255 /*
 256  * Expand only the escaped newlines in a buffer pointed to by `source'. This
 257  * function steps through each character, and converts the "\n" sequence into
 258  * a literal newline and the "\\n" sequence into "\n".
 259  *
 260  * You should not pass a string constant or literal to this function or the
 261  * program will likely segmentation fault when it tries to modify the data.
 262  *
 263  * The string length will either shorten or stay the same depending on whether
 264  * any escaped newlines were converted but the amount of memory allocated does
 265  * not change.
 266  */
 267 void strexpandnl(char *source)
 268 {
 269         uint8_t backslash = 0;
 270         char *cp1;
 271         char *cp2;
 272
 273         /* Replace '\n' with literal in dprompt */
 274         cp1 = cp2 = source;
 275         while (*cp2 != '\0') {
 276                 *cp1 = *cp2;
 277                 if (*cp2 == '\\')
 278                         backslash++;
 279                 else if (*cp2 != 'n')
 280                         backslash = 0;
 281                 else if (backslash > 0) {
 282                         *(--cp1) = (backslash & 1) == 1 ? '\n' : 'n';
 283                         backslash = 0;
 284                 }
 285                 cp1++;
 286                 cp2++;
 287         }
 288         *cp1 = *cp2;
 289 }
 290
 291 /*
 292  * Convert a string to lower case. You should not pass a string constant to
 293  * this function. Only pass pointers to allocated memory with null terminated
 294  * string data.
 295  */
 296 void
 297 strtolower(char *source)
 298 {
 299         char *p = source;
 300
 301         if (source == NULL)
 302                 return;
 303
 304         while (*p != '\0') {
 305                 *p = tolower(*p);
 306                 p++; /* would have just used `*p++' but gcc 3.x warns */
 307         }
 308 }