plug.vim 81 KB

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