D-Bus: dbus-memory.h Source File

D-Bus 1.10.22

dbus-memory.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-memory.h D-Bus memory handling
3 *
4 * Copyright (C) 2002 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 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 General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_MEMORY_H
28 #define DBUS_MEMORY_H
29
30 #include <dbus/dbus-macros.h>
31 #include <stddef.h>
32
33 DBUS_BEGIN_DECLS
34
40 DBUS_EXPORT
41 DBUS_MALLOC
42 DBUS_ALLOC_SIZE(1)
43 void* dbus_malloc (size_t bytes);
44
45 DBUS_EXPORT
46 DBUS_MALLOC
47 DBUS_ALLOC_SIZE(1)
48 void* dbus_malloc0 (size_t bytes);
49
50 DBUS_EXPORT
51 DBUS_MALLOC
52 DBUS_ALLOC_SIZE(2)
53 void* dbus_realloc (void *memory,
54 size_t bytes);
55 DBUS_EXPORT
56 void dbus_free (void *memory);
57
58 #define dbus_new(type, count) ((type*)dbus_malloc (sizeof (type) * (count)))
59 #define dbus_new0(type, count) ((type*)dbus_malloc0 (sizeof (type) * (count)))
60
61 DBUS_EXPORT
62 void dbus_free_string_array (char **str_array);
63
64 typedef void (* DBusFreeFunction) (void *memory);
65
66 DBUS_EXPORT
67 void dbus_shutdown (void);
68
71 DBUS_END_DECLS
72
73 #endif /* DBUS_MEMORY_H */
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:64
dbus_realloc
void * dbus_realloc(void *memory, size_t bytes)
Resizes a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:601
dbus_free
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:701
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
dbus_malloc
void * dbus_malloc(size_t bytes)
Allocates the given number of bytes, as with standard malloc().
Definition: dbus-memory.c:461
dbus_free_string_array
void dbus_free_string_array(char **str_array)
Frees a NULL-terminated array of strings.
Definition: dbus-memory.c:749
dbus_shutdown
void dbus_shutdown(void)
Frees all memory allocated internally by libdbus and reverses the effects of dbus_threads_init().
Definition: dbus-memory.c:897
dbus_malloc0
void * dbus_malloc0(size_t bytes)
Allocates the given number of bytes, as with standard malloc(), but all bytes are initialized to zero...
Definition: dbus-memory.c:531
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.