Document libbabeltrace2's C API
[babeltrace.git] / include / babeltrace2 / babeltrace.h
CommitLineData
3fd40f46
PP
1#ifndef BABELTRACE2_BABELTRACE_H
2#define BABELTRACE2_BABELTRACE_H
71c5da58
MJ
3
4/*
0dcb770f 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
71c5da58
MJ
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
9df34b44
PP
26/*
27 * Tell the specific headers that they are included from this header.
28 *
29 * Do NOT define `__BT_IN_BABELTRACE_H` in user code.
30 */
31#ifndef __BT_IN_BABELTRACE_H
32# define __BT_IN_BABELTRACE_H
33#endif
34
efe1e0a9 35/* Internal: needed by some of the following included headers */
9df34b44
PP
36#include <babeltrace2/func-status.h>
37
efe1e0a9
PP
38/* Internal: needed by some of the following included headers */
39#ifdef __cplusplus
40# define __BT_UPCAST(_type, _p) static_cast<_type *>(static_cast<void *>(_p))
41# define __BT_UPCAST_CONST(_type, _p) static_cast<const _type *>(static_cast<const void *>(_p))
42#else
43# define __BT_UPCAST(_type, _p) ((_type *) (_p))
44# define __BT_UPCAST_CONST(_type, _p) ((const _type *) (_p))
45#endif
46
7704a0af
PP
47#include <babeltrace2/error-reporting.h>
48#include <babeltrace2/graph/component-class-dev.h>
49#include <babeltrace2/graph/component-class.h>
50#include <babeltrace2/graph/component-descriptor-set.h>
51#include <babeltrace2/graph/component.h>
52#include <babeltrace2/graph/connection.h>
53#include <babeltrace2/graph/graph.h>
54#include <babeltrace2/graph/interrupter.h>
55#include <babeltrace2/graph/message-iterator.h>
56#include <babeltrace2/graph/message.h>
57#include <babeltrace2/graph/port.h>
58#include <babeltrace2/graph/private-query-executor.h>
59#include <babeltrace2/graph/query-executor.h>
60#include <babeltrace2/graph/self-component-class.h>
61#include <babeltrace2/graph/self-component-port.h>
62#include <babeltrace2/graph/self-component.h>
63#include <babeltrace2/graph/self-message-iterator.h>
ba38aae7 64#include <babeltrace2/integer-range-set.h>
71c5da58 65#include <babeltrace2/logging.h>
7704a0af
PP
66#include <babeltrace2/plugin/plugin-dev.h>
67#include <babeltrace2/plugin/plugin-loading.h>
71c5da58 68#include <babeltrace2/trace-ir/clock-class.h>
7704a0af 69#include <babeltrace2/trace-ir/clock-snapshot.h>
71c5da58 70#include <babeltrace2/trace-ir/event-class.h>
71c5da58 71#include <babeltrace2/trace-ir/event.h>
71c5da58 72#include <babeltrace2/trace-ir/field-class.h>
7704a0af 73#include <babeltrace2/trace-ir/field-path.h>
71c5da58 74#include <babeltrace2/trace-ir/field.h>
71c5da58 75#include <babeltrace2/trace-ir/packet.h>
71c5da58 76#include <babeltrace2/trace-ir/stream-class.h>
71c5da58 77#include <babeltrace2/trace-ir/stream.h>
71c5da58 78#include <babeltrace2/trace-ir/trace-class.h>
71c5da58 79#include <babeltrace2/trace-ir/trace.h>
7704a0af
PP
80#include <babeltrace2/types.h>
81#include <babeltrace2/util.h>
82#include <babeltrace2/value.h>
83#include <babeltrace2/version.h>
9df34b44
PP
84
85/* Cancel private definitions */
d73bb381
PP
86#undef __BT_FUNC_STATUS_AGAIN
87#undef __BT_FUNC_STATUS_END
d73bb381
PP
88#undef __BT_FUNC_STATUS_ERROR
89#undef __BT_FUNC_STATUS_INTERRUPTED
7dd3e712 90#undef __BT_FUNC_STATUS_UNKNOWN_OBJECT
9df34b44 91#undef __BT_FUNC_STATUS_MEMORY_ERROR
9df34b44 92#undef __BT_FUNC_STATUS_NOT_FOUND
d73bb381 93#undef __BT_FUNC_STATUS_OK
f67e22d1 94#undef __BT_FUNC_STATUS_OVERFLOW_ERROR
0589c646 95#undef __BT_FUNC_STATUS_USER_ERROR
9df34b44 96#undef __BT_IN_BABELTRACE_H
efe1e0a9
PP
97#undef __BT_UPCAST
98#undef __BT_UPCAST_CONST
3fef1229
SM
99#undef __BT_LOGGING_LEVEL_TRACE
100#undef __BT_LOGGING_LEVEL_DEBUG
101#undef __BT_LOGGING_LEVEL_INFO
102#undef __BT_LOGGING_LEVEL_WARNING
103#undef __BT_LOGGING_LEVEL_ERROR
104#undef __BT_LOGGING_LEVEL_FATAL
105#undef __BT_LOGGING_LEVEL_NONE
71c5da58 106
3fd40f46 107#endif /* BABELTRACE2_BABELTRACE_H */
This page took 0.045111 seconds and 4 git commands to generate.