git.sur5r.net Git - cc65/blob - src/common/strbuf.c

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 strbuf.c                                  */
   4 /*                                                                           */
   5 /*                       Variable sized string buffers                       */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2001-2004 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #include <string.h>
  37
  38 /* common */
  39 #include "xmalloc.h"
  40 #include "strbuf.h"
  41
  42
  43
  44 /*****************************************************************************/
  45 /*                                   Data                                    */
  46 /*****************************************************************************/
  47
  48
  49
  50 /* An empty string buf */
  51 const StrBuf EmptyStrBuf = STATIC_STRBUF_INITIALIZER;
  52
  53
  54
  55 /*****************************************************************************/
  56 /*                                   Code                                    */
  57 /*****************************************************************************/
  58
  59
  60
  61 StrBuf* InitStrBuf (StrBuf* B)
  62 /* Initialize a string buffer */
  63 {
  64     B->Allocated = 0;
  65     B->Len       = 0;
  66     B->Index     = 0;
  67     B->Buf       = 0;
  68     return B;
  69 }
  70
  71
  72
  73 void DoneStrBuf (StrBuf* B)
  74 /* Free the data of a string buffer (but not the struct itself) */
  75 {
  76     xfree (B->Buf);
  77 }
  78
  79
  80
  81 StrBuf* NewStrBuf (void)
  82 /* Allocate, initialize and return a new StrBuf */
  83 {
  84     /* Allocate a new string buffer */
  85     StrBuf* B = xmalloc (sizeof (StrBuf));
  86
  87     /* Initialize the struct... */
  88     InitStrBuf (B);
  89
  90     /* ...and return it */
  91     return B;
  92 }
  93
  94
  95
  96 void FreeStrBuf (StrBuf* B)
  97 /* Free a string buffer */
  98 {
  99     DoneStrBuf (B);
 100     xfree (B);
 101 }
 102
 103
 104
 105 static void SB_Realloc (StrBuf* B, unsigned NewSize)
 106 /* Reallocate the string buffer space, make sure at least NewSize bytes are
 107  * available.
 108  */
 109 {
 110     /* Get the current size, use a minimum of 8 bytes */
 111     unsigned NewAllocated = B->Allocated;
 112     if (NewAllocated == 0) {
 113         NewAllocated = 8;
 114     }
 115
 116     /* Round up to the next power of two */
 117     while (NewAllocated < NewSize) {
 118         NewAllocated *= 2;
 119     }
 120
 121     /* Reallocate the buffer */
 122     B->Buf       = xrealloc (B->Buf, NewAllocated);
 123     B->Allocated = NewAllocated;
 124 }
 125
 126
 127
 128 #if !defined(HAVE_INLINE)
 129 char SB_At (const StrBuf* B, unsigned Index)
 130 /* Get a character from the buffer */
 131 {
 132     PRECONDITION (Index < B->Len);
 133     return B->Buf[Index];
 134 }
 135 #endif
 136
 137
 138
 139 void SB_Drop (StrBuf* B, unsigned Count)
 140 /* Drop characters from the end of the string. */
 141 {
 142     PRECONDITION (Count <= B->Len);
 143     B->Len -= Count;
 144     if (B->Index > B->Len) {
 145         B->Index = B->Len;
 146     }
 147 }
 148
 149
 150
 151 void SB_Terminate (StrBuf* B)
 152 /* Zero terminate the given string buffer. NOTE: The terminating zero is not
 153  * accounted for in B->Len, if you want that, you have to use AppendChar!
 154  */
 155 {
 156     unsigned NewLen = B->Len + 1;
 157     if (NewLen > B->Allocated) {
 158         SB_Realloc (B, NewLen);
 159     }
 160     B->Buf[B->Len] = '\0';
 161 }
 162
 163
 164
 165 void SB_CopyBuf (StrBuf* Target, const char* Buf, unsigned Size)
 166 /* Copy Buf to Target, discarding the old contents of Target */
 167 {
 168     if (Target->Allocated < Size) {
 169         SB_Realloc (Target, Size);
 170     }
 171     memcpy (Target->Buf, Buf, Size);
 172     Target->Len = Size;
 173 }
 174
 175
 176
 177 #if !defined(HAVE_INLINE)
 178 void SB_CopyStr (StrBuf* Target, const char* S)
 179 /* Copy S to Target, discarding the old contents of Target */
 180 {
 181     SB_CopyBuf (Target, S, strlen (S));
 182 }
 183 #endif
 184
 185
 186
 187 #if !defined(HAVE_INLINE)
 188 void SB_Copy (StrBuf* Target, const StrBuf* Source)
 189 /* Copy Source to Target, discarding the old contents of Target */
 190 {
 191     SB_CopyBuf (Target, Source->Buf, Source->Len);
 192     Target->Index = Source->Index;
 193 }
 194 #endif
 195
 196
 197
 198 void SB_AppendChar (StrBuf* B, int C)
 199 /* Append a character to a string buffer */
 200 {
 201     unsigned NewLen = B->Len + 1;
 202     if (NewLen > B->Allocated) {
 203         SB_Realloc (B, NewLen);
 204     }
 205     B->Buf[B->Len] = (char) C;
 206     B->Len = NewLen;
 207 }
 208
 209
 210
 211 void SB_AppendBuf (StrBuf* B, const char* S, unsigned Size)
 212 /* Append a character buffer to the end of the string buffer */
 213 {
 214     unsigned NewLen = B->Len + Size;
 215     if (NewLen > B->Allocated) {
 216         SB_Realloc (B, NewLen);
 217     }
 218     memcpy (B->Buf + B->Len, S, Size);
 219     B->Len = NewLen;
 220 }
 221
 222
 223
 224 #if !defined(HAVE_INLINE)
 225 void SB_AppendStr (StrBuf* B, const char* S)
 226 /* Append a string to the end of the string buffer */
 227 {
 228     SB_AppendBuf (B, S, strlen (S));
 229 }
 230 #endif
 231
 232
 233
 234 #if !defined(HAVE_INLINE)
 235 void SB_Append (StrBuf* Target, const StrBuf* Source)
 236 /* Append the contents of Source to Target */
 237 {
 238     SB_AppendBuf (Target, Source->Buf, Source->Len);
 239 }
 240 #endif
 241
 242
 243
 244 #if !defined(HAVE_INLINE)
 245 void SB_Cut (StrBuf* B, unsigned Len)
 246 /* Cut the contents of B at the given length. If the current length of the
 247  * buffer is smaller than Len, nothing will happen.
 248  */
 249 {
 250     if (Len < B->Len) {
 251         B->Len = Len;
 252     }
 253 }
 254 #endif
 255
 256
 257
 258 void SB_Slice (StrBuf* Target, const StrBuf* Source, unsigned Start, unsigned Len)
 259 /* Copy a slice from Source into Target. The current contents of Target are
 260  * destroyed. If Start is greater than the length of Source, or if Len
 261  * characters aren't available, the result will be a buffer with less than Len
 262  * bytes.
 263  */
 264 {
 265     /* Calculate the length of the resulting buffer */
 266     if (Start >= Source->Len) {
 267         /* Target will be empty */
 268         SB_Clear (Target);
 269         return;
 270     } else if (Start + Len > Source->Len) {
 271         Len = (Start + Len) - Source->Len;
 272     }
 273
 274     /* Make sure we have enough room in the target string buffer */
 275     if (Len > Target->Allocated) {
 276         SB_Realloc (Target, Len);
 277     }
 278
 279     /* Copy the slice */
 280     memcpy (Target->Buf, Source->Buf + Start, Len);
 281     Target->Len = Len;
 282 }
 283
 284
 285
 286 void SB_Move (StrBuf* Target, StrBuf* Source)
 287 /* Move the complete contents of Source to target. This will delete the old
 288  * contents of Target, and Source will be empty after the call.
 289  */
 290 {
 291     /* Free the target string */
 292     if (Target->Buf) {
 293         xfree (Target->Buf);
 294     }
 295
 296     /* Move all data from Source to Target */
 297     *Target = *Source;
 298
 299     /* Clear Source */
 300     InitStrBuf (Source);
 301 }
 302
 303
 304
 305 int SB_Compare (const StrBuf* S1, const StrBuf* S2)
 306 /* Do a lexical compare of S1 and S2. See strcmp for result codes. */
 307 {
 308     int Result;
 309     if (S1->Len < S2->Len) {
 310         Result = memcmp (S1->Buf, S2->Buf, S1->Len);
 311         if (Result == 0) {
 312             /* S1 considered lesser because it's shorter */
 313             Result = -1;
 314         }
 315     } else if (S1->Len > S2->Len) {
 316         Result = memcmp (S1->Buf, S2->Buf, S2->Len);
 317         if (Result == 0) {
 318             /* S2 considered lesser because it's shorter */
 319             Result = 1;
 320         }
 321     } else {
 322         Result = memcmp (S1->Buf, S2->Buf, S1->Len);
 323     }
 324     return Result;
 325 }
 326
 327
 328