facade

Classes:

• Builder –

Builder

Builder()

Bases: Builder

Methods:

• activate_runtime_feature –
• build –
• module –
• run –
• translate –

Source code in src/irx/builders/llvmliteir/facade.py

def __init__(self) -> None:
    """
    title: Initialize Builder.
    """
    super().__init__()
    self.translator = self._new_translator()

activate_runtime_feature

activate_runtime_feature(feature_name: str) -> None

Source code in src/irx/builders/base.py

def activate_runtime_feature(self, feature_name: str) -> None:
    """
    title: Activate a native runtime feature for this compilation unit.
    parameters:
      feature_name:
        type: str
    """
    self.runtime_feature_names.add(feature_name)

build

build(node: AST, output_file: str) -> None

Source code in src/irx/builders/llvmliteir/facade.py

def build(self, node: astx.AST, output_file: str) -> None:
    """
    title: Build.
    parameters:
      node:
        type: astx.AST
      output_file:
        type: str
    """
    result = self.translate(node)
    result_mod = llvm.parse_assembly(result)
    result_object = self.translator.target_machine.emit_object(result_mod)

    with tempfile.TemporaryDirectory() as temp_dir:
        self.tmp_path = temp_dir
        file_path_o = Path(temp_dir) / "irx_module.o"

        with open(file_path_o, "wb") as handle:
            handle.write(result_object)

        self.output_file = output_file
        link_executable(
            primary_object=file_path_o,
            output_file=Path(self.output_file),
            artifacts=self.translator.runtime_features.native_artifacts(),
            linker_flags=self.translator.runtime_features.linker_flags(),
        )

    os.chmod(self.output_file, 0o755)

module

module() -> Module

Source code in src/irx/builders/base.py

def module(self) -> astx.Module:
    """
    title: Create a new ASTx Module.
    returns:
      type: astx.Module
    """
    return astx.Module()

run

run(
    *,
    capture_stderr: bool = True,
    raise_on_error: bool = True,
    debug: bool = False,
) -> CommandResult

Source code in src/irx/builders/base.py

def run(
    self,
    *,
    capture_stderr: bool = True,
    raise_on_error: bool = True,
    debug: bool = False,
) -> CommandResult:
    """
    title: Run the generated executable.
    parameters:
      capture_stderr:
        type: bool
        default: true
      raise_on_error:
        type: bool
        default: true
      debug:
        type: bool
        default: false
    returns:
      type: CommandResult
    """
    return run_command(
        [self.output_file],
        capture_stderr=capture_stderr,
        raise_on_error=raise_on_error,
        debug=debug,
    )

translate

translate(expr: AST) -> str

Source code in src/irx/builders/llvmliteir/facade.py

def translate(self, expr: astx.AST) -> str:
    """
    title: Translate.
    parameters:
      expr:
        type: astx.AST
    returns:
      type: str
    """
    self.translator = self._new_translator()
    return self.translator.translate(expr)