codekingpro/portable-devtools

1" Vim indent file2" Language:    SystemVerilog3" Maintainer:  kocha <kocha.lsifrontend@gmail.com>4" Last Change: 05-Feb-2017 by Bilal Wasim5"              03-Aug-2022 Improved indent6 7" Only load this indent file when no other was loaded.8if exists("b:did_indent")9  finish10endif11let b:did_indent = 112 13setlocal indentexpr=SystemVerilogIndent()14setlocal indentkeys=!^F,o,O,0),0},=begin,=end,=join,=endcase,=join_any,=join_none15setlocal indentkeys+==endmodule,=endfunction,=endtask,=endspecify16setlocal indentkeys+==endclass,=endpackage,=endsequence,=endclocking17setlocal indentkeys+==endinterface,=endgroup,=endprogram,=endproperty,=endchecker18setlocal indentkeys+==`else,=`elsif,=`endif19 20let b:undo_indent = "setl inde< indk<"21 22" Only define the function once.23if exists("*SystemVerilogIndent")24  finish25endif26 27let s:cpo_save = &cpo28set cpo&vim29 30let s:multiple_comment = 031let s:open_statement = 032 33function SystemVerilogIndent()34 35  if exists('b:systemverilog_indent_width')36    let offset = b:systemverilog_indent_width37  else38    let offset = shiftwidth()39  endif40  if exists('b:systemverilog_indent_modules')41    let indent_modules = offset42  else43    let indent_modules = 044  endif45 46  if exists('b:systemverilog_indent_ifdef_off')47    let indent_ifdef = 048  else49    let indent_ifdef = 150  endif51 52  " Find a non-blank line above the current line.53  let lnum = prevnonblank(v:lnum - 1)54 55  " At the start of the file use zero indent.56  if lnum == 057    return 058  endif59 60  let lnum2 = prevnonblank(lnum - 1)61  let curr_line  = getline(v:lnum)62  let last_line  = getline(lnum)63  let last_line2 = getline(lnum2)64  let ind  = indent(lnum)65  let ind2 = indent(lnum - 1)66  " Define the condition of an open statement67  "   Exclude the match of //, /* or */68  let sv_openstat = '\(\<or\>\|\([*/]\)\@<![*(,{><+-/%^&|!=?:]\([*/]\)\@!\)'69  " Define the condition when the statement ends with a one-line comment70  let sv_comment = '\(//.*\|/\*.*\*/\s*\)'71  if exists('b:systemverilog_indent_verbose')72    let vverb_str = 'INDENT VERBOSE: '. v:lnum .":"73    let vverb = 174  else75    let vverb = 076  endif77 78  " Multiple-line comment count79  if curr_line =~ '^\s*/\*' && curr_line !~ '/\*.\{-}\*/'80    let s:multiple_comment += 181    if vverb | echom vverb_str "Start of multiple-line comment" | endif82  elseif curr_line =~ '\*/\s*$' && curr_line !~ '/\*.\{-}\*/'83    let s:multiple_comment -= 184    if vverb | echom vverb_str "End of multiple-line comment" | endif85    return ind86  endif87  " Maintain indentation during commenting.88  if s:multiple_comment > 089    return ind90  endif91 92  " Indent after if/else/for/case/always/initial/specify/fork blocks93  if last_line =~ '^\s*\(end\)\=\s*`\@<!\<\(if\|else\)\>' ||94    \ last_line =~ '^\s*\<\(for\|while\|repeat\|case\%[[zx]]\|do\|foreach\|forever\|randcase\)\>' ||95    \ last_line =~ '^\s*\<\(always\|always_comb\|always_ff\|always_latch\)\>' ||96    \ last_line =~ '^\s*\<\(initial\|specify\|fork\|final\)\>'97    if last_line !~ '\(;\|\<end\>\|\*/\)\s*' . sv_comment . '*$' ||98      \ last_line =~ '\(//\|/\*\).*\(;\|\<end\>\)\s*' . sv_comment . '*$'99      let ind = ind + offset100      if vverb | echom vverb_str "Indent after a block statement." | endif101    endif102  " Indent after function/task/class/package/sequence/clocking/103  " interface/covergroup/property/checkerprogram blocks104  elseif last_line =~ '^\s*\<\(function\|task\|class\|package\)\>' ||105    \ last_line =~ '^\s*\<\(sequence\|clocking\|interface\)\>' ||106    \ last_line =~ '^\s*\(\w\+\s*:\)\=\s*\<covergroup\>' ||107    \ last_line =~ '^\s*\<\(property\|checker\|program\)\>' ||108    \ ( last_line =~ '^\s*\<virtual\>' && last_line =~ '\<\(function\|task\|class\|interface\)\>' ) ||109    \ ( last_line =~ '^\s*\<pure\>' &&  last_line =~ '\<virtual\>' && last_line =~ '\<\(function\|task\)\>' )110    if last_line !~ '\<end\>\s*' . sv_comment . '*$' ||111      \ last_line =~ '\(//\|/\*\).*\(;\|\<end\>\)\s*' . sv_comment . '*$'112      let ind = ind + offset113      if vverb114        echom vverb_str "Indent after function/task/class block statement."115      endif116    endif117 118  " Indent after module/function/task/specify/fork blocks119  elseif last_line =~ '^\s*\(\<extern\>\s*\)\=\<module\>'120    let ind = ind + indent_modules121    if vverb && indent_modules122      echom vverb_str "Indent after module statement."123    endif124    if last_line =~ '[(,]\s*' . sv_comment . '*$' &&125      \ last_line !~ '\(//\|/\*\).*[(,]\s*' . sv_comment . '*$'126      let ind = ind + offset127      if vverb128        echom vverb_str "Indent after a multiple-line module statement."129      endif130    endif131 132  " Indent after a 'begin' statement133  elseif last_line =~ '\(\<begin\>\)\(\s*:\s*\w\+\)*' . sv_comment . '*$' &&134    \ last_line !~ '\(//\|/\*\).*\(\<begin\>\)' &&135    \ ( last_line2 !~ sv_openstat . '\s*' . sv_comment . '*$' ||136    \ last_line2 =~ '^\s*[^=!]\+\s*:\s*' . sv_comment . '*$' )137    let ind = ind + offset138    if vverb | echom vverb_str "Indent after begin statement." | endif139 140  " Indent after a '{' or a '('141  elseif last_line =~ '[{(]' . sv_comment . '*$' &&142    \ last_line !~ '\(//\|/\*\).*[{(]' &&143    \ ( last_line2 !~ sv_openstat . '\s*' . sv_comment . '*$' ||144    \ last_line2 =~ '^\s*[^=!]\+\s*:\s*' . sv_comment . '*$' )145    let ind = ind + offset146    if vverb | echom vverb_str "Indent after begin statement." | endif147 148  " Ignore de-indent for the end of one-line block149  elseif ( last_line !~ '\<begin\>' ||150    \ last_line =~ '\(//\|/\*\).*\<begin\>' ) &&151    \ last_line2 =~ '\<\(`\@<!if\|`\@<!else\|for\|always\|initial\|do\|foreach\|forever\|final\)\>.*' .152      \ sv_comment . '*$' &&153    \ last_line2 !~ '\(//\|/\*\).*\<\(`\@<!if\|`\@<!else\|for\|always\|initial\|do\|foreach\|forever\|final\)\>' &&154    \ last_line2 !~ sv_openstat . '\s*' . sv_comment . '*$' &&155    \ ( last_line2 !~ '\<begin\>' ||156    \ last_line2 =~ '\(//\|/\*\).*\<begin\>' ) &&157    \ last_line2 =~ ')*\s*;\s*' . sv_comment . '*$'158    if vverb159      echom vverb_str "Ignore de-indent after the end of one-line statement."160    endif161 162  " De-indent for the end of one-line block163  elseif ( last_line !~ '\<begin\>' ||164    \ last_line =~ '\(//\|/\*\).*\<begin\>' ) &&165    \ last_line2 =~ '\<\(`\@<!if\|`\@<!else\|for\|always\|initial\|do\|foreach\|forever\|final\)\>.*' .166      \ sv_comment . '*$' &&167    \ last_line2 !~ '\(//\|/\*\).*\<\(`\@<!if\|`\@<!else\|for\|always\|initial\|do\|foreach\|forever\|final\)\>' &&168    \ last_line2 !~ sv_openstat . '\s*' . sv_comment . '*$' &&169    \ last_line2 !~ '\(;\|\<end\>\|\*/\)\s*' . sv_comment . '*$' &&170    \ ( last_line2 !~ '\<begin\>' ||171    \ last_line2 =~ '\(//\|/\*\).*\<begin\>' )172    let ind = ind - offset173    if vverb174      echom vverb_str "De-indent after the end of one-line statement."175    endif176 177  " Multiple-line statement (including case statement)178  " Open statement179  "   Ident the first open line180  elseif  last_line =~ sv_openstat . '\s*' . sv_comment . '*$' &&181   \ last_line !~ '\(//\|/\*\).*' . sv_openstat . '\s*$' &&182   \ last_line2 !~ sv_openstat . '\s*' . sv_comment . '*$'183    let ind = ind + offset184    let s:open_statement = 1185    if vverb | echom vverb_str "Indent after an open statement." | endif186 187  " `ifdef or `ifndef or `elsif or `else188  elseif last_line =~ '^\s*`\<\(ifn\?def\|elsif\|else\)\>' && indent_ifdef189    let ind = ind + offset190    if vverb191      echom vverb_str "Indent after a `ifdef or `ifndef or `elsif or `else statement."192    endif193 194  endif195 196  " Re-indent current line197 198  " De-indent on the end of the block199  " join/end/endcase/endfunction/endtask/endspecify200  if curr_line =~ '^\s*\<\(join\|join_any\|join_none\|\|end\|endcase\)\>' ||201      \ curr_line =~ '^\s*\<\(endfunction\|endtask\|endspecify\|endclass\)\>' ||202      \ curr_line =~ '^\s*\<\(endpackage\|endsequence\|endclocking\|endinterface\)\>' ||203      \ curr_line =~ '^\s*\<\(endgroup\|endproperty\|endchecker\|endprogram\)\>'204    let ind = ind - offset205    if vverb | echom vverb_str "De-indent the end of a block." | endif206    if s:open_statement == 1207      let ind = ind - offset208      let s:open_statement = 0209      if vverb | echom vverb_str "De-indent the close statement." | endif210    endif211  elseif curr_line =~ '^\s*\<endmodule\>'212    let ind = ind - indent_modules213    if vverb && indent_modules214      echom vverb_str "De-indent the end of a module."215    endif216 217  " De-indent on a stand-alone 'begin'218  elseif curr_line =~ '^\s*\<begin\>'219    if last_line !~ '^\s*\<\(function\|task\|specify\|module\|class\|package\)\>' ||220      \ last_line !~ '^\s*\<\(sequence\|clocking\|interface\|covergroup\)\>' ||221      \ last_line !~ '^\s*\<\(property\|checker\|program\)\>' &&222      \ last_line !~ '^\s*\()*\s*;\|)\+\)\s*' . sv_comment . '*$' &&223      \ ( last_line =~224      \ '\<\(`\@<!if\|`\@<!else\|for\|case\%[[zx]]\|always\|initial\|do\|foreach\|forever\|randcase\|final\)\>' ||225      \ last_line =~ ')\s*' . sv_comment . '*$' ||226      \ last_line =~ sv_openstat . '\s*' . sv_comment . '*$' )227      let ind = ind - offset228      if vverb229        echom vverb_str "De-indent a stand alone begin statement."230      endif231      if s:open_statement == 1232        let ind = ind - offset233        let s:open_statement = 0234        if vverb | echom vverb_str "De-indent the close statement." | endif235      endif236    endif237 238  " " Close statement239  " "   De-indent for an optional close parenthesis and a semicolon, and only240  " "   if there exists precedent non-whitespace char241  " elseif last_line =~ ')*\s*;\s*' . sv_comment . '*$' &&242  "   \ last_line !~ '^\s*)*\s*;\s*' . sv_comment . '*$' &&243  "   \ last_line !~ '\(//\|/\*\).*\S)*\s*;\s*' . sv_comment . '*$' &&244  "   \ ( last_line2 =~ sv_openstat . '\s*' . sv_comment . '*$' &&245  "   \ last_line2 !~ ';\s*//.*$') &&246  "   \ last_line2 !~ '^\s*' . sv_comment . '$'247  "   let ind = ind - offset248  "   if vverb | echom vverb_str "De-indent after a close statement." | endif249 250  " " De-indent after the end of multiple-line statement251  " elseif curr_line =~ '^\s*)' &&252  "  \ ( last_line =~ sv_openstat . '\s*' . sv_comment . '*$' ||253  "  \ last_line !~ sv_openstat . '\s*' . sv_comment . '*$' &&254  "  \ last_line2 =~ sv_openstat . '\s*' . sv_comment . '*$' )255  "   let ind = ind - offset256  "   if vverb257  "     echom vverb_str "De-indent the end of a multiple statement."258  "   endif259 260  " De-indent `elsif or `else or `endif261  elseif curr_line =~ '^\s*`\<\(elsif\|else\|endif\)\>' && indent_ifdef262    let ind = ind - offset263    if vverb | echom vverb_str "De-indent `elsif or `else or `endif statement." | endif264    if b:systemverilog_open_statement == 1265      let ind = ind - offset266      let b:systemverilog_open_statement = 0267      if vverb | echom vverb_str "De-indent the open statement." | endif268    endif269  endif270 271  " Return the indentation272  return ind273endfunction274 275let &cpo = s:cpo_save276unlet s:cpo_save277 278" vim:sw=2279 280