Struct CodegenExtsBuilder

pub struct CodegenExtsBuilder<'a, H> { /* private fields */ }

A container for a collection of codegen callbacks as they are being assembled.

The callbacks are registered against several keys:

• CustomTypes, with CodegenExtsBuilder::custom_type
• CustomConsts, with CodegenExtsBuilder::custom_const
• ExtensionOps, with CodegenExtsBuilder::extension_op

Each callback may hold references older than 'a.

Registering any callback silently replaces any other callback registered for that same key.

Implementations

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_extension(self, ext: impl CodegenExtension + 'a) -> Self

Forwards to CodegenExtension::add_extension.

use hugr_llvm::{extension::{PreludeCodegenExtension, DefaultPreludeCodegen}, CodegenExtsBuilder};
let ext = PreludeCodegenExtension::from(DefaultPreludeCodegen);
CodegenExtsBuilder::<hugr_core::Hugr>::default().add_extension(ext);

pub fn custom_type( self, custom_type: CustomTypeKey, handler: impl LLVMCustomTypeFn<'a>, ) -> Self

Register a callback to map a CustomType to a BasicTypeEnum.

pub fn extension_op( self, extension: ExtensionId, op: OpName, handler: impl ExtensionOpFn<'a, H>, ) -> Self

Register a callback to emit a ExtensionOp, keyed by fully qualified OpName.

pub fn simple_extension_op<Op: MakeOpDef + IntoEnumIterator>( self, handler: impl 'a + for<'c> Fn(&mut EmitFuncContext<'c, 'a, H>, EmitOpArgs<'c, '_, ExtensionOp, H>, Op) -> Result<()>, ) -> Self

Register callbacks to emit ExtensionOps that match the definitions generated by Ops impl of strum::IntoEnumIterator>

pub fn custom_const<CC: CustomConst>( self, handler: impl LoadConstantFn<'a, H, CC>, ) -> Self

Register a callback to materialise a constant implemented by CC.

pub fn finish(self) -> CodegenExtsMap<'a, H>

Consume self to return collections of callbacks for each of the supported keys.`

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_default_array_extensions(self) -> Self

Add a ArrayCodegenExtension to the given CodegenExtsBuilder using ccg as the implementation.

pub fn add_array_extensions(self, ccg: impl ArrayCodegen + 'a) -> Self

Add a ArrayCodegenExtension to the given CodegenExtsBuilder using DefaultArrayCodegen as the implementation.

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_default_list_extensions(self) -> Self

Add a ListCodegenExtension to the given CodegenExtsBuilder using ccg as the implementation.

pub fn add_list_extensions(self, ccg: impl ListCodegen + 'a) -> Self

Add a ListCodegenExtension to the given CodegenExtsBuilder using DefaultListCodegen as the implementation.

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_static_array_extensions( self, ccg: impl StaticArrayCodegen + 'static, ) -> Self

Add a StaticArrayCodegenExtension to the given CodegenExtsBuilder using ccg as the implementation.

pub fn add_default_static_array_extensions(self) -> Self

Add a StaticArrayCodegenExtension to the given CodegenExtsBuilder using DefaultStaticArrayCodegen as the implementation.

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_conversion_extensions(self) -> Self

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_float_extensions(self) -> Self

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_default_int_extensions(self) -> Self

Populates a CodegenExtsBuilder with all extensions needed to lower int ops, types, and constants.

Any ops that panic will do so using DefaultPreludeCodegen.

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_logic_extensions(self) -> Self

Populates a CodegenExtsBuilder with all extensions needed to lower logic ops.

impl<'a, H: HugrView<Node = Node> + 'a> CodegenExtsBuilder<'a, H>

pub fn add_default_prelude_extensions(self) -> Self

Add a PreludeCodegenExtension to the given CodegenExtsBuilder using pcg as the implementation.

pub fn add_prelude_extensions(self, pcg: impl PreludeCodegen + 'a) -> Self

Add a PreludeCodegenExtension to the given CodegenExtsBuilder using DefaultPreludeCodegen as the implementation.

Trait Implementations

impl<'a, H: Default> Default for CodegenExtsBuilder<'a, H>

fn default() -> CodegenExtsBuilder<'a, H>

Returns the “default value” for a type.