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 <assert.h>
  33 #include <glib.h>
  34
  35 struct bt_field_path {
  36         struct bt_object base;
  37         enum bt_scope root;
  38
  39         /*
  40          * Array of integers (int) indicating the index in either
  41          * structures, variants, arrays, or sequences that make up
  42          * the path to a field type. -1 means the "current element
  43          * of an array or sequence type".
  44          */
  45         GArray *indexes;
  46 };
  47
  48 BT_HIDDEN
  49 struct bt_field_path *bt_field_path_create(void);
  50
  51 BT_HIDDEN
  52 void bt_field_path_clear(struct bt_field_path *field_path);
  53
  54 BT_HIDDEN
  55 struct bt_field_path *bt_field_path_copy(
  56                 struct bt_field_path *path);
  57
  58 static inline
  59 GString *bt_field_path_string(struct bt_field_path *path)
  60 {
  61         GString *str = g_string_new(NULL);
  62         size_t i;
  63
  64         assert(path);
  65
  66         if (!str) {
  67                 goto end;
  68         }
  69
  70         g_string_append_printf(str, "[%s", bt_scope_string(path->root));
  71
  72         for (i = 0; i < path->indexes->len; i++) {
  73                 int index = g_array_index(path->indexes, int, i);
  74
  75                 g_string_append_printf(str, ", %d", index);
  76         }
  77
  78         g_string_append(str, "]");
  79
  80 end:
  81         return str;
  82 }
  83
  84 #endif /* BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL */