mru.vim 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916
  1. " File: mru.vim
  2. " Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com)
  3. " Version: 3.9.3
  4. " Last Modified: Jan 30, 2021
  5. " Copyright: Copyright (C) 2003-2021 Yegappan Lakshmanan
  6. " License: Permission is hereby granted to use and distribute this code,
  7. " with or without modifications, provided that this copyright
  8. " notice is copied with it. Like anything else that's free,
  9. " mru.vim is provided *as is* and comes with no warranty of any
  10. " kind, either expressed or implied. In no event will the copyright
  11. " holder be liable for any damages resulting from the use of this
  12. " software.
  13. "
  14. " ****************** Do not modify after this line ************************
  15. if exists('loaded_mru')
  16. finish
  17. endif
  18. let loaded_mru=1
  19. if v:version < 700
  20. finish
  21. endif
  22. " Line continuation used here
  23. let s:cpo_save = &cpo
  24. set cpo&vim
  25. " MRU configuration variables {{{1
  26. " Maximum number of entries allowed in the MRU list
  27. if !exists('MRU_Max_Entries')
  28. let MRU_Max_Entries = 100
  29. endif
  30. " Files to exclude from the MRU list
  31. if !exists('MRU_Exclude_Files')
  32. let MRU_Exclude_Files = ''
  33. endif
  34. " Files to include in the MRU list
  35. if !exists('MRU_Include_Files')
  36. let MRU_Include_Files = ''
  37. endif
  38. " Height of the MRU window
  39. " Default height is 8
  40. if !exists('MRU_Window_Height')
  41. let MRU_Window_Height = 8
  42. endif
  43. if !exists('MRU_Use_Current_Window')
  44. let MRU_Use_Current_Window = 0
  45. endif
  46. if !exists('MRU_Auto_Close')
  47. let MRU_Auto_Close = 1
  48. endif
  49. if !exists('MRU_File')
  50. if has('unix') || has('macunix')
  51. let MRU_File = $HOME . '/.vim_mru_files'
  52. else
  53. let MRU_File = $VIM . '/_vim_mru_files'
  54. if has('win32')
  55. " MS-Windows
  56. if $USERPROFILE != ''
  57. let MRU_File = $USERPROFILE . '\_vim_mru_files'
  58. endif
  59. endif
  60. endif
  61. else
  62. let MRU_File=expand(MRU_File)
  63. endif
  64. " Option for enabling or disabling the MRU menu
  65. if !exists('MRU_Add_Menu')
  66. let MRU_Add_Menu = 1
  67. endif
  68. " Maximum number of file names to show in the MRU menu. If too many files are
  69. " listed in the menu, then Vim becomes slow when updating the menu. So set
  70. " this to a low value.
  71. if !exists('MRU_Max_Menu_Entries')
  72. let MRU_Max_Menu_Entries = 10
  73. endif
  74. " Maximum number of file names to show in a MRU sub-menu. If the MRU list
  75. " contains more file names than this setting, then the MRU menu is split into
  76. " one or more sub-menus.
  77. if !exists('MRU_Max_Submenu_Entries')
  78. let MRU_Max_Submenu_Entries = 10
  79. endif
  80. " When only a single matching filename is found in the MRU list, the following
  81. " option controls whether the file name is displayed in the MRU window or the
  82. " file is directly opened. When this variable is set to 0 and a single
  83. " matching file name is found, then the file is directly opened.
  84. if !exists('MRU_Window_Open_Always')
  85. let MRU_Window_Open_Always = 0
  86. endif
  87. " When opening a file from the MRU list, the file is opened in the current
  88. " tab. If the selected file has to be opened in a tab always, then set the
  89. " following variable to 1. If the file is already opened in a tab, then the
  90. " cursor will be moved to that tab.
  91. if !exists('MRU_Open_File_Use_Tabs')
  92. let MRU_Open_File_Use_Tabs = 0
  93. endif
  94. " Format of the file names displayed in the MRU window.
  95. " The default is to display the filename followed by the complete path to the
  96. " file in parenthesis. This variable controls the expressions used to format
  97. " and parse the path. This can be changed to display the filenames in a
  98. " different format. The 'formatter' specifies how to split/format the filename
  99. " and 'parser' specifies how to read the filename back; 'syntax' matches the
  100. " part to be highlighted.
  101. if !exists('MRU_Filename_Format')
  102. let MRU_Filename_Format = {
  103. \ 'formatter': 'fnamemodify(v:val, ":t") . " (" . v:val . ")"',
  104. \ 'parser': '(\zs.*\ze)',
  105. \ 'syntax': '^.\{-}\ze('
  106. \}
  107. endif
  108. let s:MRU_buf_name = '-RecentFiles-'
  109. " Control to temporarily lock the MRU list. Used to prevent files from
  110. " getting added to the MRU list when the ':vimgrep' command is executed.
  111. let s:mru_list_locked = 0
  112. " MRU_LoadList {{{1
  113. " Loads the latest list of file names from the MRU file
  114. func! s:MRU_LoadList() abort
  115. " If the MRU file is present, then load the list of filenames. Otherwise
  116. " start with an empty list.
  117. if filereadable(g:MRU_File)
  118. let s:MRU_files = readfile(g:MRU_File)
  119. if s:MRU_files[0] =~# '^\s*" Most recently edited files in Vim'
  120. " Generated by the previous version of the MRU plugin.
  121. " Discard the list.
  122. let s:MRU_files = []
  123. elseif s:MRU_files[0] =~# '^#'
  124. " Remove the comment line
  125. call remove(s:MRU_files, 0)
  126. else
  127. " Unsupported format
  128. let s:MRU_files = []
  129. endif
  130. else
  131. let s:MRU_files = []
  132. endif
  133. " Refresh the MRU menu with the latest list of filenames
  134. call s:MRU_Refresh_Menu()
  135. endfunc
  136. " MRU_SaveList {{{1
  137. " Saves the MRU file names to the MRU file
  138. func! s:MRU_SaveList() abort
  139. let l = []
  140. call add(l, '# Most recently edited files in Vim (version 3.0)')
  141. call extend(l, s:MRU_files)
  142. call writefile(l, g:MRU_File)
  143. endfunc
  144. " MRU_AddFile {{{1
  145. " Adds a file to the MRU file list
  146. " acmd_bufnr - Buffer number of the file to add
  147. func! s:MRU_AddFile(acmd_bufnr) abort
  148. if s:mru_list_locked
  149. " MRU list is currently locked
  150. return
  151. endif
  152. " Get the full path to the filename
  153. let fname = fnamemodify(bufname(a:acmd_bufnr + 0), ':p')
  154. if fname == ''
  155. return
  156. endif
  157. " Skip temporary buffers with buftype set. The buftype is set for buffers
  158. " used by plugins.
  159. if &buftype != ''
  160. return
  161. endif
  162. if g:MRU_Include_Files != ''
  163. " If MRU_Include_Files is set, include only files matching the
  164. " specified pattern
  165. if fname !~# g:MRU_Include_Files
  166. return
  167. endif
  168. endif
  169. if g:MRU_Exclude_Files != ''
  170. " Do not add files matching the pattern specified in the
  171. " MRU_Exclude_Files to the MRU list
  172. if fname =~# g:MRU_Exclude_Files
  173. return
  174. endif
  175. endif
  176. " If the filename is not already present in the MRU list and is not
  177. " readable then ignore it
  178. let idx = index(s:MRU_files, fname)
  179. if idx == -1
  180. if !filereadable(fname)
  181. " File is not readable and is not in the MRU list
  182. return
  183. endif
  184. endif
  185. " Load the latest MRU file list
  186. call s:MRU_LoadList()
  187. " Remove the new file name from the existing MRU list (if already present)
  188. call filter(s:MRU_files, 'v:val !=# fname')
  189. " Add the new file list to the beginning of the updated old file list
  190. call insert(s:MRU_files, fname, 0)
  191. " Trim the list
  192. if len(s:MRU_files) > g:MRU_Max_Entries
  193. call remove(s:MRU_files, g:MRU_Max_Entries, -1)
  194. endif
  195. " Save the updated MRU list
  196. call s:MRU_SaveList()
  197. " Refresh the MRU menu
  198. call s:MRU_Refresh_Menu()
  199. " If the MRU window is open, update the displayed MRU list
  200. let bname = s:MRU_buf_name
  201. let winnum = bufwinnr(bname)
  202. if winnum != -1
  203. let cur_winnr = winnr()
  204. call s:MRU_Open_Window('', '')
  205. if winnr() != cur_winnr
  206. exe cur_winnr . 'wincmd w'
  207. endif
  208. endif
  209. endfunc
  210. " MRU_escape_filename {{{1
  211. " Escape special characters in a filename. Special characters in file names
  212. " that should be escaped (for security reasons)
  213. let s:esc_filename_chars = ' *?[{`$%#"|!<>();&' . "'\t\n"
  214. func! s:MRU_escape_filename(fname) abort
  215. if exists("*fnameescape")
  216. return fnameescape(a:fname)
  217. else
  218. return escape(a:fname, s:esc_filename_chars)
  219. endif
  220. endfunc
  221. " MRU_Edit_File {{{1
  222. " Edit the specified file
  223. " filename - Name of the file to edit
  224. " sanitized - Specifies whether the filename is already escaped for special
  225. " characters or not.
  226. func! s:MRU_Edit_File(filename, sanitized) abort
  227. if !a:sanitized
  228. let esc_fname = s:MRU_escape_filename(a:filename)
  229. else
  230. let esc_fname = a:filename
  231. endif
  232. " If the user wants to always open the file in a tab, then open the file
  233. " in a tab. If it is already opened in a tab, then the cursor will be
  234. " moved to that tab.
  235. if g:MRU_Open_File_Use_Tabs
  236. call s:MRU_Open_File_In_Tab(a:filename, esc_fname)
  237. return
  238. endif
  239. " If the file is already open in one of the windows, jump to it
  240. let winnum = bufwinnr('^' . a:filename . '$')
  241. if winnum != -1
  242. if winnum != winnr()
  243. exe winnum . 'wincmd w'
  244. endif
  245. else
  246. if !&hidden && (&modified || &buftype != '' || &previewwindow)
  247. " Current buffer has unsaved changes or is a special buffer or is
  248. " the preview window. The 'hidden' option is also not set.
  249. " So open the file in a new window.
  250. exe 'split ' . esc_fname
  251. else
  252. " The current file can be replaced with the selected file.
  253. exe 'edit ' . esc_fname
  254. endif
  255. endif
  256. endfunc
  257. " MRU_Open_File_In_Tab
  258. " Open a file in a tab. If the file is already opened in a tab, jump to the
  259. " tab. Otherwise, create a new tab and open the file.
  260. " fname : Name of the file to open
  261. " esc_fname : File name with special characters escaped
  262. func! s:MRU_Open_File_In_Tab(fname, esc_fname) abort
  263. " If the selected file is already open in the current tab or in
  264. " another tab, jump to it. Otherwise open it in a new tab
  265. if bufwinnr('^' . a:fname . '$') == -1
  266. let tabnum = -1
  267. let i = 1
  268. let bnum = bufnr('^' . a:fname . '$')
  269. while i <= tabpagenr('$')
  270. if index(tabpagebuflist(i), bnum) != -1
  271. let tabnum = i
  272. break
  273. endif
  274. let i += 1
  275. endwhile
  276. if tabnum != -1
  277. " Goto the tab containing the file
  278. exe 'tabnext ' . i
  279. else
  280. if (winnr("$") == 1) && (@% == '') && !&modified
  281. " Reuse the current tab if it contains a single new unmodified
  282. " file.
  283. exe 'e ' . a:esc_fname
  284. else
  285. " Open a new tab as the last tab page
  286. exe '$tabnew ' . a:esc_fname
  287. endif
  288. endif
  289. endif
  290. " Jump to the window containing the file
  291. let winnum = bufwinnr('^' . a:fname . '$')
  292. if winnum != winnr()
  293. exe winnum . 'wincmd w'
  294. endif
  295. endfunc
  296. " MRU_Window_Edit_File {{{1
  297. " fname : Name of the file to edit. May specify single or multiple
  298. " files.
  299. " edit_type : Specifies how to edit the file. Can be one of 'edit' or 'view'.
  300. " 'view' - Open the file as a read-only file
  301. " 'edit' - Edit the file as a regular file
  302. " multi : Specifies whether a single file or multiple files need to be
  303. " opened.
  304. " open_type : Specifies where to open the file.
  305. " useopen - If the file is already present in a window, then
  306. " jump to that window. Otherwise, open the file in
  307. " the previous window.
  308. " newwin_horiz - Open the file in a new horizontal window.
  309. " newwin_vert - Open the file in a new vertical window.
  310. " newtab - Open the file in a new tab. If the file is already
  311. " opened in a tab, then jump to that tab.
  312. " preview - Open the file in the preview window
  313. func! s:MRU_Window_Edit_File(fname, multi, edit_type, open_type) abort
  314. let esc_fname = s:MRU_escape_filename(a:fname)
  315. if a:open_type ==# 'newwin_horiz'
  316. " Edit the file in a new horizontally split window above the previous
  317. " window
  318. wincmd p
  319. exe 'belowright new ' . esc_fname
  320. elseif a:open_type ==# 'newwin_vert'
  321. " Edit the file in a new vertically split window above the previous
  322. " window
  323. wincmd p
  324. exe 'belowright vnew ' . esc_fname
  325. elseif a:open_type ==# 'newtab' || g:MRU_Open_File_Use_Tabs
  326. call s:MRU_Open_File_In_Tab(a:fname, esc_fname)
  327. elseif a:open_type ==# 'preview'
  328. " Edit the file in the preview window
  329. exe 'topleft pedit ' . esc_fname
  330. else
  331. " If the selected file is already open in one of the windows,
  332. " jump to it
  333. let winnum = bufwinnr('^' . a:fname . '$')
  334. if winnum != -1
  335. exe winnum . 'wincmd w'
  336. else
  337. if g:MRU_Auto_Close == 1 && g:MRU_Use_Current_Window == 0
  338. " Jump to the window from which the MRU window was opened
  339. if exists('s:MRU_last_buffer')
  340. let last_winnr = bufwinnr(s:MRU_last_buffer)
  341. if last_winnr != -1 && last_winnr != winnr()
  342. exe last_winnr . 'wincmd w'
  343. endif
  344. endif
  345. else
  346. if g:MRU_Use_Current_Window == 0
  347. " Goto the previous window
  348. " If MRU_Use_Current_Window is set to one, then the
  349. " current window is used to open the file
  350. wincmd p
  351. endif
  352. endif
  353. let split_window = 0
  354. if (!&hidden && (&modified || &previewwindow)) || a:multi
  355. " Current buffer has unsaved changes or is the preview window
  356. " or the user is opening multiple files
  357. " So open the file in a new window
  358. let split_window = 1
  359. endif
  360. if &buftype != ''
  361. " Current buffer is a special buffer (maybe used by a plugin)
  362. if g:MRU_Use_Current_Window == 0 ||
  363. \ bufnr('%') != bufnr(s:MRU_buf_name)
  364. let split_window = 1
  365. endif
  366. endif
  367. " Edit the file
  368. if split_window
  369. " Current buffer has unsaved changes or is a special buffer or
  370. " is the preview window. So open the file in a new window
  371. if a:edit_type ==# 'edit'
  372. exe 'split ' . esc_fname
  373. else
  374. exe 'sview ' . esc_fname
  375. endif
  376. else
  377. if a:edit_type ==# 'edit'
  378. exe 'edit ' . esc_fname
  379. else
  380. exe 'view ' . esc_fname
  381. endif
  382. endif
  383. endif
  384. endif
  385. endfunc
  386. " MRU_Select_File_Cmd {{{1
  387. " Open a file selected from the MRU window
  388. "
  389. " 'opt' has two values separated by comma. The first value specifies how to
  390. " edit the file and can be either 'edit' or 'view'. The second value
  391. " specifies where to open the file. It can take one of the following values:
  392. " 'useopen' to open file in the previous window
  393. " 'newwin_horiz' to open the file in a new horizontal split window
  394. " 'newwin_vert' to open the file in a new vertical split window.
  395. " 'newtab' to open the file in a new tab.
  396. " If multiple file names are selected using visual mode, then open multiple
  397. " files (either in split windows or tabs)
  398. func! s:MRU_Select_File_Cmd(opt) range abort
  399. let [edit_type, open_type] = split(a:opt, ',')
  400. let fnames = getline(a:firstline, a:lastline)
  401. if g:MRU_Auto_Close == 1 && g:MRU_Use_Current_Window == 0
  402. " Automatically close the window if the file window is
  403. " not used to display the MRU list.
  404. silent! close
  405. endif
  406. let multi = 0
  407. for f in fnames
  408. if f == ''
  409. continue
  410. endif
  411. " The text in the MRU window contains the filename in parenthesis
  412. let file = matchstr(f, g:MRU_Filename_Format.parser)
  413. call s:MRU_Window_Edit_File(file, multi, edit_type, open_type)
  414. if a:firstline != a:lastline
  415. " Opening multiple files
  416. let multi = 1
  417. endif
  418. endfor
  419. endfunc
  420. " MRU_Warn_Msg {{{1
  421. " Display a warning message
  422. func! s:MRU_Warn_Msg(msg) abort
  423. echohl WarningMsg
  424. echo a:msg
  425. echohl None
  426. endfunc
  427. " MRU_Open_Window {{{1
  428. " Display the Most Recently Used file list in a temporary window.
  429. " If the 'pat' argument is not empty, then it specifies the pattern of files
  430. " to selectively display in the MRU window.
  431. " The 'splitdir' argument specifies the location (topleft, belowright, etc.)
  432. " of the MRU window.
  433. func! s:MRU_Open_Window(pat, splitdir) abort
  434. " Load the latest MRU file list
  435. call s:MRU_LoadList()
  436. " Check for empty MRU list
  437. if empty(s:MRU_files)
  438. call s:MRU_Warn_Msg('MRU file list is empty')
  439. return
  440. endif
  441. " Save the current buffer number. This is used later to open a file when a
  442. " entry is selected from the MRU window. The window number is not saved,
  443. " as the window number will change when new windows are opened.
  444. let s:MRU_last_buffer = bufnr('%')
  445. let bname = s:MRU_buf_name
  446. " If the window is already open, jump to it
  447. let winnum = bufwinnr(bname)
  448. if winnum != -1
  449. if winnr() != winnum
  450. " If not already in the window, jump to it
  451. exe winnum . 'wincmd w'
  452. endif
  453. setlocal modifiable
  454. " Delete the contents of the buffer to the black-hole register
  455. silent! %delete _
  456. else
  457. if g:MRU_Use_Current_Window
  458. " Reuse the current window
  459. " If the current buffer has unsaved changes or is a special buffer
  460. " or is the preview window and 'hidden' is not set, then open a
  461. " new window. Otherwise, open in the current window.
  462. if !&hidden && (&modified || &buftype != '' || &previewwindow)
  463. let split_window = 1
  464. else
  465. let split_window = 0
  466. endif
  467. " If the __MRU_Files__ buffer exists, then reuse it. Otherwise open
  468. " a new buffer
  469. let bufnum = bufnr(bname)
  470. if bufnum == -1
  471. if split_window
  472. let cmd = 'botright split edit ' . bname
  473. else
  474. let cmd = 'edit ' . bname
  475. endif
  476. else
  477. if split_window
  478. let cmd = 'botright sbuffer ' . bufnum
  479. else
  480. let cmd = 'buffer ' . bufnum
  481. endif
  482. endif
  483. exe cmd
  484. if bufnr('%') != bufnr(bname)
  485. " Failed to edit the MRU buffer
  486. return
  487. endif
  488. else
  489. " Open a new window at the bottom
  490. let cmd = 'silent! '
  491. if a:splitdir == ''
  492. let cmd .= 'botright '
  493. else
  494. let cmd .= a:splitdir . ' '
  495. endif
  496. let cmd .= g:MRU_Window_Height . 'split '
  497. " If the __MRU_Files__ buffer exists, then reuse it. Otherwise open
  498. " a new buffer
  499. let bufnum = bufnr(bname)
  500. if bufnum == -1
  501. let cmd .= bname
  502. else
  503. let cmd .= '+buffer' . bufnum
  504. endif
  505. exe cmd
  506. endif
  507. endif
  508. setlocal modifiable
  509. " Mark the buffer as scratch
  510. setlocal buftype=nofile
  511. setlocal bufhidden=delete
  512. setlocal noswapfile
  513. setlocal nowrap
  514. setlocal nobuflisted
  515. " Set the 'filetype' to 'mru'. This allows the user to apply custom
  516. " syntax highlighting or other changes to the MRU bufer.
  517. setlocal filetype=mru
  518. " Use fixed height for the MRU window
  519. setlocal winfixheight
  520. " Setup the cpoptions properly for the maps to work
  521. let old_cpoptions = &cpoptions
  522. set cpoptions&vim
  523. " Create mappings to select and edit a file from the MRU list
  524. nnoremap <buffer> <silent> <CR>
  525. \ :call <SID>MRU_Select_File_Cmd('edit,useopen')<CR>
  526. vnoremap <buffer> <silent> <CR>
  527. \ :call <SID>MRU_Select_File_Cmd('edit,useopen')<CR>
  528. nnoremap <buffer> <silent> o
  529. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_horiz')<CR>
  530. vnoremap <buffer> <silent> o
  531. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_horiz')<CR>
  532. nnoremap <buffer> <silent> <S-CR>
  533. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_horiz')<CR>
  534. vnoremap <buffer> <silent> <S-CR>
  535. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_horiz')<CR>
  536. nnoremap <buffer> <silent> O
  537. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_vert')<CR>
  538. vnoremap <buffer> <silent> O
  539. \ :call <SID>MRU_Select_File_Cmd('edit,newwin_vert')<CR>
  540. nnoremap <buffer> <silent> t
  541. \ :call <SID>MRU_Select_File_Cmd('edit,newtab')<CR>
  542. vnoremap <buffer> <silent> t
  543. \ :call <SID>MRU_Select_File_Cmd('edit,newtab')<CR>
  544. nnoremap <buffer> <silent> v
  545. \ :call <SID>MRU_Select_File_Cmd('view,useopen')<CR>
  546. nnoremap <buffer> <silent> p
  547. \ :call <SID>MRU_Select_File_Cmd('view,preview')<CR>
  548. vnoremap <buffer> <silent> p
  549. \ :<C-u>if line("'<") == line("'>")<Bar>
  550. \ call <SID>MRU_Select_File_Cmd('open,preview')<Bar>
  551. \ else<Bar>
  552. \ echoerr "Only a single file can be previewed"<Bar>
  553. \ endif<CR>
  554. nnoremap <buffer> <silent> u :MRU<CR>
  555. nnoremap <buffer> <silent> <2-LeftMouse>
  556. \ :call <SID>MRU_Select_File_Cmd('edit,useopen')<CR>
  557. nnoremap <buffer> <silent> d
  558. \ :<C-U>call <SID>MRU_Delete_From_List()<CR>
  559. nnoremap <buffer> <silent> q :close<CR>
  560. " Restore the previous cpoptions settings
  561. let &cpoptions = old_cpoptions
  562. " Display the MRU list
  563. if a:pat == ''
  564. " No search pattern specified. Display the complete list
  565. let m = copy(s:MRU_files)
  566. else
  567. " Display only the entries matching the specified pattern
  568. " First try using it as a literal pattern
  569. let m = filter(copy(s:MRU_files), 'stridx(v:val, a:pat) != -1')
  570. if len(m) == 0
  571. " No match. Try using it as a regular expression
  572. let m = filter(copy(s:MRU_files), 'v:val =~# a:pat')
  573. endif
  574. endif
  575. " Get the tail part of the file name (without the directory) and display
  576. " it along with the full path in parenthesis.
  577. let output = map(m, g:MRU_Filename_Format.formatter)
  578. silent! 0put =output
  579. " Delete the empty line at the end of the buffer
  580. silent! $delete _
  581. " Move the cursor to the beginning of the file
  582. normal! gg
  583. " Add syntax highlighting for the file names
  584. if has_key(g:MRU_Filename_Format, 'syntax')
  585. exe "syntax match MRUFileName '" . g:MRU_Filename_Format.syntax . "'"
  586. highlight default link MRUFileName Identifier
  587. endif
  588. setlocal nomodifiable
  589. endfunc
  590. " MRU_Complete {{{1
  591. " Command-line completion function used by :MRU command
  592. func! s:MRU_Complete(ArgLead, CmdLine, CursorPos) abort
  593. if a:ArgLead == ''
  594. " Return the complete list of MRU files
  595. return s:MRU_files
  596. else
  597. " Return only the files matching the specified pattern
  598. return filter(copy(s:MRU_files), 'v:val =~? a:ArgLead')
  599. endif
  600. endfunc
  601. " MRU_Cmd {{{1
  602. " Function to handle the MRU command
  603. " pat - File name pattern passed to the MRU command
  604. func! s:MRU_Cmd(pat, splitdir) abort
  605. if a:pat == ''
  606. " No arguments specified. Open the MRU window
  607. call s:MRU_Open_Window('', a:splitdir)
  608. return
  609. endif
  610. " Load the latest MRU file
  611. call s:MRU_LoadList()
  612. " Empty MRU list
  613. if empty(s:MRU_files)
  614. call s:MRU_Warn_Msg('MRU file list is empty')
  615. return
  616. endif
  617. " First use the specified string as a literal string and search for
  618. " filenames containing the string. If only one filename is found,
  619. " then edit it (unless the user wants to open the MRU window always)
  620. let m = filter(copy(s:MRU_files), 'stridx(v:val, a:pat) != -1')
  621. if len(m) > 0
  622. if len(m) == 1 && !g:MRU_Window_Open_Always
  623. call s:MRU_Edit_File(m[0], 0)
  624. return
  625. endif
  626. " More than one file matches. Try find an accurate match
  627. let new_m = filter(m, 'v:val ==# a:pat')
  628. if len(new_m) == 1 && !g:MRU_Window_Open_Always
  629. call s:MRU_Edit_File(new_m[0], 0)
  630. return
  631. endif
  632. " Couldn't find an exact match, open the MRU window with all the
  633. " files matching the pattern.
  634. call s:MRU_Open_Window(a:pat, a:splitdir)
  635. return
  636. endif
  637. " Use the specified string as a regular expression pattern and search
  638. " for filenames matching the pattern
  639. let m = filter(copy(s:MRU_files), 'v:val =~? a:pat')
  640. if len(m) == 0
  641. " If an existing file (not present in the MRU list) is specified,
  642. " then open the file.
  643. if filereadable(a:pat)
  644. call s:MRU_Edit_File(a:pat, 0)
  645. return
  646. endif
  647. " No filenames matching the specified pattern are found
  648. call s:MRU_Warn_Msg("MRU file list doesn't contain " .
  649. \ "files matching " . a:pat)
  650. return
  651. endif
  652. if len(m) == 1 && !g:MRU_Window_Open_Always
  653. call s:MRU_Edit_File(m[0], 0)
  654. return
  655. endif
  656. call s:MRU_Open_Window(a:pat, a:splitdir)
  657. endfunc
  658. " MRU_add_files_to_menu {{{1
  659. " Adds a list of files to the "Recent Files" sub menu under the "File" menu.
  660. " prefix - Prefix to use for each of the menu entries
  661. " file_list - List of file names to add to the menu
  662. func! s:MRU_add_files_to_menu(prefix, file_list) abort
  663. for fname in a:file_list
  664. " Escape special characters in the filename
  665. let esc_fname = escape(fnamemodify(fname, ':t'), ".\\" .
  666. \ s:esc_filename_chars)
  667. let esc_fname = substitute(esc_fname, '&', '&&', 'g')
  668. " Truncate the directory name if it is long
  669. let dir_name = fnamemodify(fname, ':h')
  670. if v:version >= 800 || has("patch-7.4.1730")
  671. let len = strchars(dir_name)
  672. " Shorten long file names by adding only few characters from
  673. " the beginning and end.
  674. if len > 30
  675. let dir_name = strcharpart(dir_name, 0, 10) .
  676. \ '...' .
  677. \ strcharpart(dir_name, len - 20)
  678. endif
  679. else
  680. let len = strlen(dir_name)
  681. " Shorten long file names by adding only few characters from
  682. " the beginning and end.
  683. if len > 30
  684. let dir_name = strpart(dir_name, 0, 10) .
  685. \ '...' .
  686. \ strpart(dir_name, len - 20)
  687. endif
  688. endif
  689. let esc_dir_name = escape(dir_name, ".\\" . s:esc_filename_chars)
  690. let esc_dir_name = substitute(esc_dir_name, '&', '&&', 'g')
  691. let menu_path = '&File.&Recent\ Files.' . a:prefix . esc_fname .
  692. \ '\ (' . esc_dir_name . ')'
  693. let esc_mfname = s:MRU_escape_filename(fname)
  694. exe 'anoremenu <silent> ' . menu_path .
  695. \ " :call <SID>MRU_Edit_File('" . esc_mfname . "', 1)<CR>"
  696. exe 'tmenu ' . menu_path . ' Edit file ' . esc_mfname
  697. endfor
  698. endfunc
  699. " MRU_Refresh_Menu {{{1
  700. " Refresh the MRU menu
  701. func! s:MRU_Refresh_Menu() abort
  702. if !has('menu') || !g:MRU_Add_Menu
  703. " No support for menus
  704. return
  705. endif
  706. " Setup the cpoptions properly for the maps to work
  707. let old_cpoptions = &cpoptions
  708. set cpoptions&vim
  709. " Remove the MRU menu
  710. " To retain the teared-off MRU menu, we need to add a dummy entry
  711. silent! unmenu &File.&Recent\ Files
  712. " The menu priority of the File menu is 10. If the MRU plugin runs
  713. " first before menu.vim, the File menu order may not be correct.
  714. " So specify the priority of the File menu here.
  715. 10noremenu &File.&Recent\ Files.Dummy <Nop>
  716. silent! unmenu! &File.&Recent\ Files
  717. anoremenu <silent> &File.&Recent\ Files.Refresh\ list
  718. \ :call <SID>MRU_LoadList()<CR>
  719. exe 'tmenu File.&Recent\ Files.Refresh\ list Reload the MRU file list from '
  720. \ . s:MRU_escape_filename(g:MRU_File)
  721. anoremenu File.&Recent\ Files.-SEP1- :
  722. " Add the filenames in the MRU list to the menu
  723. let entry_cnt = len(s:MRU_files)
  724. if entry_cnt > g:MRU_Max_Menu_Entries
  725. " Show only MRU_Max_Menu_Entries file names in the menu
  726. let mru_list = s:MRU_files[0 : g:MRU_Max_Menu_Entries - 1]
  727. let entry_cnt = g:MRU_Max_Menu_Entries
  728. else
  729. let mru_list = s:MRU_files
  730. endif
  731. if entry_cnt > g:MRU_Max_Submenu_Entries
  732. " Split the MRU menu into sub-menus
  733. for start_idx in range(0, entry_cnt, g:MRU_Max_Submenu_Entries)
  734. let last_idx = start_idx + g:MRU_Max_Submenu_Entries - 1
  735. if last_idx >= entry_cnt
  736. let last_idx = entry_cnt - 1
  737. endif
  738. let prefix = 'Files\ (' . (start_idx + 1) . '\.\.\.' .
  739. \ (last_idx + 1) . ').'
  740. call s:MRU_add_files_to_menu(prefix,
  741. \ mru_list[start_idx : last_idx])
  742. endfor
  743. else
  744. call s:MRU_add_files_to_menu('', mru_list)
  745. endif
  746. " Remove the dummy menu entry
  747. unmenu &File.&Recent\ Files.Dummy
  748. " Restore the previous cpoptions settings
  749. let &cpoptions = old_cpoptions
  750. endfunc
  751. " MRU_Delete_From_List {{{1
  752. " remove the entry under cursor in the MRU window from the MRU list
  753. func s:MRU_Delete_From_List()
  754. call filter(s:MRU_files,
  755. \ 'v:val != matchstr(getline("."), g:MRU_Filename_Format.parser)')
  756. setlocal modifiable
  757. del _
  758. setlocal nomodifiable
  759. call s:MRU_SaveList()
  760. call s:MRU_Refresh_Menu()
  761. endfunc
  762. " Load the MRU list on plugin startup
  763. call s:MRU_LoadList()
  764. " MRU autocommands {{{1
  765. " Autocommands to detect the most recently used files
  766. autocmd BufRead * call s:MRU_AddFile(expand('<abuf>'))
  767. autocmd BufNewFile * call s:MRU_AddFile(expand('<abuf>'))
  768. autocmd BufWritePost * call s:MRU_AddFile(expand('<abuf>'))
  769. " The ':vimgrep' command adds all the files searched to the buffer list.
  770. " This also modifies the MRU list, even though the user didn't edit the
  771. " files. Use the following autocmds to prevent this.
  772. autocmd QuickFixCmdPre *vimgrep* let s:mru_list_locked = 1
  773. autocmd QuickFixCmdPost *vimgrep* let s:mru_list_locked = 0
  774. " Command to open the MRU window
  775. if v:version >= 800
  776. command! -nargs=? -complete=customlist,s:MRU_Complete MRU
  777. \ call s:MRU_Cmd(<q-args>, <q-mods>)
  778. command! -nargs=? -complete=customlist,s:MRU_Complete Mru
  779. \ call s:MRU_Cmd(<q-args>, <q-mods>)
  780. else
  781. command! -nargs=? -complete=customlist,s:MRU_Complete MRU
  782. \ call s:MRU_Cmd(<q-args>, '')
  783. command! -nargs=? -complete=customlist,s:MRU_Complete Mru
  784. \ call s:MRU_Cmd(<q-args>, '')
  785. endif
  786. " FZF (fuzzy finder) integration
  787. func s:MRU_FZF_EditFile(fname) abort
  788. call s:MRU_Window_Edit_File(a:fname, 0, 'edit', 'useopen')
  789. endfunc
  790. func s:MRU_FZF_Run() abort
  791. if !exists('*fzf#run')
  792. call s:MRU_Warn_Msg('FZF plugin is not present')
  793. return
  794. endif
  795. call fzf#run(fzf#wrap({'source' : s:MRU_files,
  796. \ 'sink' : function('s:MRU_FZF_EditFile'),
  797. \'down' : '25%'}, 0))
  798. endfunc
  799. command! -nargs=0 FZFMru call s:MRU_FZF_Run()
  800. " }}}
  801. " restore 'cpo'
  802. let &cpo = s:cpo_save
  803. unlet s:cpo_save
  804. " vim:set foldenable foldmethod=marker: