Struct gccjit::Block

pub struct Block<'ctx> { /* private fields */ }

Block represents a basic block in gccjit. Blocks are created by functions. A basic block consists of a series of instructions terminated by a terminator instruction, which can be either a jump to one block, a conditional branch to two blocks (true/false branches), a return, or a void return.

Implementations

impl<'ctx> Block<'ctx>

pub fn get_function(&self) -> Function<'ctx>

pub fn add_eval<T: ToRValue<'ctx>>(&self, loc: Option<Location<'ctx>>, value: T)

Evaluates the rvalue parameter and discards its result. Equivalent to (void) in C.

pub fn add_assignment<L: ToLValue<'ctx>, R: ToRValue<'ctx>>( &self, loc: Option<Location<'ctx>>, assign_target: L, value: R )

Assigns the value of an rvalue to an lvalue directly. Equivalent to = in C.

pub fn add_assignment_op<L: ToLValue<'ctx>, R: ToRValue<'ctx>>( &self, loc: Option<Location<'ctx>>, assign_target: L, op: BinaryOp, value: R )

Performs a binary operation on an LValue and an RValue, assigning the result of the binary operation to the LValue upon completion. Equivalent to the *=, +=, -=, etc. operator family in C.

pub fn add_comment<S: AsRef<str>>( &self, loc: Option<Location<'ctx>>, message: S )

Adds a comment to a block. It’s unclear from the documentation what this actually means.

pub fn end_with_conditional<T: ToRValue<'ctx>>( &self, loc: Option<Location<'ctx>>, cond: T, on_true: Block<'ctx>, on_false: Block<'ctx> )

Terminates a block by branching to one of two blocks, depending on the value of a conditional RValue.

pub fn end_with_jump(&self, loc: Option<Location<'ctx>>, target: Block<'ctx>)

Terminates a block by unconditionally jumping to another block.

pub fn end_with_return<T: ToRValue<'ctx>>( &self, loc: Option<Location<'ctx>>, ret: T )

Terminates a block by returning from the containing function, setting the rvalue to be the return value of the function. This is equivalent to C’s “return ”. This function can only be used to terminate a block within a function whose return type is not void.

pub fn end_with_void_return(&self, loc: Option<Location<'ctx>>)

Terminates a block by returning from the containing function, returning no value. This is equivalent to C’s bare “return” with no expression. This function can only be used to terminate a block within a function that returns void.

pub fn end_with_switch<T: ToRValue<'ctx>>( &self, loc: Option<Location<'ctx>>, expr: T, default_block: Block<'ctx>, cases: &[Case<'ctx>] )

pub fn add_extended_asm( &self, loc: Option<Location<'ctx>>, asm_template: &str ) -> ExtendedAsm<'ctx>

pub fn end_with_extended_asm_goto( &self, loc: Option<Location<'ctx>>, asm_template: &str, goto_blocks: &[Block<'ctx>], fallthrough_block: Option<Block<'ctx>> ) -> ExtendedAsm<'ctx>

Trait Implementations

impl<'ctx> Clone for Block<'ctx>

fn clone(&self) -> Block<'ctx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'ctx> Debug for Block<'ctx>

fn fmt<'a>(&self, fmt: &mut Formatter<'a>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'ctx> Hash for Block<'ctx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'ctx> PartialEq for Block<'ctx>

fn eq(&self, other: &Block<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> ToObject<'ctx> for Block<'ctx>

fn to_object(&self) -> Object<'ctx>

impl<'ctx> Copy for Block<'ctx>

impl<'ctx> Eq for Block<'ctx>

impl<'ctx> StructuralPartialEq for Block<'ctx>