plug.vim 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046
  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>echo<bar>q<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:finish(pull)
  616. let new_frozen = len(filter(keys(s:update.new), 'g:plugs[v:val].frozen'))
  617. if new_frozen
  618. let s = new_frozen > 1 ? 's' : ''
  619. call append(3, printf('- Installed %d frozen plugin%s', new_frozen, s))
  620. endif
  621. call append(3, '- Finishing ... ')
  622. redraw
  623. call plug#helptags()
  624. call plug#end()
  625. call setline(4, getline(4) . 'Done!')
  626. redraw
  627. let msgs = []
  628. if !empty(s:update.errors)
  629. call add(msgs, "Press 'R' to retry.")
  630. endif
  631. if a:pull && len(s:update.new) < len(filter(getline(5, '$'),
  632. \ "v:val =~ '^- ' && stridx(v:val, 'Already up-to-date') < 0"))
  633. call add(msgs, "Press 'D' to see the updated changes.")
  634. endif
  635. echo join(msgs, ' ')
  636. endfunction
  637. function! s:retry()
  638. if empty(s:update.errors)
  639. return
  640. endif
  641. call s:update_impl(s:update.pull, s:update.force,
  642. \ extend(copy(s:update.errors), [s:update.threads]))
  643. endfunction
  644. function! s:is_managed(name)
  645. return has_key(g:plugs[a:name], 'uri')
  646. endfunction
  647. function! s:names(...)
  648. return sort(filter(keys(g:plugs), 'stridx(v:val, a:1) == 0 && s:is_managed(v:val)'))
  649. endfunction
  650. function! s:update_impl(pull, force, args) abort
  651. let args = copy(a:args)
  652. let threads = (len(args) > 0 && args[-1] =~ '^[1-9][0-9]*$') ?
  653. \ remove(args, -1) : get(g:, 'plug_threads', s:is_win ? 1 : 16)
  654. let managed = filter(copy(g:plugs), 's:is_managed(v:key)')
  655. let todo = empty(args) ? filter(managed, '!v:val.frozen || !isdirectory(v:val.dir)') :
  656. \ filter(managed, 'index(args, v:key) >= 0')
  657. if empty(todo)
  658. echohl WarningMsg
  659. echo 'No plugin to '. (a:pull ? 'update' : 'install') . '.'
  660. echohl None
  661. return
  662. endif
  663. if !s:is_win && s:git_version_requirement(2, 3)
  664. let s:git_terminal_prompt = exists('$GIT_TERMINAL_PROMPT') ? $GIT_TERMINAL_PROMPT : ''
  665. let $GIT_TERMINAL_PROMPT = 0
  666. for plug in values(todo)
  667. let plug.uri = substitute(plug.uri,
  668. \ '^https://git::@github\.com', 'https://github.com', '')
  669. endfor
  670. endif
  671. if !isdirectory(g:plug_home)
  672. try
  673. call mkdir(g:plug_home, 'p')
  674. catch
  675. return s:err(printf('Invalid plug directory: %s. '.
  676. \ 'Try to call plug#begin with a valid directory', g:plug_home))
  677. endtry
  678. endif
  679. if has('nvim') && !exists('*jobwait') && threads > 1
  680. echohl WarningMsg
  681. echomsg 'vim-plug: update Neovim for parallel installer'
  682. echohl None
  683. endif
  684. let python = (has('python') || has('python3')) && !s:is_win && !has('win32unix')
  685. \ && (!s:nvim || has('vim_starting'))
  686. let ruby = has('ruby') && !s:nvim && (v:version >= 703 || v:version == 702 && has('patch374'))
  687. let s:update = {
  688. \ 'start': reltime(),
  689. \ 'all': todo,
  690. \ 'todo': copy(todo),
  691. \ 'errors': [],
  692. \ 'pull': a:pull,
  693. \ 'force': a:force,
  694. \ 'new': {},
  695. \ 'threads': (python || ruby || s:nvim) ? min([len(todo), threads]) : 1,
  696. \ 'bar': '',
  697. \ 'fin': 0
  698. \ }
  699. call s:prepare()
  700. call append(0, ['', ''])
  701. normal! 2G
  702. silent! redraw
  703. let s:clone_opt = get(g:, 'plug_shallow', 1) ?
  704. \ '--depth 1' . (s:git_version_requirement(1, 7, 10) ? ' --no-single-branch' : '') : ''
  705. " Python version requirement (>= 2.7)
  706. if python && !has('python3') && !ruby && !s:nvim && s:update.threads > 1
  707. redir => pyv
  708. silent python import platform; print(platform.python_version())
  709. redir END
  710. let python = s:version_requirement(
  711. \ map(split(split(pyv)[0], '\.'), 'str2nr(v:val)'), [2, 6])
  712. endif
  713. if (python || ruby) && s:update.threads > 1
  714. try
  715. let imd = &imd
  716. if s:mac_gui
  717. set noimd
  718. endif
  719. if ruby
  720. call s:update_ruby()
  721. else
  722. call s:update_python()
  723. endif
  724. catch
  725. let lines = getline(4, '$')
  726. let printed = {}
  727. silent! 4,$d _
  728. for line in lines
  729. let name = s:extract_name(line, '.', '')
  730. if empty(name) || !has_key(printed, name)
  731. call append('$', line)
  732. if !empty(name)
  733. let printed[name] = 1
  734. if line[0] == 'x' && index(s:update.errors, name) < 0
  735. call add(s:update.errors, name)
  736. end
  737. endif
  738. endif
  739. endfor
  740. finally
  741. let &imd = imd
  742. call s:update_finish()
  743. endtry
  744. else
  745. call s:update_vim()
  746. endif
  747. endfunction
  748. function! s:update_finish()
  749. if exists('s:git_terminal_prompt')
  750. let $GIT_TERMINAL_PROMPT = s:git_terminal_prompt
  751. endif
  752. if s:switch_in()
  753. call s:do(s:update.pull, s:update.force, filter(copy(s:update.all), 'has_key(v:val, "do")'))
  754. call s:finish(s:update.pull)
  755. call setline(1, 'Updated. Elapsed time: ' . split(reltimestr(reltime(s:update.start)))[0] . ' sec.')
  756. call s:switch_out('normal! gg')
  757. endif
  758. endfunction
  759. function! s:job_abort()
  760. if !s:nvim || !exists('s:jobs')
  761. return
  762. endif
  763. for [name, j] in items(s:jobs)
  764. silent! call jobstop(j.jobid)
  765. if j.new
  766. call s:system('rm -rf ' . s:shellesc(g:plugs[name].dir))
  767. endif
  768. endfor
  769. let s:jobs = {}
  770. endfunction
  771. " When a:event == 'stdout', data = list of strings
  772. " When a:event == 'exit', data = returncode
  773. function! s:job_handler(job_id, data, event) abort
  774. if !s:plug_window_exists() " plug window closed
  775. return s:job_abort()
  776. endif
  777. if a:event == 'stdout'
  778. let self.result .= substitute(s:to_s(a:data), '[\r\n]', '', 'g') . "\n"
  779. " To reduce the number of buffer updates
  780. let self.tick = get(self, 'tick', -1) + 1
  781. if self.tick % len(s:jobs) == 0
  782. call s:log(self.new ? '+' : '*', self.name, self.result)
  783. endif
  784. elseif a:event == 'exit'
  785. let self.running = 0
  786. if a:data != 0
  787. let self.error = 1
  788. endif
  789. call s:reap(self.name)
  790. call s:tick()
  791. endif
  792. endfunction
  793. function! s:spawn(name, cmd, opts)
  794. let job = { 'name': a:name, 'running': 1, 'error': 0, 'result': '',
  795. \ 'new': get(a:opts, 'new', 0),
  796. \ 'on_stdout': function('s:job_handler'),
  797. \ 'on_exit' : function('s:job_handler'),
  798. \ }
  799. let s:jobs[a:name] = job
  800. if s:nvim
  801. let argv = [ 'sh', '-c',
  802. \ (has_key(a:opts, 'dir') ? s:with_cd(a:cmd, a:opts.dir) : a:cmd) ]
  803. let jid = jobstart(argv, job)
  804. if jid > 0
  805. let job.jobid = jid
  806. else
  807. let job.running = 0
  808. let job.error = 1
  809. let job.result = jid < 0 ? 'sh is not executable' :
  810. \ 'Invalid arguments (or job table is full)'
  811. endif
  812. else
  813. let params = has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]
  814. let job.result = call('s:system', params)
  815. let job.error = v:shell_error != 0
  816. let job.running = 0
  817. endif
  818. endfunction
  819. function! s:reap(name)
  820. let job = s:jobs[a:name]
  821. if job.error
  822. call add(s:update.errors, a:name)
  823. elseif get(job, 'new', 0)
  824. let s:update.new[a:name] = 1
  825. endif
  826. let s:update.bar .= job.error ? 'x' : '='
  827. call s:log(job.error ? 'x' : '-', a:name, job.result)
  828. call s:bar()
  829. call remove(s:jobs, a:name)
  830. endfunction
  831. function! s:bar()
  832. if s:switch_in()
  833. let total = len(s:update.all)
  834. call setline(1, (s:update.pull ? 'Updating' : 'Installing').
  835. \ ' plugins ('.len(s:update.bar).'/'.total.')')
  836. call s:progress_bar(2, s:update.bar, total)
  837. call s:switch_out()
  838. endif
  839. endfunction
  840. function! s:logpos(name)
  841. for i in range(1, line('$'))
  842. if getline(i) =~# '^[-+x*] '.a:name.':'
  843. return i
  844. endif
  845. endfor
  846. return 0
  847. endfunction
  848. function! s:log(bullet, name, lines)
  849. if s:switch_in()
  850. let pos = s:logpos(a:name)
  851. if pos > 0
  852. execute pos 'd _'
  853. if pos > winheight('.')
  854. let pos = 4
  855. endif
  856. else
  857. let pos = 4
  858. endif
  859. call append(pos - 1, s:format_message(a:bullet, a:name, a:lines))
  860. call s:switch_out()
  861. endif
  862. endfunction
  863. function! s:update_vim()
  864. let s:jobs = {}
  865. call s:bar()
  866. call s:tick()
  867. endfunction
  868. function! s:tick()
  869. let pull = s:update.pull
  870. let prog = s:progress_opt(s:nvim)
  871. while 1 " Without TCO, Vim stack is bound to explode
  872. if empty(s:update.todo)
  873. if empty(s:jobs) && !s:update.fin
  874. let s:update.fin = 1
  875. call s:update_finish()
  876. endif
  877. return
  878. endif
  879. let name = keys(s:update.todo)[0]
  880. let spec = remove(s:update.todo, name)
  881. let new = !isdirectory(spec.dir)
  882. call s:log(new ? '+' : '*', name, pull ? 'Updating ...' : 'Installing ...')
  883. redraw
  884. let has_tag = has_key(spec, 'tag')
  885. let checkout = s:shellesc(has_tag ? spec.tag : spec.branch)
  886. let merge = s:shellesc(has_tag ? spec.tag : 'origin/'.spec.branch)
  887. if !new
  888. let [valid, msg] = s:git_valid(spec, 0)
  889. if valid
  890. if pull
  891. let fetch_opt = (has_tag && !empty(globpath(spec.dir, '.git/shallow'))) ? '--depth 99999999' : ''
  892. call s:spawn(name,
  893. \ 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)',
  894. \ fetch_opt, prog, checkout, merge), { 'dir': spec.dir })
  895. else
  896. let s:jobs[name] = { 'running': 0, 'result': 'Already installed', 'error': 0 }
  897. endif
  898. else
  899. let s:jobs[name] = { 'running': 0, 'result': msg, 'error': 1 }
  900. endif
  901. else
  902. call s:spawn(name,
  903. \ printf('git clone %s %s --recursive %s -b %s %s 2>&1',
  904. \ has_tag ? '' : s:clone_opt,
  905. \ prog,
  906. \ s:shellesc(spec.uri),
  907. \ checkout,
  908. \ s:shellesc(s:trim(spec.dir))), { 'new': 1 })
  909. endif
  910. if !s:jobs[name].running
  911. call s:reap(name)
  912. endif
  913. if len(s:jobs) >= s:update.threads
  914. break
  915. endif
  916. endwhile
  917. endfunction
  918. function! s:update_python()
  919. let py_exe = has('python3') ? 'python3' : 'python'
  920. execute py_exe "<< EOF"
  921. """ Due to use of signals this function is POSIX only. """
  922. import datetime
  923. import functools
  924. import os
  925. try:
  926. import queue
  927. except ImportError:
  928. import Queue as queue
  929. import random
  930. import re
  931. import shutil
  932. import signal
  933. import subprocess
  934. import tempfile
  935. import threading as thr
  936. import time
  937. import traceback
  938. import vim
  939. G_NVIM = vim.eval("has('nvim')") == '1'
  940. G_PULL = vim.eval('s:update.pull') == '1'
  941. G_RETRIES = int(vim.eval('get(g:, "plug_retries", 2)')) + 1
  942. G_TIMEOUT = int(vim.eval('get(g:, "plug_timeout", 60)'))
  943. G_CLONE_OPT = vim.eval('s:clone_opt')
  944. G_PROGRESS = vim.eval('s:progress_opt(1)')
  945. G_LOG_PROB = 1.0 / int(vim.eval('s:update.threads'))
  946. G_STOP = thr.Event()
  947. G_THREADS = {}
  948. class PlugError(Exception):
  949. def __init__(self, msg):
  950. self._msg = msg
  951. @property
  952. def msg(self):
  953. return self._msg
  954. class CmdTimedOut(PlugError):
  955. pass
  956. class CmdFailed(PlugError):
  957. pass
  958. class InvalidURI(PlugError):
  959. pass
  960. class Action(object):
  961. INSTALL, UPDATE, ERROR, DONE = ['+', '*', 'x', '-']
  962. class Buffer(object):
  963. def __init__(self, lock, num_plugs, is_pull, is_win):
  964. self.bar = ''
  965. self.event = 'Updating' if is_pull else 'Installing'
  966. self.is_win = is_win
  967. self.lock = lock
  968. self.maxy = int(vim.eval('winheight(".")'))
  969. self.num_plugs = num_plugs
  970. def __where(self, name):
  971. """ Find first line with name in current buffer. Return line num. """
  972. found, lnum = False, 0
  973. matcher = re.compile('^[-+x*] {0}:'.format(name))
  974. for line in vim.current.buffer:
  975. if matcher.search(line) is not None:
  976. found = True
  977. break
  978. lnum += 1
  979. if not found:
  980. lnum = -1
  981. return lnum
  982. def header(self):
  983. curbuf = vim.current.buffer
  984. curbuf[0] = self.event + ' plugins ({0}/{1})'.format(len(self.bar), self.num_plugs)
  985. num_spaces = self.num_plugs - len(self.bar)
  986. curbuf[1] = '[{0}{1}]'.format(self.bar, num_spaces * ' ')
  987. with self.lock:
  988. vim.command('normal! 2G')
  989. if not self.is_win:
  990. vim.command('redraw')
  991. def write(self, action, name, lines):
  992. first, rest = lines[0], lines[1:]
  993. msg = ['{0} {1}{2}{3}'.format(action, name, ': ' if first else '', first)]
  994. msg.extend([' ' + line for line in rest])
  995. try:
  996. if action == Action.ERROR:
  997. self.bar += 'x'
  998. vim.command("call add(s:update.errors, '{0}')".format(name))
  999. elif action == Action.DONE:
  1000. self.bar += '='
  1001. curbuf = vim.current.buffer
  1002. lnum = self.__where(name)
  1003. if lnum != -1: # Found matching line num
  1004. del curbuf[lnum]
  1005. if lnum > self.maxy and action in set([Action.INSTALL, Action.UPDATE]):
  1006. lnum = 3
  1007. else:
  1008. lnum = 3
  1009. curbuf.append(msg, lnum)
  1010. self.header()
  1011. except vim.error:
  1012. pass
  1013. class Command(object):
  1014. def __init__(self, cmd, cmd_dir=None, timeout=60, cb=None, clean=None):
  1015. self.cmd = cmd
  1016. self.cmd_dir = cmd_dir
  1017. self.timeout = timeout
  1018. self.callback = cb if cb else (lambda msg: None)
  1019. self.clean = clean if clean else (lambda: None)
  1020. self.proc = None
  1021. @property
  1022. def alive(self):
  1023. """ Returns true only if command still running. """
  1024. return self.proc and self.proc.poll() is None
  1025. def execute(self, ntries=3):
  1026. """ Execute the command with ntries if CmdTimedOut.
  1027. Returns the output of the command if no Exception.
  1028. """
  1029. attempt, finished, limit = 0, False, self.timeout
  1030. while not finished:
  1031. try:
  1032. attempt += 1
  1033. result = self.try_command()
  1034. finished = True
  1035. return result
  1036. except CmdTimedOut:
  1037. if attempt != ntries:
  1038. self.notify_retry()
  1039. self.timeout += limit
  1040. else:
  1041. raise
  1042. def notify_retry(self):
  1043. """ Retry required for command, notify user. """
  1044. for count in range(3, 0, -1):
  1045. if G_STOP.is_set():
  1046. raise KeyboardInterrupt
  1047. msg = 'Timeout. Will retry in {0} second{1} ...'.format(
  1048. count, 's' if count != 1 else '')
  1049. self.callback([msg])
  1050. time.sleep(1)
  1051. self.callback(['Retrying ...'])
  1052. def try_command(self):
  1053. """ Execute a cmd & poll for callback. Returns list of output.
  1054. Raises CmdFailed -> return code for Popen isn't 0
  1055. Raises CmdTimedOut -> command exceeded timeout without new output
  1056. """
  1057. first_line = True
  1058. try:
  1059. tfile = tempfile.NamedTemporaryFile(mode='w+b')
  1060. self.proc = subprocess.Popen(self.cmd, cwd=self.cmd_dir, stdout=tfile,
  1061. stderr=subprocess.STDOUT, shell=True,
  1062. preexec_fn=os.setsid)
  1063. thrd = thr.Thread(target=(lambda proc: proc.wait()), args=(self.proc,))
  1064. thrd.start()
  1065. thread_not_started = True
  1066. while thread_not_started:
  1067. try:
  1068. thrd.join(0.1)
  1069. thread_not_started = False
  1070. except RuntimeError:
  1071. pass
  1072. while self.alive:
  1073. if G_STOP.is_set():
  1074. raise KeyboardInterrupt
  1075. if first_line or random.random() < G_LOG_PROB:
  1076. first_line = False
  1077. line = nonblock_read(tfile.name)
  1078. if line:
  1079. self.callback([line])
  1080. time_diff = time.time() - os.path.getmtime(tfile.name)
  1081. if time_diff > self.timeout:
  1082. raise CmdTimedOut(['Timeout!'])
  1083. thrd.join(0.5)
  1084. tfile.seek(0)
  1085. result = [line.decode('utf-8', 'replace').rstrip() for line in tfile]
  1086. if self.proc.returncode != 0:
  1087. raise CmdFailed([''] + result)
  1088. return result
  1089. except:
  1090. self.terminate()
  1091. raise
  1092. def terminate(self):
  1093. """ Terminate process and cleanup. """
  1094. if self.alive:
  1095. os.killpg(self.proc.pid, signal.SIGTERM)
  1096. self.clean()
  1097. class Plugin(object):
  1098. def __init__(self, name, args, buf_q, lock):
  1099. self.name = name
  1100. self.args = args
  1101. self.buf_q = buf_q
  1102. self.lock = lock
  1103. tag = args.get('tag', 0)
  1104. self.checkout = esc(tag if tag else args['branch'])
  1105. self.merge = esc(tag if tag else 'origin/' + args['branch'])
  1106. self.tag = tag
  1107. def manage(self):
  1108. try:
  1109. if os.path.exists(self.args['dir']):
  1110. self.update()
  1111. else:
  1112. self.install()
  1113. with self.lock:
  1114. thread_vim_command("let s:update.new['{0}'] = 1".format(self.name))
  1115. except PlugError as exc:
  1116. self.write(Action.ERROR, self.name, exc.msg)
  1117. except KeyboardInterrupt:
  1118. G_STOP.set()
  1119. self.write(Action.ERROR, self.name, ['Interrupted!'])
  1120. except:
  1121. # Any exception except those above print stack trace
  1122. msg = 'Trace:\n{0}'.format(traceback.format_exc().rstrip())
  1123. self.write(Action.ERROR, self.name, msg.split('\n'))
  1124. raise
  1125. def install(self):
  1126. target = self.args['dir']
  1127. def clean(target):
  1128. def _clean():
  1129. try:
  1130. shutil.rmtree(target)
  1131. except OSError:
  1132. pass
  1133. return _clean
  1134. self.write(Action.INSTALL, self.name, ['Installing ...'])
  1135. callback = functools.partial(self.write, Action.INSTALL, self.name)
  1136. cmd = 'git clone {0} {1} --recursive {2} -b {3} {4} 2>&1'.format(
  1137. '' if self.tag else G_CLONE_OPT, G_PROGRESS, self.args['uri'],
  1138. self.checkout, esc(target))
  1139. com = Command(cmd, None, G_TIMEOUT, callback, clean(target))
  1140. result = com.execute(G_RETRIES)
  1141. self.write(Action.DONE, self.name, result[-1:])
  1142. def repo_uri(self):
  1143. cmd = 'git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url'
  1144. command = Command(cmd, self.args['dir'], G_TIMEOUT,)
  1145. result = command.execute(G_RETRIES)
  1146. return result[-1]
  1147. def update(self):
  1148. match = re.compile(r'git::?@')
  1149. actual_uri = re.sub(match, '', self.repo_uri())
  1150. expect_uri = re.sub(match, '', self.args['uri'])
  1151. if actual_uri != expect_uri:
  1152. msg = ['',
  1153. 'Invalid URI: {0}'.format(actual_uri),
  1154. 'Expected {0}'.format(expect_uri),
  1155. 'PlugClean required.']
  1156. raise InvalidURI(msg)
  1157. if G_PULL:
  1158. self.write(Action.UPDATE, self.name, ['Updating ...'])
  1159. callback = functools.partial(self.write, Action.UPDATE, self.name)
  1160. fetch_opt = '--depth 99999999' if self.tag and os.path.isfile(os.path.join(self.args['dir'], '.git/shallow')) else ''
  1161. cmds = ['git fetch {0} {1}'.format(fetch_opt, G_PROGRESS),
  1162. 'git checkout -q {0}'.format(self.checkout),
  1163. 'git merge --ff-only {0}'.format(self.merge),
  1164. 'git submodule update --init --recursive']
  1165. cmd = ' 2>&1 && '.join(cmds)
  1166. com = Command(cmd, self.args['dir'], G_TIMEOUT, callback)
  1167. result = com.execute(G_RETRIES)
  1168. self.write(Action.DONE, self.name, result[-1:])
  1169. else:
  1170. self.write(Action.DONE, self.name, ['Already installed'])
  1171. def write(self, action, name, msg):
  1172. self.buf_q.put((action, name, msg))
  1173. class PlugThread(thr.Thread):
  1174. def __init__(self, tname, args):
  1175. super(PlugThread, self).__init__()
  1176. self.tname = tname
  1177. self.args = args
  1178. def run(self):
  1179. thr.current_thread().name = self.tname
  1180. buf_q, work_q, lock = self.args
  1181. try:
  1182. while not G_STOP.is_set():
  1183. name, args = work_q.get_nowait()
  1184. plug = Plugin(name, args, buf_q, lock)
  1185. plug.manage()
  1186. work_q.task_done()
  1187. except queue.Empty:
  1188. pass
  1189. finally:
  1190. global G_THREADS
  1191. with lock:
  1192. del G_THREADS[thr.current_thread().name]
  1193. class RefreshThread(thr.Thread):
  1194. def __init__(self, lock):
  1195. super(RefreshThread, self).__init__()
  1196. self.lock = lock
  1197. self.running = True
  1198. def run(self):
  1199. while self.running:
  1200. with self.lock:
  1201. thread_vim_command('noautocmd normal! a')
  1202. time.sleep(0.33)
  1203. def stop(self):
  1204. self.running = False
  1205. if G_NVIM:
  1206. def thread_vim_command(cmd):
  1207. vim.session.threadsafe_call(lambda: vim.command(cmd))
  1208. else:
  1209. def thread_vim_command(cmd):
  1210. vim.command(cmd)
  1211. def esc(name):
  1212. return '"' + name.replace('"', '\"') + '"'
  1213. def nonblock_read(fname):
  1214. """ Read a file with nonblock flag. Return the last line. """
  1215. fread = os.open(fname, os.O_RDONLY | os.O_NONBLOCK)
  1216. buf = os.read(fread, 100000).decode('utf-8', 'replace')
  1217. os.close(fread)
  1218. line = buf.rstrip('\r\n')
  1219. left = max(line.rfind('\r'), line.rfind('\n'))
  1220. if left != -1:
  1221. left += 1
  1222. line = line[left:]
  1223. return line
  1224. def main():
  1225. thr.current_thread().name = 'main'
  1226. nthreads = int(vim.eval('s:update.threads'))
  1227. plugs = vim.eval('s:update.todo')
  1228. mac_gui = vim.eval('s:mac_gui') == '1'
  1229. is_win = vim.eval('s:is_win') == '1'
  1230. lock = thr.Lock()
  1231. buf = Buffer(lock, len(plugs), G_PULL, is_win)
  1232. buf_q, work_q = queue.Queue(), queue.Queue()
  1233. for work in plugs.items():
  1234. work_q.put(work)
  1235. global G_THREADS
  1236. for num in range(nthreads):
  1237. tname = 'PlugT-{0:02}'.format(num)
  1238. thread = PlugThread(tname, (buf_q, work_q, lock))
  1239. thread.start()
  1240. G_THREADS[tname] = thread
  1241. if mac_gui:
  1242. rthread = RefreshThread(lock)
  1243. rthread.start()
  1244. while not buf_q.empty() or len(G_THREADS) != 0:
  1245. try:
  1246. action, name, msg = buf_q.get(True, 0.25)
  1247. buf.write(action, name, msg)
  1248. buf_q.task_done()
  1249. except queue.Empty:
  1250. pass
  1251. except KeyboardInterrupt:
  1252. G_STOP.set()
  1253. if mac_gui:
  1254. rthread.stop()
  1255. rthread.join()
  1256. main()
  1257. EOF
  1258. endfunction
  1259. function! s:update_ruby()
  1260. ruby << EOF
  1261. module PlugStream
  1262. SEP = ["\r", "\n", nil]
  1263. def get_line
  1264. buffer = ''
  1265. loop do
  1266. char = readchar rescue return
  1267. if SEP.include? char.chr
  1268. buffer << $/
  1269. break
  1270. else
  1271. buffer << char
  1272. end
  1273. end
  1274. buffer
  1275. end
  1276. end unless defined?(PlugStream)
  1277. def esc arg
  1278. %["#{arg.gsub('"', '\"')}"]
  1279. end
  1280. def killall pid
  1281. pids = [pid]
  1282. unless `which pgrep 2> /dev/null`.empty?
  1283. children = pids
  1284. until children.empty?
  1285. children = children.map { |pid|
  1286. `pgrep -P #{pid}`.lines.map { |l| l.chomp }
  1287. }.flatten
  1288. pids += children
  1289. end
  1290. end
  1291. pids.each { |pid| Process.kill 'TERM', pid.to_i rescue nil }
  1292. end
  1293. require 'thread'
  1294. require 'fileutils'
  1295. require 'timeout'
  1296. running = true
  1297. iswin = VIM::evaluate('s:is_win').to_i == 1
  1298. pull = VIM::evaluate('s:update.pull').to_i == 1
  1299. base = VIM::evaluate('g:plug_home')
  1300. all = VIM::evaluate('s:update.todo')
  1301. limit = VIM::evaluate('get(g:, "plug_timeout", 60)')
  1302. tries = VIM::evaluate('get(g:, "plug_retries", 2)') + 1
  1303. nthr = VIM::evaluate('s:update.threads').to_i
  1304. maxy = VIM::evaluate('winheight(".")').to_i
  1305. cd = iswin ? 'cd /d' : 'cd'
  1306. tot = VIM::evaluate('len(s:update.todo)') || 0
  1307. bar = ''
  1308. skip = 'Already installed'
  1309. mtx = Mutex.new
  1310. take1 = proc { mtx.synchronize { running && all.shift } }
  1311. logh = proc {
  1312. cnt = bar.length
  1313. $curbuf[1] = "#{pull ? 'Updating' : 'Installing'} plugins (#{cnt}/#{tot})"
  1314. $curbuf[2] = '[' + bar.ljust(tot) + ']'
  1315. VIM::command('normal! 2G')
  1316. VIM::command('redraw') unless iswin
  1317. }
  1318. where = proc { |name| (1..($curbuf.length)).find { |l| $curbuf[l] =~ /^[-+x*] #{name}:/ } }
  1319. log = proc { |name, result, type|
  1320. mtx.synchronize do
  1321. ing = ![true, false].include?(type)
  1322. bar += type ? '=' : 'x' unless ing
  1323. b = case type
  1324. when :install then '+' when :update then '*'
  1325. when true, nil then '-' else
  1326. VIM::command("call add(s:update.errors, '#{name}')")
  1327. 'x'
  1328. end
  1329. result =
  1330. if type || type.nil?
  1331. ["#{b} #{name}: #{result.lines.to_a.last}"]
  1332. elsif result =~ /^Interrupted|^Timeout/
  1333. ["#{b} #{name}: #{result}"]
  1334. else
  1335. ["#{b} #{name}"] + result.lines.map { |l| " " << l }
  1336. end
  1337. if lnum = where.call(name)
  1338. $curbuf.delete lnum
  1339. lnum = 4 if ing && lnum > maxy
  1340. end
  1341. result.each_with_index do |line, offset|
  1342. $curbuf.append((lnum || 4) - 1 + offset, line.gsub(/\e\[./, '').chomp)
  1343. end
  1344. logh.call
  1345. end
  1346. }
  1347. bt = proc { |cmd, name, type, cleanup|
  1348. tried = timeout = 0
  1349. begin
  1350. tried += 1
  1351. timeout += limit
  1352. fd = nil
  1353. data = ''
  1354. if iswin
  1355. Timeout::timeout(timeout) do
  1356. tmp = VIM::evaluate('tempname()')
  1357. system("(#{cmd}) > #{tmp}")
  1358. data = File.read(tmp).chomp
  1359. File.unlink tmp rescue nil
  1360. end
  1361. else
  1362. fd = IO.popen(cmd).extend(PlugStream)
  1363. first_line = true
  1364. log_prob = 1.0 / nthr
  1365. while line = Timeout::timeout(timeout) { fd.get_line }
  1366. data << line
  1367. log.call name, line.chomp, type if name && (first_line || rand < log_prob)
  1368. first_line = false
  1369. end
  1370. fd.close
  1371. end
  1372. [$? == 0, data.chomp]
  1373. rescue Timeout::Error, Interrupt => e
  1374. if fd && !fd.closed?
  1375. killall fd.pid
  1376. fd.close
  1377. end
  1378. cleanup.call if cleanup
  1379. if e.is_a?(Timeout::Error) && tried < tries
  1380. 3.downto(1) do |countdown|
  1381. s = countdown > 1 ? 's' : ''
  1382. log.call name, "Timeout. Will retry in #{countdown} second#{s} ...", type
  1383. sleep 1
  1384. end
  1385. log.call name, 'Retrying ...', type
  1386. retry
  1387. end
  1388. [false, e.is_a?(Interrupt) ? "Interrupted!" : "Timeout!"]
  1389. end
  1390. }
  1391. main = Thread.current
  1392. threads = []
  1393. watcher = Thread.new {
  1394. while VIM::evaluate('getchar(1)')
  1395. sleep 0.1
  1396. end
  1397. mtx.synchronize do
  1398. running = false
  1399. threads.each { |t| t.raise Interrupt }
  1400. end
  1401. threads.each { |t| t.join rescue nil }
  1402. main.kill
  1403. }
  1404. refresh = Thread.new {
  1405. while true
  1406. mtx.synchronize do
  1407. break unless running
  1408. VIM::command('noautocmd normal! a')
  1409. end
  1410. sleep 0.2
  1411. end
  1412. } if VIM::evaluate('s:mac_gui') == 1
  1413. clone_opt = VIM::evaluate('s:clone_opt')
  1414. progress = VIM::evaluate('s:progress_opt(1)')
  1415. nthr.times do
  1416. mtx.synchronize do
  1417. threads << Thread.new {
  1418. while pair = take1.call
  1419. name = pair.first
  1420. dir, uri, branch, tag = pair.last.values_at *%w[dir uri branch tag]
  1421. checkout = esc(tag ? tag : branch)
  1422. merge = esc(tag ? tag : "origin/#{branch}")
  1423. subm = "git submodule update --init --recursive 2>&1"
  1424. exists = File.directory? dir
  1425. ok, result =
  1426. if exists
  1427. dir = iswin ? dir : esc(dir)
  1428. ret, data = bt.call "#{cd} #{dir} && git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url", nil, nil, nil
  1429. current_uri = data.lines.to_a.last
  1430. if !ret
  1431. if data =~ /^Interrupted|^Timeout/
  1432. [false, data]
  1433. else
  1434. [false, [data.chomp, "PlugClean required."].join($/)]
  1435. end
  1436. elsif current_uri.sub(/git::?@/, '') != uri.sub(/git::?@/, '')
  1437. [false, ["Invalid URI: #{current_uri}",
  1438. "Expected: #{uri}",
  1439. "PlugClean required."].join($/)]
  1440. else
  1441. if pull
  1442. log.call name, 'Updating ...', :update
  1443. fetch_opt = (tag && File.exist?(File.join(dir, '.git/shallow'))) ? '--depth 99999999' : ''
  1444. 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
  1445. else
  1446. [true, skip]
  1447. end
  1448. end
  1449. else
  1450. d = esc dir.sub(%r{[\\/]+$}, '')
  1451. log.call name, 'Installing ...', :install
  1452. bt.call "git clone #{clone_opt unless tag} #{progress} --recursive #{uri} -b #{checkout} #{d} 2>&1", name, :install, proc {
  1453. FileUtils.rm_rf dir
  1454. }
  1455. end
  1456. mtx.synchronize { VIM::command("let s:update.new['#{name}'] = 1") } if !exists && ok
  1457. log.call name, result, ok
  1458. end
  1459. } if running
  1460. end
  1461. end
  1462. threads.each { |t| t.join rescue nil }
  1463. logh.call
  1464. refresh.kill if refresh
  1465. watcher.kill
  1466. EOF
  1467. endfunction
  1468. function! s:shellesc(arg)
  1469. return '"'.escape(a:arg, '"').'"'
  1470. endfunction
  1471. function! s:glob_dir(path)
  1472. return map(filter(s:lines(globpath(a:path, '**')), 'isdirectory(v:val)'), 's:dirpath(v:val)')
  1473. endfunction
  1474. function! s:progress_bar(line, bar, total)
  1475. call setline(a:line, '[' . s:lpad(a:bar, a:total) . ']')
  1476. endfunction
  1477. function! s:compare_git_uri(a, b)
  1478. let a = substitute(a:a, 'git:\{1,2}@', '', '')
  1479. let b = substitute(a:b, 'git:\{1,2}@', '', '')
  1480. return a ==# b
  1481. endfunction
  1482. function! s:format_message(bullet, name, message)
  1483. if a:bullet != 'x'
  1484. return [printf('%s %s: %s', a:bullet, a:name, s:lastline(a:message))]
  1485. else
  1486. let lines = map(s:lines(a:message), '" ".v:val')
  1487. return extend([printf('x %s:', a:name)], lines)
  1488. endif
  1489. endfunction
  1490. function! s:with_cd(cmd, dir)
  1491. return printf('cd%s %s && %s', s:is_win ? ' /d' : '', s:shellesc(a:dir), a:cmd)
  1492. endfunction
  1493. function! s:system(cmd, ...)
  1494. try
  1495. let [sh, shrd] = [&shell, &shellredir]
  1496. if !s:is_win
  1497. set shell=sh shellredir=>%s\ 2>&1
  1498. endif
  1499. let cmd = a:0 > 0 ? s:with_cd(a:cmd, a:1) : a:cmd
  1500. return system(s:is_win ? '('.cmd.')' : cmd)
  1501. finally
  1502. let [&shell, &shellredir] = [sh, shrd]
  1503. endtry
  1504. endfunction
  1505. function! s:system_chomp(...)
  1506. let ret = call('s:system', a:000)
  1507. return v:shell_error ? '' : substitute(ret, '\n$', '', '')
  1508. endfunction
  1509. function! s:git_valid(spec, check_branch)
  1510. let ret = 1
  1511. let msg = 'OK'
  1512. if isdirectory(a:spec.dir)
  1513. let result = s:lines(s:system('git rev-parse --abbrev-ref HEAD 2>&1 && git config remote.origin.url', a:spec.dir))
  1514. let remote = result[-1]
  1515. if v:shell_error
  1516. let msg = join([remote, 'PlugClean required.'], "\n")
  1517. let ret = 0
  1518. elseif !s:compare_git_uri(remote, a:spec.uri)
  1519. let msg = join(['Invalid URI: '.remote,
  1520. \ 'Expected: '.a:spec.uri,
  1521. \ 'PlugClean required.'], "\n")
  1522. let ret = 0
  1523. elseif a:check_branch
  1524. let branch = result[0]
  1525. " Check tag
  1526. if has_key(a:spec, 'tag')
  1527. let tag = s:system_chomp('git describe --exact-match --tags HEAD 2>&1', a:spec.dir)
  1528. if a:spec.tag !=# tag
  1529. let msg = printf('Invalid tag: %s (expected: %s). Try PlugUpdate.',
  1530. \ (empty(tag) ? 'N/A' : tag), a:spec.tag)
  1531. let ret = 0
  1532. endif
  1533. " Check branch
  1534. elseif a:spec.branch !=# branch
  1535. let msg = printf('Invalid branch: %s (expected: %s). Try PlugUpdate.',
  1536. \ branch, a:spec.branch)
  1537. let ret = 0
  1538. endif
  1539. endif
  1540. else
  1541. let msg = 'Not found'
  1542. let ret = 0
  1543. endif
  1544. return [ret, msg]
  1545. endfunction
  1546. function! s:rm_rf(dir)
  1547. if isdirectory(a:dir)
  1548. call s:system((s:is_win ? 'rmdir /S /Q ' : 'rm -rf ') . s:shellesc(a:dir))
  1549. endif
  1550. endfunction
  1551. function! s:clean(force)
  1552. call s:prepare()
  1553. call append(0, 'Searching for unused plugins in '.g:plug_home)
  1554. call append(1, '')
  1555. " List of valid directories
  1556. let dirs = []
  1557. let [cnt, total] = [0, len(g:plugs)]
  1558. for [name, spec] in items(g:plugs)
  1559. if !s:is_managed(name) || s:git_valid(spec, 0)[0]
  1560. call add(dirs, spec.dir)
  1561. endif
  1562. let cnt += 1
  1563. call s:progress_bar(2, repeat('=', cnt), total)
  1564. normal! 2G
  1565. redraw
  1566. endfor
  1567. let allowed = {}
  1568. for dir in dirs
  1569. let allowed[s:dirpath(fnamemodify(dir, ':h:h'))] = 1
  1570. let allowed[dir] = 1
  1571. for child in s:glob_dir(dir)
  1572. let allowed[child] = 1
  1573. endfor
  1574. endfor
  1575. let todo = []
  1576. let found = sort(s:glob_dir(g:plug_home))
  1577. while !empty(found)
  1578. let f = remove(found, 0)
  1579. if !has_key(allowed, f) && isdirectory(f)
  1580. call add(todo, f)
  1581. call append(line('$'), '- ' . f)
  1582. let found = filter(found, 'stridx(v:val, f) != 0')
  1583. end
  1584. endwhile
  1585. normal! G
  1586. redraw
  1587. if empty(todo)
  1588. call append(line('$'), 'Already clean.')
  1589. else
  1590. call inputsave()
  1591. let yes = a:force || (input('Proceed? (y/N) ') =~? '^y')
  1592. call inputrestore()
  1593. if yes
  1594. for dir in todo
  1595. call s:rm_rf(dir)
  1596. endfor
  1597. call append(line('$'), 'Removed.')
  1598. else
  1599. call append(line('$'), 'Cancelled.')
  1600. endif
  1601. endif
  1602. normal! G
  1603. endfunction
  1604. function! s:upgrade()
  1605. echo 'Downloading the latest version of vim-plug'
  1606. redraw
  1607. let tmp = tempname()
  1608. let new = tmp . '/plug.vim'
  1609. try
  1610. let out = s:system(printf('git clone --depth 1 %s %s', s:plug_src, tmp))
  1611. if v:shell_error
  1612. return s:err('Error upgrading vim-plug: '. out)
  1613. endif
  1614. if readfile(s:me) ==# readfile(new)
  1615. echo 'vim-plug is already up-to-date'
  1616. return 0
  1617. else
  1618. call rename(s:me, s:me . '.old')
  1619. call rename(new, s:me)
  1620. unlet g:loaded_plug
  1621. echo 'vim-plug has been upgraded'
  1622. return 1
  1623. endif
  1624. finally
  1625. silent! call s:rm_rf(tmp)
  1626. endtry
  1627. endfunction
  1628. function! s:upgrade_specs()
  1629. for spec in values(g:plugs)
  1630. let spec.frozen = get(spec, 'frozen', 0)
  1631. endfor
  1632. endfunction
  1633. function! s:status()
  1634. call s:prepare()
  1635. call append(0, 'Checking plugins')
  1636. call append(1, '')
  1637. let ecnt = 0
  1638. let unloaded = 0
  1639. let [cnt, total] = [0, len(g:plugs)]
  1640. for [name, spec] in items(g:plugs)
  1641. if has_key(spec, 'uri')
  1642. if isdirectory(spec.dir)
  1643. let [valid, msg] = s:git_valid(spec, 1)
  1644. else
  1645. let [valid, msg] = [0, 'Not found. Try PlugInstall.']
  1646. endif
  1647. else
  1648. if isdirectory(spec.dir)
  1649. let [valid, msg] = [1, 'OK']
  1650. else
  1651. let [valid, msg] = [0, 'Not found.']
  1652. endif
  1653. endif
  1654. let cnt += 1
  1655. let ecnt += !valid
  1656. " `s:loaded` entry can be missing if PlugUpgraded
  1657. if valid && get(s:loaded, name, -1) == 0
  1658. let unloaded = 1
  1659. let msg .= ' (not loaded)'
  1660. endif
  1661. call s:progress_bar(2, repeat('=', cnt), total)
  1662. call append(3, s:format_message(valid ? '-' : 'x', name, msg))
  1663. normal! 2G
  1664. redraw
  1665. endfor
  1666. call setline(1, 'Finished. '.ecnt.' error(s).')
  1667. normal! gg
  1668. setlocal nomodifiable
  1669. if unloaded
  1670. echo "Press 'L' on each line to load plugin, or 'U' to update"
  1671. nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1672. xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
  1673. end
  1674. endfunction
  1675. function! s:extract_name(str, prefix, suffix)
  1676. return matchstr(a:str, '^'.a:prefix.' \zs[^:]\+\ze:.*'.a:suffix.'$')
  1677. endfunction
  1678. function! s:status_load(lnum)
  1679. let line = getline(a:lnum)
  1680. let name = s:extract_name(line, '-', '(not loaded)')
  1681. if !empty(name)
  1682. call plug#load(name)
  1683. setlocal modifiable
  1684. call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
  1685. setlocal nomodifiable
  1686. endif
  1687. endfunction
  1688. function! s:status_update() range
  1689. let lines = getline(a:firstline, a:lastline)
  1690. let names = filter(map(lines, 's:extract_name(v:val, "[x-]", "")'), '!empty(v:val)')
  1691. if !empty(names)
  1692. echo
  1693. execute 'PlugUpdate' join(names)
  1694. endif
  1695. endfunction
  1696. function! s:is_preview_window_open()
  1697. silent! wincmd P
  1698. if &previewwindow
  1699. wincmd p
  1700. return 1
  1701. endif
  1702. return 0
  1703. endfunction
  1704. function! s:find_name(lnum)
  1705. for lnum in reverse(range(1, a:lnum))
  1706. let line = getline(lnum)
  1707. if empty(line)
  1708. return ''
  1709. endif
  1710. let name = s:extract_name(line, '-', '')
  1711. if !empty(name)
  1712. return name
  1713. endif
  1714. endfor
  1715. return ''
  1716. endfunction
  1717. function! s:preview_commit()
  1718. if b:plug_preview < 0
  1719. let b:plug_preview = !s:is_preview_window_open()
  1720. endif
  1721. let sha = matchstr(getline('.'), '\(^ \)\@<=[0-9a-z]\{7}')
  1722. if empty(sha)
  1723. return
  1724. endif
  1725. let name = s:find_name(line('.'))
  1726. if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
  1727. return
  1728. endif
  1729. execute 'pedit' sha
  1730. wincmd P
  1731. setlocal filetype=git buftype=nofile nobuflisted modifiable
  1732. execute 'silent read !cd' s:shellesc(g:plugs[name].dir) '&& git show --pretty=medium' sha
  1733. normal! gg"_dd
  1734. setlocal nomodifiable
  1735. nnoremap <silent> <buffer> q :q<cr>
  1736. wincmd p
  1737. endfunction
  1738. function! s:section(flags)
  1739. call search('\(^[x-] \)\@<=[^:]\+:', a:flags)
  1740. endfunction
  1741. function! s:diff()
  1742. call s:prepare()
  1743. call append(0, 'Collecting updated changes ...')
  1744. normal! gg
  1745. redraw
  1746. let cnt = 0
  1747. for [k, v] in items(g:plugs)
  1748. if !isdirectory(v.dir) || !s:is_managed(k)
  1749. continue
  1750. endif
  1751. let diff = s:system_chomp('git log --pretty=format:"%h %s (%cr)" "HEAD...HEAD@{1}"', v.dir)
  1752. if !empty(diff)
  1753. call append(1, '')
  1754. call append(2, '- '.k.':')
  1755. call append(3, map(s:lines(diff), '" ". v:val'))
  1756. let cnt += 1
  1757. normal! gg
  1758. redraw
  1759. endif
  1760. endfor
  1761. call setline(1, cnt == 0 ? 'No updates.' : 'Last update:')
  1762. nnoremap <silent> <buffer> <cr> :silent! call <SID>preview_commit()<cr>
  1763. nnoremap <silent> <buffer> o :silent! call <SID>preview_commit()<cr>
  1764. nnoremap <silent> <buffer> X :call <SID>revert()<cr>
  1765. normal! gg
  1766. setlocal nomodifiable
  1767. if cnt > 0
  1768. echo "Press 'X' on each block to revert the update"
  1769. endif
  1770. endfunction
  1771. function! s:revert()
  1772. let name = s:find_name(line('.'))
  1773. if empty(name) || !has_key(g:plugs, name) ||
  1774. \ input(printf('Revert the update of %s? (y/N) ', name)) !~? '^y'
  1775. return
  1776. endif
  1777. call s:system('git reset --hard HEAD@{1} && git checkout '.s:esc(g:plugs[name].branch), g:plugs[name].dir)
  1778. setlocal modifiable
  1779. normal! "_dap
  1780. setlocal nomodifiable
  1781. echo 'Reverted.'
  1782. endfunction
  1783. function! s:snapshot(...) abort
  1784. let home = get(s:, 'plug_home_org', g:plug_home)
  1785. let [type, var, header] = s:is_win ?
  1786. \ ['dosbatch', '%PLUG_HOME%',
  1787. \ ['@echo off', ':: Generated by vim-plug', ':: '.strftime("%c"), '',
  1788. \ ':: Make sure to PlugUpdate first', '', 'set PLUG_HOME='.home]] :
  1789. \ ['sh', '$PLUG_HOME',
  1790. \ ['#!/bin/sh', '# Generated by vim-plug', '# '.strftime("%c"), '',
  1791. \ 'vim +PlugUpdate +qa', '', 'PLUG_HOME='.s:esc(home)]]
  1792. call s:prepare()
  1793. execute 'setf' type
  1794. call append(0, header)
  1795. call append('$', '')
  1796. 1
  1797. redraw
  1798. let dirs = sort(map(values(filter(copy(g:plugs),
  1799. \'has_key(v:val, "uri") && isdirectory(v:val.dir)')), 'v:val.dir'))
  1800. let anchor = line('$') - 1
  1801. for dir in reverse(dirs)
  1802. let sha = s:system_chomp('git rev-parse --short HEAD', dir)
  1803. if !empty(sha)
  1804. call append(anchor, printf('cd %s && git reset --hard %s',
  1805. \ substitute(dir, '^\V'.escape(g:plug_home, '\'), var, ''), sha))
  1806. redraw
  1807. endif
  1808. endfor
  1809. if a:0 > 0
  1810. let fn = expand(a:1)
  1811. let fne = s:esc(fn)
  1812. call writefile(getline(1, '$'), fn)
  1813. if !s:is_win | call s:system('chmod +x ' . fne) | endif
  1814. echo 'Saved to '.a:1
  1815. silent execute 'e' fne
  1816. endif
  1817. endfunction
  1818. function! s:split_rtp()
  1819. return split(&rtp, '\\\@<!,')
  1820. endfunction
  1821. let s:first_rtp = s:escrtp(get(s:split_rtp(), 0, ''))
  1822. let s:last_rtp = s:escrtp(get(s:split_rtp(), -1, ''))
  1823. if exists('g:plugs')
  1824. let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
  1825. call s:upgrade_specs()
  1826. call s:define_commands()
  1827. endif
  1828. let &cpo = s:cpo_save
  1829. unlet s:cpo_save