Replace assert() -> BT_ASSERT() and some preconditions with BT_ASSERT_PRE()
[babeltrace.git] / include / babeltrace / ctf-ir / fields-internal.h
CommitLineData
2e33ac5a
PP
1#ifndef BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
2#define BABELTRACE_CTF_IR_FIELDS_INTERNAL_H
273b65be
JG
3
4/*
2e33ac5a 5 * Babeltrace - CTF IR: Event Fields internal
273b65be 6 *
de9dd397 7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be
JG
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
dc3fffef 30#include <babeltrace/ctf-ir/field-types.h>
273b65be 31#include <babeltrace/ctf-writer/event-fields.h>
83509119 32#include <babeltrace/object-internal.h>
273b65be 33#include <babeltrace/babeltrace-internal.h>
c55a9f58 34#include <babeltrace/types.h>
dc3fffef 35#include <stdint.h>
d990a4fb 36#include <stdbool.h>
273b65be
JG
37#include <glib.h>
38
50842bdc 39struct bt_stream_pos;
dc3fffef 40
50842bdc 41struct bt_field {
83509119 42 struct bt_object base;
50842bdc 43 struct bt_field_type *type;
d990a4fb
JG
44 bool payload_set;
45 bool frozen;
273b65be
JG
46};
47
50842bdc
PP
48struct bt_field_integer {
49 struct bt_field parent;
dc3fffef
PP
50 union {
51 int64_t signd;
52 uint64_t unsignd;
53 } payload;
273b65be
JG
54};
55
50842bdc
PP
56struct bt_field_enumeration {
57 struct bt_field parent;
58 struct bt_field *payload;
273b65be
JG
59};
60
50842bdc
PP
61struct bt_field_floating_point {
62 struct bt_field parent;
dc3fffef 63 double payload;
273b65be
JG
64};
65
50842bdc
PP
66struct bt_field_structure {
67 struct bt_field parent;
68 GPtrArray *fields; /* Array of pointers to struct bt_field */
273b65be
JG
69};
70
50842bdc
PP
71struct bt_field_variant {
72 struct bt_field parent;
73 struct bt_field *tag;
74 struct bt_field *payload;
273b65be
JG
75};
76
50842bdc
PP
77struct bt_field_array {
78 struct bt_field parent;
79 GPtrArray *elements; /* Array of pointers to struct bt_field */
273b65be
JG
80};
81
50842bdc
PP
82struct bt_field_sequence {
83 struct bt_field parent;
84 struct bt_field *length;
85 GPtrArray *elements; /* Array of pointers to struct bt_field */
273b65be
JG
86};
87
50842bdc
PP
88struct bt_field_string {
89 struct bt_field parent;
273b65be
JG
90 GString *payload;
91};
92
f6ccaed9
PP
93BT_HIDDEN
94int bt_field_serialize_recursive(struct bt_field *field,
95 struct bt_stream_pos *pos,
96 enum bt_byte_order native_byte_order);
97
662e778c 98/* Validate that the field's payload is set (returns 0 if set). */
273b65be 99BT_HIDDEN
f6ccaed9 100int _bt_field_validate_recursive(struct bt_field *field);
273b65be
JG
101
102BT_HIDDEN
f6ccaed9
PP
103void _bt_field_freeze_recursive(struct bt_field *field);
104
105BT_HIDDEN
106bt_bool _bt_field_is_set_recursive(struct bt_field *field);
107
108BT_HIDDEN
109void _bt_field_reset_recursive(struct bt_field *field);
273b65be 110
918be005 111BT_HIDDEN
f6ccaed9
PP
112void _bt_field_set(struct bt_field *field, bool val);
113
114#ifdef BT_DEV_MODE
115# define bt_field_validate_recursive _bt_field_validate_recursive
116# define bt_field_freeze_recursive _bt_field_freeze_recursive
117# define bt_field_is_set_recursive _bt_field_is_set_recursive
118# define bt_field_reset_recursive _bt_field_reset_recursive
119# define bt_field_set _bt_field_set
120#else
121# define bt_field_validate_recursive(_field) (-1)
122# define bt_field_freeze_recursive(_field)
123# define bt_field_is_set_recursive(_field) (BT_FALSE)
124# define bt_field_reset_recursive(_field) (BT_TRUE)
125# define bt_field_set(_field, _val)
126#endif
918be005 127
2e8876d3
PP
128BT_HIDDEN
129int64_t bt_field_sequence_get_int_length(struct bt_field *field);
130
2e33ac5a 131#endif /* BABELTRACE_CTF_IR_FIELDS_INTERNAL_H */
This page took 0.052543 seconds and 4 git commands to generate.