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 /**   Rich Text View Management (Rich Text View)                          */
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_rich_text_view.h"
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  COMPONENT DEFINITION                                   RELEASE        */
33 /*                                                                        */
34 /*    _gx_rich_text_view_context_peek                     PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function retrieves the element at the top of rich text context */
43 /*    stack.                                                              */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    context                               Retrieved top element.        */
48 /*                                                                        */
49 /*  OUTPUT                                                                */
50 /*                                                                        */
51 /*    status                                Completion status             */
52 /*                                                                        */
53 /*  CALLS                                                                 */
54 /*                                                                        */
55 /*    None                                                                */
56 /*                                                                        */
57 /*  CALLED BY                                                             */
58 /*                                                                        */
59 /*    GUIX Internal Code                                                  */
60 /*                                                                        */
61 /*  RELEASE HISTORY                                                       */
62 /*                                                                        */
63 /*    DATE              NAME                      DESCRIPTION             */
64 /*                                                                        */
65 /*  09-30-2020     Kenneth Maxwell          Initial Version 6.1           */
66 /*                                                                        */
67 /**************************************************************************/
_gx_rich_text_view_context_peek(GX_RICH_TEXT_CONTEXT * context)68 UINT  _gx_rich_text_view_context_peek(GX_RICH_TEXT_CONTEXT *context)
69 {
70 GX_UBYTE top;
71 
72     top = _gx_system_rich_text_context_stack.gx_rich_text_context_stack_top;
73 
74     if ((top <= 0) || (context == GX_NULL))
75     {
76         return GX_FAILURE;
77     }
78 
79     top--;
80 
81    *context = _gx_system_rich_text_context_stack.gx_rich_text_context_stack[top];
82 
83     return GX_SUCCESS;
84 }
85 
86