Struct cranelift_codegen::cursor::FuncCursor

pub struct FuncCursor<'f> {
    pub func: &'f mut Function,
    /* private fields */
}

Function cursor.

A FuncCursor holds a mutable reference to a whole ir::Function while keeping a position too. The function can be re-borrowed by accessing the public cur.func member.

This cursor is for use before legalization. The inserted instructions are not given an encoding.

Fields

func: &'f mut Function

The referenced function.

Implementations

impl<'f> FuncCursor<'f>

pub fn new(func: &'f mut Function) -> Self

Create a new FuncCursor pointing nowhere.

pub fn use_srcloc(&mut self, inst: Inst)

Use the source location of inst for future instructions.

pub fn ins(&mut self) -> InsertBuilder<'_, &mut FuncCursor<'f>>

Create an instruction builder that inserts an instruction at the current position.

Trait Implementations

impl<'f> Cursor for FuncCursor<'f>

fn position(&self) -> CursorPosition

Get the current cursor position.

fn set_position(&mut self, pos: CursorPosition)

Set the current position.

fn srcloc(&self) -> SourceLoc

Get the source location that should be assigned to new instructions.

fn set_srcloc(&mut self, srcloc: SourceLoc)

Set the source location that should be assigned to new instructions.

fn layout(&self) -> &Layout

Borrow a reference to the function layout that this cursor is navigating.

fn layout_mut(&mut self) -> &mut Layout

Borrow a mutable reference to the function layout that this cursor is navigating.

fn with_srcloc(self, srcloc: SourceLoc) -> Selfwhere
    Self: Sized,

Exchange this cursor for one with a set source location.

fn at_position(self, pos: CursorPosition) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at pos.

fn at_inst(self, inst: Inst) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at inst.

fn at_first_insertion_point(self, ebb: Ebb) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at the first insertion point for ebb. This differs from at_first_inst in that it doesn’t assume that any instructions have been inserted into ebb yet.

fn at_first_inst(self, ebb: Ebb) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at the first instruction in ebb.

fn at_last_inst(self, ebb: Ebb) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at the last instruction in ebb.

fn after_inst(self, inst: Inst) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned after inst.

fn at_top(self, ebb: Ebb) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at the top of ebb.

fn at_bottom(self, ebb: Ebb) -> Selfwhere
    Self: Sized,

Rebuild this cursor positioned at the bottom of ebb.

fn current_ebb(&self) -> Option<Ebb>

Get the EBB corresponding to the current position.

fn current_inst(&self) -> Option<Inst>

Get the instruction corresponding to the current position, if any.

fn goto_after_inst(&mut self, inst: Inst)

Go to the position after a specific instruction, which must be inserted in the layout. New instructions will be inserted after inst.

fn goto_inst(&mut self, inst: Inst)

Go to a specific instruction which must be inserted in the layout. New instructions will be inserted before inst.

fn goto_first_insertion_point(&mut self, ebb: Ebb)

Go to the position for inserting instructions at the beginning of ebb, which unlike goto_first_inst doesn’t assume that any instructions have been inserted into ebb yet.

fn goto_first_inst(&mut self, ebb: Ebb)

Go to the first instruction in ebb.

fn goto_last_inst(&mut self, ebb: Ebb)

Go to the last instruction in ebb.

fn goto_top(&mut self, ebb: Ebb)

Go to the top of ebb which must be inserted into the layout. At this position, instructions cannot be inserted, but next_inst() will move to the first instruction in ebb.

fn goto_bottom(&mut self, ebb: Ebb)

Go to the bottom of ebb which must be inserted into the layout. At this position, inserted instructions will be appended to ebb.

fn next_ebb(&mut self) -> Option<Ebb>

Go to the top of the next EBB in layout order and return it.

fn prev_ebb(&mut self) -> Option<Ebb>

Go to the bottom of the previous EBB in layout order and return it.

fn next_inst(&mut self) -> Option<Inst>

Move to the next instruction in the same EBB and return it.

fn prev_inst(&mut self) -> Option<Inst>

Move to the previous instruction in the same EBB and return it.

fn insert_inst(&mut self, inst: Inst)

Insert an instruction at the current position.

fn remove_inst(&mut self) -> Inst

Remove the instruction under the cursor.

fn remove_inst_and_step_back(&mut self) -> Inst

Remove the instruction under the cursor.

fn insert_ebb(&mut self, new_ebb: Ebb)

Insert an EBB at the current position and switch to it.

impl<'c, 'f> InstInserterBase<'c> for &'c mut FuncCursor<'f>

fn data_flow_graph(&self) -> &DataFlowGraph

Get an immutable reference to the data flow graph.

fn data_flow_graph_mut(&mut self) -> &mut DataFlowGraph

Get a mutable reference to the data flow graph.

fn insert_built_inst(self, inst: Inst, _: Type) -> &'c mut DataFlowGraph

Insert a new instruction which belongs to the DFG.