git.sur5r.net Git - cc65/blob - src/cc65/litpool.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 litpool.h                                 */
   4 /*                                                                           */
   5 /*              Literal string handling for the cc65 C compiler              */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2009, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 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 #ifndef LITPOOL_H
  37 #define LITPOOL_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "strbuf.h"
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                   Data                                    */
  50 /*****************************************************************************/
  51
  52
  53
  54 /* Forward for struct SymEntry */
  55 struct SymEntry;
  56
  57
  58
  59 /*****************************************************************************/
  60 /*                                   Code                                    */
  61 /*****************************************************************************/
  62
  63
  64
  65 void InitLiteralPool (void);
  66 /* Initialize the literal pool */
  67
  68 void PushLiteralPool (struct SymEntry* Func);
  69 /* Push the current literal pool onto the stack and create a new one */
  70
  71 void PopLiteralPool (void);
  72 /* Free the current literal pool and restore the one from TOS */
  73
  74 void TranslateLiteralPool (unsigned Offs);
  75 /* Translate the literals starting from the given offset into the target
  76  * charset.
  77  */
  78
  79 void DumpLiteralPool (void);
  80 /* Dump the literal pool */
  81
  82 unsigned GetLiteralPoolLabel (void);
  83 /* Return the asm label for the current literal pool */
  84
  85 unsigned GetLiteralPoolOffs (void);
  86 /* Return the current offset into the literal pool */
  87
  88 void ResetLiteralPoolOffs (unsigned Offs);
  89 /* Reset the offset into the literal pool to some earlier value, effectively
  90  * removing values from the pool.
  91  */
  92
  93 unsigned AddLiteral (const char* S);
  94 /* Add a literal string to the literal pool. Return the starting offset into
  95  * the pool for this string.
  96  */
  97
  98 unsigned AddLiteralBuf (const void* Buf, unsigned Len);
  99 /* Add a buffer containing a literal string to the literal pool. Return the
 100  * starting offset into the pool for this string.
 101  */
 102
 103 unsigned AddLiteralStr (const StrBuf* S);
 104 /* Add a literal string to the literal pool. Return the starting offset into
 105  * the pool for this string.
 106  */
 107
 108 const char* GetLiteral (unsigned Offs);
 109 /* Get a pointer to the literal with the given offset in the pool */
 110
 111 void GetLiteralStrBuf (StrBuf* Target, unsigned Offs);
 112 /* Copy the string starting at Offs and lasting to the end of the buffer
 113  * into Target.
 114  */
 115
 116 void PrintLiteralPoolStats (FILE* F);
 117 /* Print statistics about the literal space used */
 118
 119
 120
 121 /* End of litpool.h */
 122 #endif
 123
 124
 125
 126