]> git.sur5r.net Git - cc65/blobdiff - src/common/strbuf.c
Added cc65_symbol_byscope.
[cc65] / src / common / strbuf.c
index c763dbba14d1e21a6b68a41b2d90bdb1b99d1685..320e912932ac86ca1c9a15979a522a22e38cc98e 100644 (file)
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                                strbuf.c                                  */
+/*                                strbuf.c                                  */
 /*                                                                           */
 /*                      Variable sized string buffers                       */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2001             Ullrich von Bassewitz                                       */
-/*               Wacholderweg 14                                             */
-/*               D-70597 Stuttgart                                           */
-/* EMail:        uz@musoftware.de                                            */
+/* (C) 2001-2008 Ullrich von Bassewitz                                       */
+/*               Roemerstrasse 52                                            */
+/*               D-70794 Filderstadt                                         */
+/* EMail:        uz@cc65.org                                                 */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
 
 
 #include <string.h>
+#include <ctype.h>
 
 /* common */
-#include "xmalloc.h"
+#include "chartype.h"
 #include "strbuf.h"
+#include "va_copy.h"
+#include "xmalloc.h"
+#include "xsprintf.h"
 
 
 
 /*****************************************************************************/
-/*                                 Helpers                                  */
+/*                                  Data                                    */
 /*****************************************************************************/
 
 
 
-static void SB_Realloc (StrBuf* B, unsigned NewSize)
-/* Reallocate the string buffer space, make sure at least NewSize bytes are
- * available.
- */
-{
-    /* Get the current size, use a minimum of 8 bytes */
-    unsigned NewAllocated = B->Allocated;
-    if (NewAllocated == 0) {
-       NewAllocated = 8;
-    }
-
-    /* Round up to the next power of two */
-    while (NewAllocated < NewSize) {
-       NewAllocated *= 2;
-    }
-
-    /* Reallocate the buffer */
-    B->Buf       = xrealloc (B->Buf, NewAllocated);
-    B->Allocated = NewAllocated;
-}
+/* An empty string buf */
+const StrBuf EmptyStrBuf = STATIC_STRBUF_INITIALIZER;
 
 
 
@@ -76,24 +62,37 @@ static void SB_Realloc (StrBuf* B, unsigned NewSize)
 
 
 
-StrBuf* InitStrBuf (StrBuf* B)
+#if !defined(HAVE_INLINE)
+StrBuf* SB_Init (StrBuf* B)
 /* Initialize a string buffer */
+{
+    *B = EmptyStrBuf;
+    return B;
+}
+#endif
+
+
+
+StrBuf* SB_InitFromString (StrBuf* B, const char* S)
+/* Initialize a string buffer from a literal string. Beware: The buffer won't
+ * store a copy but a pointer to the actual string.
+ */
 {
     B->Allocated = 0;
-    B->Len       = 0;
-    B->Buf       = 0;
+    B->Len       = strlen (S);
+    B->Index     = 0;
+    B->Buf       = (char*) S;
     return B;
 }
 
 
 
-void DoneStrBuf (StrBuf* B)
+void SB_Done (StrBuf* B)
 /* Free the data of a string buffer (but not the struct itself) */
 {
-    xfree (B->Buf);
-    B->Allocated = 0;
-    B->Len       = 0;
-    B->Buf       = 0;
+    if (B->Allocated) {
+        xfree (B->Buf);
+    }
 }
 
 
@@ -105,7 +104,7 @@ StrBuf* NewStrBuf (void)
     StrBuf* B = xmalloc (sizeof (StrBuf));
 
     /* Initialize the struct... */
-    InitStrBuf (B);
+    SB_Init (B);
 
     /* ...and return it */
     return B;
@@ -116,13 +115,100 @@ StrBuf* NewStrBuf (void)
 void FreeStrBuf (StrBuf* B)
 /* Free a string buffer */
 {
-    /* Don't use Done here, since we won't use the struct later */
-    xfree (B->Buf);
+    SB_Done (B);
     xfree (B);
 }
 
 
 
+void SB_Realloc (StrBuf* B, unsigned NewSize)
+/* Reallocate the string buffer space, make sure at least NewSize bytes are
+ * available.
+ */
+{
+    /* Get the current size, use a minimum of 8 bytes */
+    unsigned NewAllocated = B->Allocated;
+    if (NewAllocated == 0) {
+       NewAllocated = 8;
+    }
+
+    /* Round up to the next power of two */
+    while (NewAllocated < NewSize) {
+       NewAllocated *= 2;
+    }
+
+    /* Reallocate the buffer. Beware: The allocated size may be zero while the
+     * length is not. This means that we have a buffer that wasn't allocated
+     * on the heap.
+     */
+    if (B->Allocated) {
+        /* Just reallocate the block */
+        B->Buf   = xrealloc (B->Buf, NewAllocated);
+    } else {
+        /* Allocate a new block and copy */
+        B->Buf   = memcpy (xmalloc (NewAllocated), B->Buf, B->Len);
+    }
+
+    /* Remember the new block size */
+    B->Allocated = NewAllocated;
+}
+
+
+
+static void SB_CheapRealloc (StrBuf* B, unsigned NewSize)
+/* Reallocate the string buffer space, make sure at least NewSize bytes are
+ * available. This function won't copy the old buffer contents over to the new
+ * buffer and may be used if the old contents are overwritten later.
+ */
+{
+    /* Get the current size, use a minimum of 8 bytes */
+    unsigned NewAllocated = B->Allocated;
+    if (NewAllocated == 0) {
+       NewAllocated = 8;
+    }
+
+    /* Round up to the next power of two */
+    while (NewAllocated < NewSize) {
+       NewAllocated *= 2;
+    }
+
+    /* Free the old buffer if there is one */
+    if (B->Allocated) {
+        xfree (B->Buf);
+    }
+
+    /* Allocate a fresh block */
+    B->Buf = xmalloc (NewAllocated);
+               
+    /* Remember the new block size */
+    B->Allocated = NewAllocated;
+}
+
+
+
+#if !defined(HAVE_INLINE)
+char SB_At (const StrBuf* B, unsigned Index)
+/* Get a character from the buffer */
+{
+    PRECONDITION (Index < B->Len);
+    return B->Buf[Index];
+}
+#endif
+
+
+
+void SB_Drop (StrBuf* B, unsigned Count)
+/* Drop characters from the end of the string. */
+{
+    PRECONDITION (Count <= B->Len);
+    B->Len -= Count;
+    if (B->Index > B->Len) {
+        B->Index = B->Len;
+    }
+}
+
+
+
 void SB_Terminate (StrBuf* B)
 /* Zero terminate the given string buffer. NOTE: The terminating zero is not
  * accounted for in B->Len, if you want that, you have to use AppendChar!
@@ -137,27 +223,54 @@ void SB_Terminate (StrBuf* B)
 
 
 
-void SB_AppendChar (StrBuf* B, char C)
+void SB_CopyBuf (StrBuf* Target, const char* Buf, unsigned Size)
+/* Copy Buf to Target, discarding the old contents of Target */
+{    
+    if (Size) {
+        if (Target->Allocated < Size) {
+            SB_CheapRealloc (Target, Size);
+        }
+        memcpy (Target->Buf, Buf, Size);
+    }
+    Target->Len = Size;
+}
+
+
+
+#if !defined(HAVE_INLINE)
+void SB_CopyStr (StrBuf* Target, const char* S)
+/* Copy S to Target, discarding the old contents of Target */
+{
+    SB_CopyBuf (Target, S, strlen (S));
+}
+#endif
+
+
+
+#if !defined(HAVE_INLINE)
+void SB_Copy (StrBuf* Target, const StrBuf* Source)
+/* Copy Source to Target, discarding the old contents of Target */
+{
+    SB_CopyBuf (Target, Source->Buf, Source->Len);
+    Target->Index = Source->Index;
+}
+#endif
+
+
+
+void SB_AppendChar (StrBuf* B, int C)
 /* Append a character to a string buffer */
 {
     unsigned NewLen = B->Len + 1;
     if (NewLen > B->Allocated) {
        SB_Realloc (B, NewLen);
     }
-    B->Buf[B->Len] = C;
+    B->Buf[B->Len] = (char) C;
     B->Len = NewLen;
 }
 
 
 
-void SB_AppendStr (StrBuf* B, const char* S)
-/* Append a string to the end of the string buffer */
-{
-    SB_AppendBuf (B, S, strlen (S));
-}
-
-
-
 void SB_AppendBuf (StrBuf* B, const char* S, unsigned Size)
 /* Append a character buffer to the end of the string buffer */
 {
@@ -171,23 +284,212 @@ void SB_AppendBuf (StrBuf* B, const char* S, unsigned Size)
 
 
 
-void SB_Copy (StrBuf* Target, const StrBuf* Source)
-/* Copy Source to Target, discarding the old contents of Target */
+#if !defined(HAVE_INLINE)
+void SB_AppendStr (StrBuf* B, const char* S)
+/* Append a string to the end of the string buffer */
 {
-    if (Target->Allocated < Source->Allocated) {
-       SB_Realloc (Target, Source->Allocated);
-    }
-    memcpy (Target->Buf, Source->Buf, Source->Len);
-    Target->Len = Source->Len;
+    SB_AppendBuf (B, S, strlen (S));
 }
+#endif
 
 
 
+#if !defined(HAVE_INLINE)
 void SB_Append (StrBuf* Target, const StrBuf* Source)
 /* Append the contents of Source to Target */
 {
     SB_AppendBuf (Target, Source->Buf, Source->Len);
 }
+#endif
+
+
+
+#if !defined(HAVE_INLINE)
+void SB_Cut (StrBuf* B, unsigned Len)
+/* Cut the contents of B at the given length. If the current length of the
+ * buffer is smaller than Len, nothing will happen.
+ */
+{
+    if (Len < B->Len) {
+               B->Len = Len;
+    }
+}
+#endif
+
+
+
+void SB_Slice (StrBuf* Target, const StrBuf* Source, unsigned Start, unsigned Len)
+/* Copy a slice from Source into Target. The current contents of Target are
+ * destroyed. If Start is greater than the length of Source, or if Len
+ * characters aren't available, the result will be a buffer with less than Len
+ * bytes.
+ */
+{
+    /* Calculate the length of the resulting buffer */
+    if (Start >= Source->Len) {
+               /* Target will be empty */
+       SB_Clear (Target);
+       return;
+    }
+    if (Start + Len > Source->Len) {
+               Len = Source->Len - Start;
+    }
+
+    /* Make sure we have enough room in the target string buffer */
+    if (Len > Target->Allocated) {
+       SB_Realloc (Target, Len);
+    }
+
+    /* Copy the slice */
+    memcpy (Target->Buf, Source->Buf + Start, Len);
+    Target->Len = Len;
+}
+
+
+
+void SB_Move (StrBuf* Target, StrBuf* Source)
+/* Move the complete contents of Source to target. This will delete the old
+ * contents of Target, and Source will be empty after the call.
+ */
+{
+    /* Free the target string */
+    if (Target->Allocated) {
+        xfree (Target->Buf);
+    }
+
+    /* Move all data from Source to Target */
+    *Target = *Source;
+
+    /* Clear Source */
+    SB_Init (Source);
+}
+
+
+
+void SB_ToLower (StrBuf* S)
+/* Convert all characters in S to lower case */
+{
+    unsigned I;
+    char* B = S->Buf;
+    for (I = 0; I < S->Len; ++I, ++B) {
+        if (IsUpper (*B)) {
+            *B = tolower (*B);
+        }
+    }
+}
+
+
+
+void SB_ToUpper (StrBuf* S)
+/* Convert all characters in S to upper case */
+{
+    unsigned I;
+    char* B = S->Buf;
+    for (I = 0; I < S->Len; ++I, ++B) {
+        if (IsLower (*B)) {
+            *B = toupper (*B);
+        }
+    }
+}
+
+
+
+int SB_Compare (const StrBuf* S1, const StrBuf* S2)
+/* Do a lexical compare of S1 and S2. See strcmp for result codes. */
+{
+    int Result;
+    if (S1->Len < S2->Len) {
+        Result = memcmp (S1->Buf, S2->Buf, S1->Len);
+        if (Result == 0) {
+            /* S1 considered lesser because it's shorter */
+            Result = -1;
+        }
+    } else if (S1->Len > S2->Len) {
+        Result = memcmp (S1->Buf, S2->Buf, S2->Len);
+        if (Result == 0) {
+            /* S2 considered lesser because it's shorter */
+            Result = 1;
+        }
+    } else {
+        Result = memcmp (S1->Buf, S2->Buf, S1->Len);
+    }
+    return Result;
+}
+
+
+
+int SB_CompareStr (const StrBuf* S1, const char* S2)
+/* Do a lexical compare of S1 and S2. See strcmp for result codes. */
+{
+    int Result;
+    unsigned S2Len = strlen (S2);
+    if (S1->Len < S2Len) {
+        Result = memcmp (S1->Buf, S2, S1->Len);
+        if (Result == 0) {
+            /* S1 considered lesser because it's shorter */
+            Result = -1;
+        }
+    } else if (S1->Len > S2Len) {
+        Result = memcmp (S1->Buf, S2, S2Len);
+        if (Result == 0) {
+            /* S2 considered lesser because it's shorter */
+            Result = 1;
+        }
+    } else {
+        Result = memcmp (S1->Buf, S2, S1->Len);
+    }
+    return Result;
+}
+
+
+
+void SB_VPrintf (StrBuf* S, const char* Format, va_list ap)
+/* printf function with S as target. The function is safe, which means that
+ * the current contents of S are discarded, and are allocated again with
+ * a matching size for the output. The function will call FAIL when problems
+ * are detected (anything that let xsnprintf return -1).
+ */
+{
+    va_list tmp;
+    int SizeNeeded;
+
+    /* Since we must determine the space needed anyway, we will try with
+     * the currently allocated memory. If the call succeeds, we've saved
+     * an allocation. If not, we have to reallocate and try again.
+     */
+    va_copy (tmp, ap);
+    SizeNeeded = xvsnprintf (S->Buf, S->Allocated, Format, tmp);
+    va_end (tmp);
+
+    /* Check the result, the xvsnprintf function should not fail */
+    CHECK (SizeNeeded >= 0);
+
+    /* Check if we must reallocate */
+    if ((unsigned) SizeNeeded >= S->Allocated) {
+        /* Must retry. Use CheapRealloc to avoid copying */
+        SB_CheapRealloc (S, SizeNeeded + 1);    /* Account for '\0' */
+        (void) xvsnprintf (S->Buf, S->Allocated, Format, ap);
+    }
+
+    /* Update string buffer variables */
+    S->Len = SizeNeeded;
+    S->Index = 0;
+}
+
+
+
+void SB_Printf (StrBuf* S, const char* Format, ...)
+/* vprintf function with S as target. The function is safe, which means that
+ * the current contents of S are discarded, and are allocated again with
+ * a matching size for the output. The function will call FAIL when problems
+ * are detected (anything that let xsnprintf return -1).
+ */
+{
+    va_list ap;
+    va_start (ap, Format);
+    SB_VPrintf (S, Format, ap);
+    va_end (ap);
+}