dtzrttp/moonbit-rtl/src/syntax

README
- ::fileAnalysis::file
- ::is_validAnalysis::is_valid
- ::module_countAnalysis::module_count
- ::parseAnalysis::parse
- ::semanticAnalysis::semantic
V
analyze_file
V
analyze_text

dtzrttp/moonbit-rtl/src/syntax does not have a README file

AlwaysBlock

pub(all) struct AlwaysBlock {
  sensitivity : Array[Sensitivity]
  body : Statement
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

CaseArm

source

pub(all) struct CaseArm {
  choices : Array[Expression]
  body : Statement
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Connection

source

pub(all) struct Connection {
  port_name : String?
  expression : Expression
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ContinuousAssign

source

pub(all) struct ContinuousAssign {
  target : Expression
  value : Expression
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ContinuousAssign::new

source

fn ContinuousAssign::new(target : Expression, value : Expression, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> ContinuousAssign

Design

source

pub(all) struct Design {
  modules : Array[Module]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Design::find_module

source

fn Design::find_module(self : Design, name : String) -> Module?

Find a module in a design by name.

Design::item_count

source

fn Design::item_count(self : Design) -> Int

Count module items across a design.

Design::metrics

source

fn Design::metrics(self : Design) -> DesignMetrics

Design::module_names

source

fn Design::module_names(self : Design) -> Array[String]

Return module names in declaration order.

Design::new

source

fn Design::new(modules : Array[Module]) -> Design

DesignMetrics

source

pub(all) struct DesignMetrics {
  modules : Int
  ports : Int
  signals : Int
  assignments : Int
  always_blocks : Int
  instances : Int
  expressions : Int
  statements : Int
  maximum_control_depth : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Direction

source

pub(all) enum Direction {
  Input
  Output
  Inout
  Unspecified
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

EdgeKind

source

pub(all) enum EdgeKind {
  Any
  Posedge
  Negedge
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Expression

source

pub(all) enum Expression {
  Name(String, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Number(String, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  StringLiteral(String, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Unary(String, Expression, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Binary(Expression, String, Expression, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Index(Expression, Expression, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Unknown(@dtzrttp/moonbit-rtl/src/source.Span
Span)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Expression::binary

source

fn Expression::binary(left : Expression, operator : String, right : Expression, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Expression

Expression::contains_name

source

fn Expression::contains_name(self : Expression, wanted : String) -> Bool

Return whether an expression contains a reference to a name.

Expression::name

source

fn Expression::name(name : String, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Expression

Expression::name_text

source

fn Expression::name_text(self : Expression) -> String?

Return the referenced name when an expression is a plain name.

Expression::node_count

source

fn Expression::node_count(self : Expression) -> Int

Count expression nodes in source order.

Expression::number

source

fn Expression::number(value : String, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Expression

Expression::referenced_names

source

fn Expression::referenced_names(self : Expression) -> Array[String]

Expression::span

source

fn Expression::span(self : Expression) -> @dtzrttp/moonbit-rtl/src/source.Span
Span

Expression::string

source

fn Expression::string(value : String, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Expression

Instance

source

pub(all) struct Instance {
  module_name : String
  instance_name : String
  connections : Array[Connection]
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Module

source

pub(all) struct Module {
  name : String
  ports : Array[Port]
  signals : Array[Signal]
  items : Array[ModuleItem]
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Module::assignment_count

source

fn Module::assignment_count(self : Module) -> Int

Module::find_port

source

fn Module::find_port(self : Module, name : String) -> Port?

Find a port by name without exposing the representation to callers.

Module::find_signal

source

fn Module::find_signal(self : Module, name : String) -> Signal?

Find a declared signal by name.

Module::instance_names

source

fn Module::instance_names(self : Module) -> Array[String]

Return instance names in declaration order.

Module::new

source

fn Module::new(name : String, ports : Array[Port], signals : Array[Signal], items : Array[ModuleItem], span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Module

Module::port_names

source

fn Module::port_names(self : Module) -> Array[String]

Module::signal_count

source

fn Module::signal_count(self : Module) -> Int

ModuleItem

source

pub(all) enum ModuleItem {
  Assign(ContinuousAssign)
  Always(AlwaysBlock)
  Instance(Instance)
  Statement(Statement)
  Unknown(@dtzrttp/moonbit-rtl/src/source.Span
Span)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

NetType

source

pub(all) enum NetType {
  Wire
  Reg
  Logic
  Unspecified
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Port

source

pub(all) struct Port {
  name : String
  direction : Direction
  width : Range?
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Port::new

source

fn Port::new(name : String, direction : Direction, width : Range?, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Port

Range

source

pub(all) struct Range {
  msb : Int
  lsb : Int
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Range::new

source

fn Range::new(msb : Int, lsb : Int, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Range

Range::width

source

fn Range::width(self : Range) -> Int?

Sensitivity

source

pub(all) struct Sensitivity {
  edge : EdgeKind
  expression : Expression
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Signal

source

pub(all) struct Signal {
  name : String
  net_type : NetType
  width : Range?
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Signal::new

source

fn Signal::new(name : String, net_type : NetType, width : Range?, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Signal

Statement

source

pub(all) enum Statement {
  Empty(@dtzrttp/moonbit-rtl/src/source.Span
Span)
  Block(Array[Statement], @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Assignment(Expression, Expression, Bool, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  If(Expression, Statement, Statement?, @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Case(Expression, Array[CaseArm], @dtzrttp/moonbit-rtl/src/source.Span
Span)
  Unknown(@dtzrttp/moonbit-rtl/src/source.Span
Span)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Statement::assigned_names

source

fn Statement::assigned_names(self : Statement) -> Array[String]

Statement::control_depth

source

fn Statement::control_depth(self : Statement) -> Int

Statement::node_count

source

fn Statement::node_count(self : Statement) -> Int

Count statements recursively, including block and branch nodes.

Statement::read_names

source

fn Statement::read_names(self : Statement) -> Array[String]

Statement::span

source

fn Statement::span(self : Statement) -> @dtzrttp/moonbit-rtl/src/source.Span
Span

visit_design

source

fn visit_design(design : Design, visit : (String) -> Unit) -> Unit

Source Files

Install

Download zip

A Verilog-2001 RTL parser, hierarchy analyzer, and lint tool written in MoonBit.

verilogrtllintparserhardware

dtzrttp

Apache-2.0

github.com/dtzrttp/moonbit-rtl

Updated 2 months ago

66 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#AlwaysBlock

#CaseArm

#Connection

#ContinuousAssign

#ContinuousAssign::new

#Design

#Design::find_module

#Design::item_count

#Design::metrics

#Design::module_names

#Design::new

#DesignMetrics

#Direction

#EdgeKind

#Expression

#Expression::binary

#Expression::contains_name

#Expression::name

#Expression::name_text

#Expression::node_count

#Expression::number

#Expression::referenced_names

#Expression::span

#Expression::string

#Instance

#Module

#Module::assignment_count

#Module::find_port

#Module::find_signal

#Module::instance_names

#Module::new

#Module::port_names

#Module::signal_count

#ModuleItem

#NetType

#Port

#Port::new

#Range

#Range::new

#Range::width

#Sensitivity

#Signal

#Signal::new

#Statement

#Statement::assigned_names

#Statement::control_depth

#Statement::node_count

#Statement::read_names

#Statement::span

#visit_design

Source Files

AlwaysBlock

CaseArm

Connection

ContinuousAssign

ContinuousAssign::new

Design

Design::find_module

Design::item_count

Design::metrics

Design::module_names

Design::new

DesignMetrics

Direction

EdgeKind

Expression

Expression::binary

Expression::contains_name

Expression::name

Expression::name_text

Expression::node_count

Expression::number

Expression::referenced_names

Expression::span

Expression::string

Instance

Module

Module::assignment_count

Module::find_port

Module::find_signal

Module::instance_names

Module::new

Module::port_names

Module::signal_count

ModuleItem

NetType

Port

Port::new

Range

Range::new

Range::width

Sensitivity

Signal

Signal::new

Statement

Statement::assigned_names

Statement::control_depth

Statement::node_count

Statement::read_names

Statement::span

visit_design