1 |
|
|
/*************************************************************************** |
2 |
|
|
* Copyright (c) 2024 Microsoft Corporation |
3 |
|
|
* Copyright (c) 2026-present Eclipse ThreadX contributors |
4 |
|
|
* |
5 |
|
|
* This program and the accompanying materials are made available under the |
6 |
|
|
* terms of the MIT License which is available at |
7 |
|
|
* https://opensource.org/licenses/MIT. |
8 |
|
|
* |
9 |
|
|
* SPDX-License-Identifier: MIT |
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 |
|
|
/**************************************************************************/ |
31 |
|
|
/* */ |
32 |
|
|
/* FUNCTION RELEASE */ |
33 |
|
|
/* */ |
34 |
|
|
/* _gx_utility_string_length_check PORTABLE C */ |
35 |
|
|
/* 6.1 */ |
36 |
|
|
/* AUTHOR */ |
37 |
|
|
/* */ |
38 |
|
|
/* Kenneth Maxwell, Microsoft Corporation */ |
39 |
|
|
/* */ |
40 |
|
|
/* DESCRIPTION */ |
41 |
|
|
/* */ |
42 |
|
|
/* This function traverses the string and returns the string length, */ |
43 |
|
|
/* if the string is invalid or the string length is bigger than max */ |
44 |
|
|
/* string length, returns error. */ |
45 |
|
|
/* */ |
46 |
|
|
/* INPUT */ |
47 |
|
|
/* */ |
48 |
|
|
/* input_string Pointer to input string */ |
49 |
|
|
/* string_length Pointer to string length */ |
50 |
|
|
/* max_string_length Max string length */ |
51 |
|
|
/* */ |
52 |
|
|
/* OUTPUT */ |
53 |
|
|
/* */ |
54 |
|
|
/* None */ |
55 |
|
|
/* */ |
56 |
|
|
/* CALLS */ |
57 |
|
|
/* */ |
58 |
|
|
/* None */ |
59 |
|
|
/* */ |
60 |
|
|
/* CALLED BY */ |
61 |
|
|
/* */ |
62 |
|
|
/* GUIX Internal Code */ |
63 |
|
|
/* */ |
64 |
|
|
/**************************************************************************/ |
65 |
|
117688 |
UINT _gx_utility_string_length_check(GX_CONST GX_CHAR *input_string, UINT *string_length, UINT max_string_length) |
66 |
|
|
{ |
67 |
|
|
UINT i; |
68 |
|
|
|
69 |
|
|
/* Check for invalid input pointers. */ |
70 |
✓✓ |
117688 |
if (input_string == GX_NULL) |
71 |
|
|
{ |
72 |
|
27 |
return(GX_PTR_ERROR); |
73 |
|
|
} |
74 |
|
|
|
75 |
|
|
/* Traverse the string. */ |
76 |
✓✓ |
4179524 |
for (i = 0; input_string[i]; i++) |
77 |
|
|
{ |
78 |
|
|
|
79 |
|
|
/* Check if the string length is bigger than the max string length. */ |
80 |
✓✓ |
4061902 |
if (i >= max_string_length) |
81 |
|
|
{ |
82 |
|
39 |
return(GX_INVALID_STRING_LENGTH); |
83 |
|
|
} |
84 |
|
|
} |
85 |
|
|
|
86 |
|
|
/* Return the string length if string_length is not NULL. |
87 |
|
|
String_length being NULL indicates the caller needs to check for string |
88 |
|
|
length within the max_string_length. */ |
89 |
✓✓ |
117622 |
if (string_length) |
90 |
|
|
{ |
91 |
|
117621 |
*string_length = i; |
92 |
|
|
} |
93 |
|
|
|
94 |
|
117622 |
return(GX_SUCCESS); |
95 |
|
|
} |
96 |
|
|
|