[babeltrace.git] / include / babeltrace2 / babeltrace.h

#ifndef BABELTRACE2_BABELTRACE_H
#define BABELTRACE2_BABELTRACE_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/*
 * Tell the specific headers that they are included from this header.
 *
 * Do NOT define `__BT_IN_BABELTRACE_H` in user code.
 */
#ifndef __BT_IN_BABELTRACE_H
# define __BT_IN_BABELTRACE_H
#endif

/* Internal: needed by some of the following included headers */
#include <babeltrace2/func-status.h>

/* Internal: needed by some of the following included headers */
#ifdef __cplusplus
# define __BT_UPCAST(_type, _p)		static_cast<_type *>(static_cast<void *>(_p))
# define __BT_UPCAST_CONST(_type, _p)	static_cast<const _type *>(static_cast<const void *>(_p))
#else
# define __BT_UPCAST(_type, _p)		((_type *) (_p))
# define __BT_UPCAST_CONST(_type, _p)	((const _type *) (_p))
#endif

/* Core API */
#include <babeltrace2/current-thread.h>
#include <babeltrace2/error-cause-const.h>
#include <babeltrace2/error-const.h>
#include <babeltrace2/integer-range-set-const.h>
#include <babeltrace2/integer-range-set.h>
#include <babeltrace2/logging.h>
#include <babeltrace2/property.h>
#include <babeltrace2/types.h>
#include <babeltrace2/util.h>
#include <babeltrace2/value-const.h>
#include <babeltrace2/value.h>
#include <babeltrace2/version.h>

/* Trace IR API */
#include <babeltrace2/trace-ir/clock-class-const.h>
#include <babeltrace2/trace-ir/clock-class.h>
#include <babeltrace2/trace-ir/clock-snapshot-const.h>
#include <babeltrace2/trace-ir/event-class-const.h>
#include <babeltrace2/trace-ir/event-class.h>
#include <babeltrace2/trace-ir/event-const.h>
#include <babeltrace2/trace-ir/event.h>
#include <babeltrace2/trace-ir/field-class-const.h>
#include <babeltrace2/trace-ir/field-class.h>
#include <babeltrace2/trace-ir/field-const.h>
#include <babeltrace2/trace-ir/field-path-const.h>
#include <babeltrace2/trace-ir/field.h>
#include <babeltrace2/trace-ir/packet-const.h>
#include <babeltrace2/trace-ir/packet-context-field.h>
#include <babeltrace2/trace-ir/packet.h>
#include <babeltrace2/trace-ir/stream-class-const.h>
#include <babeltrace2/trace-ir/stream-class.h>
#include <babeltrace2/trace-ir/stream-const.h>
#include <babeltrace2/trace-ir/stream.h>
#include <babeltrace2/trace-ir/trace-class-const.h>
#include <babeltrace2/trace-ir/trace-class.h>
#include <babeltrace2/trace-ir/trace-const.h>
#include <babeltrace2/trace-ir/trace.h>

/* Component class API */
#include <babeltrace2/graph/component-class-const.h>
#include <babeltrace2/graph/component-class-filter-const.h>
#include <babeltrace2/graph/component-class-filter.h>
#include <babeltrace2/graph/component-class-sink-const.h>
#include <babeltrace2/graph/component-class-sink.h>
#include <babeltrace2/graph/component-class-source-const.h>
#include <babeltrace2/graph/component-class-source.h>
#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/graph/self-component-class-filter.h>
#include <babeltrace2/graph/self-component-class-sink.h>
#include <babeltrace2/graph/self-component-class-source.h>

/* Component API */
#include <babeltrace2/graph/component-const.h>
#include <babeltrace2/graph/component-filter-const.h>
#include <babeltrace2/graph/component-sink-const.h>
#include <babeltrace2/graph/component-source-const.h>
#include <babeltrace2/graph/self-component-filter.h>
#include <babeltrace2/graph/self-component-port-input.h>
#include <babeltrace2/graph/self-component-port-output.h>
#include <babeltrace2/graph/self-component-port.h>
#include <babeltrace2/graph/self-component-sink.h>
#include <babeltrace2/graph/self-component-source.h>
#include <babeltrace2/graph/self-component.h>

/* Message iterator API */
#include <babeltrace2/graph/message-iterator.h>
#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
#include <babeltrace2/graph/self-message-iterator.h>

/* Message API */
#include <babeltrace2/graph/message-const.h>
#include <babeltrace2/graph/message-discarded-events-const.h>
#include <babeltrace2/graph/message-discarded-events.h>
#include <babeltrace2/graph/message-discarded-packets-const.h>
#include <babeltrace2/graph/message-discarded-packets.h>
#include <babeltrace2/graph/message-event-const.h>
#include <babeltrace2/graph/message-event.h>
#include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
#include <babeltrace2/graph/message-message-iterator-inactivity.h>
#include <babeltrace2/graph/message-packet-beginning-const.h>
#include <babeltrace2/graph/message-packet-beginning.h>
#include <babeltrace2/graph/message-packet-end-const.h>
#include <babeltrace2/graph/message-packet-end.h>
#include <babeltrace2/graph/message-stream-beginning-const.h>
#include <babeltrace2/graph/message-stream-beginning.h>
#include <babeltrace2/graph/message-stream-const.h>
#include <babeltrace2/graph/message-stream-end-const.h>
#include <babeltrace2/graph/message-stream-end.h>

/* Graph API */
#include <babeltrace2/graph/component-descriptor-set-const.h>
#include <babeltrace2/graph/component-descriptor-set.h>
#include <babeltrace2/graph/connection-const.h>
#include <babeltrace2/graph/graph-const.h>
#include <babeltrace2/graph/graph.h>
#include <babeltrace2/graph/interrupter-const.h>
#include <babeltrace2/graph/interrupter.h>
#include <babeltrace2/graph/mip.h>
#include <babeltrace2/graph/port-const.h>
#include <babeltrace2/graph/port-input-const.h>
#include <babeltrace2/graph/port-output-const.h>

/* Query executor API */
#include <babeltrace2/graph/private-query-executor.h>
#include <babeltrace2/graph/query-executor-const.h>
#include <babeltrace2/graph/query-executor.h>

/* Plugin API */
#include <babeltrace2/plugin/plugin-const.h>
#include <babeltrace2/plugin/plugin-set-const.h>

/* Plugin development */
#include <babeltrace2/plugin/plugin-dev.h>

/* Cancel private definitions */
#undef __BT_FUNC_STATUS_AGAIN
#undef __BT_FUNC_STATUS_END
#undef __BT_FUNC_STATUS_ERROR
#undef __BT_FUNC_STATUS_INTERRUPTED
#undef __BT_FUNC_STATUS_UNKNOWN_OBJECT
#undef __BT_FUNC_STATUS_MEMORY_ERROR
#undef __BT_FUNC_STATUS_NOT_FOUND
#undef __BT_FUNC_STATUS_OK
#undef __BT_FUNC_STATUS_OVERFLOW_ERROR
#undef __BT_IN_BABELTRACE_H
#undef __BT_UPCAST
#undef __BT_UPCAST_CONST

#endif /* BABELTRACE2_BABELTRACE_H */
Commit	Line	Data
924dc299 PP	1	#ifndef BABELTRACE2_BABELTRACE_H
924dc299 PP	2	#define BABELTRACE2_BABELTRACE_H
3fadfbc0 MJ	3
3fadfbc0 MJ	4	/*
bbb7b5f0	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
3fadfbc0 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
4fa90f32 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
06b2c294	35	/* Internal: needed by some of the following included headers */
4fa90f32 PP	36	#include <babeltrace2/func-status.h>
4fa90f32 PP	37
06b2c294 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
3fadfbc0	47	/* Core API */
553c4bab PP	48	#include <babeltrace2/current-thread.h>
	49	#include <babeltrace2/error-cause-const.h>
	50	#include <babeltrace2/error-const.h>
fb91c0ef PP	51	#include <babeltrace2/integer-range-set-const.h>
fb91c0ef PP	52	#include <babeltrace2/integer-range-set.h>
3fadfbc0 MJ	53	#include <babeltrace2/logging.h>
	54	#include <babeltrace2/property.h>
	55	#include <babeltrace2/types.h>
	56	#include <babeltrace2/util.h>
	57	#include <babeltrace2/value-const.h>
	58	#include <babeltrace2/value.h>
	59	#include <babeltrace2/version.h>
	60
3fadfbc0 MJ	61	/* Trace IR API */
	62	#include <babeltrace2/trace-ir/clock-class-const.h>
	63	#include <babeltrace2/trace-ir/clock-class.h>
	64	#include <babeltrace2/trace-ir/clock-snapshot-const.h>
	65	#include <babeltrace2/trace-ir/event-class-const.h>
	66	#include <babeltrace2/trace-ir/event-class.h>
	67	#include <babeltrace2/trace-ir/event-const.h>
	68	#include <babeltrace2/trace-ir/event.h>
	69	#include <babeltrace2/trace-ir/field-class-const.h>
	70	#include <babeltrace2/trace-ir/field-class.h>
	71	#include <babeltrace2/trace-ir/field-const.h>
	72	#include <babeltrace2/trace-ir/field-path-const.h>
	73	#include <babeltrace2/trace-ir/field.h>
	74	#include <babeltrace2/trace-ir/packet-const.h>
	75	#include <babeltrace2/trace-ir/packet-context-field.h>
	76	#include <babeltrace2/trace-ir/packet.h>
	77	#include <babeltrace2/trace-ir/stream-class-const.h>
	78	#include <babeltrace2/trace-ir/stream-class.h>
	79	#include <babeltrace2/trace-ir/stream-const.h>
	80	#include <babeltrace2/trace-ir/stream.h>
	81	#include <babeltrace2/trace-ir/trace-class-const.h>
	82	#include <babeltrace2/trace-ir/trace-class.h>
	83	#include <babeltrace2/trace-ir/trace-const.h>
	84	#include <babeltrace2/trace-ir/trace.h>
	85
4fa90f32	86	/* Component class API */
3fadfbc0 MJ	87	#include <babeltrace2/graph/component-class-const.h>
	88	#include <babeltrace2/graph/component-class-filter-const.h>
	89	#include <babeltrace2/graph/component-class-filter.h>
	90	#include <babeltrace2/graph/component-class-sink-const.h>
	91	#include <babeltrace2/graph/component-class-sink.h>
	92	#include <babeltrace2/graph/component-class-source-const.h>
	93	#include <babeltrace2/graph/component-class-source.h>
	94	#include <babeltrace2/graph/component-class.h>
4fa90f32 PP	95	#include <babeltrace2/graph/self-component-class-filter.h>
	96	#include <babeltrace2/graph/self-component-class-sink.h>
	97	#include <babeltrace2/graph/self-component-class-source.h>
	98
	99	/* Component API */
3fadfbc0 MJ	100	#include <babeltrace2/graph/component-const.h>
	101	#include <babeltrace2/graph/component-filter-const.h>
	102	#include <babeltrace2/graph/component-sink-const.h>
	103	#include <babeltrace2/graph/component-source-const.h>
4fa90f32 PP	104	#include <babeltrace2/graph/self-component-filter.h>
	105	#include <babeltrace2/graph/self-component-port-input.h>
	106	#include <babeltrace2/graph/self-component-port-output.h>
	107	#include <babeltrace2/graph/self-component-port.h>
	108	#include <babeltrace2/graph/self-component-sink.h>
	109	#include <babeltrace2/graph/self-component-source.h>
	110	#include <babeltrace2/graph/self-component.h>
	111
	112	/* Message iterator API */
	113	#include <babeltrace2/graph/message-iterator.h>
4fa90f32 PP	114	#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
	115	#include <babeltrace2/graph/self-message-iterator.h>
	116
	117	/* Message API */
3fadfbc0 MJ	118	#include <babeltrace2/graph/message-const.h>
	119	#include <babeltrace2/graph/message-discarded-events-const.h>
	120	#include <babeltrace2/graph/message-discarded-events.h>
	121	#include <babeltrace2/graph/message-discarded-packets-const.h>
	122	#include <babeltrace2/graph/message-discarded-packets.h>
	123	#include <babeltrace2/graph/message-event-const.h>
	124	#include <babeltrace2/graph/message-event.h>
3fadfbc0 MJ	125	#include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
	126	#include <babeltrace2/graph/message-message-iterator-inactivity.h>
	127	#include <babeltrace2/graph/message-packet-beginning-const.h>
	128	#include <babeltrace2/graph/message-packet-beginning.h>
	129	#include <babeltrace2/graph/message-packet-end-const.h>
	130	#include <babeltrace2/graph/message-packet-end.h>
3fadfbc0 MJ	131	#include <babeltrace2/graph/message-stream-beginning-const.h>
3fadfbc0 MJ	132	#include <babeltrace2/graph/message-stream-beginning.h>
188edac1	133	#include <babeltrace2/graph/message-stream-const.h>
3fadfbc0 MJ	134	#include <babeltrace2/graph/message-stream-end-const.h>
3fadfbc0 MJ	135	#include <babeltrace2/graph/message-stream-end.h>
4fa90f32 PP	136
4fa90f32 PP	137	/* Graph API */
55f09f52 PP	138	#include <babeltrace2/graph/component-descriptor-set-const.h>
55f09f52 PP	139	#include <babeltrace2/graph/component-descriptor-set.h>
4fa90f32 PP	140	#include <babeltrace2/graph/connection-const.h>
	141	#include <babeltrace2/graph/graph-const.h>
	142	#include <babeltrace2/graph/graph.h>
b70d57a1 PP	143	#include <babeltrace2/graph/interrupter-const.h>
b70d57a1 PP	144	#include <babeltrace2/graph/interrupter.h>
00c988c9	145	#include <babeltrace2/graph/mip.h>
3fadfbc0 MJ	146	#include <babeltrace2/graph/port-const.h>
	147	#include <babeltrace2/graph/port-input-const.h>
	148	#include <babeltrace2/graph/port-output-const.h>
4fa90f32 PP	149
4fa90f32 PP	150	/* Query executor API */
3c729b9a	151	#include <babeltrace2/graph/private-query-executor.h>
3fadfbc0 MJ	152	#include <babeltrace2/graph/query-executor-const.h>
3fadfbc0 MJ	153	#include <babeltrace2/graph/query-executor.h>
4fa90f32 PP	154
	155	/* Plugin API */
	156	#include <babeltrace2/plugin/plugin-const.h>
	157	#include <babeltrace2/plugin/plugin-set-const.h>
	158
	159	/* Plugin development */
	160	#include <babeltrace2/plugin/plugin-dev.h>
	161
	162	/* Cancel private definitions */
9b4f9b42 PP	163	#undef __BT_FUNC_STATUS_AGAIN
9b4f9b42 PP	164	#undef __BT_FUNC_STATUS_END
9b4f9b42 PP	165	#undef __BT_FUNC_STATUS_ERROR
9b4f9b42 PP	166	#undef __BT_FUNC_STATUS_INTERRUPTED
76b6c2f7	167	#undef __BT_FUNC_STATUS_UNKNOWN_OBJECT
4fa90f32	168	#undef __BT_FUNC_STATUS_MEMORY_ERROR
4fa90f32	169	#undef __BT_FUNC_STATUS_NOT_FOUND
9b4f9b42	170	#undef __BT_FUNC_STATUS_OK
520cdc82	171	#undef __BT_FUNC_STATUS_OVERFLOW_ERROR
4fa90f32	172	#undef __BT_IN_BABELTRACE_H
06b2c294 PP	173	#undef __BT_UPCAST
06b2c294 PP	174	#undef __BT_UPCAST_CONST
3fadfbc0	175
924dc299	176	#endif /* BABELTRACE2_BABELTRACE_H */