Class Struct

This must be instantiated with a dict of members. The keys
are the offsets, the values are Curried Object classes that
will be instantiated when accessed.

Args:
   members: A dict of callables to use for retrieving each member. (Key
     is member name, value is a callable). Normally these are populated
     by the profile system

   struct_size: The size of this struct if known (Can be None).

Overrides: object.__init__

hash(x)

Overrides: object.__hash__

(inherited documentation)

Return our offset as an integer.

This allows us to interchange Struct and offsets.

The number of bytes before the object which are part of the object.

Some objects are preceeded with data before obj_offset which is still considered part of the object. Note that in that case the size of the object includes the preamble_size - hence

object_end = obj_offset + obj_size - obj.preamble_size()

repr(x)

Overrides: object.__repr__

(inherited documentation)

Overrides: BaseObject.__unicode__

When a struct is evaluated we just return our offset.

Overrides: BaseObject.v

Fetch the member named by attr.

NOTE: When the member does not exist in this struct, we return a NoneObject instance. This allows one to write code such as:

struct.m("Field1") or struct.m("Field2") struct.m("Field2")

To access a field which has been renamed in different OS versions.

By default this method does not allow callable methods specified in overlays. This is to enable overriding of normal struct members by callable properties (otherwise infinite recursion might occur). If you really want to call overlays, specify allow_callable_attributes as True.

Overrides: BaseObject.m

Retrieve a set of fields in order.

If a field is not found, then try the next field in the list until one field works. This approach allows us to propose a set of possible fields for an attribute to support renaming of struct fields in different versions.

Walk a single linked list in this struct.

The current object can be optionally yielded as the first element.

Args:
  list_member: The member name which points to the next item in the
  list.

indices

Returns (usually 1) representation(s) of self usable as dict keys.

Using full base objects for indexing can be slow, especially with Structs. This method returns a representation of the object that is a suitable key - either the value of a primitive type, or the memory address of the more complex ones.

Get Method:

unreachable.indices(self)

obj_size

Get Method:

unreachable.obj_size(self)