"""
A module implementing an interface for generating bit-field methods for
structs.
"""
# built-in
from typing import Any
# third-party
from vcorelib.io.file_writer import IndentedFileWriter
# internal
from ifgen.generation.interface import GenerateTask
from ifgen.struct.methods.fields.common import BitField
from ifgen.struct.methods.fields.getter import (
bit_field_get_all_method,
bit_field_get_method,
)
from ifgen.struct.methods.fields.setter import (
bit_field_set_all_method,
bit_field_set_method,
)
[docs]
def bit_field(
task: GenerateTask,
parent: dict[str, Any],
field: BitField,
writer: IndentedFileWriter,
read_fields: list[BitField],
write_fields: list[BitField],
alias: str = None,
) -> None:
"""Generate for an individual bit-field."""
type_size = task.env.size(parent["type"]) * 8
width = field["width"]
# Sub-methods not required.
if width == type_size:
return
index = field["index"]
# Validate field parameters.
assert index + width <= type_size, (index, width, type_size, field)
assert field["read"] or field["write"], field
# Generate a 'get' method.
if field["read"]:
bit_field_get_method(task, parent, field, writer, alias=alias)
read_fields.append(field)
# Generate a 'set' method.
if field["write"]:
bit_field_set_method(task, parent, field, writer, alias=alias)
write_fields.append(field)
[docs]
def handle_atomic_fields_methods(
task: GenerateTask,
writer: IndentedFileWriter,
field: dict[str, Any],
read_fields: list[BitField],
write_fields: list[BitField],
alias: str = None,
) -> None:
"""Handle additional bit-field methods."""
if len(read_fields) > 1:
writer.empty()
bit_field_get_all_method(task, writer, field, read_fields, alias=alias)
if len(write_fields) > 1:
writer.empty()
bit_field_set_all_method(
task, writer, field, write_fields, alias=alias
)
[docs]
def bit_fields(task: GenerateTask, writer: IndentedFileWriter) -> None:
"""Generate bit-field lines."""
for field in task.instance["fields"]:
read_fields: list[BitField] = []
write_fields: list[BitField] = []
for bfield in field.get("fields", []):
bit_field(task, field, bfield, writer, read_fields, write_fields)
handle_atomic_fields_methods(
task, writer, field, read_fields, write_fields
)
for alternate in field.get("alternates", []):
read_fields = []
write_fields = []
for bfield in alternate.get("fields", []):
bit_field(
task,
field,
bfield,
writer,
read_fields,
write_fields,
alias=alternate["name"],
)
handle_atomic_fields_methods(
task,
writer,
field,
read_fields,
write_fields,
alias=alternate["name"],
)
