ArenaPoolAllocator.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
#ifndef ATHALLOCATORS_ARENAPOOLALLOCATOR_H
#define ATHALLOCATORS_ARENAPOOLALLOCATOR_H
 
 
#include "AthAllocators/ArenaBlockAllocatorBase.h"
#include "boost/iterator/iterator_adaptor.hpp"
#include <cstdlib>
 
 
namespace SG {
 
 
class ArenaBlock;
 
 
class ArenaPoolAllocator
  : public ArenaBlockAllocatorBase
{
public:
  // Needed forward declaration.
  class const_iterator;
 
  class iterator
    : public boost::iterator_adaptor<
    iterator,
    pointer,
    boost::use_default,
    boost::forward_traversal_tag>
  {
  public:
    iterator ();
 
 
    iterator (pointer p, ArenaBlock* block);
 
 
    // To allow initializing a @c const_iterator from an @c iterator.
    friend class const_iterator;
 
 
  private:
    ArenaBlock* m_block;
 
    // Required by @c iterator_adaptor.
    friend class boost::iterator_core_access;
 
    void increment();
  };
 
 
  class const_iterator
    : public boost::iterator_adaptor<
    const_iterator,
    const_pointer,
    boost::use_default,
    boost::forward_traversal_tag>
  {
  public:
    const_iterator ();
 
 
    const_iterator (pointer p, const ArenaBlock* block);
 
 
    const_iterator (const iterator& it);
                                           
 
  private:
    const ArenaBlock* m_block;
 
    // Required by @c iterator_adaptor.
    friend class boost::iterator_core_access;
 
    void increment();
  };
 
 
  ArenaPoolAllocator (const Params& params);
 
 
  virtual ~ArenaPoolAllocator();
 
 
  ArenaPoolAllocator (const ArenaPoolAllocator&) = delete;
  ArenaPoolAllocator& operator= (const ArenaPoolAllocator&) = delete;
 
 
  ArenaPoolAllocator (ArenaPoolAllocator&& other);
 
 
  ArenaPoolAllocator& operator= (ArenaPoolAllocator&& other);
 
 
  void swap (ArenaPoolAllocator& other);
 
 
  pointer allocate();
 
 
  virtual void reset() override;
 
 
  // cppcheck-suppress virtualCallInConstructor ; false positive
  virtual void erase() override final;
 
 
  void resetTo (pointer p);
 
 
  iterator begin();
 
 
  const_iterator begin() const;
 
 
  iterator end();
 
 
  const_iterator end() const;
 
 
private:
  void refill();
 
 
  void clearBlock();
 
 
  pointer m_ptr;
 
  pointer m_end;
};
 
 
} // namespace SG
 
 
#include "AthAllocators/ArenaPoolAllocator.icc"
 
 
#endif // not ATHALLOCATORS_ARENAPOOLALLOCATOR_H