Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 1 | " Test for checking the source code style. |
| 2 | |
Christian Brabandt | 681f1c9 | 2025-05-21 20:50:11 +0200 | [diff] [blame] | 3 | let s:list_of_c_files = [] |
| 4 | |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 5 | def s:ReportError(fname: string, lnum: number, msg: string) |
| 6 | if lnum > 0 |
| 7 | assert_report(fname .. ' line ' .. lnum .. ': ' .. msg) |
| 8 | endif |
| 9 | enddef |
| 10 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 11 | def s:PerformCheck(fname: string, pattern: string, msg: string, skip: string) |
John Marriott | 78d742a | 2024-04-02 20:26:01 +0200 | [diff] [blame] | 12 | var prev_lnum = 1 |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 13 | var lnum = 1 |
| 14 | while (lnum > 0) |
| 15 | cursor(lnum, 1) |
| 16 | lnum = search(pattern, 'W', 0, 0, skip) |
John Marriott | 78d742a | 2024-04-02 20:26:01 +0200 | [diff] [blame] | 17 | if (prev_lnum == lnum) |
| 18 | break |
| 19 | endif |
| 20 | prev_lnum = lnum |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 21 | if (lnum > 0) |
John Marriott | 78d742a | 2024-04-02 20:26:01 +0200 | [diff] [blame] | 22 | ReportError(fname, lnum, msg) |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 23 | endif |
| 24 | endwhile |
| 25 | enddef |
| 26 | |
Christian Brabandt | 681f1c9 | 2025-05-21 20:50:11 +0200 | [diff] [blame] | 27 | def s:Get_C_source_files(): list<string> |
| 28 | if empty(list_of_c_files) |
| 29 | var list = glob('../*.[ch]', 0, 1) + ['../xxd/xxd.c'] |
| 30 | # Some files are auto-generated and may contain space errors, so skip those |
| 31 | list_of_c_files = filter(list, (i, v) => v !~ 'dlldata.c\|if_ole.h\|iid_ole.c') |
| 32 | endif |
| 33 | return list_of_c_files |
| 34 | enddef |
| 35 | |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 36 | def Test_source_files() |
Christian Brabandt | 681f1c9 | 2025-05-21 20:50:11 +0200 | [diff] [blame] | 37 | for fname in Get_C_source_files() |
Bram Moolenaar | bf63011 | 2023-05-19 21:41:02 +0100 | [diff] [blame] | 38 | bwipe! |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 39 | g:ignoreSwapExists = 'e' |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 40 | exe 'edit ' .. fname |
| 41 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 42 | PerformCheck(fname, ' \t', 'space before Tab', '') |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 43 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 44 | PerformCheck(fname, '\s$', 'trailing white space', '') |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 45 | |
| 46 | # some files don't stick to the Vim style rules |
| 47 | if fname =~ 'iscygpty.c' |
| 48 | continue |
| 49 | endif |
| 50 | |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 51 | var skip = 'getline(".") =~ "condition) {" || getline(".") =~ "vimglob_func" || getline(".") =~ "{\"" || getline(".") =~ "{\\d" || getline(".") =~ "{{{"' |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 52 | PerformCheck(fname, ')\s*{', 'curly after closing paren', skip) |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 53 | |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 54 | # Examples in comments use double quotes. |
| 55 | skip = "getline('.') =~ '\"'" |
Bram Moolenaar | bf63011 | 2023-05-19 21:41:02 +0100 | [diff] [blame] | 56 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 57 | PerformCheck(fname, '}\s*else', 'curly before "else"', skip) |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 58 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 59 | PerformCheck(fname, 'else\s*{', 'curly after "else"', skip) |
Bram Moolenaar | c9471b1 | 2023-05-09 15:00:00 +0100 | [diff] [blame] | 60 | |
Christian Brabandt | b147d31 | 2023-09-01 17:58:35 +0100 | [diff] [blame] | 61 | PerformCheck(fname, '\<\(if\|while\|for\)(', 'missing white space after "if"/"while"/"for"', skip) |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 62 | endfor |
| 63 | |
| 64 | bwipe! |
| 65 | enddef |
| 66 | |
Bram Moolenaar | 94722c5 | 2023-01-28 19:19:03 +0000 | [diff] [blame] | 67 | def Test_test_files() |
| 68 | for fname in glob('*.vim', 0, 1) |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 69 | g:ignoreSwapExists = 'e' |
Bram Moolenaar | 94722c5 | 2023-01-28 19:19:03 +0000 | [diff] [blame] | 70 | exe 'edit ' .. fname |
| 71 | |
| 72 | # some files intentionally have misplaced white space |
| 73 | if fname =~ 'test_cindent.vim' || fname =~ 'test_join.vim' |
| 74 | continue |
| 75 | endif |
| 76 | |
| 77 | # skip files that are known to have a space before a tab |
| 78 | if fname !~ 'test_comments.vim' |
| 79 | && fname !~ 'test_listchars.vim' |
| 80 | && fname !~ 'test_visual.vim' |
| 81 | cursor(1, 1) |
Christian Brabandt | 22105fd | 2024-07-15 20:51:11 +0200 | [diff] [blame] | 82 | var skip = 'getline(".") =~ "codestyle: ignore"' |
| 83 | var lnum = search(fname =~ "test_regexp_latin" ? '[^รก] \t' : ' \t', 'W', 0, 0, skip) |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 84 | ReportError('testdir/' .. fname, lnum, 'space before Tab') |
Bram Moolenaar | 94722c5 | 2023-01-28 19:19:03 +0000 | [diff] [blame] | 85 | endif |
| 86 | |
| 87 | # skip files that are known to have trailing white space |
| 88 | if fname !~ 'test_cmdline.vim' |
| 89 | && fname !~ 'test_let.vim' |
| 90 | && fname !~ 'test_tagjump.vim' |
| 91 | && fname !~ 'test_vim9_cmd.vim' |
Doug Kearns | dbe39ed | 2025-01-04 17:12:24 +0100 | [diff] [blame] | 92 | && fname !~ 'test_vim9_enum.vim' |
Bram Moolenaar | 94722c5 | 2023-01-28 19:19:03 +0000 | [diff] [blame] | 93 | cursor(1, 1) |
| 94 | var lnum = search( |
| 95 | fname =~ 'test_vim9_assign.vim' ? '[^=]\s$' |
| 96 | : fname =~ 'test_vim9_class.vim' ? '[^)]\s$' |
| 97 | : fname =~ 'test_vim9_script.vim' ? '[^,:3]\s$' |
| 98 | : fname =~ 'test_visual.vim' ? '[^/]\s$' |
| 99 | : '[^\\]\s$') |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 100 | ReportError('testdir/' .. fname, lnum, 'trailing white space') |
Bram Moolenaar | 94722c5 | 2023-01-28 19:19:03 +0000 | [diff] [blame] | 101 | endif |
| 102 | endfor |
| 103 | |
| 104 | bwipe! |
| 105 | enddef |
| 106 | |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 107 | def Test_help_files() |
| 108 | var lnum: number |
| 109 | set nowrapscan |
| 110 | |
| 111 | for fpath in glob('../../runtime/doc/*.txt', 0, 1) |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 112 | g:ignoreSwapExists = 'e' |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 113 | exe 'edit ' .. fpath |
| 114 | |
| 115 | var fname = fnamemodify(fpath, ":t") |
| 116 | |
| 117 | # todo.txt is for developers, it's not need a strictly check |
| 118 | # version*.txt is a history and large size, so it's not checked |
| 119 | if fname == 'todo.txt' || fname =~ 'version.*\.txt' |
| 120 | continue |
| 121 | endif |
| 122 | |
| 123 | # Check for mixed tabs and spaces |
| 124 | cursor(1, 1) |
| 125 | while 1 |
| 126 | lnum = search('[^/] \t') |
| 127 | if fname == 'visual.txt' && getline(lnum) =~ "STRING \tjkl" |
| 128 | || fname == 'usr_27.txt' && getline(lnum) =~ "\[^\? \t\]" |
| 129 | continue |
| 130 | endif |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 131 | ReportError(fpath, lnum, 'space before tab') |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 132 | if lnum == 0 |
| 133 | break |
| 134 | endif |
| 135 | endwhile |
| 136 | |
| 137 | # Check for unnecessary whitespace at the end of a line |
| 138 | cursor(1, 1) |
| 139 | while 1 |
| 140 | lnum = search('[^/~\\]\s$') |
| 141 | # skip line that are known to have trailing white space |
| 142 | if fname == 'map.txt' && getline(lnum) =~ "unmap @@ $" |
| 143 | || fname == 'usr_12.txt' && getline(lnum) =~ "^\t/ \t$" |
| 144 | || fname == 'usr_41.txt' && getline(lnum) =~ "map <F4> o#include $" |
| 145 | || fname == 'change.txt' && getline(lnum) =~ "foobar bla $" |
| 146 | continue |
| 147 | endif |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 148 | ReportError('testdir' .. fpath, lnum, 'trailing white space') |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 149 | if lnum == 0 |
| 150 | break |
| 151 | endif |
| 152 | endwhile |
| 153 | |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 154 | # # TODO: Check for line over 80 columns |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 155 | # cursor(1, 1) |
| 156 | # while 1 |
| 157 | # lnum = search('\%>80v.*$') |
Bram Moolenaar | abc8130 | 2023-06-04 16:55:27 +0100 | [diff] [blame] | 158 | # ReportError(fpath, lnum, 'line over 80 columns') |
h-east | d950984 | 2023-02-21 13:33:17 +0000 | [diff] [blame] | 159 | # if lnum == 0 |
| 160 | # break |
| 161 | # endif |
| 162 | # endwhile |
| 163 | |
| 164 | endfor |
| 165 | |
| 166 | set wrapscan&vim |
| 167 | bwipe! |
| 168 | enddef |
| 169 | |
Naruhiko Nishino | c2a9000 | 2025-05-04 20:05:47 +0200 | [diff] [blame] | 170 | def Test_indent_of_source_files() |
Christian Brabandt | 681f1c9 | 2025-05-21 20:50:11 +0200 | [diff] [blame] | 171 | for fname in Get_C_source_files() |
Naruhiko Nishino | c2a9000 | 2025-05-04 20:05:47 +0200 | [diff] [blame] | 172 | execute 'tabnew ' .. fname |
Hirohito Higashi | 38972d8 | 2025-05-06 18:13:29 +0200 | [diff] [blame] | 173 | if &expandtab |
| 174 | continue |
| 175 | endif |
Naruhiko Nishino | c2a9000 | 2025-05-04 20:05:47 +0200 | [diff] [blame] | 176 | for lnum in range(1, line('$')) |
| 177 | var name: string = synIDattr(synID(lnum, 1, 0), 'name') |
| 178 | if -1 == index(['cComment', 'cCommentStart'], name) |
| 179 | var line: string = getline(lnum) |
| 180 | var indent: string = matchstr(line, '^\s*') |
| 181 | var tailing: string = matchstr(line, '\s*$') |
| 182 | if !empty(indent) |
Hirohito Higashi | 38972d8 | 2025-05-06 18:13:29 +0200 | [diff] [blame] | 183 | if indent !~# '^\t* \{0,7}$' |
Naruhiko Nishino | c2a9000 | 2025-05-04 20:05:47 +0200 | [diff] [blame] | 184 | ReportError('testdir/' .. fname, lnum, 'invalid indent') |
| 185 | endif |
| 186 | endif |
| 187 | if !empty(tailing) |
| 188 | ReportError('testdir/' .. fname, lnum, 'tailing spaces') |
| 189 | endif |
| 190 | endif |
| 191 | endfor |
| 192 | close |
| 193 | endfor |
| 194 | enddef |
Bram Moolenaar | ebfec1c | 2023-01-22 21:14:53 +0000 | [diff] [blame] | 195 | |
Christian Brabandt | 22105fd | 2024-07-15 20:51:11 +0200 | [diff] [blame] | 196 | " vim: shiftwidth=2 sts=2 expandtab nofoldenable |