Add CTF-IR visitor interface
[babeltrace.git] / include / babeltrace / ctf-ir / visitor.h
CommitLineData
8bf65fbd
JG
1#ifndef BABELTRACE_CTF_IR_VISITOR_H
2#define BABELTRACE_CTF_IR_VISITOR_H
3
4/*
5 * BabelTrace - CTF IR: Visitor
6 *
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
31 */
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct bt_ctf_ir_element;
38
39enum bt_ctf_ir_type {
40 BT_CTF_IR_TYPE_UNKNOWN = -1,
41 BT_CTF_IR_TYPE_TRACE = 0,
42 BT_CTF_IR_TYPE_STREAM_CLASS = 1,
43 BT_CTF_IR_TYPE_STREAM = 2,
44 BT_CTF_IR_TYPE_EVENT_CLASS = 3,
45 BT_CTF_IR_TYPE_EVENT = 4,
46 BT_CTF_IR_TYPE_NR,
47};
48
49typedef int (*bt_ctf_ir_visitor)(struct bt_ctf_ir_element *element,
50 void *data);
51
52/*
53 * bt_ctf_ir_element_get_type: get an IR element's type.
54 *
55 * Get an IR element's type.
56 *
57 * @param element Element instance.
58 *
59 * Returns one of #bt_ctf_ir_type.
60 */
61enum bt_ctf_ir_type bt_ctf_ir_element_get_type(
62 struct bt_ctf_ir_element *element);
63
64/*
65 * bt_ctf_ir_element_get_element: get an IR element's value.
66 *
67 * Get an IR element's value.
68 *
69 * @param element Element instance.
70 *
71 * Returns a CTF-IR type. Use #bt_ctf_ir_type to determine the
72 * concrete type of the value returned.
73 */
74void *bt_ctf_ir_element_get_element(struct bt_ctf_ir_element *element);
75
76#ifdef __cplusplus
77}
78#endif
79
80#endif /* BABELTRACE_CTF_IR_VISITOR_H */
This page took 0.025565 seconds and 4 git commands to generate.