FreeNOS
Container.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Niek Linnenbank
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __LIBSTD_CONTAINER_H
19 #define __LIBSTD_CONTAINER_H
20 
21 #include "Types.h"
22 #include "Macros.h"
23 
35 class Container
36 {
37  public:
38 
42  Container();
43 
47  virtual ~Container();
48 
54  virtual Size size() const = 0;
55 
61  virtual Size count() const = 0;
62 
66  virtual void clear() = 0;
67 
73  virtual bool isEmpty() const;
74 
82  virtual bool reserve(Size size);
83 
91  virtual bool shrink(Size size);
92 
98  virtual Size squeeze();
99 
107  virtual bool resize(Size size);
108 };
109 
115 #endif /* __LIBSTD_CONTAINER_H */
Macros.h
Types.h
Container::count
virtual Size count() const =0
Returns the number of items inside the Container.
Container
Containers provide access to stored items.
Definition: Container.h:35
Container::reserve
virtual bool reserve(Size size)
Ensure that at least the given size is available.
Definition: Container.cpp:33
Container::isEmpty
virtual bool isEmpty() const
Check if the Container is empty.
Definition: Container.cpp:28
Container::shrink
virtual bool shrink(Size size)
Shrink the container size by the given amount of items.
Definition: Container.cpp:41
Container::squeeze
virtual Size squeeze()
Try to minimize the memory required in the Container.
Definition: Container.cpp:46
Container::resize
virtual bool resize(Size size)
Change the size of the Container.
Definition: Container.cpp:51
Container::~Container
virtual ~Container()
Destructor.
Definition: Container.cpp:24
Size
unsigned int Size
Any sane size indicator cannot go negative.
Definition: Types.h:128
Container::clear
virtual void clear()=0
Removes all items from the Container.
Container::Container
Container()
Constructor.
Definition: Container.cpp:20
Container::size
virtual Size size() const =0
Returns the maximum size of this Container.