FHElium

Appearance

fhelium.compile._pipeline ​

Compose Compile passes over Programs and shared workspace data.

DecisionRecord ​

class View source

python
DecisionRecord(subject: str, selected: str | None = None, candidates: tuple[str, ...] = (), details: tuple[str, ...] = ())

Describe one inspectable choice made during a transformation.

Attributes ​

NameTypeDefault/value
subjectstr
selectedstr | NoneNone
candidatestuple[str, ...]()
detailstuple[str, ...]()

Pass ​

class View source

python
Pass()

Bases: Protocol

Define one locally applicable transformation or analysis step.

name ​

property

python
name: str

Stable name used in pipeline composition and reports.

run ​

method

python
def run(compilation: Compilation, /) -> PassResult: ...

Inspect or transform the current Compilation and report the outcome.

PassReport ​

class View source

python
PassReport(name: str, stats: PassStats, diagnostics: tuple[str, ...] = (), decisions: tuple[DecisionRecord, ...] = ())

Record one pass's activity, diagnostics, and choices.

Attributes ​

NameTypeDefault/value
namestr
statsPassStats
diagnosticstuple[str, ...]()
decisionstuple[DecisionRecord, ...]()

PassResult ​

class View source

python
PassResult(program: Program, stats: PassStats = PassStats(), diagnostics: tuple[str, ...] = (), decisions: tuple[DecisionRecord, ...] = ())

Program, counts, diagnostics, and choices returned by one pass.

Attributes ​

NameTypeDefault/value
programProgram
statsPassStatsPassStats()
diagnosticstuple[str, ...]()
decisionstuple[DecisionRecord, ...]()

changed ​

property

python
changed: bool

Whether the reported counts describe an IR change.

unchanged ​

method

python
def unchanged(program: Program, *, matched: int=0, skipped: int=0, diagnostics: tuple[str, ...]=(), decisions: tuple[DecisionRecord, ...]=()) -> PassResult: ...

Record a normal pass result that preserves the Program.

PassStats ​

class View source

python
PassStats(matched: int = 0, transformed: int = 0, inserted: int = 0, removed: int = 0, skipped: int = 0)

Count one pass's observed and changed patterns.

Attributes ​

NameTypeDefault/value
matchedint0
transformedint0
insertedint0
removedint0
skippedint0

Pipeline ​

class View source

python
Pipeline(passes: tuple[Pass, ...] = ())

Run an ordered, dependency-free tuple of partial transformations.

Attributes ​

NameTypeDefault/value
passestuple[Pass, ...]()

names ​

property

python
names: tuple[str, ...]

Return pass names in execution order.

run ​

method

python
def run(compilation: Compilation) -> Compilation: ...

Clone and transform one Compilation while retaining its workspace.

then ​

method

python
def then(*passes: Pass) -> Pipeline: ...

Append passes in order.

before ​

method

python
def before(target: str, *passes: Pass) -> Pipeline: ...

Insert passes before one uniquely named pass.

after ​

method

python
def after(target: str, *passes: Pass) -> Pipeline: ...

Insert passes after one uniquely named pass.

replace ​

method

python
def replace(target: str, *passes: Pass) -> Pipeline: ...

Replace one uniquely named pass.

TransformError ​

class View source

python
TransformError()

Bases: RuntimeError

Report a malformed Compile transformation request or result.