WDL/wdlcstring.h

   1 /*
   2     WDL - wdlcstring.h
   3     Copyright (C) 2005 and later, Cockos Incorporated
   4
   5     This software is provided 'as-is', without any express or implied
   6     warranty.  In no event will the authors be held liable for any damages
   7     arising from the use of this software.
   8
   9     Permission is granted to anyone to use this software for any purpose,
  10     including commercial applications, and to alter it and redistribute it
  11     freely, subject to the following restrictions:
  12
  13     1. The origin of this software must not be misrepresented; you must not
  14        claim that you wrote the original software. If you use this software
  15        in a product, an acknowledgment in the product documentation would be
  16        appreciated but is not required.
  17     2. Altered source versions must be plainly marked as such, and must not be
  18        misrepresented as being the original software.
  19     3. This notice may not be removed or altered from any source distribution.
  20
  21 */
  22
  23 /*
  24 C string manipulation utilities -- [v]snprintf for Win32, also snprintf_append, lstrcatn, etc
  25   */
  26 #ifndef _WDL_CSTRING_H_
  27 #define _WDL_CSTRING_H_
  28
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <ctype.h>
  32
  33 #include "wdltypes.h"
  34
  35 #ifdef _WDL_CSTRING_IMPL_ONLY_
  36   #ifdef _WDL_CSTRING_IF_ONLY_
  37     #undef _WDL_CSTRING_IF_ONLY_
  38   #endif
  39   #define _WDL_CSTRING_PREFIX
  40 #else
  41   #define _WDL_CSTRING_PREFIX static WDL_STATICFUNC_UNUSED
  42 #endif
  43
  44
  45
  46 #if defined(_WIN32) && defined(_MSC_VER)
  47   // provide snprintf()/vsnprintf() for win32 -- note that these have no way of knowing
  48   // what the amount written was, code should(must) be written to not depend on this.
  49   #ifdef snprintf
  50   #undef snprintf
  51   #endif
  52   #define snprintf WDL_snprintf
  53
  54   #ifdef vsnprintf
  55   #undef vsnprintf
  56   #endif
  57   #define vsnprintf WDL_vsnprintf
  58
  59 #endif // win32 snprintf/vsnprintf
  60
  61 // use wdlcstring.h's lstrcpyn_safe rather than the real lstrcpyn.
  62 #ifdef _WIN32
  63   #ifdef lstrcpyn
  64   #undef lstrcpyn
  65   #endif
  66   #define lstrcpyn lstrcpyn_safe
  67 #endif
  68
  69 #ifdef __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 #ifdef _WDL_CSTRING_IF_ONLY_
  74
  75   void lstrcpyn_safe(char *o, const char *in, int count);
  76   void lstrcatn(char *o, const char *in, int count);
  77   void WDL_VARARG_WARN(printf,3,4) snprintf_append(char *o, int count, const char *format, ...);
  78   void vsnprintf_append(char *o, int count, const char *format, va_list va);
  79
  80   const char *WDL_get_filepart(const char *str); // returns whole string if no dir chars
  81   const char *WDL_get_fileext(const char *str); // returns ".ext" or end of string "" if no extension
  82   char *WDL_remove_fileext(char *str); // returns pointer to "ext" if ".ext" was removed (zero-d dot), or NULL
  83   char WDL_remove_filepart(char *str); // returns dir character that was zeroed, or 0 if new string is empty
  84   int WDL_remove_trailing_dirchars(char *str); // returns trailing dirchar count removed, will not convert "/" into ""
  85   size_t WDL_remove_trailing_crlf(char *str); // returns new length
  86
  87
  88   #if defined(_WIN32) && defined(_MSC_VER)
  89     void WDL_vsnprintf(char *o, size_t count, const char *format, va_list args);
  90     void WDL_VARARG_WARN(printf,3,4) WDL_snprintf(char *o, size_t count, const char *format, ...);
  91   #endif
  92
  93   int WDL_strcmp_logical(const char *s1, const char *s2, int case_sensitive);
  94 #else
  95
  96
  97   #if defined(_WIN32) && defined(_MSC_VER)
  98
  99     _WDL_CSTRING_PREFIX void WDL_vsnprintf(char *o, size_t count, const char *format, va_list args)
 100     {
 101       if (count>0)
 102       {
 103         int rv;
 104         o[0]=0;
 105         rv=_vsnprintf(o,count,format,args); // returns -1  if over, and does not null terminate, ugh
 106         if (rv < 0 || rv>=(int)count-1) o[count-1]=0;
 107       }
 108     }
 109     _WDL_CSTRING_PREFIX void WDL_VARARG_WARN(printf,3,4) WDL_snprintf(char *o, size_t count, const char *format, ...)
 110     {
 111       if (count>0)
 112       {
 113         int rv;
 114         va_list va;
 115         va_start(va,format);
 116         o[0]=0;
 117         rv=_vsnprintf(o,count,format,va); // returns -1  if over, and does not null terminate, ugh
 118         va_end(va);
 119
 120         if (rv < 0 || rv>=(int)count-1) o[count-1]=0;
 121       }
 122     }
 123   #endif
 124
 125   _WDL_CSTRING_PREFIX void lstrcpyn_safe(char *o, const char *in, int count)
 126   {
 127     if (count>0)
 128     {
 129       while (--count>0 && *in) *o++ = *in++;
 130       *o=0;
 131     }
 132   }
 133
 134   _WDL_CSTRING_PREFIX void lstrcatn(char *o, const char *in, int count)
 135   {
 136     if (count>0)
 137     {
 138       while (*o) { if (--count < 1) return; o++; }
 139       while (--count>0 && *in) *o++ = *in++;
 140       *o=0;
 141     }
 142   }
 143
 144   _WDL_CSTRING_PREFIX const char *WDL_get_filepart(const char *str) // returns whole string if no dir chars
 145   {
 146     const char *p = str;
 147     while (*p) p++;
 148     while (p >= str && !WDL_IS_DIRCHAR(*p)) --p;
 149     return p + 1;
 150   }
 151   _WDL_CSTRING_PREFIX const char *WDL_get_fileext(const char *str) // returns ".ext" or end of string "" if no extension
 152   {
 153     const char *p=str, *ep;
 154     while (*p) p++;
 155     ep = p;
 156     while (p >= str && !WDL_IS_DIRCHAR(*p))
 157     {
 158       if (*p == '.') return p;
 159       --p;
 160     }
 161     return ep;
 162   }
 163
 164   _WDL_CSTRING_PREFIX char *WDL_remove_fileext(char *str) // returns pointer to "ext" if ".ext" was removed (zero-d dot), or NULL
 165   {
 166     char *p=str;
 167     while (*p) p++;
 168     while (p >= str && !WDL_IS_DIRCHAR(*p))
 169     {
 170       if (*p == '.')
 171       {
 172         *p = 0;
 173         return p+1;
 174       }
 175       --p;
 176     }
 177     return NULL;
 178   }
 179
 180   _WDL_CSTRING_PREFIX char WDL_remove_filepart(char *str) // returns dir character that was zeroed, or 0 if new string is empty
 181   {
 182     char *p=str;
 183     while (*p) p++;
 184     while (p >= str)
 185     {
 186       char c = *p;
 187       if (WDL_IS_DIRCHAR(c))
 188       {
 189         *p = 0;
 190         return c;
 191       }
 192       --p;
 193     }
 194     str[0] = 0;
 195     return 0;
 196   }
 197
 198   _WDL_CSTRING_PREFIX int WDL_remove_trailing_dirchars(char *str) // returns trailing dirchar count removed
 199   {
 200     int cnt = 0;
 201     char *p=str;
 202     while (*p) p++;
 203     while (p > str+1 && WDL_IS_DIRCHAR(p[-1]))
 204     {
 205       cnt++;
 206       p--;
 207     }
 208     *p = 0;
 209     return cnt;
 210   }
 211
 212   _WDL_CSTRING_PREFIX size_t WDL_remove_trailing_crlf(char *str) // returns new length
 213   {
 214     char *p=str;
 215     while (*p) p++;
 216     while (p > str && (p[-1] == '\r' || p[-1] == '\n')) p--;
 217     *p = 0;
 218     return p-str;
 219   }
 220
 221   _WDL_CSTRING_PREFIX void WDL_VARARG_WARN(printf,3,4) snprintf_append(char *o, int count, const char *format, ...)
 222   {
 223     if (count>0)
 224     {
 225       va_list va;
 226       while (*o) { if (--count < 1) return; o++; }
 227       va_start(va,format);
 228       vsnprintf(o,count,format,va);
 229       va_end(va);
 230     }
 231   }
 232
 233   _WDL_CSTRING_PREFIX void vsnprintf_append(char *o, int count, const char *format, va_list va)
 234   {
 235     if (count>0)
 236     {
 237       while (*o) { if (--count < 1) return; o++; }
 238       vsnprintf(o,count,format,va);
 239     }
 240   }
 241
 242   _WDL_CSTRING_PREFIX int WDL_strcmp_logical(const char *s1, const char *s2, int case_sensitive)
 243   {
 244     // also exists as WDL_LogicalSortStringKeyedArray::_cmpstr()
 245
 246     char lastNonZeroChar=0;
 247     // last matching character, updated if not 0. this allows us to track whether
 248     // we are inside of a number with the same leading digits
 249
 250     for (;;)
 251     {
 252       char c1=*s1++, c2=*s2++;
 253       if (!c1) return c1-c2;
 254
 255       if (c1!=c2)
 256       {
 257         if (c1 >= '0' && c1 <= '9' && c2 >= '0' && c2 <= '9')
 258         {
 259           int lzdiff=0, cnt=0;
 260           if (lastNonZeroChar < '1' || lastNonZeroChar > '9')
 261           {
 262             while (c1 == '0') { c1=*s1++; lzdiff--; }
 263             while (c2 == '0') { c2=*s2++; lzdiff++; } // lzdiff = lz2-lz1, more leading 0s = earlier in list
 264           }
 265
 266           for (;;)
 267           {
 268             if (c1 >= '0' && c1 <= '9')
 269             {
 270               if (c2 < '0' || c2 > '9') return 1;
 271
 272               c1=s1[cnt];
 273               c2=s2[cnt++];
 274             }
 275             else
 276             {
 277               if (c2 >= '0' && c2 <= '9') return -1;
 278               break;
 279             }
 280           }
 281
 282           s1--;
 283           s2--;
 284
 285           while (cnt--)
 286           {
 287             const int d = *s1++ - *s2++;
 288             if (d) return d;
 289           }
 290
 291           if (lzdiff) return lzdiff;
 292         }
 293         else
 294         {
 295           if (!case_sensitive)
 296           {
 297             if (c1>='a' && c1<='z') c1+='A'-'a';
 298             if (c2>='a' && c2<='z') c2+='A'-'a';
 299           }
 300           if (c1 != c2) return c1-c2;
 301         }
 302       }
 303       else if (c1 != '0') lastNonZeroChar=c1;
 304     }
 305   }
 306
 307 #endif
 308
 309
 310 #ifdef __cplusplus
 311 };
 312 #endif
 313
 314 #undef _WDL_CSTRING_PREFIX
 315
 316 #endif