dtzrttp/moonbit-rtl/src/diagnostic

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/diagnostic does not have a README file

Diagnostic

pub(all) struct Diagnostic {
  code : String
  severity : Severity
  message : String
  file : String
  span : @dtzrttp/moonbit-rtl/src/source.Span
Span
  rule : String
  notes : Array[String]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Diagnostic::at_line_col

source

fn Diagnostic::at_line_col(self : Diagnostic, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> (Int, Int)

Diagnostic::column

source

fn Diagnostic::column(self : Diagnostic, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> Int

Diagnostic::is_at_least

source

fn Diagnostic::is_at_least(self : Diagnostic, minimum : Severity) -> Bool

Diagnostic::is_zero_width

source

fn Diagnostic::is_zero_width(self : Diagnostic) -> Bool

Diagnostic::line

source

fn Diagnostic::line(self : Diagnostic, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> Int

Diagnostic::location

source

fn Diagnostic::location(self : Diagnostic, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

Diagnostic::location_key

source

fn Diagnostic::location_key(self : Diagnostic) -> String

Diagnostic::new

source

fn Diagnostic::new(code : String, severity : Severity, message : String, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Diagnostic

Diagnostic::overlaps

source

fn Diagnostic::overlaps(self : Diagnostic, span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Bool

Diagnostic::source_text

source

fn Diagnostic::source_text(self : Diagnostic, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

Diagnostic::with_file

source

fn Diagnostic::with_file(self : Diagnostic, file : String) -> Diagnostic

Diagnostic::with_note

source

fn Diagnostic::with_note(self : Diagnostic, note : String) -> Diagnostic

Add a note while preserving the original diagnostic value.

Diagnostic::with_notes

source

fn Diagnostic::with_notes(self : Diagnostic, notes : Array[String]) -> Diagnostic

Diagnostic::with_rule

source

fn Diagnostic::with_rule(self : Diagnostic, rule : String) -> Diagnostic

DiagnosticReport

source

pub(all) struct DiagnosticReport {
  diagnostics : Array[Diagnostic]
  errors : Int
  warnings : Int
  infos : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

A stable aggregate for a batch of diagnostics.

DiagnosticReport::code_counts

source

fn DiagnosticReport::code_counts(self : DiagnosticReport) -> Array[(String, Int)]

DiagnosticReport::codes

source

fn DiagnosticReport::codes(self : DiagnosticReport) -> Array[String]

DiagnosticReport::deduplicated

source

fn DiagnosticReport::deduplicated(self : DiagnosticReport) -> DiagnosticReport

DiagnosticReport::files

source

fn DiagnosticReport::files(self : DiagnosticReport) -> Array[String]

DiagnosticReport::filter

source

fn DiagnosticReport::filter(self : DiagnosticReport, minimum : Severity) -> DiagnosticReport

DiagnosticReport::for_code

source

fn DiagnosticReport::for_code(self : DiagnosticReport, code : String) -> Array[Diagnostic]

DiagnosticReport::has_errors

source

fn DiagnosticReport::has_errors(self : DiagnosticReport) -> Bool

DiagnosticReport::has_infos

source

fn DiagnosticReport::has_infos(self : DiagnosticReport) -> Bool

DiagnosticReport::has_warnings

source

fn DiagnosticReport::has_warnings(self : DiagnosticReport) -> Bool

DiagnosticReport::highest_severity

source

fn DiagnosticReport::highest_severity(self : DiagnosticReport) -> Severity?

DiagnosticReport::json

source

fn DiagnosticReport::json(self : DiagnosticReport, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

DiagnosticReport::markdown

source

fn DiagnosticReport::markdown(self : DiagnosticReport, title : String) -> String

DiagnosticReport::new

source

fn DiagnosticReport::new(diagnostics : Array[Diagnostic]) -> DiagnosticReport

DiagnosticReport::sarif

source

fn DiagnosticReport::sarif(self : DiagnosticReport, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

DiagnosticReport::summary

source

fn DiagnosticReport::summary(self : DiagnosticReport) -> String

DiagnosticReport::text

source

fn DiagnosticReport::text(self : DiagnosticReport, source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

DiagnosticReport::total

source

fn DiagnosticReport::total(self : DiagnosticReport) -> Int

Severity

source

pub(all) enum Severity {
  Error
  Warning
  Info
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Severity::label

source

fn Severity::label(self : Severity) -> String

annotate

source

fn annotate(diagnostics : Array[Diagnostic], note : String) -> Array[Diagnostic]

Add a note to every diagnostic in a batch.

deduplicate

source

fn deduplicate(diagnostics : Array[Diagnostic]) -> Array[Diagnostic]

Return one copy of each structurally equal diagnostic.

diagnostic_json_line

source

fn diagnostic_json_line(diagnostic : Diagnostic) -> String

diagnostic_summary

source

fn diagnostic_summary(diagnostics : Array[Diagnostic]) -> String

diagnostics_at_line

source

fn diagnostics_at_line(diagnostics : Array[Diagnostic], source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile, line : Int) -> Array[Diagnostic]

diagnostics_for_file

source

fn diagnostics_for_file(diagnostics : Array[Diagnostic], file : String) -> Array[Diagnostic]

diagnostics_have_code

source

fn diagnostics_have_code(diagnostics : Array[Diagnostic], code : String) -> Bool

diagnostics_location_summary

source

fn diagnostics_location_summary(diagnostics : Array[Diagnostic], source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

diagnostics_overlapping

source

fn diagnostics_overlapping(diagnostics : Array[Diagnostic], span : @dtzrttp/moonbit-rtl/src/source.Span
Span) -> Array[Diagnostic]

filter_codes

source

fn filter_codes(diagnostics : Array[Diagnostic], codes : Array[String]) -> Array[Diagnostic]

Return diagnostics whose rule code is in the requested set.

filter_severity

source

fn filter_severity(diagnostics : Array[Diagnostic], minimum : Severity) -> Array[Diagnostic]

Return only diagnostics at or above the requested severity.

group_diagnostics_by_code

source

fn group_diagnostics_by_code(diagnostics : Array[Diagnostic]) -> Array[(String, Int)]

render_diagnostic_table

source

fn render_diagnostic_table(diagnostics : Array[Diagnostic]) -> String

render_graph

source

fn render_graph(index : @dtzrttp/moonbit-rtl/src/semantic.SemanticIndex
SemanticIndex) -> String

Render a semantic dependency index as a Graphviz DOT document.

render_json

source

fn render_json(diagnostics : Array[Diagnostic]) -> String

Render one JSON object per diagnostic for CI and editor integrations.

render_markdown_report

source

fn render_markdown_report(diagnostics : Array[Diagnostic], title : String) -> String

render_report_json

source

fn render_report_json(diagnostics : Array[Diagnostic], source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile, file_name : String) -> String

Render a stable machine-readable report around diagnostics from one source.

render_rule_catalog

source

fn render_rule_catalog(rules : Array[String]) -> String

render_sarif

source

fn render_sarif(diagnostics : Array[Diagnostic], source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

Render diagnostics in the SARIF 2.1.0 shape used by code scanning tools.

render_text

source

fn render_text(diagnostics : Array[Diagnostic], source : @dtzrttp/moonbit-rtl/src/source.SourceFile
SourceFile) -> String

Render diagnostics in a compiler-friendly file:line:column format.

severity_counts

source

fn severity_counts(diagnostics : Array[Diagnostic]) -> (Int, Int, Int)

Count diagnostics by severity in a stable tuple.

stable_diagnostic_order

source

fn stable_diagnostic_order(diagnostics : Array[Diagnostic]) -> Array[Diagnostic]

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

#Diagnostic

#Diagnostic::at_line_col

#Diagnostic::column

#Diagnostic::is_at_least

#Diagnostic::is_zero_width

#Diagnostic::line

#Diagnostic::location

#Diagnostic::location_key

#Diagnostic::new

#Diagnostic::overlaps

#Diagnostic::source_text

#Diagnostic::with_file

#Diagnostic::with_note

#Diagnostic::with_notes

#Diagnostic::with_rule

#DiagnosticReport

#DiagnosticReport::code_counts

#DiagnosticReport::codes

#DiagnosticReport::deduplicated

#DiagnosticReport::files

#DiagnosticReport::filter

#DiagnosticReport::for_code

#DiagnosticReport::has_errors

#DiagnosticReport::has_infos

#DiagnosticReport::has_warnings

#DiagnosticReport::highest_severity

#DiagnosticReport::json

#DiagnosticReport::markdown

#DiagnosticReport::new

#DiagnosticReport::sarif

#DiagnosticReport::summary

#DiagnosticReport::text

#DiagnosticReport::total

#Severity

#Severity::label

#annotate

#deduplicate

#diagnostic_json_line

#diagnostic_summary

#diagnostics_at_line

#diagnostics_for_file

#diagnostics_have_code

#diagnostics_location_summary

#diagnostics_overlapping

#filter_codes

#filter_severity

#group_diagnostics_by_code

#render_diagnostic_table

#render_graph

#render_json

#render_markdown_report

#render_report_json

#render_rule_catalog

#render_sarif

#render_text

#severity_counts

#stable_diagnostic_order

Source Files

Diagnostic

Diagnostic::at_line_col

Diagnostic::column

Diagnostic::is_at_least

Diagnostic::is_zero_width

Diagnostic::line

Diagnostic::location

Diagnostic::location_key

Diagnostic::new

Diagnostic::overlaps

Diagnostic::source_text

Diagnostic::with_file

Diagnostic::with_note

Diagnostic::with_notes

Diagnostic::with_rule

DiagnosticReport

DiagnosticReport::code_counts

DiagnosticReport::codes

DiagnosticReport::deduplicated

DiagnosticReport::files

DiagnosticReport::filter

DiagnosticReport::for_code

DiagnosticReport::has_errors

DiagnosticReport::has_infos

DiagnosticReport::has_warnings

DiagnosticReport::highest_severity

DiagnosticReport::json

DiagnosticReport::markdown

DiagnosticReport::new

DiagnosticReport::sarif

DiagnosticReport::summary

DiagnosticReport::text

DiagnosticReport::total

Severity

Severity::label

annotate

deduplicate

diagnostic_json_line

diagnostic_summary

diagnostics_at_line

diagnostics_for_file

diagnostics_have_code

diagnostics_location_summary

diagnostics_overlapping

filter_codes

filter_severity

group_diagnostics_by_code

render_diagnostic_table

render_graph

render_json

render_markdown_report

render_report_json

render_rule_catalog

render_sarif

render_text

severity_counts

stable_diagnostic_order