autodoc/source/inc/estack.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: estack.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_ESTACK_HXX
  32 #define ARY_ESTACK_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <slist>
  39     // COMPONENTS
  40     // PARAMETERS
  41
  42
  43
  44 template <class ELEM>
  45 class EStack : private std::slist<ELEM>
  46 {
  47   private:
  48     typedef std::slist<ELEM>    base;
  49     const base &        Base() const            { return *this; }
  50     base &              Base()                  { return *this; }
  51
  52   public:
  53     typedef ELEM                                    value_type;
  54     typedef typename std::slist<ELEM>::size_type    size_type;
  55
  56     // LIFECYCLE
  57                         EStack()                                {}
  58                         EStack(
  59                             const EStack &      i_rStack )
  60                                                 :       base( (const base &)(i_rStack) ) {}
  61                         ~EStack()                               {}
  62     // OPERATORS
  63     EStack &            operator=(
  64                             const EStack &      i_rStack )
  65                                                 { base::operator=( i_rStack.Base() );
  66                                                   return *this; }
  67     bool                operator==(
  68                             const EStack<ELEM> &
  69                                                 i_r2 ) const
  70                                                 { return std::operator==( Base(), this->i_rStack.Base() ); }
  71     bool                operator<(
  72                             const EStack<ELEM> &
  73                                                 i_r2 ) const
  74                                                 { return std::operator<( Base(), this->i_rStack.Base() ); }
  75     // OPERATIONS
  76     void                push(
  77                             const value_type &  i_rElem )
  78                                                 { base::push_front(i_rElem); }
  79     void                pop()                   { base::pop_front(); }
  80     void                erase_all()             { while (NOT empty()) pop(); }
  81
  82     // INQUIRY
  83     const value_type &  top() const             { return base::front(); }
  84     size_type           size() const            { return base::size(); }
  85     bool                empty() const           { return base::empty(); }
  86
  87     // ACCESS
  88     value_type &        top()                   { return base::front(); }
  89 };
  90
  91
  92
  93 // IMPLEMENTATION
  94
  95
  96 #endif
  97