plug.vim 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153
  1. " vim-plug: Vim plugin manager
  2. " ============================
  3. "
  4. " Download plug.vim and put it in ~/.vim/autoload
  5. "
  6. " curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
  7. " https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
  8. "
  9. " Edit your .vimrc
  10. "
  11. " call plug#begin('~/.vim/plugged')
  12. "
  13. " " Make sure you use single quotes
  14. "
  15. " " Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
  16. " Plug 'junegunn/vim-easy-align'
  17. "
  18. " " Any valid git URL is allowed
  19. " Plug 'https://github.com/junegunn/vim-github-dashboard.git'
  20. "
  21. " " Group dependencies, vim-snippets depends on ultisnips
  22. " Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
  23. "
  24. " " On-demand loading
  25. " Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
  26. " Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
  27. "
  28. " " Using a non-master branch
  29. " Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
  30. "
  31. " " Plugin options
  32. " Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
  33. "
  34. " " Plugin outside ~/.vim/plugged with post-update hook
  35. " Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
  36. "
  37. " " Unmanaged plugin (manually installed and updated)
  38. " Plug '~/my-prototype-plugin'
  39. "
  40. " " Add plugins to &runtimepath
  41. " call plug#end()
  42. "
  43. " Then reload .vimrc and :PlugInstall to install plugins.
  44. "
  45. " Plug options:
  46. "
  47. "| Option | Description |
  48. "| ----------------------- | ------------------------------------------------ |
  49. "| `branch`/`tag`/`commit` | Branch/tag/commit of the repository to use |
  50. "| `rtp` | Subdirectory that contains Vim plugin |
  51. "| `dir` | Custom directory for the plugin |
  52. "| `as` | Use different name for the plugin |
  53. "| `do` | Post-update hook (string or funcref) |
  54. "| `on` | On-demand loading: Commands or `<Plug>`-mappings |
  55. "| `for` | On-demand loading: File types |
  56. "| `frozen` | Do not update unless explicitly specified |
  57. "
  58. " More information: https://github.com/junegunn/vim-plug
  59. "
  60. "
  61. " Copyright (c) 2015 Junegunn Choi
  62. "
  63. " MIT License
  64. "
  65. " Permission is hereby granted, free of charge, to any person obtaining
  66. " a copy of this software and associated documentation files (the
  67. " "Software"), to deal in the Software without restriction, including
  68. " without limitation the rights to use, copy, modify, merge, publish,
  69. " distribute, sublicense, and/or sell copies of the Software, and to
  70. " permit persons to whom the Software is furnished to do so, subject to
  71. " the following conditions:
  72. "
  73. " The above copyright notice and this permission notice shall be
  74. " included in all copies or substantial portions of the Software.
  75. "
  76. " THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  77. " EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  78. " MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  79. " NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  80. " LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  81. " OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  82. " WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  83. if exists('g:loaded_plug')
  84. finish
  85. endif
  86. let g:loaded_plug = 1
  87. let s:cpo_save = &cpo
  88. set cpo&vim
  89. let s:plug_src = 'https://github.com/junegunn/vim-plug.git'
  90. let s:plug_tab = get(s:, 'plug_tab', -1)
  91. let s:plug_buf = get(s:, 'plug_buf', -1)
  92. let s:mac_gui = has('gui_macvim') && has('gui_running')
  93. let s:is_win = has('win32') || has('win64')
  94. let s:nvim = has('nvim') && exists('*jobwait') && !s:is_win
  95. let s:me = resolve(expand('<sfile>:p'))
  96. let s:base_spec = { 'branch': 'master', 'frozen': 0 }
  97. let s:TYPE = {
  98. \ 'string': type(''),
  99. \ 'list': type([]),
  100. \ 'dict': type({}),
  101. \ 'funcref': type(function('call'))
  102. \ }
  103. let s:loaded = get(s:, 'loaded', {})
  104. let s:triggers = get(s:, 'triggers', {})
  105. function! plug#begin(...)
  106. if a:0 > 0
  107. let s:plug_home_org = a:1
  108. let home = s:path(fnamemodify(expand(a:1), ':p'))
  109. elseif exists('g:plug_home')
  110. let home = s:path(g:plug_home)
  111. elseif !empty(&rtp)
  112. let home = s:path(split(&rtp, ',')[0]) . '/plugged'
  113. else
  114. return s:err('Unable to determine plug home. Try calling plug#begin() with a path argument.')
  115. endif
  116. let g:plug_home = home
  117. let g:plugs = {}
  118. let g:plugs_order = []
  119. let s:triggers = {}
  120. call s:define_commands()
  121. return 1
  122. endfunction
  123. function! s:define_commands()
  124. command! -nargs=+ -bar Plug call s:Plug(<args>)
  125. if !executable('git')
  126. return s:err('`git` executable not found. Most commands will not be available. To suppress this message, prepend `silent!` to `call plug#begin(...)`.')
  127. endif
  128. command! -nargs=* -bar -bang -complete=customlist,s:names PlugInstall call s:install(<bang>0, [<f-args>])
  129. command! -nargs=* -bar -bang -complete=customlist,s:names PlugUpdate call s:update(<bang>0, [<f-args>])
  130. command! -nargs=0 -bar -bang PlugClean call s:clean(<bang>0)
  131. command! -nargs=0 -bar PlugUpgrade if s:upgrade() | execute 'source' s:esc(s:me) | endif
  132. command! -nargs=0 -bar PlugStatus call s:status()
  133. command! -nargs=0 -bar PlugDiff call s:diff()
  134. command! -nargs=? -bar -bang -complete=file PlugSnapshot call s:snapshot(<bang>0, <f-args>)
  135. endfunction
  136. function! s:to_a(v)
  137. return type(a:v) == s:TYPE.list ? a:v : [a:v]
  138. endfunction
  139. function! s:to_s(v)
  140. return type(a:v) == s:TYPE.string ? a:v : join(a:v, "\n") . "\n"
  141. endfunction
  142. function! s:source(from, ...)
  143. for pattern in a:000
  144. for vim in s:lines(globpath(a:from, pattern))
  145. execute 'source' s:esc(vim)
  146. endfor
  147. endfor
  148. endfunction
  149. function! s:assoc(dict, key, val)
  150. let a:dict[a:key] = add(get(a:dict, a:key, []), a:val)
  151. endfunction
  152. function! s:ask(message)
  153. call inputsave()
  154. echohl WarningMsg
  155. let proceed = input(a:message.' (y/N) ') =~? '^y'
  156. echohl None
  157. call inputrestore()
  158. echo "\r"
  159. return proceed
  160. endfunction
  161. function! plug#end()
  162. if !exists('g:plugs')
  163. return s:err('Call plug#begin() first')
  164. endif
  165. if exists('#PlugLOD')
  166. augroup PlugLOD
  167. autocmd!
  168. augroup END
  169. augroup! PlugLOD
  170. endif
  171. let lod = { 'ft': {}, 'map': {}, 'cmd': {} }
  172. filetype off
  173. for name in g:plugs_order
  174. let plug = g:plugs[name]
  175. if get(s:loaded, name, 0) || !has_key(plug, 'on') && !has_key(plug, 'for')
  176. let s:loaded[name] = 1
  177. continue
  178. endif
  179. if has_key(plug, 'on')
  180. let s:triggers[name] = { 'map': [], 'cmd': [] }
  181. for cmd in s:to_a(plug.on)
  182. if cmd =~? '^<Plug>.\+'
  183. if empty(mapcheck(cmd)) && empty(mapcheck(cmd, 'i'))
  184. call s:assoc(lod.map, cmd, name)
  185. endif
  186. call add(s:triggers[name].map, cmd)
  187. elseif cmd =~# '^[A-Z]'
  188. if exists(':'.cmd) != 2
  189. call s:assoc(lod.cmd, cmd, name)
  190. endif
  191. call add(s:triggers[name].cmd, cmd)
  192. else
  193. call s:err('Invalid `on` option: '.cmd.
  194. \ '. Should start with an uppercase letter or `<Plug>`.')
  195. endif
  196. endfor
  197. endif
  198. if has_key(plug, 'for')
  199. let types = s:to_a(plug.for)
  200. if !empty(types)
  201. call s:source(s:rtp(plug), 'ftdetect/**/*.vim', 'after/ftdetect/**/*.vim')
  202. endif
  203. for type in types
  204. call s:assoc(lod.ft, type, name)
  205. endfor
  206. endif
  207. endfor
  208. for [cmd, names] in items(lod.cmd)
  209. execute printf(
  210. \ 'command! -nargs=* -range -bang %s call s:lod_cmd(%s, "<bang>", <line1>, <line2>, <q-args>, %s)',
  211. \ cmd, string(cmd), string(names))
  212. endfor
  213. for [map, names] in items(lod.map)
  214. for [mode, map_prefix, key_prefix] in
  215. \ [['i', '<C-O>', ''], ['n', '', ''], ['v', '', 'gv'], ['o', '', '']]
  216. execute printf(
  217. \ '%snoremap <silent> %s %s:<C-U>call <SID>lod_map(%s, %s, "%s")<CR>',
  218. \ mode, map, map_prefix, string(map), string(names), key_prefix)
  219. endfor
  220. endfor
  221. for [ft, names] in items(lod.ft)
  222. augroup PlugLOD
  223. execute printf('autocmd FileType %s call <SID>lod_ft(%s, %s)',
  224. \ ft, string(ft), string(names))
  225. augroup END
  226. endfor
  227. call s:reorg_rtp()
  228. filetype plugin indent on
  229. if has('vim_starting')
  230. if has('syntax') && !exists('g:syntax_on')
  231. syntax enable
  232. end
  233. else
  234. call s:reload()
  235. endif
  236. endfunction
  237. function! s:loaded_names()
  238. return filter(copy(g:plugs_order), 'get(s:loaded, v:val, 0)')
  239. endfunction
  240. function! s:reload()
  241. for name in s:loaded_names()
  242. call s:source(s:rtp(g:plugs[name]), 'plugin/**/*.vim', 'after/plugin/**/*.vim')
  243. endfor
  244. endfunction
  245. function! s:trim(str)
  246. return substitute(a:str, '[\/]\+$', '', '')
  247. endfunction
  248. function! s:version_requirement(val, min)
  249. for idx in range(0, len(a:min) - 1)
  250. let v = get(a:val, idx, 0)
  251. if v < a:min[idx] | return 0
  252. elseif v > a:min[idx] | return 1
  253. endif
  254. endfor
  255. return 1
  256. endfunction
  257. function! s:git_version_requirement(...)
  258. let s:git_version = get(s:, 'git_version',
  259. \ map(split(split(s:system('git --version'))[-1], '\.'), 'str2nr(v:val)'))
  260. return s:version_requirement(s:git_version, a:000)
  261. endfunction
  262. function! s:progress_opt(base)
  263. return a:base && !s:is_win &&
  264. \ s:git_version_requirement(1, 7, 1) ? '--progress' : ''
  265. endfunction
  266. if s:is_win
  267. function! s:rtp(spec)
  268. return s:path(a:spec.dir . get(a:spec, 'rtp', ''))
  269. endfunction
  270. function! s:path(path)
  271. return s:trim(substitute(a:path, '/', '\', 'g'))
  272. endfunction
  273. function! s:dirpath(path)
  274. return s:path(a:path) . '\'
  275. endfunction
  276. function! s:is_local_plug(repo)
  277. return a:repo =~? '^[a-z]:\|^[%~]'
  278. endfunction
  279. else
  280. function! s:rtp(spec)
  281. return s:dirpath(a:spec.dir . get(a:spec, 'rtp', ''))
  282. endfunction
  283. function! s:path(path)
  284. return s:trim(a:path)
  285. endfunction
  286. function! s:dirpath(path)
  287. return substitute(a:path, '[/\\]*$', '/', '')
  288. endfunction
  289. function! s:is_local_plug(repo)
  290. return a:repo[0] =~ '[/$~]'
  291. endfunction
  292. endif
  293. function! s:err(msg)
  294. echohl ErrorMsg
  295. echom '[vim-plug] '.a:msg
  296. echohl None
  297. return 0
  298. endfunction
  299. function! s:esc(path)
  300. return escape(a:path, ' ')
  301. endfunction
  302. function! s:escrtp(path)
  303. return escape(a:path, ' ,')
  304. endfunction
  305. function! s:remove_rtp()
  306. for name in s:loaded_names()
  307. let rtp = s:rtp(g:plugs[name])
  308. execute 'set rtp-='.s:escrtp(rtp)
  309. let after = globpath(rtp, 'after')
  310. if isdirectory(after)
  311. execute 'set rtp-='.s:escrtp(after)
  312. endif
  313. endfor
  314. endfunction
  315. function! s:reorg_rtp()
  316. if !empty(s:first_rtp)
  317. execute 'set rtp-='.s:first_rtp
  318. execute 'set rtp-='.s:last_rtp
  319. endif
  320. " &rtp is modified from outside
  321. if exists('s:prtp') && s:prtp !=# &rtp
  322. call s:remove_rtp()
  323. unlet! s:middle
  324. endif
  325. let s:middle = get(s:, 'middle', &rtp)
  326. let rtps = map(s:loaded_names(), 's:rtp(g:plugs[v:val])')
  327. let afters = filter(map(copy(rtps), 'globpath(v:val, "after")'), 'isdirectory(v:val)')
  328. let rtp = join(map(rtps, 'escape(v:val, ",")'), ',')
  329. \ . ','.s:middle.','
  330. \ . join(map(afters, 'escape(v:val, ",")'), ',')
  331. let &rtp = substitute(substitute(rtp, ',,*', ',', 'g'), '^,\|,$', '', 'g')
  332. let s:prtp = &rtp
  333. if !empty(s:first_rtp)
  334. execute 'set rtp^='.s:first_rtp
  335. execute 'set rtp+='.s:last_rtp
  336. endif
  337. endfunction
  338. function! plug#load(...)
  339. if a:0 == 0
  340. return s:err('Argument missing: plugin name(s) required')
  341. endif
  342. if !exists('g:plugs')
  343. return s:err('plug#begin was not called')
  344. endif
  345. let unknowns = filter(copy(a:000), '!has_key(g:plugs, v:val)')
  346. if !empty(unknowns)
  347. let s = len(unknowns) > 1 ? 's' : ''
  348. return s:err(printf('Unknown plugin%s: %s', s, join(unknowns, ', ')))
  349. end
  350. for name in a:000
  351. call s:lod([name], ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  352. endfor
  353. if exists('#BufRead')
  354. doautocmd BufRead
  355. endif
  356. return 1
  357. endfunction
  358. function! s:remove_triggers(name)
  359. if !has_key(s:triggers, a:name)
  360. return
  361. endif
  362. for cmd in s:triggers[a:name].cmd
  363. execute 'silent! delc' cmd
  364. endfor
  365. for map in s:triggers[a:name].map
  366. execute 'silent! unmap' map
  367. execute 'silent! iunmap' map
  368. endfor
  369. call remove(s:triggers, a:name)
  370. endfunction
  371. function! s:lod(names, types, ...)
  372. for name in a:names
  373. call s:remove_triggers(name)
  374. let s:loaded[name] = 1
  375. endfor
  376. call s:reorg_rtp()
  377. for name in a:names
  378. let rtp = s:rtp(g:plugs[name])
  379. for dir in a:types
  380. call s:source(rtp, dir.'/**/*.vim')
  381. endfor
  382. for file in a:000
  383. call s:source(rtp, file)
  384. endfor
  385. if exists('#User#'.name)
  386. execute 'doautocmd User' name
  387. endif
  388. endfor
  389. endfunction
  390. function! s:lod_ft(pat, names)
  391. let syn = 'syntax/'.a:pat.'.vim'
  392. call s:lod(a:names, ['plugin', 'after/plugin'], syn, 'after/'.syn)
  393. execute 'autocmd! PlugLOD FileType' a:pat
  394. if exists('#filetypeplugin#FileType')
  395. doautocmd filetypeplugin FileType
  396. endif
  397. if exists('#filetypeindent#FileType')
  398. doautocmd filetypeindent FileType
  399. endif
  400. endfunction
  401. function! s:lod_cmd(cmd, bang, l1, l2, args, names)
  402. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  403. execute printf('%s%s%s %s', (a:l1 == a:l2 ? '' : (a:l1.','.a:l2)), a:cmd, a:bang, a:args)
  404. endfunction
  405. function! s:lod_map(map, names, prefix)
  406. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  407. let extra = ''
  408. while 1
  409. let c = getchar(0)
  410. if c == 0
  411. break
  412. endif
  413. let extra .= nr2char(c)
  414. endwhile
  415. call feedkeys(a:prefix . substitute(a:map, '^<Plug>', "\<Plug>", '') . extra)
  416. endfunction
  417. function! s:Plug(repo, ...)
  418. if a:0 > 1
  419. return s:err('Invalid number of arguments (1..2)')
  420. endif
  421. try
  422. let repo = s:trim(a:repo)
  423. let opts = a:0 == 1 ? s:parse_options(a:1) : s:base_spec
  424. let name = get(opts, 'as', fnamemodify(repo, ':t:s?\.git$??'))
  425. let spec = extend(s:infer_properties(name, repo), opts)
  426. if !has_key(g:plugs, name)
  427. call add(g:plugs_order, name)
  428. endif
  429. let g:plugs[name] = spec
  430. let s:loaded[name] = get(s:loaded, name, 0)
  431. catch
  432. return s:err(v:exception)
  433. endtry
  434. endfunction
  435. function! s:parse_options(arg)
  436. let opts = copy(s:base_spec)
  437. let type = type(a:arg)
  438. if type == s:TYPE.string
  439. let opts.tag = a:arg
  440. elseif type == s:TYPE.dict
  441. call extend(opts, a:arg)
  442. if has_key(opts, 'dir')
  443. let opts.dir = s:dirpath(expand(opts.dir))
  444. endif
  445. else
  446. throw 'Invalid argument type (expected: string or dictionary)'
  447. endif
  448. return opts
  449. endfunction
  450. function! s:infer_properties(name, repo)
  451. let repo = a:repo
  452. if s:is_local_plug(repo)
  453. return { 'dir': s:dirpath(expand(repo)) }
  454. else
  455. if repo =~ ':'
  456. let uri = repo
  457. else
  458. if repo !~ '/'
  459. let repo = 'vim-scripts/'. repo
  460. endif
  461. let fmt = get(g:, 'plug_url_format', 'https://git::@github.com/%s.git')
  462. let uri = printf(fmt, repo)
  463. endif
  464. let dir = s:dirpath( fnamemodify(join([g:plug_home, a:name], '/'), ':p') )
  465. return { 'dir': dir, 'uri': uri }
  466. endif
  467. endfunction
  468. function! s:install(force, names)
  469. call s:update_impl(0, a:force, a:names)
  470. endfunction
  471. function! s:update(force, names)
  472. call s:update_impl(1, a:force, a:names)
  473. endfunction
  474. function! plug#helptags()
  475. if !exists('g:plugs')
  476. return s:err('plug#begin was not called')
  477. endif
  478. for spec in values(g:plugs)
  479. let docd = join([spec.dir, 'doc'], '/')
  480. if isdirectory(docd)
  481. silent! execute 'helptags' s:esc(docd)
  482. endif
  483. endfor
  484. return 1
  485. endfunction
  486. function! s:syntax()
  487. syntax clear
  488. syntax region plug1 start=/\%1l/ end=/\%2l/ contains=plugNumber
  489. syntax region plug2 start=/\%2l/ end=/\%3l/ contains=plugBracket,plugX
  490. syn match plugNumber /[0-9]\+[0-9.]*/ contained
  491. syn match plugBracket /[[\]]/ contained
  492. syn match plugX /x/ contained
  493. syn match plugDash /^-/
  494. syn match plugPlus /^+/
  495. syn match plugStar /^*/
  496. syn match plugMessage /\(^- \)\@<=.*/
  497. syn match plugName /\(^- \)\@<=[^ ]*:/
  498. syn match plugSha /\%(: \)\@<=[0-9a-z]\{4,}$/
  499. syn match plugTag /(tag: [^)]\+)/
  500. syn match plugInstall /\(^+ \)\@<=[^:]*/
  501. syn match plugUpdate /\(^* \)\@<=[^:]*/
  502. syn match plugCommit /^ [0-9a-z]\{7} .*/ contains=plugRelDate,plugSha,plugTag
  503. syn match plugSha /\(^ \)\@<=[0-9a-z]\{7}/ contained
  504. syn match plugRelDate /([^)]*)$/ contained
  505. syn match plugNotLoaded /(not loaded)$/
  506. syn match plugError /^x.*/
  507. syn match plugH2 /^.*:\n-\+$/
  508. syn keyword Function PlugInstall PlugStatus PlugUpdate PlugClean
  509. hi def link plug1 Title
  510. hi def link plug2 Repeat
  511. hi def link plugH2 Type
  512. hi def link plugX Exception
  513. hi def link plugBracket Structure
  514. hi def link plugNumber Number
  515. hi def link plugDash Special
  516. hi def link plugPlus Constant
  517. hi def link plugStar Boolean
  518. hi def link plugMessage Function
  519. hi def link plugName Label
  520. hi def link plugInstall Function
  521. hi def link plugUpdate Type
  522. hi def link plugError Error
  523. hi def link plugRelDate Comment
  524. hi def link plugSha Identifier
  525. hi def link plugTag Constant
  526. hi def link plugNotLoaded Comment
  527. endfunction
  528. function! s:lpad(str, len)
  529. return a:str . repeat(' ', a:len - len(a:str))
  530. endfunction
  531. function! s:lines(msg)
  532. return split(a:msg, "[\r\n]")
  533. endfunction
  534. function! s:lastline(msg)
  535. return get(s:lines(a:msg), -1, '')
  536. endfunction
  537. function! s:new_window()
  538. execute get(g:, 'plug_window', 'vertical topleft new')
  539. endfunction
  540. function! s:plug_window_exists()
  541. let buflist = tabpagebuflist(s:plug_tab)
  542. return !empty(buflist) && index(buflist, s:plug_buf) >= 0
  543. endfunction
  544. function! s:switch_in()
  545. if !s:plug_window_exists()
  546. return 0
  547. endif
  548. if winbufnr(0) != s:plug_buf
  549. let s:pos = [tabpagenr(), winnr(), winsaveview()]
  550. execute 'normal!' s:plug_tab.'gt'
  551. let winnr = bufwinnr(s:plug_buf)
  552. execute winnr.'wincmd w'
  553. call add(s:pos, winsaveview())
  554. else
  555. let s:pos = [winsaveview()]
  556. endif
  557. setlocal modifiable
  558. return 1
  559. endfunction
  560. function! s:switch_out(...)
  561. call winrestview(s:pos[-1])
  562. setlocal nomodifiable
  563. if a:0 > 0
  564. execute a:1
  565. endif
  566. if len(s:pos) > 1
  567. execute 'normal!' s:pos[0].'gt'
  568. execute s:pos[1] 'wincmd w'
  569. call winrestview(s:pos[2])
  570. endif
  571. endfunction
  572. function! s:finish_bindings()
  573. nnoremap <silent> <buffer> R :silent! call <SID>retry()<cr>
  574. nnoremap <silent> <buffer> D :PlugDiff<cr>
  575. nnoremap <silent> <buffer> S :PlugStatus<cr>
  576. nnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  577. xnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  578. nnoremap <silent> <buffer> ]] :silent! call <SID>section('')<cr>
  579. nnoremap <silent> <buffer> [[ :silent! call <SID>section('b')<cr>
  580. endfunction
  581. function! s:prepare(...)
  582. call s:job_abort()
  583. if s:switch_in()
  584. normal q
  585. endif
  586. call s:new_window()
  587. nnoremap <silent> <buffer> q :if b:plug_preview==1<bar>pc<bar>endif<bar>bd<cr>
  588. if a:0 == 0
  589. call s:finish_bindings()
  590. endif
  591. let b:plug_preview = -1
  592. let s:plug_tab = tabpagenr()
  593. let s:plug_buf = winbufnr(0)
  594. call s:assign_name()
  595. silent! unmap <buffer> <cr>
  596. silent! unmap <buffer> L
  597. silent! unmap <buffer> o
  598. silent! unmap <buffer> X
  599. setlocal buftype=nofile bufhidden=wipe nobuflisted noswapfile nowrap cursorline modifiable
  600. setf vim-plug
  601. if exists('g:syntax_on')
  602. call s:syntax()
  603. endif
  604. endfunction
  605. function! s:assign_name()
  606. " Assign buffer name
  607. let prefix = '[Plugins]'
  608. let name = prefix
  609. let idx = 2
  610. while bufexists(name)
  611. let name = printf('%s (%s)', prefix, idx)
  612. let idx = idx + 1
  613. endwhile
  614. silent! execute 'f' fnameescape(name)
  615. endfunction
  616. function! s:do(pull, force, todo)
  617. for [name, spec] in items(a:todo)
  618. if !isdirectory(spec.dir)
  619. continue
  620. endif
  621. let installed = has_key(s:update.new, name)
  622. let updated = installed ? 0 :
  623. \ (a:pull && index(s:update.errors, name) < 0 && !empty(s:system_chomp('git log --pretty=format:"%h" "HEAD...HEAD@{1}"', spec.dir)))
  624. if a:force || installed || updated
  625. execute 'cd' s:esc(spec.dir)
  626. call append(3, '- Post-update hook for '. name .' ... ')
  627. let error = ''
  628. let type = type(spec.do)
  629. if type == s:TYPE.string
  630. try
  631. " FIXME: Escaping is incomplete. We could use shellescape with eval,
  632. " but it won't work on Windows.
  633. let g:_plug_do = '!'.escape(spec.do, '#!%')
  634. execute "normal! :execute g:_plug_do\<cr>\<cr>"
  635. finally
  636. if v:shell_error
  637. let error = 'Exit status: ' . v:shell_error
  638. endif
  639. unlet g:_plug_do
  640. endtry
  641. elseif type == s:TYPE.funcref
  642. try
  643. let status = installed ? 'installed' : (updated ? 'updated' : 'unchanged')
  644. call spec.do({ 'name': name, 'status': status, 'force': a:force })
  645. catch
  646. let error = v:exception
  647. endtry
  648. else
  649. let error = 'Invalid hook type'
  650. endif
  651. call setline(4, empty(error) ? (getline(4) . 'OK')
  652. \ : ('x' . getline(4)[1:] . error))
  653. cd -
  654. endif
  655. endfor
  656. endfunction
  657. function! s:hash_match(a, b)
  658. return stridx(a:a, a:b) == 0 || stridx(a:b, a:a) == 0
  659. endfunction
  660. function! s:checkout(plugs)
  661. for [name, spec] in items(a:plugs)
  662. let sha = spec.commit
  663. call append(3, '- Checking out '.sha[:6].' of '.name.' ... ')
  664. redraw
  665. let error = []
  666. let output = s:lines(s:system('git rev-parse HEAD', spec.dir))
  667. if v:shell_error
  668. let error = output
  669. elseif !s:hash_match(sha, output[0])
  670. let output = s:lines(s:system(
  671. \ 'git fetch --depth 999999 && git checkout '.sha, spec.dir))
  672. if v:shell_error
  673. let error = output
  674. endif
  675. endif
  676. if empty(error)
  677. call setline(4, getline(4) . 'OK')
  678. else
  679. call setline(4, 'x'.getline(4)[1:] . 'Error')
  680. for line in reverse(error)
  681. call append(4, ' '.line)
  682. endfor
  683. endif
  684. endfor
  685. endfunction
  686. function! s:finish(pull)
  687. let new_frozen = len(filter(keys(s:update.new), 'g:plugs[v:val].frozen'))
  688. if new_frozen
  689. let s = new_frozen > 1 ? 's' : ''
  690. call append(3, printf('- Installed %d frozen plugin%s', new_frozen, s))
  691. endif
  692. call append(3, '- Finishing ... ')
  693. redraw
  694. call plug#helptags()
  695. call plug#end()
  696. call setline(4, getline(4) . 'Done!')
  697. redraw
  698. let msgs = []
  699. if !empty(s:update.errors)
  700. call add(msgs, "Press 'R' to retry.")
  701. endif
  702. if a:pull && len(s:update.new) < len(filter(getline(5, '$'),
  703. \ "v:val =~ '^- ' && stridx(v:val, 'Already up-to-date') < 0"))
  704. call add(msgs, "Press 'D' to see the updated changes.")
  705. endif
  706. echo join(msgs, ' ')
  707. call s:finish_bindings()
  708. endfunction
  709. function! s:retry()
  710. if empty(s:update.errors)
  711. return
  712. endif
  713. call s:update_impl(s:update.pull, s:update.force,
  714. \ extend(copy(s:update.errors), [s:update.threads]))
  715. endfunction
  716. function! s:is_managed(name)
  717. return has_key(g:plugs[a:name], 'uri')
  718. endfunction
  719. function! s:names(...)
  720. return sort(filter(keys(g:plugs), 'stridx(v:val, a:1) == 0 && s:is_managed(v:val)'))
  721. endfunction
  722. function! s:update_impl(pull, force, args) abort
  723. let args = copy(a:args)
  724. let threads = (len(args) > 0 && args[-1] =~ '^[1-9][0-9]*$') ?
  725. \ remove(args, -1) : get(g:, 'plug_threads', 16)
  726. let managed = filter(copy(g:plugs), 's:is_managed(v:key)')
  727. let todo = empty(args) ? filter(managed, '!v:val.frozen || !isdirectory(v:val.dir)') :
  728. \ filter(managed, 'index(args, v:key) >= 0')
  729. if empty(todo)
  730. echohl WarningMsg
  731. echo 'No plugin to '. (a:pull ? 'update' : 'install') . '.'
  732. echohl None
  733. return
  734. endif
  735. if !s:is_win && s:git_version_requirement(2, 3)
  736. let s:git_terminal_prompt = exists('$GIT_TERMINAL_PROMPT') ? $GIT_TERMINAL_PROMPT : ''
  737. let $GIT_TERMINAL_PROMPT = 0
  738. for plug in values(todo)
  739. let plug.uri = substitute(plug.uri,
  740. \ '^https://git::@github\.com', 'https://github.com', '')
  741. endfor
  742. endif
  743. if !isdirectory(g:plug_home)
  744. try
  745. call mkdir(g:plug_home, 'p')
  746. catch
  747. return s:err(printf('Invalid plug directory: %s. '.
  748. \ 'Try to call plug#begin with a valid directory', g:plug_home))
  749. endtry
  750. endif
  751. if has('nvim') && !exists('*jobwait') && threads > 1
  752. echohl WarningMsg
  753. echomsg 'vim-plug: update Neovim for parallel installer'
  754. echohl None
  755. endif
  756. let python = (has('python') || has('python3')) && (!s:nvim || has('vim_starting'))
  757. let ruby = has('ruby') && !s:nvim && (v:version >= 703 || v:version == 702 && has('patch374')) && !(s:is_win && has('gui_running'))
  758. let s:update = {
  759. \ 'start': reltime(),
  760. \ 'all': todo,
  761. \ 'todo': copy(todo),
  762. \ 'errors': [],
  763. \ 'pull': a:pull,
  764. \ 'force': a:force,
  765. \ 'new': {},
  766. \ 'threads': (python || ruby || s:nvim) ? min([len(todo), threads]) : 1,
  767. \ 'bar': '',
  768. \ 'fin': 0
  769. \ }
  770. call s:prepare(1)
  771. call append(0, ['', ''])
  772. normal! 2G
  773. silent! redraw
  774. let s:clone_opt = get(g:, 'plug_shallow', 1) ?
  775. \ '--depth 1' . (s:git_version_requirement(1, 7, 10) ? ' --no-single-branch' : '') : ''
  776. " Python version requirement (>= 2.7)
  777. if python && !has('python3') && !ruby && !s:nvim && s:update.threads > 1
  778. redir => pyv
  779. silent python import platform; print platform.python_version()
  780. redir END
  781. let python = s:version_requirement(
  782. \ map(split(split(pyv)[0], '\.'), 'str2nr(v:val)'), [2, 6])
  783. endif
  784. if (python || ruby) && s:update.threads > 1
  785. try
  786. let imd = &imd
  787. if s:mac_gui
  788. set noimd
  789. endif
  790. if ruby
  791. call s:update_ruby()
  792. else
  793. call s:update_python()
  794. endif
  795. catch
  796. let lines = getline(4, '$')
  797. let printed = {}
  798. silent! 4,$d _
  799. for line in lines
  800. let name = s:extract_name(line, '.', '')
  801. if empty(name) || !has_key(printed, name)
  802. call append('$', line)
  803. if !empty(name)
  804. let printed[name] = 1
  805. if line[0] == 'x' && index(s:update.errors, name) < 0
  806. call add(s:update.errors, name)
  807. end
  808. endif
  809. endif
  810. endfor
  811. finally
  812. let &imd = imd
  813. call s:update_finish()
  814. endtry
  815. else
  816. call s:update_vim()
  817. endif
  818. endfunction
  819. function! s:update_finish()
  820. if exists('s:git_terminal_prompt')
  821. let $GIT_TERMINAL_PROMPT = s:git_terminal_prompt
  822. endif
  823. if s:switch_in()
  824. call s:checkout(filter(copy(s:update.all), 'has_key(v:val, "commit")'))
  825. call s:do(s:update.pull, s:update.force, filter(copy(s:update.all), 'has_key(v:val, "do")'))
  826. call s:finish(s:update.pull)
  827. call setline(1, 'Updated. Elapsed time: ' . split(reltimestr(reltime(s:update.start)))[0] . ' sec.')
  828. call s:switch_out('normal! gg')
  829. endif
  830. endfunction
  831. function! s:job_abort()
  832. if !s:nvim || !exists('s:jobs')
  833. return
  834. endif
  835. for [name, j] in items(s:jobs)
  836. silent! call jobstop(j.jobid)
  837. if j.new
  838. call s:system('rm -rf ' . s:shellesc(g:plugs[name].dir))
  839. endif
  840. endfor
  841. let s:jobs = {}
  842. endfunction
  843. " When a:event == 'stdout', data = list of strings
  844. " When a:event == 'exit', data = returncode
  845. function! s:job_handler(job_id, data, event) abort
  846. if !s:plug_window_exists() " plug window closed
  847. return s:job_abort()
  848. endif
  849. if a:event == 'stdout'
  850. let complete = empty(a:data[-1])
  851. let lines = map(filter(a:data, 'len(v:val) > 0'), 'split(v:val, "[\r\n]")[-1]')
  852. call extend(self.lines, lines)
  853. let self.result = join(self.lines, "\n")
  854. if !complete
  855. call remove(self.lines, -1)
  856. endif
  857. " To reduce the number of buffer updates
  858. let self.tick = get(self, 'tick', -1) + 1
  859. if self.tick % len(s:jobs) == 0
  860. call s:log(self.new ? '+' : '*', self.name, self.result)
  861. endif
  862. elseif a:event == 'exit'
  863. let self.running = 0
  864. if a:data != 0
  865. let self.error = 1
  866. endif
  867. call s:reap(self.name)
  868. call s:tick()
  869. endif
  870. endfunction
  871. function! s:spawn(name, cmd, opts)
  872. let job = { 'name': a:name, 'running': 1, 'error': 0, 'lines': [], 'result': '',
  873. \ 'new': get(a:opts, 'new', 0),
  874. \ 'on_stdout': function('s:job_handler'),
  875. \ 'on_exit' : function('s:job_handler'),
  876. \ }
  877. let s:jobs[a:name] = job
  878. if s:nvim
  879. let argv = [ 'sh', '-c',
  880. \ (has_key(a:opts, 'dir') ? s:with_cd(a:cmd, a:opts.dir) : a:cmd) ]
  881. let jid = jobstart(argv, job)
  882. if jid > 0
  883. let job.jobid = jid
  884. else
  885. let job.running = 0
  886. let job.error = 1
  887. let job.result = jid < 0 ? 'sh is not executable' :
  888. \ 'Invalid arguments (or job table is full)'
  889. endif
  890. else
  891. let params = has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]
  892. let job.result = call('s:system', params)
  893. let job.error = v:shell_error != 0
  894. let job.running = 0
  895. endif
  896. endfunction
  897. function! s:reap(name)
  898. let job = s:jobs[a:name]
  899. if job.error
  900. call add(s:update.errors, a:name)
  901. elseif get(job, 'new', 0)
  902. let s:update.new[a:name] = 1
  903. endif
  904. let s:update.bar .= job.error ? 'x' : '='
  905. call s:log(job.error ? 'x' : '-', a:name, job.result)
  906. call s:bar()
  907. call remove(s:jobs, a:name)
  908. endfunction
  909. function! s:bar()
  910. if s:switch_in()
  911. let total = len(s:update.all)
  912. call setline(1, (s:update.pull ? 'Updating' : 'Installing').
  913. \ ' plugins ('.len(s:update.bar).'/'.total.')')
  914. call s:progress_bar(2, s:update.bar, total)
  915. call s:switch_out()
  916. endif
  917. endfunction
  918. function! s:logpos(name)
  919. for i in range(1, line('$'))
  920. if getline(i) =~# '^[-+x*] '.a:name.':'
  921. return i
  922. endif
  923. endfor
  924. return 0
  925. endfunction
  926. function! s:log(bullet, name, lines)
  927. if s:switch_in()
  928. let pos = s:logpos(a:name)
  929. if pos > 0
  930. execute pos 'd _'
  931. if pos > winheight('.')
  932. let pos = 4
  933. endif
  934. else
  935. let pos = 4
  936. endif
  937. call append(pos - 1, s:format_message(a:bullet, a:name, a:lines))
  938. call s:switch_out()
  939. endif
  940. endfunction
  941. function! s:update_vim()
  942. let s:jobs = {}
  943. call s:bar()
  944. call s:tick()
  945. endfunction
  946. function! s:tick()
  947. let pull = s:update.pull
  948. let prog = s:progress_opt(s:nvim)
  949. while 1 " Without TCO, Vim stack is bound to explode
  950. if empty(s:update.todo)
  951. if empty(s:jobs) && !s:update.fin
  952. let s:update.fin = 1
  953. call s:update_finish()
  954. endif
  955. return
  956. endif
  957. let name = keys(s:update.todo)[0]
  958. let spec = remove(s:update.todo, name)
  959. let new = !isdirectory(spec.dir)
  960. call s:log(new ? '+' : '*', name, pull ? 'Updating ...' : 'Installing ...')
  961. redraw
  962. let has_tag = has_key(spec, 'tag')
  963. let checkout = s:shellesc(has_tag ? spec.tag : spec.branch)
  964. let merge = s:shellesc(has_tag ? spec.tag : 'origin/'.spec.branch)
  965. if !new
  966. let error = s:git_validate(spec, 0)
  967. if empty(error)
  968. if pull
  969. let fetch_opt = (has_tag && !empty(globpath(spec.dir, '.git/shallow'))) ? '--depth 99999999' : ''
  970. call s:spawn(name,
  971. \ printf('(git fetch %s %s 2>&1 && git checkout -q %s 2>&1 && git merge --ff-only %s 2>&1 && git submodule update --init --recursive 2>&1)',
  972. \ fetch_opt, prog, checkout, merge), { 'dir': spec.dir })
  973. else
  974. let s:jobs[name] = { 'running': 0, 'result': 'Already installed', 'error': 0 }
  975. endif
  976. else
  977. let s:jobs[name] = { 'running': 0, 'result': error, 'error': 1 }
  978. endif
  979. else
  980. call s:spawn(name,
  981. \ printf('git clone %s %s --recursive %s -b %s %s 2>&1',
  982. \ has_tag ? '' : s:clone_opt,
  983. \ prog,
  984. \ s:shellesc(spec.uri),
  985. \ checkout,
  986. \ s:shellesc(s:trim(spec.dir))), { 'new': 1 })
  987. endif
  988. if !s:jobs[name].running
  989. call s:reap(name)
  990. endif
  991. if len(s:jobs) >= s:update.threads
  992. break
  993. endif
  994. endwhile
  995. endfunction
  996. function! s:update_python()
  997. let py_exe = has('python') ? 'python' : 'python3'
  998. execute py_exe "<< EOF"
  999. import datetime
  1000. import functools
  1001. import os
  1002. try:
  1003. import queue
  1004. except ImportError:
  1005. import Queue as queue
  1006. import random
  1007. import re
  1008. import shutil
  1009. import signal
  1010. import subprocess
  1011. import tempfile
  1012. import threading as thr
  1013. import time
  1014. import traceback
  1015. import vim
  1016. G_NVIM = vim.eval("has('nvim')") == '1'
  1017. G_PULL = vim.eval('s:update.pull') == '1'
  1018. G_RETRIES = int(vim.eval('get(g:, "plug_retries", 2)')) + 1
  1019. G_TIMEOUT = int(vim.eval('get(g:, "plug_timeout", 60)'))
  1020. G_CLONE_OPT = vim.eval('s:clone_opt')
  1021. G_PROGRESS = vim.eval('s:progress_opt(1)')
  1022. G_LOG_PROB = 1.0 / int(vim.eval('s:update.threads'))
  1023. G_STOP = thr.Event()
  1024. G_IS_WIN = vim.eval('s:is_win') == '1'
  1025. class PlugError(Exception):
  1026. def __init__(self, msg):
  1027. self.msg = msg
  1028. class CmdTimedOut(PlugError):
  1029. pass
  1030. class CmdFailed(PlugError):
  1031. pass
  1032. class InvalidURI(PlugError):
  1033. pass
  1034. class Action(object):
  1035. INSTALL, UPDATE, ERROR, DONE = ['+', '*', 'x', '-']
  1036. class Buffer(object):
  1037. def __init__(self, lock, num_plugs, is_pull):
  1038. self.bar = ''
  1039. self.event = 'Updating' if is_pull else 'Installing'
  1040. self.lock = lock
  1041. self.maxy = int(vim.eval('winheight(".")'))
  1042. self.num_plugs = num_plugs
  1043. def __where(self, name):
  1044. """ Find first line with name in current buffer. Return line num. """
  1045. found, lnum = False, 0
  1046. matcher = re.compile('^[-+x*] {0}:'.format(name))
  1047. for line in vim.current.buffer:
  1048. if matcher.search(line) is not None:
  1049. found = True
  1050. break
  1051. lnum += 1
  1052. if not found:
  1053. lnum = -1
  1054. return lnum
  1055. def header(self):
  1056. curbuf = vim.current.buffer
  1057. curbuf[0] = self.event + ' plugins ({0}/{1})'.format(len(self.bar), self.num_plugs)
  1058. num_spaces = self.num_plugs - len(self.bar)
  1059. curbuf[1] = '[{0}{1}]'.format(self.bar, num_spaces * ' ')
  1060. with self.lock:
  1061. vim.command('normal! 2G')
  1062. vim.command('redraw')
  1063. def write(self, action, name, lines):
  1064. first, rest = lines[0], lines[1:]
  1065. msg = ['{0} {1}{2}{3}'.format(action, name, ': ' if first else '', first)]
  1066. msg.extend([' ' + line for line in rest])
  1067. try:
  1068. if action == Action.ERROR:
  1069. self.bar += 'x'
  1070. vim.command("call add(s:update.errors, '{0}')".format(name))
  1071. elif action == Action.DONE:
  1072. self.bar += '='
  1073. curbuf = vim.current.buffer
  1074. lnum = self.__where(name)
  1075. if lnum != -1: # Found matching line num
  1076. del curbuf[lnum]
  1077. if lnum > self.maxy and action in set([Action.INSTALL, Action.UPDATE]):
  1078. lnum = 3
  1079. else:
  1080. lnum = 3
  1081. curbuf.append(msg, lnum)
  1082. self.header()
  1083. except vim.error:
  1084. pass
  1085. class Command(object):
  1086. CD = 'cd /d' if G_IS_WIN else 'cd'
  1087. def __init__(self, cmd, cmd_dir=None, timeout=60, cb=None, clean=None):
  1088. self.cmd = cmd
  1089. if cmd_dir:
  1090. self.cmd = '{0} {1} && {2}'.format(Command.CD, cmd_dir, self.cmd)
  1091. self.timeout = timeout
  1092. self.callback = cb if cb else (lambda msg: None)
  1093. self.clean = clean if clean else (lambda: None)
  1094. self.proc = None
  1095. @property
  1096. def alive(self):
  1097. """ Returns true only if command still running. """
  1098. return self.proc and self.proc.poll() is None
  1099. def execute(self, ntries=3):
  1100. """ Execute the command with ntries if CmdTimedOut.
  1101. Returns the output of the command if no Exception.
  1102. """
  1103. attempt, finished, limit = 0, False, self.timeout
  1104. while not finished:
  1105. try:
  1106. attempt += 1
  1107. result = self.try_command()
  1108. finished = True
  1109. return result
  1110. except CmdTimedOut:
  1111. if attempt != ntries:
  1112. self.notify_retry()
  1113. self.timeout += limit
  1114. else:
  1115. raise
  1116. def notify_retry(self):
  1117. """ Retry required for command, notify user. """
  1118. for count in range(3, 0, -1):
  1119. if G_STOP.is_set():
  1120. raise KeyboardInterrupt
  1121. msg = 'Timeout. Will retry in {0} second{1} ...'.format(
  1122. count, 's' if count != 1 else '')
  1123. self.callback([msg])
  1124. time.sleep(1)
  1125. self.callback(['Retrying ...'])
  1126. def try_command(self):
  1127. """ Execute a cmd & poll for callback. Returns list of output.
  1128. Raises CmdFailed -> return code for Popen isn't 0
  1129. Raises CmdTimedOut -> command exceeded timeout without new output
  1130. """
  1131. first_line = True
  1132. try:
  1133. tfile = tempfile.NamedTemporaryFile(mode='w+b')
  1134. preexec_fn = not G_IS_WIN and os.setsid or None
  1135. self.proc = subprocess.Popen(self.cmd, stdout=tfile,
  1136. stderr=subprocess.STDOUT,
  1137. stdin=subprocess.PIPE, shell=True,
  1138. preexec_fn=preexec_fn)
  1139. thrd = thr.Thread(target=(lambda proc: proc.wait()), args=(self.proc,))
  1140. thrd.start()
  1141. thread_not_started = True
  1142. while thread_not_started:
  1143. try:
  1144. thrd.join(0.1)
  1145. thread_not_started = False
  1146. except RuntimeError:
  1147. pass
  1148. while self.alive:
  1149. if G_STOP.is_set():
  1150. raise KeyboardInterrupt
  1151. if first_line or random.random() < G_LOG_PROB:
  1152. first_line = False
  1153. line = '' if G_IS_WIN else nonblock_read(tfile.name)
  1154. if line:
  1155. self.callback([line])
  1156. time_diff = time.time() - os.path.getmtime(tfile.name)
  1157. if time_diff > self.timeout:
  1158. raise CmdTimedOut(['Timeout!'])
  1159. thrd.join(0.5)
  1160. tfile.seek(0)
  1161. result = [line.decode('utf-8', 'replace').rstrip() for line in tfile]
  1162. if self.proc.returncode != 0:
  1163. raise CmdFailed([''] + result)
  1164. return result
  1165. except:
  1166. self.terminate()
  1167. raise
  1168. def terminate(self):
  1169. """ Terminate process and cleanup. """
  1170. if self.alive:
  1171. if G_IS_WIN:
  1172. os.kill(self.proc.pid, signal.SIGINT)
  1173. else:
  1174. os.killpg(self.proc.pid, signal.SIGTERM)
  1175. self.clean()
  1176. class Plugin(object):
  1177. def __init__(self, name, args, buf_q, lock):
  1178. self.name = name
  1179. self.args = args
  1180. self.buf_q = buf_q
  1181. self.lock = lock
  1182. tag = args.get('tag', 0)
  1183. self.checkout = esc(tag if tag else args['branch'])
  1184. self.merge = esc(tag if tag else 'origin/' + args['branch'])
  1185. self.tag = tag
  1186. def manage(self):
  1187. try:
  1188. if os.path.exists(self.args['dir']):
  1189. self.update()
  1190. else:
  1191. self.install()
  1192. with self.lock:
  1193. thread_vim_command("let s:update.new['{0}'] = 1".format(self.name))
  1194. except PlugError as exc:
  1195. self.write(Action.ERROR, self.name, exc.msg)
  1196. except KeyboardInterrupt:
  1197. G_STOP.set()
  1198. self.write(Action.ERROR, self.name, ['Interrupted!'])
  1199. except:
  1200. # Any exception except those above print stack trace
  1201. msg = 'Trace:\n{0}'.format(traceback.format_exc().rstrip())
  1202. self.write(Action.ERROR, self.name, msg.split('\n'))
  1203. raise
  1204. def install(self):
  1205. target = self.args['dir']
  1206. if target[-1] == '\\':
  1207. target = target[0:-1]
  1208. def clean(target):
  1209. def _clean():
  1210. try:
  1211. shutil.rmtree(target)
  1212. except OSError:
  1213. pass
  1214. return _clean
  1215. self.write(Action.INSTALL, self.name, ['Installing ...'])
  1216. callback = functools.partial(self.write, Action.INSTALL, self.name)
  1217. cmd = 'git clone {0} {1} --recursive {2} -b {3} {4} 2>&1'.format(
  1218. '' if self.tag else G_CLONE_OPT, G_PROGRESS, self.args['uri'],
  1219. self.checkout, esc(target))
  1220. com = Command(cmd, None, G_TIMEOUT, callback, clean(target))
  1221. result = com.execute(G_RETRIES)
  1222. self.write(Action.DONE, self.name, result[-1:])
  1223. def repo_uri(self):
  1224. cmd = 'git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url'
  1225. command = Command(cmd, self.args['dir'], G_TIMEOUT,)
  1226. result = command.execute(G_RETRIES)
  1227. return result[-1]
  1228. def update(self):
  1229. match = re.compile(r'git::?@')
  1230. actual_uri = re.sub(match, '', self.repo_uri())
  1231. expect_uri = re.sub(match, '', self.args['uri'])
  1232. if actual_uri != expect_uri:
  1233. msg = ['',
  1234. 'Invalid URI: {0}'.format(actual_uri),
  1235. 'Expected {0}'.format(expect_uri),
  1236. 'PlugClean required.']
  1237. raise InvalidURI(msg)
  1238. if G_PULL:
  1239. self.write(Action.UPDATE, self.name, ['Updating ...'])
  1240. callback = functools.partial(self.write, Action.UPDATE, self.name)
  1241. fetch_opt = '--depth 99999999' if self.tag and os.path.isfile(os.path.join(self.args['dir'], '.git/shallow')) else ''
  1242. cmds = ['git fetch {0} {1}'.format(fetch_opt, G_PROGRESS),
  1243. 'git checkout -q {0}'.format(self.checkout),
  1244. 'git merge --ff-only {0}'.format(self.merge),
  1245. 'git submodule update --init --recursive']
  1246. cmd = ' 2>&1 && '.join(cmds)
  1247. com = Command(cmd, self.args['dir'], G_TIMEOUT, callback)
  1248. result = com.execute(G_RETRIES)
  1249. self.write(Action.DONE, self.name, result[-1:])
  1250. else:
  1251. self.write(Action.DONE, self.name, ['Already installed'])
  1252. def write(self, action, name, msg):
  1253. self.buf_q.put((action, name, msg))
  1254. class PlugThread(thr.Thread):
  1255. def __init__(self, tname, args):
  1256. super(PlugThread, self).__init__()
  1257. self.tname = tname
  1258. self.args = args
  1259. def run(self):
  1260. thr.current_thread().name = self.tname
  1261. buf_q, work_q, lock = self.args
  1262. try:
  1263. while not G_STOP.is_set():
  1264. name, args = work_q.get_nowait()
  1265. plug = Plugin(name, args, buf_q, lock)
  1266. plug.manage()
  1267. work_q.task_done()
  1268. except queue.Empty:
  1269. pass
  1270. class RefreshThread(thr.Thread):
  1271. def __init__(self, lock):
  1272. super(RefreshThread, self).__init__()
  1273. self.lock = lock
  1274. self.running = True
  1275. def run(self):
  1276. while self.running:
  1277. with self.lock:
  1278. thread_vim_command('noautocmd normal! a')
  1279. time.sleep(0.33)
  1280. def stop(self):
  1281. self.running = False
  1282. if G_NVIM:
  1283. def thread_vim_command(cmd):
  1284. vim.session.threadsafe_call(lambda: vim.command(cmd))
  1285. else:
  1286. def thread_vim_command(cmd):
  1287. vim.command(cmd)
  1288. def esc(name):
  1289. return '"' + name.replace('"', '\"') + '"'
  1290. def nonblock_read(fname):
  1291. """ Read a file with nonblock flag. Return the last line. """
  1292. fread = os.open(fname, os.O_RDONLY | os.O_NONBLOCK)
  1293. buf = os.read(fread, 100000).decode('utf-8', 'replace')
  1294. os.close(fread)
  1295. line = buf.rstrip('\r\n')
  1296. left = max(line.rfind('\r'), line.rfind('\n'))
  1297. if left != -1:
  1298. left += 1
  1299. line = line[left:]
  1300. return line
  1301. def main():
  1302. thr.current_thread().name = 'main'
  1303. nthreads = int(vim.eval('s:update.threads'))
  1304. plugs = vim.eval('s:update.todo')
  1305. mac_gui = vim.eval('s:mac_gui') == '1'
  1306. lock = thr.Lock()
  1307. buf = Buffer(lock, len(plugs), G_PULL)
  1308. buf_q, work_q = queue.Queue(), queue.Queue()
  1309. for work in plugs.items():
  1310. work_q.put(work)
  1311. start_cnt = thr.active_count()
  1312. for num in range(nthreads):
  1313. tname = 'PlugT-{0:02}'.format(num)
  1314. thread = PlugThread(tname, (buf_q, work_q, lock))
  1315. thread.start()
  1316. if mac_gui:
  1317. rthread = RefreshThread(lock)
  1318. rthread.start()
  1319. while not buf_q.empty() or thr.active_count() != start_cnt:
  1320. try:
  1321. action, name, msg = buf_q.get(True, 0.25)
  1322. buf.write(action, name, msg)
  1323. buf_q.task_done()
  1324. except queue.Empty:
  1325. pass
  1326. except KeyboardInterrupt:
  1327. G_STOP.set()
  1328. if mac_gui:
  1329. rthread.stop()
  1330. rthread.join()
  1331. main()
  1332. EOF
  1333. endfunction
  1334. function! s:update_ruby()
  1335. ruby << EOF
  1336. module PlugStream
  1337. SEP = ["\r", "\n", nil]
  1338. def get_line
  1339. buffer = ''
  1340. loop do
  1341. char = readchar rescue return
  1342. if SEP.include? char.chr
  1343. buffer << $/
  1344. break
  1345. else
  1346. buffer << char
  1347. end
  1348. end
  1349. buffer
  1350. end
  1351. end unless defined?(PlugStream)
  1352. def esc arg
  1353. %["#{arg.gsub('"', '\"')}"]
  1354. end
  1355. def killall pid
  1356. pids = [pid]
  1357. if /mswin|mingw|bccwin/ =~ RUBY_PLATFORM
  1358. pids.each { |pid| Process.kill 'INT', pid.to_i rescue nil }
  1359. else
  1360. unless `which pgrep 2> /dev/null`.empty?
  1361. children = pids
  1362. until children.empty?
  1363. children = children.map { |pid|
  1364. `pgrep -P #{pid}`.lines.map { |l| l.chomp }
  1365. }.flatten
  1366. pids += children
  1367. end
  1368. end
  1369. pids.each { |pid| Process.kill 'TERM', pid.to_i rescue nil }
  1370. end
  1371. end
  1372. require 'thread'
  1373. require 'fileutils'
  1374. require 'timeout'
  1375. running = true
  1376. iswin = VIM::evaluate('s:is_win').to_i == 1
  1377. pull = VIM::evaluate('s:update.pull').to_i == 1
  1378. base = VIM::evaluate('g:plug_home')
  1379. all = VIM::evaluate('s:update.todo')
  1380. limit = VIM::evaluate('get(g:, "plug_timeout", 60)')
  1381. tries = VIM::evaluate('get(g:, "plug_retries", 2)') + 1
  1382. nthr = VIM::evaluate('s:update.threads').to_i
  1383. maxy = VIM::evaluate('winheight(".")').to_i
  1384. cd = iswin ? 'cd /d' : 'cd'
  1385. tot = VIM::evaluate('len(s:update.todo)') || 0
  1386. bar = ''
  1387. skip = 'Already installed'
  1388. mtx = Mutex.new
  1389. take1 = proc { mtx.synchronize { running && all.shift } }
  1390. logh = proc {
  1391. cnt = bar.length
  1392. $curbuf[1] = "#{pull ? 'Updating' : 'Installing'} plugins (#{cnt}/#{tot})"
  1393. $curbuf[2] = '[' + bar.ljust(tot) + ']'
  1394. VIM::command('normal! 2G')
  1395. VIM::command('redraw')
  1396. }
  1397. where = proc { |name| (1..($curbuf.length)).find { |l| $curbuf[l] =~ /^[-+x*] #{name}:/ } }
  1398. log = proc { |name, result, type|
  1399. mtx.synchronize do
  1400. ing = ![true, false].include?(type)
  1401. bar += type ? '=' : 'x' unless ing
  1402. b = case type
  1403. when :install then '+' when :update then '*'
  1404. when true, nil then '-' else
  1405. VIM::command("call add(s:update.errors, '#{name}')")
  1406. 'x'
  1407. end
  1408. result =
  1409. if type || type.nil?
  1410. ["#{b} #{name}: #{result.lines.to_a.last}"]
  1411. elsif result =~ /^Interrupted|^Timeout/
  1412. ["#{b} #{name}: #{result}"]
  1413. else
  1414. ["#{b} #{name}"] + result.lines.map { |l| " " << l }
  1415. end
  1416. if lnum = where.call(name)
  1417. $curbuf.delete lnum
  1418. lnum = 4 if ing && lnum > maxy
  1419. end
  1420. result.each_with_index do |line, offset|
  1421. $curbuf.append((lnum || 4) - 1 + offset, line.gsub(/\e\[./, '').chomp)
  1422. end
  1423. logh.call
  1424. end
  1425. }
  1426. bt = proc { |cmd, name, type, cleanup|
  1427. tried = timeout = 0
  1428. begin
  1429. tried += 1
  1430. timeout += limit
  1431. fd = nil
  1432. data = ''
  1433. if iswin
  1434. Timeout::timeout(timeout) do
  1435. tmp = VIM::evaluate('tempname()')
  1436. system("(#{cmd}) > #{tmp}")
  1437. data = File.read(tmp).chomp
  1438. File.unlink tmp rescue nil
  1439. end
  1440. else
  1441. fd = IO.popen(cmd).extend(PlugStream)
  1442. first_line = true
  1443. log_prob = 1.0 / nthr
  1444. while line = Timeout::timeout(timeout) { fd.get_line }
  1445. data << line
  1446. log.call name, line.chomp, type if name && (first_line || rand < log_prob)
  1447. first_line = false
  1448. end
  1449. fd.close
  1450. end
  1451. [$? == 0, data.chomp]
  1452. rescue Timeout::Error, Interrupt => e
  1453. if fd && !fd.closed?
  1454. killall fd.pid
  1455. fd.close
  1456. end
  1457. cleanup.call if cleanup
  1458. if e.is_a?(Timeout::Error) && tried < tries
  1459. 3.downto(1) do |countdown|
  1460. s = countdown > 1 ? 's' : ''
  1461. log.call name, "Timeout. Will retry in #{countdown} second#{s} ...", type
  1462. sleep 1
  1463. end
  1464. log.call name, 'Retrying ...', type
  1465. retry
  1466. end
  1467. [false, e.is_a?(Interrupt) ? "Interrupted!" : "Timeout!"]
  1468. end
  1469. }
  1470. main = Thread.current
  1471. threads = []
  1472. watcher = Thread.new {
  1473. while VIM::evaluate('getchar(1)')
  1474. sleep 0.1
  1475. end
  1476. mtx.synchronize do
  1477. running = false
  1478. threads.each { |t| t.raise Interrupt }
  1479. end
  1480. threads.each { |t| t.join rescue nil }
  1481. main.kill
  1482. }
  1483. refresh = Thread.new {
  1484. while true
  1485. mtx.synchronize do
  1486. break unless running
  1487. VIM::command('noautocmd normal! a')
  1488. end
  1489. sleep 0.2
  1490. end
  1491. } if VIM::evaluate('s:mac_gui') == 1
  1492. clone_opt = VIM::evaluate('s:clone_opt')
  1493. progress = VIM::evaluate('s:progress_opt(1)')
  1494. nthr.times do
  1495. mtx.synchronize do
  1496. threads << Thread.new {
  1497. while pair = take1.call
  1498. name = pair.first
  1499. dir, uri, branch, tag = pair.last.values_at *%w[dir uri branch tag]
  1500. checkout = esc(tag ? tag : branch)
  1501. merge = esc(tag ? tag : "origin/#{branch}")
  1502. subm = "git submodule update --init --recursive 2>&1"
  1503. exists = File.directory? dir
  1504. ok, result =
  1505. if exists
  1506. chdir = "#{cd} #{iswin ? dir : esc(dir)}"
  1507. ret, data = bt.call "#{chdir} && git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url", nil, nil, nil
  1508. current_uri = data.lines.to_a.last
  1509. if !ret
  1510. if data =~ /^Interrupted|^Timeout/
  1511. [false, data]
  1512. else
  1513. [false, [data.chomp, "PlugClean required."].join($/)]
  1514. end
  1515. elsif current_uri.sub(/git::?@/, '') != uri.sub(/git::?@/, '')
  1516. [false, ["Invalid URI: #{current_uri}",
  1517. "Expected: #{uri}",
  1518. "PlugClean required."].join($/)]
  1519. else
  1520. if pull
  1521. log.call name, 'Updating ...', :update
  1522. fetch_opt = (tag && File.exist?(File.join(dir, '.git/shallow'))) ? '--depth 99999999' : ''
  1523. bt.call "#{chdir} && git fetch #{fetch_opt} #{progress} 2>&1 && git checkout -q #{checkout} 2>&1 && git merge --ff-only #{merge} 2>&1 && #{subm}", name, :update, nil
  1524. else
  1525. [true, skip]
  1526. end
  1527. end
  1528. else
  1529. d = esc dir.sub(%r{[\\/]+$}, '')
  1530. log.call name, 'Installing ...', :install
  1531. bt.call "git clone #{clone_opt unless tag} #{progress} --recursive #{uri} -b #{checkout} #{d} 2>&1", name, :install, proc {
  1532. FileUtils.rm_rf dir
  1533. }
  1534. end
  1535. mtx.synchronize { VIM::command("let s:update.new['#{name}'] = 1") } if !exists && ok
  1536. log.call name, result, ok
  1537. end
  1538. } if running
  1539. end
  1540. end
  1541. threads.each { |t| t.join rescue nil }
  1542. logh.call
  1543. refresh.kill if refresh
  1544. watcher.kill
  1545. EOF
  1546. endfunction
  1547. function! s:shellesc(arg)
  1548. return '"'.escape(a:arg, '"').'"'
  1549. endfunction
  1550. function! s:glob_dir(path)
  1551. return map(filter(s:lines(globpath(a:path, '**')), 'isdirectory(v:val)'), 's:dirpath(v:val)')
  1552. endfunction
  1553. function! s:progress_bar(line, bar, total)
  1554. call setline(a:line, '[' . s:lpad(a:bar, a:total) . ']')
  1555. endfunction
  1556. function! s:compare_git_uri(a, b)
  1557. let a = substitute(a:a, 'git:\{1,2}@', '', '')
  1558. let b = substitute(a:b, 'git:\{1,2}@', '', '')
  1559. return a ==# b
  1560. endfunction
  1561. function! s:format_message(bullet, name, message)
  1562. if a:bullet != 'x'
  1563. return [printf('%s %s: %s', a:bullet, a:name, s:lastline(a:message))]
  1564. else
  1565. let lines = map(s:lines(a:message), '" ".v:val')
  1566. return extend([printf('x %s:', a:name)], lines)
  1567. endif
  1568. endfunction
  1569. function! s:with_cd(cmd, dir)
  1570. return printf('cd%s %s && %s', s:is_win ? ' /d' : '', s:shellesc(a:dir), a:cmd)
  1571. endfunction
  1572. function! s:system(cmd, ...)
  1573. try
  1574. let [sh, shrd] = [&shell, &shellredir]
  1575. if !s:is_win
  1576. set shell=sh shellredir=>%s\ 2>&1
  1577. endif
  1578. let cmd = a:0 > 0 ? s:with_cd(a:cmd, a:1) : a:cmd
  1579. return system(s:is_win ? '('.cmd.')' : cmd)
  1580. finally
  1581. let [&shell, &shellredir] = [sh, shrd]
  1582. endtry
  1583. endfunction
  1584. function! s:system_chomp(...)
  1585. let ret = call('s:system', a:000)
  1586. return v:shell_error ? '' : substitute(ret, '\n$', '', '')
  1587. endfunction
  1588. function! s:git_validate(spec, check_branch)
  1589. let err = ''
  1590. if isdirectory(a:spec.dir)
  1591. let result = s:lines(s:system('git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url', a:spec.dir))
  1592. let remote = result[-1]
  1593. if v:shell_error
  1594. let err = join([remote, 'PlugClean required.'], "\n")
  1595. elseif !s:compare_git_uri(remote, a:spec.uri)
  1596. let err = join(['Invalid URI: '.remote,
  1597. \ 'Expected: '.a:spec.uri,
  1598. \ 'PlugClean required.'], "\n")
  1599. elseif a:check_branch && has_key(a:spec, 'commit')
  1600. let result = s:lines(s:system('git rev-parse HEAD 2>&1', a:spec.dir))
  1601. let sha = result[-1]
  1602. if v:shell_error
  1603. let err = join(add(result, 'PlugClean required.'), "\n")
  1604. elseif !s:hash_match(sha, a:spec.commit)
  1605. let err = join([printf('Invalid HEAD (expected: %s, actual: %s)',
  1606. \ a:spec.commit[:6], sha[:6]),
  1607. \ 'PlugUpdate required.'], "\n")
  1608. endif
  1609. elseif a:check_branch
  1610. let branch = result[0]
  1611. " Check tag
  1612. if has_key(a:spec, 'tag')
  1613. let tag = s:system_chomp('git describe --exact-match --tags HEAD 2>&1', a:spec.dir)
  1614. if a:spec.tag !=# tag
  1615. let err = printf('Invalid tag: %s (expected: %s). Try PlugUpdate.',
  1616. \ (empty(tag) ? 'N/A' : tag), a:spec.tag)
  1617. endif
  1618. " Check branch
  1619. elseif a:spec.branch !=# branch
  1620. let err = printf('Invalid branch: %s (expected: %s). Try PlugUpdate.',
  1621. \ branch, a:spec.branch)
  1622. endif
  1623. endif
  1624. else
  1625. let err = 'Not found'
  1626. endif
  1627. return err
  1628. endfunction
  1629. function! s:rm_rf(dir)
  1630. if isdirectory(a:dir)
  1631. call s:system((s:is_win ? 'rmdir /S /Q ' : 'rm -rf ') . s:shellesc(a:dir))
  1632. endif
  1633. endfunction
  1634. function! s:clean(force)
  1635. call s:prepare()
  1636. call append(0, 'Searching for unused plugins in '.g:plug_home)
  1637. call append(1, '')
  1638. " List of valid directories
  1639. let dirs = []
  1640. let [cnt, total] = [0, len(g:plugs)]
  1641. for [name, spec] in items(g:plugs)
  1642. if !s:is_managed(name) || empty(s:git_validate(spec, 0))
  1643. call add(dirs, spec.dir)
  1644. endif
  1645. let cnt += 1
  1646. call s:progress_bar(2, repeat('=', cnt), total)
  1647. normal! 2G
  1648. redraw
  1649. endfor
  1650. let allowed = {}
  1651. for dir in dirs
  1652. let allowed[s:dirpath(fnamemodify(dir, ':h:h'))] = 1
  1653. let allowed[dir] = 1
  1654. for child in s:glob_dir(dir)
  1655. let allowed[child] = 1
  1656. endfor
  1657. endfor
  1658. let todo = []
  1659. let found = sort(s:glob_dir(g:plug_home))
  1660. while !empty(found)
  1661. let f = remove(found, 0)
  1662. if !has_key(allowed, f) && isdirectory(f)
  1663. call add(todo, f)
  1664. call append(line('$'), '- ' . f)
  1665. let found = filter(found, 'stridx(v:val, f) != 0')
  1666. end
  1667. endwhile
  1668. normal! G
  1669. redraw
  1670. if empty(todo)
  1671. call append(line('$'), 'Already clean.')
  1672. else
  1673. if a:force || s:ask('Proceed?')
  1674. for dir in todo
  1675. call s:rm_rf(dir)
  1676. endfor
  1677. call append(line('$'), 'Removed.')
  1678. else
  1679. call append(line('$'), 'Cancelled.')
  1680. endif
  1681. endif
  1682. normal! G
  1683. endfunction
  1684. function! s:upgrade()
  1685. echo 'Downloading the latest version of vim-plug'
  1686. redraw
  1687. let tmp = tempname()
  1688. let new = tmp . '/plug.vim'
  1689. try
  1690. let out = s:system(printf('git clone --depth 1 %s %s', s:plug_src, tmp))
  1691. if v:shell_error
  1692. return s:err('Error upgrading vim-plug: '. out)
  1693. endif
  1694. if readfile(s:me) ==# readfile(new)
  1695. echo 'vim-plug is already up-to-date'
  1696. return 0
  1697. else
  1698. call rename(s:me, s:me . '.old')
  1699. call rename(new, s:me)
  1700. unlet g:loaded_plug
  1701. echo 'vim-plug has been upgraded'
  1702. return 1
  1703. endif
  1704. finally
  1705. silent! call s:rm_rf(tmp)
  1706. endtry
  1707. endfunction
  1708. function! s:upgrade_specs()
  1709. for spec in values(g:plugs)
  1710. let spec.frozen = get(spec, 'frozen', 0)
  1711. endfor
  1712. endfunction
  1713. function! s:status()
  1714. call s:prepare()
  1715. call append(0, 'Checking plugins')
  1716. call append(1, '')
  1717. let ecnt = 0
  1718. let unloaded = 0
  1719. let [cnt, total] = [0, len(g:plugs)]
  1720. for [name, spec] in items(g:plugs)
  1721. if has_key(spec, 'uri')
  1722. if isdirectory(spec.dir)
  1723. let err = s:git_validate(spec, 1)
  1724. let [valid, msg] = [empty(err), empty(err) ? 'OK' : err]
  1725. else
  1726. let [valid, msg] = [0, 'Not found. Try PlugInstall.']
  1727. endif
  1728. else
  1729. if isdirectory(spec.dir)
  1730. let [valid, msg] = [1, 'OK']
  1731. else
  1732. let [valid, msg] = [0, 'Not found.']
  1733. endif
  1734. endif
  1735. let cnt += 1
  1736. let ecnt += !valid
  1737. " `s:loaded` entry can be missing if PlugUpgraded
  1738. if valid && get(s:loaded, name, -1) == 0
  1739. let unloaded = 1
  1740. let msg .= ' (not loaded)'
  1741. endif
  1742. call s:progress_bar(2, repeat('=', cnt), total)
  1743. call append(3, s:format_message(valid ? '-' : 'x', name, msg))
  1744. normal! 2G
  1745. redraw
  1746. endfor
  1747. call setline(1, 'Finished. '.ecnt.' error(s).')
  1748. normal! gg
  1749. setlocal nomodifiable
  1750. if unloaded
  1751. echo "Press 'L' on each line to load plugin, or 'U' to update"
  1752. nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1753. xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1754. end
  1755. endfunction
  1756. function! s:extract_name(str, prefix, suffix)
  1757. return matchstr(a:str, '^'.a:prefix.' \zs[^:]\+\ze:.*'.a:suffix.'$')
  1758. endfunction
  1759. function! s:status_load(lnum)
  1760. let line = getline(a:lnum)
  1761. let name = s:extract_name(line, '-', '(not loaded)')
  1762. if !empty(name)
  1763. call plug#load(name)
  1764. setlocal modifiable
  1765. call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
  1766. setlocal nomodifiable
  1767. endif
  1768. endfunction
  1769. function! s:status_update() range
  1770. let lines = getline(a:firstline, a:lastline)
  1771. let names = filter(map(lines, 's:extract_name(v:val, "[x-]", "")'), '!empty(v:val)')
  1772. if !empty(names)
  1773. echo
  1774. execute 'PlugUpdate' join(names)
  1775. endif
  1776. endfunction
  1777. function! s:is_preview_window_open()
  1778. silent! wincmd P
  1779. if &previewwindow
  1780. wincmd p
  1781. return 1
  1782. endif
  1783. return 0
  1784. endfunction
  1785. function! s:find_name(lnum)
  1786. for lnum in reverse(range(1, a:lnum))
  1787. let line = getline(lnum)
  1788. if empty(line)
  1789. return ''
  1790. endif
  1791. let name = s:extract_name(line, '-', '')
  1792. if !empty(name)
  1793. return name
  1794. endif
  1795. endfor
  1796. return ''
  1797. endfunction
  1798. function! s:preview_commit()
  1799. if b:plug_preview < 0
  1800. let b:plug_preview = !s:is_preview_window_open()
  1801. endif
  1802. let sha = matchstr(getline('.'), '\(^ \)\@<=[0-9a-z]\{7}')
  1803. if empty(sha)
  1804. return
  1805. endif
  1806. let name = s:find_name(line('.'))
  1807. if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
  1808. return
  1809. endif
  1810. execute 'pedit' sha
  1811. wincmd P
  1812. setlocal filetype=git buftype=nofile nobuflisted modifiable
  1813. execute 'silent read !cd' s:shellesc(g:plugs[name].dir) '&& git show --pretty=medium' sha
  1814. normal! gg"_dd
  1815. setlocal nomodifiable
  1816. nnoremap <silent> <buffer> q :q<cr>
  1817. wincmd p
  1818. endfunction
  1819. function! s:section(flags)
  1820. call search('\(^[x-] \)\@<=[^:]\+:', a:flags)
  1821. endfunction
  1822. function! s:format_git_log(line)
  1823. let [sha, refs, subject, date] = split(a:line, nr2char(1))
  1824. let tag = matchstr(refs, 'tag: [^,)]\+')
  1825. let tag = empty(tag) ? ' ' : ' ('.tag.') '
  1826. return printf(' %s%s%s (%s)', sha, tag, subject, date)
  1827. endfunction
  1828. function! s:append_ul(lnum, text)
  1829. call append(a:lnum, ['', a:text, repeat('-', len(a:text))])
  1830. endfunction
  1831. function! s:diff()
  1832. call s:prepare()
  1833. call append(0, ['Collecting changes ...', ''])
  1834. let cnts = [0, 0]
  1835. let bar = ''
  1836. let total = filter(copy(g:plugs), 's:is_managed(v:key) && isdirectory(v:val.dir)')
  1837. call s:progress_bar(2, bar, len(total))
  1838. for origin in [1, 0]
  1839. let plugs = reverse(sort(items(filter(copy(total), (origin ? '' : '!').'(has_key(v:val, "commit") || has_key(v:val, "tag"))'))))
  1840. if empty(plugs)
  1841. continue
  1842. endif
  1843. call s:append_ul(2, origin ? 'Pending updates:' : 'Last update:')
  1844. for [k, v] in plugs
  1845. let range = origin ? '..origin/'.v.branch : 'HEAD@{1}..'
  1846. let diff = s:system_chomp('git log --pretty=format:"%h%x01%d%x01%s%x01%cr" '.s:shellesc(range), v.dir)
  1847. if !empty(diff)
  1848. let ref = has_key(v, 'tag') ? (' (tag: '.v.tag.')') : has_key(v, 'commit') ? (' '.v.commit) : ''
  1849. call append(5, extend(['', '- '.k.':'.ref], map(s:lines(diff), 's:format_git_log(v:val)')))
  1850. let cnts[origin] += 1
  1851. endif
  1852. let bar .= '='
  1853. call s:progress_bar(2, bar, len(total))
  1854. normal! 2G
  1855. redraw
  1856. endfor
  1857. if !cnts[origin]
  1858. call append(5, ['', 'N/A'])
  1859. endif
  1860. endfor
  1861. call setline(1, printf('%d plugin(s) updated.', cnts[0])
  1862. \ . (cnts[1] ? printf(' %d plugin(s) have pending updates.', cnts[1]) : ''))
  1863. if cnts[0] || cnts[1]
  1864. nnoremap <silent> <buffer> <cr> :silent! call <SID>preview_commit()<cr>
  1865. nnoremap <silent> <buffer> o :silent! call <SID>preview_commit()<cr>
  1866. endif
  1867. if cnts[0]
  1868. nnoremap <silent> <buffer> X :call <SID>revert()<cr>
  1869. echo "Press 'X' on each block to revert the update"
  1870. endif
  1871. normal! gg
  1872. setlocal nomodifiable
  1873. endfunction
  1874. function! s:revert()
  1875. if search('^Pending updates', 'bnW')
  1876. return
  1877. endif
  1878. let name = s:find_name(line('.'))
  1879. if empty(name) || !has_key(g:plugs, name) ||
  1880. \ input(printf('Revert the update of %s? (y/N) ', name)) !~? '^y'
  1881. return
  1882. endif
  1883. call s:system('git reset --hard HEAD@{1} && git checkout '.s:esc(g:plugs[name].branch), g:plugs[name].dir)
  1884. setlocal modifiable
  1885. normal! "_dap
  1886. setlocal nomodifiable
  1887. echo 'Reverted.'
  1888. endfunction
  1889. function! s:snapshot(force, ...) abort
  1890. call s:prepare()
  1891. setf vim
  1892. call append(0, ['" Generated by vim-plug',
  1893. \ '" '.strftime("%c"),
  1894. \ '" :source this file in vim to restore the snapshot',
  1895. \ '" or execute: vim -S snapshot.vim',
  1896. \ '', '', 'PlugUpdate!'])
  1897. 1
  1898. let anchor = line('$') - 3
  1899. let names = sort(keys(filter(copy(g:plugs),
  1900. \'has_key(v:val, "uri") && !has_key(v:val, "commit") && isdirectory(v:val.dir)')))
  1901. for name in reverse(names)
  1902. let sha = s:system_chomp('git rev-parse --short HEAD', g:plugs[name].dir)
  1903. if !empty(sha)
  1904. call append(anchor, printf("silent! let g:plugs['%s'].commit = '%s'", name, sha))
  1905. redraw
  1906. endif
  1907. endfor
  1908. if a:0 > 0
  1909. let fn = expand(a:1)
  1910. if filereadable(fn) && !(a:force || s:ask(a:1.' already exists. Overwrite?'))
  1911. return
  1912. endif
  1913. call writefile(getline(1, '$'), fn)
  1914. echo 'Saved as '.a:1
  1915. silent execute 'e' s:esc(fn)
  1916. setf vim
  1917. endif
  1918. endfunction
  1919. function! s:split_rtp()
  1920. return split(&rtp, '\\\@<!,')
  1921. endfunction
  1922. let s:first_rtp = s:escrtp(get(s:split_rtp(), 0, ''))
  1923. let s:last_rtp = s:escrtp(get(s:split_rtp(), -1, ''))
  1924. if exists('g:plugs')
  1925. let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
  1926. call s:upgrade_specs()
  1927. call s:define_commands()
  1928. endif
  1929. let &cpo = s:cpo_save
  1930. unlet s:cpo_save