MemoryLeakWarningPlugin.h

00001 /*
00002  * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *     * Redistributions of source code must retain the above copyright
00008  *       notice, this list of conditions and the following disclaimer.
00009  *     * Redistributions in binary form must reproduce the above copyright
00010  *       notice, this list of conditions and the following disclaimer in the
00011  *       documentation and/or other materials provided with the distribution.
00012  *     * Neither the name of the <organization> nor the
00013  *       names of its contributors may be used to endorse or promote products
00014  *       derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
00017  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00018  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019  * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
00020  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00021  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00022  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00023  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00025  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 #ifndef D_MemoryLeakWarningPlugin_h
00029 #define D_MemoryLeakWarningPlugin_h
00030 
00031 #include "TestPlugin.h"
00032 #include "MemoryLeakDetectorNewMacros.h"
00033 
00034 #define IGNORE_ALL_LEAKS_IN_TEST() MemoryLeakWarningPlugin::getFirstPlugin()->ignoreAllLeaksInTest();
00035 #define EXPECT_N_LEAKS(n)          MemoryLeakWarningPlugin::getFirstPlugin()->expectLeaksInTest(n);
00036 
00037 extern void crash_on_allocation_number(unsigned alloc_number);
00038 
00039 class MemoryLeakDetector;
00040 class MemoryLeakFailure;
00041 
00042 class MemoryLeakWarningPlugin: public TestPlugin
00043 {
00044 public:
00045     MemoryLeakWarningPlugin(const SimpleString& name, MemoryLeakDetector* localDetector = 0);
00046     virtual ~MemoryLeakWarningPlugin();
00047 
00048     virtual void preTestAction(UtestShell& test, TestResult& result) _override;
00049     virtual void postTestAction(UtestShell& test, TestResult& result) _override;
00050 
00051     virtual const char* FinalReport(int toBeDeletedLeaks = 0);
00052 
00053     void ignoreAllLeaksInTest();
00054     void expectLeaksInTest(int n);
00055 
00056     void destroyGlobalDetectorAndTurnOffMemoryLeakDetectionInDestructor(bool des);
00057 
00058     MemoryLeakDetector* getMemoryLeakDetector();
00059 
00060     static MemoryLeakWarningPlugin* getFirstPlugin();
00061 
00062     static MemoryLeakDetector* getGlobalDetector();
00063     static MemoryLeakFailure* getGlobalFailureReporter();
00064     static void setGlobalDetector(MemoryLeakDetector* detector, MemoryLeakFailure* reporter);
00065     static void destroyGlobalDetector();
00066 
00067     static void turnOffNewDeleteOverloads();
00068     static void turnOnNewDeleteOverloads();
00069     static bool areNewDeleteOverloaded();
00070 private:
00071     MemoryLeakDetector* memLeakDetector_;
00072     bool ignoreAllWarnings_;
00073     bool destroyGlobalDetectorAndTurnOfMemoryLeakDetectionInDestructor_;
00074     int expectedLeaks_;
00075     int failureCount_;
00076 
00077     static MemoryLeakWarningPlugin* firstPlugin_;
00078 };
00079 
00080 extern void* cpputest_malloc_location_with_leak_detection(size_t size, const char* file, int line);
00081 extern void* cpputest_realloc_location_with_leak_detection(void* memory, size_t size, const char* file, int line);
00082 extern void cpputest_free_location_with_leak_detection(void* buffer, const char* file, int line);
00083 
00084 #endif