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                       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 /*    function call.                                                      */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    rectangle                             Rectangle to center           */
49 /*    within                                Rectangle to center within    */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    None                                                                */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    _gx_utility_rectangle_center          Actual utility rectangle      */
58 /*                                            center 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_center(GX_RECTANGLE * rectangle,GX_RECTANGLE * within)73 UINT  _gxe_utility_rectangle_center(GX_RECTANGLE *rectangle, GX_RECTANGLE *within)
74 {
75     /* Check for invalid input pointers.  */
76     if ((rectangle == GX_NULL) || (within == GX_NULL))
77     {
78         return GX_PTR_ERROR;
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         (within -> gx_rectangle_left > within -> gx_rectangle_right) ||
85         (within -> gx_rectangle_top > within -> gx_rectangle_bottom))
86     {
87         return GX_INVALID_SIZE;
88     }
89 
90     /* Call the actual utility rectangle center function.  */
91     return(_gx_utility_rectangle_center(rectangle, within));
92 }
93 
94