utils.h 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. #ifndef BABELTRACE_CTF_IR_UTILS_H
  2. #define BABELTRACE_CTF_IR_UTILS_H
  3. /*
  4. * BabelTrace - CTF IR: Utilities
  5. *
  6. * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  7. *
  8. * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  9. *
  10. * Permission is hereby granted, free of charge, to any person obtaining a copy
  11. * of this software and associated documentation files (the "Software"), to deal
  12. * in the Software without restriction, including without limitation the rights
  13. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14. * copies of the Software, and to permit persons to whom the Software is
  15. * furnished to do so, subject to the following conditions:
  16. *
  17. * The above copyright notice and this permission notice shall be included in
  18. * all copies or substantial portions of the Software.
  19. *
  20. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26. * SOFTWARE.
  27. *
  28. * The Common Trace Format (CTF) Specification is available at
  29. * http://www.efficios.com/ctf
  30. */
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /*
  35. * bt_ctf_validate_identifier: validate an identifier against the CTF spec.
  36. *
  37. * Validate that an identifier meets the CTF specification's restrictions on
  38. * identifiers. An identifier will be rejected if it is a keyword defined
  39. * in the CTF specification or if it does not meet any other requirement imposed
  40. * on identifiers.
  41. *
  42. * Note that this will not check whether or not the identifier clashes with
  43. * identifiers used in a given trace.
  44. *
  45. * Returns 0 if the identifier is valid, a negative value on error.
  46. */
  47. extern int bt_ctf_validate_identifier(const char *identifier);
  48. #ifdef __cplusplus
  49. }
  50. #endif
  51. #endif /* BABELTRACE_CTF_IR_UTILS_H */