cleanup
[platform/upstream/glib.git] / glib / gtrashstack.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16  */
17
18 /*
19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
20  * file for a list of people on the GLib Team.  See the ChangeLog
21  * files for a list of changes.  These files are distributed with
22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
23  */
24
25 #ifndef __G_TRASH_STACK_H__
26 #define __G_TRASH_STACK_H__
27
28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29 #error "Only <glib.h> can be included directly."
30 #endif
31
32 #include <glib/gutils.h>
33
34 G_BEGIN_DECLS
35
36 typedef struct _GTrashStack GTrashStack;
37 struct _GTrashStack
38 {
39   GTrashStack *next;
40 };
41
42 G_INLINE_FUNC void      g_trash_stack_push   (GTrashStack **stack_p,
43                                               gpointer      data_p);
44 G_INLINE_FUNC gpointer  g_trash_stack_pop    (GTrashStack **stack_p);
45 G_INLINE_FUNC gpointer  g_trash_stack_peek   (GTrashStack **stack_p);
46 G_INLINE_FUNC guint     g_trash_stack_height (GTrashStack **stack_p);
47
48 #if defined (G_CAN_INLINE) || defined (__G_TRASH_STACK_C__)
49
50 G_INLINE_FUNC void
51 g_trash_stack_push (GTrashStack **stack_p,
52                     gpointer      data_p)
53 {
54   GTrashStack *data = (GTrashStack *) data_p;
55
56   data->next = *stack_p;
57   *stack_p = data;
58 }
59 G_INLINE_FUNC gpointer
60 g_trash_stack_pop (GTrashStack **stack_p)
61 {
62   GTrashStack *data;
63
64   data = *stack_p;
65   if (data)
66     {
67       *stack_p = data->next;
68       /* NULLify private pointer here, most platforms store NULL as
69        * subsequent 0 bytes
70        */
71       data->next = NULL;
72     }
73
74   return data;
75 }
76 G_INLINE_FUNC gpointer
77 g_trash_stack_peek (GTrashStack **stack_p)
78 {
79   GTrashStack *data;
80
81   data = *stack_p;
82
83   return data;
84 }
85 G_INLINE_FUNC guint
86 g_trash_stack_height (GTrashStack **stack_p)
87 {
88   GTrashStack *data;
89   guint i = 0;
90
91   for (data = *stack_p; data; data = data->next)
92     i++;
93
94   return i;
95 }
96
97 #endif  /* G_CAN_INLINE || __G_TRASH_STACK_C__ */
98
99 G_END_DECLS
100
101 #endif /* __G_UTILS_H__ */