class_alloc.h

Go to the documentation of this file.

// $Header$
//
// Copyright (C) 2000 - 2004, by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.
//

#ifndef LIBCWD_CLASS_ALLOC_H
#define LIBCWD_CLASS_ALLOC_H

#ifndef LIBCWD_CONFIG_H
#include <libcwd/config.h>
#endif

#ifndef LIBCWD_ENUM_MEMBLK_TYPES_H
#include <libcwd/enum_memblk_types.h>           // Needed for memblk_types_nt.
#endif
#ifndef LIBCW_LOCKABLE_AUTO_PTR_H
#include <libcwd/lockable_auto_ptr.h>           // Needed for lockable_auto_ptr<char, true>.
#endif
#if CWDEBUG_LOCATION && !defined(LIBCWD_CLASS_LOCATION_H)
#include <libcwd/class_location.h>              // Needed for location_ct.
#endif
#ifndef LIBCW_CSTDDEF
#define LIBCW_CSTDDEF
#include <cstddef>                              // Needed for size_t.
#endif
#ifndef LIBCWD_SMART_PTR_H
#include <libcwd/smart_ptr.h>
#endif
#ifndef LIBCW_SYS_TIME_H
#define LIBCW_SYS_TIME_H
#include <sys/time.h>                           // Needed for struct timeval.
#endif

namespace libcwd {

// Forward declaration
class type_info_ct;

//===================================================================================================
//
// The class which describes allocated memory blocks.
//

class alloc_ct {
protected:
  void const* a_start;                  
  size_t a_size;                        
  memblk_types_nt a_memblk_type;                
  type_info_ct const* type_info_ptr;            
  _private_::smart_ptr a_description;           
  struct timeval a_time;                        
#if CWDEBUG_LOCATION
  location_ct const* M_location;                
#endif

public:
  size_t size() const { return a_size; }

  void const* start() const { return a_start; }

  memblk_types_nt memblk_type() const { return a_memblk_type; }

  type_info_ct const& type_info() const { return *type_info_ptr; }

  char const* description() const { return a_description; }

  struct timeval const& time() const { return a_time; }

#if CWDEBUG_LOCATION

  location_ct const& location() const { return *M_location; }
#endif

protected:
  alloc_ct(void const* s, size_t sz, memblk_types_nt type, type_info_ct const& ti, struct timeval const& t
#if CWDEBUG_LOCATION
      , location_ct const* l
#endif
      ) : a_start(s), a_size(sz), a_memblk_type(type), type_info_ptr(&ti), a_time(t)
#if CWDEBUG_LOCATION
      , M_location(l)
#endif
      , M_tagged(false)
      { }

  virtual ~alloc_ct() { }

  // For internal use:
private:
  bool M_tagged;                                // Set when AllocTag et al was called.
public:
  bool is_tagged() const { return M_tagged; }
  void alloctag_called() { M_tagged = true; }
  void reset_type_info() { type_info_ptr = &unknown_type_info_c; }
};

} // namespace libcwd

#endif // LIBCWD_CLASS_ALLOC_H