VirtualBox

source: vbox/trunk/src/VBox/Storage/testcase/VDScriptStack.h@ 103131

Last change on this file since 103131 was 99739, checked in by vboxsync, 17 months ago

*: doxygen corrections (mostly about removing @returns from functions returning void).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.9 KB
Line 
1/** @file
2 *
3 * VBox HDD container test utility - scripting engine, internal stack implementation.
4 */
5
6/*
7 * Copyright (C) 2013-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#ifndef VBOX_INCLUDED_SRC_testcase_VDScriptStack_h
29#define VBOX_INCLUDED_SRC_testcase_VDScriptStack_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34#include <iprt/list.h>
35#include <iprt/string.h>
36
37#include "VDScript.h"
38
39/**
40 * Stack structure.
41 */
42typedef struct VDSCRIPTSTACK
43{
44 /** Size of one stack element. */
45 size_t cbStackEntry;
46 /** Stack memory. */
47 void *pvStack;
48 /** Number of elements on the stack. */
49 unsigned cOnStack;
50 /** Maximum number of elements the stack can hold. */
51 unsigned cOnStackMax;
52} VDSCRIPTSTACK;
53/** Pointer to a stack. */
54typedef VDSCRIPTSTACK *PVDSCRIPTSTACK;
55
56/**
57 * Init the stack structure.
58 *
59 * @param pStack The stack to initialize.
60 * @param cbStackEntry The size of one stack entry.
61 */
62DECLINLINE(void) vdScriptStackInit(PVDSCRIPTSTACK pStack, size_t cbStackEntry)
63{
64 pStack->cbStackEntry = cbStackEntry;
65 pStack->pvStack = NULL;
66 pStack->cOnStack = 0;
67 pStack->cOnStackMax = 0;
68}
69
70/**
71 * Destroys the given stack freeing all memory.
72 *
73 * @param pStack The stack to destroy.
74 */
75DECLINLINE(void) vdScriptStackDestroy(PVDSCRIPTSTACK pStack)
76{
77 if (pStack->pvStack)
78 RTMemFree(pStack->pvStack);
79 pStack->cbStackEntry = 0;
80 pStack->pvStack = NULL;
81 pStack->cOnStack = 0;
82 pStack->cOnStackMax = 0;
83}
84
85/**
86 * Gets the topmost unused stack entry.
87 *
88 * @returns Pointer to the first unused entry.
89 * NULL if there is no room left and increasing the stack failed.
90 * @param pStack The stack.
91 */
92DECLINLINE(void *)vdScriptStackGetUnused(PVDSCRIPTSTACK pStack)
93{
94 void *pvElem = NULL;
95
96 if (pStack->cOnStack >= pStack->cOnStackMax)
97 {
98 unsigned cOnStackMaxNew = pStack->cOnStackMax + 10;
99 void *pvStackNew = NULL;
100
101 /* Try to increase stack space. */
102 pvStackNew = RTMemRealloc(pStack->pvStack, cOnStackMaxNew * pStack->cbStackEntry);
103 if (pvStackNew)
104 {
105 pStack->pvStack = pvStackNew;
106 pStack->cOnStackMax = cOnStackMaxNew;
107 }
108
109 }
110
111 if (pStack->cOnStack < pStack->cOnStackMax)
112 pvElem = (char *)pStack->pvStack + pStack->cOnStack * pStack->cbStackEntry;
113
114 return pvElem;
115}
116
117/**
118 * Gets the topmost used entry on the stack.
119 *
120 * @returns Pointer to the first used entry
121 * or NULL if the stack is empty.
122 * @param pStack The stack.
123 */
124DECLINLINE(void *)vdScriptStackGetUsed(PVDSCRIPTSTACK pStack)
125{
126 if (!pStack->cOnStack)
127 return NULL;
128 else
129 return (char *)pStack->pvStack + (pStack->cOnStack - 1) * pStack->cbStackEntry;
130}
131
132/**
133 * Increases the used element count for the given stack.
134 *
135 * @param pStack The stack.
136 */
137DECLINLINE(void) vdScriptStackPush(PVDSCRIPTSTACK pStack)
138{
139 pStack->cOnStack++;
140}
141
142/**
143 * Decreases the used element count for the given stack.
144 *
145 * @param pStack The stack.
146 */
147DECLINLINE(void) vdScriptStackPop(PVDSCRIPTSTACK pStack)
148{
149 pStack->cOnStack--;
150}
151
152#endif /* !VBOX_INCLUDED_SRC_testcase_VDScriptStack_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette