[babeltrace.git] / include / babeltrace / iterator-internal.h

#ifndef _BABELTRACE_ITERATOR_INTERNAL_H
#define _BABELTRACE_ITERATOR_INTERNAL_H

/*
 * BabelTrace
 *
 * Internal iterator header
 *
 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * 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.
 */

/*
 * struct bt_iter: data structure representing an iterator on a trace
 * collection.
 */
struct bt_iter {
	struct ptr_heap *stream_heap;
	struct bt_context *ctx;
	struct bt_iter_pos *end_pos;
	GArray *callbacks;				/* Array of struct bt_stream_callbacks */
	struct bt_callback_chain main_callbacks;	/* For all events */
	/*
	 * Flag indicating if dependency graph needs to be recalculated.
	 * Set by bt_iter_add_callback(), and checked (and
	 * cleared) by upon entry into bt_iter_read_event().
	 * bt_iter_read_event() is responsible for calling dep
	 * graph calculation if it sees this flag set.
	 */
	int recalculate_dep_graph;
	/*
	 * Array of pointers to struct bt_dependencies, for garbage
	 * collection. We're not using a linked list here because each
	 * struct bt_dependencies can belong to more than one
	 * bt_iter.
	 */
	GPtrArray *dep_gc;
};

#endif /* _BABELTRACE_ITERATOR_INTERNAL_H */
Commit	Line	Data
6f3077a2 JD	1	#ifndef _BABELTRACE_ITERATOR_INTERNAL_H
	2	#define _BABELTRACE_ITERATOR_INTERNAL_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* Internal iterator header
	8	*
	9	* Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
	10	*
	11	* Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	12	*
	13	* Permission is hereby granted, free of charge, to any person obtaining a copy
	14	* of this software and associated documentation files (the "Software"), to deal
	15	* in the Software without restriction, including without limitation the rights
	16	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	17	* copies of the Software, and to permit persons to whom the Software is
	18	* furnished to do so, subject to the following conditions:
	19	*
	20	* The above copyright notice and this permission notice shall be included in
	21	* all copies or substantial portions of the Software.
	22	*/
	23
	24	/*
e8c92a62	25	* struct bt_iter: data structure representing an iterator on a trace
6f3077a2 JD	26	* collection.
6f3077a2 JD	27	*/
e8c92a62	28	struct bt_iter {
6f3077a2	29	struct ptr_heap *stream_heap;
95d36295	30	struct bt_context *ctx;
e8c92a62	31	struct bt_iter_pos *end_pos;
6f3077a2 JD	32	GArray callbacks; / Array of struct bt_stream_callbacks */
	33	struct bt_callback_chain main_callbacks; /* For all events */
	34	/*
	35	* Flag indicating if dependency graph needs to be recalculated.
e8c92a62 JD	36	* Set by bt_iter_add_callback(), and checked (and
	37	* cleared) by upon entry into bt_iter_read_event().
	38	* bt_iter_read_event() is responsible for calling dep
6f3077a2 JD	39	* graph calculation if it sees this flag set.
	40	*/
	41	int recalculate_dep_graph;
	42	/*
	43	* Array of pointers to struct bt_dependencies, for garbage
	44	* collection. We're not using a linked list here because each
	45	* struct bt_dependencies can belong to more than one
e8c92a62	46	* bt_iter.
6f3077a2 JD	47	*/
	48	GPtrArray *dep_gc;
	49	};
	50
	51	#endif /* _BABELTRACE_ITERATOR_INTERNAL_H */