lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / trace-ir / trace-class.h
CommitLineData
862ca4ed
PP
1#ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_H
2#define BABELTRACE_TRACE_IR_TRACE_CLASS_H
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
862ca4ed
PP
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
862ca4ed
PP
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 *
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
28 */
29
d24d5663
PP
30#include <stdint.h>
31
41693723
PP
32/*
33 * For bt_bool, bt_uuid, bt_trace_class, bt_stream_class,
34 * bt_field_class, bt_self_component
35 */
3fadfbc0 36#include <babeltrace2/types.h>
862ca4ed 37
d24d5663
PP
38/* For __BT_FUNC_STATUS_* */
39#define __BT_FUNC_STATUS_ENABLE
40#include <babeltrace2/func-status.h>
41#undef __BT_FUNC_STATUS_ENABLE
862ca4ed
PP
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
41693723 47extern bt_trace_class *bt_trace_class_create(bt_self_component *self_comp);
862ca4ed
PP
48
49extern void bt_trace_class_set_assigns_automatic_stream_class_id(
b19ff26f 50 bt_trace_class *trace_class, bt_bool value);
862ca4ed 51
d24d5663
PP
52typedef enum bt_trace_class_set_name_status {
53 BT_TRACE_CLASS_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
54 BT_TRACE_CLASS_SET_NAME_STATUS_OK = __BT_FUNC_STATUS_OK,
55} bt_trace_class_set_name_status;
56
57extern bt_trace_class_set_name_status bt_trace_class_set_name(
a1ed915c 58 bt_trace_class *trace_class, const char *name);
862ca4ed 59
b19ff26f 60extern void bt_trace_class_set_uuid(bt_trace_class *trace_class,
862ca4ed
PP
61 bt_uuid uuid);
62
d24d5663
PP
63typedef enum bt_trace_class_set_environment_entry_status {
64 BT_TRACE_CLASS_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
65 BT_TRACE_CLASS_SET_ENVIRONMENT_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK,
66} bt_trace_class_set_environment_entry_status;
67
68extern bt_trace_class_set_environment_entry_status
69bt_trace_class_set_environment_entry_integer(
b19ff26f 70 bt_trace_class *trace_class,
862ca4ed
PP
71 const char *name, int64_t value);
72
d24d5663
PP
73extern bt_trace_class_set_environment_entry_status
74bt_trace_class_set_environment_entry_string(
b19ff26f 75 bt_trace_class *trace_class,
862ca4ed
PP
76 const char *name, const char *value);
77
b19ff26f
PP
78extern bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
79 bt_trace_class *trace_class, uint64_t index);
862ca4ed 80
b19ff26f
PP
81extern bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
82 bt_trace_class *trace_class, uint64_t id);
862ca4ed
PP
83
84#ifdef __cplusplus
85}
86#endif
87
d24d5663
PP
88#include <babeltrace2/undef-func-status.h>
89
862ca4ed 90#endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_H */
This page took 0.033699 seconds and 4 git commands to generate.