1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#pragma once
#ifdef __cplusplus
#include <string_view>
#endif
/**
* A const UTF8 string.
*/
struct WPI_String {
/** Contents. */
const char* str;
/** Length */
size_t len;
};
#ifdef __cplusplus
namespace wpi {
/** Converts a WPI_String to a string_view */
constexpr std::string_view to_string_view(const struct WPI_String* str) {
if (str) {
return {str->str, str->len};
} else {
return "";
}
}
/** Converts a string_view to a WPI_String */
constexpr WPI_String make_string(std::string_view view) {
return WPI_String{view.data(), view.size()};
}
} // namespace wpi
#endif // __cplusplus
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Initializes a WPI_String from a null terminated UTF-8 string.
* If input string is null, initializes output to 0 length.
* The output length does not include the null terminator.
*
* The lifetime of the output string is the lifetime of the input string.
* Do not call WPI_FreeString() with the output of this call.
*
* @param wpiString output string
* @param utf8String input string (null terminated)
*/
void WPI_InitString(struct WPI_String* wpiString, const char* utf8String);
/**
* Initializes a WPI_String from a UTF-8 string and length.
* If input string is null or 0 length, initializes output to 0 length.
* The input string does not need to be null terminated.
*
* The lifetime of the output string is the lifetime of the input string.
* Do not call WPI_FreeString() with the output of this call.
*
* @param wpiString output string
* @param utf8String input string
* @param length input string length in chars
*/
void WPI_InitStringWithLength(struct WPI_String* wpiString,
const char* utf8String, size_t length);
/**
* Allocates a WPI_String for the specified length.
* The resultant string must be freed with WPI_FreeString().
*
* @param wpiString output string
* @param length string length in chars to allocate
* @return mutable pointer to allocated buffer
*
*/
char* WPI_AllocateString(struct WPI_String* wpiString, size_t length);
/**
* Frees a WPI_String that was allocated with WPI_AllocateString()
*
* @param wpiString string to free
*/
void WPI_FreeString(const struct WPI_String* wpiString);
/**
* Allocates an array of WPI_Strings.
*
* @param length array length
* @return string array
*/
struct WPI_String* WPI_AllocateStringArray(size_t length);
/**
* Frees a WPI_String array returned by WPI_AllocateStringArray().
*
* @param wpiStringArray string array to free
* @param length length of array
*/
void WPI_FreeStringArray(const struct WPI_String* wpiStringArray,
size_t length);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus