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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                intstack.h                                 */
   4 /*                                                                           */
   5 /*                  Integer stack used for program settings                  */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2004-2010, 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 INTSTACK_H
  37 #define INTSTACK_H
  38
  39
  40
  41 #include "inline.h"
  42
  43
  44
  45 /*****************************************************************************/
  46 /*                                   Data                                    */
  47 /*****************************************************************************/
  48
  49
  50
  51 typedef struct IntStack IntStack;
  52 struct IntStack {
  53     unsigned    Count;
  54     long        Stack[8];
  55 };
  56
  57 /* An initializer for an empty int stack */
  58 #define STATIC_INTSTACK_INITIALIZER     { 0, { 0, 0, 0, 0, 0, 0, 0, 0 } }
  59
  60 /* Declare an int stack with the given value as first element */
  61 #define INTSTACK(Val)   { 1, { Val, 0, 0, 0, 0, 0, 0, 0 } }
  62
  63
  64
  65 /*****************************************************************************/
  66 /*                                   Code                                    */
  67 /*****************************************************************************/
  68
  69
  70
  71 #if defined(HAVE_INLINE)
  72 INLINE int IS_IsFull (const IntStack* S)
  73 /* Return true if there is no space left on the given int stack */
  74 {
  75     return (S->Count >= sizeof (S->Stack) / sizeof (S->Stack[0]));
  76 }
  77 #else
  78 #  define IS_IsFull(S)  ((S)->Count >= sizeof ((S)->Stack) / sizeof ((S)->Stack[0]))
  79 #endif
  80
  81 #if defined(HAVE_INLINE)
  82 INLINE int IS_IsEmpty (const IntStack* S)
  83 /* Return true if there are no values on the given int stack */
  84 {
  85     return (S->Count == 0);
  86 }
  87 #else
  88 #  define IS_IsEmpty(S)  ((S)->Count == 0)
  89 #endif
  90
  91 #if defined(HAVE_INLINE)
  92 INLINE unsigned IS_GetCount (const IntStack* S)
  93 /* Return the number of elements on the given int stack */
  94 {
  95     return S->Count;
  96 }
  97 #else
  98 #  define IS_GetCount(S)        (S)->Count
  99 #endif
 100
 101 long IS_Get (const IntStack* S);
 102 /* Get the value on top of an int stack */
 103
 104 void IS_Set (IntStack* S, long Val);
 105 /* Set the value on top of an int stack */
 106
 107 void IS_Drop (IntStack* S);
 108 /* Drop a value from an int stack */
 109
 110 void IS_Push (IntStack* S, long Val);
 111 /* Push a value onto an int stack */
 112
 113 long IS_Pop (IntStack* S);
 114 /* Pop a value from an int stack */
 115
 116
 117
 118 /* End of intstack.h */
 119
 120 #endif