Rename the ctf class to CTFReader
[babeltrace.git] / bindings / python / babeltrace.i.in
index 4b3439f2a726a3df835746214f80a0d84011fd4c..620264879ce325cf970f7e2bf4b96098fdaaf894 100644 (file)
@@ -54,6 +54,36 @@ typedef unsigned long long uint64_t;
 typedef long long int64_t;
 typedef int bt_intern_str;
 
+/* =================================================================
+               PYTHON-COMPLEMENTS.H
+               ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
+*/
+
+FILE *_bt_file_open(char *file_path, char *mode);
+void _bt_file_close(FILE *fp);
+struct bt_definition **_bt_python_field_listcaller(
+               const struct bt_ctf_event *ctf_event,
+               const struct bt_definition *scope,
+               unsigned int *OUTPUT);
+struct bt_definition *_bt_python_field_one_from_list(
+               struct bt_definition **list, int index);
+struct bt_ctf_event_decl **_bt_python_event_decl_listcaller(
+               int handle_id,
+               struct bt_context *ctx,
+               unsigned int *OUTPUT);
+struct bt_ctf_event_decl *_bt_python_decl_one_from_list(
+               struct bt_ctf_event_decl **list, int index);
+struct bt_ctf_field_decl **_by_python_field_decl_listcaller(
+               struct bt_ctf_event_decl *event_decl,
+               enum bt_ctf_scope scope,
+               unsigned int *OUTPUT);
+struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list(
+               struct bt_ctf_field_decl **list, int index);
+struct definition_array *_bt_python_get_array_from_def(
+               struct bt_definition *field);
+struct definition_sequence *_bt_python_get_sequence_from_def(
+               struct bt_definition *field);
+
 /* =================================================================
                CONTEXT.H, CONTEXT-INTERNAL.H
                ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
@@ -568,6 +598,8 @@ struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
 %rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field);
 %rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field);
 %rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field);
+%rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field);
+%rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field);
 %rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void);
 %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
                bt_ctf_event_decl *event);
@@ -578,6 +610,8 @@ struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
 %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
 %rename("_bt_sequence_len")  bt_sequence_len(struct definition_sequence *sequence);
 %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
+%rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure);
+%rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
 
 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
                enum bt_ctf_scope scope);
@@ -605,33 +639,51 @@ uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
 int64_t bt_ctf_get_int64(const struct bt_definition *field);
 char *bt_ctf_get_char_array(const struct bt_definition *field);
 char *bt_ctf_get_string(const struct bt_definition *field);
+double bt_ctf_get_float(const struct bt_definition *field);
+const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
 int bt_ctf_field_get_error(void);
 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
 uint64_t bt_sequence_len(struct definition_sequence *sequence);
 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
+uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure);
+const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
 
 %pythoncode%{
 
-class ctf:
-
-       #enum equivalent, accessible constants
-       #These are taken directly from ctf/events.h
-       #All changes to enums must also be made here
-       class type_id:
-               UNKNOWN = 0
-               INTEGER = 1
-               FLOAT = 2
-               ENUM = 3
-               STRING = 4
-               STRUCT = 5
-               UNTAGGED_VARIANT = 6
-               VARIANT = 7
-               ARRAY = 8
-               SEQUENCE = 9
-               NR_CTF_TYPES = 10
+class CTFStringEncoding:
+       NONE = 0
+       UTF8 = 1
+       ASCII = 2
+       UNKNOWN = 3
+
+#enum equivalent, accessible constants
+#These are taken directly from ctf/events.h
+#All changes to enums must also be made here
+class CTFTypeId:
+       UNKNOWN = 0
+       INTEGER = 1
+       FLOAT = 2
+       ENUM = 3
+       STRING = 4
+       STRUCT = 5
+       UNTAGGED_VARIANT = 6
+       VARIANT = 7
+       ARRAY = 8
+       SEQUENCE = 9
+       NR_CTF_TYPES = 10
+
+       def get_type_name(id):
+               name = "UNKNOWN"
+               constants = [attr for attr in dir(CTFTypeId) if not callable(getattr(CTFTypeId, attr)) and not attr.startswith("__")]
+               for attr in constants:
+                       if getattr(CTFTypeId, attr) == id:
+                               name = attr
+                               break
+               return name
 
+class CTFReader:
        class scope:
                TRACE_PACKET_HEADER = 0
                STREAM_PACKET_CONTEXT = 1
@@ -667,7 +719,7 @@ class ctf:
 
                def __new__(cls, context, begin_pos = None, end_pos = None):
                        # __new__ is used to control the return value
-                       # as the ctf.Iterator class should return None
+                       # as the CTFReader.Iterator class should return None
                        # if bt_ctf_iter_create returns NULL
 
                        if begin_pos is None:
@@ -686,7 +738,7 @@ class ctf:
                        if it is None:
                                return None
 
-                       ret_class = super(ctf.Iterator, cls).__new__(cls)
+                       ret_class = super(CTFReader.Iterator, cls).__new__(cls)
                        ret_class._i = it
                        return ret_class
 
@@ -705,7 +757,7 @@ class ctf:
                        ret = _bt_ctf_iter_read_event(self._i)
                        if ret is None:
                                return ret
-                       ev = ctf.Event.__new__(ctf.Event)
+                       ev = CTFReader.Event.__new__(CTFReader.Event)
                        ev._e = ret
                        return ev
 
@@ -713,24 +765,24 @@ class ctf:
        class Event(object):
                """
                This class represents an event from the trace.
-               It is obtained with read_event() from ctf.Iterator.
+               It is obtained with read_event() from CTFReader.Iterator.
                Do not instantiate.
                """
 
                def __init__(self):
-                       raise NotImplementedError("ctf.Event cannot be instantiated")
+                       raise NotImplementedError("CTFReader.Event cannot be instantiated")
 
                def get_top_level_scope(self, scope):
                        """
                        Return a definition of the top-level scope
-                       Top-level scopes are defined in ctf.scope.
+                       Top-level scopes are defined in CTFReader.scope.
                        In order to get a field or a field list, the user needs to pass a
                        scope as argument, this scope can be a top-level scope or a scope
                        relative to an arbitrary field. This function provides the mapping
                        between the scope and the actual definition of top-level scopes.
                        On error return None.
                        """
-                       evDef = ctf.Definition.__new__(ctf.Definition)
+                       evDef = CTFReader.Definition.__new__(CTFReader.Definition)
                        evDef._d = _bt_ctf_get_top_level_scope(self._e, scope)
                        if evDef._d is None:
                                return None
@@ -759,7 +811,7 @@ class ctf:
                        Return the definition of a specific field.
                        Return None on error.
                        """
-                       evDef = ctf.Definition.__new__(ctf.Definition)
+                       evDef = CTFReader.Definition.__new__(CTFReader.Definition)
                        try:
                                evDef._d = _bt_ctf_get_field(self._e, scope._d, field)
                        except AttributeError:
@@ -775,8 +827,8 @@ class ctf:
                        Return the definition of fields by a name
                        Return None on error
                        """
-                       eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
-                       streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
+                       eventScope = self.get_top_level_scope(CTFReader.scope.EVENT_FIELDS)
+                       streamScope = self.get_top_level_scope(CTFReader.scope.STREAM_EVENT_CONTEXT)
                        fields_by_name = []
 
                        if eventScope is not None:
@@ -799,7 +851,7 @@ class ctf:
                        Return None on error.
                        """
                        try:
-                               field_lc = _bt_python_field_listcaller(self._e, scope._d)
+                               field_lc, count = _bt_python_field_listcaller(self._e, scope._d)
                        except AttributeError:
                                raise TypeError("in get_field_list, argument 2 must be a "
                                        "Definition (scope) instance")
@@ -808,25 +860,18 @@ class ctf:
                                return None
 
                        def_list = []
-                       i = 0
-                       while True:
-                               tmp = ctf.Definition.__new__(ctf.Definition)
+                       for i in range(count):
+                               tmp = CTFReader.Definition.__new__(CTFReader.Definition)
                                tmp._d = _bt_python_field_one_from_list(field_lc, i)
-
-                               if tmp._d is None:
-                                       #Last item of list is None, assured in
-                                       #_bt_python_field_listcaller
-                                       break
-
                                tmp._s = scope
                                def_list.append(tmp)
-                               i += 1
+
                        return def_list
 
                def get_field_list(self):
                        """Return a list of Definitions or None on error."""
-                       eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
-                       streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
+                       eventScope = self.get_top_level_scope(CTFReader.scope.EVENT_FIELDS)
+                       streamScope = self.get_top_level_scope(CTFReader.scope.STREAM_EVENT_CONTEXT)
 
                        def_list = []
                        if eventScope is not None:
@@ -848,7 +893,7 @@ class ctf:
                        If the field is an array or a sequence, return the element
                        at position index, otherwise return None
                        """
-                       evDef = ctf.Definition.__new__(ctf.Definition)
+                       evDef = CTFReader.Definition.__new__(CTFReader.Definition)
                        try:
                                evDef._d = _bt_ctf_get_index(self._e, field._d, index)
                        except AttributeError:
@@ -884,12 +929,18 @@ class ctf:
                        else:
                                return ctx
 
+       class FieldError(Exception):
+               def __init__(self, value):
+                       self.value = value
+
+               def __str__(self):
+                       return repr(self.value)
 
        class Definition(object):
                """Definition class.  Do not instantiate."""
 
                def __init__(self):
-                       raise NotImplementedError("ctf.Definition cannot be instantiated")
+                       raise NotImplementedError("CTFReader.Definition cannot be instantiated")
 
                def __repr__(self):
                        return "Babeltrace Definition: name('{0}'), type({1})".format(
@@ -958,7 +1009,7 @@ class ctf:
                        if array is None:
                                return None
 
-                       element = ctf.Definition.__new__(ctf.Definition)
+                       element = CTFReader.Definition.__new__(CTFReader.Definition)
                        element._d =  _bt_array_index(array, index)
                        if element._d is None:
                                return None
@@ -979,7 +1030,7 @@ class ctf:
                        """
                        seq = _bt_python_get_sequence_from_def(self._d)
                        if seq is not None:
-                               element = ctf.Definition.__new__(ctf.Definition)
+                               element = CTFReader.Definition.__new__(CTFReader.Definition)
                                element._d = _bt_sequence_index(seq, index)
                                if element._d is not None:
                                        return element
@@ -990,7 +1041,7 @@ class ctf:
                        Return the value associated with the field.
                        If the field does not exist or is not of the type requested,
                        the value returned is undefined. To check if an error occured,
-                       use the ctf.field_error() function after accessing a field.
+                       use the CTFReader.field_error() function after accessing a field.
                        """
                        return _bt_ctf_get_uint64(self._d)
 
@@ -999,7 +1050,7 @@ class ctf:
                        Return the value associated with the field.
                        If the field does not exist or is not of the type requested,
                        the value returned is undefined. To check if an error occured,
-                       use the ctf.field_error() function after accessing a field.
+                       use the CTFReader.field_error() function after accessing a field.
                        """
                        return _bt_ctf_get_int64(self._d)
 
@@ -1008,7 +1059,7 @@ class ctf:
                        Return the value associated with the field.
                        If the field does not exist or is not of the type requested,
                        the value returned is undefined. To check if an error occured,
-                       use the ctf.field_error() function after accessing a field.
+                       use the CTFReader.field_error() function after accessing a field.
                        """
                        return _bt_ctf_get_char_array(self._d)
 
@@ -1017,39 +1068,88 @@ class ctf:
                        Return the value associated with the field.
                        If the field does not exist or is not of the type requested,
                        the value returned is undefined. To check if an error occured,
-                       use the ctf.field_error() function after accessing a field.
+                       use the CTFReader.field_error() function after accessing a field.
                        """
                        return _bt_ctf_get_string(self._d)
 
+               def get_float(self):
+                       """
+                       Return the value associated with the field.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the CTFReader.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_float(self._d)
+
+               def get_variant(self):
+                       """
+                       Return the variant's selected field.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the CTFReader.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_variant(self._d)
+
+               def get_struct_field_count(self):
+                       """
+                       Return the number of fields contained in the structure.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined.
+                       """
+                       return _bt_ctf_get_struct_field_count(self._d)
+
+               def get_struct_field_at(self, i):
+                       """
+                       Return the structure's field at position i.
+                       If the field does not exist or is not of the type requested,
+                       the value returned is undefined. To check if an error occured,
+                       use the CTFReader.field_error() function after accessing a field.
+                       """
+                       return _bt_ctf_get_struct_field_index(self._d, i)
+
                def get_value(self):
                        """
                        Return the value associated with the field according to its type.
                        Return None on error.
                        """
                        id = self.field_type()
-                       if id == ctf.type_id.STRING:
-                               return self.get_str()
-                       if id == ctf.type_id.ARRAY:
-                               array = []
+                       value = None
+                       if id == CTFTypeId.STRING:
+                               value = self.get_str()
+                       elif id == CTFTypeId.ARRAY:
+                               value = []
                                for i in range(self.get_array_len()):
                                        element = self.get_array_element_at(i)
-                                       array.append(element.get_value())
-                               return array
-                       if id == ctf.type_id.INTEGER:
+                                       value.append(element.get_value())
+                       elif id == CTFTypeId.INTEGER:
                                if self.get_int_signedness() == 0:
-                                       return self.get_uint64()
+                                       value = self.get_uint64()
                                else:
-                                       return self.get_int64()
-                       if id == ctf.type_id.ENUM:
-                               return self.get_enum_str()
-                       if id == ctf.type_id.SEQUENCE:
+                                       value = self.get_int64()
+                       elif id == CTFTypeId.ENUM:
+                               value = self.get_enum_str()
+                       elif id == CTFTypeId.SEQUENCE:
                                seq_len = self.get_sequence_len()
-                               values = []
+                               value = []
                                for i in range(seq_len):
                                        evDef = self.get_sequence_element_at(i)
-                                       values.append(evDef.get_value())
-                               return values
-                       return None
+                                       value.append(evDef.get_value())
+                       elif id == CTFTypeId.FLOAT:
+                               value = self.get_float()
+                       elif id == CTFTypeId.VARIANT:
+                               variant = CTFReader.Definition.__new__(CTFReader.Definition)
+                               variant._d = self.get_variant();
+                               value = variant.get_value()
+                       elif id == CTFTypeId.STRUCT:
+                               value = {}
+                               for i in range(self.get_struct_field_count()):
+                                       member = CTFReader.Definition.__new__(CTFReader.Definition)
+                                       member._d = self.get_struct_field_at(i);
+                                       value[member.field_name()] = member.get_value()
+
+                       if CTFReader.field_error():
+                               raise CTFReader.FieldError("Error occured while accessing field {} of type {}".format(self.field_name(), CTFTypeId.get_type_name(self.field_type())))
+                       return value
 
                def get_scope(self):
                        """Return the scope of a field or None on error."""
@@ -1059,7 +1159,7 @@ class ctf:
                """Event declaration class.  Do not instantiate."""
 
                def __init__(self):
-                       raise NotImplementedError("ctf.EventDecl cannot be instantiated")
+                       raise NotImplementedError("CTFReader.EventDecl cannot be instantiated")
 
                def __repr__(self):
                        return "Babeltrace EventDecl: name {0}".format(self.get_name())
@@ -1070,7 +1170,7 @@ class ctf:
 
                def get_decl_fields(self, scope):
                        """
-                       Return a list of ctf.FieldDecl
+                       Return a list of CTFReader.FieldDecl
                        Return None on error.
                        """
                        ptr_list = _by_python_field_decl_listcaller(self._d, scope)
@@ -1081,7 +1181,7 @@ class ctf:
                        decl_list = []
                        i = 0
                        while True:
-                               tmp = ctf.FieldDecl.__new__(ctf.FieldDecl)
+                               tmp = CTFReader.FieldDecl.__new__(CTFReader.FieldDecl)
                                tmp._d =  _bt_python_field_decl_one_from_list(
                                        ptr_list, i)
 
@@ -1098,7 +1198,7 @@ class ctf:
                """Field declaration class.  Do not instantiate."""
 
                def __init__(self):
-                       raise NotImplementedError("ctf.FieldDecl cannot be instantiated")
+                       raise NotImplementedError("CTFReader.FieldDecl cannot be instantiated")
 
                def __repr__(self):
                        return "Babeltrace FieldDecl: name {0}".format(self.get_name())
@@ -1120,7 +1220,7 @@ class ctf:
        @staticmethod
        def get_event_decl_list(trace_handle, context):
                """
-               Return a list of ctf.EventDecl
+               Return a list of CTFReader.EventDecl
                Return None on error.
                """
                try:
@@ -1129,7 +1229,7 @@ class ctf:
                                raise TypeError("in get_event_decl_list, "
                                        "argument 1 must be a TraceHandle instance")
                try:
-                       ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
+                       ptr_list, count = _bt_python_event_decl_listcaller(handle_id, context._c)
                except AttributeError:
                                raise TypeError("in get_event_decl_list, "
                                        "argument 2 must be a Context instance")
@@ -1138,17 +1238,11 @@ class ctf:
                        return None
 
                decl_list = []
-               i = 0
-               while True:
-                       tmp = ctf.EventDecl.__new__(ctf.EventDecl)
+               for i in range(count):
+                       tmp = CTFReader.EventDecl.__new__(CTFReader.EventDecl)
                        tmp._d =  _bt_python_decl_one_from_list(ptr_list, i)
-
-                       if tmp._d is None:
-                               #Last item of list is None
-                               break
-
                        decl_list.append(tmp)
-                       i += 1
+
                return decl_list
 
 %}
@@ -1161,8 +1255,6 @@ class ctf:
 //                        python-complements.h
 // =================================================================
 
-%include python-complements.c
-
 %pythoncode %{
 
 class File(object):
This page took 0.031375 seconds and 4 git commands to generate.