xref: /freebsd/contrib/expat/tests/memcheck.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /* Interface to allocation functions that will track what has or has
2    not been freed.
3                             __  __            _
4                          ___\ \/ /_ __   __ _| |_
5                         / _ \\  /| '_ \ / _` | __|
6                        |  __//  \| |_) | (_| | |_
7                         \___/_/\_\ .__/ \__,_|\__|
8                                  |_| XML parser
9 
10    Copyright (c) 2017 Rhodri James <rhodri@wildebeest.org.uk>
11    Copyright (c) 2017 Sebastian Pipping <sebastian@pipping.org>
12    Licensed under the MIT license:
13 
14    Permission is  hereby granted,  free of charge,  to any  person obtaining
15    a  copy  of  this  software   and  associated  documentation  files  (the
16    "Software"),  to  deal in  the  Software  without restriction,  including
17    without  limitation the  rights  to use,  copy,  modify, merge,  publish,
18    distribute, sublicense, and/or sell copies of the Software, and to permit
19    persons  to whom  the Software  is  furnished to  do so,  subject to  the
20    following conditions:
21 
22    The above copyright  notice and this permission notice  shall be included
23    in all copies or substantial portions of the Software.
24 
25    THE  SOFTWARE  IS  PROVIDED  "AS  IS",  WITHOUT  WARRANTY  OF  ANY  KIND,
26    EXPRESS  OR IMPLIED,  INCLUDING  BUT  NOT LIMITED  TO  THE WARRANTIES  OF
27    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
28    NO EVENT SHALL THE AUTHORS OR  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
29    DAMAGES OR  OTHER LIABILITY, WHETHER  IN AN  ACTION OF CONTRACT,  TORT OR
30    OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
31    USE OR OTHER DEALINGS IN THE SOFTWARE.
32 */
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 #ifndef XML_MEMCHECK_H
39 #  define XML_MEMCHECK_H 1
40 
41 /* Allocation declarations */
42 
43 void *tracking_malloc(size_t size);
44 void tracking_free(void *ptr);
45 void *tracking_realloc(void *ptr, size_t size);
46 
47 /* End-of-test check to see if unfreed allocations remain. Returns
48  * TRUE (1) if there is nothing, otherwise prints a report of the
49  * remaining allocations and returns FALSE (0).
50  */
51 int tracking_report(void);
52 
53 #endif /* XML_MEMCHECK_H */
54 
55 #ifdef __cplusplus
56 }
57 #endif
58