Struct libreda_db::undo::Undo

pub struct Undo<'a, T, U> { /* fields omitted */ }

Wrapper around netlist, layout and L2N structures that allows undoing of operations.

Implementations

impl<'a, T, U> Undo<'a, T, U>

pub fn num_transactions(&self) -> usize

Return the number of undoable transactions.

pub fn flush(&mut self)

Clear the undo buffer and make changes permanent.

impl<'a, T: L2NEdit> Undo<'a, T, L2NUndoOp<T>>

pub fn undo_l2n(chip: &'a mut T) -> Self

Create a wrapper around a fused layout and netlist which allows to undo operations.

pub fn undo(&mut self)

Undo the latest transaction. Does nothing if there’s no transaction left to be undone.

impl<'a, T: LayoutEdit> Undo<'a, T, LayoutUndoOp<T>>

pub fn undo_layout(chip: &'a mut T) -> Self

Create a wrapper which allows to undo operations performed on the LayoutEdit trait.

pub fn undo(&mut self)

Undo the latest transaction. Does nothing if there’s no transaction left to be undone.

impl<'a, T: NetlistEdit> Undo<'a, T, NetlistUndoOp<T>>

pub fn undo_netlist(chip: &'a mut T) -> Self

Create a wrapper which allows to undo operations performed on the NetlistEdit trait.

pub fn undo(&mut self)

Undo the latest transaction. Does nothing if there’s no transaction left to be undone.

impl<'a, T: HierarchyEdit> Undo<'a, T, HierarchyUndoOp<T>>

pub fn undo_hierarchy(chip: &'a mut T) -> Self

Create a wrapper which allows to undo operations performed on the HierarchyEdit trait.

pub fn undo(&mut self)

Undo the latest transaction. Does nothing if there’s no transaction left to be undone.

pub fn undo_all(&mut self)

Undoes all transactions.

Trait Implementations

impl<'a, T, U> Deref for Undo<'a, T, U>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: HierarchyBase, U> HierarchyBase for Undo<'a, T, U>

type NameType = T::NameType

Type for names of cells, instances, etc.

type CellId = T::CellId

Cell/module identifier type.

type CellInstId = T::CellInstId

Cell instance identifier type.

fn cell_by_name(&self, name: &str) -> Option<Self::CellId>

Find a cell by its name. Return the cell with the given name. Returns None if the cell does not exist.

fn cell_instance_by_name(
    &self,
    parent_cell: &Self::CellId,
    name: &str
) -> Option<Self::CellInstId>

Find a cell instance by its name. Returns None if the name does not exist.

fn cell_name(&self, cell: &Self::CellId) -> Self::NameType

Get the name of the cell.

fn cell_instance_name(
    &self,
    cell_inst: &Self::CellInstId
) -> Option<Self::NameType>

Get the name of the cell instance.

fn parent_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the parent cell of this instance.

fn template_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the template cell of this instance.

fn for_each_cell<F>(&self, f: F) where
    F: FnMut(Self::CellId), 

Call a function on each cell of the netlist.

fn for_each_cell_instance<F>(&self, cell: &Self::CellId, f: F) where
    F: FnMut(Self::CellInstId), 

Call a function on each instance in this cell.

fn for_each_cell_dependency<F>(&self, cell: &Self::CellId, f: F) where
    F: FnMut(Self::CellId), 

Call a function for each cell that is a child of this cell.

fn for_each_dependent_cell<F>(&self, cell: &Self::CellId, f: F) where
    F: FnMut(Self::CellId), 

Call a function for each cell that directly depends on cell.

fn for_each_cell_reference<F>(&self, cell: &Self::CellId, f: F) where
    F: FnMut(Self::CellInstId), 

Iterate over all instances of this cell, i.e. instances that use this cell as a template.

fn num_child_instances(&self, cell: &Self::CellId) -> usize

Get the number of cell instances inside the cell.

fn num_cells(&self) -> usize

Get the number of cell templates.

fn each_cell_vec(&self) -> Vec<Self::CellId>

Get a Vec of all cell IDs in this netlist.

fn each_cell(&self) -> Box<dyn Iterator<Item = Self::CellId>>

Iterate over all cells.

fn each_cell_instance_vec(&self, cell: &Self::CellId) -> Vec<Self::CellInstId>

Get a Vec of the IDs of all instances in this cell.

fn each_cell_instance(
    &self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellInstId>>

Iterate over all instances in a cell.

fn each_cell_dependency_vec(&self, cell: &Self::CellId) -> Vec<Self::CellId>

Get a Vec of each cell that is a child of this cell.

fn each_cell_dependency<'a>(
    &'a self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellId> + 'a>

Iterate over all cells that are instantiated in this cell.

fn num_cell_dependencies(&self, cell: &Self::CellId) -> usize

Count all cells that are dependencies of cell.

fn each_dependent_cell_vec(&self, cell: &Self::CellId) -> Vec<Self::CellId>

Get a Vec of each cell that directly depends on cell.

fn each_dependent_cell<'a>(
    &'a self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellId> + 'a>

Iterate over each cell that directly depends on cell.

fn num_dependent_cells(&self, cell: &Self::CellId) -> usize

Count all cells that are directly dependent on cell, i.e. contain an instance of cell.

fn each_cell_reference_vec(&self, cell: &Self::CellId) -> Vec<Self::CellInstId>

Get a Vec with all cell instances referencing this cell.

fn each_cell_reference(
    &self,
    cell: &Self::CellId
) -> Box<dyn Iterator<Item = Self::CellInstId>>

Iterate over all instances of this cell, i.e. instances that use this cell as a template.

fn num_cell_references(&self, cell: &Self::CellId) -> usize

Count all instantiations of cell.

fn get_chip_property(&self, key: &Self::NameType) -> Option<PropertyValue>

Get a property of the top-level chip data structure.

fn get_cell_property(
    &self,
    cell: &Self::CellId,
    key: &Self::NameType
) -> Option<PropertyValue>

Get a property of a cell.

fn get_cell_instance_property(
    &self,
    inst: &Self::CellInstId,
    key: &Self::NameType
) -> Option<PropertyValue>

Get a property of a cell instance.

impl<'a, T: HierarchyEdit, U: From<HierarchyUndoOp<T>>> HierarchyEdit for Undo<'a, T, U>

fn new() -> Self

Create a new empty data structure.

fn create_cell(&mut self, name: Self::NameType) -> Self::CellId

Create a new and empty cell template. A cell template can be be instantiated in other cells.

fn remove_cell(&mut self, _cell_id: &Self::CellId)

Remove a cell and all the instances of it.

fn create_cell_instance(
    &mut self,
    parent_cell: &Self::CellId,
    template_cell: &Self::CellId,
    name: Option<Self::NameType>
) -> Self::CellInstId

Create a new instance of template_cell in parent_cell. Recursive instantiation is forbidden and might panic.

fn remove_cell_instance(&mut self, _inst: &Self::CellInstId)

Remove cell instance if it exists.

fn rename_cell_instance(
    &mut self,
    inst: &Self::CellInstId,
    new_name: Option<Self::NameType>
)

Change the name of a cell instance.

fn rename_cell(&mut self, cell: &Self::CellId, new_name: Self::NameType)

Change the name of a cell.

fn set_chip_property(&mut self, key: Self::NameType, value: PropertyValue)

Set a property of the top-level chip data structure..

fn set_cell_property(
    &mut self,
    cell: &Self::CellId,
    key: Self::NameType,
    value: PropertyValue
)

Set a property of a cell.

fn set_cell_instance_property(
    &mut self,
    inst: &Self::CellInstId,
    key: Self::NameType,
    value: PropertyValue
)

Set a property of a cell instance.

impl<'a, T: LayoutBase, U> LayoutBase for Undo<'a, T, U>

type Coord = T::Coord

Number type used for coordinates.

type LayerId = T::LayerId

Layer identifier type.

type ShapeId = T::ShapeId

Shape identifier type.

fn dbu(&self) -> Self::Coord

Get the distance unit used in this layout in ‘pixels per micron’.

fn each_layer(&self) -> Box<dyn Iterator<Item = Self::LayerId>>

Iterate over all defined layers.

fn layer_info(&self, layer: &Self::LayerId) -> &LayerInfo<Self::NameType>

Get the LayerInfo data structure for this layer.

fn find_layer(&self, index: u32, datatype: u32) -> Option<Self::LayerId>

Find layer index by the (index, data type) tuple.

fn layer_by_name(&self, name: &str) -> Option<Self::LayerId>

Find layer index by the name.

fn bounding_box_per_layer(
    &self,
    cell: &Self::CellId,
    layer: &Self::LayerId
) -> Option<Rect<Self::Coord>>

Compute the bounding box of the shapes on one layer. The bounding box also includes all child cell instances.

fn each_shape_id(
    &self,
    cell: &Self::CellId,
    layer: &Self::LayerId
) -> Box<dyn Iterator<Item = Self::ShapeId>>

Iterate over the IDs of all shapes in the cell on a specific layer.

fn for_each_shape<F>(&self, cell: &Self::CellId, layer: &Self::LayerId, f: F) where
    F: FnMut(&Self::ShapeId, &Geometry<Self::Coord>), 

Call a function for each shape on this layer.

fn with_shape<F, R>(&self, shape_id: &Self::ShapeId, f: F) -> R where
    F: FnMut(&Self::LayerId, &Geometry<Self::Coord>) -> R, 

Access a shape by its ID.

fn parent_of_shape(
    &self,
    shape_id: &Self::ShapeId
) -> (Self::CellId, Self::LayerId)

Get the parent cell and the layer of a shape as a (cell, layer) tuple.

fn get_transform(
    &self,
    cell_inst: &Self::CellInstId
) -> SimpleTransform<Self::Coord>

Get the geometric transform that describes the location of a cell instance relative to its parent.

fn bounding_box(&self, cell: &Self::CellId) -> Option<Rect<Self::Coord>>

Compute the bounding box of the cell over all layers. The bounding box is not defined if the cell is empty. In this case return None.

fn for_each_shape_recursive<F>(
    &self,
    cell: &Self::CellId,
    layer: &Self::LayerId,
    f: F
) where
    F: FnMut(SimpleTransform<Self::Coord>, &Self::ShapeId, &Geometry<Self::Coord>), 

Call a function f for each shape of this cell and its sub cells. Along to the geometric shape f also gets a transformation as argument. The transformation describes the actual position of the geometric shape relative to the cell.

fn get_shape_property(
    &mut self,
    shape: &Self::ShapeId,
    key: &Self::NameType
) -> Option<PropertyValue>

Get a property of a shape.

impl<'a, T, U> LayoutEdit for Undo<'a, T, U> where
    T: LayoutEdit,
    U: From<LayoutUndoOp<T>> + From<HierarchyUndoOp<T>>, 

fn set_dbu(&mut self, dbu: Self::Coord)

Set the distance unit used in this layout in ‘pixels per micron’.

fn create_layer(&mut self, index: u32, datatype: u32) -> Self::LayerId

Create a new layer. Use set_layer_name() to define a name.

fn set_layer_name(
    &mut self,
    layer: &Self::LayerId,
    name: Option<Self::NameType>
) -> Option<Self::NameType>

Set the name of a layer or clear the layer name when passing None. This method should not change the ID of the layer. Returns the previous name of the layer.

fn insert_shape(
    &mut self,
    parent_cell: &T::CellId,
    layer: &T::LayerId,
    geometry: Geometry<Self::Coord>
) -> Self::ShapeId

Insert a geometric shape into the parent cell.

fn remove_shape(
    &mut self,
    shape_id: &Self::ShapeId
) -> Option<Geometry<Self::Coord>>

Remove shape from the parent cell.

fn replace_shape(
    &mut self,
    shape_id: &Self::ShapeId,
    geometry: Geometry<Self::Coord>
) -> Geometry<Self::Coord>

Replace the geometry of a shape.

fn set_transform(
    &mut self,
    cell_inst: &Self::CellInstId,
    tf: SimpleTransform<Self::Coord>
)

Set the geometric transform that describes the location of a cell instance relative to its parent.

fn set_shape_property(
    &mut self,
    shape: &Self::ShapeId,
    key: Self::NameType,
    _value: PropertyValue
)

Set a property of a shape.

fn find_or_create_layer(&mut self, index: UInt, datatype: UInt) -> Self::LayerId

Create a layer or return an existing one.

impl<'a, T: NetlistBase, U> NetlistBase for Undo<'a, T, U>

type PinId = T::PinId

Pin identifier type. Uniquely identifies a pin in the whole netlist.

type PinInstId = T::PinInstId

Pin instance identifier type. Uniquely identifies a pin instance in the whole netlist. A pin instance is a pin of a circuit instance.

type NetId = T::NetId

Net identifier type. Uniquely identifies a net in the whole netlist.

fn template_pin(&self, pin_instance: &Self::PinInstId) -> Self::PinId

Get the ID of the template pin of this pin instance.

fn pin_direction(&self, pin: &Self::PinId) -> Direction

Get the signal direction of the pin.

fn pin_name(&self, pin: &Self::PinId) -> Self::NameType

Get the name of the pin.

fn pin_by_name(
    &self,
    parent_circuit: &Self::CellId,
    name: &str
) -> Option<Self::PinId>

Find a pin by its name. Returns None if no such pin can be found.

fn parent_cell_of_pin(&self, pin: &Self::PinId) -> Self::CellId

Get the ID of the parent circuit of this pin.

fn parent_of_pin_instance(&self, pin_inst: &Self::PinInstId) -> Self::CellInstId

Get the ID of the circuit instance that holds this pin instance.

fn parent_cell_of_net(&self, net: &Self::NetId) -> Self::CellId

Get the ID of the parent circuit of this net.

fn net_of_pin(&self, pin: &Self::PinId) -> Option<Self::NetId>

Get the internal net attached to this pin.

fn net_of_pin_instance(
    &self,
    pin_instance: &Self::PinInstId
) -> Option<Self::NetId>

Get the external net attached to this pin instance.

fn net_zero(&self, parent_circuit: &Self::CellId) -> Self::NetId

Get the net of the logical constant zero.

fn net_one(&self, parent_circuit: &Self::CellId) -> Self::NetId

Get the net of the logical constant one.

fn net_by_name(
    &self,
    parent_circuit: &Self::CellId,
    name: &str
) -> Option<Self::NetId>

Find a net by its name inside the parent circuit. Returns None if no such net can be found.

fn net_name(&self, net: &Self::NetId) -> Option<Self::NameType>

Get the name of the net.

fn for_each_pin<F>(&self, circuit: &Self::CellId, f: F) where
    F: FnMut(Self::PinId), 

Call a function for each pin of the circuit.

fn for_each_pin_instance<F>(&self, circuit_inst: &Self::CellInstId, f: F) where
    F: FnMut(Self::PinInstId), 

Call a function for each pin instance of the circuit instance.

fn for_each_internal_net<F>(&self, circuit: &Self::CellId, f: F) where
    F: FnMut(Self::NetId), 

Call a function for net of the circuit.

fn num_pins(&self, circuit: &Self::CellId) -> usize

Get the number of pins of a circuit.

fn for_each_pin_of_net<F>(&self, net: &Self::NetId, f: F) where
    F: FnMut(Self::PinId), 

Call a function for each pin connected to this net.

fn for_each_pin_instance_of_net<F>(&self, net: &Self::NetId, f: F) where
    F: FnMut(Self::PinInstId), 

Call a function for each pin instance connected to this net.

fn pin_instance(
    &self,
    cell_inst: &Self::CellInstId,
    pin: &Self::PinId
) -> Self::PinInstId

Get the ID of a pin instance given the cell instance and the pin ID.

fn net_of_terminal(&self, terminal: &TerminalId<Self>) -> Option<Self::NetId>

Get the net that is attached to this terminal.

fn each_pin_vec(&self, circuit: &Self::CellId) -> Vec<Self::PinId>

Get a Vec with the IDs of all pins of this circuit.

fn each_pin<'a>(
    &'a self,
    circuit: &Self::CellId
) -> Box<dyn Iterator<Item = Self::PinId> + 'a>

Iterate over all pins of a circuit.

fn each_pin_instance_vec(
    &self,
    circuit_instance: &Self::CellInstId
) -> Vec<Self::PinInstId>

Get a Vec with the IDs of all pin instance of this circuit instance.

fn each_pin_instance<'a>(
    &'a self,
    circuit_instance: &Self::CellInstId
) -> Box<dyn Iterator<Item = Self::PinInstId> + 'a>

Iterate over all pin instances of a circuit.

fn each_external_net<'a>(
    &'a self,
    circuit_instance: &Self::CellInstId
) -> Box<dyn Iterator<Item = Self::NetId> + 'a>

Iterate over all external nets connected to the circuit instance. A net might appear more than once.

fn for_each_external_net<F>(&self, circuit_instance: &Self::CellInstId, f: F) where
    F: FnMut(Self::NetId), 

Iterate over all external nets connected to the circuit instance. A net might appear more than once.

fn each_external_net_vec(
    &self,
    circuit_instance: &Self::CellInstId
) -> Vec<Self::NetId>

Get a vector of all external nets connected to the circuit instance. A net might appear more than once.

fn each_internal_net_vec(&self, circuit: &Self::CellId) -> Vec<Self::NetId>

Get a Vec with all nets in this circuit.

fn each_internal_net<'a>(
    &'a self,
    circuit: &Self::CellId
) -> Box<dyn Iterator<Item = Self::NetId> + 'a>

Iterate over all defined nets inside a circuit.

fn num_internal_nets(&self, circuit: &Self::CellId) -> usize

Return the number of nets defined inside a cell.

fn num_net_pins(&self, net: &Self::NetId) -> usize

Get the number of pins that are connected to this net.

fn num_net_pin_instances(&self, net: &Self::NetId) -> usize

Get the number of pin instances that are connected to this net.

fn num_net_terminals(&self, net: &Self::NetId) -> usize

Get the number of terminals that are connected to this net.

fn each_pin_of_net_vec(&self, net: &Self::NetId) -> Vec<Self::PinId>

Get a Vec with all pin IDs connected to this net.

fn each_pin_of_net<'a>(
    &'a self,
    net: &Self::NetId
) -> Box<dyn Iterator<Item = Self::PinId> + 'a>

Iterate over all pins of a net.

fn each_pin_instance_of_net_vec(
    &self,
    net: &Self::NetId
) -> Vec<Self::PinInstId>

Get a Vec with all pin instance IDs connected to this net.

fn each_pin_instance_of_net<'a>(
    &'a self,
    net: &Self::NetId
) -> Box<dyn Iterator<Item = Self::PinInstId> + 'a>

Iterate over all pins of a net.

fn for_each_terminal_of_net<F>(&self, net: &Self::NetId, f: F) where
    F: FnMut(TerminalId<Self>), 

Call a function for each terminal connected to this net.

fn each_terminal_of_net_vec(&self, net: &Self::NetId) -> Vec<TerminalId<Self>>

Get a Vec with all terminal IDs connected to this net.

fn each_terminal_of_net<'a>(
    &'a self,
    net: &Self::NetId
) -> Box<dyn Iterator<Item = TerminalId<Self>> + 'a>

Iterate over all terminals of a net.

impl<'a, T, U> NetlistEdit for Undo<'a, T, U> where
    T: NetlistEdit,
    U: From<NetlistUndoOp<T>> + From<HierarchyUndoOp<T>>, 

fn create_pin(
    &mut self,
    circuit: &Self::CellId,
    name: Self::NameType,
    direction: Direction
) -> Self::PinId

Create a new pin in this circuit. Also adds the pin to all instances of the circuit.

fn remove_pin(&mut self, _id: &Self::PinId)

Remove the pin from this circuit and from all instances of this circuit.

fn rename_pin(
    &mut self,
    pin: &Self::PinId,
    new_name: Self::NameType
) -> Self::NameType

Change the name of the pin, returns the old name.

fn create_net(
    &mut self,
    parent: &Self::CellId,
    name: Option<Self::NameType>
) -> Self::NetId

Create a net net that lives in the parent circuit.

fn rename_net(
    &mut self,
    net_id: &Self::NetId,
    new_name: Option<Self::NameType>
) -> Option<Self::NameType>

Set a new name for the net. This might panic if the name already exists. Returns the old name.

fn remove_net(&mut self, _net: &Self::NetId)

Delete the net if it exists and disconnect all connected terminals.

fn connect_pin(
    &mut self,
    pin: &Self::PinId,
    net: Option<Self::NetId>
) -> Option<Self::NetId>

Connect a pin to a net. Returns the old connected net, if any.

fn connect_pin_instance(
    &mut self,
    pin: &Self::PinInstId,
    net: Option<Self::NetId>
) -> Option<Self::NetId>

Connect a pin instance to a net. Returns the old connected net, if any.

fn disconnect_pin(&mut self, pin: &Self::PinId) -> Option<Self::NetId>

Disconnect the pin from any connected net. Returns the old connected net, if any.

fn disconnect_pin_instance(
    &mut self,
    pin_instance: &Self::PinInstId
) -> Option<Self::NetId>

Disconnect the pin instance from any connected net. Returns the old connected net, if any.

fn connect_terminal(
    &mut self,
    terminal: &TerminalId<Self>,
    net: Option<Self::NetId>
) -> Option<Self::NetId>

Connect a terminal to a net. Returns the old connected net, if any.

fn disconnect_terminal(
    &mut self,
    terminal: &TerminalId<Self>
) -> Option<Self::NetId>

Disconnect the terminal from any connected net. Returns the old connected net, if any.