Skip to content

Commit

Permalink
Refactor line adjustment logic
Browse files Browse the repository at this point in the history
  • Loading branch information
@dalance
dalance committed Apr 22, 2024
1 parent 013e4d3 commit 32a34f9
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 45 deletions.
62 changes: 34 additions & 28 deletions crates/emitter/src/emitter.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ use veryl_parser::veryl_token::{Token, TokenSource, VerylToken};
use veryl_parser::veryl_walker::VerylWalker;
use veryl_parser::Stringifier;

#[cfg(target_os = "windows")]
const NEWLINE: &str = "\r\n";
#[cfg(not(target_os = "windows"))]
const NEWLINE: &str = "\n";

pub enum AttributeType {
Ifdef,
Sv,
Expand All @@ -28,7 +33,6 @@ pub struct Emitter {
indent: usize,
line: u32,
aligner: Aligner,
last_newline: u32,
in_start_token: bool,
consumed_next_newline: bool,
single_line: bool,
Expand Down Expand Up @@ -56,7 +60,6 @@ impl Default for Emitter {
indent: 0,
line: 1,
aligner: Aligner::new(),
last_newline: 0,
in_start_token: false,
consumed_next_newline: false,
single_line: false,
Expand Down Expand Up @@ -126,7 +129,7 @@ impl Emitter {
fn newline_push(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand All @@ -138,7 +141,7 @@ impl Emitter {
fn newline_pop(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand All @@ -150,7 +153,7 @@ impl Emitter {
fn newline(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand Down Expand Up @@ -178,21 +181,29 @@ impl Emitter {
self.str(&" ".repeat(repeat));
}

fn push_token(&mut self, x: &Token) {
fn consume_adjust_line(&mut self, x: &Token) {
if self.adjust_line && x.line > self.line + 1 {
self.newline();
}
self.adjust_line = false;
}

fn clear_adjust_line(&mut self) {
self.adjust_line = false;
}

fn push_token(&mut self, x: &Token) {
self.consume_adjust_line(x);
let text = resource_table::get_str_value(x.text).unwrap();
let text = if text.ends_with('\n') {
self.consumed_next_newline = true;
text.trim_end()
} else {
&text
};
self.last_newline = text.matches('\n').count() as u32;
let newlines_in_text = text.matches('\n').count() as u32;
self.str(text);
self.line = x.line;
self.line = x.line + newlines_in_text;
}

fn process_token(&mut self, x: &VerylToken, will_push: bool, duplicated: Option<usize>) {
Expand Down Expand Up @@ -220,9 +231,9 @@ impl Emitter {
if x.line == self.line && !self.in_start_token {
self.space(1);
}
for _ in 0..x.line - (self.line + self.last_newline) {
for _ in 0..x.line - self.line {
self.unindent();
self.str("\n");
self.str(NEWLINE);
self.indent();
}
self.push_token(x);
Expand All @@ -232,7 +243,7 @@ impl Emitter {
}
if self.consumed_next_newline {
self.unindent();
self.str("\n");
self.str(NEWLINE);
self.indent();
}
}
Expand Down Expand Up @@ -342,7 +353,7 @@ impl Emitter {
}

fn statement_variable_declatation_only(&mut self, arg: &Statement) -> usize {
self.adjust_line = false;
self.clear_adjust_line();
match arg {
Statement::LetStatement(x) => {
let x = &x.let_statement;
Expand All @@ -361,7 +372,7 @@ impl Emitter {
}

fn function_item_variable_declatation_only(&mut self, arg: &FunctionItem) -> usize {
self.adjust_line = false;
self.clear_adjust_line();
match arg {
FunctionItem::VarDeclaration(x) => {
self.var_declaration(&x.var_declaration);
Expand Down Expand Up @@ -444,7 +455,8 @@ impl VerylWalker for Emitter {
self.string.truncate(self.string.len() - "`endif".len());

let trailing_endif = format!(
"`endif\n{}",
"`endif{}{}",
NEWLINE,
" ".repeat(self.indent * self.format_opt.indent_width)
);
let mut additional_endif = 0;
Expand Down Expand Up @@ -558,9 +570,10 @@ impl VerylWalker for Emitter {
if !namespace.included(&enum_namespace) {
self.namespace(&enum_namespace);
}
let enum_member_token = arg.scoped_identifier_list.last().unwrap();
self.consume_adjust_line(&enum_member_token.identifier.identifier_token.token);
self.str(&x.prefix);
self.str("_");
let enum_member_token = arg.scoped_identifier_list.last().unwrap();
self.identifier(&enum_member_token.identifier);
}
SymbolKind::Modport(_) => {
Expand Down Expand Up @@ -1432,18 +1445,17 @@ impl VerylWalker for Emitter {
match identifier.as_str() {
"ifdef" | "ifndef" => {
if let Some(ref x) = arg.attribute_opt {
self.adjust_line = false;

let comma = if self.string.trim_end().ends_with(',') {
self.unindent();
self.string.truncate(self.string.len() - ",\n".len());
self.string
.truncate(self.string.len() - format!(",{}", NEWLINE).len());
self.newline();
true
} else {
false
};

self.adjust_line = false;
self.consume_adjust_line(&arg.identifier.identifier_token.token);
self.str("`");
self.identifier(&arg.identifier);
self.space(1);
Expand All @@ -1458,26 +1470,22 @@ impl VerylWalker for Emitter {
self.newline();
}

self.adjust_line = false;
self.clear_adjust_line();
}
}
"sv" => {
if let Some(ref x) = arg.attribute_opt {
self.adjust_line = false;

self.str("(*");
self.space(1);
if let AttributeItem::StringLiteral(x) = &*x.attribute_list.attribute_item {
let text = x.string_literal.string_literal_token.to_string();
let text = &text[1..text.len() - 1];
let text = text.replace("\\\"", "\"");
self.str(&text);
self.token(&x.string_literal.string_literal_token.replace(&text));
}
self.space(1);
self.str("*)");
self.newline();

self.adjust_line = false;
}
}
"test" => {
Expand Down Expand Up @@ -2773,8 +2781,7 @@ impl VerylWalker for Emitter {
let text = arg.embed_content.embed_content_token.to_string();
let text = text.strip_prefix("{{{").unwrap();
let text = text.strip_suffix("}}}").unwrap();
let text = text.replace('\r', "");
self.str(&text);
self.str(text);
}
}

Expand All @@ -2790,7 +2797,6 @@ impl VerylWalker for Emitter {
let path = base.join(path);
// File existence is checked at analyzer
let text = fs::read_to_string(path).unwrap();
let text = text.replace('\r', "");
self.str(&text);
}
}
Expand Down
29 changes: 18 additions & 11 deletions crates/formatter/src/formatter.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ use veryl_parser::veryl_grammar_trait::*;
use veryl_parser::veryl_token::{Token, VerylToken};
use veryl_parser::veryl_walker::VerylWalker;

#[cfg(target_os = "windows")]
const NEWLINE: &str = "\r\n";
#[cfg(not(target_os = "windows"))]
const NEWLINE: &str = "\n";

pub struct Formatter {
format_opt: Format,
string: String,
indent: usize,
line: u32,
aligner: Aligner,
last_newline: u32,
in_start_token: bool,
consumed_next_newline: bool,
single_line: bool,
Expand All @@ -27,7 +31,6 @@ impl Default for Formatter {
indent: 0,
line: 1,
aligner: Aligner::new(),
last_newline: 0,
in_start_token: false,
consumed_next_newline: false,
single_line: false,
Expand Down Expand Up @@ -81,7 +84,7 @@ impl Formatter {
fn newline_push(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand All @@ -93,7 +96,7 @@ impl Formatter {
fn newline_pop(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand All @@ -105,7 +108,7 @@ impl Formatter {
fn newline(&mut self) {
self.unindent();
if !self.consumed_next_newline {
self.str("\n");
self.str(NEWLINE);
} else {
self.consumed_next_newline = false;
}
Expand All @@ -131,21 +134,25 @@ impl Formatter {
self.str(&" ".repeat(repeat));
}

fn push_token(&mut self, x: &Token) {
fn consume_adjust_line(&mut self, x: &Token) {
if self.adjust_line && x.line > self.line + 1 {
self.newline();
}
self.adjust_line = false;
}

fn push_token(&mut self, x: &Token) {
self.consume_adjust_line(x);
let text = resource_table::get_str_value(x.text).unwrap();
let text = if text.ends_with('\n') {
self.consumed_next_newline = true;
text.trim_end()
} else {
&text
};
self.last_newline = text.matches('\n').count() as u32;
let newlines_in_text = text.matches('\n').count() as u32;
self.str(text);
self.line = x.line;
self.line = x.line + newlines_in_text;
}

fn process_token(&mut self, x: &VerylToken, will_push: bool) {
Expand All @@ -167,9 +174,9 @@ impl Formatter {
if x.line == self.line && !self.in_start_token {
self.space(1);
}
for _ in 0..x.line - (self.line + self.last_newline) {
for _ in 0..x.line - self.line {
self.unindent();
self.str("\n");
self.str(NEWLINE);
self.indent();
}
self.push_token(x);
Expand All @@ -179,7 +186,7 @@ impl Formatter {
}
if self.consumed_next_newline {
self.unindent();
self.str("\n");
self.str(NEWLINE);
self.indent();
}
}
Expand Down
6 changes: 0 additions & 6 deletions crates/tests/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,6 @@ mod formatter {
let mut formatter = Formatter::new(&metadata);
formatter.format(&ret.veryl);

// remove CR on Windows environment
let original = original.replace('\r', "");

assert_eq!(original, formatter.as_str());
}

Expand Down Expand Up @@ -136,9 +133,6 @@ mod emitter {
let file = format!("../../testcases/sv/{}.sv", name);
let reference = fs::read_to_string(&file).unwrap();

// remove CR on Windows environment
let reference = reference.replace('\r', "");

assert_eq!(reference, emitter.as_str());
}

Expand Down
4 changes: 4 additions & 0 deletions testcases/sv/23_ifdef.sv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ module veryl_testcase_Module23 #(
input logic port_a
,`endif
input logic port_b

`ifdef DEFINE_A
,
input logic port_c
Expand All @@ -29,6 +30,7 @@ module veryl_testcase_Module23 #(
always_comb _a = 1;
`endif
`endif

`ifdef DEFINE_A
logic [10-1:0] _b;
always_comb _b = 1;
Expand All @@ -37,10 +39,12 @@ module veryl_testcase_Module23 #(
`endif

endmodule

`ifdef DEFINE_A
module veryl_testcase_Module23_A;
endmodule
`endif

`ifndef DEFINE_A
module veryl_testcase_Module23_B;
endmodule
Expand Down
15 changes: 15 additions & 0 deletions testcases/sv/53_multiline_comment_case.sv
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
module veryl_testcase_Module53;
typedef enum logic {
EnumA_A
} EnumA;

logic _a;
always_comb begin
case (EnumA_A)
/*
*/
EnumA_A: _a = 0;
default : _a = 1;
endcase
end
endmodule
Loading

0 comments on commit 32a34f9

Please sign in to comment.