File: //lib/python3.9/site-packages/elftools/construct/__pycache__/adapters.cpython-39.pyc
a
�#�_�@ � @ s� d dl mZmZmZ d dlmZmZmZ d dlmZm Z d dl
m Z m Z G dd� de�Z
G dd� de�ZG d d
� d
e�ZG d d � d e�ZG d
d� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd � d e�ZG d d � d e�ZG d d � d e�ZG d!d"� d"e�ZG d#d$� d$e�Z G d%d&� d&e�Z G d'd(� d(e�Z G d)d*� d*e�Z G d+d,� d,e�Z G d-d.� d.e �Z!G d/d0� d0e �Z"d1S )2� )�Adapter�AdaptationError�Pass)�
int_to_bin�
bin_to_int�
swap_bytes)�FlagsContainer� HexString)�BytesIO� decodebytesc @ s e Zd Zg ZdS )�BitIntegerErrorN��__name__�
__module__� __qualname__� __slots__� r r �?/usr/lib/python3.9/site-packages/elftools/construct/adapters.pyr
s r c @ s e Zd Zg ZdS )� MappingErrorNr
r r r r r s r c @ s e Zd Zg ZdS )�
ConstErrorNr
r r r r r s r c @ s e Zd Zg ZdS )�ValidationErrorNr
r r r r r s r c @ s e Zd Zg ZdS )� PaddingErrorNr
r r r r r s r c @ s2 e Zd ZdZg d�Zd dd�Zdd� Zd d
� Zd S )
�BitIntegerAdaptera�
Adapter for bit-integers (converts bitstrings to integers, and vice versa).
See BitField.
Parameters:
* subcon - the subcon to adapt
* width - the size of the subcon, in bits
* swapped - whether to swap byte order (little endian/big endian).
default is False (big endian)
* signed - whether the value is signed (two's complement). the default
is False (unsigned)
* bytesize - number of bits per byte, used for byte-swapping (if swapped).
default is 8.
)�width�swapped�signed�bytesizeF� c C s( t �| |� || _|| _|| _|| _d S �N)r �__init__r r r r )�self�subconr r r r r r r r ( s
zBitIntegerAdapter.__init__c C s> |dk r| j std|��t|| jd�}| jr:t|| jd�}|S )N� z+object is negative, but field is not signed)r �r )r r r r r r r )r �obj�context�obj2r r r �_encode/ s �zBitIntegerAdapter._encodec C s" | j rt|| jd�}t|| jd�S )Nr# )r )r r r r r �r r$ r% r r r �_decode7 s zBitIntegerAdapter._decodeN)FFr �r r r �__doc__r r r' r) r r r r r s �
r c @ s6 e Zd ZdZg d�Zeefdd�Zdd� Zdd� Zd S )
�MappingAdaptera�
Adapter that maps objects to other objects.
See SymmetricMapping and Enum.
Parameters:
* subcon - the subcon to map
* decoding - the decoding (parsing) mapping (a dict)
* encoding - the encoding (building) mapping (a dict)
* decdefault - the default return value when the object is not found
in the decoding mapping. if no object is given, an exception is raised.
if `Pass` is used, the unmapped object will be passed as-is
* encdefault - the default return value when the object is not found
in the encoding mapping. if no object is given, an exception is raised.
if `Pass` is used, the unmapped object will be passed as-is
)�encoding�decoding�
encdefault�
decdefaultc C s( t �| |� || _|| _|| _|| _d S r )r r r. r- r0 r/ )r r! r. r- r0 r/ r r r r M s
zMappingAdapter.__init__c C s^ z | j | W S ttfyX | jtu r<td|| jjf ��| jtu rN| Y S | j Y S 0 d S )Nz no encoding mapping for %r [%s]) r- �KeyError� TypeErrorr/ �NotImplementedr r! �namer r( r r r r' T s
�
zMappingAdapter._encodec C s^ z | j | W S ttfyX | jtu r<td|| jjf ��| jtu rN| Y S | j Y S 0 d S )Nz no decoding mapping for %r [%s]) r. r1 r2 r0 r3 r r! r4 r r( r r r r) ^ s
�
zMappingAdapter._decodeN) r r r r+ r r3 r r' r) r r r r r, < s �
r, c @ s. e Zd ZdZdgZdd� Zdd� Zdd� Zd S )
� FlagsAdaptera
Adapter for flag fields. Each flag is extracted from the number, resulting
in a FlagsContainer object. Not intended for direct usage.
See FlagsEnum.
Parameters
* subcon - the subcon to extract
* flags - a dictionary mapping flag-names to their value
�flagsc C s t �| |� || _d S r )r r r6 )r r! r6 r r r r t s zFlagsAdapter.__init__c C s0 d}| j �� D ] \}}t||d�r||O }q|S )Nr" F)r6 �items�getattr)r r$ r% r6 r4 �valuer r r r' w s
zFlagsAdapter._encodec C s2 t � }| j�� D ] \}}t||t||@ �� q|S r )r r6 r7 �setattr�bool)r r$ r% r& r4 r9 r r r r) } s zFlagsAdapter._decodeNr* r r r r r5 i s
r5 c @ s0 e Zd ZdZdgZd
dd�Zdd� Zdd � ZdS ) �
StringAdapteraA
Adapter for strings. Converts a sequence of characters into a python
string, and optionally handles character encoding.
See String.
Parameters:
* subcon - the subcon to convert
* encoding - the character encoding name (e.g., "utf8"), or None to
return raw bytes (usually 8-bit ASCII).
r- Nc C s t �| |� || _d S r )r r r- )r r! r- r r r r � s zStringAdapter.__init__c C s | j r|�| j �}|S r )r- �encoder( r r r r' � s zStringAdapter._encodec C s | j r|�| j �}|S r )r- �decoder( r r r r) � s zStringAdapter._decode)Nr* r r r r r< � s
r< c @ s2 e Zd ZdZg d�Zd dd�Zdd� Zd d
� Zd S )
�PaddedStringAdaptera�
Adapter for padded strings.
See String.
Parameters:
* subcon - the subcon to adapt
* padchar - the padding character. default is b"\x00".
* paddir - the direction where padding is placed ("right", "left", or
"center"). the default is "right".
* trimdir - the direction where trimming will take place ("right" or
"left"). the default is "right". trimming is only meaningful for
building, when the given string is too long.
)�padchar�paddir�trimdir� �rightc C sF |dvrt d|��|dvr$t d|��t�| |� || _|| _|| _d S )N)rD �left�centerz*paddir must be 'right', 'left' or 'center')rD rE z!trimdir must be 'right' or 'left')�
ValueErrorr r r@ rA rB )r r! r@ rA rB r r r r � s �
z PaddedStringAdapter.__init__c C s@ | j dkr|�| j�}n$| j dkr0|�| j�}n |�| j�}|S �NrD rE )rA �rstripr@ �lstrip�stripr( r r r r) � s
zPaddedStringAdapter._decodec C s� | � |�}| jdkr$|�|| j�}n(| jdkr>|�|| j�}n|�|| j�}t|�|kr~| jdkrp|d |� }n|| d � }|S rH )�_sizeofrA �ljustr@ �rjustrF �lenrB )r r$ r% �sizer r r r' � s
zPaddedStringAdapter._encodeN)rC rD rD �r r r r+ r r r) r' r r r r r? � s
�
r? c @ s$ e Zd ZdZg Zdd� Zdd� ZdS )�LengthValueAdapterz�
Adapter for length-value pairs. It extracts only the value from the
pair, and calculates the length based on the value.
See PrefixedArray and PascalString.
Parameters:
* subcon - the subcon returning a length-value pair
c C s t |�|fS r )rO r( r r r r' � s zLengthValueAdapter._encodec C s |d S )Nr r r( r r r r) � s zLengthValueAdapter._decodeN)r r r r+ r r' r) r r r r rR � s rR c @ s0 e Zd ZdZdgZd dd�Zdd� Zd d
� ZdS ) �CStringAdapterar
Adapter for C-style strings (strings terminated by a terminator char).
Parameters:
* subcon - the subcon to convert
* terminators - a sequence of terminator chars. default is b"\x00".
* encoding - the character encoding to use (e.g., "utf8"), or None to
return raw-bytes. the terminator characters are not affected by the
encoding.
� terminatorsrC Nc C s t j| ||d� || _d S )N)r- )r< r rT )r r! rT r- r r r r � s zCStringAdapter.__init__c C s t �| ||�| jdd� S )Nr" r )r< r' rT r( r r r r' � s zCStringAdapter._encodec C s t �| d�|d d� �|�S )N� ���)r< r) �joinr( r r r r) � s zCStringAdapter._decode)rC Nr* r r r r rS � s
rS c @ s. e Zd ZdZdgZdd� Zdd� Zdd� Zd S )
�
TunnelAdapteraC
Adapter for tunneling (as in protocol tunneling). A tunnel is construct
nested upon another (layering). For parsing, the lower layer first parses
the data (note: it must return a string!), then the upper layer is called
to parse that data (bottom-up). For building it works in a top-down manner;
first the upper layer builds the data, then the lower layer takes it and
writes it to the stream.
Parameters:
* subcon - the lower layer subcon
* inner_subcon - the upper layer (tunneled/nested) subcon
Example:
# a pascal string containing compressed data (zlib encoding), so first
# the string is read, decompressed, and finally re-parsed as an array
# of UBInt16
TunnelAdapter(
PascalString("data", encoding = "zlib"),
GreedyRange(UBInt16("elements"))
)
� inner_subconc C s t �| |� || _d S r )r r rY )r r! rY r r r r s zTunnelAdapter.__init__c C s | j �t|�|�S r )rY �_parser
r( r r r r) s zTunnelAdapter._decodec C s t � }| j�|||� |�� S r )r
rY Z_build�getvalue)r r$ r% �streamr r r r' s zTunnelAdapter._encodeNrQ r r r r rX � s
rX c @ s e Zd ZdZddgZdd� ZdS )� ExprAdaptera>
A generic adapter that accepts 'encoder' and 'decoder' as parameters. You
can use ExprAdapter instead of writing a full-blown class when only a
simple expression is needed.
Parameters:
* subcon - the subcon to adapt
* encoder - a function that takes (obj, context) and returns an encoded
version of obj
* decoder - a function that takes (obj, context) and returns a decoded
version of obj
Example:
ExprAdapter(UBInt8("foo"),
encoder = lambda obj, ctx: obj / 4,
decoder = lambda obj, ctx: obj * 4,
)
r' r) c C s t �| |� || _|| _d S r )r r r' r) )r r! �encoder�decoderr r r r $ s zExprAdapter.__init__N)r r r r+ r r r r r r r] s r] c @ s0 e Zd ZdZdgZd dd�Zdd� Zdd � Zd
S ) �HexDumpAdapterzT
Adapter for hex-dumping strings. It returns a HexString, which is a string
�linesize� c C s t �| |� || _d S r )r r ra )r r! ra r r r r . s zHexDumpAdapter.__init__c C s |S r r r( r r r r' 1 s zHexDumpAdapter._encodec C s t || jd�S )N)ra )r ra r( r r r r) 3 s zHexDumpAdapter._decodeN)rb r* r r r r r` ) s
r` c @ s. e Zd ZdZdgZdd� Zdd� Zdd� Zd S )
� ConstAdaptera,
Adapter for enforcing a constant value ("magic numbers"). When decoding,
the return value is checked; when building, the value is substituted in.
Parameters:
* subcon - the subcon to validate
* value - the expected value
Example:
Const(Field("signature", 2), "MZ")
r9 c C s t �| |� || _d S r )r r r9 )r r! r9 r r r r C s zConstAdapter.__init__c C s. |d u s|| j kr| j S td| j |f ��d S �Nzexpected %r, found %r�r9 r r( r r r r' F s zConstAdapter._encodec C s || j kr td| j |f ��|S rd re r( r r r r) K s
zConstAdapter._decodeNr* r r r r rc 6 s
rc c @ s2 e Zd ZdZg d�Zd
dd�Zdd� Zdd � ZdS ) �SlicingAdapterz�
Adapter for slicing a list (getting a slice from that list)
Parameters:
* subcon - the subcon to slice
* start - start index
* stop - stop index (or None for up-to-end)
* step - step (or None for every element)
)�start�stop�stepNc C s t �| |� || _|| _d S r )r r rg rh )r r! rg rh r r r r [ s zSlicingAdapter.__init__c C s | j d u r|S d g| j | S r )rg r( r r r r' _ s
zSlicingAdapter._encodec C s || j | j� S r )rg rh r( r r r r) c s zSlicingAdapter._decode)Nr* r r r r rf P s
rf c @ s. e Zd ZdZdgZdd� Zdd� Zdd� Zd S )
�IndexingAdapterz�
Adapter for indexing a list (getting a single item from that list)
Parameters:
* subcon - the subcon to index
* index - the index of the list to get
�indexc C s0 t �| |� t|�tur&tdt|���|| _d S )Nzindex must be an integer)r r �type�intr2 rk )r r! rk r r r r o s zIndexingAdapter.__init__c C s d g| j |g S r �rk r( r r r r' t s zIndexingAdapter._encodec C s
|| j S r rn r( r r r r) v s zIndexingAdapter._decodeNr* r r r r rj f s
rj c @ s2 e Zd ZdZddgZd
dd�Zdd � Zd
d � Zd S )�PaddingAdaptera+
Adapter for padding.
Parameters:
* subcon - the subcon to pad
* pattern - the padding pattern (character as byte). default is b"\x00"
* strict - whether or not to verify, during parsing, that the given
padding matches the padding pattern. default is False (unstrict)
�pattern�strictrC Fc C s t �| |� || _|| _d S r )r r rp rq )r r! rp rq r r r r � s zPaddingAdapter.__init__c C s | � |�| j S r )rL rp r( r r r r' � s zPaddingAdapter._encodec C s2 | j r.| �|�| j }||kr.td||f ��|S rd )rq rL rp r )r r$ r% Zexpectedr r r r) � s
zPaddingAdapter._decodeN)rC Fr* r r r r ro y s
ro c @ s, e Zd ZdZg Zdd� Zdd� Zdd� ZdS ) � Validatorz�
Abstract class: validates a condition on the encoded/decoded object.
Override _validate(obj, context) in deriving classes.
Parameters:
* subcon - the subcon to validate
c C s | � ||�std|��|S )Nzinvalid object)� _validater r( r r r r) � s
zValidator._decodec C s | � ||�S r )r) r( r r r r' � s zValidator._encodec C s
t � �d S r )�NotImplementedErrorr( r r r rs � s zValidator._validateN)r r r r+ r r) r' rs r r r r rr � s
rr c @ s& e Zd ZdZdgZdd� Zdd� ZdS )�OneOfai
Validates that the object is one of the listed values.
:param ``Construct`` subcon: object to validate
:param iterable valids: a set of valid values
>>> OneOf(UBInt8("foo"), [4,5,6,7]).parse("\x05")
5
>>> OneOf(UBInt8("foo"), [4,5,6,7]).parse("\x08")
Traceback (most recent call last):
...
construct.core.ValidationError: ('invalid object', 8)
>>>
>>> OneOf(UBInt8("foo"), [4,5,6,7]).build(5)
'\x05'
>>> OneOf(UBInt8("foo"), [4,5,6,7]).build(9)
Traceback (most recent call last):
...
construct.core.ValidationError: ('invalid object', 9)
�validsc C s t �| |� || _d S r )rr r rv )r r! rv r r r r � s zOneOf.__init__c C s
|| j v S r )rv r( r r r rs � s zOneOf._validateN�r r r r+ r r rs r r r r ru � s ru c @ s& e Zd ZdZdgZdd� Zdd� ZdS )�NoneOfa�
Validates that the object is none of the listed values.
:param ``Construct`` subcon: object to validate
:param iterable invalids: a set of invalid values
>>> NoneOf(UBInt8("foo"), [4,5,6,7]).parse("\x08")
8
>>> NoneOf(UBInt8("foo"), [4,5,6,7]).parse("\x06")
Traceback (most recent call last):
...
construct.core.ValidationError: ('invalid object', 6)
�invalidsc C s t �| |� || _d S r )rr r ry )r r! ry r r r r � s zNoneOf.__init__c C s
|| j vS r )ry r( r r r rs � s zNoneOf._validateNrw r r r r rx � s
rx N)#Zcorer r r �libr r r r r Z
lib.py3compatr
r r r r r r r r, r5 r< r? rR rS rX r] r` rc rf rj ro rr ru rx r r r r �<module> s2 $-1!