[babeltrace.git] / include / babeltrace / ctf-ir / utils.h

#ifndef BABELTRACE_CTF_IR_UTILS_H
#define BABELTRACE_CTF_IR_UTILS_H

/*
 * BabelTrace - CTF IR: Utilities
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

/* For bt_bool */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
@defgroup ctfirutils CTF IR utilities
@ingroup ctfir
@brief CTF IR utilities.

@code
#include <babeltrace/ctf-ir/utils.h>
@endcode

@file
@brief CTF IR utilities functions.
@sa ctfirutils

@addtogroup ctfirutils
@{
*/

/**
@brief	Returns whether or not the string \p identifier is a valid
	identifier according to CTF.

This function returns a negative value if \p identifier is a CTF keyword
or if it does not meet any other imposed requirement.

@param[in] identifier	String to test.
@returns		#BT_TRUE if \p identifier is a valid CTF
			identifier, or #BT_FALSE otherwise.

@prenotnull{identifier}
*/
extern bt_bool bt_identifier_is_valid(const char *identifier);

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_IR_UTILS_H */
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
9d408fca	33	/* For bt_bool */
075edd49 PP	34	#include <babeltrace/types.h>
075edd49 PP	35
654c1444 JG	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
e7586526 PP	40	/**
	41	@defgroup ctfirutils CTF IR utilities
	42	@ingroup ctfir
	43	@brief CTF IR utilities.
	44
6dd2bd0c PP	45	@code
	46	#include <babeltrace/ctf-ir/utils.h>
	47	@endcode
	48
e7586526 PP	49	@file
	50	@brief CTF IR utilities functions.
	51	@sa ctfirutils
	52
	53	@addtogroup ctfirutils
	54	@{
	55	*/
	56
	57	/**
	58	@brief Returns whether or not the string \p identifier is a valid
	59	identifier according to CTF.
	60
	61	This function returns a negative value if \p identifier is a CTF keyword
	62	or if it does not meet any other imposed requirement.
	63
	64	@param[in] identifier String to test.
075edd49 PP	65	@returns #BT_TRUE if \p identifier is a valid CTF
075edd49 PP	66	identifier, or #BT_FALSE otherwise.
e7586526 PP	67
	68	@prenotnull{identifier}
	69	*/
50842bdc	70	extern bt_bool bt_identifier_is_valid(const char *identifier);
654c1444	71
e7586526 PP	72	/** @} */
e7586526 PP	73
654c1444 JG	74	#ifdef __cplusplus
	75	}
	76	#endif
	77
	78	#endif /* BABELTRACE_CTF_IR_UTILS_H */