1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** GUIX Component                                                        */
17 /**                                                                       */
18 /**   Utility (Utility)                                                   */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "gx_api.h"
28 #include "gx_utility.h"
29 
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_utility_rectangle_compare                      PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function checks for errors in the utility rectangle compare    */
45 /*    function call.                                                      */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    first_rectangle                       First rectangle               */
50 /*    second_rectangle                      Second rectangle              */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    [GX_TRUE | GX_FALSE]                                                */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_utility_rectangle_compare         Actual utility rectangle      */
59 /*                                          compare function              */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    Application Code                                                    */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
70 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
71 /*                                            resulting in version 6.1    */
72 /*                                                                        */
73 /**************************************************************************/
_gxe_utility_rectangle_compare(GX_RECTANGLE * first_rectangle,GX_RECTANGLE * second_rectangle)74 GX_BOOL  _gxe_utility_rectangle_compare(GX_RECTANGLE *first_rectangle, GX_RECTANGLE *second_rectangle)
75 {
76     /* Check for invalid input pointers.  */
77     if ((first_rectangle == GX_NULL) || (second_rectangle == GX_NULL))
78     {
79         return GX_FALSE;
80     }
81 
82     /* Check for valid rectangle.  */
83     if ((first_rectangle -> gx_rectangle_left > first_rectangle -> gx_rectangle_right) ||
84         (first_rectangle -> gx_rectangle_top > first_rectangle -> gx_rectangle_bottom) ||
85         (second_rectangle -> gx_rectangle_left > second_rectangle -> gx_rectangle_right) ||
86         (second_rectangle -> gx_rectangle_top > second_rectangle -> gx_rectangle_bottom))
87     {
88         return GX_FALSE;
89     }
90 
91     /* Call the actual utility rectangle compare function.  */
92     return(_gx_utility_rectangle_compare(first_rectangle, second_rectangle));
93 }
94 
95