itkSmapsFileParser.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSmapsFileParser.h,v $
  Language:  C++
  Date:      $Date: 2008-10-24 18:11:22 $
  Version:   $Revision: 1.1 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkSmapsFileParser_h
#define __itkSmapsFileParser_h

#include "itkConfigure.h"
#include "itkWin32Header.h"
#include "itkExceptionObject.h"

#include <string>
#include <vector>
#include <map>
#include <istream>
#include <iostream>

namespace itk {


class ITKCommon_EXPORT MapRecord
{
public:
  typedef unsigned int  MemoryLoadType;
  virtual ~MapRecord();
  void Reset(void);

  std::string  m_RecordName;

  std::map<std::string, MemoryLoadType> m_Tokens;

};

class ITKCommon_EXPORT SmapsRecord : public MapRecord
{
  friend ITKCommon_EXPORT std::istream&  operator>>(std::istream &in, SmapsRecord &record);
};

class ITKCommon_EXPORT VMMapSummaryRecord : public MapRecord
{
  friend ITKCommon_EXPORT std::istream&  operator>>(std::istream &in, VMMapSummaryRecord &record);
};

class ITKCommon_EXPORT VMMapRecord : public MapRecord
{
  friend ITKCommon_EXPORT std::istream&  operator>>(std::istream &in, VMMapRecord &record);
};

class ITKCommon_EXPORT MapData
{
public:
  typedef unsigned long             MemoryLoadType;
  //todo delete records
  virtual ~MapData();

  virtual MemoryLoadType GetHeapUsage() = 0;

  virtual MemoryLoadType GetStackUsage() = 0;

  virtual MemoryLoadType GetTotalMemoryUsage();

  virtual MemoryLoadType GetMemoryUsage( const char * filter, const char * token );

  bool Empty();
protected:

  void Reset(void);
protected: 
  typedef std::vector< MapRecord* >  MapRecordVectorType;

  MapRecordVectorType                   m_Records;
};

class ITKCommon_EXPORT SmapsData_2_6:public MapData
{
public:
  typedef MapData::MemoryLoadType MemoryLoadType;
  
  virtual ~SmapsData_2_6();

  virtual MemoryLoadType GetHeapUsage();

  virtual MemoryLoadType GetStackUsage();

  friend ITKCommon_EXPORT std::istream&  operator>>( std::istream &smapsStream,
                                              SmapsData_2_6 &data);

protected:
  bool                m_HeapRecordFound;
};

class ITKCommon_EXPORT VMMapData_10_2:public MapData
{
public:
  typedef MapData::MemoryLoadType MemoryLoadType;
  VMMapData_10_2();
  virtual ~VMMapData_10_2();

  virtual MemoryLoadType GetHeapUsage();

  virtual MemoryLoadType GetStackUsage();  

  friend ITKCommon_EXPORT std::istream& operator>>( std::istream &stream,
                                              VMMapData_10_2 &data);
protected: 
  bool                m_UsingSummary;
};


template<class TMapData>
class ITK_EXPORT MapFileParser
{
public: 
  typedef typename TMapData::MemoryLoadType MemoryLoadType;

  virtual ~MapFileParser();
  virtual void ReadFile( const std::string &mapFileLocation = "") = 0;

  bool Update(void);

  MemoryLoadType GetHeapUsage();

  MemoryLoadType GetStackUsage();

  MemoryLoadType GetTotalMemoryUsage();

  MemoryLoadType GetMemoryUsage( const char* filter , const char * token = "Size" );

protected: 
  std::string   m_MapFilePath;  //< location of the last loaded Map file
  TMapData      m_MapData;      //< data of the loaded smap file
};

template<class TSmapsDataType>
class ITK_EXPORT SmapsFileParser: public MapFileParser<TSmapsDataType>
{
public:
  virtual ~SmapsFileParser();
  virtual void ReadFile( const std::string &mapFileLocation = "");

};

template<class TVMMapDataType>
class ITK_EXPORT VMMapFileParser: public MapFileParser<TVMMapDataType>
{
public:
  virtual ~VMMapFileParser();
  virtual void ReadFile( const std::string &mapFileLocation = "");

};

}  // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSmapsFileParser.txx"
#endif

#endif // __itkSmapsFileParser_h