lib: rename "begin" to "beginning" when used as a noun
[babeltrace.git] / include / babeltrace / trace-ir / stream-internal.h
1 #ifndef BABELTRACE_TRACE_IR_STREAM_INTERNAL_H
2 #define BABELTRACE_TRACE_IR_STREAM_INTERNAL_H
3
4 /*
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@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
28 #include <babeltrace/trace-ir/stream.h>
29 #include <babeltrace/trace-ir/utils-internal.h>
30 #include <babeltrace/object-internal.h>
31 #include <babeltrace/object-pool-internal.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <glib.h>
34
35 struct bt_stream_class;
36 struct bt_stream;
37
38 struct bt_stream {
39 struct bt_object base;
40
41 /* Owned by this */
42 struct bt_stream_class *class;
43
44 struct {
45 GString *str;
46
47 /* NULL or `str->str` above */
48 const char *value;
49 } name;
50
51 uint64_t id;
52
53 /* Pool of `struct bt_packet *` */
54 struct bt_object_pool packet_pool;
55
56 bool frozen;
57 };
58
59 BT_HIDDEN
60 void _bt_stream_freeze(const struct bt_stream *stream);
61
62 #ifdef BT_DEV_MODE
63 # define bt_stream_freeze _bt_stream_freeze
64 #else
65 # define bt_stream_freeze(_stream)
66 #endif
67
68 static inline
69 struct bt_trace *bt_stream_borrow_trace_inline(const struct bt_stream *stream)
70 {
71 BT_ASSERT(stream);
72 return (void *) bt_object_borrow_parent(&stream->base);
73 }
74
75 #endif /* BABELTRACE_TRACE_IR_STREAM_INTERNAL_H */
This page took 0.031072 seconds and 4 git commands to generate.