Source code for qbindiff.loader.structure

# Copyright 2023 Quarkslab
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Structure
"""

from __future__ import annotations
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from typing import Any
    from qbindiff.loader.types import DataType, StructureType




class StructureMember:
    """
    Class that represents a struct member reference
    """

    def __init__(
        self,
        data_type: DataType,
        name: str,
        size: int,
        value: Any,
        structure: Structure,
    ):
        self.type = data_type
        self.name = name
        self.size = size
        self.value = value
        self.structure = structure





class Structure:
    """
    Class that represents a struct reference
    """

    def __init__(self, struct_type: StructureType, name: str, size: int):
        self.type = struct_type
        self.name = name
        self.size = size
        self.members: dict[int, StructureMember] = {}  # { offset: StructureMember }



    def add_member(
        self, offset: int, data_type: DataType, name: str, size: int, value: Any
    ) -> None:
        """
        Add a new member of the struct at offset `offset`

        :param offset: offset where to add the member
        :param data_type: type of the member
        :param name: its name
        :param size: its size
        :param value: its value
        :return: None
        """

        self.members[offset] = StructureMember(data_type, name, size, value, self)




    def member_by_name(self, name: str) -> StructureMember | None:
        """
        Get member by name. WARNING: time complexity O(n)

        :param name: name from which we want to recover the structure member
        :return: member of the structure denoted by its name or None
        """

        try:
            return next(filter(lambda m: m.name == name, self.members.values()))
        except StopIteration:
            return None