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