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 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    _gx_system_screen_stack_get                         PORTABLE C      */
34 /*                                                           6.1          */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    Kenneth Maxwell, Microsoft Corporation                              */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function removes the topmost entry from the system screen      */
42 /*    stack, and returns popped parent and screen pointers to the caller. */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    popped_parent                         Retrieved stack top parent    */
47 /*    popped_screen                         Retrieved stack top screen    */
48 /*                                                                        */
49 /*  OUTPUT                                                                */
50 /*                                                                        */
51 /*    status                                Completion status             */
52 /*                                                                        */
53 /*  CALLS                                                                 */
54 /*                                                                        */
55 /*    None                                                                */
56 /*                                                                        */
57 /*  CALLED BY                                                             */
58 /*                                                                        */
59 /*    Application Code                                                    */
60 /*                                                                        */
61 /*  RELEASE HISTORY                                                       */
62 /*                                                                        */
63 /*    DATE              NAME                      DESCRIPTION             */
64 /*                                                                        */
65 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
66 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
67 /*                                            resulting in version 6.1    */
68 /*                                                                        */
69 /**************************************************************************/
_gx_system_screen_stack_get(GX_WIDGET ** popped_parent,GX_WIDGET ** popped_screen)70 UINT  _gx_system_screen_stack_get(GX_WIDGET **popped_parent, GX_WIDGET **popped_screen)
71 {
72 UINT       status;
73 INT        top;
74 GX_WIDGET *screen = GX_NULL;
75 GX_WIDGET *parent = GX_NULL;
76 
77     top = _gx_system_screen_stack.gx_screen_stack_control_top;
78 
79     if (top >= 0)
80     {
81         top <<= 1;
82         screen = _gx_system_screen_stack.gx_screen_stack_control_memory[top];
83         parent = _gx_system_screen_stack.gx_screen_stack_control_memory[top + 1];
84 
85         _gx_system_screen_stack.gx_screen_stack_control_top--;
86 
87         status = GX_SUCCESS;
88     }
89     else
90     {
91         status = GX_FAILURE;
92     }
93 
94     if (popped_parent)
95     {
96         (*popped_parent) = parent;
97     }
98 
99     if (popped_screen)
100     {
101         (*popped_screen) = screen;
102     }
103 
104     return status;
105 }
106 
107