1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
Copyright 2024 Northern.tech AS
This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
To the extent this program is licensed as part of the Enterprise
versions of CFEngine, the applicable Commercial Open Source License
(COSL) may apply to this file if you as a licensee so wish it. See
included file COSL.txt.
*/
#ifndef CFENGINE_STACK_H
#define CFENGINE_STACK_H
#include <stdlib.h> // size_t
typedef struct Stack_ Stack;
/**
@brief Creates a new stack with specified capacity.
@param [in] initial_capacity Initial capacity, defaults to 1.
@param [in] ItemDestroy Function used to destroy data elements.
*/
Stack *StackNew(size_t initial_capacity, void (*ItemDestroy) ());
/**
@brief Destroys the stack and frees the memory it occupies.
@param [in] stack The stack to destroy.
@warning Stack should only be destroyed if all threads are joined
*/
void StackDestroy(Stack *stack);
/**
@brief Frees the memory allocated for the data pointer and the struct itself.
@param [in] stack The stack to free.
*/
void StackSoftDestroy(Stack *stack);
/**
@brief Returns and removes the last element added to the stack.
@note Will return NULL if stack is empty.
@param [in] stack The stack to pop from.
@return A pointer to the last data added.
*/
void *StackPop(Stack *stack);
/**
@brief Returns the last element added to the stack, without removing it.
@note Will return NULL if stack is empty.
@param [in] stack The stack to pop from.
@return A pointer to the last data added.
*/
void *StackTop(Stack *stack);
/**
@brief Adds a new item on top of the stack.
@param [in] stack The stack to push to.
@param [in] item The item to push.
*/
void StackPush(Stack *stack, void *item);
/**
@brief Adds a new item on top of the stack and returns the current size.
@param [in] stack The stack to push to.
@param [in] item The item to push.
@return The amount of elements in the stack.
*/
size_t StackPushReportCount(Stack *stack, void *item);
/**
@brief Get current number of items in stack.
@note On NULL stack, returns 0.
@param [in] stack The stack.
@return The amount of elements in the stack.
*/
size_t StackCount(Stack const *stack);
/**
@brief Get current capacity of stack.
@note On NULL stack, returns 0.
@param [in] stack The stack.
@return The current capacity of the stack.
*/
size_t StackCapacity(Stack const *stack);
/**
@brief Create a shallow copy of a given stack.
@note This makes a new stack pointing to the same memory as the old stack.
@param [in] stack The stack.
@return A new stack pointing to the same data.
*/
Stack *StackCopy(Stack const *stack);
/**
@brief Checks if a stack is empty.
@param [in] stack The stack.
@return Returns true if stack is empty, false otherwise.
*/
bool StackIsEmpty(Stack const *stack);
#endif
|
