Freeciv-3.2
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Protected Member Functions
generate_packets.ArrayType Class Reference
+ Inheritance diagram for generate_packets.ArrayType:

Public Member Functions

 __init__ (self, FieldType elem, SizeInfo size)
 
str get_code_declaration (self, Location location)
 
str get_code_handle_param (self, Location location)
 
str get_code_fill (self, Location location)
 
str get_code_hash (self, Location location)
 
str get_code_cmp (self, Location location)
 
str get_code_put (self, Location location, bool deep_diff=False)
 
str get_code_get (self, Location location, bool deep_diff=False)
 
str __str__ (self)
 
- Public Member Functions inherited from generate_packets.FieldType
"FieldType" array (self, SizeInfo size)
 
str get_code_handle_arg (self, Location location)
 
- Public Member Functions inherited from generate_packets.RawFieldType
str __repr__ (self)
 

Data Fields

 elem
 
 size
 

Protected Member Functions

str _get_code_put_full (self, Location location, str inner_put)
 
str _get_code_put_diff (self, Location location, str inner_put)
 
str _get_code_get_full (self, Location location, str inner_get)
 
str _get_code_get_diff (self, Location location, str inner_get)
 

Additional Inherited Members

- Static Public Attributes inherited from generate_packets.FieldType
bool foldable = False
 

Detailed Description

Type information for an array field. Consists of size information and
another FieldType for the array's elements, which may also be an
ArrayType (for multi-dimensionaly arrays).

Definition at line 1106 of file generate_packets.py.

Constructor & Destructor Documentation

◆ __init__()

generate_packets.ArrayType.__init__ (   self,
FieldType  elem,
SizeInfo  size 
)

Definition at line 1111 of file generate_packets.py.

Member Function Documentation

◆ __str__()

str generate_packets.ArrayType.__str__ (   self)

Reimplemented from generate_packets.RawFieldType.

Definition at line 1373 of file generate_packets.py.

◆ _get_code_get_diff()

str generate_packets.ArrayType._get_code_get_diff (   self,
Location  location,
str  inner_get 
)
protected
Helper method. Generate array-diff get code.

Definition at line 1303 of file generate_packets.py.

◆ _get_code_get_full()

str generate_packets.ArrayType._get_code_get_full (   self,
Location  location,
str  inner_get 
)
protected
Helper method. Generate get code without array-diff.

Definition at line 1275 of file generate_packets.py.

◆ _get_code_put_diff()

str generate_packets.ArrayType._get_code_put_diff (   self,
Location  location,
str  inner_put 
)
protected
Helper method. Generate array-diff put code.

Definition at line 1196 of file generate_packets.py.

◆ _get_code_put_full()

str generate_packets.ArrayType._get_code_put_full (   self,
Location  location,
str  inner_put 
)
protected
Helper method. Generate put code without array-diff.

Definition at line 1166 of file generate_packets.py.

◆ get_code_cmp()

str generate_packets.ArrayType.get_code_cmp (   self,
Location  location 
)
Generate a code snippet comparing a field of this type between
the `old` and `real_packet` and setting `differ` accordingly.

Reimplemented from generate_packets.FieldType.

Definition at line 1142 of file generate_packets.py.

◆ get_code_declaration()

str generate_packets.ArrayType.get_code_declaration (   self,
Location  location 
)
Generate a code snippet declaring a field with this type in a
packet struct.

Reimplemented from generate_packets.FieldType.

Definition at line 1117 of file generate_packets.py.

◆ get_code_fill()

str generate_packets.ArrayType.get_code_fill (   self,
Location  location 
)
Generate a code snippet moving a value of this type from dsend
arguments into a packet struct.

Reimplemented from generate_packets.FieldType.

Definition at line 1127 of file generate_packets.py.

◆ get_code_get()

str generate_packets.ArrayType.get_code_get (   self,
Location  location,
bool   deep_diff = False 
)
Generate a code snippet reading a field of this type from the
dataio stream.

Reimplemented from generate_packets.FieldType.

Definition at line 1366 of file generate_packets.py.

◆ get_code_handle_param()

str generate_packets.ArrayType.get_code_handle_param (   self,
Location  location 
)
Generate a code fragment declaring a parameter with this type for
a handle function.

See also self.get_code_handle_arg()

Reimplemented from generate_packets.FieldType.

Definition at line 1122 of file generate_packets.py.

◆ get_code_hash()

str generate_packets.ArrayType.get_code_hash (   self,
Location  location 
)
Generate a code snippet factoring a field of this type into a
hash computation's `result`.

Reimplemented from generate_packets.FieldType.

Definition at line 1139 of file generate_packets.py.

◆ get_code_put()

str generate_packets.ArrayType.get_code_put (   self,
Location  location,
bool   deep_diff = False 
)
Generate a code snippet writing a field of this type to the
dataio stream.

Reimplemented from generate_packets.FieldType.

Definition at line 1268 of file generate_packets.py.

Field Documentation

◆ elem

generate_packets.ArrayType.elem

Definition at line 1112 of file generate_packets.py.

◆ size

generate_packets.ArrayType.size

Definition at line 1114 of file generate_packets.py.