plug.vim 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786
  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 /^-/
  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 keyword Function PlugInstall PlugStatus PlugUpdate PlugClean
  743. hi def link plug1 Title
  744. hi def link plug2 Repeat
  745. hi def link plugH2 Type
  746. hi def link plugX Exception
  747. hi def link plugBracket Structure
  748. hi def link plugNumber Number
  749. hi def link plugDash Special
  750. hi def link plugPlus Constant
  751. hi def link plugStar Boolean
  752. hi def link plugMessage Function
  753. hi def link plugName Label
  754. hi def link plugInstall Function
  755. hi def link plugUpdate Type
  756. hi def link plugError Error
  757. hi def link plugDeleted Ignore
  758. hi def link plugRelDate Comment
  759. hi def link plugEdge PreProc
  760. hi def link plugSha Identifier
  761. hi def link plugTag Constant
  762. hi def link plugNotLoaded Comment
  763. endfunction
  764. function! s:lpad(str, len)
  765. return a:str . repeat(' ', a:len - len(a:str))
  766. endfunction
  767. function! s:lines(msg)
  768. return split(a:msg, "[\r\n]")
  769. endfunction
  770. function! s:lastline(msg)
  771. return get(s:lines(a:msg), -1, '')
  772. endfunction
  773. function! s:new_window()
  774. execute get(g:, 'plug_window', 'vertical topleft new')
  775. endfunction
  776. function! s:plug_window_exists()
  777. let buflist = tabpagebuflist(s:plug_tab)
  778. return !empty(buflist) && index(buflist, s:plug_buf) >= 0
  779. endfunction
  780. function! s:switch_in()
  781. if !s:plug_window_exists()
  782. return 0
  783. endif
  784. if winbufnr(0) != s:plug_buf
  785. let s:pos = [tabpagenr(), winnr(), winsaveview()]
  786. execute 'normal!' s:plug_tab.'gt'
  787. let winnr = bufwinnr(s:plug_buf)
  788. execute winnr.'wincmd w'
  789. call add(s:pos, winsaveview())
  790. else
  791. let s:pos = [winsaveview()]
  792. endif
  793. setlocal modifiable
  794. return 1
  795. endfunction
  796. function! s:switch_out(...)
  797. call winrestview(s:pos[-1])
  798. setlocal nomodifiable
  799. if a:0 > 0
  800. execute a:1
  801. endif
  802. if len(s:pos) > 1
  803. execute 'normal!' s:pos[0].'gt'
  804. execute s:pos[1] 'wincmd w'
  805. call winrestview(s:pos[2])
  806. endif
  807. endfunction
  808. function! s:finish_bindings()
  809. nnoremap <silent> <buffer> R :call <SID>retry()<cr>
  810. nnoremap <silent> <buffer> D :PlugDiff<cr>
  811. nnoremap <silent> <buffer> S :PlugStatus<cr>
  812. nnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  813. xnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  814. nnoremap <silent> <buffer> ]] :silent! call <SID>section('')<cr>
  815. nnoremap <silent> <buffer> [[ :silent! call <SID>section('b')<cr>
  816. endfunction
  817. function! s:prepare(...)
  818. if empty(s:plug_getcwd())
  819. throw 'Invalid current working directory. Cannot proceed.'
  820. endif
  821. for evar in ['$GIT_DIR', '$GIT_WORK_TREE']
  822. if exists(evar)
  823. throw evar.' detected. Cannot proceed.'
  824. endif
  825. endfor
  826. call s:job_abort()
  827. if s:switch_in()
  828. if b:plug_preview == 1
  829. pc
  830. endif
  831. enew
  832. else
  833. call s:new_window()
  834. endif
  835. nnoremap <silent> <buffer> q :if b:plug_preview==1<bar>pc<bar>endif<bar>bd<cr>
  836. if a:0 == 0
  837. call s:finish_bindings()
  838. endif
  839. let b:plug_preview = -1
  840. let s:plug_tab = tabpagenr()
  841. let s:plug_buf = winbufnr(0)
  842. call s:assign_name()
  843. for k in ['<cr>', 'L', 'o', 'X', 'd', 'dd']
  844. execute 'silent! unmap <buffer>' k
  845. endfor
  846. setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap cursorline modifiable nospell
  847. if exists('+colorcolumn')
  848. setlocal colorcolumn=
  849. endif
  850. setf vim-plug
  851. if exists('g:syntax_on')
  852. call s:syntax()
  853. endif
  854. endfunction
  855. function! s:assign_name()
  856. " Assign buffer name
  857. let prefix = '[Plugins]'
  858. let name = prefix
  859. let idx = 2
  860. while bufexists(name)
  861. let name = printf('%s (%s)', prefix, idx)
  862. let idx = idx + 1
  863. endwhile
  864. silent! execute 'f' fnameescape(name)
  865. endfunction
  866. function! s:chsh(swap)
  867. let prev = [&shell, &shellcmdflag, &shellredir]
  868. if !s:is_win
  869. set shell=sh
  870. endif
  871. if a:swap
  872. if &shell =~# 'powershell\(\.exe\)\?$' || &shell =~# 'pwsh$'
  873. let &shellredir = '2>&1 | Out-File -Encoding UTF8 %s'
  874. elseif &shell =~# 'sh' || &shell =~# 'cmd\(\.exe\)\?$'
  875. set shellredir=>%s\ 2>&1
  876. endif
  877. endif
  878. return prev
  879. endfunction
  880. function! s:bang(cmd, ...)
  881. let batchfile = ''
  882. try
  883. let [sh, shellcmdflag, shrd] = s:chsh(a:0)
  884. " FIXME: Escaping is incomplete. We could use shellescape with eval,
  885. " but it won't work on Windows.
  886. let cmd = a:0 ? s:with_cd(a:cmd, a:1) : a:cmd
  887. if s:is_win
  888. let [batchfile, cmd] = s:batchfile(cmd)
  889. endif
  890. let g:_plug_bang = (s:is_win && has('gui_running') ? 'silent ' : '').'!'.escape(cmd, '#!%')
  891. execute "normal! :execute g:_plug_bang\<cr>\<cr>"
  892. finally
  893. unlet g:_plug_bang
  894. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  895. if s:is_win && filereadable(batchfile)
  896. call delete(batchfile)
  897. endif
  898. endtry
  899. return v:shell_error ? 'Exit status: ' . v:shell_error : ''
  900. endfunction
  901. function! s:regress_bar()
  902. let bar = substitute(getline(2)[1:-2], '.*\zs=', 'x', '')
  903. call s:progress_bar(2, bar, len(bar))
  904. endfunction
  905. function! s:is_updated(dir)
  906. return !empty(s:system_chomp(['git', 'log', '--pretty=format:%h', 'HEAD...HEAD@{1}'], a:dir))
  907. endfunction
  908. function! s:do(pull, force, todo)
  909. for [name, spec] in items(a:todo)
  910. if !isdirectory(spec.dir)
  911. continue
  912. endif
  913. let installed = has_key(s:update.new, name)
  914. let updated = installed ? 0 :
  915. \ (a:pull && index(s:update.errors, name) < 0 && s:is_updated(spec.dir))
  916. if a:force || installed || updated
  917. execute 'cd' s:esc(spec.dir)
  918. call append(3, '- Post-update hook for '. name .' ... ')
  919. let error = ''
  920. let type = type(spec.do)
  921. if type == s:TYPE.string
  922. if spec.do[0] == ':'
  923. if !get(s:loaded, name, 0)
  924. let s:loaded[name] = 1
  925. call s:reorg_rtp()
  926. endif
  927. call s:load_plugin(spec)
  928. try
  929. execute spec.do[1:]
  930. catch
  931. let error = v:exception
  932. endtry
  933. if !s:plug_window_exists()
  934. cd -
  935. throw 'Warning: vim-plug was terminated by the post-update hook of '.name
  936. endif
  937. else
  938. let error = s:bang(spec.do)
  939. endif
  940. elseif type == s:TYPE.funcref
  941. try
  942. call s:load_plugin(spec)
  943. let status = installed ? 'installed' : (updated ? 'updated' : 'unchanged')
  944. call spec.do({ 'name': name, 'status': status, 'force': a:force })
  945. catch
  946. let error = v:exception
  947. endtry
  948. else
  949. let error = 'Invalid hook type'
  950. endif
  951. call s:switch_in()
  952. call setline(4, empty(error) ? (getline(4) . 'OK')
  953. \ : ('x' . getline(4)[1:] . error))
  954. if !empty(error)
  955. call add(s:update.errors, name)
  956. call s:regress_bar()
  957. endif
  958. cd -
  959. endif
  960. endfor
  961. endfunction
  962. function! s:hash_match(a, b)
  963. return stridx(a:a, a:b) == 0 || stridx(a:b, a:a) == 0
  964. endfunction
  965. function! s:checkout(spec)
  966. let sha = a:spec.commit
  967. let output = s:git_revision(a:spec.dir)
  968. if !empty(output) && !s:hash_match(sha, s:lines(output)[0])
  969. let output = s:system(
  970. \ 'git -c credential.helper= fetch --depth 999999 && git checkout '.plug#shellescape(sha).' --', a:spec.dir)
  971. endif
  972. return output
  973. endfunction
  974. function! s:finish(pull)
  975. let new_frozen = len(filter(keys(s:update.new), 'g:plugs[v:val].frozen'))
  976. if new_frozen
  977. let s = new_frozen > 1 ? 's' : ''
  978. call append(3, printf('- Installed %d frozen plugin%s', new_frozen, s))
  979. endif
  980. call append(3, '- Finishing ... ') | 4
  981. redraw
  982. call plug#helptags()
  983. call plug#end()
  984. call setline(4, getline(4) . 'Done!')
  985. redraw
  986. let msgs = []
  987. if !empty(s:update.errors)
  988. call add(msgs, "Press 'R' to retry.")
  989. endif
  990. if a:pull && len(s:update.new) < len(filter(getline(5, '$'),
  991. \ "v:val =~ '^- ' && v:val !~# 'Already up.to.date'"))
  992. call add(msgs, "Press 'D' to see the updated changes.")
  993. endif
  994. echo join(msgs, ' ')
  995. call s:finish_bindings()
  996. endfunction
  997. function! s:retry()
  998. if empty(s:update.errors)
  999. return
  1000. endif
  1001. echo
  1002. call s:update_impl(s:update.pull, s:update.force,
  1003. \ extend(copy(s:update.errors), [s:update.threads]))
  1004. endfunction
  1005. function! s:is_managed(name)
  1006. return has_key(g:plugs[a:name], 'uri')
  1007. endfunction
  1008. function! s:names(...)
  1009. return sort(filter(keys(g:plugs), 'stridx(v:val, a:1) == 0 && s:is_managed(v:val)'))
  1010. endfunction
  1011. function! s:check_ruby()
  1012. silent! ruby require 'thread'; VIM::command("let g:plug_ruby = '#{RUBY_VERSION}'")
  1013. if !exists('g:plug_ruby')
  1014. redraw!
  1015. return s:warn('echom', 'Warning: Ruby interface is broken')
  1016. endif
  1017. let ruby_version = split(g:plug_ruby, '\.')
  1018. unlet g:plug_ruby
  1019. return s:version_requirement(ruby_version, [1, 8, 7])
  1020. endfunction
  1021. function! s:update_impl(pull, force, args) abort
  1022. let sync = index(a:args, '--sync') >= 0 || has('vim_starting')
  1023. let args = filter(copy(a:args), 'v:val != "--sync"')
  1024. let threads = (len(args) > 0 && args[-1] =~ '^[1-9][0-9]*$') ?
  1025. \ remove(args, -1) : get(g:, 'plug_threads', 16)
  1026. let managed = filter(copy(g:plugs), 's:is_managed(v:key)')
  1027. let todo = empty(args) ? filter(managed, '!v:val.frozen || !isdirectory(v:val.dir)') :
  1028. \ filter(managed, 'index(args, v:key) >= 0')
  1029. if empty(todo)
  1030. return s:warn('echo', 'No plugin to '. (a:pull ? 'update' : 'install'))
  1031. endif
  1032. if !s:is_win && s:git_version_requirement(2, 3)
  1033. let s:git_terminal_prompt = exists('$GIT_TERMINAL_PROMPT') ? $GIT_TERMINAL_PROMPT : ''
  1034. let $GIT_TERMINAL_PROMPT = 0
  1035. for plug in values(todo)
  1036. let plug.uri = substitute(plug.uri,
  1037. \ '^https://git::@github\.com', 'https://github.com', '')
  1038. endfor
  1039. endif
  1040. if !isdirectory(g:plug_home)
  1041. try
  1042. call mkdir(g:plug_home, 'p')
  1043. catch
  1044. return s:err(printf('Invalid plug directory: %s. '.
  1045. \ 'Try to call plug#begin with a valid directory', g:plug_home))
  1046. endtry
  1047. endif
  1048. if has('nvim') && !exists('*jobwait') && threads > 1
  1049. call s:warn('echom', '[vim-plug] Update Neovim for parallel installer')
  1050. endif
  1051. let use_job = s:nvim || s:vim8
  1052. let python = (has('python') || has('python3')) && !use_job
  1053. 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()
  1054. let s:update = {
  1055. \ 'start': reltime(),
  1056. \ 'all': todo,
  1057. \ 'todo': copy(todo),
  1058. \ 'errors': [],
  1059. \ 'pull': a:pull,
  1060. \ 'force': a:force,
  1061. \ 'new': {},
  1062. \ 'threads': (python || ruby || use_job) ? min([len(todo), threads]) : 1,
  1063. \ 'bar': '',
  1064. \ 'fin': 0
  1065. \ }
  1066. call s:prepare(1)
  1067. call append(0, ['', ''])
  1068. normal! 2G
  1069. silent! redraw
  1070. let s:clone_opt = []
  1071. if get(g:, 'plug_shallow', 1)
  1072. call extend(s:clone_opt, ['--depth', '1'])
  1073. if s:git_version_requirement(1, 7, 10)
  1074. call add(s:clone_opt, '--no-single-branch')
  1075. endif
  1076. endif
  1077. if has('win32unix') || has('wsl')
  1078. call extend(s:clone_opt, ['-c', 'core.eol=lf', '-c', 'core.autocrlf=input'])
  1079. endif
  1080. let s:submodule_opt = s:git_version_requirement(2, 8) ? ' --jobs='.threads : ''
  1081. " Python version requirement (>= 2.7)
  1082. if python && !has('python3') && !ruby && !use_job && s:update.threads > 1
  1083. redir => pyv
  1084. silent python import platform; print platform.python_version()
  1085. redir END
  1086. let python = s:version_requirement(
  1087. \ map(split(split(pyv)[0], '\.'), 'str2nr(v:val)'), [2, 6])
  1088. endif
  1089. if (python || ruby) && s:update.threads > 1
  1090. try
  1091. let imd = &imd
  1092. if s:mac_gui
  1093. set noimd
  1094. endif
  1095. if ruby
  1096. call s:update_ruby()
  1097. else
  1098. call s:update_python()
  1099. endif
  1100. catch
  1101. let lines = getline(4, '$')
  1102. let printed = {}
  1103. silent! 4,$d _
  1104. for line in lines
  1105. let name = s:extract_name(line, '.', '')
  1106. if empty(name) || !has_key(printed, name)
  1107. call append('$', line)
  1108. if !empty(name)
  1109. let printed[name] = 1
  1110. if line[0] == 'x' && index(s:update.errors, name) < 0
  1111. call add(s:update.errors, name)
  1112. end
  1113. endif
  1114. endif
  1115. endfor
  1116. finally
  1117. let &imd = imd
  1118. call s:update_finish()
  1119. endtry
  1120. else
  1121. call s:update_vim()
  1122. while use_job && sync
  1123. sleep 100m
  1124. if s:update.fin
  1125. break
  1126. endif
  1127. endwhile
  1128. endif
  1129. endfunction
  1130. function! s:log4(name, msg)
  1131. call setline(4, printf('- %s (%s)', a:msg, a:name))
  1132. redraw
  1133. endfunction
  1134. function! s:update_finish()
  1135. if exists('s:git_terminal_prompt')
  1136. let $GIT_TERMINAL_PROMPT = s:git_terminal_prompt
  1137. endif
  1138. if s:switch_in()
  1139. call append(3, '- Updating ...') | 4
  1140. 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))'))
  1141. let [pos, _] = s:logpos(name)
  1142. if !pos
  1143. continue
  1144. endif
  1145. if has_key(spec, 'commit')
  1146. call s:log4(name, 'Checking out '.spec.commit)
  1147. let out = s:checkout(spec)
  1148. elseif has_key(spec, 'tag')
  1149. let tag = spec.tag
  1150. if tag =~ '\*'
  1151. let tags = s:lines(s:system('git tag --list '.plug#shellescape(tag).' --sort -version:refname 2>&1', spec.dir))
  1152. if !v:shell_error && !empty(tags)
  1153. let tag = tags[0]
  1154. call s:log4(name, printf('Latest tag for %s -> %s', spec.tag, tag))
  1155. call append(3, '')
  1156. endif
  1157. endif
  1158. call s:log4(name, 'Checking out '.tag)
  1159. let out = s:system('git checkout -q '.plug#shellescape(tag).' -- 2>&1', spec.dir)
  1160. else
  1161. let branch = s:git_origin_branch(spec)
  1162. call s:log4(name, 'Merging origin/'.s:esc(branch))
  1163. let out = s:system('git checkout -q '.plug#shellescape(branch).' -- 2>&1'
  1164. \. (has_key(s:update.new, name) ? '' : ('&& git merge --ff-only '.plug#shellescape('origin/'.branch).' 2>&1')), spec.dir)
  1165. endif
  1166. if !v:shell_error && filereadable(spec.dir.'/.gitmodules') &&
  1167. \ (s:update.force || has_key(s:update.new, name) || s:is_updated(spec.dir))
  1168. call s:log4(name, 'Updating submodules. This may take a while.')
  1169. let out .= s:bang('git submodule update --init --recursive'.s:submodule_opt.' 2>&1', spec.dir)
  1170. endif
  1171. let msg = s:format_message(v:shell_error ? 'x': '-', name, out)
  1172. if v:shell_error
  1173. call add(s:update.errors, name)
  1174. call s:regress_bar()
  1175. silent execute pos 'd _'
  1176. call append(4, msg) | 4
  1177. elseif !empty(out)
  1178. call setline(pos, msg[0])
  1179. endif
  1180. redraw
  1181. endfor
  1182. silent 4 d _
  1183. try
  1184. 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")'))
  1185. catch
  1186. call s:warn('echom', v:exception)
  1187. call s:warn('echo', '')
  1188. return
  1189. endtry
  1190. call s:finish(s:update.pull)
  1191. call setline(1, 'Updated. Elapsed time: ' . split(reltimestr(reltime(s:update.start)))[0] . ' sec.')
  1192. call s:switch_out('normal! gg')
  1193. endif
  1194. endfunction
  1195. function! s:job_abort()
  1196. if (!s:nvim && !s:vim8) || !exists('s:jobs')
  1197. return
  1198. endif
  1199. for [name, j] in items(s:jobs)
  1200. if s:nvim
  1201. silent! call jobstop(j.jobid)
  1202. elseif s:vim8
  1203. silent! call job_stop(j.jobid)
  1204. endif
  1205. if j.new
  1206. call s:rm_rf(g:plugs[name].dir)
  1207. endif
  1208. endfor
  1209. let s:jobs = {}
  1210. endfunction
  1211. function! s:last_non_empty_line(lines)
  1212. let len = len(a:lines)
  1213. for idx in range(len)
  1214. let line = a:lines[len-idx-1]
  1215. if !empty(line)
  1216. return line
  1217. endif
  1218. endfor
  1219. return ''
  1220. endfunction
  1221. function! s:job_out_cb(self, data) abort
  1222. let self = a:self
  1223. let data = remove(self.lines, -1) . a:data
  1224. let lines = map(split(data, "\n", 1), 'split(v:val, "\r", 1)[-1]')
  1225. call extend(self.lines, lines)
  1226. " To reduce the number of buffer updates
  1227. let self.tick = get(self, 'tick', -1) + 1
  1228. if !self.running || self.tick % len(s:jobs) == 0
  1229. let bullet = self.running ? (self.new ? '+' : '*') : (self.error ? 'x' : '-')
  1230. let result = self.error ? join(self.lines, "\n") : s:last_non_empty_line(self.lines)
  1231. call s:log(bullet, self.name, result)
  1232. endif
  1233. endfunction
  1234. function! s:job_exit_cb(self, data) abort
  1235. let a:self.running = 0
  1236. let a:self.error = a:data != 0
  1237. call s:reap(a:self.name)
  1238. call s:tick()
  1239. endfunction
  1240. function! s:job_cb(fn, job, ch, data)
  1241. if !s:plug_window_exists() " plug window closed
  1242. return s:job_abort()
  1243. endif
  1244. call call(a:fn, [a:job, a:data])
  1245. endfunction
  1246. function! s:nvim_cb(job_id, data, event) dict abort
  1247. return (a:event == 'stdout' || a:event == 'stderr') ?
  1248. \ s:job_cb('s:job_out_cb', self, 0, join(a:data, "\n")) :
  1249. \ s:job_cb('s:job_exit_cb', self, 0, a:data)
  1250. endfunction
  1251. function! s:spawn(name, cmd, opts)
  1252. let job = { 'name': a:name, 'running': 1, 'error': 0, 'lines': [''],
  1253. \ 'new': get(a:opts, 'new', 0) }
  1254. let s:jobs[a:name] = job
  1255. if s:nvim
  1256. if has_key(a:opts, 'dir')
  1257. let job.cwd = a:opts.dir
  1258. endif
  1259. let argv = a:cmd
  1260. call extend(job, {
  1261. \ 'on_stdout': function('s:nvim_cb'),
  1262. \ 'on_stderr': function('s:nvim_cb'),
  1263. \ 'on_exit': function('s:nvim_cb'),
  1264. \ })
  1265. let jid = s:plug_call('jobstart', argv, job)
  1266. if jid > 0
  1267. let job.jobid = jid
  1268. else
  1269. let job.running = 0
  1270. let job.error = 1
  1271. let job.lines = [jid < 0 ? argv[0].' is not executable' :
  1272. \ 'Invalid arguments (or job table is full)']
  1273. endif
  1274. elseif s:vim8
  1275. let cmd = join(map(copy(a:cmd), 'plug#shellescape(v:val, {"script": 0})'))
  1276. if has_key(a:opts, 'dir')
  1277. let cmd = s:with_cd(cmd, a:opts.dir, 0)
  1278. endif
  1279. let argv = s:is_win ? ['cmd', '/s', '/c', '"'.cmd.'"'] : ['sh', '-c', cmd]
  1280. let jid = job_start(s:is_win ? join(argv, ' ') : argv, {
  1281. \ 'out_cb': function('s:job_cb', ['s:job_out_cb', job]),
  1282. \ 'err_cb': function('s:job_cb', ['s:job_out_cb', job]),
  1283. \ 'exit_cb': function('s:job_cb', ['s:job_exit_cb', job]),
  1284. \ 'err_mode': 'raw',
  1285. \ 'out_mode': 'raw'
  1286. \})
  1287. if job_status(jid) == 'run'
  1288. let job.jobid = jid
  1289. else
  1290. let job.running = 0
  1291. let job.error = 1
  1292. let job.lines = ['Failed to start job']
  1293. endif
  1294. else
  1295. let job.lines = s:lines(call('s:system', has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]))
  1296. let job.error = v:shell_error != 0
  1297. let job.running = 0
  1298. endif
  1299. endfunction
  1300. function! s:reap(name)
  1301. let job = s:jobs[a:name]
  1302. if job.error
  1303. call add(s:update.errors, a:name)
  1304. elseif get(job, 'new', 0)
  1305. let s:update.new[a:name] = 1
  1306. endif
  1307. let s:update.bar .= job.error ? 'x' : '='
  1308. let bullet = job.error ? 'x' : '-'
  1309. let result = job.error ? join(job.lines, "\n") : s:last_non_empty_line(job.lines)
  1310. call s:log(bullet, a:name, empty(result) ? 'OK' : result)
  1311. call s:bar()
  1312. call remove(s:jobs, a:name)
  1313. endfunction
  1314. function! s:bar()
  1315. if s:switch_in()
  1316. let total = len(s:update.all)
  1317. call setline(1, (s:update.pull ? 'Updating' : 'Installing').
  1318. \ ' plugins ('.len(s:update.bar).'/'.total.')')
  1319. call s:progress_bar(2, s:update.bar, total)
  1320. call s:switch_out()
  1321. endif
  1322. endfunction
  1323. function! s:logpos(name)
  1324. let max = line('$')
  1325. for i in range(4, max > 4 ? max : 4)
  1326. if getline(i) =~# '^[-+x*] '.a:name.':'
  1327. for j in range(i + 1, max > 5 ? max : 5)
  1328. if getline(j) !~ '^ '
  1329. return [i, j - 1]
  1330. endif
  1331. endfor
  1332. return [i, i]
  1333. endif
  1334. endfor
  1335. return [0, 0]
  1336. endfunction
  1337. function! s:log(bullet, name, lines)
  1338. if s:switch_in()
  1339. let [b, e] = s:logpos(a:name)
  1340. if b > 0
  1341. silent execute printf('%d,%d d _', b, e)
  1342. if b > winheight('.')
  1343. let b = 4
  1344. endif
  1345. else
  1346. let b = 4
  1347. endif
  1348. " FIXME For some reason, nomodifiable is set after :d in vim8
  1349. setlocal modifiable
  1350. call append(b - 1, s:format_message(a:bullet, a:name, a:lines))
  1351. call s:switch_out()
  1352. endif
  1353. endfunction
  1354. function! s:update_vim()
  1355. let s:jobs = {}
  1356. call s:bar()
  1357. call s:tick()
  1358. endfunction
  1359. function! s:tick()
  1360. let pull = s:update.pull
  1361. let prog = s:progress_opt(s:nvim || s:vim8)
  1362. while 1 " Without TCO, Vim stack is bound to explode
  1363. if empty(s:update.todo)
  1364. if empty(s:jobs) && !s:update.fin
  1365. call s:update_finish()
  1366. let s:update.fin = 1
  1367. endif
  1368. return
  1369. endif
  1370. let name = keys(s:update.todo)[0]
  1371. let spec = remove(s:update.todo, name)
  1372. let new = empty(globpath(spec.dir, '.git', 1))
  1373. call s:log(new ? '+' : '*', name, pull ? 'Updating ...' : 'Installing ...')
  1374. redraw
  1375. let has_tag = has_key(spec, 'tag')
  1376. if !new
  1377. let [error, _] = s:git_validate(spec, 0)
  1378. if empty(error)
  1379. if pull
  1380. let cmd = ['git', 'fetch']
  1381. if has_tag && !empty(globpath(spec.dir, '.git/shallow'))
  1382. call extend(cmd, ['--depth', '99999999'])
  1383. endif
  1384. if !empty(prog)
  1385. call add(cmd, prog)
  1386. endif
  1387. call s:spawn(name, cmd, { 'dir': spec.dir })
  1388. else
  1389. let s:jobs[name] = { 'running': 0, 'lines': ['Already installed'], 'error': 0 }
  1390. endif
  1391. else
  1392. let s:jobs[name] = { 'running': 0, 'lines': s:lines(error), 'error': 1 }
  1393. endif
  1394. else
  1395. let cmd = ['git', 'clone']
  1396. if !has_tag
  1397. call extend(cmd, s:clone_opt)
  1398. endif
  1399. if !empty(prog)
  1400. call add(cmd, prog)
  1401. endif
  1402. call s:spawn(name, extend(cmd, [spec.uri, s:trim(spec.dir)]), { 'new': 1 })
  1403. endif
  1404. if !s:jobs[name].running
  1405. call s:reap(name)
  1406. endif
  1407. if len(s:jobs) >= s:update.threads
  1408. break
  1409. endif
  1410. endwhile
  1411. endfunction
  1412. function! s:update_python()
  1413. let py_exe = has('python') ? 'python' : 'python3'
  1414. execute py_exe "<< EOF"
  1415. import datetime
  1416. import functools
  1417. import os
  1418. try:
  1419. import queue
  1420. except ImportError:
  1421. import Queue as queue
  1422. import random
  1423. import re
  1424. import shutil
  1425. import signal
  1426. import subprocess
  1427. import tempfile
  1428. import threading as thr
  1429. import time
  1430. import traceback
  1431. import vim
  1432. G_NVIM = vim.eval("has('nvim')") == '1'
  1433. G_PULL = vim.eval('s:update.pull') == '1'
  1434. G_RETRIES = int(vim.eval('get(g:, "plug_retries", 2)')) + 1
  1435. G_TIMEOUT = int(vim.eval('get(g:, "plug_timeout", 60)'))
  1436. G_CLONE_OPT = ' '.join(vim.eval('s:clone_opt'))
  1437. G_PROGRESS = vim.eval('s:progress_opt(1)')
  1438. G_LOG_PROB = 1.0 / int(vim.eval('s:update.threads'))
  1439. G_STOP = thr.Event()
  1440. G_IS_WIN = vim.eval('s:is_win') == '1'
  1441. class PlugError(Exception):
  1442. def __init__(self, msg):
  1443. self.msg = msg
  1444. class CmdTimedOut(PlugError):
  1445. pass
  1446. class CmdFailed(PlugError):
  1447. pass
  1448. class InvalidURI(PlugError):
  1449. pass
  1450. class Action(object):
  1451. INSTALL, UPDATE, ERROR, DONE = ['+', '*', 'x', '-']
  1452. class Buffer(object):
  1453. def __init__(self, lock, num_plugs, is_pull):
  1454. self.bar = ''
  1455. self.event = 'Updating' if is_pull else 'Installing'
  1456. self.lock = lock
  1457. self.maxy = int(vim.eval('winheight(".")'))
  1458. self.num_plugs = num_plugs
  1459. def __where(self, name):
  1460. """ Find first line with name in current buffer. Return line num. """
  1461. found, lnum = False, 0
  1462. matcher = re.compile('^[-+x*] {0}:'.format(name))
  1463. for line in vim.current.buffer:
  1464. if matcher.search(line) is not None:
  1465. found = True
  1466. break
  1467. lnum += 1
  1468. if not found:
  1469. lnum = -1
  1470. return lnum
  1471. def header(self):
  1472. curbuf = vim.current.buffer
  1473. curbuf[0] = self.event + ' plugins ({0}/{1})'.format(len(self.bar), self.num_plugs)
  1474. num_spaces = self.num_plugs - len(self.bar)
  1475. curbuf[1] = '[{0}{1}]'.format(self.bar, num_spaces * ' ')
  1476. with self.lock:
  1477. vim.command('normal! 2G')
  1478. vim.command('redraw')
  1479. def write(self, action, name, lines):
  1480. first, rest = lines[0], lines[1:]
  1481. msg = ['{0} {1}{2}{3}'.format(action, name, ': ' if first else '', first)]
  1482. msg.extend([' ' + line for line in rest])
  1483. try:
  1484. if action == Action.ERROR:
  1485. self.bar += 'x'
  1486. vim.command("call add(s:update.errors, '{0}')".format(name))
  1487. elif action == Action.DONE:
  1488. self.bar += '='
  1489. curbuf = vim.current.buffer
  1490. lnum = self.__where(name)
  1491. if lnum != -1: # Found matching line num
  1492. del curbuf[lnum]
  1493. if lnum > self.maxy and action in set([Action.INSTALL, Action.UPDATE]):
  1494. lnum = 3
  1495. else:
  1496. lnum = 3
  1497. curbuf.append(msg, lnum)
  1498. self.header()
  1499. except vim.error:
  1500. pass
  1501. class Command(object):
  1502. CD = 'cd /d' if G_IS_WIN else 'cd'
  1503. def __init__(self, cmd, cmd_dir=None, timeout=60, cb=None, clean=None):
  1504. self.cmd = cmd
  1505. if cmd_dir:
  1506. self.cmd = '{0} {1} && {2}'.format(Command.CD, cmd_dir, self.cmd)
  1507. self.timeout = timeout
  1508. self.callback = cb if cb else (lambda msg: None)
  1509. self.clean = clean if clean else (lambda: None)
  1510. self.proc = None
  1511. @property
  1512. def alive(self):
  1513. """ Returns true only if command still running. """
  1514. return self.proc and self.proc.poll() is None
  1515. def execute(self, ntries=3):
  1516. """ Execute the command with ntries if CmdTimedOut.
  1517. Returns the output of the command if no Exception.
  1518. """
  1519. attempt, finished, limit = 0, False, self.timeout
  1520. while not finished:
  1521. try:
  1522. attempt += 1
  1523. result = self.try_command()
  1524. finished = True
  1525. return result
  1526. except CmdTimedOut:
  1527. if attempt != ntries:
  1528. self.notify_retry()
  1529. self.timeout += limit
  1530. else:
  1531. raise
  1532. def notify_retry(self):
  1533. """ Retry required for command, notify user. """
  1534. for count in range(3, 0, -1):
  1535. if G_STOP.is_set():
  1536. raise KeyboardInterrupt
  1537. msg = 'Timeout. Will retry in {0} second{1} ...'.format(
  1538. count, 's' if count != 1 else '')
  1539. self.callback([msg])
  1540. time.sleep(1)
  1541. self.callback(['Retrying ...'])
  1542. def try_command(self):
  1543. """ Execute a cmd & poll for callback. Returns list of output.
  1544. Raises CmdFailed -> return code for Popen isn't 0
  1545. Raises CmdTimedOut -> command exceeded timeout without new output
  1546. """
  1547. first_line = True
  1548. try:
  1549. tfile = tempfile.NamedTemporaryFile(mode='w+b')
  1550. preexec_fn = not G_IS_WIN and os.setsid or None
  1551. self.proc = subprocess.Popen(self.cmd, stdout=tfile,
  1552. stderr=subprocess.STDOUT,
  1553. stdin=subprocess.PIPE, shell=True,
  1554. preexec_fn=preexec_fn)
  1555. thrd = thr.Thread(target=(lambda proc: proc.wait()), args=(self.proc,))
  1556. thrd.start()
  1557. thread_not_started = True
  1558. while thread_not_started:
  1559. try:
  1560. thrd.join(0.1)
  1561. thread_not_started = False
  1562. except RuntimeError:
  1563. pass
  1564. while self.alive:
  1565. if G_STOP.is_set():
  1566. raise KeyboardInterrupt
  1567. if first_line or random.random() < G_LOG_PROB:
  1568. first_line = False
  1569. line = '' if G_IS_WIN else nonblock_read(tfile.name)
  1570. if line:
  1571. self.callback([line])
  1572. time_diff = time.time() - os.path.getmtime(tfile.name)
  1573. if time_diff > self.timeout:
  1574. raise CmdTimedOut(['Timeout!'])
  1575. thrd.join(0.5)
  1576. tfile.seek(0)
  1577. result = [line.decode('utf-8', 'replace').rstrip() for line in tfile]
  1578. if self.proc.returncode != 0:
  1579. raise CmdFailed([''] + result)
  1580. return result
  1581. except:
  1582. self.terminate()
  1583. raise
  1584. def terminate(self):
  1585. """ Terminate process and cleanup. """
  1586. if self.alive:
  1587. if G_IS_WIN:
  1588. os.kill(self.proc.pid, signal.SIGINT)
  1589. else:
  1590. os.killpg(self.proc.pid, signal.SIGTERM)
  1591. self.clean()
  1592. class Plugin(object):
  1593. def __init__(self, name, args, buf_q, lock):
  1594. self.name = name
  1595. self.args = args
  1596. self.buf_q = buf_q
  1597. self.lock = lock
  1598. self.tag = args.get('tag', 0)
  1599. def manage(self):
  1600. try:
  1601. if os.path.exists(self.args['dir']):
  1602. self.update()
  1603. else:
  1604. self.install()
  1605. with self.lock:
  1606. thread_vim_command("let s:update.new['{0}'] = 1".format(self.name))
  1607. except PlugError as exc:
  1608. self.write(Action.ERROR, self.name, exc.msg)
  1609. except KeyboardInterrupt:
  1610. G_STOP.set()
  1611. self.write(Action.ERROR, self.name, ['Interrupted!'])
  1612. except:
  1613. # Any exception except those above print stack trace
  1614. msg = 'Trace:\n{0}'.format(traceback.format_exc().rstrip())
  1615. self.write(Action.ERROR, self.name, msg.split('\n'))
  1616. raise
  1617. def install(self):
  1618. target = self.args['dir']
  1619. if target[-1] == '\\':
  1620. target = target[0:-1]
  1621. def clean(target):
  1622. def _clean():
  1623. try:
  1624. shutil.rmtree(target)
  1625. except OSError:
  1626. pass
  1627. return _clean
  1628. self.write(Action.INSTALL, self.name, ['Installing ...'])
  1629. callback = functools.partial(self.write, Action.INSTALL, self.name)
  1630. cmd = 'git clone {0} {1} {2} {3} 2>&1'.format(
  1631. '' if self.tag else G_CLONE_OPT, G_PROGRESS, self.args['uri'],
  1632. esc(target))
  1633. com = Command(cmd, None, G_TIMEOUT, callback, clean(target))
  1634. result = com.execute(G_RETRIES)
  1635. self.write(Action.DONE, self.name, result[-1:])
  1636. def repo_uri(self):
  1637. cmd = 'git rev-parse --abbrev-ref HEAD 2>&1 && git config -f .git/config remote.origin.url'
  1638. command = Command(cmd, self.args['dir'], G_TIMEOUT,)
  1639. result = command.execute(G_RETRIES)
  1640. return result[-1]
  1641. def update(self):
  1642. actual_uri = self.repo_uri()
  1643. expect_uri = self.args['uri']
  1644. regex = re.compile(r'^(?:\w+://)?(?:[^@/]*@)?([^:/]*(?::[0-9]*)?)[:/](.*?)(?:\.git)?/?$')
  1645. ma = regex.match(actual_uri)
  1646. mb = regex.match(expect_uri)
  1647. if ma is None or mb is None or ma.groups() != mb.groups():
  1648. msg = ['',
  1649. 'Invalid URI: {0}'.format(actual_uri),
  1650. 'Expected {0}'.format(expect_uri),
  1651. 'PlugClean required.']
  1652. raise InvalidURI(msg)
  1653. if G_PULL:
  1654. self.write(Action.UPDATE, self.name, ['Updating ...'])
  1655. callback = functools.partial(self.write, Action.UPDATE, self.name)
  1656. fetch_opt = '--depth 99999999' if self.tag and os.path.isfile(os.path.join(self.args['dir'], '.git/shallow')) else ''
  1657. cmd = 'git -c credential.helper= fetch {0} {1} 2>&1'.format(fetch_opt, G_PROGRESS)
  1658. com = Command(cmd, self.args['dir'], G_TIMEOUT, callback)
  1659. result = com.execute(G_RETRIES)
  1660. self.write(Action.DONE, self.name, result[-1:])
  1661. else:
  1662. self.write(Action.DONE, self.name, ['Already installed'])
  1663. def write(self, action, name, msg):
  1664. self.buf_q.put((action, name, msg))
  1665. class PlugThread(thr.Thread):
  1666. def __init__(self, tname, args):
  1667. super(PlugThread, self).__init__()
  1668. self.tname = tname
  1669. self.args = args
  1670. def run(self):
  1671. thr.current_thread().name = self.tname
  1672. buf_q, work_q, lock = self.args
  1673. try:
  1674. while not G_STOP.is_set():
  1675. name, args = work_q.get_nowait()
  1676. plug = Plugin(name, args, buf_q, lock)
  1677. plug.manage()
  1678. work_q.task_done()
  1679. except queue.Empty:
  1680. pass
  1681. class RefreshThread(thr.Thread):
  1682. def __init__(self, lock):
  1683. super(RefreshThread, self).__init__()
  1684. self.lock = lock
  1685. self.running = True
  1686. def run(self):
  1687. while self.running:
  1688. with self.lock:
  1689. thread_vim_command('noautocmd normal! a')
  1690. time.sleep(0.33)
  1691. def stop(self):
  1692. self.running = False
  1693. if G_NVIM:
  1694. def thread_vim_command(cmd):
  1695. vim.session.threadsafe_call(lambda: vim.command(cmd))
  1696. else:
  1697. def thread_vim_command(cmd):
  1698. vim.command(cmd)
  1699. def esc(name):
  1700. return '"' + name.replace('"', '\"') + '"'
  1701. def nonblock_read(fname):
  1702. """ Read a file with nonblock flag. Return the last line. """
  1703. fread = os.open(fname, os.O_RDONLY | os.O_NONBLOCK)
  1704. buf = os.read(fread, 100000).decode('utf-8', 'replace')
  1705. os.close(fread)
  1706. line = buf.rstrip('\r\n')
  1707. left = max(line.rfind('\r'), line.rfind('\n'))
  1708. if left != -1:
  1709. left += 1
  1710. line = line[left:]
  1711. return line
  1712. def main():
  1713. thr.current_thread().name = 'main'
  1714. nthreads = int(vim.eval('s:update.threads'))
  1715. plugs = vim.eval('s:update.todo')
  1716. mac_gui = vim.eval('s:mac_gui') == '1'
  1717. lock = thr.Lock()
  1718. buf = Buffer(lock, len(plugs), G_PULL)
  1719. buf_q, work_q = queue.Queue(), queue.Queue()
  1720. for work in plugs.items():
  1721. work_q.put(work)
  1722. start_cnt = thr.active_count()
  1723. for num in range(nthreads):
  1724. tname = 'PlugT-{0:02}'.format(num)
  1725. thread = PlugThread(tname, (buf_q, work_q, lock))
  1726. thread.start()
  1727. if mac_gui:
  1728. rthread = RefreshThread(lock)
  1729. rthread.start()
  1730. while not buf_q.empty() or thr.active_count() != start_cnt:
  1731. try:
  1732. action, name, msg = buf_q.get(True, 0.25)
  1733. buf.write(action, name, ['OK'] if not msg else msg)
  1734. buf_q.task_done()
  1735. except queue.Empty:
  1736. pass
  1737. except KeyboardInterrupt:
  1738. G_STOP.set()
  1739. if mac_gui:
  1740. rthread.stop()
  1741. rthread.join()
  1742. main()
  1743. EOF
  1744. endfunction
  1745. function! s:update_ruby()
  1746. ruby << EOF
  1747. module PlugStream
  1748. SEP = ["\r", "\n", nil]
  1749. def get_line
  1750. buffer = ''
  1751. loop do
  1752. char = readchar rescue return
  1753. if SEP.include? char.chr
  1754. buffer << $/
  1755. break
  1756. else
  1757. buffer << char
  1758. end
  1759. end
  1760. buffer
  1761. end
  1762. end unless defined?(PlugStream)
  1763. def esc arg
  1764. %["#{arg.gsub('"', '\"')}"]
  1765. end
  1766. def killall pid
  1767. pids = [pid]
  1768. if /mswin|mingw|bccwin/ =~ RUBY_PLATFORM
  1769. pids.each { |pid| Process.kill 'INT', pid.to_i rescue nil }
  1770. else
  1771. unless `which pgrep 2> /dev/null`.empty?
  1772. children = pids
  1773. until children.empty?
  1774. children = children.map { |pid|
  1775. `pgrep -P #{pid}`.lines.map { |l| l.chomp }
  1776. }.flatten
  1777. pids += children
  1778. end
  1779. end
  1780. pids.each { |pid| Process.kill 'TERM', pid.to_i rescue nil }
  1781. end
  1782. end
  1783. def compare_git_uri a, b
  1784. regex = %r{^(?:\w+://)?(?:[^@/]*@)?([^:/]*(?::[0-9]*)?)[:/](.*?)(?:\.git)?/?$}
  1785. regex.match(a).to_a.drop(1) == regex.match(b).to_a.drop(1)
  1786. end
  1787. require 'thread'
  1788. require 'fileutils'
  1789. require 'timeout'
  1790. running = true
  1791. iswin = VIM::evaluate('s:is_win').to_i == 1
  1792. pull = VIM::evaluate('s:update.pull').to_i == 1
  1793. base = VIM::evaluate('g:plug_home')
  1794. all = VIM::evaluate('s:update.todo')
  1795. limit = VIM::evaluate('get(g:, "plug_timeout", 60)')
  1796. tries = VIM::evaluate('get(g:, "plug_retries", 2)') + 1
  1797. nthr = VIM::evaluate('s:update.threads').to_i
  1798. maxy = VIM::evaluate('winheight(".")').to_i
  1799. vim7 = VIM::evaluate('v:version').to_i <= 703 && RUBY_PLATFORM =~ /darwin/
  1800. cd = iswin ? 'cd /d' : 'cd'
  1801. tot = VIM::evaluate('len(s:update.todo)') || 0
  1802. bar = ''
  1803. skip = 'Already installed'
  1804. mtx = Mutex.new
  1805. take1 = proc { mtx.synchronize { running && all.shift } }
  1806. logh = proc {
  1807. cnt = bar.length
  1808. $curbuf[1] = "#{pull ? 'Updating' : 'Installing'} plugins (#{cnt}/#{tot})"
  1809. $curbuf[2] = '[' + bar.ljust(tot) + ']'
  1810. VIM::command('normal! 2G')
  1811. VIM::command('redraw')
  1812. }
  1813. where = proc { |name| (1..($curbuf.length)).find { |l| $curbuf[l] =~ /^[-+x*] #{name}:/ } }
  1814. log = proc { |name, result, type|
  1815. mtx.synchronize do
  1816. ing = ![true, false].include?(type)
  1817. bar += type ? '=' : 'x' unless ing
  1818. b = case type
  1819. when :install then '+' when :update then '*'
  1820. when true, nil then '-' else
  1821. VIM::command("call add(s:update.errors, '#{name}')")
  1822. 'x'
  1823. end
  1824. result =
  1825. if type || type.nil?
  1826. ["#{b} #{name}: #{result.lines.to_a.last || 'OK'}"]
  1827. elsif result =~ /^Interrupted|^Timeout/
  1828. ["#{b} #{name}: #{result}"]
  1829. else
  1830. ["#{b} #{name}"] + result.lines.map { |l| " " << l }
  1831. end
  1832. if lnum = where.call(name)
  1833. $curbuf.delete lnum
  1834. lnum = 4 if ing && lnum > maxy
  1835. end
  1836. result.each_with_index do |line, offset|
  1837. $curbuf.append((lnum || 4) - 1 + offset, line.gsub(/\e\[./, '').chomp)
  1838. end
  1839. logh.call
  1840. end
  1841. }
  1842. bt = proc { |cmd, name, type, cleanup|
  1843. tried = timeout = 0
  1844. begin
  1845. tried += 1
  1846. timeout += limit
  1847. fd = nil
  1848. data = ''
  1849. if iswin
  1850. Timeout::timeout(timeout) do
  1851. tmp = VIM::evaluate('tempname()')
  1852. system("(#{cmd}) > #{tmp}")
  1853. data = File.read(tmp).chomp
  1854. File.unlink tmp rescue nil
  1855. end
  1856. else
  1857. fd = IO.popen(cmd).extend(PlugStream)
  1858. first_line = true
  1859. log_prob = 1.0 / nthr
  1860. while line = Timeout::timeout(timeout) { fd.get_line }
  1861. data << line
  1862. log.call name, line.chomp, type if name && (first_line || rand < log_prob)
  1863. first_line = false
  1864. end
  1865. fd.close
  1866. end
  1867. [$? == 0, data.chomp]
  1868. rescue Timeout::Error, Interrupt => e
  1869. if fd && !fd.closed?
  1870. killall fd.pid
  1871. fd.close
  1872. end
  1873. cleanup.call if cleanup
  1874. if e.is_a?(Timeout::Error) && tried < tries
  1875. 3.downto(1) do |countdown|
  1876. s = countdown > 1 ? 's' : ''
  1877. log.call name, "Timeout. Will retry in #{countdown} second#{s} ...", type
  1878. sleep 1
  1879. end
  1880. log.call name, 'Retrying ...', type
  1881. retry
  1882. end
  1883. [false, e.is_a?(Interrupt) ? "Interrupted!" : "Timeout!"]
  1884. end
  1885. }
  1886. main = Thread.current
  1887. threads = []
  1888. watcher = Thread.new {
  1889. if vim7
  1890. while VIM::evaluate('getchar(1)')
  1891. sleep 0.1
  1892. end
  1893. else
  1894. require 'io/console' # >= Ruby 1.9
  1895. nil until IO.console.getch == 3.chr
  1896. end
  1897. mtx.synchronize do
  1898. running = false
  1899. threads.each { |t| t.raise Interrupt } unless vim7
  1900. end
  1901. threads.each { |t| t.join rescue nil }
  1902. main.kill
  1903. }
  1904. refresh = Thread.new {
  1905. while true
  1906. mtx.synchronize do
  1907. break unless running
  1908. VIM::command('noautocmd normal! a')
  1909. end
  1910. sleep 0.2
  1911. end
  1912. } if VIM::evaluate('s:mac_gui') == 1
  1913. clone_opt = VIM::evaluate('s:clone_opt').join(' ')
  1914. progress = VIM::evaluate('s:progress_opt(1)')
  1915. nthr.times do
  1916. mtx.synchronize do
  1917. threads << Thread.new {
  1918. while pair = take1.call
  1919. name = pair.first
  1920. dir, uri, tag = pair.last.values_at *%w[dir uri tag]
  1921. exists = File.directory? dir
  1922. ok, result =
  1923. if exists
  1924. chdir = "#{cd} #{iswin ? dir : esc(dir)}"
  1925. ret, data = bt.call "#{chdir} && git rev-parse --abbrev-ref HEAD 2>&1 && git config -f .git/config remote.origin.url", nil, nil, nil
  1926. current_uri = data.lines.to_a.last
  1927. if !ret
  1928. if data =~ /^Interrupted|^Timeout/
  1929. [false, data]
  1930. else
  1931. [false, [data.chomp, "PlugClean required."].join($/)]
  1932. end
  1933. elsif !compare_git_uri(current_uri, uri)
  1934. [false, ["Invalid URI: #{current_uri}",
  1935. "Expected: #{uri}",
  1936. "PlugClean required."].join($/)]
  1937. else
  1938. if pull
  1939. log.call name, 'Updating ...', :update
  1940. fetch_opt = (tag && File.exist?(File.join(dir, '.git/shallow'))) ? '--depth 99999999' : ''
  1941. bt.call "#{chdir} && git -c credential.helper= fetch #{fetch_opt} #{progress} 2>&1", name, :update, nil
  1942. else
  1943. [true, skip]
  1944. end
  1945. end
  1946. else
  1947. d = esc dir.sub(%r{[\\/]+$}, '')
  1948. log.call name, 'Installing ...', :install
  1949. bt.call "git clone #{clone_opt unless tag} #{progress} #{uri} #{d} 2>&1", name, :install, proc {
  1950. FileUtils.rm_rf dir
  1951. }
  1952. end
  1953. mtx.synchronize { VIM::command("let s:update.new['#{name}'] = 1") } if !exists && ok
  1954. log.call name, result, ok
  1955. end
  1956. } if running
  1957. end
  1958. end
  1959. threads.each { |t| t.join rescue nil }
  1960. logh.call
  1961. refresh.kill if refresh
  1962. watcher.kill
  1963. EOF
  1964. endfunction
  1965. function! s:shellesc_cmd(arg, script)
  1966. let escaped = substitute('"'.a:arg.'"', '[&|<>()@^!"]', '^&', 'g')
  1967. return substitute(escaped, '%', (a:script ? '%' : '^') . '&', 'g')
  1968. endfunction
  1969. function! s:shellesc_ps1(arg)
  1970. return "'".substitute(escape(a:arg, '\"'), "'", "''", 'g')."'"
  1971. endfunction
  1972. function! s:shellesc_sh(arg)
  1973. return "'".substitute(a:arg, "'", "'\\\\''", 'g')."'"
  1974. endfunction
  1975. " Escape the shell argument based on the shell.
  1976. " Vim and Neovim's shellescape() are insufficient.
  1977. " 1. shellslash determines whether to use single/double quotes.
  1978. " Double-quote escaping is fragile for cmd.exe.
  1979. " 2. It does not work for powershell.
  1980. " 3. It does not work for *sh shells if the command is executed
  1981. " via cmd.exe (ie. cmd.exe /c sh -c command command_args)
  1982. " 4. It does not support batchfile syntax.
  1983. "
  1984. " Accepts an optional dictionary with the following keys:
  1985. " - shell: same as Vim/Neovim 'shell' option.
  1986. " If unset, fallback to 'cmd.exe' on Windows or 'sh'.
  1987. " - script: If truthy and shell is cmd.exe, escape for batchfile syntax.
  1988. function! plug#shellescape(arg, ...)
  1989. if a:arg =~# '^[A-Za-z0-9_/:.-]\+$'
  1990. return a:arg
  1991. endif
  1992. let opts = a:0 > 0 && type(a:1) == s:TYPE.dict ? a:1 : {}
  1993. let shell = get(opts, 'shell', s:is_win ? 'cmd.exe' : 'sh')
  1994. let script = get(opts, 'script', 1)
  1995. if shell =~# 'cmd\(\.exe\)\?$'
  1996. return s:shellesc_cmd(a:arg, script)
  1997. elseif shell =~# 'powershell\(\.exe\)\?$' || shell =~# 'pwsh$'
  1998. return s:shellesc_ps1(a:arg)
  1999. endif
  2000. return s:shellesc_sh(a:arg)
  2001. endfunction
  2002. function! s:glob_dir(path)
  2003. return map(filter(s:glob(a:path, '**'), 'isdirectory(v:val)'), 's:dirpath(v:val)')
  2004. endfunction
  2005. function! s:progress_bar(line, bar, total)
  2006. call setline(a:line, '[' . s:lpad(a:bar, a:total) . ']')
  2007. endfunction
  2008. function! s:compare_git_uri(a, b)
  2009. " See `git help clone'
  2010. " https:// [user@] github.com[:port] / junegunn/vim-plug [.git]
  2011. " [git@] github.com[:port] : junegunn/vim-plug [.git]
  2012. " file:// / junegunn/vim-plug [/]
  2013. " / junegunn/vim-plug [/]
  2014. let pat = '^\%(\w\+://\)\='.'\%([^@/]*@\)\='.'\([^:/]*\%(:[0-9]*\)\=\)'.'[:/]'.'\(.\{-}\)'.'\%(\.git\)\=/\?$'
  2015. let ma = matchlist(a:a, pat)
  2016. let mb = matchlist(a:b, pat)
  2017. return ma[1:2] ==# mb[1:2]
  2018. endfunction
  2019. function! s:format_message(bullet, name, message)
  2020. if a:bullet != 'x'
  2021. return [printf('%s %s: %s', a:bullet, a:name, s:lastline(a:message))]
  2022. else
  2023. let lines = map(s:lines(a:message), '" ".v:val')
  2024. return extend([printf('x %s:', a:name)], lines)
  2025. endif
  2026. endfunction
  2027. function! s:with_cd(cmd, dir, ...)
  2028. let script = a:0 > 0 ? a:1 : 1
  2029. return printf('cd%s %s && %s', s:is_win ? ' /d' : '', plug#shellescape(a:dir, {'script': script}), a:cmd)
  2030. endfunction
  2031. function! s:system(cmd, ...)
  2032. let batchfile = ''
  2033. try
  2034. let [sh, shellcmdflag, shrd] = s:chsh(1)
  2035. if type(a:cmd) == s:TYPE.list
  2036. " Neovim's system() supports list argument to bypass the shell
  2037. " but it cannot set the working directory for the command.
  2038. " Assume that the command does not rely on the shell.
  2039. if has('nvim') && a:0 == 0
  2040. return system(a:cmd)
  2041. endif
  2042. let cmd = join(map(copy(a:cmd), 'plug#shellescape(v:val, {"shell": &shell, "script": 0})'))
  2043. if &shell =~# 'powershell\(\.exe\)\?$'
  2044. let cmd = '& ' . cmd
  2045. endif
  2046. else
  2047. let cmd = a:cmd
  2048. endif
  2049. if a:0 > 0
  2050. let cmd = s:with_cd(cmd, a:1, type(a:cmd) != s:TYPE.list)
  2051. endif
  2052. if s:is_win && type(a:cmd) != s:TYPE.list
  2053. let [batchfile, cmd] = s:batchfile(cmd)
  2054. endif
  2055. return system(cmd)
  2056. finally
  2057. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  2058. if s:is_win && filereadable(batchfile)
  2059. call delete(batchfile)
  2060. endif
  2061. endtry
  2062. endfunction
  2063. function! s:system_chomp(...)
  2064. let ret = call('s:system', a:000)
  2065. return v:shell_error ? '' : substitute(ret, '\n$', '', '')
  2066. endfunction
  2067. function! s:git_validate(spec, check_branch)
  2068. let err = ''
  2069. if isdirectory(a:spec.dir)
  2070. let result = [s:git_local_branch(a:spec.dir), s:git_origin_url(a:spec.dir)]
  2071. let remote = result[-1]
  2072. if empty(remote)
  2073. let err = join([remote, 'PlugClean required.'], "\n")
  2074. elseif !s:compare_git_uri(remote, a:spec.uri)
  2075. let err = join(['Invalid URI: '.remote,
  2076. \ 'Expected: '.a:spec.uri,
  2077. \ 'PlugClean required.'], "\n")
  2078. elseif a:check_branch && has_key(a:spec, 'commit')
  2079. let sha = s:git_revision(a:spec.dir)
  2080. if empty(sha)
  2081. let err = join(add(result, 'PlugClean required.'), "\n")
  2082. elseif !s:hash_match(sha, a:spec.commit)
  2083. let err = join([printf('Invalid HEAD (expected: %s, actual: %s)',
  2084. \ a:spec.commit[:6], sha[:6]),
  2085. \ 'PlugUpdate required.'], "\n")
  2086. endif
  2087. elseif a:check_branch
  2088. let current_branch = result[0]
  2089. " Check tag
  2090. let origin_branch = s:git_origin_branch(a:spec)
  2091. if has_key(a:spec, 'tag')
  2092. let tag = s:system_chomp('git describe --exact-match --tags HEAD 2>&1', a:spec.dir)
  2093. if a:spec.tag !=# tag && a:spec.tag !~ '\*'
  2094. let err = printf('Invalid tag: %s (expected: %s). Try PlugUpdate.',
  2095. \ (empty(tag) ? 'N/A' : tag), a:spec.tag)
  2096. endif
  2097. " Check branch
  2098. elseif origin_branch !=# current_branch
  2099. let err = printf('Invalid branch: %s (expected: %s). Try PlugUpdate.',
  2100. \ current_branch, origin_branch)
  2101. endif
  2102. if empty(err)
  2103. let [ahead, behind] = split(s:lastline(s:system([
  2104. \ 'git', 'rev-list', '--count', '--left-right',
  2105. \ printf('HEAD...origin/%s', origin_branch)
  2106. \ ], a:spec.dir)), '\t')
  2107. if !v:shell_error && ahead
  2108. if behind
  2109. " Only mention PlugClean if diverged, otherwise it's likely to be
  2110. " pushable (and probably not that messed up).
  2111. let err = printf(
  2112. \ "Diverged from origin/%s (%d commit(s) ahead and %d commit(s) behind!\n"
  2113. \ .'Backup local changes and run PlugClean and PlugUpdate to reinstall it.', origin_branch, ahead, behind)
  2114. else
  2115. let err = printf("Ahead of origin/%s by %d commit(s).\n"
  2116. \ .'Cannot update until local changes are pushed.',
  2117. \ origin_branch, ahead)
  2118. endif
  2119. endif
  2120. endif
  2121. endif
  2122. else
  2123. let err = 'Not found'
  2124. endif
  2125. return [err, err =~# 'PlugClean']
  2126. endfunction
  2127. function! s:rm_rf(dir)
  2128. if isdirectory(a:dir)
  2129. return s:system(s:is_win
  2130. \ ? 'rmdir /S /Q '.plug#shellescape(a:dir)
  2131. \ : ['rm', '-rf', a:dir])
  2132. endif
  2133. endfunction
  2134. function! s:clean(force)
  2135. call s:prepare()
  2136. call append(0, 'Searching for invalid plugins in '.g:plug_home)
  2137. call append(1, '')
  2138. " List of valid directories
  2139. let dirs = []
  2140. let errs = {}
  2141. let [cnt, total] = [0, len(g:plugs)]
  2142. for [name, spec] in items(g:plugs)
  2143. if !s:is_managed(name)
  2144. call add(dirs, spec.dir)
  2145. else
  2146. let [err, clean] = s:git_validate(spec, 1)
  2147. if clean
  2148. let errs[spec.dir] = s:lines(err)[0]
  2149. else
  2150. call add(dirs, spec.dir)
  2151. endif
  2152. endif
  2153. let cnt += 1
  2154. call s:progress_bar(2, repeat('=', cnt), total)
  2155. normal! 2G
  2156. redraw
  2157. endfor
  2158. let allowed = {}
  2159. for dir in dirs
  2160. let allowed[s:dirpath(s:plug_fnamemodify(dir, ':h:h'))] = 1
  2161. let allowed[dir] = 1
  2162. for child in s:glob_dir(dir)
  2163. let allowed[child] = 1
  2164. endfor
  2165. endfor
  2166. let todo = []
  2167. let found = sort(s:glob_dir(g:plug_home))
  2168. while !empty(found)
  2169. let f = remove(found, 0)
  2170. if !has_key(allowed, f) && isdirectory(f)
  2171. call add(todo, f)
  2172. call append(line('$'), '- ' . f)
  2173. if has_key(errs, f)
  2174. call append(line('$'), ' ' . errs[f])
  2175. endif
  2176. let found = filter(found, 'stridx(v:val, f) != 0')
  2177. end
  2178. endwhile
  2179. 4
  2180. redraw
  2181. if empty(todo)
  2182. call append(line('$'), 'Already clean.')
  2183. else
  2184. let s:clean_count = 0
  2185. call append(3, ['Directories to delete:', ''])
  2186. redraw!
  2187. if a:force || s:ask_no_interrupt('Delete all directories?')
  2188. call s:delete([6, line('$')], 1)
  2189. else
  2190. call setline(4, 'Cancelled.')
  2191. nnoremap <silent> <buffer> d :set opfunc=<sid>delete_op<cr>g@
  2192. nmap <silent> <buffer> dd d_
  2193. xnoremap <silent> <buffer> d :<c-u>call <sid>delete_op(visualmode(), 1)<cr>
  2194. echo 'Delete the lines (d{motion}) to delete the corresponding directories'
  2195. endif
  2196. endif
  2197. 4
  2198. setlocal nomodifiable
  2199. endfunction
  2200. function! s:delete_op(type, ...)
  2201. call s:delete(a:0 ? [line("'<"), line("'>")] : [line("'["), line("']")], 0)
  2202. endfunction
  2203. function! s:delete(range, force)
  2204. let [l1, l2] = a:range
  2205. let force = a:force
  2206. let err_count = 0
  2207. while l1 <= l2
  2208. let line = getline(l1)
  2209. if line =~ '^- ' && isdirectory(line[2:])
  2210. execute l1
  2211. redraw!
  2212. let answer = force ? 1 : s:ask('Delete '.line[2:].'?', 1)
  2213. let force = force || answer > 1
  2214. if answer
  2215. let err = s:rm_rf(line[2:])
  2216. setlocal modifiable
  2217. if empty(err)
  2218. call setline(l1, '~'.line[1:])
  2219. let s:clean_count += 1
  2220. else
  2221. delete _
  2222. call append(l1 - 1, s:format_message('x', line[1:], err))
  2223. let l2 += len(s:lines(err))
  2224. let err_count += 1
  2225. endif
  2226. let msg = printf('Removed %d directories.', s:clean_count)
  2227. if err_count > 0
  2228. let msg .= printf(' Failed to remove %d directories.', err_count)
  2229. endif
  2230. call setline(4, msg)
  2231. setlocal nomodifiable
  2232. endif
  2233. endif
  2234. let l1 += 1
  2235. endwhile
  2236. endfunction
  2237. function! s:upgrade()
  2238. echo 'Downloading the latest version of vim-plug'
  2239. redraw
  2240. let tmp = s:plug_tempname()
  2241. let new = tmp . '/plug.vim'
  2242. try
  2243. let out = s:system(['git', 'clone', '--depth', '1', s:plug_src, tmp])
  2244. if v:shell_error
  2245. return s:err('Error upgrading vim-plug: '. out)
  2246. endif
  2247. if readfile(s:me) ==# readfile(new)
  2248. echo 'vim-plug is already up-to-date'
  2249. return 0
  2250. else
  2251. call rename(s:me, s:me . '.old')
  2252. call rename(new, s:me)
  2253. unlet g:loaded_plug
  2254. echo 'vim-plug has been upgraded'
  2255. return 1
  2256. endif
  2257. finally
  2258. silent! call s:rm_rf(tmp)
  2259. endtry
  2260. endfunction
  2261. function! s:upgrade_specs()
  2262. for spec in values(g:plugs)
  2263. let spec.frozen = get(spec, 'frozen', 0)
  2264. endfor
  2265. endfunction
  2266. function! s:status()
  2267. call s:prepare()
  2268. call append(0, 'Checking plugins')
  2269. call append(1, '')
  2270. let ecnt = 0
  2271. let unloaded = 0
  2272. let [cnt, total] = [0, len(g:plugs)]
  2273. for [name, spec] in items(g:plugs)
  2274. let is_dir = isdirectory(spec.dir)
  2275. if has_key(spec, 'uri')
  2276. if is_dir
  2277. let [err, _] = s:git_validate(spec, 1)
  2278. let [valid, msg] = [empty(err), empty(err) ? 'OK' : err]
  2279. else
  2280. let [valid, msg] = [0, 'Not found. Try PlugInstall.']
  2281. endif
  2282. else
  2283. if is_dir
  2284. let [valid, msg] = [1, 'OK']
  2285. else
  2286. let [valid, msg] = [0, 'Not found.']
  2287. endif
  2288. endif
  2289. let cnt += 1
  2290. let ecnt += !valid
  2291. " `s:loaded` entry can be missing if PlugUpgraded
  2292. if is_dir && get(s:loaded, name, -1) == 0
  2293. let unloaded = 1
  2294. let msg .= ' (not loaded)'
  2295. endif
  2296. call s:progress_bar(2, repeat('=', cnt), total)
  2297. call append(3, s:format_message(valid ? '-' : 'x', name, msg))
  2298. normal! 2G
  2299. redraw
  2300. endfor
  2301. call setline(1, 'Finished. '.ecnt.' error(s).')
  2302. normal! gg
  2303. setlocal nomodifiable
  2304. if unloaded
  2305. echo "Press 'L' on each line to load plugin, or 'U' to update"
  2306. nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  2307. xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  2308. end
  2309. endfunction
  2310. function! s:extract_name(str, prefix, suffix)
  2311. return matchstr(a:str, '^'.a:prefix.' \zs[^:]\+\ze:.*'.a:suffix.'$')
  2312. endfunction
  2313. function! s:status_load(lnum)
  2314. let line = getline(a:lnum)
  2315. let name = s:extract_name(line, '-', '(not loaded)')
  2316. if !empty(name)
  2317. call plug#load(name)
  2318. setlocal modifiable
  2319. call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
  2320. setlocal nomodifiable
  2321. endif
  2322. endfunction
  2323. function! s:status_update() range
  2324. let lines = getline(a:firstline, a:lastline)
  2325. let names = filter(map(lines, 's:extract_name(v:val, "[x-]", "")'), '!empty(v:val)')
  2326. if !empty(names)
  2327. echo
  2328. execute 'PlugUpdate' join(names)
  2329. endif
  2330. endfunction
  2331. function! s:is_preview_window_open()
  2332. silent! wincmd P
  2333. if &previewwindow
  2334. wincmd p
  2335. return 1
  2336. endif
  2337. endfunction
  2338. function! s:find_name(lnum)
  2339. for lnum in reverse(range(1, a:lnum))
  2340. let line = getline(lnum)
  2341. if empty(line)
  2342. return ''
  2343. endif
  2344. let name = s:extract_name(line, '-', '')
  2345. if !empty(name)
  2346. return name
  2347. endif
  2348. endfor
  2349. return ''
  2350. endfunction
  2351. function! s:preview_commit()
  2352. if b:plug_preview < 0
  2353. let b:plug_preview = !s:is_preview_window_open()
  2354. endif
  2355. let sha = matchstr(getline('.'), '^ \X*\zs[0-9a-f]\{7,9}')
  2356. if empty(sha)
  2357. return
  2358. endif
  2359. let name = s:find_name(line('.'))
  2360. if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
  2361. return
  2362. endif
  2363. if exists('g:plug_pwindow') && !s:is_preview_window_open()
  2364. execute g:plug_pwindow
  2365. execute 'e' sha
  2366. else
  2367. execute 'pedit' sha
  2368. wincmd P
  2369. endif
  2370. setlocal previewwindow filetype=git buftype=nofile nobuflisted modifiable
  2371. let batchfile = ''
  2372. try
  2373. let [sh, shellcmdflag, shrd] = s:chsh(1)
  2374. let cmd = 'cd '.plug#shellescape(g:plugs[name].dir).' && git show --no-color --pretty=medium '.sha
  2375. if s:is_win
  2376. let [batchfile, cmd] = s:batchfile(cmd)
  2377. endif
  2378. execute 'silent %!' cmd
  2379. finally
  2380. let [&shell, &shellcmdflag, &shellredir] = [sh, shellcmdflag, shrd]
  2381. if s:is_win && filereadable(batchfile)
  2382. call delete(batchfile)
  2383. endif
  2384. endtry
  2385. setlocal nomodifiable
  2386. nnoremap <silent> <buffer> q :q<cr>
  2387. wincmd p
  2388. endfunction
  2389. function! s:section(flags)
  2390. call search('\(^[x-] \)\@<=[^:]\+:', a:flags)
  2391. endfunction
  2392. function! s:format_git_log(line)
  2393. let indent = ' '
  2394. let tokens = split(a:line, nr2char(1))
  2395. if len(tokens) != 5
  2396. return indent.substitute(a:line, '\s*$', '', '')
  2397. endif
  2398. let [graph, sha, refs, subject, date] = tokens
  2399. let tag = matchstr(refs, 'tag: [^,)]\+')
  2400. let tag = empty(tag) ? ' ' : ' ('.tag.') '
  2401. return printf('%s%s%s%s%s (%s)', indent, graph, sha, tag, subject, date)
  2402. endfunction
  2403. function! s:append_ul(lnum, text)
  2404. call append(a:lnum, ['', a:text, repeat('-', len(a:text))])
  2405. endfunction
  2406. function! s:diff()
  2407. call s:prepare()
  2408. call append(0, ['Collecting changes ...', ''])
  2409. let cnts = [0, 0]
  2410. let bar = ''
  2411. let total = filter(copy(g:plugs), 's:is_managed(v:key) && isdirectory(v:val.dir)')
  2412. call s:progress_bar(2, bar, len(total))
  2413. for origin in [1, 0]
  2414. let plugs = reverse(sort(items(filter(copy(total), (origin ? '' : '!').'(has_key(v:val, "commit") || has_key(v:val, "tag"))'))))
  2415. if empty(plugs)
  2416. continue
  2417. endif
  2418. call s:append_ul(2, origin ? 'Pending updates:' : 'Last update:')
  2419. for [k, v] in plugs
  2420. let branch = s:git_origin_branch(v)
  2421. if len(branch)
  2422. let range = origin ? '..origin/'.branch : 'HEAD@{1}..'
  2423. let cmd = ['git', 'log', '--graph', '--color=never']
  2424. if s:git_version_requirement(2, 10, 0)
  2425. call add(cmd, '--no-show-signature')
  2426. endif
  2427. call extend(cmd, ['--pretty=format:%x01%h%x01%d%x01%s%x01%cr', range])
  2428. if has_key(v, 'rtp')
  2429. call extend(cmd, ['--', v.rtp])
  2430. endif
  2431. let diff = s:system_chomp(cmd, v.dir)
  2432. if !empty(diff)
  2433. let ref = has_key(v, 'tag') ? (' (tag: '.v.tag.')') : has_key(v, 'commit') ? (' '.v.commit) : ''
  2434. call append(5, extend(['', '- '.k.':'.ref], map(s:lines(diff), 's:format_git_log(v:val)')))
  2435. let cnts[origin] += 1
  2436. endif
  2437. endif
  2438. let bar .= '='
  2439. call s:progress_bar(2, bar, len(total))
  2440. normal! 2G
  2441. redraw
  2442. endfor
  2443. if !cnts[origin]
  2444. call append(5, ['', 'N/A'])
  2445. endif
  2446. endfor
  2447. call setline(1, printf('%d plugin(s) updated.', cnts[0])
  2448. \ . (cnts[1] ? printf(' %d plugin(s) have pending updates.', cnts[1]) : ''))
  2449. if cnts[0] || cnts[1]
  2450. nnoremap <silent> <buffer> <plug>(plug-preview) :silent! call <SID>preview_commit()<cr>
  2451. if empty(maparg("\<cr>", 'n'))
  2452. nmap <buffer> <cr> <plug>(plug-preview)
  2453. endif
  2454. if empty(maparg('o', 'n'))
  2455. nmap <buffer> o <plug>(plug-preview)
  2456. endif
  2457. endif
  2458. if cnts[0]
  2459. nnoremap <silent> <buffer> X :call <SID>revert()<cr>
  2460. echo "Press 'X' on each block to revert the update"
  2461. endif
  2462. normal! gg
  2463. setlocal nomodifiable
  2464. endfunction
  2465. function! s:revert()
  2466. if search('^Pending updates', 'bnW')
  2467. return
  2468. endif
  2469. let name = s:find_name(line('.'))
  2470. if empty(name) || !has_key(g:plugs, name) ||
  2471. \ input(printf('Revert the update of %s? (y/N) ', name)) !~? '^y'
  2472. return
  2473. endif
  2474. call s:system('git reset --hard HEAD@{1} && git checkout '.plug#shellescape(g:plugs[name].branch).' --', g:plugs[name].dir)
  2475. setlocal modifiable
  2476. normal! "_dap
  2477. setlocal nomodifiable
  2478. echo 'Reverted'
  2479. endfunction
  2480. function! s:snapshot(force, ...) abort
  2481. call s:prepare()
  2482. setf vim
  2483. call append(0, ['" Generated by vim-plug',
  2484. \ '" '.strftime("%c"),
  2485. \ '" :source this file in vim to restore the snapshot',
  2486. \ '" or execute: vim -S snapshot.vim',
  2487. \ '', '', 'PlugUpdate!'])
  2488. 1
  2489. let anchor = line('$') - 3
  2490. let names = sort(keys(filter(copy(g:plugs),
  2491. \'has_key(v:val, "uri") && !has_key(v:val, "commit") && isdirectory(v:val.dir)')))
  2492. for name in reverse(names)
  2493. let sha = s:git_revision(g:plugs[name].dir)
  2494. if !empty(sha)
  2495. call append(anchor, printf("silent! let g:plugs['%s'].commit = '%s'", name, sha))
  2496. redraw
  2497. endif
  2498. endfor
  2499. if a:0 > 0
  2500. let fn = s:plug_expand(a:1)
  2501. if filereadable(fn) && !(a:force || s:ask(a:1.' already exists. Overwrite?'))
  2502. return
  2503. endif
  2504. call writefile(getline(1, '$'), fn)
  2505. echo 'Saved as '.a:1
  2506. silent execute 'e' s:esc(fn)
  2507. setf vim
  2508. endif
  2509. endfunction
  2510. function! s:split_rtp()
  2511. return split(&rtp, '\\\@<!,')
  2512. endfunction
  2513. let s:first_rtp = s:escrtp(get(s:split_rtp(), 0, ''))
  2514. let s:last_rtp = s:escrtp(get(s:split_rtp(), -1, ''))
  2515. if exists('g:plugs')
  2516. let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
  2517. call s:upgrade_specs()
  2518. call s:define_commands()
  2519. endif
  2520. let &cpo = s:cpo_save
  2521. unlet s:cpo_save