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 /**   Prompt Management (Prompt)                                          */
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_display.h"
29 #include "gx_widget.h"
30 #include "gx_prompt.h"
31 #include "gx_utility.h"
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gx_prompt_text_id_set                              PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This service sets the text of a prompt widget.                      */
46 /*                                                                        */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    prompt                                Pointer to prompt widget      */
51 /*                                            control block               */
52 /*    string_id                             Resource ID of the string     */
53 /*                                                                        */
54 /*  OUTPUT                                                                */
55 /*                                                                        */
56 /*    status                                Completion status             */
57 /*                                                                        */
58 /*  CALLS                                                                 */
59 /*                                                                        */
60 /*    _gx_system_dirty_mark                 Mark this prompt as dirty     */
61 /*                                                                        */
62 /*  CALLED BY                                                             */
63 /*                                                                        */
64 /*    Application Code                                                    */
65 /*                                                                        */
66 /*  RELEASE HISTORY                                                       */
67 /*                                                                        */
68 /*    DATE              NAME                      DESCRIPTION             */
69 /*                                                                        */
70 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
71 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
72 /*                                            added logic to delete       */
73 /*                                            dynamic bidi text,          */
74 /*                                            resulting in version 6.1    */
75 /*                                                                        */
76 /**************************************************************************/
_gx_prompt_text_id_set(GX_PROMPT * prompt,GX_RESOURCE_ID string_id)77 UINT  _gx_prompt_text_id_set(GX_PROMPT *prompt, GX_RESOURCE_ID string_id)
78 {
79     prompt -> gx_prompt_text_id = string_id;
80 
81     /* If text id is used, clear prompt string to avoid confuse. */
82     if (prompt -> gx_widget_style & GX_STYLE_TEXT_COPY)
83     {
84         if (prompt -> gx_prompt_string.gx_string_ptr)
85         {
86             _gx_system_memory_free((void *)(prompt -> gx_prompt_string.gx_string_ptr));
87         }
88     }
89 
90     prompt -> gx_prompt_string.gx_string_ptr = GX_NULL;
91     prompt -> gx_prompt_string.gx_string_length = 0;
92 
93 #if defined(GX_DYNAMIC_BIDI_TEXT_SUPPORT)
94     if (prompt -> gx_prompt_bidi_resolved_text_info)
95     {
96         _gx_utility_bidi_resolved_text_info_delete(&prompt -> gx_prompt_bidi_resolved_text_info);
97     }
98 #endif
99 
100     if (prompt -> gx_widget_status & GX_STATUS_VISIBLE)
101     {
102         _gx_system_dirty_mark((GX_WIDGET *)prompt);
103     }
104 
105     return(GX_SUCCESS);
106 }
107 
108