"""
The COPY operation.
Copies a value from one module into another.
"""
from itertools import product
from ..language_defs import (
INSTRUCTION_GROUPS,
SRC_REGISTERS,
DEST_REGISTERS,
MODULE_CONTROL,
FLAGS,
instruction_byte_from_bitdefs,
)
from ..operation_utils import assemble_instruction, match_and_parse_line
from ..data_structures import (
get_arg_def_template, get_machine_code_byte_template
)
_NAME = "COPY"
[docs]def generate_signatures():
"""
Generate the definitions of all possible arguments passable.
Returns:
list(list(dict)): All possible arguments. See
:func:`~.get_arg_def_template` for more information.
"""
signatures = []
sources = ("ACC", "A", "B", "C", "PC", "SP")
destinations = ("ACC", "A", "B", "C", "SP")
for src, dest in product(sources, destinations):
if src != dest:
signature = []
arg0_def = get_arg_def_template()
arg0_def["value_type"] = "module_name"
arg0_def["value"] = src
signature.append(arg0_def)
arg1_def = get_arg_def_template()
arg1_def["value_type"] = "module_name"
arg1_def["value"] = dest
signature.append(arg1_def)
signatures.append(signature)
return signatures
[docs]def generate_microcode_templates():
"""
Generate microcode for all the COPY operations.
Returns:
list(DataTemplate): DataTemplates for all the COPY microcode.
"""
data_templates = []
signatures = generate_signatures()
for signature in signatures:
templates = generate_operation_templates(signature)
data_templates.extend(templates)
return data_templates
[docs]def generate_operation_templates(signature):
"""
Create the DataTemplates to define a copy with the given args.
Args:
signature (list(dict)): List of argument definitions that
specify which particular copy operation to generate
templates for.
Returns:
list(DataTemplate) : Datatemplates that define this copy.
"""
instruction_byte_bitdefs = generate_instruction_byte_bitdefs(signature)
flags_bitdefs = [FLAGS["ANY"]]
control_steps = [
[
MODULE_CONTROL[signature[0]["value"]]["OUT"],
MODULE_CONTROL[signature[1]["value"]]["IN"],
]
]
return assemble_instruction(
instruction_byte_bitdefs, flags_bitdefs, control_steps
)
[docs]def generate_instruction_byte_bitdefs(signature):
"""
Generate bitdefs to specify the instruction byte for these args.
Args:
signature (list(dict)): List of argument definitions that
specify which particular copy operation to generate
the instruction byte bitdefs for.
Returns:
list(str): Bitdefs that make up the instruction_byte
"""
return [
INSTRUCTION_GROUPS["COPY"],
SRC_REGISTERS[signature[0]["value"]],
DEST_REGISTERS[signature[1]["value"]],
]
[docs]def parse_line(line):
"""
Parse a line of assembly code to create machine code byte templates.
If a line is not identifiably a COPY assembly line, return an empty
list instead.
Args:
line (str): Assembly line to be parsed.
Returns:
list(dict): List of instruction byte template dictionaries or an
empty list.
"""
match, signature = match_and_parse_line(
line, _NAME, generate_signatures()
)
if not match:
return []
instruction_byte = instruction_byte_from_bitdefs(
generate_instruction_byte_bitdefs(signature)
)
mc_byte = get_machine_code_byte_template()
mc_byte["byte_type"] = "instruction"
mc_byte["bitstring"] = instruction_byte
return [mc_byte]