GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: gx_system_animation_get.c Lines: 15 15 100.0 %
Date: 2024-12-05 08:52:37 Branches: 2 2 100.0 %

Line Branch Exec Source
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
/**   System Management (System)                                          */
18
/**                                                                       */
19
/**************************************************************************/
20
21
#define GX_SOURCE_CODE
22
23
24
/* Include necessary system files.  */
25
26
#include "gx_api.h"
27
#include "gx_system.h"
28
#include "gx_animation.h"
29
30
31
/**************************************************************************/
32
/*                                                                        */
33
/*  FUNCTION                                               RELEASE        */
34
/*                                                                        */
35
/*    _gx_system_animation_get                            PORTABLE C      */
36
/*                                                           6.1.3        */
37
/*  AUTHOR                                                                */
38
/*                                                                        */
39
/*    Kenneth Maxwell, Microsoft Corporation                              */
40
/*                                                                        */
41
/*  DESCRIPTION                                                           */
42
/*                                                                        */
43
/*    Obtain an animation structure from the system pool.                 */
44
/*                                                                        */
45
/*  INPUT                                                                 */
46
/*                                                                        */
47
/*    animation                             Adress to return pointer      */
48
/*                                                                        */
49
/*  OUTPUT                                                                */
50
/*                                                                        */
51
/*    status                                Completion status             */
52
/*                                                                        */
53
/*  CALLS                                                                 */
54
/*                                                                        */
55
/*   _gx_system_lock                        lock system mutex             */
56
/*   _gx_system_unlock                      unlock system mutex           */
57
/*                                                                        */
58
/*  CALLED BY                                                             */
59
/*                                                                        */
60
/*    GUIX Application                                                    */
61
/*    GUIX Internal Code                                                  */
62
/*                                                                        */
63
/*  RELEASE HISTORY                                                       */
64
/*                                                                        */
65
/*    DATE              NAME                      DESCRIPTION             */
66
/*                                                                        */
67
/*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
68
/*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
69
/*                                            resulting in version 6.1    */
70
/*  12-31-2020     Kenneth Maxwell          Modified comment(s), init     */
71
/*                                            animation canvas to null,   */
72
/*                                            resulting in version 6.1.3  */
73
/*                                                                        */
74
/**************************************************************************/
75
#if (GX_ANIMATION_POOL_SIZE > 0)
76
77
25
UINT  _gx_system_animation_get(GX_ANIMATION **animation)
78
{
79
25
UINT status = GX_SUCCESS;
80
GX_ANIMATION *free_block;
81
82
    /* lock entering critical section */
83
25
    GX_ENTER_CRITICAL
84
85
    /* check for already having this timer */
86
25
    if (_gx_system_animation_free_list)
87
    {
88
24
        free_block = _gx_system_animation_free_list;
89
24
        _gx_system_animation_free_list = free_block -> gx_animation_next;
90
24
        free_block -> gx_animation_next = GX_NULL;
91
24
        free_block -> gx_animation_system_allocated = GX_TRUE;
92
24
        free_block -> gx_animation_status = GX_ANIMATION_IDLE;
93
24
        free_block -> gx_animation_canvas = GX_NULL;
94
24
        *animation = free_block;
95
    }
96
    else
97
    {
98
1
        *animation = GX_NULL;
99
1
        status = GX_OUT_OF_ANIMATIONS;
100
    }
101
102
25
    GX_EXIT_CRITICAL
103
25
    return status;
104
}
105
#endif