untar

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _untar as _untar
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57UNTAR_SUCCESSFUL = _untar.UNTAR_SUCCESSFUL
 58
 59UNTAR_FAIL = _untar.UNTAR_FAIL
 60
 61UNTAR_INVALID_CHECKSUM = _untar.UNTAR_INVALID_CHECKSUM
 62
 63UNTAR_INVALID_HEADER = _untar.UNTAR_INVALID_HEADER
 64
 65UNTAR_GZ_INFLATE_FAILED = _untar.UNTAR_GZ_INFLATE_FAILED
 66
 67UNTAR_GZ_INFLATE_END_FAILED = _untar.UNTAR_GZ_INFLATE_END_FAILED
 68
 69
 70def Untar_FromMemory(tar_buf, size):
 71    r"""
 72    Untar_FromMemory(void * tar_buf, size_t size) -> int
 73
 74    Parameters
 75    ----------
 76    tar_buf: void *
 77    size: size_t
 78
 79    """
 80    return _untar.Untar_FromMemory(tar_buf, size)
 81
 82def Untar_FromMemory_Print(tar_buf, size, printer):
 83    r"""
 84    Untar_FromMemory_Print(void * tar_buf, size_t size, rtems_printer const * printer) -> int
 85
 86    Parameters
 87    ----------
 88    tar_buf: void *
 89    size: size_t
 90    printer: rtems_printer const *
 91
 92    """
 93    return _untar.Untar_FromMemory_Print(tar_buf, size, printer)
 94
 95def Untar_FromFile(tar_name):
 96    r"""
 97    Untar_FromFile(char const * tar_name) -> int
 98
 99    Parameters
100    ----------
101    tar_name: char const *
102
103    """
104    return _untar.Untar_FromFile(tar_name)
105
106def Untar_FromFile_Print(tar_name, printer):
107    r"""
108    Untar_FromFile_Print(char const * tar_name, rtems_printer const * printer) -> int
109
110    Parameters
111    ----------
112    tar_name: char const *
113    printer: rtems_printer const *
114
115    """
116    return _untar.Untar_FromFile_Print(tar_name, printer)
117UNTAR_FILE_NAME_SIZE = _untar.UNTAR_FILE_NAME_SIZE
118
119class Untar_HeaderContext(object):
120    r"""Proxy of C Untar_HeaderContext struct."""
121
122    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
123    __repr__ = _swig_repr
124    file_path = property(_untar.Untar_HeaderContext_file_path_get, _untar.Untar_HeaderContext_file_path_set, doc=r"""file_path : p.char""")
125    file_name = property(_untar.Untar_HeaderContext_file_name_get, _untar.Untar_HeaderContext_file_name_set, doc=r"""file_name : p.char""")
126    link_name = property(_untar.Untar_HeaderContext_link_name_get, _untar.Untar_HeaderContext_link_name_set, doc=r"""link_name : a(100).char""")
127    mode = property(_untar.Untar_HeaderContext_mode_get, _untar.Untar_HeaderContext_mode_set, doc=r"""mode : unsigned long""")
128    file_size = property(_untar.Untar_HeaderContext_file_size_get, _untar.Untar_HeaderContext_file_size_set, doc=r"""file_size : unsigned long""")
129    nblocks = property(_untar.Untar_HeaderContext_nblocks_get, _untar.Untar_HeaderContext_nblocks_set, doc=r"""nblocks : unsigned long""")
130    linkflag = property(_untar.Untar_HeaderContext_linkflag_get, _untar.Untar_HeaderContext_linkflag_set, doc=r"""linkflag : unsigned char""")
131    printer = property(_untar.Untar_HeaderContext_printer_get, _untar.Untar_HeaderContext_printer_set, doc=r"""printer : p.q(const).rtems_printer""")
132
133    def __init__(self):
134        r"""__init__(Untar_HeaderContext self) -> Untar_HeaderContext"""
135        _untar.Untar_HeaderContext_swiginit(self, _untar.new_Untar_HeaderContext())
136    __swig_destroy__ = _untar.delete_Untar_HeaderContext
137
138# Register Untar_HeaderContext in _untar:
139_untar.Untar_HeaderContext_swigregister(Untar_HeaderContext)
140class Untar_ChunkContext(object):
141    r"""Proxy of C Untar_ChunkContext struct."""
142
143    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
144    __repr__ = _swig_repr
145    base = property(_untar.Untar_ChunkContext_base_get, _untar.Untar_ChunkContext_base_set, doc=r"""base : Untar_HeaderContext""")
146    buf = property(_untar.Untar_ChunkContext_buf_get, _untar.Untar_ChunkContext_buf_set, doc=r"""File path buffer.""")
147    state = property(_untar.Untar_ChunkContext_state_get, _untar.Untar_ChunkContext_state_set, doc=r"""state : enum $unnamed3$""")
148    header = property(_untar.Untar_ChunkContext_header_get, _untar.Untar_ChunkContext_header_set, doc=r"""Header buffer.""")
149    done_bytes = property(_untar.Untar_ChunkContext_done_bytes_get, _untar.Untar_ChunkContext_done_bytes_set, doc=r"""Number of bytes of overall length are already processed.""")
150    out_fd = property(_untar.Untar_ChunkContext_out_fd_get, _untar.Untar_ChunkContext_out_fd_set, doc=r"""File descriptor of output file.""")
151
152    def __init__(self):
153        r"""__init__(Untar_ChunkContext self) -> Untar_ChunkContext"""
154        _untar.Untar_ChunkContext_swiginit(self, _untar.new_Untar_ChunkContext())
155    __swig_destroy__ = _untar.delete_Untar_ChunkContext
156
157# Register Untar_ChunkContext in _untar:
158_untar.Untar_ChunkContext_swigregister(Untar_ChunkContext)
159UNTAR_CHUNK_HEADER = _untar.UNTAR_CHUNK_HEADER
160
161UNTAR_CHUNK_SKIP = _untar.UNTAR_CHUNK_SKIP
162
163UNTAR_CHUNK_WRITE = _untar.UNTAR_CHUNK_WRITE
164
165UNTAR_CHUNK_ERROR = _untar.UNTAR_CHUNK_ERROR
166
167
168class Untar_GzChunkContext(object):
169    r"""Proxy of C Untar_GzChunkContext struct."""
170
171    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
172    __repr__ = _swig_repr
173    base = property(_untar.Untar_GzChunkContext_base_get, _untar.Untar_GzChunkContext_base_set, doc=r"""Instance of Chunk Context needed for tar decompression.""")
174    strm = property(_untar.Untar_GzChunkContext_strm_get, _untar.Untar_GzChunkContext_strm_set, doc=r"""Current zlib context.""")
175    inflateBuffer = property(_untar.Untar_GzChunkContext_inflateBuffer_get, _untar.Untar_GzChunkContext_inflateBuffer_set, doc=r"""Buffer that contains the inflated data.""")
176    inflateBufferSize = property(_untar.Untar_GzChunkContext_inflateBufferSize_get, _untar.Untar_GzChunkContext_inflateBufferSize_set, doc=r"""Size of buffer that contains the inflated data.""")
177
178    def __init__(self):
179        r"""__init__(Untar_GzChunkContext self) -> Untar_GzChunkContext"""
180        _untar.Untar_GzChunkContext_swiginit(self, _untar.new_Untar_GzChunkContext())
181    __swig_destroy__ = _untar.delete_Untar_GzChunkContext
182
183# Register Untar_GzChunkContext in _untar:
184_untar.Untar_GzChunkContext_swigregister(Untar_GzChunkContext)
185class Untar_XzChunkContext(object):
186    r"""Proxy of C Untar_XzChunkContext struct."""
187
188    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
189    __repr__ = _swig_repr
190    base = property(_untar.Untar_XzChunkContext_base_get, _untar.Untar_XzChunkContext_base_set, doc=r"""Instance of Chunk Context needed for tar decompression.""")
191    strm = property(_untar.Untar_XzChunkContext_strm_get, _untar.Untar_XzChunkContext_strm_set, doc=r"""Xz context.""")
192    buf = property(_untar.Untar_XzChunkContext_buf_get, _untar.Untar_XzChunkContext_buf_set, doc=r"""Xz buffer.""")
193    inflateBuffer = property(_untar.Untar_XzChunkContext_inflateBuffer_get, _untar.Untar_XzChunkContext_inflateBuffer_set, doc=r"""Buffer that contains the inflated data.""")
194    inflateBufferSize = property(_untar.Untar_XzChunkContext_inflateBufferSize_get, _untar.Untar_XzChunkContext_inflateBufferSize_set, doc=r"""Size of buffer that contains the inflated data.""")
195
196    def __init__(self):
197        r"""__init__(Untar_XzChunkContext self) -> Untar_XzChunkContext"""
198        _untar.Untar_XzChunkContext_swiginit(self, _untar.new_Untar_XzChunkContext())
199    __swig_destroy__ = _untar.delete_Untar_XzChunkContext
200
201# Register Untar_XzChunkContext in _untar:
202_untar.Untar_XzChunkContext_swigregister(Untar_XzChunkContext)
203
204def Untar_ChunkContext_Init(context):
205    r"""
206    Initializes the Untar_ChunkContext files out of a part of a block of
207    memory.
208
209    :param Untar_ChunkContext: *context [in] Pointer to a context structure.
210    """
211    return _untar.Untar_ChunkContext_Init(context)
212
213def Untar_FromChunk_Print(context, chunk, chunk_size, printer):
214    r"""
215    Untar_FromChunk_Print(Untar_ChunkContext context, void * chunk, size_t chunk_size, rtems_printer const * printer) -> int
216
217    Parameters
218    ----------
219    context: Untar_ChunkContext *
220    chunk: void *
221    chunk_size: size_t
222    printer: rtems_printer const *
223
224    """
225    return _untar.Untar_FromChunk_Print(context, chunk, chunk_size, printer)
226
227def Untar_GzChunkContext_Init(ctx, inflateBuffer, inflateBufferSize):
228    r"""
229    Initializes the Untar_ChunkGzContext.
230
231    :param Untar_ChunkGzContext: *context [in] Pointer to a context structure.
232    :param void: *inflateBuffer [in] Pointer to a context structure.
233    :param size_t: inflateBufferSize [in] Size of inflateBuffer.
234    """
235    return _untar.Untar_GzChunkContext_Init(ctx, inflateBuffer, inflateBufferSize)
236
237def Untar_FromGzChunk_Print(ctx, chunk, chunk_size, printer):
238    r"""
239    Untar_FromGzChunk_Print(Untar_GzChunkContext ctx, void * chunk, size_t chunk_size, rtems_printer const * printer) -> int
240
241    Parameters
242    ----------
243    ctx: Untar_GzChunkContext *
244    chunk: void *
245    chunk_size: size_t
246    printer: rtems_printer const *
247
248    """
249    return _untar.Untar_FromGzChunk_Print(ctx, chunk, chunk_size, printer)
250
251def Untar_XzChunkContext_Init(ctx, mode, dict_max, inflateBuffer, inflateBufferSize):
252    r"""
253    Initializes the Untar_ChunkXzContext.
254
255    :param Untar_ChunkXzContext: *context [in] Pointer to a context structure.
256    :param enum: xz_mode mode [in] Dictionary mode.
257    :param uint32_t: dict_max [in] Maximum size of dictionary.
258    :param void: *inflateBuffer [in] Pointer to a context structure.
259    :param size_t: inflateBufferSize [in] Size of inflateBuffer.
260    """
261    return _untar.Untar_XzChunkContext_Init(ctx, mode, dict_max, inflateBuffer, inflateBufferSize)
262
263def Untar_FromXzChunk_Print(ctx, chunk, chunk_size, printer):
264    r"""
265    Untar_FromXzChunk_Print(Untar_XzChunkContext ctx, void const * chunk, size_t chunk_size, rtems_printer const * printer) -> int
266
267    Parameters
268    ----------
269    ctx: Untar_XzChunkContext *
270    chunk: void const *
271    chunk_size: size_t
272    printer: rtems_printer const *
273
274    """
275    return _untar.Untar_FromXzChunk_Print(ctx, chunk, chunk_size, printer)
276
277def Untar_ProcessHeader(ctx, bufr):
278    r"""
279    Untar_ProcessHeader(Untar_HeaderContext ctx, char const * bufr) -> int
280
281    Parameters
282    ----------
283    ctx: Untar_HeaderContext *
284    bufr: char const *
285
286    """
287    return _untar.Untar_ProcessHeader(ctx, bufr)