include/babeltrace/ctf-ir/field-path-internal.h

   1 #ifndef BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL
   2 #define BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL
   3
   4 /*
   5  * BabelTrace - CTF IR: Field path
   6  *
   7  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #include <babeltrace/object-internal.h>
  32 #include <glib.h>
  33
  34 struct bt_ctf_field_path {
  35         struct bt_object base;
  36         enum bt_ctf_scope root;
  37
  38         /*
  39          * Array of integers (int) indicating the index in either
  40          * structures, variants, arrays, or sequences that make up
  41          * the path to a field type. -1 means the "current element
  42          * of an array or sequence type".
  43          */
  44         GArray *indexes;
  45 };
  46
  47 BT_HIDDEN
  48 struct bt_ctf_field_path *bt_ctf_field_path_create(void);
  49
  50 BT_HIDDEN
  51 void bt_ctf_field_path_clear(struct bt_ctf_field_path *field_path);
  52
  53 BT_HIDDEN
  54 struct bt_ctf_field_path *bt_ctf_field_path_copy(
  55                 struct bt_ctf_field_path *path);
  56
  57 #endif /* BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL */