plug.vim 83 KB

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