plug.vim 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076
  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. " Plug 'junegunn/seoul256.vim'
  15. " Plug 'junegunn/vim-easy-align'
  16. "
  17. " " Group dependencies, vim-snippets depends on ultisnips
  18. " Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
  19. "
  20. " " On-demand loading
  21. " Plug 'scrooloose/nerdtree', { 'on': 'NERDTreeToggle' }
  22. " Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
  23. "
  24. " " Using git URL
  25. " Plug 'https://github.com/junegunn/vim-github-dashboard.git'
  26. "
  27. " " Using a non-master branch
  28. " Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
  29. " " Plugin options
  30. " Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
  31. "
  32. " " Plugin outside ~/.vim/plugged with post-update hook
  33. " Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
  34. "
  35. " " Unmanaged plugin (manually installed and updated)
  36. " Plug '~/my-prototype-plugin'
  37. "
  38. " " Add plugins to &runtimepath
  39. " call plug#end()
  40. "
  41. " Then reload .vimrc and :PlugInstall to install plugins.
  42. " Visit https://github.com/junegunn/vim-plug for more information.
  43. "
  44. "
  45. " Copyright (c) 2015 Junegunn Choi
  46. "
  47. " MIT License
  48. "
  49. " Permission is hereby granted, free of charge, to any person obtaining
  50. " a copy of this software and associated documentation files (the
  51. " "Software"), to deal in the Software without restriction, including
  52. " without limitation the rights to use, copy, modify, merge, publish,
  53. " distribute, sublicense, and/or sell copies of the Software, and to
  54. " permit persons to whom the Software is furnished to do so, subject to
  55. " the following conditions:
  56. "
  57. " The above copyright notice and this permission notice shall be
  58. " included in all copies or substantial portions of the Software.
  59. "
  60. " THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  61. " EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  62. " MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  63. " NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  64. " LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  65. " OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  66. " WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  67. if exists('g:loaded_plug')
  68. finish
  69. endif
  70. let g:loaded_plug = 1
  71. let s:cpo_save = &cpo
  72. set cpo&vim
  73. let s:plug_src = 'https://github.com/junegunn/vim-plug.git'
  74. let s:plug_tab = get(s:, 'plug_tab', -1)
  75. let s:plug_buf = get(s:, 'plug_buf', -1)
  76. let s:mac_gui = has('gui_macvim') && has('gui_running')
  77. let s:is_win = has('win32') || has('win64')
  78. let s:nvim = has('nvim') && exists('*jobwait') && !s:is_win
  79. let s:me = resolve(expand('<sfile>:p'))
  80. let s:base_spec = { 'branch': 'master', 'frozen': 0 }
  81. let s:TYPE = {
  82. \ 'string': type(''),
  83. \ 'list': type([]),
  84. \ 'dict': type({}),
  85. \ 'funcref': type(function('call'))
  86. \ }
  87. let s:loaded = get(s:, 'loaded', {})
  88. let s:triggers = get(s:, 'triggers', {})
  89. function! plug#begin(...)
  90. if a:0 > 0
  91. let s:plug_home_org = a:1
  92. let home = s:path(fnamemodify(expand(a:1), ':p'))
  93. elseif exists('g:plug_home')
  94. let home = s:path(g:plug_home)
  95. elseif !empty(&rtp)
  96. let home = s:path(split(&rtp, ',')[0]) . '/plugged'
  97. else
  98. return s:err('Unable to determine plug home. Try calling plug#begin() with a path argument.')
  99. endif
  100. let g:plug_home = home
  101. let g:plugs = {}
  102. let g:plugs_order = []
  103. let s:triggers = {}
  104. call s:define_commands()
  105. return 1
  106. endfunction
  107. function! s:define_commands()
  108. command! -nargs=+ -bar Plug call s:add(<args>)
  109. if !executable('git')
  110. return s:err('`git` executable not found. vim-plug requires git.')
  111. endif
  112. command! -nargs=* -bar -bang -complete=customlist,s:names PlugInstall call s:install('<bang>' == '!', [<f-args>])
  113. command! -nargs=* -bar -bang -complete=customlist,s:names PlugUpdate call s:update('<bang>' == '!', [<f-args>])
  114. command! -nargs=0 -bar -bang PlugClean call s:clean('<bang>' == '!')
  115. command! -nargs=0 -bar PlugUpgrade if s:upgrade() | execute 'source' s:esc(s:me) | endif
  116. command! -nargs=0 -bar PlugStatus call s:status()
  117. command! -nargs=0 -bar PlugDiff call s:diff()
  118. command! -nargs=? -bar PlugSnapshot call s:snapshot(<f-args>)
  119. endfunction
  120. function! s:to_a(v)
  121. return type(a:v) == s:TYPE.list ? a:v : [a:v]
  122. endfunction
  123. function! s:to_s(v)
  124. return type(a:v) == s:TYPE.string ? a:v : join(a:v, "\n") . "\n"
  125. endfunction
  126. function! s:source(from, ...)
  127. for pattern in a:000
  128. for vim in s:lines(globpath(a:from, pattern))
  129. execute 'source' s:esc(vim)
  130. endfor
  131. endfor
  132. endfunction
  133. function! s:assoc(dict, key, val)
  134. let a:dict[a:key] = add(get(a:dict, a:key, []), a:val)
  135. endfunction
  136. function! plug#end()
  137. if !exists('g:plugs')
  138. return s:err('Call plug#begin() first')
  139. endif
  140. if exists('#PlugLOD')
  141. augroup PlugLOD
  142. autocmd!
  143. augroup END
  144. augroup! PlugLOD
  145. endif
  146. let lod = { 'ft': {}, 'map': {}, 'cmd': {} }
  147. filetype off
  148. for name in g:plugs_order
  149. let plug = g:plugs[name]
  150. if get(s:loaded, name, 0) || !has_key(plug, 'on') && !has_key(plug, 'for')
  151. let s:loaded[name] = 1
  152. continue
  153. endif
  154. if has_key(plug, 'on')
  155. let s:triggers[name] = { 'map': [], 'cmd': [] }
  156. for cmd in s:to_a(plug.on)
  157. if cmd =~? '^<Plug>.\+'
  158. if empty(mapcheck(cmd)) && empty(mapcheck(cmd, 'i'))
  159. call s:assoc(lod.map, cmd, name)
  160. endif
  161. call add(s:triggers[name].map, cmd)
  162. elseif cmd =~# '^[A-Z]'
  163. if exists(':'.cmd) != 2
  164. call s:assoc(lod.cmd, cmd, name)
  165. endif
  166. call add(s:triggers[name].cmd, cmd)
  167. else
  168. call s:err('Invalid `on` option: '.cmd.
  169. \ '. Should start with an uppercase letter or `<Plug>`.')
  170. endif
  171. endfor
  172. endif
  173. if has_key(plug, 'for')
  174. let types = s:to_a(plug.for)
  175. if !empty(types)
  176. call s:source(s:rtp(plug), 'ftdetect/**/*.vim', 'after/ftdetect/**/*.vim')
  177. endif
  178. for type in types
  179. call s:assoc(lod.ft, type, name)
  180. endfor
  181. endif
  182. endfor
  183. for [cmd, names] in items(lod.cmd)
  184. execute printf(
  185. \ 'command! -nargs=* -range -bang %s call s:lod_cmd(%s, "<bang>", <line1>, <line2>, <q-args>, %s)',
  186. \ cmd, string(cmd), string(names))
  187. endfor
  188. for [map, names] in items(lod.map)
  189. for [mode, map_prefix, key_prefix] in
  190. \ [['i', '<C-O>', ''], ['n', '', ''], ['v', '', 'gv'], ['o', '', '']]
  191. execute printf(
  192. \ '%snoremap <silent> %s %s:<C-U>call <SID>lod_map(%s, %s, "%s")<CR>',
  193. \ mode, map, map_prefix, string(map), string(names), key_prefix)
  194. endfor
  195. endfor
  196. for [ft, names] in items(lod.ft)
  197. augroup PlugLOD
  198. execute printf('autocmd FileType %s call <SID>lod_ft(%s, %s)',
  199. \ ft, string(ft), string(names))
  200. augroup END
  201. endfor
  202. call s:reorg_rtp()
  203. filetype plugin indent on
  204. if has('vim_starting')
  205. syntax enable
  206. else
  207. call s:reload()
  208. endif
  209. endfunction
  210. function! s:loaded_names()
  211. return filter(copy(g:plugs_order), 'get(s:loaded, v:val, 0)')
  212. endfunction
  213. function! s:reload()
  214. for name in s:loaded_names()
  215. call s:source(s:rtp(g:plugs[name]), 'plugin/**/*.vim', 'after/plugin/**/*.vim')
  216. endfor
  217. endfunction
  218. function! s:trim(str)
  219. return substitute(a:str, '[\/]\+$', '', '')
  220. endfunction
  221. function! s:version_requirement(val, min)
  222. for idx in range(0, len(a:min) - 1)
  223. let v = get(a:val, idx, 0)
  224. if v < a:min[idx] | return 0
  225. elseif v > a:min[idx] | return 1
  226. endif
  227. endfor
  228. return 1
  229. endfunction
  230. function! s:git_version_requirement(...)
  231. let s:git_version = get(s:, 'git_version',
  232. \ map(split(split(s:system('git --version'))[-1], '\.'), 'str2nr(v:val)'))
  233. return s:version_requirement(s:git_version, a:000)
  234. endfunction
  235. function! s:progress_opt(base)
  236. return a:base && !s:is_win &&
  237. \ s:git_version_requirement(1, 7, 1) ? '--progress' : ''
  238. endfunction
  239. if s:is_win
  240. function! s:rtp(spec)
  241. return s:path(a:spec.dir . get(a:spec, 'rtp', ''))
  242. endfunction
  243. function! s:path(path)
  244. return s:trim(substitute(a:path, '/', '\', 'g'))
  245. endfunction
  246. function! s:dirpath(path)
  247. return s:path(a:path) . '\'
  248. endfunction
  249. function! s:is_local_plug(repo)
  250. return a:repo =~? '^[a-z]:\|^[%~]'
  251. endfunction
  252. else
  253. function! s:rtp(spec)
  254. return s:dirpath(a:spec.dir . get(a:spec, 'rtp', ''))
  255. endfunction
  256. function! s:path(path)
  257. return s:trim(a:path)
  258. endfunction
  259. function! s:dirpath(path)
  260. return substitute(a:path, '[/\\]*$', '/', '')
  261. endfunction
  262. function! s:is_local_plug(repo)
  263. return a:repo[0] =~ '[/$~]'
  264. endfunction
  265. endif
  266. function! s:err(msg)
  267. echohl ErrorMsg
  268. echom '[vim-plug] '.a:msg
  269. echohl None
  270. return 0
  271. endfunction
  272. function! s:esc(path)
  273. return escape(a:path, ' ')
  274. endfunction
  275. function! s:escrtp(path)
  276. return escape(a:path, ' ,')
  277. endfunction
  278. function! s:remove_rtp()
  279. for name in s:loaded_names()
  280. let rtp = s:rtp(g:plugs[name])
  281. execute 'set rtp-='.s:escrtp(rtp)
  282. let after = globpath(rtp, 'after')
  283. if isdirectory(after)
  284. execute 'set rtp-='.s:escrtp(after)
  285. endif
  286. endfor
  287. endfunction
  288. function! s:reorg_rtp()
  289. if !empty(s:first_rtp)
  290. execute 'set rtp-='.s:first_rtp
  291. execute 'set rtp-='.s:last_rtp
  292. endif
  293. " &rtp is modified from outside
  294. if exists('s:prtp') && s:prtp !=# &rtp
  295. call s:remove_rtp()
  296. unlet! s:middle
  297. endif
  298. let s:middle = get(s:, 'middle', &rtp)
  299. let rtps = map(s:loaded_names(), 's:rtp(g:plugs[v:val])')
  300. let afters = filter(map(copy(rtps), 'globpath(v:val, "after")'), 'isdirectory(v:val)')
  301. let rtp = join(map(rtps, 'escape(v:val, ",")'), ',')
  302. \ . ','.s:middle.','
  303. \ . join(map(afters, 'escape(v:val, ",")'), ',')
  304. let &rtp = substitute(substitute(rtp, ',,*', ',', 'g'), '^,\|,$', '', 'g')
  305. let s:prtp = &rtp
  306. if !empty(s:first_rtp)
  307. execute 'set rtp^='.s:first_rtp
  308. execute 'set rtp+='.s:last_rtp
  309. endif
  310. endfunction
  311. function! plug#load(...)
  312. if a:0 == 0
  313. return s:err('Argument missing: plugin name(s) required')
  314. endif
  315. if !exists('g:plugs')
  316. return s:err('plug#begin was not called')
  317. endif
  318. let unknowns = filter(copy(a:000), '!has_key(g:plugs, v:val)')
  319. if !empty(unknowns)
  320. let s = len(unknowns) > 1 ? 's' : ''
  321. return s:err(printf('Unknown plugin%s: %s', s, join(unknowns, ', ')))
  322. end
  323. for name in a:000
  324. call s:lod([name], ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  325. endfor
  326. if exists('#BufRead')
  327. doautocmd BufRead
  328. endif
  329. return 1
  330. endfunction
  331. function! s:remove_triggers(name)
  332. if !has_key(s:triggers, a:name)
  333. return
  334. endif
  335. for cmd in s:triggers[a:name].cmd
  336. execute 'silent! delc' cmd
  337. endfor
  338. for map in s:triggers[a:name].map
  339. execute 'silent! unmap' map
  340. execute 'silent! iunmap' map
  341. endfor
  342. call remove(s:triggers, a:name)
  343. endfunction
  344. function! s:lod(names, types)
  345. for name in a:names
  346. call s:remove_triggers(name)
  347. let s:loaded[name] = 1
  348. endfor
  349. call s:reorg_rtp()
  350. for name in a:names
  351. let rtp = s:rtp(g:plugs[name])
  352. for dir in a:types
  353. call s:source(rtp, dir.'/**/*.vim')
  354. endfor
  355. if exists('#User#'.name)
  356. execute 'doautocmd User' name
  357. endif
  358. endfor
  359. endfunction
  360. function! s:lod_ft(pat, names)
  361. call s:lod(a:names, ['plugin', 'after/plugin', 'syntax', 'after/syntax'])
  362. execute 'autocmd! PlugLOD FileType' a:pat
  363. if exists('#filetypeplugin#FileType')
  364. doautocmd filetypeplugin FileType
  365. endif
  366. if exists('#filetypeindent#FileType')
  367. doautocmd filetypeindent FileType
  368. endif
  369. endfunction
  370. function! s:lod_cmd(cmd, bang, l1, l2, args, names)
  371. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  372. execute printf('%s%s%s %s', (a:l1 == a:l2 ? '' : (a:l1.','.a:l2)), a:cmd, a:bang, a:args)
  373. endfunction
  374. function! s:lod_map(map, names, prefix)
  375. call s:lod(a:names, ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
  376. let extra = ''
  377. while 1
  378. let c = getchar(0)
  379. if c == 0
  380. break
  381. endif
  382. let extra .= nr2char(c)
  383. endwhile
  384. call feedkeys(a:prefix . substitute(a:map, '^<Plug>', "\<Plug>", '') . extra)
  385. endfunction
  386. function! s:add(repo, ...)
  387. if a:0 > 1
  388. return s:err('Invalid number of arguments (1..2)')
  389. endif
  390. try
  391. let repo = s:trim(a:repo)
  392. let name = fnamemodify(repo, ':t:s?\.git$??')
  393. let spec = extend(s:infer_properties(name, repo),
  394. \ a:0 == 1 ? s:parse_options(a:1) : s:base_spec)
  395. if !has_key(g:plugs, name)
  396. call add(g:plugs_order, name)
  397. endif
  398. let g:plugs[name] = spec
  399. let s:loaded[name] = get(s:loaded, name, 0)
  400. catch
  401. return s:err(v:exception)
  402. endtry
  403. endfunction
  404. function! s:parse_options(arg)
  405. let opts = copy(s:base_spec)
  406. let type = type(a:arg)
  407. if type == s:TYPE.string
  408. let opts.tag = a:arg
  409. elseif type == s:TYPE.dict
  410. call extend(opts, a:arg)
  411. if has_key(opts, 'dir')
  412. let opts.dir = s:dirpath(expand(opts.dir))
  413. endif
  414. else
  415. throw 'Invalid argument type (expected: string or dictionary)'
  416. endif
  417. return opts
  418. endfunction
  419. function! s:infer_properties(name, repo)
  420. let repo = a:repo
  421. if s:is_local_plug(repo)
  422. return { 'dir': s:dirpath(expand(repo)) }
  423. else
  424. if repo =~ ':'
  425. let uri = repo
  426. else
  427. if repo !~ '/'
  428. let repo = 'vim-scripts/'. repo
  429. endif
  430. let fmt = get(g:, 'plug_url_format', 'https://git::@github.com/%s.git')
  431. let uri = printf(fmt, repo)
  432. endif
  433. let dir = s:dirpath( fnamemodify(join([g:plug_home, a:name], '/'), ':p') )
  434. return { 'dir': dir, 'uri': uri }
  435. endif
  436. endfunction
  437. function! s:install(force, names)
  438. call s:update_impl(0, a:force, a:names)
  439. endfunction
  440. function! s:update(force, names)
  441. call s:update_impl(1, a:force, a:names)
  442. endfunction
  443. function! plug#helptags()
  444. if !exists('g:plugs')
  445. return s:err('plug#begin was not called')
  446. endif
  447. for spec in values(g:plugs)
  448. let docd = join([spec.dir, 'doc'], '/')
  449. if isdirectory(docd)
  450. silent! execute 'helptags' s:esc(docd)
  451. endif
  452. endfor
  453. return 1
  454. endfunction
  455. function! s:syntax()
  456. syntax clear
  457. syntax region plug1 start=/\%1l/ end=/\%2l/ contains=plugNumber
  458. syntax region plug2 start=/\%2l/ end=/\%3l/ contains=plugBracket,plugX
  459. syn match plugNumber /[0-9]\+[0-9.]*/ contained
  460. syn match plugBracket /[[\]]/ contained
  461. syn match plugX /x/ contained
  462. syn match plugDash /^-/
  463. syn match plugPlus /^+/
  464. syn match plugStar /^*/
  465. syn match plugMessage /\(^- \)\@<=.*/
  466. syn match plugName /\(^- \)\@<=[^ ]*:/
  467. syn match plugInstall /\(^+ \)\@<=[^:]*/
  468. syn match plugUpdate /\(^* \)\@<=[^:]*/
  469. syn match plugCommit /^ [0-9a-z]\{7} .*/ contains=plugRelDate,plugSha
  470. syn match plugSha /\(^ \)\@<=[0-9a-z]\{7}/ contained
  471. syn match plugRelDate /([^)]*)$/ contained
  472. syn match plugNotLoaded /(not loaded)$/
  473. syn match plugError /^x.*/
  474. syn keyword Function PlugInstall PlugStatus PlugUpdate PlugClean
  475. hi def link plug1 Title
  476. hi def link plug2 Repeat
  477. hi def link plugX Exception
  478. hi def link plugBracket Structure
  479. hi def link plugNumber Number
  480. hi def link plugDash Special
  481. hi def link plugPlus Constant
  482. hi def link plugStar Boolean
  483. hi def link plugMessage Function
  484. hi def link plugName Label
  485. hi def link plugInstall Function
  486. hi def link plugUpdate Type
  487. hi def link plugError Error
  488. hi def link plugRelDate Comment
  489. hi def link plugSha Identifier
  490. hi def link plugNotLoaded Comment
  491. endfunction
  492. function! s:lpad(str, len)
  493. return a:str . repeat(' ', a:len - len(a:str))
  494. endfunction
  495. function! s:lines(msg)
  496. return split(a:msg, "[\r\n]")
  497. endfunction
  498. function! s:lastline(msg)
  499. return get(s:lines(a:msg), -1, '')
  500. endfunction
  501. function! s:new_window()
  502. execute get(g:, 'plug_window', 'vertical topleft new')
  503. endfunction
  504. function! s:plug_window_exists()
  505. let buflist = tabpagebuflist(s:plug_tab)
  506. return !empty(buflist) && index(buflist, s:plug_buf) >= 0
  507. endfunction
  508. function! s:switch_in()
  509. if !s:plug_window_exists()
  510. return 0
  511. endif
  512. if winbufnr(0) != s:plug_buf
  513. let s:pos = [tabpagenr(), winnr(), winsaveview()]
  514. execute 'normal!' s:plug_tab.'gt'
  515. let winnr = bufwinnr(s:plug_buf)
  516. execute winnr.'wincmd w'
  517. call add(s:pos, winsaveview())
  518. else
  519. let s:pos = [winsaveview()]
  520. endif
  521. setlocal modifiable
  522. return 1
  523. endfunction
  524. function! s:switch_out(...)
  525. call winrestview(s:pos[-1])
  526. setlocal nomodifiable
  527. if a:0 > 0
  528. execute a:1
  529. endif
  530. if len(s:pos) > 1
  531. execute 'normal!' s:pos[0].'gt'
  532. execute s:pos[1] 'wincmd w'
  533. call winrestview(s:pos[2])
  534. endif
  535. endfunction
  536. function! s:prepare()
  537. call s:job_abort()
  538. if s:switch_in()
  539. silent %d _
  540. else
  541. call s:new_window()
  542. nnoremap <silent> <buffer> q :if b:plug_preview==1<bar>pc<bar>endif<bar>bd<cr>
  543. nnoremap <silent> <buffer> R :silent! call <SID>retry()<cr>
  544. nnoremap <silent> <buffer> D :PlugDiff<cr>
  545. nnoremap <silent> <buffer> S :PlugStatus<cr>
  546. nnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  547. xnoremap <silent> <buffer> U :call <SID>status_update()<cr>
  548. nnoremap <silent> <buffer> ]] :silent! call <SID>section('')<cr>
  549. nnoremap <silent> <buffer> [[ :silent! call <SID>section('b')<cr>
  550. let b:plug_preview = -1
  551. let s:plug_tab = tabpagenr()
  552. let s:plug_buf = winbufnr(0)
  553. call s:assign_name()
  554. endif
  555. silent! unmap <buffer> <cr>
  556. silent! unmap <buffer> L
  557. silent! unmap <buffer> o
  558. silent! unmap <buffer> X
  559. setlocal buftype=nofile bufhidden=wipe nobuflisted noswapfile nowrap cursorline modifiable
  560. setf vim-plug
  561. call s:syntax()
  562. endfunction
  563. function! s:assign_name()
  564. " Assign buffer name
  565. let prefix = '[Plugins]'
  566. let name = prefix
  567. let idx = 2
  568. while bufexists(name)
  569. let name = printf('%s (%s)', prefix, idx)
  570. let idx = idx + 1
  571. endwhile
  572. silent! execute 'f' fnameescape(name)
  573. endfunction
  574. function! s:do(pull, force, todo)
  575. for [name, spec] in items(a:todo)
  576. if !isdirectory(spec.dir)
  577. continue
  578. endif
  579. let installed = has_key(s:update.new, name)
  580. let updated = installed ? 0 :
  581. \ (a:pull && index(s:update.errors, name) < 0 && !empty(s:system_chomp('git log --pretty=format:"%h" "HEAD...HEAD@{1}"', spec.dir)))
  582. if a:force || installed || updated
  583. execute 'cd' s:esc(spec.dir)
  584. call append(3, '- Post-update hook for '. name .' ... ')
  585. let error = ''
  586. let type = type(spec.do)
  587. if type == s:TYPE.string
  588. try
  589. " FIXME: Escaping is incomplete. We could use shellescape with eval,
  590. " but it won't work on Windows.
  591. let g:_plug_do = '!'.escape(spec.do, '#!%')
  592. execute "normal! :execute g:_plug_do\<cr>\<cr>"
  593. finally
  594. if v:shell_error
  595. let error = 'Exit status: ' . v:shell_error
  596. endif
  597. unlet g:_plug_do
  598. endtry
  599. elseif type == s:TYPE.funcref
  600. try
  601. let status = installed ? 'installed' : (updated ? 'updated' : 'unchanged')
  602. call spec.do({ 'name': name, 'status': status, 'force': a:force })
  603. catch
  604. let error = v:exception
  605. endtry
  606. else
  607. let error = 'Invalid hook type'
  608. endif
  609. call setline(4, empty(error) ? (getline(4) . 'OK')
  610. \ : ('x' . getline(4)[1:] . error))
  611. cd -
  612. endif
  613. endfor
  614. endfunction
  615. function! s:hash_match(a, b)
  616. return stridx(a:a, a:b) == 0 || stridx(a:b, a:a) == 0
  617. endfunction
  618. function! s:checkout(plugs)
  619. for [name, spec] in items(a:plugs)
  620. let sha = spec.commit
  621. call append(3, '- Checking out '.sha[:6].' of '.name.' ... ')
  622. redraw
  623. let error = []
  624. let output = s:lines(s:system('git rev-parse HEAD', spec.dir))
  625. if v:shell_error
  626. let error = output
  627. elseif !s:hash_match(sha, output[0])
  628. let output = s:lines(s:system(
  629. \ 'git fetch --depth 999999 && git checkout '.sha, spec.dir))
  630. if v:shell_error
  631. let error = output
  632. endif
  633. endif
  634. if empty(error)
  635. call setline(4, getline(4) . 'OK')
  636. else
  637. call setline(4, 'x'.getline(4)[1:] . 'Error')
  638. for line in reverse(error)
  639. call append(4, ' '.line)
  640. endfor
  641. endif
  642. endfor
  643. endfunction
  644. function! s:finish(pull)
  645. let new_frozen = len(filter(keys(s:update.new), 'g:plugs[v:val].frozen'))
  646. if new_frozen
  647. let s = new_frozen > 1 ? 's' : ''
  648. call append(3, printf('- Installed %d frozen plugin%s', new_frozen, s))
  649. endif
  650. call append(3, '- Finishing ... ')
  651. redraw
  652. call plug#helptags()
  653. call plug#end()
  654. call setline(4, getline(4) . 'Done!')
  655. redraw
  656. let msgs = []
  657. if !empty(s:update.errors)
  658. call add(msgs, "Press 'R' to retry.")
  659. endif
  660. if a:pull && len(s:update.new) < len(filter(getline(5, '$'),
  661. \ "v:val =~ '^- ' && stridx(v:val, 'Already up-to-date') < 0"))
  662. call add(msgs, "Press 'D' to see the updated changes.")
  663. endif
  664. echo join(msgs, ' ')
  665. endfunction
  666. function! s:retry()
  667. if empty(s:update.errors)
  668. return
  669. endif
  670. call s:update_impl(s:update.pull, s:update.force,
  671. \ extend(copy(s:update.errors), [s:update.threads]))
  672. endfunction
  673. function! s:is_managed(name)
  674. return has_key(g:plugs[a:name], 'uri')
  675. endfunction
  676. function! s:names(...)
  677. return sort(filter(keys(g:plugs), 'stridx(v:val, a:1) == 0 && s:is_managed(v:val)'))
  678. endfunction
  679. function! s:update_impl(pull, force, args) abort
  680. let args = copy(a:args)
  681. let threads = (len(args) > 0 && args[-1] =~ '^[1-9][0-9]*$') ?
  682. \ remove(args, -1) : get(g:, 'plug_threads', s:is_win ? 1 : 16)
  683. let managed = filter(copy(g:plugs), 's:is_managed(v:key)')
  684. let todo = empty(args) ? filter(managed, '!v:val.frozen || !isdirectory(v:val.dir)') :
  685. \ filter(managed, 'index(args, v:key) >= 0')
  686. if empty(todo)
  687. echohl WarningMsg
  688. echo 'No plugin to '. (a:pull ? 'update' : 'install') . '.'
  689. echohl None
  690. return
  691. endif
  692. if !s:is_win && s:git_version_requirement(2, 3)
  693. let s:git_terminal_prompt = exists('$GIT_TERMINAL_PROMPT') ? $GIT_TERMINAL_PROMPT : ''
  694. let $GIT_TERMINAL_PROMPT = 0
  695. for plug in values(todo)
  696. let plug.uri = substitute(plug.uri,
  697. \ '^https://git::@github\.com', 'https://github.com', '')
  698. endfor
  699. endif
  700. if !isdirectory(g:plug_home)
  701. try
  702. call mkdir(g:plug_home, 'p')
  703. catch
  704. return s:err(printf('Invalid plug directory: %s. '.
  705. \ 'Try to call plug#begin with a valid directory', g:plug_home))
  706. endtry
  707. endif
  708. if has('nvim') && !exists('*jobwait') && threads > 1
  709. echohl WarningMsg
  710. echomsg 'vim-plug: update Neovim for parallel installer'
  711. echohl None
  712. endif
  713. let python = (has('python') || has('python3')) && !s:is_win && !has('win32unix')
  714. \ && (!s:nvim || has('vim_starting'))
  715. let ruby = has('ruby') && !s:nvim && (v:version >= 703 || v:version == 702 && has('patch374'))
  716. let s:update = {
  717. \ 'start': reltime(),
  718. \ 'all': todo,
  719. \ 'todo': copy(todo),
  720. \ 'errors': [],
  721. \ 'pull': a:pull,
  722. \ 'force': a:force,
  723. \ 'new': {},
  724. \ 'threads': (python || ruby || s:nvim) ? min([len(todo), threads]) : 1,
  725. \ 'bar': '',
  726. \ 'fin': 0
  727. \ }
  728. call s:prepare()
  729. call append(0, ['', ''])
  730. normal! 2G
  731. silent! redraw
  732. let s:clone_opt = get(g:, 'plug_shallow', 1) ?
  733. \ '--depth 1' . (s:git_version_requirement(1, 7, 10) ? ' --no-single-branch' : '') : ''
  734. " Python version requirement (>= 2.7)
  735. if python && !has('python3') && !ruby && !s:nvim && s:update.threads > 1
  736. redir => pyv
  737. silent python import platform; print(platform.python_version())
  738. redir END
  739. let python = s:version_requirement(
  740. \ map(split(split(pyv)[0], '\.'), 'str2nr(v:val)'), [2, 6])
  741. endif
  742. if (python || ruby) && s:update.threads > 1
  743. try
  744. let imd = &imd
  745. if s:mac_gui
  746. set noimd
  747. endif
  748. if ruby
  749. call s:update_ruby()
  750. else
  751. call s:update_python()
  752. endif
  753. catch
  754. let lines = getline(4, '$')
  755. let printed = {}
  756. silent! 4,$d _
  757. for line in lines
  758. let name = s:extract_name(line, '.', '')
  759. if empty(name) || !has_key(printed, name)
  760. call append('$', line)
  761. if !empty(name)
  762. let printed[name] = 1
  763. if line[0] == 'x' && index(s:update.errors, name) < 0
  764. call add(s:update.errors, name)
  765. end
  766. endif
  767. endif
  768. endfor
  769. finally
  770. let &imd = imd
  771. call s:update_finish()
  772. endtry
  773. else
  774. call s:update_vim()
  775. endif
  776. endfunction
  777. function! s:update_finish()
  778. if exists('s:git_terminal_prompt')
  779. let $GIT_TERMINAL_PROMPT = s:git_terminal_prompt
  780. endif
  781. if s:switch_in()
  782. call s:checkout(filter(copy(s:update.all), 'has_key(v:val, "commit")'))
  783. call s:do(s:update.pull, s:update.force, filter(copy(s:update.all), 'has_key(v:val, "do")'))
  784. call s:finish(s:update.pull)
  785. call setline(1, 'Updated. Elapsed time: ' . split(reltimestr(reltime(s:update.start)))[0] . ' sec.')
  786. call s:switch_out('normal! gg')
  787. endif
  788. endfunction
  789. function! s:job_abort()
  790. if !s:nvim || !exists('s:jobs')
  791. return
  792. endif
  793. for [name, j] in items(s:jobs)
  794. silent! call jobstop(j.jobid)
  795. if j.new
  796. call s:system('rm -rf ' . s:shellesc(g:plugs[name].dir))
  797. endif
  798. endfor
  799. let s:jobs = {}
  800. endfunction
  801. " When a:event == 'stdout', data = list of strings
  802. " When a:event == 'exit', data = returncode
  803. function! s:job_handler(job_id, data, event) abort
  804. if !s:plug_window_exists() " plug window closed
  805. return s:job_abort()
  806. endif
  807. if a:event == 'stdout'
  808. let self.result .= substitute(s:to_s(a:data), '[\r\n]', '', 'g') . "\n"
  809. " To reduce the number of buffer updates
  810. let self.tick = get(self, 'tick', -1) + 1
  811. if self.tick % len(s:jobs) == 0
  812. call s:log(self.new ? '+' : '*', self.name, self.result)
  813. endif
  814. elseif a:event == 'exit'
  815. let self.running = 0
  816. if a:data != 0
  817. let self.error = 1
  818. endif
  819. call s:reap(self.name)
  820. call s:tick()
  821. endif
  822. endfunction
  823. function! s:spawn(name, cmd, opts)
  824. let job = { 'name': a:name, 'running': 1, 'error': 0, 'result': '',
  825. \ 'new': get(a:opts, 'new', 0),
  826. \ 'on_stdout': function('s:job_handler'),
  827. \ 'on_exit' : function('s:job_handler'),
  828. \ }
  829. let s:jobs[a:name] = job
  830. if s:nvim
  831. let argv = [ 'sh', '-c',
  832. \ (has_key(a:opts, 'dir') ? s:with_cd(a:cmd, a:opts.dir) : a:cmd) ]
  833. let jid = jobstart(argv, job)
  834. if jid > 0
  835. let job.jobid = jid
  836. else
  837. let job.running = 0
  838. let job.error = 1
  839. let job.result = jid < 0 ? 'sh is not executable' :
  840. \ 'Invalid arguments (or job table is full)'
  841. endif
  842. else
  843. let params = has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]
  844. let job.result = call('s:system', params)
  845. let job.error = v:shell_error != 0
  846. let job.running = 0
  847. endif
  848. endfunction
  849. function! s:reap(name)
  850. let job = s:jobs[a:name]
  851. if job.error
  852. call add(s:update.errors, a:name)
  853. elseif get(job, 'new', 0)
  854. let s:update.new[a:name] = 1
  855. endif
  856. let s:update.bar .= job.error ? 'x' : '='
  857. call s:log(job.error ? 'x' : '-', a:name, job.result)
  858. call s:bar()
  859. call remove(s:jobs, a:name)
  860. endfunction
  861. function! s:bar()
  862. if s:switch_in()
  863. let total = len(s:update.all)
  864. call setline(1, (s:update.pull ? 'Updating' : 'Installing').
  865. \ ' plugins ('.len(s:update.bar).'/'.total.')')
  866. call s:progress_bar(2, s:update.bar, total)
  867. call s:switch_out()
  868. endif
  869. endfunction
  870. function! s:logpos(name)
  871. for i in range(1, line('$'))
  872. if getline(i) =~# '^[-+x*] '.a:name.':'
  873. return i
  874. endif
  875. endfor
  876. return 0
  877. endfunction
  878. function! s:log(bullet, name, lines)
  879. if s:switch_in()
  880. let pos = s:logpos(a:name)
  881. if pos > 0
  882. execute pos 'd _'
  883. if pos > winheight('.')
  884. let pos = 4
  885. endif
  886. else
  887. let pos = 4
  888. endif
  889. call append(pos - 1, s:format_message(a:bullet, a:name, a:lines))
  890. call s:switch_out()
  891. endif
  892. endfunction
  893. function! s:update_vim()
  894. let s:jobs = {}
  895. call s:bar()
  896. call s:tick()
  897. endfunction
  898. function! s:tick()
  899. let pull = s:update.pull
  900. let prog = s:progress_opt(s:nvim)
  901. while 1 " Without TCO, Vim stack is bound to explode
  902. if empty(s:update.todo)
  903. if empty(s:jobs) && !s:update.fin
  904. let s:update.fin = 1
  905. call s:update_finish()
  906. endif
  907. return
  908. endif
  909. let name = keys(s:update.todo)[0]
  910. let spec = remove(s:update.todo, name)
  911. let new = !isdirectory(spec.dir)
  912. call s:log(new ? '+' : '*', name, pull ? 'Updating ...' : 'Installing ...')
  913. redraw
  914. let has_tag = has_key(spec, 'tag')
  915. let checkout = s:shellesc(has_tag ? spec.tag : spec.branch)
  916. let merge = s:shellesc(has_tag ? spec.tag : 'origin/'.spec.branch)
  917. if !new
  918. let error = s:git_validate(spec, 0)
  919. if empty(error)
  920. if pull
  921. let fetch_opt = (has_tag && !empty(globpath(spec.dir, '.git/shallow'))) ? '--depth 99999999' : ''
  922. call s:spawn(name,
  923. \ printf('(git fetch %s %s 2>&1 && git checkout -q %s 2>&1 && git merge --ff-only %s 2>&1 && git submodule update --init --recursive 2>&1)',
  924. \ fetch_opt, prog, checkout, merge), { 'dir': spec.dir })
  925. else
  926. let s:jobs[name] = { 'running': 0, 'result': 'Already installed', 'error': 0 }
  927. endif
  928. else
  929. let s:jobs[name] = { 'running': 0, 'result': error, 'error': 1 }
  930. endif
  931. else
  932. call s:spawn(name,
  933. \ printf('git clone %s %s --recursive %s -b %s %s 2>&1',
  934. \ has_tag ? '' : s:clone_opt,
  935. \ prog,
  936. \ s:shellesc(spec.uri),
  937. \ checkout,
  938. \ s:shellesc(s:trim(spec.dir))), { 'new': 1 })
  939. endif
  940. if !s:jobs[name].running
  941. call s:reap(name)
  942. endif
  943. if len(s:jobs) >= s:update.threads
  944. break
  945. endif
  946. endwhile
  947. endfunction
  948. function! s:update_python()
  949. let py_exe = has('python') ? 'python' : 'python3'
  950. execute py_exe "<< EOF"
  951. """ Due to use of signals this function is POSIX only. """
  952. import datetime
  953. import functools
  954. import os
  955. try:
  956. import queue
  957. except ImportError:
  958. import Queue as queue
  959. import random
  960. import re
  961. import shutil
  962. import signal
  963. import subprocess
  964. import tempfile
  965. import threading as thr
  966. import time
  967. import traceback
  968. import vim
  969. G_NVIM = vim.eval("has('nvim')") == '1'
  970. G_PULL = vim.eval('s:update.pull') == '1'
  971. G_RETRIES = int(vim.eval('get(g:, "plug_retries", 2)')) + 1
  972. G_TIMEOUT = int(vim.eval('get(g:, "plug_timeout", 60)'))
  973. G_CLONE_OPT = vim.eval('s:clone_opt')
  974. G_PROGRESS = vim.eval('s:progress_opt(1)')
  975. G_LOG_PROB = 1.0 / int(vim.eval('s:update.threads'))
  976. G_STOP = thr.Event()
  977. class PlugError(Exception):
  978. def __init__(self, msg):
  979. self.msg = msg
  980. class CmdTimedOut(PlugError):
  981. pass
  982. class CmdFailed(PlugError):
  983. pass
  984. class InvalidURI(PlugError):
  985. pass
  986. class Action(object):
  987. INSTALL, UPDATE, ERROR, DONE = ['+', '*', 'x', '-']
  988. class Buffer(object):
  989. def __init__(self, lock, num_plugs, is_pull, is_win):
  990. self.bar = ''
  991. self.event = 'Updating' if is_pull else 'Installing'
  992. self.is_win = is_win
  993. self.lock = lock
  994. self.maxy = int(vim.eval('winheight(".")'))
  995. self.num_plugs = num_plugs
  996. def __where(self, name):
  997. """ Find first line with name in current buffer. Return line num. """
  998. found, lnum = False, 0
  999. matcher = re.compile('^[-+x*] {0}:'.format(name))
  1000. for line in vim.current.buffer:
  1001. if matcher.search(line) is not None:
  1002. found = True
  1003. break
  1004. lnum += 1
  1005. if not found:
  1006. lnum = -1
  1007. return lnum
  1008. def header(self):
  1009. curbuf = vim.current.buffer
  1010. curbuf[0] = self.event + ' plugins ({0}/{1})'.format(len(self.bar), self.num_plugs)
  1011. num_spaces = self.num_plugs - len(self.bar)
  1012. curbuf[1] = '[{0}{1}]'.format(self.bar, num_spaces * ' ')
  1013. with self.lock:
  1014. vim.command('normal! 2G')
  1015. if not self.is_win:
  1016. vim.command('redraw')
  1017. def write(self, action, name, lines):
  1018. first, rest = lines[0], lines[1:]
  1019. msg = ['{0} {1}{2}{3}'.format(action, name, ': ' if first else '', first)]
  1020. msg.extend([' ' + line for line in rest])
  1021. try:
  1022. if action == Action.ERROR:
  1023. self.bar += 'x'
  1024. vim.command("call add(s:update.errors, '{0}')".format(name))
  1025. elif action == Action.DONE:
  1026. self.bar += '='
  1027. curbuf = vim.current.buffer
  1028. lnum = self.__where(name)
  1029. if lnum != -1: # Found matching line num
  1030. del curbuf[lnum]
  1031. if lnum > self.maxy and action in set([Action.INSTALL, Action.UPDATE]):
  1032. lnum = 3
  1033. else:
  1034. lnum = 3
  1035. curbuf.append(msg, lnum)
  1036. self.header()
  1037. except vim.error:
  1038. pass
  1039. class Command(object):
  1040. def __init__(self, cmd, cmd_dir=None, timeout=60, cb=None, clean=None):
  1041. self.cmd = cmd
  1042. if cmd_dir:
  1043. self.cmd = 'cd {0} && {1}'.format(cmd_dir, self.cmd)
  1044. self.timeout = timeout
  1045. self.callback = cb if cb else (lambda msg: None)
  1046. self.clean = clean if clean else (lambda: None)
  1047. self.proc = None
  1048. @property
  1049. def alive(self):
  1050. """ Returns true only if command still running. """
  1051. return self.proc and self.proc.poll() is None
  1052. def execute(self, ntries=3):
  1053. """ Execute the command with ntries if CmdTimedOut.
  1054. Returns the output of the command if no Exception.
  1055. """
  1056. attempt, finished, limit = 0, False, self.timeout
  1057. while not finished:
  1058. try:
  1059. attempt += 1
  1060. result = self.try_command()
  1061. finished = True
  1062. return result
  1063. except CmdTimedOut:
  1064. if attempt != ntries:
  1065. self.notify_retry()
  1066. self.timeout += limit
  1067. else:
  1068. raise
  1069. def notify_retry(self):
  1070. """ Retry required for command, notify user. """
  1071. for count in range(3, 0, -1):
  1072. if G_STOP.is_set():
  1073. raise KeyboardInterrupt
  1074. msg = 'Timeout. Will retry in {0} second{1} ...'.format(
  1075. count, 's' if count != 1 else '')
  1076. self.callback([msg])
  1077. time.sleep(1)
  1078. self.callback(['Retrying ...'])
  1079. def try_command(self):
  1080. """ Execute a cmd & poll for callback. Returns list of output.
  1081. Raises CmdFailed -> return code for Popen isn't 0
  1082. Raises CmdTimedOut -> command exceeded timeout without new output
  1083. """
  1084. first_line = True
  1085. try:
  1086. tfile = tempfile.NamedTemporaryFile(mode='w+b')
  1087. self.proc = subprocess.Popen(self.cmd, stdout=tfile,
  1088. stderr=subprocess.STDOUT, shell=True,
  1089. preexec_fn=os.setsid)
  1090. thrd = thr.Thread(target=(lambda proc: proc.wait()), args=(self.proc,))
  1091. thrd.start()
  1092. thread_not_started = True
  1093. while thread_not_started:
  1094. try:
  1095. thrd.join(0.1)
  1096. thread_not_started = False
  1097. except RuntimeError:
  1098. pass
  1099. while self.alive:
  1100. if G_STOP.is_set():
  1101. raise KeyboardInterrupt
  1102. if first_line or random.random() < G_LOG_PROB:
  1103. first_line = False
  1104. line = nonblock_read(tfile.name)
  1105. if line:
  1106. self.callback([line])
  1107. time_diff = time.time() - os.path.getmtime(tfile.name)
  1108. if time_diff > self.timeout:
  1109. raise CmdTimedOut(['Timeout!'])
  1110. thrd.join(0.5)
  1111. tfile.seek(0)
  1112. result = [line.decode('utf-8', 'replace').rstrip() for line in tfile]
  1113. if self.proc.returncode != 0:
  1114. raise CmdFailed([''] + result)
  1115. return result
  1116. except:
  1117. self.terminate()
  1118. raise
  1119. def terminate(self):
  1120. """ Terminate process and cleanup. """
  1121. if self.alive:
  1122. os.killpg(self.proc.pid, signal.SIGTERM)
  1123. self.clean()
  1124. class Plugin(object):
  1125. def __init__(self, name, args, buf_q, lock):
  1126. self.name = name
  1127. self.args = args
  1128. self.buf_q = buf_q
  1129. self.lock = lock
  1130. tag = args.get('tag', 0)
  1131. self.checkout = esc(tag if tag else args['branch'])
  1132. self.merge = esc(tag if tag else 'origin/' + args['branch'])
  1133. self.tag = tag
  1134. def manage(self):
  1135. try:
  1136. if os.path.exists(self.args['dir']):
  1137. self.update()
  1138. else:
  1139. self.install()
  1140. with self.lock:
  1141. thread_vim_command("let s:update.new['{0}'] = 1".format(self.name))
  1142. except PlugError as exc:
  1143. self.write(Action.ERROR, self.name, exc.msg)
  1144. except KeyboardInterrupt:
  1145. G_STOP.set()
  1146. self.write(Action.ERROR, self.name, ['Interrupted!'])
  1147. except:
  1148. # Any exception except those above print stack trace
  1149. msg = 'Trace:\n{0}'.format(traceback.format_exc().rstrip())
  1150. self.write(Action.ERROR, self.name, msg.split('\n'))
  1151. raise
  1152. def install(self):
  1153. target = self.args['dir']
  1154. def clean(target):
  1155. def _clean():
  1156. try:
  1157. shutil.rmtree(target)
  1158. except OSError:
  1159. pass
  1160. return _clean
  1161. self.write(Action.INSTALL, self.name, ['Installing ...'])
  1162. callback = functools.partial(self.write, Action.INSTALL, self.name)
  1163. cmd = 'git clone {0} {1} --recursive {2} -b {3} {4} 2>&1'.format(
  1164. '' if self.tag else G_CLONE_OPT, G_PROGRESS, self.args['uri'],
  1165. self.checkout, esc(target))
  1166. com = Command(cmd, None, G_TIMEOUT, callback, clean(target))
  1167. result = com.execute(G_RETRIES)
  1168. self.write(Action.DONE, self.name, result[-1:])
  1169. def repo_uri(self):
  1170. cmd = 'git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url'
  1171. command = Command(cmd, self.args['dir'], G_TIMEOUT,)
  1172. result = command.execute(G_RETRIES)
  1173. return result[-1]
  1174. def update(self):
  1175. match = re.compile(r'git::?@')
  1176. actual_uri = re.sub(match, '', self.repo_uri())
  1177. expect_uri = re.sub(match, '', self.args['uri'])
  1178. if actual_uri != expect_uri:
  1179. msg = ['',
  1180. 'Invalid URI: {0}'.format(actual_uri),
  1181. 'Expected {0}'.format(expect_uri),
  1182. 'PlugClean required.']
  1183. raise InvalidURI(msg)
  1184. if G_PULL:
  1185. self.write(Action.UPDATE, self.name, ['Updating ...'])
  1186. callback = functools.partial(self.write, Action.UPDATE, self.name)
  1187. fetch_opt = '--depth 99999999' if self.tag and os.path.isfile(os.path.join(self.args['dir'], '.git/shallow')) else ''
  1188. cmds = ['git fetch {0} {1}'.format(fetch_opt, G_PROGRESS),
  1189. 'git checkout -q {0}'.format(self.checkout),
  1190. 'git merge --ff-only {0}'.format(self.merge),
  1191. 'git submodule update --init --recursive']
  1192. cmd = ' 2>&1 && '.join(cmds)
  1193. com = Command(cmd, self.args['dir'], G_TIMEOUT, callback)
  1194. result = com.execute(G_RETRIES)
  1195. self.write(Action.DONE, self.name, result[-1:])
  1196. else:
  1197. self.write(Action.DONE, self.name, ['Already installed'])
  1198. def write(self, action, name, msg):
  1199. self.buf_q.put((action, name, msg))
  1200. class PlugThread(thr.Thread):
  1201. def __init__(self, tname, args):
  1202. super(PlugThread, self).__init__()
  1203. self.tname = tname
  1204. self.args = args
  1205. def run(self):
  1206. thr.current_thread().name = self.tname
  1207. buf_q, work_q, lock = self.args
  1208. try:
  1209. while not G_STOP.is_set():
  1210. name, args = work_q.get_nowait()
  1211. plug = Plugin(name, args, buf_q, lock)
  1212. plug.manage()
  1213. work_q.task_done()
  1214. except queue.Empty:
  1215. pass
  1216. class RefreshThread(thr.Thread):
  1217. def __init__(self, lock):
  1218. super(RefreshThread, self).__init__()
  1219. self.lock = lock
  1220. self.running = True
  1221. def run(self):
  1222. while self.running:
  1223. with self.lock:
  1224. thread_vim_command('noautocmd normal! a')
  1225. time.sleep(0.33)
  1226. def stop(self):
  1227. self.running = False
  1228. if G_NVIM:
  1229. def thread_vim_command(cmd):
  1230. vim.session.threadsafe_call(lambda: vim.command(cmd))
  1231. else:
  1232. def thread_vim_command(cmd):
  1233. vim.command(cmd)
  1234. def esc(name):
  1235. return '"' + name.replace('"', '\"') + '"'
  1236. def nonblock_read(fname):
  1237. """ Read a file with nonblock flag. Return the last line. """
  1238. fread = os.open(fname, os.O_RDONLY | os.O_NONBLOCK)
  1239. buf = os.read(fread, 100000).decode('utf-8', 'replace')
  1240. os.close(fread)
  1241. line = buf.rstrip('\r\n')
  1242. left = max(line.rfind('\r'), line.rfind('\n'))
  1243. if left != -1:
  1244. left += 1
  1245. line = line[left:]
  1246. return line
  1247. def main():
  1248. thr.current_thread().name = 'main'
  1249. nthreads = int(vim.eval('s:update.threads'))
  1250. plugs = vim.eval('s:update.todo')
  1251. mac_gui = vim.eval('s:mac_gui') == '1'
  1252. is_win = vim.eval('s:is_win') == '1'
  1253. lock = thr.Lock()
  1254. buf = Buffer(lock, len(plugs), G_PULL, is_win)
  1255. buf_q, work_q = queue.Queue(), queue.Queue()
  1256. for work in plugs.items():
  1257. work_q.put(work)
  1258. start_cnt = thr.active_count()
  1259. for num in range(nthreads):
  1260. tname = 'PlugT-{0:02}'.format(num)
  1261. thread = PlugThread(tname, (buf_q, work_q, lock))
  1262. thread.start()
  1263. if mac_gui:
  1264. rthread = RefreshThread(lock)
  1265. rthread.start()
  1266. while not buf_q.empty() or thr.active_count() != start_cnt:
  1267. try:
  1268. action, name, msg = buf_q.get(True, 0.25)
  1269. buf.write(action, name, msg)
  1270. buf_q.task_done()
  1271. except queue.Empty:
  1272. pass
  1273. except KeyboardInterrupt:
  1274. G_STOP.set()
  1275. if mac_gui:
  1276. rthread.stop()
  1277. rthread.join()
  1278. main()
  1279. EOF
  1280. endfunction
  1281. function! s:update_ruby()
  1282. ruby << EOF
  1283. module PlugStream
  1284. SEP = ["\r", "\n", nil]
  1285. def get_line
  1286. buffer = ''
  1287. loop do
  1288. char = readchar rescue return
  1289. if SEP.include? char.chr
  1290. buffer << $/
  1291. break
  1292. else
  1293. buffer << char
  1294. end
  1295. end
  1296. buffer
  1297. end
  1298. end unless defined?(PlugStream)
  1299. def esc arg
  1300. %["#{arg.gsub('"', '\"')}"]
  1301. end
  1302. def killall pid
  1303. pids = [pid]
  1304. unless `which pgrep 2> /dev/null`.empty?
  1305. children = pids
  1306. until children.empty?
  1307. children = children.map { |pid|
  1308. `pgrep -P #{pid}`.lines.map { |l| l.chomp }
  1309. }.flatten
  1310. pids += children
  1311. end
  1312. end
  1313. pids.each { |pid| Process.kill 'TERM', pid.to_i rescue nil }
  1314. end
  1315. require 'thread'
  1316. require 'fileutils'
  1317. require 'timeout'
  1318. running = true
  1319. iswin = VIM::evaluate('s:is_win').to_i == 1
  1320. pull = VIM::evaluate('s:update.pull').to_i == 1
  1321. base = VIM::evaluate('g:plug_home')
  1322. all = VIM::evaluate('s:update.todo')
  1323. limit = VIM::evaluate('get(g:, "plug_timeout", 60)')
  1324. tries = VIM::evaluate('get(g:, "plug_retries", 2)') + 1
  1325. nthr = VIM::evaluate('s:update.threads').to_i
  1326. maxy = VIM::evaluate('winheight(".")').to_i
  1327. cd = iswin ? 'cd /d' : 'cd'
  1328. tot = VIM::evaluate('len(s:update.todo)') || 0
  1329. bar = ''
  1330. skip = 'Already installed'
  1331. mtx = Mutex.new
  1332. take1 = proc { mtx.synchronize { running && all.shift } }
  1333. logh = proc {
  1334. cnt = bar.length
  1335. $curbuf[1] = "#{pull ? 'Updating' : 'Installing'} plugins (#{cnt}/#{tot})"
  1336. $curbuf[2] = '[' + bar.ljust(tot) + ']'
  1337. VIM::command('normal! 2G')
  1338. VIM::command('redraw') unless iswin
  1339. }
  1340. where = proc { |name| (1..($curbuf.length)).find { |l| $curbuf[l] =~ /^[-+x*] #{name}:/ } }
  1341. log = proc { |name, result, type|
  1342. mtx.synchronize do
  1343. ing = ![true, false].include?(type)
  1344. bar += type ? '=' : 'x' unless ing
  1345. b = case type
  1346. when :install then '+' when :update then '*'
  1347. when true, nil then '-' else
  1348. VIM::command("call add(s:update.errors, '#{name}')")
  1349. 'x'
  1350. end
  1351. result =
  1352. if type || type.nil?
  1353. ["#{b} #{name}: #{result.lines.to_a.last}"]
  1354. elsif result =~ /^Interrupted|^Timeout/
  1355. ["#{b} #{name}: #{result}"]
  1356. else
  1357. ["#{b} #{name}"] + result.lines.map { |l| " " << l }
  1358. end
  1359. if lnum = where.call(name)
  1360. $curbuf.delete lnum
  1361. lnum = 4 if ing && lnum > maxy
  1362. end
  1363. result.each_with_index do |line, offset|
  1364. $curbuf.append((lnum || 4) - 1 + offset, line.gsub(/\e\[./, '').chomp)
  1365. end
  1366. logh.call
  1367. end
  1368. }
  1369. bt = proc { |cmd, name, type, cleanup|
  1370. tried = timeout = 0
  1371. begin
  1372. tried += 1
  1373. timeout += limit
  1374. fd = nil
  1375. data = ''
  1376. if iswin
  1377. Timeout::timeout(timeout) do
  1378. tmp = VIM::evaluate('tempname()')
  1379. system("(#{cmd}) > #{tmp}")
  1380. data = File.read(tmp).chomp
  1381. File.unlink tmp rescue nil
  1382. end
  1383. else
  1384. fd = IO.popen(cmd).extend(PlugStream)
  1385. first_line = true
  1386. log_prob = 1.0 / nthr
  1387. while line = Timeout::timeout(timeout) { fd.get_line }
  1388. data << line
  1389. log.call name, line.chomp, type if name && (first_line || rand < log_prob)
  1390. first_line = false
  1391. end
  1392. fd.close
  1393. end
  1394. [$? == 0, data.chomp]
  1395. rescue Timeout::Error, Interrupt => e
  1396. if fd && !fd.closed?
  1397. killall fd.pid
  1398. fd.close
  1399. end
  1400. cleanup.call if cleanup
  1401. if e.is_a?(Timeout::Error) && tried < tries
  1402. 3.downto(1) do |countdown|
  1403. s = countdown > 1 ? 's' : ''
  1404. log.call name, "Timeout. Will retry in #{countdown} second#{s} ...", type
  1405. sleep 1
  1406. end
  1407. log.call name, 'Retrying ...', type
  1408. retry
  1409. end
  1410. [false, e.is_a?(Interrupt) ? "Interrupted!" : "Timeout!"]
  1411. end
  1412. }
  1413. main = Thread.current
  1414. threads = []
  1415. watcher = Thread.new {
  1416. while VIM::evaluate('getchar(1)')
  1417. sleep 0.1
  1418. end
  1419. mtx.synchronize do
  1420. running = false
  1421. threads.each { |t| t.raise Interrupt }
  1422. end
  1423. threads.each { |t| t.join rescue nil }
  1424. main.kill
  1425. }
  1426. refresh = Thread.new {
  1427. while true
  1428. mtx.synchronize do
  1429. break unless running
  1430. VIM::command('noautocmd normal! a')
  1431. end
  1432. sleep 0.2
  1433. end
  1434. } if VIM::evaluate('s:mac_gui') == 1
  1435. clone_opt = VIM::evaluate('s:clone_opt')
  1436. progress = VIM::evaluate('s:progress_opt(1)')
  1437. nthr.times do
  1438. mtx.synchronize do
  1439. threads << Thread.new {
  1440. while pair = take1.call
  1441. name = pair.first
  1442. dir, uri, branch, tag = pair.last.values_at *%w[dir uri branch tag]
  1443. checkout = esc(tag ? tag : branch)
  1444. merge = esc(tag ? tag : "origin/#{branch}")
  1445. subm = "git submodule update --init --recursive 2>&1"
  1446. exists = File.directory? dir
  1447. ok, result =
  1448. if exists
  1449. dir = iswin ? dir : esc(dir)
  1450. ret, data = bt.call "#{cd} #{dir} && git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url", nil, nil, nil
  1451. current_uri = data.lines.to_a.last
  1452. if !ret
  1453. if data =~ /^Interrupted|^Timeout/
  1454. [false, data]
  1455. else
  1456. [false, [data.chomp, "PlugClean required."].join($/)]
  1457. end
  1458. elsif current_uri.sub(/git::?@/, '') != uri.sub(/git::?@/, '')
  1459. [false, ["Invalid URI: #{current_uri}",
  1460. "Expected: #{uri}",
  1461. "PlugClean required."].join($/)]
  1462. else
  1463. if pull
  1464. log.call name, 'Updating ...', :update
  1465. fetch_opt = (tag && File.exist?(File.join(dir, '.git/shallow'))) ? '--depth 99999999' : ''
  1466. bt.call "#{cd} #{dir} && git fetch #{fetch_opt} #{progress} 2>&1 && git checkout -q #{checkout} 2>&1 && git merge --ff-only #{merge} 2>&1 && #{subm}", name, :update, nil
  1467. else
  1468. [true, skip]
  1469. end
  1470. end
  1471. else
  1472. d = esc dir.sub(%r{[\\/]+$}, '')
  1473. log.call name, 'Installing ...', :install
  1474. bt.call "git clone #{clone_opt unless tag} #{progress} --recursive #{uri} -b #{checkout} #{d} 2>&1", name, :install, proc {
  1475. FileUtils.rm_rf dir
  1476. }
  1477. end
  1478. mtx.synchronize { VIM::command("let s:update.new['#{name}'] = 1") } if !exists && ok
  1479. log.call name, result, ok
  1480. end
  1481. } if running
  1482. end
  1483. end
  1484. threads.each { |t| t.join rescue nil }
  1485. logh.call
  1486. refresh.kill if refresh
  1487. watcher.kill
  1488. EOF
  1489. endfunction
  1490. function! s:shellesc(arg)
  1491. return '"'.escape(a:arg, '"').'"'
  1492. endfunction
  1493. function! s:glob_dir(path)
  1494. return map(filter(s:lines(globpath(a:path, '**')), 'isdirectory(v:val)'), 's:dirpath(v:val)')
  1495. endfunction
  1496. function! s:progress_bar(line, bar, total)
  1497. call setline(a:line, '[' . s:lpad(a:bar, a:total) . ']')
  1498. endfunction
  1499. function! s:compare_git_uri(a, b)
  1500. let a = substitute(a:a, 'git:\{1,2}@', '', '')
  1501. let b = substitute(a:b, 'git:\{1,2}@', '', '')
  1502. return a ==# b
  1503. endfunction
  1504. function! s:format_message(bullet, name, message)
  1505. if a:bullet != 'x'
  1506. return [printf('%s %s: %s', a:bullet, a:name, s:lastline(a:message))]
  1507. else
  1508. let lines = map(s:lines(a:message), '" ".v:val')
  1509. return extend([printf('x %s:', a:name)], lines)
  1510. endif
  1511. endfunction
  1512. function! s:with_cd(cmd, dir)
  1513. return printf('cd%s %s && %s', s:is_win ? ' /d' : '', s:shellesc(a:dir), a:cmd)
  1514. endfunction
  1515. function! s:system(cmd, ...)
  1516. try
  1517. let [sh, shrd] = [&shell, &shellredir]
  1518. if !s:is_win
  1519. set shell=sh shellredir=>%s\ 2>&1
  1520. endif
  1521. let cmd = a:0 > 0 ? s:with_cd(a:cmd, a:1) : a:cmd
  1522. return system(s:is_win ? '('.cmd.')' : cmd)
  1523. finally
  1524. let [&shell, &shellredir] = [sh, shrd]
  1525. endtry
  1526. endfunction
  1527. function! s:system_chomp(...)
  1528. let ret = call('s:system', a:000)
  1529. return v:shell_error ? '' : substitute(ret, '\n$', '', '')
  1530. endfunction
  1531. function! s:git_validate(spec, check_branch)
  1532. let err = ''
  1533. if isdirectory(a:spec.dir)
  1534. let result = s:lines(s:system('git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url', a:spec.dir))
  1535. let remote = result[-1]
  1536. if v:shell_error
  1537. let err = join([remote, 'PlugClean required.'], "\n")
  1538. elseif !s:compare_git_uri(remote, a:spec.uri)
  1539. let err = join(['Invalid URI: '.remote,
  1540. \ 'Expected: '.a:spec.uri,
  1541. \ 'PlugClean required.'], "\n")
  1542. elseif a:check_branch && has_key(a:spec, 'commit')
  1543. let result = s:lines(s:system('git rev-parse HEAD 2>&1', a:spec.dir))
  1544. let sha = result[-1]
  1545. if v:shell_error
  1546. let err = join(add(result, 'PlugClean required.'), "\n")
  1547. elseif !s:hash_match(sha, a:spec.commit)
  1548. let err = join([printf('Invalid HEAD (expected: %s, actual: %s)',
  1549. \ a:spec.commit[:6], sha[:6]),
  1550. \ 'PlugUpdate required.'], "\n")
  1551. endif
  1552. elseif a:check_branch
  1553. let branch = result[0]
  1554. " Check tag
  1555. if has_key(a:spec, 'tag')
  1556. let tag = s:system_chomp('git describe --exact-match --tags HEAD 2>&1', a:spec.dir)
  1557. if a:spec.tag !=# tag
  1558. let err = printf('Invalid tag: %s (expected: %s). Try PlugUpdate.',
  1559. \ (empty(tag) ? 'N/A' : tag), a:spec.tag)
  1560. endif
  1561. " Check branch
  1562. elseif a:spec.branch !=# branch
  1563. let err = printf('Invalid branch: %s (expected: %s). Try PlugUpdate.',
  1564. \ branch, a:spec.branch)
  1565. endif
  1566. endif
  1567. else
  1568. let err = 'Not found'
  1569. endif
  1570. return err
  1571. endfunction
  1572. function! s:rm_rf(dir)
  1573. if isdirectory(a:dir)
  1574. call s:system((s:is_win ? 'rmdir /S /Q ' : 'rm -rf ') . s:shellesc(a:dir))
  1575. endif
  1576. endfunction
  1577. function! s:clean(force)
  1578. call s:prepare()
  1579. call append(0, 'Searching for unused plugins in '.g:plug_home)
  1580. call append(1, '')
  1581. " List of valid directories
  1582. let dirs = []
  1583. let [cnt, total] = [0, len(g:plugs)]
  1584. for [name, spec] in items(g:plugs)
  1585. if !s:is_managed(name) || empty(s:git_validate(spec, 0))
  1586. call add(dirs, spec.dir)
  1587. endif
  1588. let cnt += 1
  1589. call s:progress_bar(2, repeat('=', cnt), total)
  1590. normal! 2G
  1591. redraw
  1592. endfor
  1593. let allowed = {}
  1594. for dir in dirs
  1595. let allowed[s:dirpath(fnamemodify(dir, ':h:h'))] = 1
  1596. let allowed[dir] = 1
  1597. for child in s:glob_dir(dir)
  1598. let allowed[child] = 1
  1599. endfor
  1600. endfor
  1601. let todo = []
  1602. let found = sort(s:glob_dir(g:plug_home))
  1603. while !empty(found)
  1604. let f = remove(found, 0)
  1605. if !has_key(allowed, f) && isdirectory(f)
  1606. call add(todo, f)
  1607. call append(line('$'), '- ' . f)
  1608. let found = filter(found, 'stridx(v:val, f) != 0')
  1609. end
  1610. endwhile
  1611. normal! G
  1612. redraw
  1613. if empty(todo)
  1614. call append(line('$'), 'Already clean.')
  1615. else
  1616. call inputsave()
  1617. let yes = a:force || (input('Proceed? (y/N) ') =~? '^y')
  1618. call inputrestore()
  1619. if yes
  1620. for dir in todo
  1621. call s:rm_rf(dir)
  1622. endfor
  1623. call append(line('$'), 'Removed.')
  1624. else
  1625. call append(line('$'), 'Cancelled.')
  1626. endif
  1627. endif
  1628. normal! G
  1629. endfunction
  1630. function! s:upgrade()
  1631. echo 'Downloading the latest version of vim-plug'
  1632. redraw
  1633. let tmp = tempname()
  1634. let new = tmp . '/plug.vim'
  1635. try
  1636. let out = s:system(printf('git clone --depth 1 %s %s', s:plug_src, tmp))
  1637. if v:shell_error
  1638. return s:err('Error upgrading vim-plug: '. out)
  1639. endif
  1640. if readfile(s:me) ==# readfile(new)
  1641. echo 'vim-plug is already up-to-date'
  1642. return 0
  1643. else
  1644. call rename(s:me, s:me . '.old')
  1645. call rename(new, s:me)
  1646. unlet g:loaded_plug
  1647. echo 'vim-plug has been upgraded'
  1648. return 1
  1649. endif
  1650. finally
  1651. silent! call s:rm_rf(tmp)
  1652. endtry
  1653. endfunction
  1654. function! s:upgrade_specs()
  1655. for spec in values(g:plugs)
  1656. let spec.frozen = get(spec, 'frozen', 0)
  1657. endfor
  1658. endfunction
  1659. function! s:status()
  1660. call s:prepare()
  1661. call append(0, 'Checking plugins')
  1662. call append(1, '')
  1663. let ecnt = 0
  1664. let unloaded = 0
  1665. let [cnt, total] = [0, len(g:plugs)]
  1666. for [name, spec] in items(g:plugs)
  1667. if has_key(spec, 'uri')
  1668. if isdirectory(spec.dir)
  1669. let err = s:git_validate(spec, 1)
  1670. let [valid, msg] = [empty(err), empty(err) ? 'OK' : err]
  1671. else
  1672. let [valid, msg] = [0, 'Not found. Try PlugInstall.']
  1673. endif
  1674. else
  1675. if isdirectory(spec.dir)
  1676. let [valid, msg] = [1, 'OK']
  1677. else
  1678. let [valid, msg] = [0, 'Not found.']
  1679. endif
  1680. endif
  1681. let cnt += 1
  1682. let ecnt += !valid
  1683. " `s:loaded` entry can be missing if PlugUpgraded
  1684. if valid && get(s:loaded, name, -1) == 0
  1685. let unloaded = 1
  1686. let msg .= ' (not loaded)'
  1687. endif
  1688. call s:progress_bar(2, repeat('=', cnt), total)
  1689. call append(3, s:format_message(valid ? '-' : 'x', name, msg))
  1690. normal! 2G
  1691. redraw
  1692. endfor
  1693. call setline(1, 'Finished. '.ecnt.' error(s).')
  1694. normal! gg
  1695. setlocal nomodifiable
  1696. if unloaded
  1697. echo "Press 'L' on each line to load plugin, or 'U' to update"
  1698. nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1699. xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1700. end
  1701. endfunction
  1702. function! s:extract_name(str, prefix, suffix)
  1703. return matchstr(a:str, '^'.a:prefix.' \zs[^:]\+\ze:.*'.a:suffix.'$')
  1704. endfunction
  1705. function! s:status_load(lnum)
  1706. let line = getline(a:lnum)
  1707. let name = s:extract_name(line, '-', '(not loaded)')
  1708. if !empty(name)
  1709. call plug#load(name)
  1710. setlocal modifiable
  1711. call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
  1712. setlocal nomodifiable
  1713. endif
  1714. endfunction
  1715. function! s:status_update() range
  1716. let lines = getline(a:firstline, a:lastline)
  1717. let names = filter(map(lines, 's:extract_name(v:val, "[x-]", "")'), '!empty(v:val)')
  1718. if !empty(names)
  1719. echo
  1720. execute 'PlugUpdate' join(names)
  1721. endif
  1722. endfunction
  1723. function! s:is_preview_window_open()
  1724. silent! wincmd P
  1725. if &previewwindow
  1726. wincmd p
  1727. return 1
  1728. endif
  1729. return 0
  1730. endfunction
  1731. function! s:find_name(lnum)
  1732. for lnum in reverse(range(1, a:lnum))
  1733. let line = getline(lnum)
  1734. if empty(line)
  1735. return ''
  1736. endif
  1737. let name = s:extract_name(line, '-', '')
  1738. if !empty(name)
  1739. return name
  1740. endif
  1741. endfor
  1742. return ''
  1743. endfunction
  1744. function! s:preview_commit()
  1745. if b:plug_preview < 0
  1746. let b:plug_preview = !s:is_preview_window_open()
  1747. endif
  1748. let sha = matchstr(getline('.'), '\(^ \)\@<=[0-9a-z]\{7}')
  1749. if empty(sha)
  1750. return
  1751. endif
  1752. let name = s:find_name(line('.'))
  1753. if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
  1754. return
  1755. endif
  1756. execute 'pedit' sha
  1757. wincmd P
  1758. setlocal filetype=git buftype=nofile nobuflisted modifiable
  1759. execute 'silent read !cd' s:shellesc(g:plugs[name].dir) '&& git show --pretty=medium' sha
  1760. normal! gg"_dd
  1761. setlocal nomodifiable
  1762. nnoremap <silent> <buffer> q :q<cr>
  1763. wincmd p
  1764. endfunction
  1765. function! s:section(flags)
  1766. call search('\(^[x-] \)\@<=[^:]\+:', a:flags)
  1767. endfunction
  1768. function! s:diff()
  1769. call s:prepare()
  1770. call append(0, 'Collecting updated changes ...')
  1771. normal! gg
  1772. redraw
  1773. let cnt = 0
  1774. for [k, v] in filter(items(g:plugs), '!has_key(v:val[1], "commit")')
  1775. if !isdirectory(v.dir) || !s:is_managed(k)
  1776. continue
  1777. endif
  1778. let diff = s:system_chomp('git log --pretty=format:"%h %s (%cr)" "HEAD...HEAD@{1}"', v.dir)
  1779. if !empty(diff)
  1780. call append(1, '')
  1781. call append(2, '- '.k.':')
  1782. call append(3, map(s:lines(diff), '" ". v:val'))
  1783. let cnt += 1
  1784. normal! gg
  1785. redraw
  1786. endif
  1787. endfor
  1788. call setline(1, cnt == 0 ? 'No updates.' : 'Last update:')
  1789. nnoremap <silent> <buffer> <cr> :silent! call <SID>preview_commit()<cr>
  1790. nnoremap <silent> <buffer> o :silent! call <SID>preview_commit()<cr>
  1791. nnoremap <silent> <buffer> X :call <SID>revert()<cr>
  1792. normal! gg
  1793. setlocal nomodifiable
  1794. if cnt > 0
  1795. echo "Press 'X' on each block to revert the update"
  1796. endif
  1797. endfunction
  1798. function! s:revert()
  1799. let name = s:find_name(line('.'))
  1800. if empty(name) || !has_key(g:plugs, name) ||
  1801. \ input(printf('Revert the update of %s? (y/N) ', name)) !~? '^y'
  1802. return
  1803. endif
  1804. call s:system('git reset --hard HEAD@{1} && git checkout '.s:esc(g:plugs[name].branch), g:plugs[name].dir)
  1805. setlocal modifiable
  1806. normal! "_dap
  1807. setlocal nomodifiable
  1808. echo 'Reverted.'
  1809. endfunction
  1810. function! s:snapshot(...) abort
  1811. let home = get(s:, 'plug_home_org', g:plug_home)
  1812. let [type, var, header] = s:is_win ?
  1813. \ ['dosbatch', '%PLUG_HOME%',
  1814. \ ['@echo off', ':: Generated by vim-plug', ':: '.strftime("%c"), '',
  1815. \ ':: Make sure to PlugUpdate first', '', 'set PLUG_HOME='.home]] :
  1816. \ ['sh', '$PLUG_HOME',
  1817. \ ['#!/bin/sh', '# Generated by vim-plug', '# '.strftime("%c"), '',
  1818. \ 'vim +PlugUpdate +qa', '', 'PLUG_HOME='.s:esc(home)]]
  1819. call s:prepare()
  1820. execute 'setf' type
  1821. call append(0, header)
  1822. call append('$', '')
  1823. 1
  1824. redraw
  1825. let dirs = sort(map(values(filter(copy(g:plugs),
  1826. \'has_key(v:val, "uri") && !has_key(v:val, "commit") && isdirectory(v:val.dir)')), 'v:val.dir'))
  1827. let anchor = line('$') - 1
  1828. for dir in reverse(dirs)
  1829. let sha = s:system_chomp('git rev-parse --short HEAD', dir)
  1830. if !empty(sha)
  1831. call append(anchor, printf('cd %s && git reset --hard %s',
  1832. \ substitute(dir, '^\V'.escape(g:plug_home, '\'), var, ''), sha))
  1833. redraw
  1834. endif
  1835. endfor
  1836. if a:0 > 0
  1837. let fn = expand(a:1)
  1838. let fne = s:esc(fn)
  1839. call writefile(getline(1, '$'), fn)
  1840. if !s:is_win | call s:system('chmod +x ' . fne) | endif
  1841. echo 'Saved to '.a:1
  1842. silent execute 'e' fne
  1843. endif
  1844. endfunction
  1845. function! s:split_rtp()
  1846. return split(&rtp, '\\\@<!,')
  1847. endfunction
  1848. let s:first_rtp = s:escrtp(get(s:split_rtp(), 0, ''))
  1849. let s:last_rtp = s:escrtp(get(s:split_rtp(), -1, ''))
  1850. if exists('g:plugs')
  1851. let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
  1852. call s:upgrade_specs()
  1853. call s:define_commands()
  1854. endif
  1855. let &cpo = s:cpo_save
  1856. unlet s:cpo_save