NetBurner 3.1
CodeMemoryReportFormatter.h
1 /*
2  * Copyright (c) 2007, Michael Feathers, James Grenning and Bas Vodde
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of the <organization> nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE EARLIER MENTIONED AUTHORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef D_CodeMemoryReportFormatter_h
29 #define D_CodeMemoryReportFormatter_h
30 
31 #include "CppUTestExt/MemoryReportFormatter.h"
32 
33 struct CodeReportingAllocationNode;
34 class CodeMemoryReportFormatter : public MemoryReportFormatter
35 {
36 private:
37  CodeReportingAllocationNode* codeReportingList_;
38  TestMemoryAllocator* internalAllocator_;
39 
40 public:
41  CodeMemoryReportFormatter(TestMemoryAllocator* internalAllocator);
42  virtual ~CodeMemoryReportFormatter();
43 
44  virtual void report_testgroup_start(TestResult* result, UtestShell& test) _override;
45  virtual void report_testgroup_end(TestResult* /*result*/, UtestShell& /*test*/) _override {} // LCOV_EXCL_LINE
46 
47  virtual void report_test_start(TestResult* result, UtestShell& test) _override;
48  virtual void report_test_end(TestResult* result, UtestShell& test) _override;
49 
50  virtual void report_alloc_memory(TestResult* result, TestMemoryAllocator* allocator, size_t size, char* memory, const char* file, int line) _override;
51  virtual void report_free_memory(TestResult* result, TestMemoryAllocator* allocator, char* memory, const char* file, int line) _override;
52 
53 private:
54 
55  void addNodeToList(const char* variableName, void* memory, CodeReportingAllocationNode* next);
56  CodeReportingAllocationNode* findNode(void* memory);
57  bool variableExists(const SimpleString& variableName);
58  void clearReporting();
59 
60  bool isNewAllocator(TestMemoryAllocator* allocator);
61  SimpleString createVariableNameFromFileLineInfo(const char *file, int line);
62 
63  SimpleString getAllocationString(TestMemoryAllocator* allocator, const SimpleString& variableName, size_t size);
64  SimpleString getDeallocationString(TestMemoryAllocator* allocator, const SimpleString& variableName, const char* file, int line);
65 };
66 
67 #endif