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 /**   Screen Stack Management (Screen Stack)                              */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_widget.h"
28 #include "gx_screen_stack.h"
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gx_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 screen stack.    */
44 /*    The new screen pointer is then attached to the parent.              */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    control                               Pointer of stack entry        */
49 /*    screen                                Screen pointer to push        */
50 /*    new_screen                            Pointer of new screen         */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    None                                                                */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
69 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_gx_screen_stack_push(GX_SCREEN_STACK_CONTROL * control,GX_WIDGET * screen,GX_WIDGET * new_screen)73 UINT  _gx_screen_stack_push(GX_SCREEN_STACK_CONTROL *control, GX_WIDGET *screen, GX_WIDGET *new_screen)
74 {
75 INT top;
76     control -> gx_screen_stack_control_top++;
77     top = control -> gx_screen_stack_control_top;
78 
79     if (top <= control -> gx_screen_stack_control_max - 1)
80     {
81         top <<= 1;
82 
83         /* Push the screen and its parent to screen stack.  */
84         control -> gx_screen_stack_control_memory[top] = screen;
85         control -> gx_screen_stack_control_memory[top + 1] = screen -> gx_widget_parent;
86 
87         /* Attach the new screen to the parent.  */
88         _gx_widget_attach(screen -> gx_widget_parent, new_screen);
89 
90         /* Dettached the old screen from its parent.  */
91         _gx_widget_detach(screen);
92 
93 
94         return(GX_SUCCESS);
95     }
96     else
97     {
98         control -> gx_screen_stack_control_top--;
99         return(GX_FAILURE);
100     }
101 }
102 
103