Class/Object

firrtl

RenameMap

Related Docs: object RenameMap | package firrtl

Permalink

final class RenameMap extends AnyRef

Map old names to new names

Transforms that modify names should return a RenameMap with the CircuitState These are mutable datastructures for convenience

Source
RenameMap.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenameMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(renameMap: RenameMap): RenameMap

    Permalink

    Create new RenameMap that merges this and renameMap

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def addMap(map: Map[Named, Seq[Named]]): Unit

    Permalink
  6. def andThen(next: RenameMap): RenameMap

    Permalink

    Chain a RenameMap with this RenameMap

    Chain a RenameMap with this RenameMap

    next

    the map to chain with this map

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  7. def apply(t: CompleteTarget): Seq[CompleteTarget]

    Permalink

    Renames a CompleteTarget

    Renames a CompleteTarget

    t

    target to rename

    returns

    renamed targets

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val chained: Option[RenameMap]

    Permalink
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  11. def copy(chained: Option[RenameMap] = chained): RenameMap

    Permalink

    Creates a deep copy of this RenameMap

  12. def delete(names: Seq[String]): Unit

    Permalink

    Records that references in names are all deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last

  13. def delete(name: String): Unit

    Permalink

    Records named reference is deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last

  14. def delete(name: ComponentName): Unit

    Permalink
  15. def delete(name: ModuleName): Unit

    Permalink
  16. def delete(name: CircuitName): Unit

    Permalink
  17. def delete(name: CompleteTarget): Unit

    Permalink

    Records that a CompleteTarget is deleted

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  20. def get(key: Named): Option[Seq[Named]]

    Permalink
  21. def get(key: ComponentName): Option[Seq[ComponentName]]

    Permalink
  22. def get(key: ModuleName): Option[Seq[ModuleName]]

    Permalink
  23. def get(key: CircuitName): Option[Seq[CircuitName]]

    Permalink
  24. def get(key: IsMember): Option[Seq[IsMember]]

    Permalink

    Get renames of a IsMember

    Get renames of a IsMember

    key

    Target referencing the original member of the circuit

    returns

    Optionally return sequence of targets that key remaps to

  25. def get(key: CircuitTarget): Option[Seq[CircuitTarget]]

    Permalink

    Get renames of a CircuitTarget

    Get renames of a CircuitTarget

    key

    Target referencing the original circuit

    returns

    Optionally return sequence of targets that key remaps to

  26. def get(key: CompleteTarget): Option[Seq[CompleteTarget]]

    Permalink

    Get renames of a CircuitTarget

    Get renames of a CircuitTarget

    key

    Target referencing the original circuit

    returns

    Optionally return sequence of targets that key remaps to

  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  28. def getReverseRenameMap: RenameMap

    Permalink
  29. def getUnderlying: Map[CompleteTarget, Seq[CompleteTarget]]

    Permalink

    Returns the underlying map of rename information

  30. def hasChanges: Boolean

    Permalink

    returns

    Whether this RenameMap has collected any changes

  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. def keys: Iterator[CompleteTarget]

    Permalink
  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  37. def record(from: IsMember, tos: Seq[IsMember]): Unit

    Permalink

    Record that the from IsMember is renamed to another sequence of IsMembers

    Record that the from IsMember is renamed to another sequence of IsMembers

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  38. def record(from: IsMember, to: IsMember): Unit

    Permalink

    Record that the from Member is renamed to another IsMember

    Record that the from Member is renamed to another IsMember

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  39. def record(from: CircuitTarget, tos: Seq[CircuitTarget]): Unit

    Permalink

    Record that the from CircuitTarget is renamed to another sequence of CircuitTargets

    Record that the from CircuitTarget is renamed to another sequence of CircuitTargets

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  40. def record(from: CircuitTarget, to: CircuitTarget): Unit

    Permalink

    Record that the from CircuitTarget is renamed to another CircuitTarget

    Record that the from CircuitTarget is renamed to another CircuitTarget

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  41. def recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit

    Permalink

    Records that the keys in map are also renamed to their corresponding value seqs.

    Records that the keys in map are also renamed to their corresponding value seqs. Only (CircuitTarget -> Seq[ CircuitTarget ]) and (IsMember -> Seq[ IsMember ]) key/value allowed

    Note

    Rename to/tos will be made distinct

    ,

    Self renames *will* be recorded

  42. def rename(from: String, tos: Seq[String]): Unit

    Permalink

    Records how a reference maps to a new reference The reference's root module and circuit are determined by whomever called setModule or setCircuit last

  43. def rename(from: String, to: String): Unit

    Permalink

    Records how a reference maps to a new reference

  44. def rename(from: ComponentName, tos: Seq[ComponentName]): Unit

    Permalink
  45. def rename(from: ComponentName, to: ComponentName): Unit

    Permalink
  46. def rename(from: Named, tos: Seq[Named]): Unit

    Permalink
  47. def rename(from: Named, to: Named): Unit

    Permalink
  48. def serialize: String

    Permalink

    Serialize the underlying remapping of keys to new targets

  49. def setCircuit(circuit: String): Unit

    Permalink

    Sets mutable state to record current circuit we are visiting

  50. def setModule(module: String): Unit

    Permalink

    Sets mutable state to record current module we are visiting

  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  53. val underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]

    Permalink
  54. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped