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_utility.h"
29 
30 /* Bring in externs for caller checking code.  */
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_system_dirty_partial_add                       PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function checks for errors in system dirty partial add call.   */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    widget                                Pointer to widget control     */
50 /*                                            block                       */
51 /*    dirty_area                            Dirty area of widget to add   */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_system_dirty_partial_add          Actual system dirty partial   */
60 /*                                            add call                    */
61 /*                                                                        */
62 /*  CALLED BY                                                             */
63 /*                                                                        */
64 /*    GUIX Application                                                    */
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 /*                                            resulting in version 6.1    */
73 /*                                                                        */
74 /**************************************************************************/
_gxe_system_dirty_partial_add(GX_WIDGET * widget,GX_RECTANGLE * dirty_area)75 UINT  _gxe_system_dirty_partial_add(GX_WIDGET *widget, GX_RECTANGLE *dirty_area)
76 {
77 UINT status;
78 
79     /* Check for invalid caller.  */
80     GX_INIT_AND_THREADS_CALLER_CHECKING
81 
82     /* Check for invalid pointer.  */
83     if ((widget == GX_NULL) || (dirty_area == GX_NULL))
84     {
85         return(GX_PTR_ERROR);
86     }
87 
88     /* Check for invalid widget.  */
89     if (widget -> gx_widget_type == 0)
90     {
91         return(GX_INVALID_WIDGET);
92     }
93 
94     /* Check for invalid size of dirty area.  */
95     if((dirty_area -> gx_rectangle_left > dirty_area -> gx_rectangle_right) ||
96        (dirty_area -> gx_rectangle_top > dirty_area -> gx_rectangle_bottom) ||
97        (!_gx_utility_rectangle_overlap_detect(dirty_area, &widget->gx_widget_size, GX_NULL)))
98     {
99         return(GX_INVALID_SIZE);
100     }
101 
102     /* Call actual system dirty partial add.  */
103     status = _gx_system_dirty_partial_add(widget, dirty_area);
104 
105     /* Return status.  */
106     return(status);
107 }
108 
109