1 |
|
|
/*************************************************************************** |
2 |
|
|
* Copyright (c) 2024 Microsoft Corporation |
3 |
|
|
* |
4 |
|
|
* This program and the accompanying materials are made available under the |
5 |
|
|
* terms of the MIT License which is available at |
6 |
|
|
* https://opensource.org/licenses/MIT. |
7 |
|
|
* |
8 |
|
|
* SPDX-License-Identifier: MIT |
9 |
|
|
**************************************************************************/ |
10 |
|
|
|
11 |
|
|
|
12 |
|
|
/**************************************************************************/ |
13 |
|
|
/**************************************************************************/ |
14 |
|
|
/** */ |
15 |
|
|
/** GUIX Component */ |
16 |
|
|
/** */ |
17 |
|
|
/** System Management (System) */ |
18 |
|
|
/** */ |
19 |
|
|
/**************************************************************************/ |
20 |
|
|
|
21 |
|
|
#define GX_SOURCE_CODE |
22 |
|
|
|
23 |
|
|
|
24 |
|
|
/* Include necessary system files. */ |
25 |
|
|
|
26 |
|
|
#include "gx_api.h" |
27 |
|
|
#include "gx_system.h" |
28 |
|
|
#include "gx_animation.h" |
29 |
|
|
|
30 |
|
|
/* Bring in externs for caller checking code. */ |
31 |
|
|
GX_CALLER_CHECKING_EXTERNS |
32 |
|
|
|
33 |
|
|
/**************************************************************************/ |
34 |
|
|
/* */ |
35 |
|
|
/* FUNCTION RELEASE */ |
36 |
|
|
/* */ |
37 |
|
|
/* _gxe_system_animation_free PORTABLE C */ |
38 |
|
|
/* 6.1 */ |
39 |
|
|
/* AUTHOR */ |
40 |
|
|
/* */ |
41 |
|
|
/* Kenneth Maxwell, Microsoft Corporation */ |
42 |
|
|
/* */ |
43 |
|
|
/* DESCRIPTION */ |
44 |
|
|
/* */ |
45 |
|
|
/* This function checks for errors in system_animation_free call. */ |
46 |
|
|
/* */ |
47 |
|
|
/* INPUT */ |
48 |
|
|
/* */ |
49 |
|
|
/* animation Pointer to animation struct */ |
50 |
|
|
/* */ |
51 |
|
|
/* OUTPUT */ |
52 |
|
|
/* */ |
53 |
|
|
/* status Completion status */ |
54 |
|
|
/* */ |
55 |
|
|
/* CALLS */ |
56 |
|
|
/* */ |
57 |
|
|
/* _gx_system_animation_free Actual animation free call */ |
58 |
|
|
/* */ |
59 |
|
|
/* CALLED BY */ |
60 |
|
|
/* */ |
61 |
|
|
/* GUIX Application */ |
62 |
|
|
/* */ |
63 |
|
|
/* RELEASE HISTORY */ |
64 |
|
|
/* */ |
65 |
|
|
/* DATE NAME DESCRIPTION */ |
66 |
|
|
/* */ |
67 |
|
|
/* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */ |
68 |
|
|
/* 09-30-2020 Kenneth Maxwell Modified comment(s), */ |
69 |
|
|
/* resulting in version 6.1 */ |
70 |
|
|
/* */ |
71 |
|
|
/**************************************************************************/ |
72 |
|
|
#if (GX_ANIMATION_POOL_SIZE > 0) |
73 |
|
7 |
UINT _gxe_system_animation_free(GX_ANIMATION *animation) |
74 |
|
|
{ |
75 |
|
|
UINT status; |
76 |
|
|
|
77 |
|
|
/* Check for invalid caller. */ |
78 |
✓✓✓✓
✓✓ |
7 |
GX_INIT_AND_THREADS_CALLER_CHECKING |
79 |
|
|
|
80 |
|
|
/* Check for invalid pointer. */ |
81 |
✓✓ |
5 |
if (animation == GX_NULL) |
82 |
|
|
{ |
83 |
|
2 |
return(GX_PTR_ERROR); |
84 |
|
|
} |
85 |
|
|
|
86 |
✓✓ |
3 |
if (animation->gx_animation_system_allocated == 0) |
87 |
|
|
{ |
88 |
|
1 |
return (GX_INVALID_ANIMATION); |
89 |
|
|
} |
90 |
|
|
|
91 |
✓✓ |
2 |
if (animation->gx_animation_status != GX_ANIMATION_IDLE) |
92 |
|
|
{ |
93 |
|
1 |
return (GX_INVALID_ANIMATION); |
94 |
|
|
} |
95 |
|
|
|
96 |
|
|
/* Call actual animation get */ |
97 |
|
1 |
status = _gx_system_animation_free(animation); |
98 |
|
|
|
99 |
|
|
/* Return status. */ |
100 |
|
1 |
return(status); |
101 |
|
|
} |
102 |
|
|
#endif |