projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 654c1444 JG |
1 | #ifndef BABELTRACE_CTF_IR_UTILS_H |
| 2 | #define BABELTRACE_CTF_IR_UTILS_H | |
| 3 | ||
| 4 | /* | |
| 5 | * BabelTrace - CTF IR: Utilities | |
| 6 | * | |
| 7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
| 8 | * | |
| 9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
| 10 | * | |
| 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: | |
| 17 | * | |
| 18 | * The above copyright notice and this permission notice shall be included in | |
| 19 | * all copies or substantial portions of the Software. | |
| 20 | * | |
| 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 | |
| 27 | * SOFTWARE. | |
| 28 | * | |
| 29 | * The Common Trace Format (CTF) Specification is available at | |
| 30 | * http://www.efficios.com/ctf | |
| 31 | */ | |
| 32 | ||
| 075edd49 PP |
33 | #include <babeltrace/types.h> |
| 34 | ||
| 654c1444 JG |
35 | #ifdef __cplusplus |
| 36 | extern "C" { | |
| 37 | #endif | |
| 38 | ||
| e7586526 PP |
39 | /** |
| 40 | @defgroup ctfirutils CTF IR utilities | |
| 41 | @ingroup ctfir | |
| 42 | @brief CTF IR utilities. | |
| 43 | ||
| 6dd2bd0c PP |
44 | @code |
| 45 | #include <babeltrace/ctf-ir/utils.h> | |
| 46 | @endcode | |
| 47 | ||
| e7586526 PP |
48 | @file |
| 49 | @brief CTF IR utilities functions. | |
| 50 | @sa ctfirutils | |
| 51 | ||
| 52 | @addtogroup ctfirutils | |
| 53 | @{ | |
| 54 | */ | |
| 55 | ||
| 56 | /** | |
| 57 | @brief Returns whether or not the string \p identifier is a valid | |
| 58 | identifier according to CTF. | |
| 59 | ||
| 60 | This function returns a negative value if \p identifier is a CTF keyword | |
| 61 | or if it does not meet any other imposed requirement. | |
| 62 | ||
| 63 | @param[in] identifier String to test. | |
| 075edd49 PP |
64 | @returns #BT_TRUE if \p identifier is a valid CTF |
| 65 | identifier, or #BT_FALSE otherwise. | |
| e7586526 PP |
66 | |
| 67 | @prenotnull{identifier} | |
| 68 | */ | |
| 075edd49 | 69 | extern bt_bool bt_ctf_identifier_is_valid(const char *identifier); |
| 654c1444 | 70 | |
| e7586526 PP |
71 | /** @} */ |
| 72 | ||
| 075edd49 PP |
73 | /* Pre-2.0 CTF writer compatibility */ |
| 74 | extern int bt_ctf_validate_identifier(const char *identifier); | |
| 75 | ||
| 654c1444 JG |
76 | #ifdef __cplusplus |
| 77 | } | |
| 78 | #endif | |
| 79 | ||
| 80 | #endif /* BABELTRACE_CTF_IR_UTILS_H */ |