lib-lib/str.c

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 /** \addtogroup mutt_strings */
  21 /*@{*/
  22
  23 /** \file str.c
  24  * \brief Madmutt string API module implementation.
  25  * \author Pierre Habouzit <madcoder@debian.org>
  26  */
  27
  28 #include "lib-lib.h"
  29
  30 #ifndef __doxygen_skip__
  31 #define XX 255
  32 unsigned char const __m_strdigits[128] = {
  33     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX,
  34     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX,
  35     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX,
  36      0,  1,  2,  3,  4,  5,  6,  7,  8,  9, XX, XX, XX, XX, XX, XX,
  37     XX, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  38     25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, XX, XX, XX, XX, XX,
  39     XX, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  40     25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, XX, XX, XX, XX, XX,
  41 };
  42 #undef XX
  43
  44 #define XX -1
  45 signed char const __m_b64digits[128] = {
  46     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX,
  47     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX,
  48     XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, XX, 62, XX, XX, XX, 63,
  49     52, 53, 54, 55, 56, 57, 58, 59, 60, 61, XX, XX, XX, XX, XX, XX,
  50     XX,  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14,
  51     15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, XX, XX, XX, XX, XX,
  52     XX, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
  53     41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, XX, XX, XX, XX, XX
  54 };
  55 #undef XX
  56
  57 char const __m_b64chars[64] = {
  58     'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
  59     'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd',
  60     'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's',
  61     't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7',
  62     '8', '9', '+', '/'
  63 };
  64
  65 char const __m_b36chars_lower[36] = {
  66     '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
  67     'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
  68     'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',
  69     'u', 'v', 'w', 'x', 'y', 'z'
  70 };
  71
  72 char const __m_b36chars_upper[36] = {
  73     '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
  74     'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
  75     'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',
  76     'U', 'V', 'W', 'X', 'Y', 'Z'
  77 };
  78 #endif
  79
  80 /** \brief safe strcpy.
  81  *
  82  * Copies at most <tt>n-1</tt> characters from \c src into \c dst, always
  83  * adding a final \c \\0 in \c dst.
  84  *
  85  * \param[in]  dst      destination buffer.
  86  * \param[in]  n        size of the buffer. Negative sizes are allowed.
  87  * \param[in]  src      source string.
  88  *
  89  * \return \c src \e length. If this value is \>= \c n then the copy was
  90  *         truncated.
  91  */
  92 ssize_t m_strcpy(char *dst, ssize_t n, const char *src)
  93 {
  94     ssize_t len = m_strlen(src);
  95
  96     if (n > 0) {
  97         ssize_t dlen = MIN(n - 1, len);
  98         memcpy(dst, src, dlen);
  99         dst[dlen] = '\0';
 100     }
 101
 102     return len;
 103 }
 104
 105 /** \brief safe limited strcpy.
 106  *
 107  * Copies at most min(<tt>n-1</tt>, \c l) characters from \c src into \c dst,
 108  * always adding a final \c \\0 in \c dst.
 109  *
 110  * \param[in]  dst      destination buffer.
 111  * \param[in]  n        size of the buffer. Negative sizes are allowed.
 112  * \param[in]  src      source string.
 113  * \param[in]  l        maximum number of chars to copy.
 114  *
 115  * \return minimum of  \c src \e length and \c l.
 116  */
 117 ssize_t m_strncpy(char *dst, ssize_t n, const char *src, ssize_t l)
 118 {
 119     ssize_t len = MIN(m_strlen(src), l);
 120
 121     if (n > 0) {
 122         ssize_t dlen = MIN(n - 1, len);
 123         memcpy(dst, src, dlen);
 124         dst[dlen] = '\0';
 125     }
 126
 127     return len;
 128 }
 129
 130 char *m_strrtrim(char *s)
 131 {
 132     ssize_t len = m_strlen(s);
 133
 134     while (len > 1 && ISSPACE(s[len - 1]))
 135         s[--len] = '\0';
 136
 137     return s + len;
 138 }
 139
 140 const char *m_stristrn(const char *haystack, const char *needle, ssize_t nlen)
 141 {
 142     int nc;
 143
 144     if (!nlen)
 145         return haystack;
 146
 147     nc = tolower(*needle);
 148     for (;;) {
 149         int c = tolower(*haystack);
 150
 151         if (c != nc) {
 152             if (c == '\0')
 153                 return NULL;
 154         } else {
 155             ssize_t i;
 156
 157             /* compare the rest of needle */
 158             for (i = 1;; i++) {
 159                 if (i == nlen)
 160                     return haystack;
 161                 if (c == '\0')
 162                     return NULL;
 163                 c = tolower(haystack[i]);
 164                 if (c != tolower(needle[i]))
 165                     break;
 166             }
 167         }
 168
 169         haystack++;
 170     }
 171 }
 172
 173 /** \brief \c NULL resistant strcasecmp.
 174  * \param[in]  a     the first string.
 175  * \param[in]  b     the second string.
 176  * \return <tt>strcasecmp(a, b)</tt>, and treats \c NULL strings like \c ""
 177  *         ones, as if we were in the C locale.
 178  */
 179 int ascii_strcasecmp(const char *a, const char *b)
 180 {
 181     if (a == b)
 182         return 0;
 183     if (!a)
 184         return -1;
 185     if (!b)
 186         return 1;
 187
 188     while (*a || *b) {
 189         int i;
 190         if ((i = ascii_tolower(*a++) - ascii_tolower(*b++)))
 191             return i;
 192     }
 193
 194     return 0;
 195 }
 196
 197 /** \brief \c NULL resistant strncasecmp.
 198  * \param[in]  a     the first string.
 199  * \param[in]  b     the second string.
 200  * \param[in]  n     the number of maximum chars to compare.
 201  * \return <tt>strncasecmp(a, b)</tt>, and treats \c NULL strings like \c ""
 202  *         ones, as if we were in the C locale.
 203  */
 204 int ascii_strncasecmp(const char *a, const char *b, ssize_t n)
 205 {
 206     if (a == b)
 207         return 0;
 208     if (!a)
 209         return -1;
 210     if (!b)
 211         return 1;
 212
 213     while ((*a || *b) && n > 0) {
 214         int i;
 215         if ((i = ascii_tolower(*a++) - ascii_tolower(*b++)))
 216             return i;
 217         n--;
 218     }
 219
 220     return 0;
 221 }
 222
 223 /** \brief Retutnrs the on-screen width of the string, multi-byte aware.
 224  *
 225  * The function assumes that at rendering time, any non printable character or
 226  * any unrecognized multibyte sequence will be replaced with a 1-cell wide
 227  * char.
 228  *
 229  * \param[in]  s   the string;
 230  * \return the width of \c s.
 231  */
 232 ssize_t m_strwidth (const char *s)
 233 {
 234     const ssize_t len = m_strlen(s);
 235     mbstate_t mbstate;
 236     ssize_t w = 0, pos = 0;
 237
 238     p_clear(&mbstate, 1);
 239
 240     while (pos < len) {
 241         wchar_t wc;
 242         ssize_t nb;
 243
 244         nb = mbrtowc(&wc, s + pos, len - pos, &mbstate);
 245         switch (nb) {
 246           case -2:
 247             return w + 1;
 248
 249           case -1: /* assume we will replace that char with a ? later */
 250             wc = '?';
 251           default:
 252             w   += iswprint(wc) ? wcwidth(wc) : 1;
 253             pos += nb;
 254         }
 255     }
 256
 257     return w;
 258 }
 259
 260 ssize_t m_strformat(char *dst, ssize_t dlen, int width, const char *fmt,
 261                     format_t *callback, anytype cdata, format_flag flags)
 262 {
 263     ssize_t pos = flags & M_FORMAT_ARROWCURSOR ? 3 : 0;
 264
 265     m_strpad(dst, dlen, '\0', pos + 1);
 266     if (!fmt)
 267         return pos;
 268
 269     while (*fmt) {
 270         int ch;
 271
 272         if (*fmt == '%') {
 273             char ifstr[STRING], elstr[STRING], prefix[STRING];
 274
 275             *ifstr = *elstr = *prefix = '\0';
 276
 277             if (*++fmt == '%') {
 278                 pos += m_strputc(dst + pos, dlen - pos, *fmt++);
 279                 continue;
 280             }
 281
 282             if (*fmt == '?') {
 283                 flags |= M_FORMAT_OPTIONAL;
 284                 fmt++;
 285             } else {
 286                 ssize_t pfxlen;
 287                 flags &= ~M_FORMAT_OPTIONAL;
 288
 289                 /* eat the format string */
 290                 pfxlen = strspn(fmt, "0123456789.-");
 291                 m_strncpy(prefix, sizeof(prefix), fmt, pfxlen);
 292                 fmt   += pfxlen;
 293             }
 294
 295             /* save the character to switch on */
 296             if (!(ch = *fmt++))
 297                 break;
 298
 299             if (flags & M_FORMAT_OPTIONAL) {
 300                 ssize_t iflen;
 301                 const char *p;
 302
 303                 if (*fmt++ != '?')
 304                     break;                /* bad format */
 305
 306                 /* eat the `if' part of the string */
 307                 iflen = strcspn(fmt, "?&");
 308                 m_strncpy(ifstr, ssizeof(ifstr), fmt, iflen);
 309                 fmt  += iflen;
 310
 311                 /* eat the `else' part of the string (optional) */
 312                 if (*fmt == '&')
 313                     fmt++;                /* skip the & */
 314
 315                 p = m_strchrnul(fmt, '?');
 316                 m_strncpy(elstr, ssizeof(elstr), fmt, p - fmt);
 317                 fmt = p;
 318
 319                 if (!*fmt++)              /* move past the trailing `?' */
 320                     break;                /* bad format */
 321             }
 322
 323             switch (ch) {
 324                 char lower, nodots, buf[LONG_STRING];
 325
 326               case '>':                 /* right justify to EOL */
 327                 width -= m_strwidth(dst);
 328
 329                 ch = *fmt++;            /* pad char */
 330
 331                 if (width > 0) {
 332                     m_strformat(buf, sizeof(buf), 0, fmt, callback, cdata, flags);
 333                     width -= m_strwidth(buf);
 334                     pos += m_strpad(dst + pos, dlen - pos, ch, width);
 335                     pos += m_strcpy(dst + pos, dlen - pos, buf);
 336                 }
 337                 return pos;             /* skip rest of input */
 338
 339               case '|':                 /* pad to EOL */
 340                 width -= m_strwidth(dst);
 341                 return pos + m_strpad(dst + pos, dlen - pos, *fmt, width);
 342
 343               default:
 344                 lower = nodots = 0;
 345
 346                 while (ch == '_' || ch == ':') {
 347                     lower  |= ch == '_';
 348                     nodots |= ch == ':';
 349                     ch = *fmt++;
 350                 }
 351
 352                 /* use callback function to handle this case */
 353                 fmt = callback(buf, sizeof (buf), ch, fmt, prefix,
 354                                ifstr, elstr, cdata, flags);
 355
 356                 if (lower)
 357                     m_strtolower(buf);
 358
 359                 if (nodots) {
 360                     char *p;
 361
 362                     for (p = buf; *p; p++) {
 363                         if (*p == '.')
 364                             *p = '_';
 365                     }
 366                 }
 367
 368                 pos += m_strcpy(dst + pos, dlen - pos, buf);
 369                 break;
 370             }
 371             continue;
 372         }
 373
 374         if (*fmt == '\\') {
 375             if (!*++fmt)
 376                 break;
 377             switch ((ch = *fmt++)) {
 378               case 'n': pos += m_strputc(dst + pos, dlen - pos, '\n'); break;
 379               case 't': pos += m_strputc(dst + pos, dlen - pos, '\t'); break;
 380               case 'r': pos += m_strputc(dst + pos, dlen - pos, '\r'); break;
 381               case 'f': pos += m_strputc(dst + pos, dlen - pos, '\f'); break;
 382               case 'v': pos += m_strputc(dst + pos, dlen - pos, '\v'); break;
 383               default:  pos += m_strputc(dst + pos, dlen - pos, ch);   break;
 384             }
 385         } else {
 386             ssize_t len = strcspn(fmt, "%\\");
 387
 388             pos += m_strncpy(dst + pos, dlen - pos, fmt, len);
 389             fmt += len;
 390         }
 391     }
 392
 393     return pos;
 394 }
 395
 396 /*@}*/