[vim/vim] Not able to indent systemverilog files properly (Issue #10242)

raveensrk

unread,

Apr 21, 2022, 8:05:19 AM4/21/22

to vim/vim, Subscribed

Steps to reproduce

Open a system verilog file with .sv extension
Select all, ggVG
Indent all with, =

The indentation gets messed up. Whereas emacs perfectly indents the same code.

file_indented_by_vim.sv.txt

Expected behaviour

This is the correct indentation, based on emacs.

file_indented_by_emacs.txt

Version of Vim

8.2

Environment

OS: Ubuntu 20.04 [WSL]
Terminal: Windows Terminal
$TERM: xterm-256color
$SHELL: /bin/bash
BASH: 5.0.17

Logs and stack traces

No response

—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Apr 21, 2022, 8:15:11 AM4/21/22

to vim/vim, Subscribed

Same issue exists in neovim.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Apr 21, 2022, 11:42:50 AM4/21/22

to vim/vim, Subscribed

please try to contact the maintainer of this file: https://github.com/vim/vim/blob/master/runtime/indent/verilog.vim

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Apr 21, 2022, 11:51:30 AM4/21/22

to vim/vim, Subscribed

@chrisbra Are you sure that indent script is the issue? Because, there is also systemverilog.vim that is the syntax and filetype I using.

Also verilog and systemverilog both have similar syntax. I tried setting the syntax and filetype to verilog. The issue still remains. I think both indent files have this issue.

Should I contact the systemverilog.vim maintainer or verilog.vim?

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Apr 21, 2022, 12:17:13 PM4/21/22

to vim/vim, Subscribed

ah, I don't know verilog and systemverilog at all. I just assumed that would be the correct one. In that case, try to contact the maintainer of the systemverilog indent script.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Apr 27, 2022, 9:51:48 PM4/27/22

to vim/vim, Subscribed

@raveensrk Thank you for contacting us. I have checked and corrected the problem.

indent/systemverilog.vim

Could you please try it once.
If there seems to be no problem, I will issue a PR.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Apr 28, 2022, 10:51:02 AM4/28/22

to vim/vim, Subscribed

@Kocha Thank you for the fix. All the issues I faced were solved. You can proceed with the PR.

Not sure if i did the check properly. This is what i did,

Replaced the /usr/local/share/vim/vim82/indent/systemverilog.vim in the $VIMRUNTINE path with your indent file.
Opened the
and Indented with ggVG=

I did not check with my actual code base. I will check this indent fix there and get back to you.

The only difference between emacs and vim this the \ifndefindendation. Vim indents everything after`ifndef` where emacs doesnot. I do not know which is the right way to indent this. So I will let you decide.

Left is vim with the new indent file and the right is emacs.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Apr 28, 2022, 11:21:15 AM4/28/22

to vim/vim, Subscribed

There is some misalignment going on in multiline comments. I will get back with example code tomorrow.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Apr 29, 2022, 9:07:24 AM4/29/22

to vim/vim, Subscribed

@Kocha There is some junk commented code in my code base with a mix of multiline and single line comments which is causing some problems. Can you take a look at this as well? Thanks.

Left is Vim and Right is Emacs

I have attached the files below.

fix_systemverilog.vim.zip

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

May 6, 2022, 3:49:27 AM5/6/22

to vim/vim, Subscribed

@raveensrk Could you please try this?

indent/systemverilog.vim

Regarding the ifndef indentation, I have added an option.
Once this is set, there will be no indentation.

b:systemverilog_indent_ifdef_off

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

May 13, 2022, 7:52:54 AM5/13/22

to vim/vim, Subscribed

Hi @Kocha, I tried the above fix and some above-mentioned problems went away. I also tried the b:systemverilog_indent_ifdef_off option. That also worked fine.

In systemverilog file buffer, To set the ifdef indent off,
let b:systemverilog_indent_ifdef_off = 1
To revert this change, I used,
unlet b:systemverilog_indent_ifdef_off

Both worked file. Let me know if this is the correct way to test this. Could this option be inverted instead? Let the indent option be off by default and let the user decide to switch it on. I am suggesting this based on Emacs implementation taken as reference.

I also tested this on my codebase, and it looks like there are few more issues when single line comments are used after the multiline comments. For example,

(Same as before, left is vim with the new indent file and right is Emacs.)

I have attached the files below.

fix_systemverilog.vim.3.tar.gz

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

May 16, 2022, 5:09:10 AM5/16/22

to vim/vim, Subscribed

Hi @raveensrk
I think I'll go default ifdef indent on.
Because that is what the example code in the IEEE1800 22.6.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

raveensrk

unread,

Jun 1, 2022, 7:06:52 AM6/1/22

to vim/vim, Subscribed

Hi @Kocha, Are you working on the fix for the previous comment?

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Jun 3, 2022, 4:23:25 AM6/3/22

to vim/vim, Subscribed

Hi @raveensrk, Sorry to keep you waiting.
Next... Could you please try this?

indent/systemverilog.vim

—

Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Jun 9, 2022, 9:55:27 AM6/9/22

to vim/vim, Subscribed

Hi @Kocha, I checked the fix, and it worked. There are a few other places where the indentation is off again.

fix_systemverilog.vim.4.tar.gz

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Jun 20, 2022, 5:46:05 AM6/20/22

to vim/vim, Subscribed

Hi @raveensrk, Sorry for the many updates.

Next... Could you please try this?

indent/systemverilog.vim

—

Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Jun 28, 2022, 7:50:36 AM6/28/22

to vim/vim, Subscribed

@Kocha Sorry for the delay. I had to test this out a bit. The previous reported issue fixed. But there are a few more issues that I discovered.

fix_systemverilog.vim.5.tar.gz

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Jul 1, 2022, 5:07:35 AM7/1/22

to vim/vim, Subscribed

Hi @raveensrk Thank you for response.

top.sv : let b:systemverilog_indent_modules=1 option.
env.sv
- Not support uvm macro indent.
- Bugfix a few. -> indent/systemverilog.vim
  But, task close parenthesis is a little difficult, please give me some time.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Jul 6, 2022, 10:14:56 PM7/6/22

to vim/vim, Subscribed

HI @raveensrk
I tried to solve task close parenthesis , but I am not sure if this is the right way to do it.

Could you please try this?

indent/systemverilog.vim

—

Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Jul 18, 2022, 9:08:15 AM7/18/22

to vim/vim, Subscribed

Hi @Kocha, checked the fix, it works fine. Could I request one more update to the indentation? The ability to break argument into multiple lines for print statements would be a nice addition. I will let you decide.

fix_systemverilog.vim.6.tar.gz

I think after this update, we can close this issue and do a pull request. Meanwhile, I will be using this indentation file, if I see more issues I will reopen this issue and post the issues. I think most bugs I faced were fixed. Thanks for the help.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Aug 1, 2022, 9:30:55 AM8/1/22

to vim/vim, Subscribed

@Kocha Any updates? Will you be doing a pull request?

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Aug 3, 2022, 9:06:14 AM8/3/22

to vim/vim, Subscribed

@raveensrk Sorry for the wait.
Updated the indent/systemverilog.vim file.

indent/systemverilog.vim

If there seems to be no problem, I will issue a PR.

—

Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Aug 3, 2022, 12:54:53 PM8/3/22

to vim/vim, Subscribed

Thanks, the update looks good to me. Issue a pr @Kocha lets merge it.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Kocha

unread,

Aug 4, 2022, 9:10:42 AM8/4/22

to vim/vim, Subscribed

Hi, @raveensrk I sent to PR and closed.
If all is well, please close the Issue.

Best regards.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Aug 25, 2022, 3:21:30 AM8/25/22

to vim/vim, Subscribed

Thanks @Kocha. Closing this issue.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Raveen Kumar

unread,

Aug 25, 2022, 3:21:31 AM8/25/22

to vim/vim, Subscribed

Closed #10242 as completed.

—
Reply to this email directly, view it on GitHub.

You are receiving this because you are subscribed to this thread.

Reply all

Reply to author

Forward