libidn  1.28
idn-free.h
Go to the documentation of this file.
1 /* idn-free.h --- Invoke the free function to release memory
2  Copyright (C) 2004-2013 Simon Josefsson
3 
4  This file is part of GNU Libidn.
5 
6  GNU Libidn is free software: you can redistribute it and/or
7  modify it under the terms of either:
8 
9  * the GNU Lesser General Public License as published by the Free
10  Software Foundation; either version 3 of the License, or (at
11  your option) any later version.
12 
13  or
14 
15  * the GNU General Public License as published by the Free
16  Software Foundation; either version 2 of the License, or (at
17  your option) any later version.
18 
19  or both in parallel, as here.
20 
21  GNU Libidn is distributed in the hope that it will be useful,
22  but WITHOUT ANY WARRANTY; without even the implied warranty of
23  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24  General Public License for more details.
25 
26  You should have received copies of the GNU General Public License and
27  the GNU Lesser General Public License along with this program. If
28  not, see <http://www.gnu.org/licenses/>. */
29 
30 #ifndef IDN_FREE_H
31 # define IDN_FREE_H
32 
33 # ifndef IDNAPI
34 # if defined LIBIDN_BUILDING && defined HAVE_VISIBILITY && HAVE_VISIBILITY
35 # define IDNAPI __attribute__((__visibility__("default")))
36 # elif defined LIBIDN_BUILDING && defined _MSC_VER && ! defined LIBIDN_STATIC
37 # define IDNAPI __declspec(dllexport)
38 # elif defined _MSC_VER && ! defined LIBIDN_STATIC
39 # define IDNAPI __declspec(dllimport)
40 # else
41 # define IDNAPI
42 # endif
43 # endif
44 
45 # ifdef __cplusplus
46 extern "C"
47 {
48 # endif
49 
50 /* I don't recommend using this interface in general. Use `free'.
51  *
52  * I'm told Microsoft Windows may use one set of `malloc' and `free'
53  * in a library, and another incompatible set in a statically compiled
54  * application that link to the library, thus creating problems if the
55  * application would invoke `free' on a pointer pointing to memory
56  * allocated by the library. This motivated adding this function.
57  *
58  * The theory of isolating all memory allocations and de-allocations
59  * within a code package (library) sounds good, to simplify hunting
60  * down memory allocation related problems, but I'm not sure if it is
61  * worth enough to motivate recommending this interface over calling
62  * `free' directly, though.
63  *
64  * See the manual section 'Memory handling under Windows' for more
65  * information.
66  */
67 
68 extern void IDNAPI idn_free (void *ptr);
69 
70 # ifdef __cplusplus
71 }
72 # endif
73 
74 #endif /* IDN_FREE_H */