pub struct EmitModuleContext<'c, 'a, H>where
'a: 'c,{ /* private fields */ }
Expand description
A context holding data required for emitting HUGRs into an LLVM module. This includes the module itself, a set of extensions for lowering custom elements, and policy for naming various HUGR elements.
'c
names the lifetime of the LLVM context, while 'a
names the lifetime
of other internal references.
Implementations§
Source§impl<'c, 'a, H> EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> EmitModuleContext<'c, 'a, H>
Sourcepub fn llvm_type(&self, hugr_type: &HugrType) -> Result<BasicTypeEnum<'c>>
pub fn llvm_type(&self, hugr_type: &HugrType) -> Result<BasicTypeEnum<'c>>
Sourcepub fn llvm_func_type(
&self,
hugr_type: &HugrFuncType,
) -> Result<FunctionType<'c>>
pub fn llvm_func_type( &self, hugr_type: &HugrFuncType, ) -> Result<FunctionType<'c>>
Convert a HugrFuncType into an LLVM FunctionType.
Sourcepub fn llvm_sum_type(&self, sum_type: HugrSumType) -> Result<LLVMSumType<'c>>
pub fn llvm_sum_type(&self, sum_type: HugrSumType) -> Result<LLVMSumType<'c>>
Convert a hugr HugrSumType into an LLVM LLVMSumType.
pub fn iw_context(&self) -> &'c Context
Sourcepub fn new(
iw_context: &'c Context,
module: Module<'c>,
namer: Rc<Namer>,
extensions: Rc<CodegenExtsMap<'a, H>>,
) -> Self
pub fn new( iw_context: &'c Context, module: Module<'c>, namer: Rc<Namer>, extensions: Rc<CodegenExtsMap<'a, H>>, ) -> Self
Creates a new EmitModuleContext
. We take ownership of the Module,
and return it in EmitModuleContext::finish
.
Sourcepub fn extensions(&self) -> Rc<CodegenExtsMap<'a, H>>
pub fn extensions(&self) -> Rc<CodegenExtsMap<'a, H>>
Returns a reference to the inner CodegenExtsMap
.
Sourcepub fn typing_session(&self) -> TypingSession<'c, 'a>
pub fn typing_session(&self) -> TypingSession<'c, 'a>
Returns a TypingSession
constructed from it’s members.
Sourcepub fn get_func_defn<'hugr>(
&self,
node: FatNode<'hugr, FuncDefn, H>,
) -> Result<FunctionValue<'c>>
pub fn get_func_defn<'hugr>( &self, node: FatNode<'hugr, FuncDefn, H>, ) -> Result<FunctionValue<'c>>
Adds or gets the FunctionValue
in the Module corresponding to the given FuncDefn
.
The name of the result is mangled by EmitModuleContext::name_func
.
Sourcepub fn get_func_decl<'hugr>(
&self,
node: FatNode<'hugr, FuncDecl, H>,
) -> Result<FunctionValue<'c>>
pub fn get_func_decl<'hugr>( &self, node: FatNode<'hugr, FuncDecl, H>, ) -> Result<FunctionValue<'c>>
Adds or gets the FunctionValue
in the Module corresponding to the given FuncDecl
.
The name of the result is mangled by EmitModuleContext::name_func
.
Sourcepub fn get_extern_func(
&self,
symbol: impl AsRef<str>,
typ: FunctionType<'c>,
) -> Result<FunctionValue<'c>>
pub fn get_extern_func( &self, symbol: impl AsRef<str>, typ: FunctionType<'c>, ) -> Result<FunctionValue<'c>>
Adds or get the FunctionValue
in the Module with the given symbol
and function type.
The name undergoes no mangling. The FunctionValue
will have
Linkage::External
.
If this function is called multiple times with the same arguments it
will return the same FunctionValue
.
If a function with the given name exists but the type does not match then an Error is returned.
Sourcepub fn get_global(
&self,
symbol: impl AsRef<str>,
typ: impl BasicType<'c>,
constant: bool,
) -> Result<GlobalValue<'c>>
pub fn get_global( &self, symbol: impl AsRef<str>, typ: impl BasicType<'c>, constant: bool, ) -> Result<GlobalValue<'c>>
Adds or gets the GlobalValue
in the Module corresponding to the
given symbol and LLVM type.
The name will not be mangled.
If a global with the given name exists but the type or constant-ness does not match then an error will be returned.
Auto Trait Implementations§
impl<'c, 'a, H> !Freeze for EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> !RefUnwindSafe for EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> !Send for EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> !Sync for EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> Unpin for EmitModuleContext<'c, 'a, H>
impl<'c, 'a, H> !UnwindSafe for EmitModuleContext<'c, 'a, H>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.