plug.vim 82 KB

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