1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
" Tests for :help
source check.vim
import './vim9.vim' as v9
func Test_help_restore_snapshot()
help
set buftype=
help
edit x
help
helpclose
endfunc
func Test_help_restore_snapshot_split()
" Squeeze the unnamed buffer, Xfoo and the help one side-by-side and focus
" the first one before calling :help.
let bnr = bufnr()
botright vsp Xfoo
wincmd h
help
wincmd L
let g:did_bufenter = v:false
augroup T
au!
au BufEnter Xfoo let g:did_bufenter = v:true
augroup END
helpclose
augroup! T
" We're back to the unnamed buffer.
call assert_equal(bnr, bufnr())
" No BufEnter was triggered for Xfoo.
call assert_equal(v:false, g:did_bufenter)
close!
bwipe!
endfunc
func Test_help_errors()
call assert_fails('help doesnotexist', 'E149:')
call assert_fails('help!', 'E478:')
if has('multi_lang')
call assert_fails('help help@xy', 'E661:')
endif
let save_hf = &helpfile
set helpfile=help_missing
help
call assert_equal(1, winnr('$'))
call assert_notequal('help', &buftype)
let &helpfile = save_hf
call assert_fails('help ' . repeat('a', 1048), 'E149:')
new
set keywordprg=:help
call setline(1, " ")
call assert_fails('normal VK', 'E349:')
bwipe!
endfunc
func Test_help_expr()
help expr-!~?
call assert_equal('eval.txt', expand('%:t'))
close
endfunc
func Test_help_keyword()
new
set keywordprg=:help
call setline(1, " Visual ")
normal VK
call assert_match('^Visual mode', getline('.'))
call assert_equal('help', &ft)
close
bwipe!
endfunc
func Test_help_local_additions()
call mkdir('Xruntime/doc', 'pR')
call writefile(['*mydoc.txt* my awesome doc'], 'Xruntime/doc/mydoc.txt')
call writefile(['*mydoc-ext.txt* my extended awesome doc'], 'Xruntime/doc/mydoc-ext.txt')
let rtp_save = &rtp
set rtp+=./Xruntime
help local-additions
let lines = getline(line(".") + 1, search("^$") - 1)
call assert_equal([
\ '|mydoc-ext.txt| my extended awesome doc',
\ '|mydoc.txt| my awesome doc'
\ ], lines)
call delete('Xruntime/doc/mydoc-ext.txt')
close
call mkdir('Xruntime-ja/doc', 'pR')
call writefile(["local-additions\thelp.jax\t/*local-additions*"], 'Xruntime-ja/doc/tags-ja')
call writefile(['*help.txt* This is jax file', '',
\ 'LOCAL ADDITIONS: *local-additions*', ''], 'Xruntime-ja/doc/help.jax')
call writefile(['*work.txt* This is jax file'], 'Xruntime-ja/doc/work.jax')
call writefile(['*work2.txt* This is jax file'], 'Xruntime-ja/doc/work2.jax')
set rtp+=./Xruntime-ja
help local-additions@en
let lines = getline(line(".") + 1, search("^$") - 1)
call assert_equal([
\ '|mydoc.txt| my awesome doc'
\ ], lines)
close
help local-additions@ja
let lines = getline(line(".") + 1, search("^$") - 1)
call assert_equal([
\ '|mydoc.txt| my awesome doc',
\ '|help.txt| This is jax file',
\ '|work.txt| This is jax file',
\ '|work2.txt| This is jax file',
\ ], lines)
close
let &rtp = rtp_save
endfunc
func Test_help_completion()
call feedkeys(":help :undo\<C-A>\<C-B>\"\<CR>", 'tx')
call assert_equal('"help :undo :undoj :undol :undojoin :undolist', @:)
endfunc
" Test for the :helptags command
" NOTE: if you run tests as root this will fail. Don't run tests as root!
func Test_helptag_cmd()
call mkdir('Xtagdir/a/doc', 'pR')
" No help file to process in the directory
call assert_fails('helptags Xtagdir', 'E151:')
call writefile([], 'Xtagdir/a/doc/sample.txt')
" Test for ++t argument
helptags ++t Xtagdir
call assert_equal(["help-tags\ttags\t1"], readfile('Xtagdir/tags'))
call delete('Xtagdir/tags')
" Test parsing tags
call writefile(['*tag1*', 'Example: >', ' *notag*', 'Example end: *tag2*'],
\ 'Xtagdir/a/doc/sample.txt')
helptags Xtagdir
call assert_equal(["tag1\ta/doc/sample.txt\t/*tag1*",
\ "tag2\ta/doc/sample.txt\t/*tag2*"], readfile('Xtagdir/tags'))
" Duplicate tags in the help file
call writefile(['*tag1*', '*tag1*', '*tag2*'], 'Xtagdir/a/doc/sample.txt')
call assert_fails('helptags Xtagdir', 'E154:')
endfunc
func Test_helptag_cmd_readonly()
CheckUnix
CheckNotRoot
" Read-only tags file
call mkdir('Xrodir/doc', 'pR')
call writefile([''], 'Xrodir/doc/tags')
call writefile([], 'Xrodir/doc/sample.txt')
call setfperm('Xrodir/doc/tags', 'r-xr--r--')
call assert_fails('helptags Xrodir/doc', 'E152:', getfperm('Xrodir/doc/tags'))
let rtp = &rtp
let &rtp = 'Xrodir'
helptags ALL
let &rtp = rtp
call delete('Xrodir/doc/tags')
" No permission to read the help file
call mkdir('Xrodir/b/doc', 'p')
call writefile([], 'Xrodir/b/doc/sample.txt')
call setfperm('Xrodir/b/doc/sample.txt', '-w-------')
call assert_fails('helptags Xrodir', 'E153:', getfperm('Xrodir/b/doc/sample.txt'))
endfunc
" Test for setting the 'helpheight' option in the help window
func Test_help_window_height()
let &cmdheight = &lines - 23
set helpheight=10
help
set helpheight=14
call assert_equal(14, winheight(0))
set helpheight& cmdheight=1
close
endfunc
func Test_help_long_argument()
try
exe 'help \%' .. repeat('0', 1021)
catch
call assert_match("E149:", v:exception)
endtry
endfunc
func Test_help_using_visual_match()
let lines =<< trim END
call setline(1, ' ')
/^
exe "normal \<C-V>\<C-V>"
h5\%V]
END
call v9.CheckScriptFailure(lines, 'E149:')
endfunc
" vim: shiftwidth=2 sts=2 expandtab
|
