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      Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  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->Buf       = 0;
  67     return B;
  68 }
  69
  70
  71
  72 void DoneStrBuf (StrBuf* B)
  73 /* Free the data of a string buffer (but not the struct itself) */
  74 {
  75     xfree (B->Buf);
  76 }
  77
  78
  79
  80 StrBuf* NewStrBuf (void)
  81 /* Allocate, initialize and return a new StrBuf */
  82 {
  83     /* Allocate a new string buffer */
  84     StrBuf* B = xmalloc (sizeof (StrBuf));
  85
  86     /* Initialize the struct... */
  87     InitStrBuf (B);
  88
  89     /* ...and return it */
  90     return B;
  91 }
  92
  93
  94
  95 void FreeStrBuf (StrBuf* B)
  96 /* Free a string buffer */
  97 {
  98     DoneStrBuf (B);
  99     xfree (B);
 100 }
 101
 102
 103
 104 void SB_Realloc (StrBuf* B, unsigned NewSize)
 105 /* Reallocate the string buffer space, make sure at least NewSize bytes are
 106  * available.
 107  */
 108 {
 109     /* Get the current size, use a minimum of 8 bytes */
 110     unsigned NewAllocated = B->Allocated;
 111     if (NewAllocated == 0) {
 112         NewAllocated = 8;
 113     }
 114
 115     /* Round up to the next power of two */
 116     while (NewAllocated < NewSize) {
 117         NewAllocated *= 2;
 118     }
 119
 120     /* Reallocate the buffer */
 121     B->Buf       = xrealloc (B->Buf, NewAllocated);
 122     B->Allocated = NewAllocated;
 123 }
 124
 125
 126
 127 #if !defined(HAVE_INLINE)
 128 char SB_At (const StrBuf* B, unsigned Index)
 129 /* Get a character from the buffer */
 130 {
 131     PRECONDITION (Index < B->Len);
 132     return B->Buf[Index];
 133 }
 134 #endif
 135
 136
 137
 138 void SB_Terminate (StrBuf* B)
 139 /* Zero terminate the given string buffer. NOTE: The terminating zero is not
 140  * accounted for in B->Len, if you want that, you have to use AppendChar!
 141  */
 142 {
 143     unsigned NewLen = B->Len + 1;
 144     if (NewLen > B->Allocated) {
 145         SB_Realloc (B, NewLen);
 146     }
 147     B->Buf[B->Len] = '\0';
 148 }
 149
 150
 151
 152 void SB_CopyBuf (StrBuf* Target, const char* Buf, unsigned Size)
 153 /* Copy Buf to Target, discarding the old contents of Target */
 154 {
 155     if (Target->Allocated < Size) {
 156         SB_Realloc (Target, Size);
 157     }
 158     memcpy (Target->Buf, Buf, Size);
 159     Target->Len = Size;
 160 }
 161
 162
 163
 164 #if !defined(HAVE_INLINE)
 165 void SB_CopyStr (StrBuf* Target, const char* S)
 166 /* Copy S to Target, discarding the old contents of Target */
 167 {
 168     SB_CopyBuf (Target, S, strlen (S));
 169 }
 170 #endif
 171
 172
 173
 174 #if !defined(HAVE_INLINE)
 175 void SB_Copy (StrBuf* Target, const StrBuf* Source)
 176 /* Copy Source to Target, discarding the old contents of Target */
 177 {
 178     SB_CopyBuf (Target, Source->Buf, Source->Len);
 179 }
 180 #endif
 181
 182
 183
 184 void SB_AppendChar (StrBuf* B, char C)
 185 /* Append a character to a string buffer */
 186 {
 187     unsigned NewLen = B->Len + 1;
 188     if (NewLen > B->Allocated) {
 189         SB_Realloc (B, NewLen);
 190     }
 191     B->Buf[B->Len] = C;
 192     B->Len = NewLen;
 193 }
 194
 195
 196
 197 void SB_AppendBuf (StrBuf* B, const char* S, unsigned Size)
 198 /* Append a character buffer to the end of the string buffer */
 199 {
 200     unsigned NewLen = B->Len + Size;
 201     if (NewLen > B->Allocated) {
 202         SB_Realloc (B, NewLen);
 203     }
 204     memcpy (B->Buf + B->Len, S, Size);
 205     B->Len = NewLen;
 206 }
 207
 208
 209
 210 #if !defined(HAVE_INLINE)
 211 void SB_AppendStr (StrBuf* B, const char* S)
 212 /* Append a string to the end of the string buffer */
 213 {
 214     SB_AppendBuf (B, S, strlen (S));
 215 }
 216 #endif
 217
 218
 219
 220 #if !defined(HAVE_INLINE)
 221 void SB_Append (StrBuf* Target, const StrBuf* Source)
 222 /* Append the contents of Source to Target */
 223 {
 224     SB_AppendBuf (Target, Source->Buf, Source->Len);
 225 }
 226 #endif
 227
 228
 229
 230 #if !defined(HAVE_INLINE)
 231 void SB_Cut (StrBuf* B, unsigned Len)
 232 /* Cut the contents of B at the given length. If the current length of the
 233  * buffer is smaller than Len, nothing will happen.
 234  */
 235 {
 236     if (Len < B->Len) {
 237         B->Len = Len;
 238     }
 239 }
 240 #endif
 241
 242
 243
 244 void SB_Slice (StrBuf* Target, const StrBuf* Source, unsigned Start, unsigned Len)
 245 /* Copy a slice from Source into Target. The current contents of Target are
 246  * destroyed. If Start is greater than the length of Source, or if Len
 247  * characters aren't available, the result will be a buffer with less than Len
 248  * bytes.
 249  */
 250 {
 251     /* Calculate the length of the resulting buffer */
 252     if (Start >= Source->Len) {
 253         /* Target will be empty */
 254         SB_Clear (Target);
 255         return;
 256     } else if (Start + Len > Source->Len) {
 257         Len = (Start + Len) - Source->Len;
 258     }
 259
 260     /* Make sure we have enough room in the target string buffer */
 261     if (Len > Target->Allocated) {
 262         SB_Realloc (Target, Len);
 263     }
 264
 265     /* Copy the slice */
 266     memcpy (Target->Buf, Source->Buf + Start, Len);
 267     Target->Len = Len;
 268 }
 269
 270
 271