src/ctf-writer/field-path.h

   1 #ifndef BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL
   2 #define BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL
   3
   4 /*
   5  * Copyright 2016 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 "common/common.h"
  30 #include "common/assert.h"
  31 #include "common/macros.h"
  32 #include <babeltrace2/ctf-writer/field-types.h>
  33 #include <glib.h>
  34
  35 #include "object.h"
  36
  37 struct bt_ctf_field_path {
  38         struct bt_ctf_object base;
  39         enum bt_ctf_scope root;
  40
  41         /*
  42          * Array of integers (int) indicating the index in either
  43          * structures, variants, arrays, or sequences that make up
  44          * the path to a field type. -1 means the "current element
  45          * of an array or sequence type".
  46          */
  47         GArray *indexes;
  48 };
  49
  50 BT_HIDDEN
  51 struct bt_ctf_field_path *bt_ctf_field_path_create(void);
  52
  53 BT_HIDDEN
  54 void bt_ctf_field_path_clear(struct bt_ctf_field_path *field_path);
  55
  56 BT_HIDDEN
  57 struct bt_ctf_field_path *bt_ctf_field_path_copy(
  58                 struct bt_ctf_field_path *path);
  59
  60 BT_HIDDEN enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
  61                 const struct bt_ctf_field_path *field_path);
  62
  63 BT_HIDDEN int64_t bt_ctf_field_path_get_index_count(
  64                 const struct bt_ctf_field_path *field_path);
  65
  66 BT_HIDDEN int bt_ctf_field_path_get_index(
  67                 const struct bt_ctf_field_path *field_path, uint64_t index);
  68
  69 #endif /* BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL */