lib: make trace IR API const-correct

[babeltrace.git] / include / babeltrace / trace-ir / stream-class-const.h

diff --git a/include/babeltrace/trace-ir/stream-class-const.h b/include/babeltrace/trace-ir/stream-class-const.h
new file mode 100644 (file)
index 0000000..2b4cb3d
--- /dev/null
+++ b/include/babeltrace/trace-ir/stream-class-const.h
@@ -0,0 +1,108 @@
+#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
+#define BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
+
+/*
+ * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ *
+ * Author: Jérémie Galarneau <jeremie.galarneau@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.
+ *
+ * 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.
+ *
+ * The Common Trace Format (CTF) Specification is available at
+ * http://www.efficios.com/ctf
+ */
+
+#include <stdint.h>
+
+/* For bt_bool */
+#include <babeltrace/types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct bt_trace;
+struct bt_stream_class;
+struct bt_event_class;
+struct bt_clock_class;
+struct bt_event_header_field;
+struct bt_packet_context_field;
+
+extern const struct bt_trace *bt_stream_class_borrow_trace_const(
+               const struct bt_stream_class *stream_class);
+
+extern const char *bt_stream_class_get_name(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_assigns_automatic_stream_id(
+               const struct bt_stream_class *stream_class);
+
+extern uint64_t bt_stream_class_get_id(
+               const struct bt_stream_class *stream_class);
+
+extern const struct bt_field_class *
+bt_stream_class_borrow_packet_context_field_class_const(
+               const struct bt_stream_class *stream_class);
+
+extern const struct bt_field_class *
+bt_stream_class_borrow_event_header_field_class_const(
+               const struct bt_stream_class *stream_class);
+
+extern const struct bt_field_class *
+bt_stream_class_borrow_event_common_context_field_class_const(
+               const struct bt_stream_class *stream_class);
+
+extern uint64_t bt_stream_class_get_event_class_count(
+               const struct bt_stream_class *stream_class);
+
+extern const struct bt_event_class *
+bt_stream_class_borrow_event_class_by_index_const(
+               const struct bt_stream_class *stream_class, uint64_t index);
+
+extern const struct bt_event_class *
+bt_stream_class_borrow_event_class_by_id_const(
+               const struct bt_stream_class *stream_class, uint64_t id);
+
+extern const struct bt_clock_class *
+bt_stream_class_borrow_default_clock_class_const(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_default_clock_is_always_known(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value(
+               const struct bt_stream_class *stream_class);
+
+extern bt_bool bt_stream_class_packets_have_default_end_clock_value(
+               const struct bt_stream_class *stream_class);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */