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 GX_CALLER_CHECKING_EXTERNS
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _gxe_utility_rectangle_center_find                  PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Kenneth Maxwell, Microsoft Corporation                              */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function checks for errors in the utility rectangle center     */
44 /*    find function call.                                                 */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    rectangle                             Rectangle                     */
49 /*    return_center                         Pointer to destination to     */
50 /*                                            store found center point    */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    None                                                                */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_utility_rectangle_center_find     Actual utility rectangle      */
59 /*                                          center find 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_center_find(GX_RECTANGLE * rectangle,GX_POINT * return_center)74 UINT  _gxe_utility_rectangle_center_find(GX_RECTANGLE *rectangle,
75                                          GX_POINT *return_center)
76 {
77     /* Check for invalid input pointers.  */
78     if ((rectangle == GX_NULL) || (return_center == GX_NULL))
79     {
80         return GX_PTR_ERROR;
81     }
82 
83     /* Check for valid rectangle.  */
84     if ((rectangle -> gx_rectangle_left > rectangle -> gx_rectangle_right) ||
85         (rectangle -> gx_rectangle_top > rectangle -> gx_rectangle_bottom))
86     {
87         return GX_INVALID_SIZE;
88     }
89 
90     /* Call the actual utility rectangle center find function.  */
91     return(_gx_utility_rectangle_center_find(rectangle, return_center));
92 }
93 
94