1 #ifndef BABELTRACE_CTF_IR_UTILS_H
2 #define BABELTRACE_CTF_IR_UTILS_H
5 * BabelTrace - CTF IR: Utilities
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
38 @defgroup ctfirutils CTF IR utilities
40 @brief CTF IR utilities.
43 #include <babeltrace/ctf-ir/utils.h>
47 @brief CTF IR utilities functions.
50 @addtogroup ctfirutils
55 @brief Returns whether or not the string \p identifier is a valid
56 identifier according to CTF.
58 This function returns a negative value if \p identifier is a CTF keyword
59 or if it does not meet any other imposed requirement.
61 @param[in] identifier String to test.
62 @returns 0 if \p identifier is a valid identifier, or
63 a negative value otherwise or on error.
65 @prenotnull{identifier}
67 extern int bt_ctf_validate_identifier(const char *identifier
);
75 #endif /* BABELTRACE_CTF_IR_UTILS_H */
This page took 0.039932 seconds and 4 git commands to generate.