list_pool.h

Go to the documentation of this file.

//
// 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.
//


#ifndef LIST_POOL_H
#define LIST_POOL_H

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

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

#ifndef STD_UNORDERED_SET_H
#include "SheafSystem/std_unordered_set.h"
#endif

namespace sheaf
{

// Forward declarations to enable friend declaration.

template <typename T>
class list_pool;
template <typename T>
size_t deep_size(const list_pool<T>& xpool, bool xinclude_shallow);

template <typename T>
struct ptr_hash
{
public:
  size_t operator()(const T& t) const
  {
    return (size_t) t;
  }
};

template <typename T>
struct ptr_key_test
{
public:
  bool operator()(const T& t1, const T& t2) const
  {
    return (t1 == t2);
  }
};

template <typename T>
class list_pool
{

  friend size_t deep_size<T>(const list_pool<T>& xpool, bool xinclude_shallow);

  // ===========================================================
  // ===========================================================

public:

  typedef unsigned long int  size_type;

  list_pool();

  virtual ~list_pool();

  T& get();

  void release(T& xobj);

  bool allocated(const T& xobj) const;

  // The number of allocated objects.
  size_type ct() const;

protected:

private:

  typedef singly_linked_list<T*> free_list_type;

  typedef unordered::unordered_set<T*, ptr_hash<T*>, ptr_key_test<T*> > allocated_type;

  list_pool(const list_pool& xother) { };

  free_list_type _free_list;

  allocated_type _allocated;

};

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

template <typename T>
size_t deep_size(const list_pool<T>& xpool, bool xinclude_shallow);

} // namespace sheaf

#endif // ifndef LIST_POOL_H