include/Stack.h

   1 /*
   2  * $Id$
   3  *
   4  * AUTHOR: Alex Rousskov
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_STACK_H
  35 #define SQUID_STACK_H
  36
  37 #include "Array.h"
  38
  39 /* RBC: 20030714 Composition might be better long-term, but for now,
  40  * there's no reason to do so.
  41  */
  42
  43 template <class S = void *>
  44
  45 class Stack : public Vector<S>
  46 {
  47 public:
  48     using Vector<S>::count;
  49     using Vector<S>::items;
  50     typedef typename Vector<S>::value_type value_type;
  51     typedef typename Vector<S>::pointer pointer;
  52     value_type pop() {
  53         if (!count)
  54             return value_type();
  55
  56         value_type result = items[--count];
  57
  58         this->items[count] = value_type();
  59
  60         return result;
  61     }
  62
  63     /* todo, fatal on empty Top call */
  64     value_type top() const {
  65         return count ? items[count - 1] : value_type();
  66     }
  67 };
  68
  69 #endif /* SQUID_STACK_H */