NetlistHierarchyAdapter class

Adapter that exposes a netlist as a source-agnostic hierarchy.

Extends BaseHierarchyAdapter from rohd_hierarchy package, using the shared implementation for search, autocomplete, and lookup methods. Only the netlist format-specific JSON parsing logic is implemented here.

Features:

  • Parses ports, netnames, and cells from netlist JSON
  • Filters auto-generated netnames (hide_name, $-prefixed, port dupes)
  • Extracts port_directions on primitive cells for signal visibility
  • Supports optional root-name override for VCD name alignment
Inheritance

Constructors

NetlistHierarchyAdapter.fromJson(String netlistJson, {String? rootNameOverride})
Convenience factory to parse a netlist JSON string directly.
factory
NetlistHierarchyAdapter.fromMap(Map<String, dynamic> netlistJson, {String? rootNameOverride})
Factory to parse a pre-decoded netlist JSON map.
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
root HierarchyOccurrence
The root occurrence for the hierarchy.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addressToPathname(OccurrenceAddress address, {bool asSignal = false}) String?
Convert a OccurrenceAddress back to a /-separated pathname by walking the tree using child indices.
inherited
autocompletePaths(String partialPath, {int? limit}) List<String>
Autocomplete suggestions for a partial hierarchical path.
inherited
matchOccurrences(String query, {int? limit}) List<HierarchyOccurrence>
Find hierarchy occurrences whose path matches query.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
occurrenceByAddress(OccurrenceAddress address) HierarchyOccurrence?
Find an occurrence by its OccurrenceAddress. O(depth).
inherited
occurrenceByPathname(String pathname) HierarchyOccurrence?
Resolve a /-separated pathname to a HierarchyOccurrence.
inherited
pathnameToAddress(String pathname) OccurrenceAddress?
Convert a pathname (e.g. "Top/sub/clk" or "Top.sub.clk") to a OccurrenceAddress by walking the tree.
inherited
searchOccurrencePaths(String query, {int? limit}) List<String>
Find hierarchical occurrence paths matching query.
inherited
searchOccurrencePathsRegex(String pattern, {int? limit}) List<String>
Search for occurrence paths matching a regex pattern.
inherited
searchOccurrences(String query, {int? limit}) List<OccurrenceSearchResult>
Search for occurrences and return enriched OccurrenceSearchResult objects.
inherited
searchOccurrencesRegex(String pattern, {int? limit}) List<OccurrenceSearchResult>
Search for occurrences by regex pattern and return enriched results.
inherited
searchSignalPaths(String query, {int? limit}) List<String>
Find hierarchical signal paths matching query.
inherited
searchSignalPathsRegex(String pattern, {int? limit}) List<String>
Search for signals whose hierarchical path matches a regex pattern.
inherited
searchSignals(String query, {int? limit}) List<SignalSearchResult>
Search for signals and return enriched SignalSearchResult objects.
inherited
searchSignalsRegex(String pattern, {int? limit}) List<SignalSearchResult>
Search for signals by regex pattern and return enriched results.
inherited
signalByAddress(OccurrenceAddress address) SignalOccurrence?
Find a signal by its OccurrenceAddress.
inherited
toString() String
A string representation of this object.
inherited
waveformIdToAddress(String waveformId) OccurrenceAddress?
Resolve a signal identifier from a VCD or FST waveform file to an OccurrenceAddress.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited