plug.vim 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792
  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. " " Multiple Plug commands can be written in a single line using | separators
  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-default branch
  29. " Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
  30. "
  31. " " Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
  32. " Plug 'fatih/vim-go', { 'tag': '*' }
  33. "
  34. " " Plugin options
  35. " Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
  36. "
  37. " " Plugin outside ~/.vim/plugged with post-update hook
  38. " Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
  39. "
  40. " " Unmanaged plugin (manually installed and updated)
  41. " Plug '~/my-prototype-plugin'
  42. "
  43. " " Initialize plugin system
  44. " call plug#end()
  45. "
  46. " Then reload .vimrc and :PlugInstall to install plugins.
  47. "
  48. " Plug options:
  49. "
  50. "| Option | Description |
  51. "| ----------------------- | ------------------------------------------------ |
  52. "| `branch`/`tag`/`commit` | Branch/tag/commit of the repository to use |
  53. "| `rtp` | Subdirectory that contains Vim plugin |
  54. "| `dir` | Custom directory for the plugin |
  55. "| `as` | Use different name for the plugin |
  56. "| `do` | Post-update hook (string or funcref) |
  57. "| `on` | On-demand loading: Commands or `<Plug>`-mappings |
  58. "| `for` | On-demand loading: File types |
  59. "| `frozen` | Do not update unless explicitly specified |
  60. "
  61. " More information: https://github.com/junegunn/vim-plug
  62. "
  63. "
  64. " Copyright (c) 2017 Junegunn Choi
  65. "
  66. " MIT License
  67. "
  68. " Permission is hereby granted, free of charge, to any person obtaining
  69. " a copy of this software and associated documentation files (the
  70. " "Software"), to deal in the Software without restriction, including
  71. " without limitation the rights to use, copy, modify, merge, publish,
  72. " distribute, sublicense, and/or sell copies of the Software, and to
  73. " permit persons to whom the Software is furnished to do so, subject to
  74. " the following conditions:
  75. "
  76. " The above copyright notice and this permission notice shall be
  77. " included in all copies or substantial portions of the Software.
  78. "
  79. " THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  80. " EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  81. " MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  82. " NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  83. " LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  84. " OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  85. " WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  86. if exists('g:loaded_plug')
  87. finish
  88. endif
  89. let g:loaded_plug = 1
  90. let s:cpo_save = &cpo
  91. set cpo&vim
  92. let s:plug_src = 'https://github.com/junegunn/vim-plug.git'
  93. let s:plug_tab = get(s:, 'plug_tab', -1)
  94. let s:plug_buf = get(s:, 'plug_buf', -1)
  95. let s:mac_gui = has('gui_macvim') && has('gui_running')
  96. let s:is_win = has('win32')
  97. let s:nvim = has('nvim-0.2') || (has('nvim') && exists('*jobwait') && !s:is_win)
  98. let s:vim8 = has('patch-8.0.0039') && exists('*job_start')
  99. if s:is_win && &shellslash
  100. set noshellslash
  101. let s:me = resolve(expand('<sfile>:p'))
  102. set shellslash
  103. else
  104. let s:me = resolve(expand('<sfile>:p'))
  105. endif
  106. let s:base_spec = { 'branch': '', 'frozen': 0 }
  107. let s:TYPE = {
  108. \ 'string': type(''),
  109. \ 'list': type([]),
  110. \ 'dict': type({}),
  111. \ 'funcref': type(function('call'))
  112. \ }
  113. let s:loaded = get(s:, 'loaded', {})
  114. let s:triggers = get(s:, 'triggers', {})
  115. function! s:isabsolute(dir) abort
  116. return a:dir =~# '^/' || (has('win32') && a:dir =~? '^\%(\\\|[A-Z]:\)')
  117. endfunction
  118. function! s:get_gitdir(dir) abort
  119. let gitdir = a:dir . '/.git'
  120. if isdirectory(gitdir)
  121. return gitdir
  122. endif
  123. try
  124. let line = readfile(gitdir)[0]
  125. if line =~# '^gitdir: '
  126. let gitdir = line[8:]
  127. if !s:isabsolute(gitdir)
  128. let gitdir = a:dir . '/' . gitdir
  129. endif
  130. if isdirectory(gitdir)
  131. return gitdir
  132. endif
  133. endif
  134. catch
  135. endtry
  136. return ''
  137. endfunction
  138. function! s:git_get_remote_origin_url(dir) abort
  139. let gitdir = s:get_gitdir(a:dir)
  140. let config = gitdir . '/config'
  141. if empty(gitdir) || !filereadable(config)
  142. return ''
  143. endif
  144. return matchstr(join(readfile(config)), '\[remote "origin"\].\{-}url\s*=\s*\zs\S*\ze')
  145. endfunction
  146. function! s:git_get_revision(dir) abort
  147. let gitdir = s:get_gitdir(a:dir)
  148. if gitdir ==# ''
  149. return ''
  150. endif
  151. try
  152. let line = readfile(gitdir . '/HEAD')[0]
  153. if line =~# '^ref: '
  154. let ref = line[5:]
  155. if filereadable(gitdir . '/' . ref)
  156. return readfile(gitdir . '/' . ref)[0]
  157. endif
  158. for line in readfile(gitdir . '/packed-refs')
  159. if line =~# ' ' . ref
  160. return substitute(line, '^\([0-9a-f]*\) ', '\1', '')
  161. endif
  162. endfor
  163. endif
  164. return l:line
  165. catch
  166. endtry
  167. return ''
  168. endfunction
  169. function! s:git_get_branch(dir) abort
  170. let gitdir = s:get_gitdir(a:dir)
  171. if gitdir ==# ''
  172. return ''
  173. endif
  174. try
  175. let line = readfile(gitdir . '/HEAD')[0]
  176. if line =~# '^ref: refs/heads/'
  177. return line[16:]
  178. endif
  179. return 'HEAD'
  180. catch
  181. return ''
  182. endtry
  183. endfunction
  184. if s:is_win
  185. function! s:plug_call(fn, ...)
  186. let shellslash = &shellslash
  187. try
  188. set noshellslash
  189. return call(a:fn, a:000)
  190. finally
  191. let &shellslash = shellslash
  192. endtry
  193. endfunction
  194. else
  195. function! s:plug_call(fn, ...)
  196. return call(a:fn, a:000)
  197. endfunction
  198. endif
  199. function! s:plug_getcwd()
  200. return s:plug_call('getcwd')
  201. endfunction
  202. function! s:plug_fnamemodify(fname, mods)
  203. return s:plug_call('fnamemodify', a:fname, a:mods)
  204. endfunction
  205. function! s:plug_expand(fmt)
  206. return s:plug_call('expand', a:fmt, 1)
  207. endfunction
  208. function! s:plug_tempname()
  209. return s:plug_call('tempname')
  210. endfunction
  211. function! plug#begin(...)
  212. if a:0 > 0
  213. let s:plug_home_org = a:1
  214. let home = s:path(s:plug_fnamemodify(s:plug_expand(a:1), ':p'))
  215. elseif exists('g:plug_home')
  216. let home = s:path(g:plug_home)
  217. elseif !empty(&rtp)
  218. let home = s:path(split(&rtp, ',')[0]) . '/plugged'
  219. else
  220. return s:err('Unable to determine plug home. Try calling plug#begin() with a path argument.')
  221. endif
  222. if s:plug_fnamemodify(home, ':t') ==# 'plugin' && s:plug_fnamemodify(home, ':h') ==# s:first_rtp
  223. return s:err('Invalid plug home. '.home.' is a standard Vim runtime path and is not allowed.')
  224. endif
  225. let g:plug_home = home
  226. let g:plugs = {}
  227. let g:plugs_order = []
  228. let s:triggers = {}
  229. call s:define_commands()
  230. return 1
  231. endfunction
  232. function! s:define_commands()
  233. command! -nargs=+ -bar Plug call plug#(<args>)
  234. if !executable('git')
  235. return s:err('`git` executable not found. Most commands will not be available. To suppress this message, prepend `silent!` to `call plug#begin(...)`.')
  236. endif
  237. if has('win32')
  238. \ && &shellslash
  239. \ && (&shell =~# 'cmd\(\.exe\)\?$' || &shell =~# 'powershell\(\.exe\)\?$')
  240. return s:err('vim-plug does not support shell, ' . &shell . ', when shellslash is set.')
  241. endif
  242. if !has('nvim')
  243. \ && (has('win32') || has('win32unix'))
  244. \ && !has('multi_byte')
  245. return s:err('Vim needs +multi_byte feature on Windows to run shell commands. Enable +iconv for best results.')
  246. endif
  247. command! -nargs=* -bar -bang -complete=customlist,s:names PlugInstall call s:install(<bang>0, [<f-args>])
  248. command! -nargs=* -bar -bang -complete=customlist,s:names PlugUpdate call s:update(<bang>0, [<f-args>])
  249. command! -nargs=0 -bar -bang PlugClean call s:clean(<bang>0)
  250. command! -nargs=0 -bar PlugUpgrade if s:upgrade() | execute 'source' s:esc(s:me) | endif
  251. command! -nargs=0 -bar PlugStatus call s:status()
  252. command! -nargs=0 -bar PlugDiff call s:diff()
  253. command! -nargs=? -bar -bang -complete=file PlugSnapshot call s:snapshot(<bang>0, <f-args>)
  254. endfunction
  255. function! s:to_a(v)
  256. return type(a:v) == s:TYPE.list ? a:v : [a:v]
  257. endfunction
  258. function! s:to_s(v)
  259. return type(a:v) == s:TYPE.string ? a:v : join(a:v, "\n") . "\n"
  260. endfunction
  261. function! s:glob(from, pattern)
  262. return s:lines(globpath(a:from, a:pattern))
  263. endfunction
  264. function! s:source(from, ...)
  265. let found = 0
  266. for pattern in a:000
  267. for vim in s:glob(a:from, pattern)
  268. execute 'source' s:esc(vim)
  269. let found = 1
  270. endfor
  271. endfor
  272. return found
  273. endfunction
  274. function! s:assoc(dict, key, val)
  275. let a:dict[a:key] = add(get(a:dict, a:key, []), a:val)
  276. endfunction
  277. function! s:ask(message, ...)
  278. call inputsave()
  279. echohl WarningMsg
  280. let answer = input(a:message.(a:0 ? ' (y/N/a) ' : ' (y/N) '))
  281. echohl None
  282. call inputrestore()
  283. echo "\r"
  284. return (a:0 && answer =~? '^a') ? 2 : (answer =~? '^y') ? 1 : 0
  285. endfunction
  286. function! s:ask_no_interrupt(...)
  287. try
  288. return call('s:ask', a:000)
  289. catch
  290. return 0
  291. endtry
  292. endfunction
  293. function! s:lazy(plug, opt)
  294. return has_key(a:plug, a:opt) &&
  295. \ (empty(s:to_a(a:plug[a:opt])) ||
  296. \ !isdirectory(a:plug.dir) ||
  297. \ len(s:glob(s:rtp(a:plug), 'plugin')) ||
  298. \ len(s:glob(s:rtp(a:plug), 'after/plugin')))
  299. endfunction
  300. function! plug#end()
  301. if !exists('g:plugs')
  302. return s:err('plug#end() called without calling plug#begin() first')
  303. endif
  304. if exists('#PlugLOD')
  305. augroup PlugLOD
  306. autocmd!
  307. augroup END
  308. augroup! PlugLOD
  309. endif
  310. let lod = { 'ft': {}, 'map': {}, 'cmd': {} }
  311. if exists('g:did_load_filetypes')
  312. filetype off
  313. endif
  314. for name in g:plugs_order
  315. if !has_key(g:plugs, name)
  316. continue
  317. endif
  318. let plug = g:plugs[name]
  319. if get(s:loaded, name, 0) || !s:lazy(plug, 'on') && !s:lazy(plug, 'for')
  320. let s:loaded[name] = 1
  321. continue
  322. endif
  323. if has_key(plug, 'on')
  324. let s:triggers[name] = { 'map': [], 'cmd': [] }
  325. for cmd in s:to_a(plug.on)
  326. if cmd =~? '^<Plug>.\+'
  327. if empty(mapcheck(cmd)) && empty(mapcheck(cmd, 'i'))
  328. call s:assoc(lod.map, cmd, name)
  329. endif
  330. call add(s:triggers[name].map, cmd)
  331. elseif cmd =~# '^[A-Z]'
  332. let cmd = substitute(cmd, '!*$', '', '')
  333. if exists(':'.cmd) != 2
  334. call s:assoc(lod.cmd, cmd, name)
  335. endif
  336. call add(s:triggers[name].cmd, cmd)
  337. else
  338. call s:err('Invalid `on` option: '.cmd.
  339. \ '. Should start with an uppercase letter or `<Plug>`.')
  340. endif
  341. endfor
  342. endif
  343. if has_key(plug, 'for')
  344. let types = s:to_a(plug.for)
  345. if !empty(types)
  346. augroup filetypedetect
  347. call s:source(s:rtp(plug), 'ftdetect/**/*.vim', 'after/ftdetect/**/*.vim')
  348. augroup END
  349. endif
  350. for type in types
  351. call s:assoc(lod.ft, type, name)
  352. endfor
  353. endif
  354. endfor
  355. for [cmd, names] in items(lod.cmd)
  356. execute printf(
  357. \ 'command! -nargs=* -range -bang -complete=file %s call s:lod_cmd(%s, "<bang>", <line1>, <line2>, <q-args>, %s)',
  358. \ cmd, string(cmd), string(names))
  359. endfor
  360. for [map, names] in items(lod.map)
  361. for [mode, map_prefix, key_prefix] in
  362. \ [['i', '<C-O>', ''], ['n', '', ''], ['v', '', 'gv'], ['o', '', '']]
  363. execute printf(
  364. \ '%snoremap <silent> %s %s:<C-U>call <SID>lod_map(%s, %s, %s, "%s")<CR>',
  365. \ mode, map, map_prefix, string(map), string(names), mode != 'i', key_prefix)
  366. endfor
  367. endfor
  368. for [ft, names] in items(lod.ft)
  369. augroup PlugLOD
  370. execute printf('autocmd FileType %s call <SID>lod_ft(%s, %s)',
  371. \ ft, string(ft), string(names))
  372. augroup END
  373. endfor
  374. call s:reorg_rtp()
  375. filetype plugin indent on
  376. if has('vim_starting')
  377. if has('syntax') && !exists('g:syntax_on')
  378. syntax enable
  379. end
  380. else
  381. call s:reload_plugins()
  382. endif
  383. endfunction
  384. function! s:loaded_names()
  385. return filter(copy(g:plugs_order), 'get(s:loaded, v:val, 0)')
  386. endfunction
  387. function! s:load_plugin(spec)
  388. call s:source(s:rtp(a:spec), 'plugin/**/*.vim', 'after/plugin/**/*.vim')
  389. endfunction
  390. function! s:reload_plugins()
  391. for name in s:loaded_names()
  392. call s:load_plugin(g:plugs[name])
  393. endfor
  394. endfunction
  395. function! s:trim(str)
  396. return substitute(a:str, '[\/]\+$', '', '')
  397. endfunction
  398. function! s:version_requirement(val, min)
  399. for idx in range(0, len(a:min) - 1)
  400. let v = get(a:val, idx, 0)
  401. if v < a:min[idx] | return 0
  402. elseif v > a:min[idx] | return 1
  403. endif
  404. endfor
  405. return 1
  406. endfunction
  407. function! s:git_version_requirement(...)
  408. if !exists('s:git_version')
  409. let s:git_version = map(split(split(s:system(['git', '--version']))[2], '\.'), 'str2nr(v:val)')
  410. endif
  411. return s:version_requirement(s:git_version, a:000)
  412. endfunction
  413. function! s:progress_opt(base)
  414. return a:base && !s:is_win &&
  415. \ s:git_version_requirement(1, 7, 1) ? '--progress' : ''
  416. endfunction
  417. function! s:rtp(spec)
  418. return s:path(a:spec.dir . get(a:spec, 'rtp', ''))
  419. endfunction
  420. if s:is_win
  421. function! s:path(path)
  422. return s:trim(substitute(a:path, '/', '\', 'g'))
  423. endfunction
  424. function! s:dirpath(path)
  425. return s:path(a:path) . '\'
  426. endfunction
  427. function! s:is_local_plug(repo)
  428. return a:repo =~? '^[a-z]:\|^[%~]'
  429. endfunction
  430. " Copied from fzf
  431. function! s:wrap_cmds(cmds)
  432. let cmds = [
  433. \ '@echo off',
  434. \ 'setlocal enabledelayedexpansion']
  435. \ + (type(a:cmds) == type([]) ? a:cmds : [a:cmds])
  436. \ + ['endlocal']
  437. if has('iconv')
  438. if !exists('s:codepage')
  439. let s:codepage = libcallnr('kernel32.dll', 'GetACP', 0)
  440. endif
  441. return map(cmds, printf('iconv(v:val."\r", "%s", "cp%d")', &encoding, s:codepage))
  442. endif
  443. return map(cmds, 'v:val."\r"')
  444. endfunction
  445. function! s:batchfile(cmd)
  446. let batchfile = s:plug_tempname().'.bat'
  447. call writefile(s:wrap_cmds(a:cmd), batchfile)
  448. let cmd = plug#shellescape(batchfile, {'shell': &shell, 'script': 0})
  449. if &shell =~# 'powershell\(\.exe\)\?$'
  450. let cmd = '& ' . cmd
  451. endif
  452. return [batchfile, cmd]
  453. endfunction
  454. else
  455. function! s:path(path)
  456. return s:trim(a:path)
  457. endfunction
  458. function! s:dirpath(path)
  459. return substitute(a:path, '[/\\]*$', '/', '')
  460. endfunction
  461. function! s:is_local_plug(repo)
  462. return a:repo[0] =~ '[/$~]'
  463. endfunction
  464. endif
  465. function! s:err(msg)
  466. echohl ErrorMsg
  467. echom '[vim-plug] '.a:msg
  468. echohl None
  469. endfunction
  470. function! s:warn(cmd, msg)
  471. echohl WarningMsg
  472. execute a:cmd 'a:msg'
  473. echohl None
  474. endfunction
  475. function! s:esc(path)
  476. return escape(a:path, ' ')
  477. endfunction
  478. function! s:escrtp(path)
  479. return escape(a:path, ' ,')
  480. endfunction
  481. function! s:remove_rtp()
  482. for name in s:loaded_names()
  483. let rtp = s:rtp(g:plugs[name])
  484. execute 'set rtp-='.s:escrtp(rtp)
  485. let after = globpath(rtp, 'after')
  486. if isdirectory(after)
  487. execute 'set rtp-='.s:escrtp(after)
  488. endif
  489. endfor
  490. endfunction
  491. function! s:reorg_rtp()
  492. if !empty(s:first_rtp)
  493. execute 'set rtp-='.s:first_rtp
  494. execute 'set rtp-='.s:last_rtp
  495. endif
  496. " &rtp is modified from outside
  497. if exists('s:prtp') && s:prtp !=# &rtp
  498. call s:remove_rtp()
  499. unlet! s:middle
  500. endif
  501. let s:middle = get(s:, 'middle', &rtp)
  502. let rtps = map(s:loaded_names(), 's:rtp(g:plugs[v:val])')
  503. let afters = filter(map(copy(rtps), 'globpath(v:val, "after")'), '!empty(v:val)')
  504. let rtp = join(map(rtps, 'escape(v:val, ",")'), ',')
  505. \ . ','.s:middle.','
  506. \ . join(map(afters, 'escape(v:val, ",")'), ',')
  507. let &rtp = substitute(substitute(rtp, ',,*', ',', 'g'), '^,\|,$', '', 'g')
  508. let s:prtp = &rtp
  509. if !empty(s:first_rtp)
  510. execute 'set rtp^='.s:first_rtp
  511. execute 'set rtp+='.s:last_rtp
  512. endif
  513. endfunction
  514. function! s:doautocmd(...)
  515. if exists('#'.join(a:000, '#'))
  516. execute 'doautocmd' ((v:version > 703 || has('patch442')) ? '<nomodeline>' : '') join(a:000)
  517. endif
  518. endfunction
  519. function! s:dobufread(names)
  520. for name in a:names
  521. let path = s:rtp(g:plugs[name])
  522. for dir in ['ftdetect', 'ftplugin', 'after/ftdetect', 'after/ftplugin']
  523. if len(finddir(dir, path))
  524. if exists('#BufRead')
  525. doautocmd BufRead
  526. endif
  527. return
  528. endif
  529. endfor
  530. endfor
  531. endfunction
  532. function! plug#load(...)
  533. if a:0 == 0
  534. return s:err('Argument missing: plugin name(s) required')
  535. endif
  536. if !exists('g:plugs')
  537. return s:err('plug#begin was not called')
  538. endif
  539. let names = a:0 == 1 && type(a:1) == s:TYPE.list ? a:1 : a:000
  540. let unknowns = filter(copy(names), '!has_key(g:plugs, v:val)')
  541. if !empty(unknowns)
  542. let s = len(unknowns) > 1 ? 's' : ''
  543. return s:err(printf('Unknown plugin%s: %s', s, join(unknowns, ', ')))
  544. end
  545. let unloaded = filter(copy(names), '!get(s:loaded, v:val, 0)')
  546. if !empty(unloaded)
  547. for name in unloaded
  548. call s:lod([name], ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  549. endfor
  550. call s:dobufread(unloaded)
  551. return 1
  552. end
  553. return 0
  554. endfunction
  555. function! s:remove_triggers(name)
  556. if !has_key(s:triggers, a:name)
  557. return
  558. endif
  559. for cmd in s:triggers[a:name].cmd
  560. execute 'silent! delc' cmd
  561. endfor
  562. for map in s:triggers[a:name].map
  563. execute 'silent! unmap' map
  564. execute 'silent! iunmap' map
  565. endfor
  566. call remove(s:triggers, a:name)
  567. endfunction
  568. function! s:lod(names, types, ...)
  569. for name in a:names
  570. call s:remove_triggers(name)
  571. let s:loaded[name] = 1
  572. endfor
  573. call s:reorg_rtp()
  574. for name in a:names
  575. let rtp = s:rtp(g:plugs[name])
  576. for dir in a:types
  577. call s:source(rtp, dir.'/**/*.vim')
  578. endfor
  579. if a:0
  580. if !s:source(rtp, a:1) && !empty(s:glob(rtp, a:2))
  581. execute 'runtime' a:1
  582. endif
  583. call s:source(rtp, a:2)
  584. endif
  585. call s:doautocmd('User', name)
  586. endfor
  587. endfunction
  588. function! s:lod_ft(pat, names)
  589. let syn = 'syntax/'.a:pat.'.vim'
  590. call s:lod(a:names, ['plugin', 'after/plugin'], syn, 'after/'.syn)
  591. execute 'autocmd! PlugLOD FileType' a:pat
  592. call s:doautocmd('filetypeplugin', 'FileType')
  593. call s:doautocmd('filetypeindent', 'FileType')
  594. endfunction
  595. function! s:lod_cmd(cmd, bang, l1, l2, args, names)
  596. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  597. call s:dobufread(a:names)
  598. execute printf('%s%s%s %s', (a:l1 == a:l2 ? '' : (a:l1.','.a:l2)), a:cmd, a:bang, a:args)
  599. endfunction
  600. function! s:lod_map(map, names, with_prefix, prefix)
  601. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  602. call s:dobufread(a:names)
  603. let extra = ''
  604. while 1
  605. let c = getchar(0)
  606. if c == 0
  607. break
  608. endif
  609. let extra .= nr2char(c)
  610. endwhile
  611. if a:with_prefix
  612. let prefix = v:count ? v:count : ''
  613. let prefix .= '"'.v:register.a:prefix
  614. if mode(1) == 'no'
  615. if v:operator == 'c'
  616. let prefix = "\<esc>" . prefix
  617. endif
  618. let prefix .= v:operator
  619. endif
  620. call feedkeys(prefix, 'n')
  621. endif
  622. call feedkeys(substitute(a:map, '^<Plug>', "\<Plug>", '') . extra)
  623. endfunction
  624. function! plug#(repo, ...)
  625. if a:0 > 1
  626. return s:err('Invalid number of arguments (1..2)')
  627. endif
  628. try
  629. let repo = s:trim(a:repo)
  630. let opts = a:0 == 1 ? s:parse_options(a:1) : s:base_spec
  631. let name = get(opts, 'as', s:plug_fnamemodify(repo, ':t:s?\.git$??'))
  632. let spec = extend(s:infer_properties(name, repo), opts)
  633. if !has_key(g:plugs, name)
  634. call add(g:plugs_order, name)
  635. endif
  636. let g:plugs[name] = spec
  637. let s:loaded[name] = get(s:loaded, name, 0)
  638. catch
  639. return s:err(repo . ' ' . v:exception)
  640. endtry
  641. endfunction
  642. function! s:parse_options(arg)
  643. let opts = copy(s:base_spec)
  644. let type = type(a:arg)
  645. let opt_errfmt = 'Invalid argument for "%s" option of :Plug (expected: %s)'
  646. if type == s:TYPE.string
  647. if empty(a:arg)
  648. throw printf(opt_errfmt, 'tag', 'string')
  649. endif
  650. let opts.tag = a:arg
  651. elseif type == s:TYPE.dict
  652. for opt in ['branch', 'tag', 'commit', 'rtp', 'dir', 'as']
  653. if has_key(a:arg, opt)
  654. \ && (type(a:arg[opt]) != s:TYPE.string || empty(a:arg[opt]))
  655. throw printf(opt_errfmt, opt, 'string')
  656. endif
  657. endfor
  658. for opt in ['on', 'for']
  659. if has_key(a:arg, opt)
  660. \ && type(a:arg[opt]) != s:TYPE.list
  661. \ && (type(a:arg[opt]) != s:TYPE.string || empty(a:arg[opt]))
  662. throw printf(opt_errfmt, opt, 'string or list')
  663. endif
  664. endfor
  665. if has_key(a:arg, 'do')
  666. \ && type(a:arg.do) != s:TYPE.funcref
  667. \ && (type(a:arg.do) != s:TYPE.string || empty(a:arg.do))
  668. throw printf(opt_errfmt, 'do', 'string or funcref')
  669. endif
  670. call extend(opts, a:arg)
  671. if has_key(opts, 'dir')
  672. let opts.dir = s:dirpath(s:plug_expand(opts.dir))
  673. endif
  674. else
  675. throw 'Invalid argument type (expected: string or dictionary)'
  676. endif
  677. return opts
  678. endfunction
  679. function! s:infer_properties(name, repo)
  680. let repo = a:repo
  681. if s:is_local_plug(repo)
  682. return { 'dir': s:dirpath(s:plug_expand(repo)) }
  683. else
  684. if repo =~ ':'
  685. let uri = repo
  686. else
  687. if repo !~ '/'
  688. throw printf('Invalid argument: %s (implicit `vim-scripts'' expansion is deprecated)', repo)
  689. endif
  690. let fmt = get(g:, 'plug_url_format', 'https://git::@github.com/%s.git')
  691. let uri = printf(fmt, repo)
  692. endif
  693. return { 'dir': s:dirpath(g:plug_home.'/'.a:name), 'uri': uri }
  694. endif
  695. endfunction
  696. function! s:install(force, names)
  697. call s:update_impl(0, a:force, a:names)
  698. endfunction
  699. function! s:update(force, names)
  700. call s:update_impl(1, a:force, a:names)
  701. endfunction
  702. function! plug#helptags()
  703. if !exists('g:plugs')
  704. return s:err('plug#begin was not called')
  705. endif
  706. for spec in values(g:plugs)
  707. let docd = join([s:rtp(spec), 'doc'], '/')
  708. if isdirectory(docd)
  709. silent! execute 'helptags' s:esc(docd)
  710. endif
  711. endfor
  712. return 1
  713. endfunction
  714. function! s:syntax()
  715. syntax clear
  716. syntax region plug1 start=/\%1l/ end=/\%2l/ contains=plugNumber
  717. syntax region plug2 start=/\%2l/ end=/\%3l/ contains=plugBracket,plugX
  718. syn match plugNumber /[0-9]\+[0-9.]*/ contained
  719. syn match plugBracket /[[\]]/ contained
  720. syn match plugX /x/ contained
  721. syn match plugDash /^-/
  722. syn match plugPlus /^+/
  723. syn match plugStar /^*/
  724. syn match plugMessage /\(^- \)\@<=.*/
  725. syn match plugName /\(^- \)\@<=[^ ]*:/
  726. syn match plugSha /\%(: \)\@<=[0-9a-f]\{4,}$/
  727. syn match plugTag /(tag: [^)]\+)/
  728. syn match plugInstall /\(^+ \)\@<=[^:]*/
  729. syn match plugUpdate /\(^* \)\@<=[^:]*/
  730. syn match plugCommit /^ \X*[0-9a-f]\{7,9} .*/ contains=plugRelDate,plugEdge,plugTag
  731. syn match plugEdge /^ \X\+$/
  732. syn match plugEdge /^ \X*/ contained nextgroup=plugSha
  733. syn match plugSha /[0-9a-f]\{7,9}/ contained
  734. syn match plugRelDate /([^)]*)$/ contained
  735. syn match plugNotLoaded /(not loaded)$/
  736. syn match plugError /^x.*/
  737. syn region plugDeleted start=/^\~ .*/ end=/^\ze\S/
  738. syn match plugH2 /^.*:\n-\+$/
  739. syn keyword Function PlugInstall PlugStatus PlugUpdate PlugClean
  740. hi def link plug1 Title
  741. hi def link plug2 Repeat
  742. hi def link plugH2 Type
  743. hi def link plugX Exception
  744. hi def link plugBracket Structure
  745. hi def link plugNumber Number
  746. hi def link plugDash Special
  747. hi def link plugPlus Constant
  748. hi def link plugStar Boolean
  749. hi def link plugMessage Function
  750. hi def link plugName Label
  751. hi def link plugInstall Function
  752. hi def link plugUpdate Type
  753. hi def link plugError Error
  754. hi def link plugDeleted Ignore
  755. hi def link plugRelDate Comment
  756. hi def link plugEdge PreProc
  757. hi def link plugSha Identifier
  758. hi def link plugTag Constant
  759. hi def link plugNotLoaded Comment
  760. endfunction
  761. function! s:lpad(str, len)
  762. return a:str . repeat(' ', a:len - len(a:str))
  763. endfunction
  764. function! s:lines(msg)
  765. return split(a:msg, "[\r\n]")
  766. endfunction
  767. function! s:lastline(msg)
  768. return get(s:lines(a:msg), -1, '')
  769. endfunction
  770. function! s:new_window()
  771. execute get(g:, 'plug_window', 'vertical topleft new')
  772. endfunction
  773. function! s:plug_window_exists()
  774. let buflist = tabpagebuflist(s:plug_tab)
  775. return !empty(buflist) && index(buflist, s:plug_buf) >= 0
  776. endfunction
  777. function! s:switch_in()
  778. if !s:plug_window_exists()
  779. return 0
  780. endif
  781. if winbufnr(0) != s:plug_buf
  782. let s:pos = [tabpagenr(), winnr(), winsaveview()]
  783. execute 'normal!' s:plug_tab.'gt'
  784. let winnr = bufwinnr(s:plug_buf)
  785. execute winnr.'wincmd w'
  786. call add(s:pos, winsaveview())
  787. else
  788. let s:pos = [winsaveview()]
  789. endif
  790. setlocal modifiable
  791. return 1
  792. endfunction
  793. function! s:switch_out(...)
  794. call winrestview(s:pos[-1])
  795. setlocal nomodifiable
  796. if a:0 > 0
  797. execute a:1
  798. endif
  799. if len(s:pos) > 1
  800. execute 'normal!' s:pos[0].'gt'
  801. execute s:pos[1] 'wincmd w'
  802. call winrestview(s:pos[2])
  803. endif
  804. endfunction
  805. function! s:finish_bindings()
  806. nnoremap <silent> <buffer> R :call <SID>retry()<cr>
  807. nnoremap <silent> <buffer> D :PlugDiff<cr>
  808. nnoremap <silent> <buffer> S :PlugStatus<cr>
  809. nnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  810. xnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  811. nnoremap <silent> <buffer> ]] :silent! call <SID>section('')<cr>
  812. nnoremap <silent> <buffer> [[ :silent! call <SID>section('b')<cr>
  813. endfunction
  814. function! s:prepare(...)
  815. if empty(s:plug_getcwd())
  816. throw 'Invalid current working directory. Cannot proceed.'
  817. endif
  818. for evar in ['$GIT_DIR', '$GIT_WORK_TREE']
  819. if exists(evar)
  820. throw evar.' detected. Cannot proceed.'
  821. endif
  822. endfor
  823. call s:job_abort()
  824. if s:switch_in()
  825. if b:plug_preview == 1
  826. pc
  827. endif
  828. enew
  829. else
  830. call s:new_window()
  831. endif
  832. nnoremap <silent> <buffer> q :if b:plug_preview==1<bar>pc<bar>endif<bar>bd<cr>
  833. if a:0 == 0
  834. call s:finish_bindings()
  835. endif
  836. let b:plug_preview = -1
  837. let s:plug_tab = tabpagenr()
  838. let s:plug_buf = winbufnr(0)
  839. call s:assign_name()
  840. for k in ['<cr>', 'L', 'o', 'X', 'd', 'dd']
  841. execute 'silent! unmap <buffer>' k
  842. endfor
  843. setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap cursorline modifiable nospell
  844. if exists('+colorcolumn')
  845. setlocal colorcolumn=
  846. endif
  847. setf vim-plug
  848. if exists('g:syntax_on')
  849. call s:syntax()
  850. endif
  851. endfunction
  852. function! s:assign_name()
  853. " Assign buffer name
  854. let prefix = '[Plugins]'
  855. let name = prefix
  856. let idx = 2
  857. while bufexists(name)
  858. let name = printf('%s (%s)', prefix, idx)
  859. let idx = idx + 1
  860. endwhile
  861. silent! execute 'f' fnameescape(name)
  862. endfunction
  863. function! s:chsh(swap)
  864. let prev = [&shell, &shellcmdflag, &shellredir]
  865. if !s:is_win
  866. set shell=sh
  867. endif
  868. if a:swap
  869. if &shell =~# 'powershell\(\.exe\)\?$' || &shell =~# 'pwsh$'
  870. let &shellredir = '2>&1 | Out-File -Encoding UTF8 %s'
  871. elseif &shell =~# 'sh' || &shell =~# 'cmd\(\.exe\)\?$'
  872. set shellredir=>%s\ 2>&1
  873. endif
  874. endif
  875. return prev
  876. endfunction
  877. function! s:bang(cmd, ...)
  878. let batchfile = ''
  879. try
  880. let [sh, shellcmdflag, shrd] = s:chsh(a:0)
  881. " FIXME: Escaping is incomplete. We could use shellescape with eval,
  882. " but it won't work on Windows.
  883. let cmd = a:0 ? s:with_cd(a:cmd, a:1) : a:cmd
  884. if s:is_win
  885. let [batchfile, cmd] = s:batchfile(cmd)
  886. endif
  887. let g:_plug_bang = (s:is_win && has('gui_running') ? 'silent ' : '').'!'.escape(cmd, '#!%')
  888. execute "normal! :execute g:_plug_bang\<cr>\<cr>"
  889. finally
  890. unlet g:_plug_bang
  891. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  892. if s:is_win && filereadable(batchfile)
  893. call delete(batchfile)
  894. endif
  895. endtry
  896. return v:shell_error ? 'Exit status: ' . v:shell_error : ''
  897. endfunction
  898. function! s:regress_bar()
  899. let bar = substitute(getline(2)[1:-2], '.*\zs=', 'x', '')
  900. call s:progress_bar(2, bar, len(bar))
  901. endfunction
  902. function! s:is_updated(dir)
  903. return !empty(s:system_chomp(['git', 'log', '--pretty=format:%h', 'HEAD...HEAD@{1}'], a:dir))
  904. endfunction
  905. function! s:do(pull, force, todo)
  906. for [name, spec] in items(a:todo)
  907. if !isdirectory(spec.dir)
  908. continue
  909. endif
  910. let installed = has_key(s:update.new, name)
  911. let updated = installed ? 0 :
  912. \ (a:pull && index(s:update.errors, name) < 0 && s:is_updated(spec.dir))
  913. if a:force || installed || updated
  914. execute 'cd' s:esc(spec.dir)
  915. call append(3, '- Post-update hook for '. name .' ... ')
  916. let error = ''
  917. let type = type(spec.do)
  918. if type == s:TYPE.string
  919. if spec.do[0] == ':'
  920. if !get(s:loaded, name, 0)
  921. let s:loaded[name] = 1
  922. call s:reorg_rtp()
  923. endif
  924. call s:load_plugin(spec)
  925. try
  926. execute spec.do[1:]
  927. catch
  928. let error = v:exception
  929. endtry
  930. if !s:plug_window_exists()
  931. cd -
  932. throw 'Warning: vim-plug was terminated by the post-update hook of '.name
  933. endif
  934. else
  935. let error = s:bang(spec.do)
  936. endif
  937. elseif type == s:TYPE.funcref
  938. try
  939. call s:load_plugin(spec)
  940. let status = installed ? 'installed' : (updated ? 'updated' : 'unchanged')
  941. call spec.do({ 'name': name, 'status': status, 'force': a:force })
  942. catch
  943. let error = v:exception
  944. endtry
  945. else
  946. let error = 'Invalid hook type'
  947. endif
  948. call s:switch_in()
  949. call setline(4, empty(error) ? (getline(4) . 'OK')
  950. \ : ('x' . getline(4)[1:] . error))
  951. if !empty(error)
  952. call add(s:update.errors, name)
  953. call s:regress_bar()
  954. endif
  955. cd -
  956. endif
  957. endfor
  958. endfunction
  959. function! s:hash_match(a, b)
  960. return stridx(a:a, a:b) == 0 || stridx(a:b, a:a) == 0
  961. endfunction
  962. function! s:checkout(spec)
  963. let sha = a:spec.commit
  964. let output = s:git_get_revision(a:spec.dir)
  965. if !empty(output) && !s:hash_match(sha, s:lines(output)[0])
  966. let output = s:system(
  967. \ 'git fetch --depth 999999 && git checkout '.plug#shellescape(sha).' --', a:spec.dir)
  968. endif
  969. return output
  970. endfunction
  971. function! s:finish(pull)
  972. let new_frozen = len(filter(keys(s:update.new), 'g:plugs[v:val].frozen'))
  973. if new_frozen
  974. let s = new_frozen > 1 ? 's' : ''
  975. call append(3, printf('- Installed %d frozen plugin%s', new_frozen, s))
  976. endif
  977. call append(3, '- Finishing ... ') | 4
  978. redraw
  979. call plug#helptags()
  980. call plug#end()
  981. call setline(4, getline(4) . 'Done!')
  982. redraw
  983. let msgs = []
  984. if !empty(s:update.errors)
  985. call add(msgs, "Press 'R' to retry.")
  986. endif
  987. if a:pull && len(s:update.new) < len(filter(getline(5, '$'),
  988. \ "v:val =~ '^- ' && v:val !~# 'Already up.to.date'"))
  989. call add(msgs, "Press 'D' to see the updated changes.")
  990. endif
  991. echo join(msgs, ' ')
  992. call s:finish_bindings()
  993. endfunction
  994. function! s:retry()
  995. if empty(s:update.errors)
  996. return
  997. endif
  998. echo
  999. call s:update_impl(s:update.pull, s:update.force,
  1000. \ extend(copy(s:update.errors), [s:update.threads]))
  1001. endfunction
  1002. function! s:is_managed(name)
  1003. return has_key(g:plugs[a:name], 'uri')
  1004. endfunction
  1005. function! s:names(...)
  1006. return sort(filter(keys(g:plugs), 'stridx(v:val, a:1) == 0 && s:is_managed(v:val)'))
  1007. endfunction
  1008. function! s:check_ruby()
  1009. silent! ruby require 'thread'; VIM::command("let g:plug_ruby = '#{RUBY_VERSION}'")
  1010. if !exists('g:plug_ruby')
  1011. redraw!
  1012. return s:warn('echom', 'Warning: Ruby interface is broken')
  1013. endif
  1014. let ruby_version = split(g:plug_ruby, '\.')
  1015. unlet g:plug_ruby
  1016. return s:version_requirement(ruby_version, [1, 8, 7])
  1017. endfunction
  1018. function! s:update_impl(pull, force, args) abort
  1019. let sync = index(a:args, '--sync') >= 0 || has('vim_starting')
  1020. let args = filter(copy(a:args), 'v:val != "--sync"')
  1021. let threads = (len(args) > 0 && args[-1] =~ '^[1-9][0-9]*$') ?
  1022. \ remove(args, -1) : get(g:, 'plug_threads', 16)
  1023. let managed = filter(copy(g:plugs), 's:is_managed(v:key)')
  1024. let todo = empty(args) ? filter(managed, '!v:val.frozen || !isdirectory(v:val.dir)') :
  1025. \ filter(managed, 'index(args, v:key) >= 0')
  1026. if empty(todo)
  1027. return s:warn('echo', 'No plugin to '. (a:pull ? 'update' : 'install'))
  1028. endif
  1029. if !s:is_win && s:git_version_requirement(2, 3)
  1030. let s:git_terminal_prompt = exists('$GIT_TERMINAL_PROMPT') ? $GIT_TERMINAL_PROMPT : ''
  1031. let $GIT_TERMINAL_PROMPT = 0
  1032. for plug in values(todo)
  1033. let plug.uri = substitute(plug.uri,
  1034. \ '^https://git::@github\.com', 'https://github.com', '')
  1035. endfor
  1036. endif
  1037. if !isdirectory(g:plug_home)
  1038. try
  1039. call mkdir(g:plug_home, 'p')
  1040. catch
  1041. return s:err(printf('Invalid plug directory: %s. '.
  1042. \ 'Try to call plug#begin with a valid directory', g:plug_home))
  1043. endtry
  1044. endif
  1045. if has('nvim') && !exists('*jobwait') && threads > 1
  1046. call s:warn('echom', '[vim-plug] Update Neovim for parallel installer')
  1047. endif
  1048. let use_job = s:nvim || s:vim8
  1049. let python = (has('python') || has('python3')) && !use_job
  1050. let ruby = has('ruby') && !use_job && (v:version >= 703 || v:version == 702 && has('patch374')) && !(s:is_win && has('gui_running')) && threads > 1 && s:check_ruby()
  1051. let s:update = {
  1052. \ 'start': reltime(),
  1053. \ 'all': todo,
  1054. \ 'todo': copy(todo),
  1055. \ 'errors': [],
  1056. \ 'pull': a:pull,
  1057. \ 'force': a:force,
  1058. \ 'new': {},
  1059. \ 'threads': (python || ruby || use_job) ? min([len(todo), threads]) : 1,
  1060. \ 'bar': '',
  1061. \ 'fin': 0
  1062. \ }
  1063. call s:prepare(1)
  1064. call append(0, ['', ''])
  1065. normal! 2G
  1066. silent! redraw
  1067. let s:clone_opt = []
  1068. if get(g:, 'plug_shallow', 1)
  1069. call extend(s:clone_opt, ['--depth', '1'])
  1070. if s:git_version_requirement(1, 7, 10)
  1071. call add(s:clone_opt, '--no-single-branch')
  1072. endif
  1073. endif
  1074. if has('win32unix') || has('wsl')
  1075. call extend(s:clone_opt, ['-c', 'core.eol=lf', '-c', 'core.autocrlf=input'])
  1076. endif
  1077. let s:submodule_opt = s:git_version_requirement(2, 8) ? ' --jobs='.threads : ''
  1078. " Python version requirement (>= 2.7)
  1079. if python && !has('python3') && !ruby && !use_job && s:update.threads > 1
  1080. redir => pyv
  1081. silent python import platform; print platform.python_version()
  1082. redir END
  1083. let python = s:version_requirement(
  1084. \ map(split(split(pyv)[0], '\.'), 'str2nr(v:val)'), [2, 6])
  1085. endif
  1086. if (python || ruby) && s:update.threads > 1
  1087. try
  1088. let imd = &imd
  1089. if s:mac_gui
  1090. set noimd
  1091. endif
  1092. if ruby
  1093. call s:update_ruby()
  1094. else
  1095. call s:update_python()
  1096. endif
  1097. catch
  1098. let lines = getline(4, '$')
  1099. let printed = {}
  1100. silent! 4,$d _
  1101. for line in lines
  1102. let name = s:extract_name(line, '.', '')
  1103. if empty(name) || !has_key(printed, name)
  1104. call append('$', line)
  1105. if !empty(name)
  1106. let printed[name] = 1
  1107. if line[0] == 'x' && index(s:update.errors, name) < 0
  1108. call add(s:update.errors, name)
  1109. end
  1110. endif
  1111. endif
  1112. endfor
  1113. finally
  1114. let &imd = imd
  1115. call s:update_finish()
  1116. endtry
  1117. else
  1118. call s:update_vim()
  1119. while use_job && sync
  1120. sleep 100m
  1121. if s:update.fin
  1122. break
  1123. endif
  1124. endwhile
  1125. endif
  1126. endfunction
  1127. function! s:log4(name, msg)
  1128. call setline(4, printf('- %s (%s)', a:msg, a:name))
  1129. redraw
  1130. endfunction
  1131. function! s:update_finish()
  1132. if exists('s:git_terminal_prompt')
  1133. let $GIT_TERMINAL_PROMPT = s:git_terminal_prompt
  1134. endif
  1135. if s:switch_in()
  1136. call append(3, '- Updating ...') | 4
  1137. for [name, spec] in items(filter(copy(s:update.all), 'index(s:update.errors, v:key) < 0 && (s:update.force || s:update.pull || has_key(s:update.new, v:key))'))
  1138. let [pos, _] = s:logpos(name)
  1139. if !pos
  1140. continue
  1141. endif
  1142. if has_key(spec, 'commit')
  1143. call s:log4(name, 'Checking out '.spec.commit)
  1144. let out = s:checkout(spec)
  1145. elseif has_key(spec, 'tag')
  1146. let tag = spec.tag
  1147. if tag =~ '\*'
  1148. let tags = s:lines(s:system('git tag --list '.plug#shellescape(tag).' --sort -version:refname 2>&1', spec.dir))
  1149. if !v:shell_error && !empty(tags)
  1150. let tag = tags[0]
  1151. call s:log4(name, printf('Latest tag for %s -> %s', spec.tag, tag))
  1152. call append(3, '')
  1153. endif
  1154. endif
  1155. call s:log4(name, 'Checking out '.tag)
  1156. let out = s:system('git checkout -q '.plug#shellescape(tag).' -- 2>&1', spec.dir)
  1157. else
  1158. let branch = s:git_origin_branch(spec)
  1159. call s:log4(name, 'Merging origin/'.s:esc(branch))
  1160. let out = s:system('git checkout -q '.plug#shellescape(branch).' -- 2>&1'
  1161. \. (has_key(s:update.new, name) ? '' : ('&& git merge --ff-only '.plug#shellescape('origin/'.branch).' 2>&1')), spec.dir)
  1162. endif
  1163. if !v:shell_error && filereadable(spec.dir.'/.gitmodules') &&
  1164. \ (s:update.force || has_key(s:update.new, name) || s:is_updated(spec.dir))
  1165. call s:log4(name, 'Updating submodules. This may take a while.')
  1166. let out .= s:bang('git submodule update --init --recursive'.s:submodule_opt.' 2>&1', spec.dir)
  1167. endif
  1168. let msg = s:format_message(v:shell_error ? 'x': '-', name, out)
  1169. if v:shell_error
  1170. call add(s:update.errors, name)
  1171. call s:regress_bar()
  1172. silent execute pos 'd _'
  1173. call append(4, msg) | 4
  1174. elseif !empty(out)
  1175. call setline(pos, msg[0])
  1176. endif
  1177. redraw
  1178. endfor
  1179. silent 4 d _
  1180. try
  1181. call s:do(s:update.pull, s:update.force, filter(copy(s:update.all), 'index(s:update.errors, v:key) < 0 && has_key(v:val, "do")'))
  1182. catch
  1183. call s:warn('echom', v:exception)
  1184. call s:warn('echo', '')
  1185. return
  1186. endtry
  1187. call s:finish(s:update.pull)
  1188. call setline(1, 'Updated. Elapsed time: ' . split(reltimestr(reltime(s:update.start)))[0] . ' sec.')
  1189. call s:switch_out('normal! gg')
  1190. endif
  1191. endfunction
  1192. function! s:job_abort()
  1193. if (!s:nvim && !s:vim8) || !exists('s:jobs')
  1194. return
  1195. endif
  1196. for [name, j] in items(s:jobs)
  1197. if s:nvim
  1198. silent! call jobstop(j.jobid)
  1199. elseif s:vim8
  1200. silent! call job_stop(j.jobid)
  1201. endif
  1202. if j.new
  1203. call s:rm_rf(g:plugs[name].dir)
  1204. endif
  1205. endfor
  1206. let s:jobs = {}
  1207. endfunction
  1208. function! s:last_non_empty_line(lines)
  1209. let len = len(a:lines)
  1210. for idx in range(len)
  1211. let line = a:lines[len-idx-1]
  1212. if !empty(line)
  1213. return line
  1214. endif
  1215. endfor
  1216. return ''
  1217. endfunction
  1218. function! s:job_out_cb(self, data) abort
  1219. let self = a:self
  1220. let data = remove(self.lines, -1) . a:data
  1221. let lines = map(split(data, "\n", 1), 'split(v:val, "\r", 1)[-1]')
  1222. call extend(self.lines, lines)
  1223. " To reduce the number of buffer updates
  1224. let self.tick = get(self, 'tick', -1) + 1
  1225. if !self.running || self.tick % len(s:jobs) == 0
  1226. let bullet = self.running ? (self.new ? '+' : '*') : (self.error ? 'x' : '-')
  1227. let result = self.error ? join(self.lines, "\n") : s:last_non_empty_line(self.lines)
  1228. call s:log(bullet, self.name, result)
  1229. endif
  1230. endfunction
  1231. function! s:job_exit_cb(self, data) abort
  1232. let a:self.running = 0
  1233. let a:self.error = a:data != 0
  1234. call s:reap(a:self.name)
  1235. call s:tick()
  1236. endfunction
  1237. function! s:job_cb(fn, job, ch, data)
  1238. if !s:plug_window_exists() " plug window closed
  1239. return s:job_abort()
  1240. endif
  1241. call call(a:fn, [a:job, a:data])
  1242. endfunction
  1243. function! s:nvim_cb(job_id, data, event) dict abort
  1244. return (a:event == 'stdout' || a:event == 'stderr') ?
  1245. \ s:job_cb('s:job_out_cb', self, 0, join(a:data, "\n")) :
  1246. \ s:job_cb('s:job_exit_cb', self, 0, a:data)
  1247. endfunction
  1248. function! s:spawn(name, cmd, opts)
  1249. let job = { 'name': a:name, 'running': 1, 'error': 0, 'lines': [''],
  1250. \ 'new': get(a:opts, 'new', 0) }
  1251. let s:jobs[a:name] = job
  1252. if s:nvim
  1253. if has_key(a:opts, 'dir')
  1254. let job.cwd = a:opts.dir
  1255. endif
  1256. let argv = a:cmd
  1257. call extend(job, {
  1258. \ 'on_stdout': function('s:nvim_cb'),
  1259. \ 'on_stderr': function('s:nvim_cb'),
  1260. \ 'on_exit': function('s:nvim_cb'),
  1261. \ })
  1262. let jid = s:plug_call('jobstart', argv, job)
  1263. if jid > 0
  1264. let job.jobid = jid
  1265. else
  1266. let job.running = 0
  1267. let job.error = 1
  1268. let job.lines = [jid < 0 ? argv[0].' is not executable' :
  1269. \ 'Invalid arguments (or job table is full)']
  1270. endif
  1271. elseif s:vim8
  1272. let cmd = join(map(copy(a:cmd), 'plug#shellescape(v:val, {"script": 0})'))
  1273. if has_key(a:opts, 'dir')
  1274. let cmd = s:with_cd(cmd, a:opts.dir, 0)
  1275. endif
  1276. let argv = s:is_win ? ['cmd', '/s', '/c', '"'.cmd.'"'] : ['sh', '-c', cmd]
  1277. let jid = job_start(s:is_win ? join(argv, ' ') : argv, {
  1278. \ 'out_cb': function('s:job_cb', ['s:job_out_cb', job]),
  1279. \ 'err_cb': function('s:job_cb', ['s:job_out_cb', job]),
  1280. \ 'exit_cb': function('s:job_cb', ['s:job_exit_cb', job]),
  1281. \ 'err_mode': 'raw',
  1282. \ 'out_mode': 'raw'
  1283. \})
  1284. if job_status(jid) == 'run'
  1285. let job.jobid = jid
  1286. else
  1287. let job.running = 0
  1288. let job.error = 1
  1289. let job.lines = ['Failed to start job']
  1290. endif
  1291. else
  1292. let job.lines = s:lines(call('s:system', has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]))
  1293. let job.error = v:shell_error != 0
  1294. let job.running = 0
  1295. endif
  1296. endfunction
  1297. function! s:reap(name)
  1298. let job = s:jobs[a:name]
  1299. if job.error
  1300. call add(s:update.errors, a:name)
  1301. elseif get(job, 'new', 0)
  1302. let s:update.new[a:name] = 1
  1303. endif
  1304. let s:update.bar .= job.error ? 'x' : '='
  1305. let bullet = job.error ? 'x' : '-'
  1306. let result = job.error ? join(job.lines, "\n") : s:last_non_empty_line(job.lines)
  1307. call s:log(bullet, a:name, empty(result) ? 'OK' : result)
  1308. call s:bar()
  1309. call remove(s:jobs, a:name)
  1310. endfunction
  1311. function! s:bar()
  1312. if s:switch_in()
  1313. let total = len(s:update.all)
  1314. call setline(1, (s:update.pull ? 'Updating' : 'Installing').
  1315. \ ' plugins ('.len(s:update.bar).'/'.total.')')
  1316. call s:progress_bar(2, s:update.bar, total)
  1317. call s:switch_out()
  1318. endif
  1319. endfunction
  1320. function! s:logpos(name)
  1321. let max = line('$')
  1322. for i in range(4, max > 4 ? max : 4)
  1323. if getline(i) =~# '^[-+x*] '.a:name.':'
  1324. for j in range(i + 1, max > 5 ? max : 5)
  1325. if getline(j) !~ '^ '
  1326. return [i, j - 1]
  1327. endif
  1328. endfor
  1329. return [i, i]
  1330. endif
  1331. endfor
  1332. return [0, 0]
  1333. endfunction
  1334. function! s:log(bullet, name, lines)
  1335. if s:switch_in()
  1336. let [b, e] = s:logpos(a:name)
  1337. if b > 0
  1338. silent execute printf('%d,%d d _', b, e)
  1339. if b > winheight('.')
  1340. let b = 4
  1341. endif
  1342. else
  1343. let b = 4
  1344. endif
  1345. " FIXME For some reason, nomodifiable is set after :d in vim8
  1346. setlocal modifiable
  1347. call append(b - 1, s:format_message(a:bullet, a:name, a:lines))
  1348. call s:switch_out()
  1349. endif
  1350. endfunction
  1351. function! s:update_vim()
  1352. let s:jobs = {}
  1353. call s:bar()
  1354. call s:tick()
  1355. endfunction
  1356. function! s:tick()
  1357. let pull = s:update.pull
  1358. let prog = s:progress_opt(s:nvim || s:vim8)
  1359. while 1 " Without TCO, Vim stack is bound to explode
  1360. if empty(s:update.todo)
  1361. if empty(s:jobs) && !s:update.fin
  1362. call s:update_finish()
  1363. let s:update.fin = 1
  1364. endif
  1365. return
  1366. endif
  1367. let name = keys(s:update.todo)[0]
  1368. let spec = remove(s:update.todo, name)
  1369. let new = empty(globpath(spec.dir, '.git', 1))
  1370. call s:log(new ? '+' : '*', name, pull ? 'Updating ...' : 'Installing ...')
  1371. redraw
  1372. let has_tag = has_key(spec, 'tag')
  1373. if !new
  1374. let [error, _] = s:git_validate(spec, 0)
  1375. if empty(error)
  1376. if pull
  1377. let cmd = ['git', 'fetch']
  1378. if has_tag && !empty(globpath(spec.dir, '.git/shallow'))
  1379. call extend(cmd, ['--depth', '99999999'])
  1380. endif
  1381. if !empty(prog)
  1382. call add(cmd, prog)
  1383. endif
  1384. call s:spawn(name, cmd, { 'dir': spec.dir })
  1385. else
  1386. let s:jobs[name] = { 'running': 0, 'lines': ['Already installed'], 'error': 0 }
  1387. endif
  1388. else
  1389. let s:jobs[name] = { 'running': 0, 'lines': s:lines(error), 'error': 1 }
  1390. endif
  1391. else
  1392. let cmd = ['git', 'clone']
  1393. if !has_tag
  1394. call extend(cmd, s:clone_opt)
  1395. endif
  1396. if !empty(prog)
  1397. call add(cmd, prog)
  1398. endif
  1399. call s:spawn(name, extend(cmd, [spec.uri, s:trim(spec.dir)]), { 'new': 1 })
  1400. endif
  1401. if !s:jobs[name].running
  1402. call s:reap(name)
  1403. endif
  1404. if len(s:jobs) >= s:update.threads
  1405. break
  1406. endif
  1407. endwhile
  1408. endfunction
  1409. function! s:update_python()
  1410. let py_exe = has('python') ? 'python' : 'python3'
  1411. execute py_exe "<< EOF"
  1412. import datetime
  1413. import functools
  1414. import os
  1415. try:
  1416. import queue
  1417. except ImportError:
  1418. import Queue as queue
  1419. import random
  1420. import re
  1421. import shutil
  1422. import signal
  1423. import subprocess
  1424. import tempfile
  1425. import threading as thr
  1426. import time
  1427. import traceback
  1428. import vim
  1429. G_NVIM = vim.eval("has('nvim')") == '1'
  1430. G_PULL = vim.eval('s:update.pull') == '1'
  1431. G_RETRIES = int(vim.eval('get(g:, "plug_retries", 2)')) + 1
  1432. G_TIMEOUT = int(vim.eval('get(g:, "plug_timeout", 60)'))
  1433. G_CLONE_OPT = ' '.join(vim.eval('s:clone_opt'))
  1434. G_PROGRESS = vim.eval('s:progress_opt(1)')
  1435. G_LOG_PROB = 1.0 / int(vim.eval('s:update.threads'))
  1436. G_STOP = thr.Event()
  1437. G_IS_WIN = vim.eval('s:is_win') == '1'
  1438. class PlugError(Exception):
  1439. def __init__(self, msg):
  1440. self.msg = msg
  1441. class CmdTimedOut(PlugError):
  1442. pass
  1443. class CmdFailed(PlugError):
  1444. pass
  1445. class InvalidURI(PlugError):
  1446. pass
  1447. class Action(object):
  1448. INSTALL, UPDATE, ERROR, DONE = ['+', '*', 'x', '-']
  1449. class Buffer(object):
  1450. def __init__(self, lock, num_plugs, is_pull):
  1451. self.bar = ''
  1452. self.event = 'Updating' if is_pull else 'Installing'
  1453. self.lock = lock
  1454. self.maxy = int(vim.eval('winheight(".")'))
  1455. self.num_plugs = num_plugs
  1456. def __where(self, name):
  1457. """ Find first line with name in current buffer. Return line num. """
  1458. found, lnum = False, 0
  1459. matcher = re.compile('^[-+x*] {0}:'.format(name))
  1460. for line in vim.current.buffer:
  1461. if matcher.search(line) is not None:
  1462. found = True
  1463. break
  1464. lnum += 1
  1465. if not found:
  1466. lnum = -1
  1467. return lnum
  1468. def header(self):
  1469. curbuf = vim.current.buffer
  1470. curbuf[0] = self.event + ' plugins ({0}/{1})'.format(len(self.bar), self.num_plugs)
  1471. num_spaces = self.num_plugs - len(self.bar)
  1472. curbuf[1] = '[{0}{1}]'.format(self.bar, num_spaces * ' ')
  1473. with self.lock:
  1474. vim.command('normal! 2G')
  1475. vim.command('redraw')
  1476. def write(self, action, name, lines):
  1477. first, rest = lines[0], lines[1:]
  1478. msg = ['{0} {1}{2}{3}'.format(action, name, ': ' if first else '', first)]
  1479. msg.extend([' ' + line for line in rest])
  1480. try:
  1481. if action == Action.ERROR:
  1482. self.bar += 'x'
  1483. vim.command("call add(s:update.errors, '{0}')".format(name))
  1484. elif action == Action.DONE:
  1485. self.bar += '='
  1486. curbuf = vim.current.buffer
  1487. lnum = self.__where(name)
  1488. if lnum != -1: # Found matching line num
  1489. del curbuf[lnum]
  1490. if lnum > self.maxy and action in set([Action.INSTALL, Action.UPDATE]):
  1491. lnum = 3
  1492. else:
  1493. lnum = 3
  1494. curbuf.append(msg, lnum)
  1495. self.header()
  1496. except vim.error:
  1497. pass
  1498. class Command(object):
  1499. CD = 'cd /d' if G_IS_WIN else 'cd'
  1500. def __init__(self, cmd, cmd_dir=None, timeout=60, cb=None, clean=None):
  1501. self.cmd = cmd
  1502. if cmd_dir:
  1503. self.cmd = '{0} {1} && {2}'.format(Command.CD, cmd_dir, self.cmd)
  1504. self.timeout = timeout
  1505. self.callback = cb if cb else (lambda msg: None)
  1506. self.clean = clean if clean else (lambda: None)
  1507. self.proc = None
  1508. @property
  1509. def alive(self):
  1510. """ Returns true only if command still running. """
  1511. return self.proc and self.proc.poll() is None
  1512. def execute(self, ntries=3):
  1513. """ Execute the command with ntries if CmdTimedOut.
  1514. Returns the output of the command if no Exception.
  1515. """
  1516. attempt, finished, limit = 0, False, self.timeout
  1517. while not finished:
  1518. try:
  1519. attempt += 1
  1520. result = self.try_command()
  1521. finished = True
  1522. return result
  1523. except CmdTimedOut:
  1524. if attempt != ntries:
  1525. self.notify_retry()
  1526. self.timeout += limit
  1527. else:
  1528. raise
  1529. def notify_retry(self):
  1530. """ Retry required for command, notify user. """
  1531. for count in range(3, 0, -1):
  1532. if G_STOP.is_set():
  1533. raise KeyboardInterrupt
  1534. msg = 'Timeout. Will retry in {0} second{1} ...'.format(
  1535. count, 's' if count != 1 else '')
  1536. self.callback([msg])
  1537. time.sleep(1)
  1538. self.callback(['Retrying ...'])
  1539. def try_command(self):
  1540. """ Execute a cmd & poll for callback. Returns list of output.
  1541. Raises CmdFailed -> return code for Popen isn't 0
  1542. Raises CmdTimedOut -> command exceeded timeout without new output
  1543. """
  1544. first_line = True
  1545. try:
  1546. tfile = tempfile.NamedTemporaryFile(mode='w+b')
  1547. preexec_fn = not G_IS_WIN and os.setsid or None
  1548. self.proc = subprocess.Popen(self.cmd, stdout=tfile,
  1549. stderr=subprocess.STDOUT,
  1550. stdin=subprocess.PIPE, shell=True,
  1551. preexec_fn=preexec_fn)
  1552. thrd = thr.Thread(target=(lambda proc: proc.wait()), args=(self.proc,))
  1553. thrd.start()
  1554. thread_not_started = True
  1555. while thread_not_started:
  1556. try:
  1557. thrd.join(0.1)
  1558. thread_not_started = False
  1559. except RuntimeError:
  1560. pass
  1561. while self.alive:
  1562. if G_STOP.is_set():
  1563. raise KeyboardInterrupt
  1564. if first_line or random.random() < G_LOG_PROB:
  1565. first_line = False
  1566. line = '' if G_IS_WIN else nonblock_read(tfile.name)
  1567. if line:
  1568. self.callback([line])
  1569. time_diff = time.time() - os.path.getmtime(tfile.name)
  1570. if time_diff > self.timeout:
  1571. raise CmdTimedOut(['Timeout!'])
  1572. thrd.join(0.5)
  1573. tfile.seek(0)
  1574. result = [line.decode('utf-8', 'replace').rstrip() for line in tfile]
  1575. if self.proc.returncode != 0:
  1576. raise CmdFailed([''] + result)
  1577. return result
  1578. except:
  1579. self.terminate()
  1580. raise
  1581. def terminate(self):
  1582. """ Terminate process and cleanup. """
  1583. if self.alive:
  1584. if G_IS_WIN:
  1585. os.kill(self.proc.pid, signal.SIGINT)
  1586. else:
  1587. os.killpg(self.proc.pid, signal.SIGTERM)
  1588. self.clean()
  1589. class Plugin(object):
  1590. def __init__(self, name, args, buf_q, lock):
  1591. self.name = name
  1592. self.args = args
  1593. self.buf_q = buf_q
  1594. self.lock = lock
  1595. self.tag = args.get('tag', 0)
  1596. def manage(self):
  1597. try:
  1598. if os.path.exists(self.args['dir']):
  1599. self.update()
  1600. else:
  1601. self.install()
  1602. with self.lock:
  1603. thread_vim_command("let s:update.new['{0}'] = 1".format(self.name))
  1604. except PlugError as exc:
  1605. self.write(Action.ERROR, self.name, exc.msg)
  1606. except KeyboardInterrupt:
  1607. G_STOP.set()
  1608. self.write(Action.ERROR, self.name, ['Interrupted!'])
  1609. except:
  1610. # Any exception except those above print stack trace
  1611. msg = 'Trace:\n{0}'.format(traceback.format_exc().rstrip())
  1612. self.write(Action.ERROR, self.name, msg.split('\n'))
  1613. raise
  1614. def install(self):
  1615. target = self.args['dir']
  1616. if target[-1] == '\\':
  1617. target = target[0:-1]
  1618. def clean(target):
  1619. def _clean():
  1620. try:
  1621. shutil.rmtree(target)
  1622. except OSError:
  1623. pass
  1624. return _clean
  1625. self.write(Action.INSTALL, self.name, ['Installing ...'])
  1626. callback = functools.partial(self.write, Action.INSTALL, self.name)
  1627. cmd = 'git clone {0} {1} {2} {3} 2>&1'.format(
  1628. '' if self.tag else G_CLONE_OPT, G_PROGRESS, self.args['uri'],
  1629. esc(target))
  1630. com = Command(cmd, None, G_TIMEOUT, callback, clean(target))
  1631. result = com.execute(G_RETRIES)
  1632. self.write(Action.DONE, self.name, result[-1:])
  1633. def repo_uri(self):
  1634. cmd = 'git rev-parse --abbrev-ref HEAD 2>&1 && git config -f .git/config remote.origin.url'
  1635. command = Command(cmd, self.args['dir'], G_TIMEOUT,)
  1636. result = command.execute(G_RETRIES)
  1637. return result[-1]
  1638. def update(self):
  1639. actual_uri = self.repo_uri()
  1640. expect_uri = self.args['uri']
  1641. regex = re.compile(r'^(?:\w+://)?(?:[^@/]*@)?([^:/]*(?::[0-9]*)?)[:/](.*?)(?:\.git)?/?$')
  1642. ma = regex.match(actual_uri)
  1643. mb = regex.match(expect_uri)
  1644. if ma is None or mb is None or ma.groups() != mb.groups():
  1645. msg = ['',
  1646. 'Invalid URI: {0}'.format(actual_uri),
  1647. 'Expected {0}'.format(expect_uri),
  1648. 'PlugClean required.']
  1649. raise InvalidURI(msg)
  1650. if G_PULL:
  1651. self.write(Action.UPDATE, self.name, ['Updating ...'])
  1652. callback = functools.partial(self.write, Action.UPDATE, self.name)
  1653. fetch_opt = '--depth 99999999' if self.tag and os.path.isfile(os.path.join(self.args['dir'], '.git/shallow')) else ''
  1654. cmd = 'git fetch {0} {1} 2>&1'.format(fetch_opt, G_PROGRESS)
  1655. com = Command(cmd, self.args['dir'], G_TIMEOUT, callback)
  1656. result = com.execute(G_RETRIES)
  1657. self.write(Action.DONE, self.name, result[-1:])
  1658. else:
  1659. self.write(Action.DONE, self.name, ['Already installed'])
  1660. def write(self, action, name, msg):
  1661. self.buf_q.put((action, name, msg))
  1662. class PlugThread(thr.Thread):
  1663. def __init__(self, tname, args):
  1664. super(PlugThread, self).__init__()
  1665. self.tname = tname
  1666. self.args = args
  1667. def run(self):
  1668. thr.current_thread().name = self.tname
  1669. buf_q, work_q, lock = self.args
  1670. try:
  1671. while not G_STOP.is_set():
  1672. name, args = work_q.get_nowait()
  1673. plug = Plugin(name, args, buf_q, lock)
  1674. plug.manage()
  1675. work_q.task_done()
  1676. except queue.Empty:
  1677. pass
  1678. class RefreshThread(thr.Thread):
  1679. def __init__(self, lock):
  1680. super(RefreshThread, self).__init__()
  1681. self.lock = lock
  1682. self.running = True
  1683. def run(self):
  1684. while self.running:
  1685. with self.lock:
  1686. thread_vim_command('noautocmd normal! a')
  1687. time.sleep(0.33)
  1688. def stop(self):
  1689. self.running = False
  1690. if G_NVIM:
  1691. def thread_vim_command(cmd):
  1692. vim.session.threadsafe_call(lambda: vim.command(cmd))
  1693. else:
  1694. def thread_vim_command(cmd):
  1695. vim.command(cmd)
  1696. def esc(name):
  1697. return '"' + name.replace('"', '\"') + '"'
  1698. def nonblock_read(fname):
  1699. """ Read a file with nonblock flag. Return the last line. """
  1700. fread = os.open(fname, os.O_RDONLY | os.O_NONBLOCK)
  1701. buf = os.read(fread, 100000).decode('utf-8', 'replace')
  1702. os.close(fread)
  1703. line = buf.rstrip('\r\n')
  1704. left = max(line.rfind('\r'), line.rfind('\n'))
  1705. if left != -1:
  1706. left += 1
  1707. line = line[left:]
  1708. return line
  1709. def main():
  1710. thr.current_thread().name = 'main'
  1711. nthreads = int(vim.eval('s:update.threads'))
  1712. plugs = vim.eval('s:update.todo')
  1713. mac_gui = vim.eval('s:mac_gui') == '1'
  1714. lock = thr.Lock()
  1715. buf = Buffer(lock, len(plugs), G_PULL)
  1716. buf_q, work_q = queue.Queue(), queue.Queue()
  1717. for work in plugs.items():
  1718. work_q.put(work)
  1719. start_cnt = thr.active_count()
  1720. for num in range(nthreads):
  1721. tname = 'PlugT-{0:02}'.format(num)
  1722. thread = PlugThread(tname, (buf_q, work_q, lock))
  1723. thread.start()
  1724. if mac_gui:
  1725. rthread = RefreshThread(lock)
  1726. rthread.start()
  1727. while not buf_q.empty() or thr.active_count() != start_cnt:
  1728. try:
  1729. action, name, msg = buf_q.get(True, 0.25)
  1730. buf.write(action, name, ['OK'] if not msg else msg)
  1731. buf_q.task_done()
  1732. except queue.Empty:
  1733. pass
  1734. except KeyboardInterrupt:
  1735. G_STOP.set()
  1736. if mac_gui:
  1737. rthread.stop()
  1738. rthread.join()
  1739. main()
  1740. EOF
  1741. endfunction
  1742. function! s:update_ruby()
  1743. ruby << EOF
  1744. module PlugStream
  1745. SEP = ["\r", "\n", nil]
  1746. def get_line
  1747. buffer = ''
  1748. loop do
  1749. char = readchar rescue return
  1750. if SEP.include? char.chr
  1751. buffer << $/
  1752. break
  1753. else
  1754. buffer << char
  1755. end
  1756. end
  1757. buffer
  1758. end
  1759. end unless defined?(PlugStream)
  1760. def esc arg
  1761. %["#{arg.gsub('"', '\"')}"]
  1762. end
  1763. def killall pid
  1764. pids = [pid]
  1765. if /mswin|mingw|bccwin/ =~ RUBY_PLATFORM
  1766. pids.each { |pid| Process.kill 'INT', pid.to_i rescue nil }
  1767. else
  1768. unless `which pgrep 2> /dev/null`.empty?
  1769. children = pids
  1770. until children.empty?
  1771. children = children.map { |pid|
  1772. `pgrep -P #{pid}`.lines.map { |l| l.chomp }
  1773. }.flatten
  1774. pids += children
  1775. end
  1776. end
  1777. pids.each { |pid| Process.kill 'TERM', pid.to_i rescue nil }
  1778. end
  1779. end
  1780. def compare_git_uri a, b
  1781. regex = %r{^(?:\w+://)?(?:[^@/]*@)?([^:/]*(?::[0-9]*)?)[:/](.*?)(?:\.git)?/?$}
  1782. regex.match(a).to_a.drop(1) == regex.match(b).to_a.drop(1)
  1783. end
  1784. require 'thread'
  1785. require 'fileutils'
  1786. require 'timeout'
  1787. running = true
  1788. iswin = VIM::evaluate('s:is_win').to_i == 1
  1789. pull = VIM::evaluate('s:update.pull').to_i == 1
  1790. base = VIM::evaluate('g:plug_home')
  1791. all = VIM::evaluate('s:update.todo')
  1792. limit = VIM::evaluate('get(g:, "plug_timeout", 60)')
  1793. tries = VIM::evaluate('get(g:, "plug_retries", 2)') + 1
  1794. nthr = VIM::evaluate('s:update.threads').to_i
  1795. maxy = VIM::evaluate('winheight(".")').to_i
  1796. vim7 = VIM::evaluate('v:version').to_i <= 703 && RUBY_PLATFORM =~ /darwin/
  1797. cd = iswin ? 'cd /d' : 'cd'
  1798. tot = VIM::evaluate('len(s:update.todo)') || 0
  1799. bar = ''
  1800. skip = 'Already installed'
  1801. mtx = Mutex.new
  1802. take1 = proc { mtx.synchronize { running && all.shift } }
  1803. logh = proc {
  1804. cnt = bar.length
  1805. $curbuf[1] = "#{pull ? 'Updating' : 'Installing'} plugins (#{cnt}/#{tot})"
  1806. $curbuf[2] = '[' + bar.ljust(tot) + ']'
  1807. VIM::command('normal! 2G')
  1808. VIM::command('redraw')
  1809. }
  1810. where = proc { |name| (1..($curbuf.length)).find { |l| $curbuf[l] =~ /^[-+x*] #{name}:/ } }
  1811. log = proc { |name, result, type|
  1812. mtx.synchronize do
  1813. ing = ![true, false].include?(type)
  1814. bar += type ? '=' : 'x' unless ing
  1815. b = case type
  1816. when :install then '+' when :update then '*'
  1817. when true, nil then '-' else
  1818. VIM::command("call add(s:update.errors, '#{name}')")
  1819. 'x'
  1820. end
  1821. result =
  1822. if type || type.nil?
  1823. ["#{b} #{name}: #{result.lines.to_a.last || 'OK'}"]
  1824. elsif result =~ /^Interrupted|^Timeout/
  1825. ["#{b} #{name}: #{result}"]
  1826. else
  1827. ["#{b} #{name}"] + result.lines.map { |l| " " << l }
  1828. end
  1829. if lnum = where.call(name)
  1830. $curbuf.delete lnum
  1831. lnum = 4 if ing && lnum > maxy
  1832. end
  1833. result.each_with_index do |line, offset|
  1834. $curbuf.append((lnum || 4) - 1 + offset, line.gsub(/\e\[./, '').chomp)
  1835. end
  1836. logh.call
  1837. end
  1838. }
  1839. bt = proc { |cmd, name, type, cleanup|
  1840. tried = timeout = 0
  1841. begin
  1842. tried += 1
  1843. timeout += limit
  1844. fd = nil
  1845. data = ''
  1846. if iswin
  1847. Timeout::timeout(timeout) do
  1848. tmp = VIM::evaluate('tempname()')
  1849. system("(#{cmd}) > #{tmp}")
  1850. data = File.read(tmp).chomp
  1851. File.unlink tmp rescue nil
  1852. end
  1853. else
  1854. fd = IO.popen(cmd).extend(PlugStream)
  1855. first_line = true
  1856. log_prob = 1.0 / nthr
  1857. while line = Timeout::timeout(timeout) { fd.get_line }
  1858. data << line
  1859. log.call name, line.chomp, type if name && (first_line || rand < log_prob)
  1860. first_line = false
  1861. end
  1862. fd.close
  1863. end
  1864. [$? == 0, data.chomp]
  1865. rescue Timeout::Error, Interrupt => e
  1866. if fd && !fd.closed?
  1867. killall fd.pid
  1868. fd.close
  1869. end
  1870. cleanup.call if cleanup
  1871. if e.is_a?(Timeout::Error) && tried < tries
  1872. 3.downto(1) do |countdown|
  1873. s = countdown > 1 ? 's' : ''
  1874. log.call name, "Timeout. Will retry in #{countdown} second#{s} ...", type
  1875. sleep 1
  1876. end
  1877. log.call name, 'Retrying ...', type
  1878. retry
  1879. end
  1880. [false, e.is_a?(Interrupt) ? "Interrupted!" : "Timeout!"]
  1881. end
  1882. }
  1883. main = Thread.current
  1884. threads = []
  1885. watcher = Thread.new {
  1886. if vim7
  1887. while VIM::evaluate('getchar(1)')
  1888. sleep 0.1
  1889. end
  1890. else
  1891. require 'io/console' # >= Ruby 1.9
  1892. nil until IO.console.getch == 3.chr
  1893. end
  1894. mtx.synchronize do
  1895. running = false
  1896. threads.each { |t| t.raise Interrupt } unless vim7
  1897. end
  1898. threads.each { |t| t.join rescue nil }
  1899. main.kill
  1900. }
  1901. refresh = Thread.new {
  1902. while true
  1903. mtx.synchronize do
  1904. break unless running
  1905. VIM::command('noautocmd normal! a')
  1906. end
  1907. sleep 0.2
  1908. end
  1909. } if VIM::evaluate('s:mac_gui') == 1
  1910. clone_opt = VIM::evaluate('s:clone_opt').join(' ')
  1911. progress = VIM::evaluate('s:progress_opt(1)')
  1912. nthr.times do
  1913. mtx.synchronize do
  1914. threads << Thread.new {
  1915. while pair = take1.call
  1916. name = pair.first
  1917. dir, uri, tag = pair.last.values_at *%w[dir uri tag]
  1918. exists = File.directory? dir
  1919. ok, result =
  1920. if exists
  1921. chdir = "#{cd} #{iswin ? dir : esc(dir)}"
  1922. ret, data = bt.call "#{chdir} && git rev-parse --abbrev-ref HEAD 2>&1 && git config -f .git/config remote.origin.url", nil, nil, nil
  1923. current_uri = data.lines.to_a.last
  1924. if !ret
  1925. if data =~ /^Interrupted|^Timeout/
  1926. [false, data]
  1927. else
  1928. [false, [data.chomp, "PlugClean required."].join($/)]
  1929. end
  1930. elsif !compare_git_uri(current_uri, uri)
  1931. [false, ["Invalid URI: #{current_uri}",
  1932. "Expected: #{uri}",
  1933. "PlugClean required."].join($/)]
  1934. else
  1935. if pull
  1936. log.call name, 'Updating ...', :update
  1937. fetch_opt = (tag && File.exist?(File.join(dir, '.git/shallow'))) ? '--depth 99999999' : ''
  1938. bt.call "#{chdir} && git fetch #{fetch_opt} #{progress} 2>&1", name, :update, nil
  1939. else
  1940. [true, skip]
  1941. end
  1942. end
  1943. else
  1944. d = esc dir.sub(%r{[\\/]+$}, '')
  1945. log.call name, 'Installing ...', :install
  1946. bt.call "git clone #{clone_opt unless tag} #{progress} #{uri} #{d} 2>&1", name, :install, proc {
  1947. FileUtils.rm_rf dir
  1948. }
  1949. end
  1950. mtx.synchronize { VIM::command("let s:update.new['#{name}'] = 1") } if !exists && ok
  1951. log.call name, result, ok
  1952. end
  1953. } if running
  1954. end
  1955. end
  1956. threads.each { |t| t.join rescue nil }
  1957. logh.call
  1958. refresh.kill if refresh
  1959. watcher.kill
  1960. EOF
  1961. endfunction
  1962. function! s:shellesc_cmd(arg, script)
  1963. let escaped = substitute('"'.a:arg.'"', '[&|<>()@^!"]', '^&', 'g')
  1964. return substitute(escaped, '%', (a:script ? '%' : '^') . '&', 'g')
  1965. endfunction
  1966. function! s:shellesc_ps1(arg)
  1967. return "'".substitute(escape(a:arg, '\"'), "'", "''", 'g')."'"
  1968. endfunction
  1969. function! s:shellesc_sh(arg)
  1970. return "'".substitute(a:arg, "'", "'\\\\''", 'g')."'"
  1971. endfunction
  1972. " Escape the shell argument based on the shell.
  1973. " Vim and Neovim's shellescape() are insufficient.
  1974. " 1. shellslash determines whether to use single/double quotes.
  1975. " Double-quote escaping is fragile for cmd.exe.
  1976. " 2. It does not work for powershell.
  1977. " 3. It does not work for *sh shells if the command is executed
  1978. " via cmd.exe (ie. cmd.exe /c sh -c command command_args)
  1979. " 4. It does not support batchfile syntax.
  1980. "
  1981. " Accepts an optional dictionary with the following keys:
  1982. " - shell: same as Vim/Neovim 'shell' option.
  1983. " If unset, fallback to 'cmd.exe' on Windows or 'sh'.
  1984. " - script: If truthy and shell is cmd.exe, escape for batchfile syntax.
  1985. function! plug#shellescape(arg, ...)
  1986. if a:arg =~# '^[A-Za-z0-9_/:.-]\+$'
  1987. return a:arg
  1988. endif
  1989. let opts = a:0 > 0 && type(a:1) == s:TYPE.dict ? a:1 : {}
  1990. let shell = get(opts, 'shell', s:is_win ? 'cmd.exe' : 'sh')
  1991. let script = get(opts, 'script', 1)
  1992. if shell =~# 'cmd\(\.exe\)\?$'
  1993. return s:shellesc_cmd(a:arg, script)
  1994. elseif shell =~# 'powershell\(\.exe\)\?$' || shell =~# 'pwsh$'
  1995. return s:shellesc_ps1(a:arg)
  1996. endif
  1997. return s:shellesc_sh(a:arg)
  1998. endfunction
  1999. function! s:glob_dir(path)
  2000. return map(filter(s:glob(a:path, '**'), 'isdirectory(v:val)'), 's:dirpath(v:val)')
  2001. endfunction
  2002. function! s:progress_bar(line, bar, total)
  2003. call setline(a:line, '[' . s:lpad(a:bar, a:total) . ']')
  2004. endfunction
  2005. function! s:compare_git_uri(a, b)
  2006. " See `git help clone'
  2007. " https:// [user@] github.com[:port] / junegunn/vim-plug [.git]
  2008. " [git@] github.com[:port] : junegunn/vim-plug [.git]
  2009. " file:// / junegunn/vim-plug [/]
  2010. " / junegunn/vim-plug [/]
  2011. let pat = '^\%(\w\+://\)\='.'\%([^@/]*@\)\='.'\([^:/]*\%(:[0-9]*\)\=\)'.'[:/]'.'\(.\{-}\)'.'\%(\.git\)\=/\?$'
  2012. let ma = matchlist(a:a, pat)
  2013. let mb = matchlist(a:b, pat)
  2014. return ma[1:2] ==# mb[1:2]
  2015. endfunction
  2016. function! s:format_message(bullet, name, message)
  2017. if a:bullet != 'x'
  2018. return [printf('%s %s: %s', a:bullet, a:name, s:lastline(a:message))]
  2019. else
  2020. let lines = map(s:lines(a:message), '" ".v:val')
  2021. return extend([printf('x %s:', a:name)], lines)
  2022. endif
  2023. endfunction
  2024. function! s:with_cd(cmd, dir, ...)
  2025. let script = a:0 > 0 ? a:1 : 1
  2026. return printf('cd%s %s && %s', s:is_win ? ' /d' : '', plug#shellescape(a:dir, {'script': script}), a:cmd)
  2027. endfunction
  2028. function! s:system(cmd, ...)
  2029. let batchfile = ''
  2030. try
  2031. let [sh, shellcmdflag, shrd] = s:chsh(1)
  2032. if type(a:cmd) == s:TYPE.list
  2033. " Neovim's system() supports list argument to bypass the shell
  2034. " but it cannot set the working directory for the command.
  2035. " Assume that the command does not rely on the shell.
  2036. if has('nvim') && a:0 == 0
  2037. return system(a:cmd)
  2038. endif
  2039. let cmd = join(map(copy(a:cmd), 'plug#shellescape(v:val, {"shell": &shell, "script": 0})'))
  2040. if &shell =~# 'powershell\(\.exe\)\?$'
  2041. let cmd = '& ' . cmd
  2042. endif
  2043. else
  2044. let cmd = a:cmd
  2045. endif
  2046. if a:0 > 0
  2047. let cmd = s:with_cd(cmd, a:1, type(a:cmd) != s:TYPE.list)
  2048. endif
  2049. if s:is_win && type(a:cmd) != s:TYPE.list
  2050. let [batchfile, cmd] = s:batchfile(cmd)
  2051. endif
  2052. return system(cmd)
  2053. finally
  2054. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  2055. if s:is_win && filereadable(batchfile)
  2056. call delete(batchfile)
  2057. endif
  2058. endtry
  2059. endfunction
  2060. function! s:system_chomp(...)
  2061. let ret = call('s:system', a:000)
  2062. return v:shell_error ? '' : substitute(ret, '\n$', '', '')
  2063. endfunction
  2064. function! s:git_origin_branch(spec)
  2065. if len(a:spec.branch)
  2066. return a:spec.branch
  2067. endif
  2068. " The file may not be present if this is a local repository
  2069. let origin_head = a:spec.dir.'/.git/refs/remotes/origin/HEAD'
  2070. if filereadable(origin_head)
  2071. return split(readfile(origin_head)[0], 'refs/remotes/origin/')[-1]
  2072. endif
  2073. " The command may not return the name of a branch in detached HEAD state
  2074. let result = s:lines(s:system('git symbolic-ref --short HEAD', a:spec.dir))
  2075. return v:shell_error ? '' : result[-1]
  2076. endfunction
  2077. function! s:git_validate(spec, check_branch)
  2078. let err = ''
  2079. if isdirectory(a:spec.dir)
  2080. let result = [s:git_get_branch(a:spec.dir), s:git_get_remote_origin_url(a:spec.dir)]
  2081. let remote = result[-1]
  2082. if empty(remote)
  2083. let err = join([remote, 'PlugClean required.'], "\n")
  2084. elseif !s:compare_git_uri(remote, a:spec.uri)
  2085. let err = join(['Invalid URI: '.remote,
  2086. \ 'Expected: '.a:spec.uri,
  2087. \ 'PlugClean required.'], "\n")
  2088. elseif a:check_branch && has_key(a:spec, 'commit')
  2089. let sha = s:git_get_revision(a:spec.dir)
  2090. if empty(sha)
  2091. let err = join(add(result, 'PlugClean required.'), "\n")
  2092. elseif !s:hash_match(sha, a:spec.commit)
  2093. let err = join([printf('Invalid HEAD (expected: %s, actual: %s)',
  2094. \ a:spec.commit[:6], sha[:6]),
  2095. \ 'PlugUpdate required.'], "\n")
  2096. endif
  2097. elseif a:check_branch
  2098. let current_branch = result[0]
  2099. " Check tag
  2100. let origin_branch = s:git_origin_branch(a:spec)
  2101. if has_key(a:spec, 'tag')
  2102. let tag = s:system_chomp('git describe --exact-match --tags HEAD 2>&1', a:spec.dir)
  2103. if a:spec.tag !=# tag && a:spec.tag !~ '\*'
  2104. let err = printf('Invalid tag: %s (expected: %s). Try PlugUpdate.',
  2105. \ (empty(tag) ? 'N/A' : tag), a:spec.tag)
  2106. endif
  2107. " Check branch
  2108. elseif origin_branch !=# current_branch
  2109. let err = printf('Invalid branch: %s (expected: %s). Try PlugUpdate.',
  2110. \ current_branch, origin_branch)
  2111. endif
  2112. if empty(err)
  2113. let [ahead, behind] = split(s:lastline(s:system([
  2114. \ 'git', 'rev-list', '--count', '--left-right',
  2115. \ printf('HEAD...origin/%s', origin_branch)
  2116. \ ], a:spec.dir)), '\t')
  2117. if !v:shell_error && ahead
  2118. if behind
  2119. " Only mention PlugClean if diverged, otherwise it's likely to be
  2120. " pushable (and probably not that messed up).
  2121. let err = printf(
  2122. \ "Diverged from origin/%s (%d commit(s) ahead and %d commit(s) behind!\n"
  2123. \ .'Backup local changes and run PlugClean and PlugUpdate to reinstall it.', origin_branch, ahead, behind)
  2124. else
  2125. let err = printf("Ahead of origin/%s by %d commit(s).\n"
  2126. \ .'Cannot update until local changes are pushed.',
  2127. \ origin_branch, ahead)
  2128. endif
  2129. endif
  2130. endif
  2131. endif
  2132. else
  2133. let err = 'Not found'
  2134. endif
  2135. return [err, err =~# 'PlugClean']
  2136. endfunction
  2137. function! s:rm_rf(dir)
  2138. if isdirectory(a:dir)
  2139. return s:system(s:is_win
  2140. \ ? 'rmdir /S /Q '.plug#shellescape(a:dir)
  2141. \ : ['rm', '-rf', a:dir])
  2142. endif
  2143. endfunction
  2144. function! s:clean(force)
  2145. call s:prepare()
  2146. call append(0, 'Searching for invalid plugins in '.g:plug_home)
  2147. call append(1, '')
  2148. " List of valid directories
  2149. let dirs = []
  2150. let errs = {}
  2151. let [cnt, total] = [0, len(g:plugs)]
  2152. for [name, spec] in items(g:plugs)
  2153. if !s:is_managed(name)
  2154. call add(dirs, spec.dir)
  2155. else
  2156. let [err, clean] = s:git_validate(spec, 1)
  2157. if clean
  2158. let errs[spec.dir] = s:lines(err)[0]
  2159. else
  2160. call add(dirs, spec.dir)
  2161. endif
  2162. endif
  2163. let cnt += 1
  2164. call s:progress_bar(2, repeat('=', cnt), total)
  2165. normal! 2G
  2166. redraw
  2167. endfor
  2168. let allowed = {}
  2169. for dir in dirs
  2170. let allowed[s:dirpath(s:plug_fnamemodify(dir, ':h:h'))] = 1
  2171. let allowed[dir] = 1
  2172. for child in s:glob_dir(dir)
  2173. let allowed[child] = 1
  2174. endfor
  2175. endfor
  2176. let todo = []
  2177. let found = sort(s:glob_dir(g:plug_home))
  2178. while !empty(found)
  2179. let f = remove(found, 0)
  2180. if !has_key(allowed, f) && isdirectory(f)
  2181. call add(todo, f)
  2182. call append(line('$'), '- ' . f)
  2183. if has_key(errs, f)
  2184. call append(line('$'), ' ' . errs[f])
  2185. endif
  2186. let found = filter(found, 'stridx(v:val, f) != 0')
  2187. end
  2188. endwhile
  2189. 4
  2190. redraw
  2191. if empty(todo)
  2192. call append(line('$'), 'Already clean.')
  2193. else
  2194. let s:clean_count = 0
  2195. call append(3, ['Directories to delete:', ''])
  2196. redraw!
  2197. if a:force || s:ask_no_interrupt('Delete all directories?')
  2198. call s:delete([6, line('$')], 1)
  2199. else
  2200. call setline(4, 'Cancelled.')
  2201. nnoremap <silent> <buffer> d :set opfunc=<sid>delete_op<cr>g@
  2202. nmap <silent> <buffer> dd d_
  2203. xnoremap <silent> <buffer> d :<c-u>call <sid>delete_op(visualmode(), 1)<cr>
  2204. echo 'Delete the lines (d{motion}) to delete the corresponding directories'
  2205. endif
  2206. endif
  2207. 4
  2208. setlocal nomodifiable
  2209. endfunction
  2210. function! s:delete_op(type, ...)
  2211. call s:delete(a:0 ? [line("'<"), line("'>")] : [line("'["), line("']")], 0)
  2212. endfunction
  2213. function! s:delete(range, force)
  2214. let [l1, l2] = a:range
  2215. let force = a:force
  2216. let err_count = 0
  2217. while l1 <= l2
  2218. let line = getline(l1)
  2219. if line =~ '^- ' && isdirectory(line[2:])
  2220. execute l1
  2221. redraw!
  2222. let answer = force ? 1 : s:ask('Delete '.line[2:].'?', 1)
  2223. let force = force || answer > 1
  2224. if answer
  2225. let err = s:rm_rf(line[2:])
  2226. setlocal modifiable
  2227. if empty(err)
  2228. call setline(l1, '~'.line[1:])
  2229. let s:clean_count += 1
  2230. else
  2231. delete _
  2232. call append(l1 - 1, s:format_message('x', line[1:], err))
  2233. let l2 += len(s:lines(err))
  2234. let err_count += 1
  2235. endif
  2236. let msg = printf('Removed %d directories.', s:clean_count)
  2237. if err_count > 0
  2238. let msg .= printf(' Failed to remove %d directories.', err_count)
  2239. endif
  2240. call setline(4, msg)
  2241. setlocal nomodifiable
  2242. endif
  2243. endif
  2244. let l1 += 1
  2245. endwhile
  2246. endfunction
  2247. function! s:upgrade()
  2248. echo 'Downloading the latest version of vim-plug'
  2249. redraw
  2250. let tmp = s:plug_tempname()
  2251. let new = tmp . '/plug.vim'
  2252. try
  2253. let out = s:system(['git', 'clone', '--depth', '1', s:plug_src, tmp])
  2254. if v:shell_error
  2255. return s:err('Error upgrading vim-plug: '. out)
  2256. endif
  2257. if readfile(s:me) ==# readfile(new)
  2258. echo 'vim-plug is already up-to-date'
  2259. return 0
  2260. else
  2261. call rename(s:me, s:me . '.old')
  2262. call rename(new, s:me)
  2263. unlet g:loaded_plug
  2264. echo 'vim-plug has been upgraded'
  2265. return 1
  2266. endif
  2267. finally
  2268. silent! call s:rm_rf(tmp)
  2269. endtry
  2270. endfunction
  2271. function! s:upgrade_specs()
  2272. for spec in values(g:plugs)
  2273. let spec.frozen = get(spec, 'frozen', 0)
  2274. endfor
  2275. endfunction
  2276. function! s:status()
  2277. call s:prepare()
  2278. call append(0, 'Checking plugins')
  2279. call append(1, '')
  2280. let ecnt = 0
  2281. let unloaded = 0
  2282. let [cnt, total] = [0, len(g:plugs)]
  2283. for [name, spec] in items(g:plugs)
  2284. let is_dir = isdirectory(spec.dir)
  2285. if has_key(spec, 'uri')
  2286. if is_dir
  2287. let [err, _] = s:git_validate(spec, 1)
  2288. let [valid, msg] = [empty(err), empty(err) ? 'OK' : err]
  2289. else
  2290. let [valid, msg] = [0, 'Not found. Try PlugInstall.']
  2291. endif
  2292. else
  2293. if is_dir
  2294. let [valid, msg] = [1, 'OK']
  2295. else
  2296. let [valid, msg] = [0, 'Not found.']
  2297. endif
  2298. endif
  2299. let cnt += 1
  2300. let ecnt += !valid
  2301. " `s:loaded` entry can be missing if PlugUpgraded
  2302. if is_dir && get(s:loaded, name, -1) == 0
  2303. let unloaded = 1
  2304. let msg .= ' (not loaded)'
  2305. endif
  2306. call s:progress_bar(2, repeat('=', cnt), total)
  2307. call append(3, s:format_message(valid ? '-' : 'x', name, msg))
  2308. normal! 2G
  2309. redraw
  2310. endfor
  2311. call setline(1, 'Finished. '.ecnt.' error(s).')
  2312. normal! gg
  2313. setlocal nomodifiable
  2314. if unloaded
  2315. echo "Press 'L' on each line to load plugin, or 'U' to update"
  2316. nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  2317. xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  2318. end
  2319. endfunction
  2320. function! s:extract_name(str, prefix, suffix)
  2321. return matchstr(a:str, '^'.a:prefix.' \zs[^:]\+\ze:.*'.a:suffix.'$')
  2322. endfunction
  2323. function! s:status_load(lnum)
  2324. let line = getline(a:lnum)
  2325. let name = s:extract_name(line, '-', '(not loaded)')
  2326. if !empty(name)
  2327. call plug#load(name)
  2328. setlocal modifiable
  2329. call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
  2330. setlocal nomodifiable
  2331. endif
  2332. endfunction
  2333. function! s:status_update() range
  2334. let lines = getline(a:firstline, a:lastline)
  2335. let names = filter(map(lines, 's:extract_name(v:val, "[x-]", "")'), '!empty(v:val)')
  2336. if !empty(names)
  2337. echo
  2338. execute 'PlugUpdate' join(names)
  2339. endif
  2340. endfunction
  2341. function! s:is_preview_window_open()
  2342. silent! wincmd P
  2343. if &previewwindow
  2344. wincmd p
  2345. return 1
  2346. endif
  2347. endfunction
  2348. function! s:find_name(lnum)
  2349. for lnum in reverse(range(1, a:lnum))
  2350. let line = getline(lnum)
  2351. if empty(line)
  2352. return ''
  2353. endif
  2354. let name = s:extract_name(line, '-', '')
  2355. if !empty(name)
  2356. return name
  2357. endif
  2358. endfor
  2359. return ''
  2360. endfunction
  2361. function! s:preview_commit()
  2362. if b:plug_preview < 0
  2363. let b:plug_preview = !s:is_preview_window_open()
  2364. endif
  2365. let sha = matchstr(getline('.'), '^ \X*\zs[0-9a-f]\{7,9}')
  2366. if empty(sha)
  2367. return
  2368. endif
  2369. let name = s:find_name(line('.'))
  2370. if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
  2371. return
  2372. endif
  2373. if exists('g:plug_pwindow') && !s:is_preview_window_open()
  2374. execute g:plug_pwindow
  2375. execute 'e' sha
  2376. else
  2377. execute 'pedit' sha
  2378. wincmd P
  2379. endif
  2380. setlocal previewwindow filetype=git buftype=nofile nobuflisted modifiable
  2381. let batchfile = ''
  2382. try
  2383. let [sh, shellcmdflag, shrd] = s:chsh(1)
  2384. let cmd = 'cd '.plug#shellescape(g:plugs[name].dir).' && git show --no-color --pretty=medium '.sha
  2385. if s:is_win
  2386. let [batchfile, cmd] = s:batchfile(cmd)
  2387. endif
  2388. execute 'silent %!' cmd
  2389. finally
  2390. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  2391. if s:is_win && filereadable(batchfile)
  2392. call delete(batchfile)
  2393. endif
  2394. endtry
  2395. setlocal nomodifiable
  2396. nnoremap <silent> <buffer> q :q<cr>
  2397. wincmd p
  2398. endfunction
  2399. function! s:section(flags)
  2400. call search('\(^[x-] \)\@<=[^:]\+:', a:flags)
  2401. endfunction
  2402. function! s:format_git_log(line)
  2403. let indent = ' '
  2404. let tokens = split(a:line, nr2char(1))
  2405. if len(tokens) != 5
  2406. return indent.substitute(a:line, '\s*$', '', '')
  2407. endif
  2408. let [graph, sha, refs, subject, date] = tokens
  2409. let tag = matchstr(refs, 'tag: [^,)]\+')
  2410. let tag = empty(tag) ? ' ' : ' ('.tag.') '
  2411. return printf('%s%s%s%s%s (%s)', indent, graph, sha, tag, subject, date)
  2412. endfunction
  2413. function! s:append_ul(lnum, text)
  2414. call append(a:lnum, ['', a:text, repeat('-', len(a:text))])
  2415. endfunction
  2416. function! s:diff()
  2417. call s:prepare()
  2418. call append(0, ['Collecting changes ...', ''])
  2419. let cnts = [0, 0]
  2420. let bar = ''
  2421. let total = filter(copy(g:plugs), 's:is_managed(v:key) && isdirectory(v:val.dir)')
  2422. call s:progress_bar(2, bar, len(total))
  2423. for origin in [1, 0]
  2424. let plugs = reverse(sort(items(filter(copy(total), (origin ? '' : '!').'(has_key(v:val, "commit") || has_key(v:val, "tag"))'))))
  2425. if empty(plugs)
  2426. continue
  2427. endif
  2428. call s:append_ul(2, origin ? 'Pending updates:' : 'Last update:')
  2429. for [k, v] in plugs
  2430. let branch = s:git_origin_branch(v)
  2431. if len(branch)
  2432. let range = origin ? '..origin/'.branch : 'HEAD@{1}..'
  2433. let cmd = ['git', 'log', '--graph', '--color=never']
  2434. if s:git_version_requirement(2, 10, 0)
  2435. call add(cmd, '--no-show-signature')
  2436. endif
  2437. call extend(cmd, ['--pretty=format:%x01%h%x01%d%x01%s%x01%cr', range])
  2438. if has_key(v, 'rtp')
  2439. call extend(cmd, ['--', v.rtp])
  2440. endif
  2441. let diff = s:system_chomp(cmd, v.dir)
  2442. if !empty(diff)
  2443. let ref = has_key(v, 'tag') ? (' (tag: '.v.tag.')') : has_key(v, 'commit') ? (' '.v.commit) : ''
  2444. call append(5, extend(['', '- '.k.':'.ref], map(s:lines(diff), 's:format_git_log(v:val)')))
  2445. let cnts[origin] += 1
  2446. endif
  2447. endif
  2448. let bar .= '='
  2449. call s:progress_bar(2, bar, len(total))
  2450. normal! 2G
  2451. redraw
  2452. endfor
  2453. if !cnts[origin]
  2454. call append(5, ['', 'N/A'])
  2455. endif
  2456. endfor
  2457. call setline(1, printf('%d plugin(s) updated.', cnts[0])
  2458. \ . (cnts[1] ? printf(' %d plugin(s) have pending updates.', cnts[1]) : ''))
  2459. if cnts[0] || cnts[1]
  2460. nnoremap <silent> <buffer> <plug>(plug-preview) :silent! call <SID>preview_commit()<cr>
  2461. if empty(maparg("\<cr>", 'n'))
  2462. nmap <buffer> <cr> <plug>(plug-preview)
  2463. endif
  2464. if empty(maparg('o', 'n'))
  2465. nmap <buffer> o <plug>(plug-preview)
  2466. endif
  2467. endif
  2468. if cnts[0]
  2469. nnoremap <silent> <buffer> X :call <SID>revert()<cr>
  2470. echo "Press 'X' on each block to revert the update"
  2471. endif
  2472. normal! gg
  2473. setlocal nomodifiable
  2474. endfunction
  2475. function! s:revert()
  2476. if search('^Pending updates', 'bnW')
  2477. return
  2478. endif
  2479. let name = s:find_name(line('.'))
  2480. if empty(name) || !has_key(g:plugs, name) ||
  2481. \ input(printf('Revert the update of %s? (y/N) ', name)) !~? '^y'
  2482. return
  2483. endif
  2484. call s:system('git reset --hard HEAD@{1} && git checkout '.plug#shellescape(g:plugs[name].branch).' --', g:plugs[name].dir)
  2485. setlocal modifiable
  2486. normal! "_dap
  2487. setlocal nomodifiable
  2488. echo 'Reverted'
  2489. endfunction
  2490. function! s:snapshot(force, ...) abort
  2491. call s:prepare()
  2492. setf vim
  2493. call append(0, ['" Generated by vim-plug',
  2494. \ '" '.strftime("%c"),
  2495. \ '" :source this file in vim to restore the snapshot',
  2496. \ '" or execute: vim -S snapshot.vim',
  2497. \ '', '', 'PlugUpdate!'])
  2498. 1
  2499. let anchor = line('$') - 3
  2500. let names = sort(keys(filter(copy(g:plugs),
  2501. \'has_key(v:val, "uri") && !has_key(v:val, "commit") && isdirectory(v:val.dir)')))
  2502. for name in reverse(names)
  2503. let sha = s:git_get_revision(g:plugs[name].dir)
  2504. if !empty(sha)
  2505. call append(anchor, printf("silent! let g:plugs['%s'].commit = '%s'", name, sha))
  2506. redraw
  2507. endif
  2508. endfor
  2509. if a:0 > 0
  2510. let fn = s:plug_expand(a:1)
  2511. if filereadable(fn) && !(a:force || s:ask(a:1.' already exists. Overwrite?'))
  2512. return
  2513. endif
  2514. call writefile(getline(1, '$'), fn)
  2515. echo 'Saved as '.a:1
  2516. silent execute 'e' s:esc(fn)
  2517. setf vim
  2518. endif
  2519. endfunction
  2520. function! s:split_rtp()
  2521. return split(&rtp, '\\\@<!,')
  2522. endfunction
  2523. let s:first_rtp = s:escrtp(get(s:split_rtp(), 0, ''))
  2524. let s:last_rtp = s:escrtp(get(s:split_rtp(), -1, ''))
  2525. if exists('g:plugs')
  2526. let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
  2527. call s:upgrade_specs()
  2528. call s:define_commands()
  2529. endif
  2530. let &cpo = s:cpo_save
  2531. unlet s:cpo_save