plug.vim 81 KB

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