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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 strbuf.h                                  */
   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 #ifndef STRBUF_H
  37 #define STRBUF_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                   Data                                    */
  43 /*****************************************************************************/
  44
  45
  46
  47 typedef struct StrBuf StrBuf;
  48 struct StrBuf {
  49     unsigned    Allocated;
  50     unsigned    Len;
  51     char*       Buf;
  52 };
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                   Code                                    */
  58 /*****************************************************************************/
  59
  60
  61
  62 StrBuf* InitStrBuf (StrBuf* B);
  63 /* Initialize a string buffer */
  64
  65 void DoneStrBuf (StrBuf* B);
  66 /* Free the data of a string buffer (but not the struct itself) */
  67
  68 StrBuf* NewStrBuf (void);
  69 /* Allocate, initialize and return a new StrBuf */
  70
  71 void FreeStrBuf (StrBuf* B);
  72 /* Free a string buffer */
  73
  74 void SB_Terminate (StrBuf* B);
  75 /* Zero terminate the given string buffer. NOTE: The terminating zero is not
  76  * accounted for in B->Len, if you want that, you have to use AppendChar!
  77  */
  78
  79 void SB_AppendChar (StrBuf* B, char C);
  80 /* Append a character to a string buffer */
  81
  82 void SB_AppendStr (StrBuf* B, const char* S);
  83 /* Append a string to the end of the string buffer */
  84
  85 void SB_AppendBuf (StrBuf* B, const char* S, unsigned Size);
  86 /* Append a character buffer to the end of the string buffer */
  87
  88 void SB_Copy (StrBuf* Target, const StrBuf* Source);
  89 /* Copy Source to Target, discarding the old contents of Target */
  90
  91 void SB_Append (StrBuf* Target, const StrBuf* Source);
  92 /* Append the contents of Source to Target */
  93
  94
  95
  96 /* End of strbuf.h */
  97
  98 #endif
  99
 100
 101