Python bindings docs: clarify add_event_class comments
[babeltrace.git] / bindings / python / python-complements.h
... / ...
CommitLineData
1/*
2 * python-complements.h
3 *
4 * Babeltrace Python module complements header, required for Python bindings
5 *
6 * Copyright 2012 EfficiOS Inc.
7 *
8 * Author: Danny Serres <danny.serres@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 */
20
21#include <stdio.h>
22#include <glib.h>
23#include <babeltrace/babeltrace.h>
24#include <babeltrace/format.h>
25#include <babeltrace/ctf-ir/metadata.h>
26#include <babeltrace/ctf/events.h>
27#include <babeltrace/iterator-internal.h>
28#include <babeltrace/ctf/events-internal.h>
29#include <babeltrace/ctf-writer/event-fields.h>
30#include <babeltrace/ctf-writer/clock.h>
31
32/* ctf-field-list */
33struct bt_definition **_bt_python_field_listcaller(
34 const struct bt_ctf_event *ctf_event,
35 const struct bt_definition *scope,
36 unsigned int *len);
37struct bt_definition *_bt_python_field_one_from_list(
38 struct bt_definition **list, int index);
39
40/* event_decl_list */
41struct bt_ctf_event_decl **_bt_python_event_decl_listcaller(
42 int handle_id,
43 struct bt_context *ctx,
44 unsigned int *len);
45struct bt_ctf_event_decl *_bt_python_decl_one_from_list(
46 struct bt_ctf_event_decl **list, int index);
47
48/* decl_fields */
49struct bt_ctf_field_decl **_by_python_field_decl_listcaller(
50 struct bt_ctf_event_decl *event_decl,
51 enum bt_ctf_scope scope,
52 unsigned int *len);
53struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list(
54 struct bt_ctf_field_decl **list, int index);
55
56/* definitions */
57struct definition_array *_bt_python_get_array_from_def(
58 struct bt_definition *field);
59struct definition_sequence *_bt_python_get_sequence_from_def(
60 struct bt_definition *field);
61struct bt_declaration *_bt_python_get_array_element_declaration(
62 struct bt_declaration *field);
63struct bt_declaration *_bt_python_get_sequence_element_declaration(
64 struct bt_declaration *field);
65const char *_bt_python_get_array_string(struct bt_definition *field);
66const char *_bt_python_get_sequence_string(struct bt_definition *field);
67
68/* ctf ir */
69int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field);
70enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field);
71const char *_bt_python_ctf_field_type_enumeration_get_mapping(
72 struct bt_ctf_field_type *enumeration, size_t index,
73 int64_t *range_start, int64_t *range_end);
74const char *_bt_python_ctf_field_type_enumeration_get_mapping_unsigned(
75 struct bt_ctf_field_type *enumeration, size_t index,
76 uint64_t *range_start, uint64_t *range_end);
77const char *_bt_python_ctf_field_type_structure_get_field_name(
78 struct bt_ctf_field_type *structure, size_t index);
79struct bt_ctf_field_type *_bt_python_ctf_field_type_structure_get_field_type(
80 struct bt_ctf_field_type *structure, size_t index);
81const char *_bt_python_ctf_field_type_variant_get_field_name(
82 struct bt_ctf_field_type *variant, size_t index);
83struct bt_ctf_field_type *_bt_python_ctf_field_type_variant_get_field_type(
84 struct bt_ctf_field_type *variant, size_t index);
85const char *_bt_python_ctf_event_class_get_field_name(
86 struct bt_ctf_event_class *event_class, size_t index);
87struct bt_ctf_field_type *_bt_python_ctf_event_class_get_field_type(
88 struct bt_ctf_event_class *event_class, size_t index);
89int _bt_python_ctf_clock_get_uuid_index(struct bt_ctf_clock *clock,
90 size_t index, unsigned char *value);
91int _bt_python_ctf_clock_set_uuid_index(struct bt_ctf_clock *clock,
92 size_t index, unsigned char value);
This page took 0.023154 seconds and 4 git commands to generate.