X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fsupport%2Flimited_stack.h;h=b17eeae19dbca92efecaedff761a8f40d73d8744;hb=8d640dc77608bedddb5b00982c23665584f52d21;hp=fa05691ce5411232c2002dfa63d543aec75db3fa;hpb=5b4633d0d1d578b51ba25af97223d77430deb2b1;p=lyx.git diff --git a/src/support/limited_stack.h b/src/support/limited_stack.h index fa05691ce5..b17eeae19d 100644 --- a/src/support/limited_stack.h +++ b/src/support/limited_stack.h @@ -6,7 +6,7 @@ * * \author John Levon * - * Full author contact details are available in file CREDITS + * Full author contact details are available in file CREDITS. */ #ifndef LIMITED_STACK_H @@ -14,8 +14,11 @@ #include + +namespace lyx { + /** - * limited_stack - a stack of limited size + * limited_stack - A stack of limited size. * * Like a normal stack, but elements falling out * of the bottom are destructed. @@ -26,35 +29,34 @@ public: typedef std::deque container_type; typedef typename container_type::value_type value_type; typedef typename container_type::size_type size_type; + typedef typename container_type::const_iterator const_iterator; /// limit is the maximum size of the stack limited_stack(size_type limit = 100) { limit_ = limit; } - /// return the top element - value_type top() { + /// Return the top element. + value_type & top() { return c_.front(); } - /// pop and throw away the top element + /// Pop and throw away the top element. void pop() { c_.pop_front(); } - /// return true if the stack is empty + /// Return true if the stack is empty. bool empty() const { - return c_.size() == 0; + return c_.empty(); } - /// clear all elements, deleting them + /// Clear all elements, deleting them. void clear() { - while (!c_.empty()) { - c_.pop_back(); - } + c_.clear(); } - /// push an item on to the stack, deleting the + /// Push an item on to the stack, deleting the /// bottom item on overflow. void push(value_type const & v) { c_.push_front(v); @@ -63,24 +65,36 @@ public: } } - /// direct read access to intermediate elements + /// Direct read access to intermediate elements. T const & operator[](size_type pos) const { return c_[pos]; } - /// read access to used size + /// Read access to used size. size_type size() const { return c_.size(); } + + const_iterator begin() const { + return c_.begin(); + } + + const_iterator end() const { + return c_.end(); + } + private: - /// internal contents + /// Internal contents. container_type c_; - /// the maximum number elements stored + /// The maximum number elements stored. size_type limit_; }; -// make pointer type an error. +// Make pointer type an error. template class limited_stack; + +} // namespace lyx + #endif // LIMITED_STACK_H