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 /**   Utility (Utility)                                                   */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_utility.h"
28 
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gxe_utility_rectangle_overlap_detect               PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function checks for errors in the utility rectangle overlap    */
43 /*    detect function call.                                               */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    first_rectangle                       First rectangle               */
48 /*    second_rectangle                      Second rectangle              */
49 /*    return_overlap_area                   Overlapping rectangle area    */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    [GX_TRUE | GX_FALSE]                                                */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    _gx_utility_rectangle_overlap_detect  Actual utility rectangle      */
58 /*                                          overlap detect function       */
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 /**************************************************************************/
_gxe_utility_rectangle_overlap_detect(GX_RECTANGLE * first_rectangle,GX_RECTANGLE * second_rectangle,GX_RECTANGLE * return_overlap_area)73 GX_BOOL  _gxe_utility_rectangle_overlap_detect(GX_RECTANGLE *first_rectangle, GX_RECTANGLE *second_rectangle,
74                                                GX_RECTANGLE *return_overlap_area)
75 {
76 GX_BOOL status;
77 
78     /* Check for invalid input pointers.  */
79     if ((first_rectangle == GX_NULL) || (second_rectangle == GX_NULL))
80     {
81         return GX_FALSE;
82     }
83 
84     /* Check for valid rectangle.  */
85     if ((first_rectangle -> gx_rectangle_left > first_rectangle -> gx_rectangle_right) ||
86         (first_rectangle -> gx_rectangle_top > first_rectangle -> gx_rectangle_bottom) ||
87         (second_rectangle -> gx_rectangle_left > second_rectangle -> gx_rectangle_right) ||
88         (second_rectangle -> gx_rectangle_top > second_rectangle -> gx_rectangle_bottom))
89     {
90         return GX_FALSE;
91     }
92 
93     /* Call the actual utility rectangle overlap detect function.  */
94     status = _gx_utility_rectangle_overlap_detect(first_rectangle, second_rectangle, return_overlap_area);
95 
96     /* Return completion status.  */
97     return status;
98 }
99 
100