bindings/python/bt2/bt2/packet.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2016-2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object, utils
  24 import bt2.fields
  25 import bt2.stream
  26 import copy
  27 import abc
  28 import bt2
  29
  30
  31 class _Packet(object._Object):
  32     @property
  33     def stream(self):
  34         stream_ptr = native_bt.ctf_packet_get_stream(self._ptr)
  35         assert(stream_ptr)
  36         return bt2.stream._Stream._create_from_ptr(stream_ptr)
  37
  38     @property
  39     def header_field(self):
  40         field_ptr = native_bt.ctf_packet_get_header(self._ptr)
  41
  42         if field_ptr is None:
  43             return
  44
  45         return bt2.fields._create_from_ptr(field_ptr)
  46
  47     @header_field.setter
  48     def header_field(self, header_field):
  49         header_field_ptr = None
  50
  51         if header_field is not None:
  52             utils._check_type(header_field, bt2.fields._Field)
  53             header_field_ptr = header_field._ptr
  54
  55         ret = native_bt.ctf_packet_set_header(self._ptr, header_field_ptr)
  56         utils._handle_ret(ret, "cannot set packet object's header field")
  57
  58     @property
  59     def context_field(self):
  60         field_ptr = native_bt.ctf_packet_get_context(self._ptr)
  61
  62         if field_ptr is None:
  63             return
  64
  65         return bt2.fields._create_from_ptr(field_ptr)
  66
  67     @context_field.setter
  68     def context_field(self, context_field):
  69         context_field_ptr = None
  70
  71         if context_field is not None:
  72             utils._check_type(context_field, bt2.fields._Field)
  73             context_field_ptr = context_field._ptr
  74
  75         ret = native_bt.ctf_packet_set_context(self._ptr, context_field_ptr)
  76         utils._handle_ret(ret, "cannot set packet object's context field")
  77
  78     def __eq__(self, other):
  79         if type(other) is not type(self):
  80             return False
  81
  82         if self.addr == other.addr:
  83             return True
  84
  85         self_props = (
  86             self.header_field,
  87             self.context_field,
  88         )
  89         other_props = (
  90             other.header_field,
  91             other.context_field,
  92         )
  93         return self_props == other_props
  94
  95     def _copy(self, copy_func):
  96         cpy = self.stream.create_packet()
  97         cpy.header_field = copy_func(self.header_field)
  98         cpy.context_field = copy_func(self.context_field)
  99         return cpy
 100
 101     def __copy__(self):
 102         return self._copy(copy.copy)
 103
 104     def __deepcopy__(self, memo):
 105         cpy = self._copy(copy.deepcopy)
 106         memo[id(self)] = cpy
 107         return cpy