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 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    _gxe_utility_rectangle_point_detect                 PORTABLE C      */
34 /*                                                           6.1          */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    Kenneth Maxwell, Microsoft Corporation                              */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function checks for errors in the utility rectangle point      */
42 /*    detect function call.                                               */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    rectangle                             Rectangle                     */
47 /*    point                                 Point                         */
48 /*                                                                        */
49 /*  OUTPUT                                                                */
50 /*                                                                        */
51 /*    [GX_TRUE | GX_FALSE]                                                */
52 /*                                                                        */
53 /*  CALLS                                                                 */
54 /*                                                                        */
55 /*    _gx_utility_rectangle_point_detect    Actual utility rectangle      */
56 /*                                          point detect function         */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    Application Code                                                    */
61 /*                                                                        */
62 /*  RELEASE HISTORY                                                       */
63 /*                                                                        */
64 /*    DATE              NAME                      DESCRIPTION             */
65 /*                                                                        */
66 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
67 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
68 /*                                            resulting in version 6.1    */
69 /*                                                                        */
70 /**************************************************************************/
_gxe_utility_rectangle_point_detect(GX_RECTANGLE * rectangle,GX_POINT point)71 GX_BOOL  _gxe_utility_rectangle_point_detect(GX_RECTANGLE *rectangle, GX_POINT point)
72 {
73 GX_BOOL status;
74 
75     /* Check for invalid input pointers.  */
76     if (rectangle == GX_NULL)
77     {
78         return(GX_FALSE);
79     }
80 
81     /* Check for valid rectangle.  */
82     if ((rectangle -> gx_rectangle_left > rectangle -> gx_rectangle_right) ||
83         (rectangle -> gx_rectangle_top > rectangle -> gx_rectangle_bottom))
84     {
85         return(GX_FALSE);
86     }
87 
88     /* Call the actual utility rectangle point detect function.  */
89     status = _gx_utility_rectangle_point_detect(rectangle, point);
90 
91     /* Return completion status.  */
92     return status;
93 }
94 
95