include/babeltrace/ctf-ir/utils.h

   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
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 #include <babeltrace/babeltrace-internal.h>
  38 #include <babeltrace/objects.h>
  39
  40 /*
  41  * bt_ctf_validate_identifier: validate an identifier against the CTF spec.
  42  *
  43  * Validate that an identifier meets the CTF specification's restrictions on
  44  * identifiers. An identifier will be rejected if it is a keyword defined
  45  * in the CTF specification or if it does not meet any other requirement imposed
  46  * on identifiers.
  47  *
  48  * Note that this will not check whether or not the identifier clashes with
  49  * identifiers used in a given trace.
  50  *
  51  * Returns 0 if the identifier is valid, a negative value on error.
  52  */
  53 extern int bt_ctf_validate_identifier(const char *identifier);
  54
  55 BT_HIDDEN
  56 struct bt_object *bt_ctf_attributes_create(void);
  57
  58 BT_HIDDEN
  59 void bt_ctf_attributes_destroy(struct bt_object *attr_obj);
  60
  61 BT_HIDDEN
  62 int bt_ctf_attributes_get_count(struct bt_object *attr_obj);
  63
  64 BT_HIDDEN
  65 const char *bt_ctf_attributes_get_field_name(struct bt_object *attr_obj,
  66                 int index);
  67
  68 BT_HIDDEN
  69 struct bt_object *bt_ctf_attributes_get_field_value(struct bt_object *attr_obj,
  70                 int index);
  71
  72 BT_HIDDEN
  73 int bt_ctf_attributes_set_field_value(struct bt_object *attr_obj,
  74                 const char *name, struct bt_object *value_obj);
  75
  76 BT_HIDDEN
  77 struct bt_object *bt_ctf_attributes_get_field_value_by_name(
  78                 struct bt_object *attr_obj, const char *name);
  79
  80 BT_HIDDEN
  81 int bt_ctf_attributes_freeze(struct bt_object *attr_obj);
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif
  86
  87 #endif /* BABELTRACE_CTF_IR_UTILS_H */