/
session.vim
573 lines (527 loc) · 19.6 KB
/
session.vim
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
" Vim script
" Author: Peter Odding
" Last Change: September 4, 2011
" URL: http://peterodding.com/code/vim/session/
let g:xolox#session#version = '1.4.12'
" Public API for session persistence. {{{1
" The functions in this fold take a single list argument in which the Vim
" script lines are stored that should be executed to restore the (relevant
" parts of the) current Vim editing session. The only exception to this is
" xolox#session#save_session() which expects the target filename as 2nd
" argument:
function! xolox#session#save_session(commands, filename) " {{{2
call add(a:commands, '" ' . a:filename . ': Vim session script.')
call add(a:commands, '" Created by session.vim ' . g:xolox#session#version . ' on ' . strftime('%d %B %Y at %H:%M:%S.'))
call add(a:commands, '" Open this file in Vim and run :source % to restore your session.')
call add(a:commands, '')
call add(a:commands, 'set guioptions=' . escape(&go, ' "\'))
call add(a:commands, 'silent! set guifont=' . escape(&gfn, ' "\'))
call xolox#session#save_features(a:commands)
call xolox#session#save_colors(a:commands)
call xolox#session#save_qflist(a:commands)
call xolox#session#save_state(a:commands)
call xolox#session#save_fullscreen(a:commands)
call add(a:commands, '')
call add(a:commands, '" vim: ft=vim ro nowrap smc=128')
endfunction
function! xolox#session#save_features(commands) " {{{2
let template = "if exists('%s') != %i | %s %s | endif"
for [global, command] in [
\ ['g:syntax_on', 'syntax'],
\ ['g:did_load_filetypes', 'filetype'],
\ ['g:did_load_ftplugin', 'filetype plugin'],
\ ['g:did_indent_on', 'filetype indent']]
let active = exists(global)
let toggle = active ? 'on' : 'off'
call add(a:commands, printf(template, global, active, command, toggle))
endfor
endfunction
function! xolox#session#save_colors(commands) " {{{2
if exists('g:colors_name') && type(g:colors_name) == type('') && g:colors_name != ''
let template = "if !exists('g:colors_name') || g:colors_name != %s | colorscheme %s | endif"
call add(a:commands, printf(template, string(g:colors_name), fnameescape(g:colors_name)))
call add(a:commands, 'set background=' . &background)
endif
endfunction
function! xolox#session#save_fullscreen(commands) " {{{2
try
if xolox#shell#is_fullscreen()
call add(a:commands, "if has('gui_running')")
call add(a:commands, " try")
call add(a:commands, " call xolox#shell#fullscreen()")
" XXX Without this hack Vim on GTK doesn't restore &lines and &columns.
call add(a:commands, " call feedkeys(\":set lines=" . &lines . " columns=" . &columns . "\\<CR>\")")
call add(a:commands, " catch " . '/^Vim\%((\a\+)\)\=:E117/')
call add(a:commands, " \" Ignore missing full-screen plug-in.")
call add(a:commands, " endtry")
call add(a:commands, "endif")
endif
catch /^Vim\%((\a\+)\)\=:E117/
" Ignore missing full-screen functionality.
endtry
endfunction
function! xolox#session#save_qflist(commands) " {{{2
if has('quickfix')
let qf_list = []
for qf_entry in getqflist()
if has_key(qf_entry, 'bufnr')
if !has_key(qf_entry, 'filename')
let qf_entry.filename = bufname(qf_entry.bufnr)
endif
unlet qf_entry.bufnr
endif
call add(qf_list, qf_entry)
endfor
call add(a:commands, 'call setqflist(' . string(qf_list) . ')')
endif
endfunction
function! xolox#session#save_state(commands) " {{{2
let tempfile = tempname()
let ssop_save = &sessionoptions
try
" The default value of &sessionoptions includes "options" which causes
" :mksession to include all Vim options and mappings in generated session
" scripts. This can significantly increase the size of session scripts
" which makes them slower to generate and evaluate. It can also be a bit
" buggy, e.g. it breaks Ctrl-S when :runtime mswin.vim has been used. The
" value of &sessionoptions is changed temporarily to avoid these issues.
set ssop-=options ssop+=resize
execute 'mksession' fnameescape(tempfile)
let lines = readfile(tempfile)
if lines[-1] == '" vim: set ft=vim :'
call remove(lines, -1)
endif
call xolox#session#save_special_windows(lines)
call extend(a:commands, map(lines, 's:state_filter(v:val)'))
return 1
finally
let &sessionoptions = ssop_save
call delete(tempfile)
endtry
endfunction
function! s:state_filter(line)
if a:line == 'normal zo'
" Silence "E490: No fold found" errors.
return 'silent! normal zo'
else
return a:line
endif
endfunction
function! xolox#session#save_special_windows(session) " {{{2
" Integration between :mksession, :NERDTree and :Project.
let tabpage = tabpagenr()
let window = winnr()
try
if &sessionoptions =~ '\<tabpages\>'
tabdo call s:check_special_tabpage(a:session)
else
call s:check_special_tabpage(a:session)
endif
finally
execute 'tabnext' tabpage
execute window . 'wincmd w'
call s:jump_to_window(a:session, tabpage, window)
endtry
endfunction
function! s:check_special_tabpage(session)
let status = 0
windo let status += s:check_special_window(a:session)
if status > 0 && winnr('$') > 1
call add(a:session, winrestcmd())
endif
endfunction
function! s:check_special_window(session)
if exists('b:NERDTreeRoot')
let command = 'NERDTree'
let argument = b:NERDTreeRoot.path.str()
elseif exists('g:proj_running') && g:proj_running == bufnr('%')
let command = 'Project'
let argument = expand('%:p')
elseif &filetype == 'netrw'
let command = 'edit'
let argument = bufname('%')
elseif &buftype == 'quickfix'
let command = 'cwindow'
let argument = ''
endif
if exists('command')
call s:jump_to_window(a:session, tabpagenr(), winnr())
if command != 'edit'
call add(a:session, 'bwipeout')
endif
if argument == ''
call add(a:session, command)
else
let argument = fnamemodify(argument, ':~')
if &sessionoptions =~ '\<slash\>'
let argument = substitute(argument, '\', '/', 'g')
endif
call add(a:session, command . ' ' . fnameescape(argument))
endif
return 1
endif
endfunction
function! s:jump_to_window(session, tabpage, window)
if &sessionoptions =~ '\<tabpages\>'
call add(a:session, 'tabnext ' . a:tabpage)
endif
call add(a:session, a:window . 'wincmd w')
endfunction
function! s:nerdtree_persist()
" Remember current working directory and whether NERDTree is loaded.
if exists('b:NERDTreeRoot')
return 'NERDTree ' . fnameescape(b:NERDTreeRoot.path.str()) . ' | only'
else
return 'cd ' . fnameescape(getcwd())
endif
endfunction
" Automatic commands to manage the default session. {{{1
function! xolox#session#auto_load() " {{{2
if g:session_autoload == 'no'
return
endif
" Check that the user has started Vim without editing any files.
if bufnr('$') == 1 && bufname('%') == '' && !&mod && getline(1, '$') == ['']
" Check whether a session matching the user-specified server name exists.
if v:servername !~ '^\cgvim\d*$'
for session in xolox#session#get_names()
if v:servername ==? session
execute 'OpenSession' fnameescape(session)
return
endif
endfor
endif
" Default to the last used session or the session named `default'?
let session = s:last_session_recall()
let path = xolox#session#name_to_path(session)
if filereadable(path) && !s:session_is_locked(path)
let msg = "Do you want to restore your %s editing session?"
let label = session != 'default' ? 'last used' : 'default'
if s:prompt(printf(msg, label), 'g:session_autoload')
execute 'OpenSession' fnameescape(session)
endif
endif
endif
endfunction
function! xolox#session#auto_save() " {{{2
if !v:dying && g:session_autosave != 'no'
let name = s:get_name('', 0)
if name != '' && exists('s:session_is_dirty')
let msg = "Do you want to save your editing session before quitting Vim?"
if s:prompt(msg, 'g:session_autosave')
execute 'SaveSession' fnameescape(name)
endif
endif
endif
endfunction
function! xolox#session#auto_unlock() " {{{2
let i = 0
while i < len(s:lock_files)
let lock_file = s:lock_files[i]
if delete(lock_file) == 0
call remove(s:lock_files, i)
else
let i += 1
endif
endwhile
endfunction
function! xolox#session#auto_dirty_check() " {{{2
" This function is called each time a WinEnter event fires to detect when
" the current tab page is changed in some way. This enables the plug-in to
" not bother with the auto-save dialog when the session hasn't changed.
if v:this_session == ''
" Don't waste CPU time when no session is loaded.
return
elseif !exists('s:cached_layouts')
let s:cached_layouts = {}
else
" Clear non-existing tab pages from s:cached_layouts.
let last_tabpage = tabpagenr('$')
call filter(s:cached_layouts, 'v:key <= last_tabpage')
endif
let tabpagenr = tabpagenr()
let keys = ['tabpage:' . tabpagenr]
let buflist = tabpagebuflist()
for winnr in range(1, winnr('$'))
" Create a string that describes the state of the window {winnr}.
call add(keys, printf('width:%i,height:%i,buffer:%i',
\ winwidth(winnr), winheight(winnr), buflist[winnr - 1]))
endfor
let layout = join(keys, "\n")
let cached_layout = get(s:cached_layouts, tabpagenr, '')
if cached_layout != '' && cached_layout != layout
let s:session_is_dirty = 1
endif
let s:cached_layouts[tabpagenr] = layout
endfunction
function! s:prompt(msg, var) " {{{2
let value = eval(a:var)
if value == 'yes' || (type(value) != type('') && value)
return 1
else
let format = "%s Note that you can permanently disable this dialog by adding the following line to your %s script:\n\n\t:let %s = 'no'"
let vimrc = xolox#misc#os#is_win() ? '~\_vimrc' : '~/.vimrc'
let prompt = printf(format, a:msg, vimrc, a:var)
return confirm(prompt, "&Yes\n&No", 1, 'Question') == 1
endif
endfunction
" Commands that enable users to manage multiple sessions. {{{1
function! xolox#session#open_cmd(name, bang) abort " {{{2
let name = s:select_name(s:unescape(a:name), 'restore')
if name != ''
let starttime = xolox#misc#timer#start()
let path = xolox#session#name_to_path(name)
if !filereadable(path)
let msg = "session.vim %s: The %s session at %s doesn't exist!"
call xolox#misc#msg#warn(msg, g:xolox#session#version, string(name), fnamemodify(path, ':~'))
elseif a:bang == '!' || !s:session_is_locked(path, 'OpenSession')
let oldcwd = s:nerdtree_persist()
call xolox#session#close_cmd(a:bang, 1)
let s:oldcwd = oldcwd
call s:lock_session(path)
execute 'source' fnameescape(path)
unlet! s:session_is_dirty
call s:last_session_persist(name)
call xolox#misc#timer#stop("session.vim %s: Opened %s session in %s.", g:xolox#session#version, string(name), starttime)
call xolox#misc#msg#info("session.vim %s: Opened %s session from %s.", g:xolox#session#version, string(name), fnamemodify(path, ':~'))
endif
endif
endfunction
function! xolox#session#view_cmd(name) abort " {{{2
let name = s:select_name(s:get_name(s:unescape(a:name), 0), 'view')
if name != ''
let path = xolox#session#name_to_path(name)
if !filereadable(path)
let msg = "session.vim %s: The %s session at %s doesn't exist!"
call xolox#misc#msg#warn(msg, g:xolox#session#version, string(name), fnamemodify(path, ':~'))
else
execute 'tab drop' fnameescape(path)
call xolox#misc#msg#info("session.vim %s: Viewing session script %s.", g:xolox#session#version, fnamemodify(path, ':~'))
endif
endif
endfunction
function! xolox#session#save_cmd(name, bang) abort " {{{2
let starttime = xolox#misc#timer#start()
let name = s:get_name(s:unescape(a:name), 1)
let path = xolox#session#name_to_path(name)
let friendly_path = fnamemodify(path, ':~')
if a:bang == '!' || !s:session_is_locked(path, 'SaveSession')
let lines = []
call xolox#session#save_session(lines, friendly_path)
if xolox#misc#os#is_win() && &ssop !~ '\<unix\>'
call map(lines, 'v:val . "\r"')
endif
if writefile(lines, path) != 0
let msg = "session.vim %s: Failed to save %s session to %s!"
call xolox#misc#msg#warn(msg, g:xolox#session#version, string(name), friendly_path)
else
call s:last_session_persist(name)
call xolox#misc#timer#stop("session.vim %s: Saved %s session in %s.", g:xolox#session#version, string(name), starttime)
call xolox#misc#msg#info("session.vim %s: Saved %s session to %s.", g:xolox#session#version, string(name), friendly_path)
let v:this_session = path
call s:lock_session(path)
unlet! s:session_is_dirty
endif
endif
endfunction
function! xolox#session#delete_cmd(name, bang) " {{{2
let name = s:select_name(s:unescape(a:name), 'delete')
if name != ''
let path = xolox#session#name_to_path(name)
if !filereadable(path)
let msg = "session.vim %s: The %s session at %s doesn't exist!"
call xolox#misc#msg#warn(msg, g:xolox#session#version, string(name), fnamemodify(path, ':~'))
elseif a:bang == '!' || !s:session_is_locked(path, 'DeleteSession')
if delete(path) != 0
let msg = "session.vim %s: Failed to delete %s session at %s!"
call xolox#misc#msg#warn(msg, g:xolox#session#version, string(name), fnamemodify(path, ':~'))
else
call s:unlock_session(path)
let msg = "session.vim %s: Deleted %s session at %s."
call xolox#misc#msg#info(msg, g:xolox#session#version, string(name), fnamemodify(path, ':~'))
endif
endif
endif
endfunction
function! xolox#session#close_cmd(bang, silent) abort " {{{2
let name = s:get_name('', 0)
if name != '' && exists('s:session_is_dirty')
let msg = "Do you want to save your current editing session before closing it?"
if s:prompt(msg, 'g:session_autosave')
SaveSession
endif
call s:unlock_session(xolox#session#name_to_path(name))
endif
" Close al but the current tab page.
if tabpagenr('$') > 1
execute 'tabonly' . a:bang
endif
" Close all but the current window.
if winnr('$') > 1
execute 'only' . a:bang
endif
" Start editing a new, empty buffer.
execute 'enew' . a:bang
" Close all but the current buffer.
let bufnr_keep = bufnr('%')
for bufnr in range(1, bufnr('$'))
if buflisted(bufnr) && bufnr != bufnr_keep
execute 'silent bdelete' bufnr
endif
endfor
" Restore working directory (and NERDTree?) from before :OpenSession.
if exists('s:oldcwd')
execute s:oldcwd
unlet s:oldcwd
endif
unlet! s:session_is_dirty
if v:this_session == ''
if !a:silent
let msg = "session.vim %s: Closed session."
call xolox#misc#msg#info(msg, g:xolox#session#version)
endif
else
if !a:silent
let msg = "session.vim %s: Closed session %s."
call xolox#misc#msg#info(msg, g:xolox#session#version, fnamemodify(v:this_session, ':~'))
endif
let v:this_session = ''
endif
return 1
endfunction
function! xolox#session#restart_cmd(bang, args) abort " {{{2
if !has('gui_running')
let msg = "session.vim %s: The :RestartVim command only works in graphical Vim!"
call xolox#misc#msg#warn(msg, g:xolox#session#version)
else
let name = s:get_name('', 0)
if name == '' | let name = 'restart' | endif
execute 'SaveSession' . a:bang fnameescape(name)
let progname = shellescape(fnameescape(v:progname))
let command = progname . ' -c ' . shellescape('OpenSession\! ' . fnameescape(name))
let args = matchstr(a:args, '^\s*|\s*\zs.\+$')
if !empty(args)
let command .= ' -c ' . shellescape(args)
endif
if has('win32') || has('win64')
execute '!start' command
else
let term = shellescape(fnameescape($TERM))
let encoding = "--cmd ':set enc=" . escape(&enc, '\ ') . "'"
silent execute '! TERM=' . term command encoding '&'
endif
execute 'CloseSession' . a:bang
silent quitall
endif
endfunction
" Miscellaneous functions. {{{1
function! s:unescape(s) " {{{2
return substitute(a:s, '\\\(.\)', '\1', 'g')
endfunction
function! s:select_name(name, action) " {{{2
if a:name != ''
return a:name
endif
let sessions = sort(xolox#session#get_names())
if empty(sessions)
return 'default'
elseif len(sessions) == 1
return sessions[0]
endif
let lines = copy(sessions)
for i in range(len(sessions))
let lines[i] = ' ' . (i + 1) . '. ' . lines[i]
endfor
redraw
sleep 100 m
echo "\nPlease select the session to " . a:action . ":"
sleep 100 m
let i = inputlist([''] + lines + [''])
return i >= 1 && i <= len(sessions) ? sessions[i - 1] : ''
endfunction
function! s:get_name(name, use_default) " {{{2
let name = a:name
if name == '' && v:this_session != ''
let this_session_dir = fnamemodify(v:this_session, ':p:h')
if xolox#misc#path#equals(this_session_dir, g:session_directory)
let name = xolox#session#path_to_name(v:this_session)
endif
endif
return name != '' ? name : a:use_default ? 'default' : ''
endfunction
function! xolox#session#name_to_path(name) " {{{2
let directory = xolox#misc#path#absolute(g:session_directory)
let filename = xolox#misc#path#encode(a:name) . '.vim'
return xolox#misc#path#merge(directory, filename)
endfunction
function! xolox#session#path_to_name(path) " {{{2
return xolox#misc#path#decode(fnamemodify(a:path, ':t:r'))
endfunction
function! xolox#session#get_names() " {{{2
let directory = xolox#misc#path#absolute(g:session_directory)
let filenames = split(glob(xolox#misc#path#merge(directory, '*.vim')), "\n")
return map(filenames, 'xolox#session#path_to_name(v:val)')
endfunction
function! xolox#session#complete_names(arg, line, pos) " {{{2
let names = filter(xolox#session#get_names(), 'v:val =~ a:arg')
return map(names, 'fnameescape(v:val)')
endfunction
" Default to last used session: {{{2
function! s:last_session_file()
let directory = xolox#misc#path#absolute(g:session_directory)
return xolox#misc#path#merge(directory, 'last-session.txt')
endfunction
function! s:last_session_persist(name)
if g:session_default_to_last
if writefile([a:name], s:last_session_file()) != 0
call xolox#misc#msg#warn("session.vim %s: Failed to persist name of last used session!", g:xolox#session#version)
endif
endif
endfunction
function! s:last_session_recall()
if g:session_default_to_last
let fname = s:last_session_file()
if filereadable(fname)
return readfile(fname)[0]
endif
endif
return 'default'
endfunction
" Lock file management: {{{2
if !exists('s:lock_files')
let s:lock_files = []
endif
function! s:lock_session(session_path)
let lock_file = a:session_path . '.lock'
if writefile([v:servername], lock_file) == 0
if index(s:lock_files, lock_file) == -1
call add(s:lock_files, lock_file)
endif
return 1
endif
endfunction
function! s:unlock_session(session_path)
let lock_file = a:session_path . '.lock'
if delete(lock_file) == 0
let idx = index(s:lock_files, lock_file)
if idx >= 0
call remove(s:lock_files, idx)
endif
return 1
endif
endfunction
function! s:session_is_locked(session_path, ...)
let lock_file = a:session_path . '.lock'
if filereadable(lock_file)
let lines = readfile(lock_file)
if lines[0] !=? v:servername
if a:0 >= 1
let msg = "session.vim %s: The %s session is locked by another Vim instance named %s! Use :%s! to override."
let name = string(fnamemodify(a:session_path, ':t:r'))
call xolox#misc#msg#warn(msg, g:xolox#session#version, name, string(lines[0]), a:1)
endif
return 1
endif
endif
endfunction
" vim: ts=2 sw=2 et