include/babeltrace2/trace-ir/field-path-internal.h

   1 #ifndef BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
   2 #define BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
   3
   4 /*
   5  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * The Common Trace Format (CTF) Specification is available at
  26  * http://www.efficios.com/ctf
  27  */
  28
  29 #include <babeltrace2/object-internal.h>
  30 #include <babeltrace2/trace-ir/field-path-const.h>
  31 #include <babeltrace2/assert-internal.h>
  32 #include <glib.h>
  33
  34 struct bt_field_path_item {
  35         enum bt_field_path_item_type type;
  36         uint64_t index;
  37 };
  38
  39 struct bt_field_path {
  40         struct bt_object base;
  41         enum bt_scope root;
  42
  43         /* Array of `struct bt_field_path_item` (items) */
  44         GArray *items;
  45 };
  46
  47 BT_HIDDEN
  48 struct bt_field_path *bt_field_path_create(void);
  49
  50 static inline
  51 struct bt_field_path_item *bt_field_path_borrow_item_by_index_inline(
  52                 const struct bt_field_path *field_path, uint64_t index)
  53 {
  54         BT_ASSERT(field_path);
  55         BT_ASSERT(index < field_path->items->len);
  56         return &g_array_index(field_path->items, struct bt_field_path_item,
  57                 index);
  58 }
  59
  60 static inline
  61 void bt_field_path_append_item(struct bt_field_path *field_path,
  62                 struct bt_field_path_item *item)
  63 {
  64         BT_ASSERT(field_path);
  65         BT_ASSERT(item);
  66         g_array_append_val(field_path->items, *item);
  67 }
  68
  69 static inline
  70 void bt_field_path_remove_last_item(struct bt_field_path *field_path)
  71 {
  72         BT_ASSERT(field_path);
  73         BT_ASSERT(field_path->items->len > 0);
  74         g_array_set_size(field_path->items, field_path->items->len - 1);
  75 }
  76
  77 static inline
  78 const char *bt_field_path_item_type_string(enum bt_field_path_item_type type)
  79 {
  80         switch (type) {
  81         case BT_FIELD_PATH_ITEM_TYPE_INDEX:
  82                 return "BT_FIELD_PATH_ITEM_TYPE_INDEX";
  83         case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
  84                 return "BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT";
  85         default:
  86                 return "(unknown)";
  87         }
  88 };
  89
  90 #endif /* BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL */