LGPL
[vlc.git] / include / vlc_memory.h
1 /*****************************************************************************
2  * vlc_memory.h: Memory functions
3  *****************************************************************************
4  * Copyright (C) 2009 VLC authors and VideoLAN
5  *
6  * Authors: JP Dinger <jpd at videolan dot org>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 #ifndef VLC_MEMORY_H
24 #define VLC_MEMORY_H 1
25
26 #include <stdlib.h>
27
28 /**
29  * \file
30  * This file deals with memory fixups
31  */
32
33 /**
34  * \defgroup memory Memory
35  * @{
36  */
37
38 /**
39  * This wrapper around realloc() will free the input pointer when
40  * realloc() returns NULL. The use case ptr = realloc(ptr, newsize) will
41  * cause a memory leak when ptr pointed to a heap allocation before,
42  * leaving the buffer allocated but unreferenced. vlc_realloc() is a
43  * drop-in replacement for that use case (and only that use case).
44  */
45 static inline void *realloc_or_free( void *p, size_t sz )
46 {
47     void *n = realloc(p,sz);
48     if( !n )
49         free(p);
50     return n;
51 }
52
53 /**
54  * @}
55  */
56
57 #endif