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
- Alphabetic
- By Inheritance
- RenameMap
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
++(renameMap: RenameMap): RenameMap
Create new RenameMap that merges this and renameMap
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addMap(map: Map[Named, Seq[Named]]): Unit
- def andThen(next: RenameMap): RenameMap
-
def
apply(t: CompleteTarget): Seq[CompleteTarget]
Renames a CompleteTarget
Renames a CompleteTarget
- t
target to rename
- returns
renamed targets
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val chained: Option[RenameMap]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
copy(chained: Option[RenameMap] = chained): RenameMap
Creates a deep copy of this RenameMap
-
def
delete(names: Seq[String]): Unit
Records that references in names are all deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
-
def
delete(name: String): Unit
Records named reference is deleted The reference's root module and circuit are determined by whomever called setModule or setCircuit last
- def delete(name: ComponentName): Unit
- def delete(name: ModuleName): Unit
- def delete(name: CircuitName): Unit
-
def
delete(name: CompleteTarget): Unit
Records that a CompleteTarget is deleted
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def get(key: Named): Option[Seq[Named]]
- def get(key: ComponentName): Option[Seq[ComponentName]]
- def get(key: ModuleName): Option[Seq[ModuleName]]
- def get(key: CircuitName): Option[Seq[CircuitName]]
-
def
get(key: IsMember): Option[Seq[IsMember]]
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
-
def
get(key: CircuitTarget): Option[Seq[CircuitTarget]]
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
-
def
get(key: CompleteTarget): Option[Seq[CompleteTarget]]
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getReverseRenameMap: RenameMap
-
def
getUnderlying: Map[CompleteTarget, Seq[CompleteTarget]]
Returns the underlying map of rename information
-
def
hasChanges: Boolean
- returns
Whether this RenameMap has collected any changes
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keys: Iterator[CompleteTarget]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
record(from: IsMember, tos: Seq[IsMember]): Unit
Record that the from IsMember is renamed to another sequence of IsMembers
- def record(from: IsMember, to: IsMember): Unit
-
def
record(from: CircuitTarget, tos: Seq[CircuitTarget]): Unit
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
Self renames *will* be recorded
,Rename to/tos will be made distinct
-
def
record(from: CircuitTarget, to: CircuitTarget): Unit
Record that the from CircuitTarget is renamed to another CircuitTarget
Record that the from CircuitTarget is renamed to another CircuitTarget
- Note
Self renames *will* be recorded
,Rename to/tos will be made distinct
-
def
recordAll(map: Map[CompleteTarget, Seq[CompleteTarget]]): Unit
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
Self renames *will* be recorded
,Rename to/tos will be made distinct
-
def
rename(from: String, tos: Seq[String]): Unit
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
-
def
rename(from: String, to: String): Unit
Records how a reference maps to a new reference
- def rename(from: ComponentName, tos: Seq[ComponentName]): Unit
- def rename(from: ComponentName, to: ComponentName): Unit
- def rename(from: Named, tos: Seq[Named]): Unit
- def rename(from: Named, to: Named): Unit
-
def
serialize: String
Serialize the underlying remapping of keys to new targets
-
def
setCircuit(circuit: String): Unit
Sets mutable state to record current circuit we are visiting
-
def
setModule(module: String): Unit
Sets mutable state to record current module we are visiting
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- val underlying: HashMap[CompleteTarget, Seq[CompleteTarget]]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
This is the documentation for Firrtl.