ptr_linked_pool.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class PTR_LINKED_POOL

#ifndef PTR_LINKED_POOL_H
#define PTR_LINKED_POOL_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

#ifndef SINGLY_LINKED_LIST_H
#include "SheafSystem/singly_linked_list.h"
#endif

namespace sheaf
{

template <typename T>
class SHEAF_DLL_SPEC ptr_linked_pool
{
public:


  size_t capacity() const;

  size_t free_size() const;

  size_t allocated_size() const;

  void reserve(size_t xcapacity);

  void clear();

  T* allocate();

  void deallocate(T* xobject);
  
  void print() const;

  void print(std::ostream& xos) const;
        
  ptr_linked_pool(size_t xcapacity = 1024);

  ~ptr_linked_pool();


private:

  size_t _capacity;

  size_t _free_size;

  T* _free_list;

  singly_linked_list<block<T>*> _chunk_list;

};
 

//==============================================================================
// NON-MEMBER FUNCTIONS
//==============================================================================

template <typename T>
std::ostream& operator<< (std::ostream& xos, const ptr_linked_pool<T>& xp);


} // namespace sheaf

#endif // ifndef PTR_LINKED_POOL_H