/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

//==========================================================
// ORIGINAL COPYRIGHT FOLLOWS
//==========================================================
// Yes::Engine - Free C++ 3D engine
//
// Copyright (C) 2004-2005 Laurent Gomila
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc.,
// 59 Temple Place - Suite 330,
// Boston, MA  02111-1307, USA.
//
// E-mail : laurent.gom@gmail.com
//==========================================================

#ifndef KEOS_MEMORYMANAGER_H
#define KEOS_MEMORYMANAGER_H

#include "KeosNoMemoryMacros.h"

#include "KeosPlatform.h"
#include "KeosStdHeaders.h"
#include "KeosFile.h"

namespace Keos
{
    //-----------------------------------------------------------------------
    /** Memory manager, detects the memory leaks.
     *
     */
    class KEOS_EXPORT CMemoryManager
    {
    public :

        /** Return the class instance.
         *  @return Reference on the unique instance of the class.
         */
        static CMemoryManager& Instance();

        /** Add an allocation memory.
         *  @param nSize Allocated size.
         *  @param File File containing the allowance.
         *  @param nLine Line of the allowance.
         *  @param bArray True if it is an allowance of array.
         *  @return Pointer on the allocated memory.
         */
        void* Allocate(size_t nSize, const CFile& File, int nLine, bool bArray);

        /** Remove an allocation memory.
         *  @param pPtr Address of the memory deallocated.
         *  @param bArray True if it is an deallocation of array.
         */
        void Free(void* pPtr, bool bArray);

        /** Back up the information about the current deallocation.
         *  @param File File containing the deallocation.
         *  @param nLine Line of the deallocation.
         */
        void NextDelete(const CFile& File, int nLine);

        /** Destructor.
         *
         */
        ~CMemoryManager();

    private :

        /** Default constructor.
         *
         */
        CMemoryManager();

        /** Log the report on the memory leaks.
         *
         */
        void ReportLeaks();

        // Types
        struct TBlock
        {
            size_t      nSize;      // Allocated size
            CFile       File;       // File containing the allocation
            int         nLine;      // Line of the allocation
            bool        bArray;     // Object or array ?
        };
        typedef std::map<void*, TBlock> TBlockMap;

        //! Output file
        std::ofstream      m_File;
        //! Memory blocks allocated
        TBlockMap          m_Blocks;
        //! Stack whose summit contains the line and the file of the next deallocation
        std::stack<TBlock> m_DeleteStack;
    };

} // namespace Keos

#include "KeosMemoryMacros.h"

#endif // KEOS_MEMORYMANAGER_H
