plug.vim 61 KB

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