ucx/stack.h

Sat, 04 Apr 2015 22:06:42 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 04 Apr 2015 22:06:42 +0200
changeset 90
46971430650b
parent 70
88092b88ec00
child 110
53895e9a4bbb
permissions
-rw-r--r--

parser for with-clause ready to parse more attributes, but marks duplicated attributes as error

70
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 /*
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
3 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4 * Copyright 2014 Olaf Wintermann. All rights reserved.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
8 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
11 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
15 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
27 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 * @file stack.h
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32 * Default stack memory allocation implementation.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
33 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34 * @author Mike Becker
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
35 * @author Olaf Wintermann
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
36 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
37
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
38 #ifndef UCX_STACK_H
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
39 #define UCX_STACK_H
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41 #include "ucx.h"
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
42 #include <stdint.h>
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43 #include "allocator.h"
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
44
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
45 #ifdef __cplusplus
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
46 extern "C" {
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
47 #endif
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
48
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
49
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
50 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
51 * UCX stack structure.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
52 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
53 typedef struct {
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
54 /** UcxAllocator based on this stack */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
55 UcxAllocator allocator;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
56
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
57 /** Stack size. */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
58 size_t size;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
59
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
60 /** Pointer to the bottom of the stack */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
61 char *space;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
62
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
63 /** Pointer to the top of the stack */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
64 char *top;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
65 } UcxStack;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
66
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
67 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
68 * Metadata for each UCX stack element.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
69 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
70 struct ucx_stack_metadata {
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
71 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
72 * Location of the previous element (<code>NULL</code> if this is the first)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
73 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
74 char *prev;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
75
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
76 /** Size of this element */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
77 size_t size;
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
78 };
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
79
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
80 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
81 * Initializes UcxStack structure with memory.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
82 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
83 * @param stack a pointer to an uninitialized stack structure
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
84 * @param space the memory area that shall be managed
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
85 * @param size size of the memory area
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
86 * @return a new UcxStack structure
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
87 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
88 void ucx_stack_init(UcxStack *stack, char* space, size_t size);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
89
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
90 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
91 * Allocates stack memory.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
92 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
93 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
94 * @param n amount of memory to allocate
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
95 * @return a pointer to the allocated memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
96 * @see ucx_allocator_malloc()
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
97 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
98 void *ucx_stack_malloc(UcxStack *stack, size_t n);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
99
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
100 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
101 * Alias for #ucx_stack_malloc().
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
102 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
103 * @param n amount of memory to allocate
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
104 * @return a pointer to the allocated memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
105 * @see ucx_stack_malloc
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
106 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
107 #define ucx_stack_push(stack, n) ucx_stack_malloc(stack, n)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
108
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
109 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
110 * Allocates an array of stack memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
111 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
112 * The content of the allocated memory is set to zero.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
113 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
114 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
115 * @param nelem amount of elements to allocate
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
116 * @param elsize amount of memory per element
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
117 * @return a pointer to the allocated memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
118 * @see ucx_allocator_calloc()
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
119 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
120 void *ucx_stack_calloc(UcxStack *stack, size_t nelem, size_t elsize);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
121
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
122 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
123 * Alias for #ucx_stack_calloc().
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
124 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
125 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
126 * @param n amount of elements to allocate
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
127 * @param elsize amount of memory per element
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
128 * @return a pointer to the allocated memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
129 * @see ucx_stack_calloc
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
130 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
131 #define ucx_stack_pusharr(stack,n,elsize) ucx_stack_calloc(stack,n,elssize)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
132
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
133 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
134 * Reallocates memory on the stack.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
135 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
136 * Shrinking memory is always safe. Extending memory can be very expensive.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
137 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
138 * @param stack the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
139 * @param ptr a pointer to the memory that shall be reallocated
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
140 * @param n the new size of the memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
141 * @return a pointer to the new location of the memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
142 * @see ucx_allocator_realloc()
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
143 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
144 void *ucx_stack_realloc(UcxStack *stack, void *ptr, size_t n);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
145
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
146 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
147 * Frees memory on the stack.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
148 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
149 * Freeing stack memory behaves in a special way.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
150 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
151 * If the element, that should be freed, is the top most element of the stack,
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
152 * it is removed from the stack. Otherwise it is marked as freed. Marked
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
153 * elements are removed, when they become the top most elements of the stack.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
154 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
155 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
156 * @param ptr a pointer to the memory that shall be freed
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
157 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
158 void ucx_stack_free(UcxStack *stack, void *ptr);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
159
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
160
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
161 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
162 * Returns the size of the top most element.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
163 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
164 * @return the size of the top most element
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
165 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
166 #define ucx_stack_topsize(stack) ((stack)->top ? ((struct ucx_stack_metadata*)\
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
167 (stack)->top - 1)->size : 0)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
168
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
169 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
170 * Removes the top most element from the stack and copies the content to <code>
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
171 * dest</code>, if specified.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
172 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
173 * Use #ucx_stack_topsize()# to get the amount of memory that must be available
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
174 * at the location of <code>dest</code>.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
175 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
176 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
177 * @param dest the location where the contents shall be written to, or <code>
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
178 * NULL</code>, if the element shall only be removed.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
179 * @see ucx_stack_free
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
180 * @see ucx_stack_popn
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
181 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
182 #define ucx_stack_pop(stack, dest) ucx_stack_popn(stack, dest, SIZE_MAX)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
183
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
184 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
185 * Removes the top most element from the stack and copies the content to <code>
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
186 * dest</code>.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
187 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
188 * In contrast to #ucx_stack_pop() the <code>dest</code> pointer <code>MUST
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
189 * NOT</code> be <code>NULL</code>.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
190 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
191 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
192 * @param dest the location where the contents shall be written to
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
193 * @param n copies at most n elements to <code>dest</code>
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
194 * @see ucx_stack_pop
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
195 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
196 void ucx_stack_popn(UcxStack *stack, void *dest, size_t n);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
197
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
198 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
199 * Returns the remaining available memory on the specified stack.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
200 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
201 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
202 * @return the remaining available memory
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
203 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
204 size_t ucx_stack_avail(UcxStack *stack);
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
205
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
206 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
207 * Checks, if the stack is empty.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
208 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
209 * @param stack a pointer to the stack
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
210 * @return nonzero, if the stack is empty, zero otherwise
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
211 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
212 #define ucx_stack_empty(stack) (!(stack)->top)
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
213
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
214 /**
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
215 * Computes a recommended size for the stack memory area. Note, that
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
216 * reallocations have not been taken into account, so you might need to reserve
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
217 * twice as much memory to allow many reallocations.
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
218 *
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
219 * @param size the approximate payload
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
220 * @param elems the approximate count of element allocations
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
221 * @return a recommended size for the stack space based on the information
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
222 * provided
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
223 */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
224 #define ucx_stack_dim(size, elems) (size+sizeof(struct ucx_stack_metadata) * \
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
225 (elems + 1))
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
226
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
227
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
228 #ifdef __cplusplus
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
229 }
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
230 #endif
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
231
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
232 #endif /* UCX_STACK_H */
88092b88ec00 ucx update
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
233

mercurial