1 | /** @file
|
---|
2 | *
|
---|
3 | * VBox HDD container test utility - scripting engine, internal stack implementation.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2013-2016 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | */
|
---|
17 | #ifndef _VDScriptStack_h__
|
---|
18 | #define _VDScriptStack_h__
|
---|
19 |
|
---|
20 | #include <iprt/list.h>
|
---|
21 | #include <iprt/string.h>
|
---|
22 |
|
---|
23 | #include "VDScript.h"
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * Stack structure.
|
---|
27 | */
|
---|
28 | typedef struct VDSCRIPTSTACK
|
---|
29 | {
|
---|
30 | /** Size of one stack element. */
|
---|
31 | size_t cbStackEntry;
|
---|
32 | /** Stack memory. */
|
---|
33 | void *pvStack;
|
---|
34 | /** Number of elements on the stack. */
|
---|
35 | unsigned cOnStack;
|
---|
36 | /** Maximum number of elements the stack can hold. */
|
---|
37 | unsigned cOnStackMax;
|
---|
38 | } VDSCRIPTSTACK;
|
---|
39 | /** Pointer to a stack. */
|
---|
40 | typedef VDSCRIPTSTACK *PVDSCRIPTSTACK;
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * Init the stack structure.
|
---|
44 | *
|
---|
45 | * @returns nothing.
|
---|
46 | * @param pStack The stack to initialize.
|
---|
47 | * @param cbStackEntry The size of one stack entry.
|
---|
48 | */
|
---|
49 | DECLINLINE(void) vdScriptStackInit(PVDSCRIPTSTACK pStack, size_t cbStackEntry)
|
---|
50 | {
|
---|
51 | pStack->cbStackEntry = cbStackEntry;
|
---|
52 | pStack->pvStack = NULL;
|
---|
53 | pStack->cOnStack = 0;
|
---|
54 | pStack->cOnStackMax = 0;
|
---|
55 | }
|
---|
56 |
|
---|
57 | /**
|
---|
58 | * Destroys the given stack freeing all memory.
|
---|
59 | *
|
---|
60 | * @returns nothing.
|
---|
61 | * @param pStack The stack to destroy.
|
---|
62 | */
|
---|
63 | DECLINLINE(void) vdScriptStackDestroy(PVDSCRIPTSTACK pStack)
|
---|
64 | {
|
---|
65 | if (pStack->pvStack)
|
---|
66 | RTMemFree(pStack->pvStack);
|
---|
67 | pStack->cbStackEntry = 0;
|
---|
68 | pStack->pvStack = NULL;
|
---|
69 | pStack->cOnStack = 0;
|
---|
70 | pStack->cOnStackMax = 0;
|
---|
71 | }
|
---|
72 |
|
---|
73 | /**
|
---|
74 | * Gets the topmost unused stack entry.
|
---|
75 | *
|
---|
76 | * @returns Pointer to the first unused entry.
|
---|
77 | * NULL if there is no room left and increasing the stack failed.
|
---|
78 | * @param pStack The stack.
|
---|
79 | */
|
---|
80 | DECLINLINE(void *)vdScriptStackGetUnused(PVDSCRIPTSTACK pStack)
|
---|
81 | {
|
---|
82 | void *pvElem = NULL;
|
---|
83 |
|
---|
84 | if (pStack->cOnStack >= pStack->cOnStackMax)
|
---|
85 | {
|
---|
86 | unsigned cOnStackMaxNew = pStack->cOnStackMax + 10;
|
---|
87 | void *pvStackNew = NULL;
|
---|
88 |
|
---|
89 | /* Try to increase stack space. */
|
---|
90 | pvStackNew = RTMemRealloc(pStack->pvStack, cOnStackMaxNew * pStack->cbStackEntry);
|
---|
91 | if (pvStackNew)
|
---|
92 | {
|
---|
93 | pStack->pvStack = pvStackNew;
|
---|
94 | pStack->cOnStackMax = cOnStackMaxNew;
|
---|
95 | }
|
---|
96 |
|
---|
97 | }
|
---|
98 |
|
---|
99 | if (pStack->cOnStack < pStack->cOnStackMax)
|
---|
100 | pvElem = (char *)pStack->pvStack + pStack->cOnStack * pStack->cbStackEntry;
|
---|
101 |
|
---|
102 | return pvElem;
|
---|
103 | }
|
---|
104 |
|
---|
105 | /**
|
---|
106 | * Gets the topmost used entry on the stack.
|
---|
107 | *
|
---|
108 | * @returns Pointer to the first used entry
|
---|
109 | * or NULL if the stack is empty.
|
---|
110 | * @param pStack The stack.
|
---|
111 | */
|
---|
112 | DECLINLINE(void *)vdScriptStackGetUsed(PVDSCRIPTSTACK pStack)
|
---|
113 | {
|
---|
114 | if (!pStack->cOnStack)
|
---|
115 | return NULL;
|
---|
116 | else
|
---|
117 | return (char *)pStack->pvStack + (pStack->cOnStack - 1) * pStack->cbStackEntry;
|
---|
118 | }
|
---|
119 |
|
---|
120 | /**
|
---|
121 | * Increases the used element count for the given stack.
|
---|
122 | *
|
---|
123 | * @returns nothing.
|
---|
124 | * @param pStack The stack.
|
---|
125 | */
|
---|
126 | DECLINLINE(void) vdScriptStackPush(PVDSCRIPTSTACK pStack)
|
---|
127 | {
|
---|
128 | pStack->cOnStack++;
|
---|
129 | }
|
---|
130 |
|
---|
131 | /**
|
---|
132 | * Decreases the used element count for the given stack.
|
---|
133 | *
|
---|
134 | * @returns nothing.
|
---|
135 | * @param pStack The stack.
|
---|
136 | */
|
---|
137 | DECLINLINE(void) vdScriptStackPop(PVDSCRIPTSTACK pStack)
|
---|
138 | {
|
---|
139 | pStack->cOnStack--;
|
---|
140 | }
|
---|
141 |
|
---|
142 | #endif /* _VDScriptStack_h__ */
|
---|