File: file.vim

package info (click to toggle)
vim-tlib 1.28-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 752 kB
  • sloc: ruby: 61; makefile: 5
file content (356 lines) | stat: -rw-r--r-- 11,200 bytes parent folder | download | duplicates (2)
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
" @Author:      Tom Link (micathom AT gmail com?subject=[vim])
" @Website:     http://www.vim.org/account/profile.php?user_id=4037
" @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
" @Revision:    225


if !exists('g:tlib#file#drop')
    " If true, use |:drop| to edit loaded buffers (only available with GUI).
    let g:tlib#file#drop = has('gui')   "{{{2
endif


if !exists('g:tlib#file#use_tabs')
    let g:tlib#file#use_tabs = 0   "{{{2
endif


if !exists('g:tlib#file#edit_cmds')
    let g:tlib#file#edit_cmds = g:tlib#file#use_tabs ? {'buffer': 'tab split | buffer', 'edit': 'tabedit'} : {}  "{{{2
endif


if !exists('g:tlib#file#absolute_filename_rx')
    let g:tlib#file#absolute_filename_rx = '^\~\?[\/]'   "{{{2
endif


if !exists('g:tlib#file#reject_rx')
    let g:tlib#file#reject_rx = '\%(^\|[\/]\)\%(tags\|Thumbs\.db\)$'   "{{{2
endif


""" File related {{{1
" For the following functions please see ../../test/tlib.vim for examples.


" EXAMPLES: >
"   tlib#file#Split('foo/bar/filename.txt')
"   => ['foo', 'bar', 'filename.txt']
function! tlib#file#Split(filename) abort "{{{3
    let prefix = matchstr(a:filename, '^\(\w\+:\)\?/\+')
    Tlibtrace 'tlib', prefix
    if !empty(prefix)
        let filename = a:filename[len(prefix) : -1]
    else
        let filename = a:filename
    endif
    let rv = split(filename, '[\/]')
    " let rv = split(filename, '[\/]', 1)
    if !empty(prefix)
        call insert(rv, prefix[0:-2])
    endif
    return rv
endf


" :display: tlib#file#Join(filename_parts, ?strip_slashes=1, ?maybe_absolute=0)
" EXAMPLES: >
"   tlib#file#Join(['foo', 'bar', 'filename.txt'])
"   => 'foo/bar/filename.txt'
function! tlib#file#Join(filename_parts, ...) abort "{{{3
    TVarArg ['strip_slashes', 1], 'maybe_absolute'
    Tlibtrace 'tlib', a:filename_parts, strip_slashes
    if maybe_absolute
        let filename_parts = []
        for part in a:filename_parts
            if part =~ g:tlib#file#absolute_filename_rx
                let filename_parts = []
            endif
            call add(filename_parts, part)
        endfor
    else
        let filename_parts = a:filename_parts
    endif
    if strip_slashes
        " let rx    = tlib#rx#Escape(g:tlib#dir#sep) .'$'
        let rx    = '[/\\]\+$'
        let parts = map(copy(filename_parts), 'substitute(v:val, rx, "", "")')
        Tlibtrace 'tlib', parts
        return join(parts, g:tlib#dir#sep)
    else
        return join(filename_parts, g:tlib#dir#sep)
    endif
endf


" EXAMPLES: >
"   tlib#file#Relative('foo/bar/filename.txt', 'foo')
"   => 'bar/filename.txt'
function! tlib#file#Relative(filename, basedir) abort "{{{3
    Tlibtrace 'tlib', a:filename, a:basedir
    " TLogDBG getcwd()
    " TLogDBG expand('%:p')
    let b0 = tlib#file#Absolute(a:basedir)
    let b  = tlib#file#Split(b0)
    Tlibtrace 'tlib', b
    let f0 = tlib#file#Absolute(a:filename)
    let fn = fnamemodify(f0, ':t')
    let fd = fnamemodify(f0, ':h')
    let f  = tlib#file#Split(fd)
    Tlibtrace 'tlib', f0, fn, fd, f
    if f[0] != b[0]
        let rv = f0
    else
        while !empty(f) && !empty(b)
            if f[0] != b[0]
                break
            endif
            call remove(f, 0)
            call remove(b, 0)
        endwh
        Tlibtrace 'tlib', f, b
        let rv = tlib#file#Join(repeat(['..'], len(b)) + f + [fn])
    endif
    Tlibtrace 'tlib', rv
    return rv
endf


function! tlib#file#IsAbsolute(filename) abort "{{{3
    return a:filename =~? '^\%(/\|\w\+:/\)'
endf


function! tlib#file#Absolute(filename, ...) abort "{{{3
    if filereadable(a:filename)
        let filename = fnamemodify(a:filename, ':p')
    elseif a:filename =~# '^\(/\|[^\/]\+:\)'
        let filename = a:filename
    else
        let cwd = a:0 >= 1 ? a:1 : getcwd()
        let filename = tlib#file#Join([cwd, a:filename])
    endif
    let filename = substitute(filename, '\(^\|[\/]\)\zs\.[\/]', '', 'g')
    let filename = substitute(filename, '[\/]\zs[^\/]\+[\/]\.\.[\/]', '', 'g')
    return filename
endf


function! tlib#file#Canonic(filename, ...) abort "{{{3
    TVarArg ['mode', '']
    if empty(mode)
        if a:filename =~# '^\\\\'
            let mode = 'windows'
        elseif a:filename =~# '^\(file\|ftp\|http\)s\?:'
            let mode = 'url'
        elseif (empty(mode) && g:tlib#sys#windows)
            let mode = 'windows'
        endif
    endif
    let filename = a:filename
    if mode ==# 'windows'
        let filename = substitute(filename, '/', '\\', 'g')
    else
        let filename = substitute(filename, '\\', '/', 'g')
    endif
    return filename
endf


function! s:SetScrollBind(world) abort "{{{3
    let sb = get(a:world, 'scrollbind', &scrollbind)
    if sb != &scrollbind
        let &scrollbind = sb
    endif
endf


" :def: function! tlib#file#With(fcmd, bcmd, files, ?world={}) abort
function! tlib#file#With(fcmd, bcmd, files, ...) abort "{{{3
    Tlibtrace 'tlib', a:fcmd, a:bcmd, a:files
    let world = a:0 >= 1 ? a:1 : {}
    let unset_switchbuf = a:0 >= 2 ? a:2 : 0
    exec tlib#arg#Let([['world', {}]])
    call tlib#autocmdgroup#Init()
    augroup TLibFileRead
        autocmd!
    augroup END
    if unset_switchbuf
        let switchbuf = &switchbuf
        set switchbuf&
    endif
    try
        for f in a:files
            try
                let bn = bufnr('^'.f.'$')
                Tlibtrace 'tlib', f, bn
                let bufloaded = bufloaded(bn)
                let ok = 0
                let s:bufread = ""
                if bn != -1 && buflisted(bn)
                    if !empty(a:bcmd)
                        let bcmd = a:bcmd .' '. bn
                        Tlibtrace 'tlib', bcmd
                        exec bcmd
                        let ok = 1
                        call s:SetScrollBind(world)
                    endif
                else
                    if filereadable(f)
                        if !empty(a:fcmd)
                            " TLogDBG a:fcmd .' '. tlib#arg#Ex(f)
                            exec 'autocmd TLibFileRead BufRead' escape(f, '\ ') 'let s:bufread=expand("<afile>:p")'
                            try 
                                let fcmd = a:fcmd .' '. tlib#arg#Ex(f)
                                Tlibtrace 'tlib', fcmd
                                exec fcmd
                            finally
                                exec 'autocmd! TLibFileRead BufRead'
                            endtry
                            let ok = 1
                            call s:SetScrollBind(world)
                        endif
                    else
                        echohl error
                        echom 'File not readable: '. f
                        echohl NONE
                    endif
                endif
                Tlibtrace 'tlib', ok, bufloaded, &filetype
                if empty(s:bufread) && ok && !bufloaded && empty(&filetype)
                    doautocmd BufRead
                endif
            catch /^Vim\%((\a\+)\)\=:E325/
                echohl ErrorMsg
                echom v:exception
                echohl NONE
            endtry
        endfor
    finally
        augroup! TLibFileRead
        if unset_switchbuf
            let &switchbuf = switchbuf
        endif
        unlet! s:bufread
    endtry
    " TLogDBG "done"
endf


" Return 0 if the file isn't readable/doesn't exist.
" Otherwise return 1.
function! tlib#file#Edit(fileid) abort "{{{3
    if type(a:fileid) == 0
        let bn = a:fileid
        let filename = fnamemodify(bufname(bn), ':p')
    else
        let filename = fnamemodify(a:fileid, ':p')
        let bn = bufnr(filename)
    endif
    if filename == expand('%:p')
        return 1
    else
        Tlibtrace 'tlib', a:fileid, bn, filename, g:tlib#file#drop, filereadable(filename), bufnr('%')
        if bn != -1 && buflisted(bn)
            if g:tlib#file#drop
                " echom "DBG" get(g:tlib#file#edit_cmds, 'drop', 'drop') fnameescape(filename)
                exec get(g:tlib#file#edit_cmds, 'drop', 'drop') fnameescape(filename)
                " echom "DBG" bufnr('%')
            else
                " echom "DBG" get(g:tlib#file#edit_cmds, 'buffer', 'buffer') bn
                exec get(g:tlib#file#edit_cmds, 'buffer', 'buffer') bn
                " echom "DBG" bufnr('%')
            endif
            return 1
        endif
        if !filereadable(filename) && exists('#TLibPrepareFile#User')
            exec 'doautocmd TLibPrepareFile User' filename
        endif
        if filereadable(filename)
            try
                " let file = tlib#arg#Ex(filename)
                " Tlibtrace 'tlib', file
                " echom "DBG" get(g:tlib#file#edit_cmds, 'edit', 'edit') fnameescape(filename)
                exec get(g:tlib#file#edit_cmds, 'edit', 'edit') fnameescape(filename)
            catch /E325/
                " swap file exists, let the user handle it
            catch
                echohl error
                echom v:exception
                echohl NONE
            endtry
            return 1
        else
            echom "TLIB: File not readable: " . filename
            if filename != a:fileid
                echom "TLIB: original filename: " . a:fileid
            endif
        endif
    endif
    return 0
endf


function! tlib#file#FilterFiles(files, options) abort "{{{3
    Tlibtrace 'tlib', a:files, a:options, g:tlib#file#reject_rx
    if !get(a:options, 'all', 0)
        call filter(a:files, 'v:val !~# g:tlib#file#reject_rx')
    endif
    Tlibtrace 'tlib', a:files
    let type = get(a:options, 'type', 'fd')
    Tlibtrace 'tlib', type
    if type !~# 'd' || type !~# 'f'
        call filter(a:files, 'isdirectory(v:val) ? type =~# "d" : type =~# "f"')
    endif
    Tlibtrace 'tlib', a:files
    return a:files
endf


if v:version > 704 || (v:version == 704 && has('patch279'))

    function! tlib#file#Glob(pattern, ...) abort "{{{3
        let all = a:0 >= 1 ? a:1 : 0
        let nosuf = a:0 >= 2 ? a:2 : 0
        return tlib#file#FilterFiles(glob(a:pattern, nosuf, 1), {'all': all})
    endf

    function! tlib#file#Globpath(path, pattern, ...) abort "{{{3
        let all = a:0 >= 1 ? a:1 : 0
        let nosuf = a:0 >= 2 ? a:2 : 0
        return tlib#file#FilterFiles(globpath(a:path, a:pattern, nosuf, 1), {'all': all})
    endf

else

    " :nodoc:
    function! tlib#file#Glob(pattern, ...) abort "{{{3
        let all = a:0 >= 1 ? a:1 : 0
        let nosuf = a:0 >= 2 ? a:2 : 0
        return tlib#file#FilterFiles(split(glob(a:pattern, nosuf), '\n'), {'all': all})
    endf

    " :nodoc:
    function! tlib#file#Globpath(path, pattern, ...) abort "{{{3
        let all = a:0 >= 1 ? a:1 : 0
        let nosuf = a:0 >= 2 ? a:2 : 0
        return tlib#file#FilterFiles(split(globpath(a:path, a:pattern), '\n'), {'all': all})
    endf

endif


let s:filereadable = {}

augroup TLib
	autocmd BufWritePost,FileWritePost,FocusLost * let s:filereadable = {}
augroup end

function! tlib#file#Filereadable(filename) abort "{{{3
    if !has_key(s:filereadable, a:filename)
        let s:filereadable[a:filename] = filereadable(a:filename)
    endif
    return s:filereadable[a:filename]
endf