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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                strstack.h                                 */
   4 /*                                                                           */
   5 /*                  String stack used for program settings                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2004      Ullrich von Bassewitz                                       */
  10 /*               Römerstraße 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 STRSTACK_H
  37 #define STRSTACK_H
  38
  39
  40
  41 #include "inline.h"
  42
  43
  44
  45 /*****************************************************************************/
  46 /*                                   Data                                    */
  47 /*****************************************************************************/
  48
  49
  50
  51 typedef struct StrStack StrStack;
  52 struct StrStack {
  53     unsigned    Count;
  54     char*       Stack[8];
  55 };
  56
  57 /* Declare an empty string stack */
  58 #define STRSTACK()      { 0 };
  59
  60
  61
  62 /*****************************************************************************/
  63 /*                                   Code                                    */
  64 /*****************************************************************************/
  65
  66
  67
  68 #if defined(HAVE_INLINE)
  69 INLINE int SS_IsFull (const StrStack* S)
  70 /* Return true if there is no space left on the given string stack */
  71 {
  72     return (S->Count >= sizeof (S->Stack) / sizeof (S->Stack[0]));
  73 }
  74 #else
  75 #  define SS_IsFull(S)  ((S)->Count >= sizeof ((S)->Stack) / sizeof ((S)->Stack[0]))
  76 #endif
  77
  78 #if defined(HAVE_INLINE)
  79 INLINE unsigned SS_GetCount (const StrStack* S)
  80 /* Return the number of elements on the given string stack */
  81 {
  82     return S->Count;
  83 }
  84 #else
  85 #  define SS_GetCount(S)        (S)->Count
  86 #endif
  87
  88 const char* SS_Get (const StrStack* S);
  89 /* Get the value on top of a string stack */
  90
  91 void SS_Set (StrStack* S, const char* Val);
  92 /* Set the value on top of a string stack */
  93
  94 void SS_Drop (StrStack* S);
  95 /* Drop a value from a string stack */
  96
  97 void SS_Push (StrStack* S, const char* Val);
  98 /* Push a value onto a string stack */
  99
 100
 101
 102 /* End of strstack.h */
 103 #endif
 104
 105
 106