1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 06:30:03 +08:00
SpaceVim/autoload/SpaceVim/api.vim
2021-09-19 22:23:23 +08:00

60 lines
1.7 KiB
VimL

"=============================================================================
" api.vim --- SpaceVim api
" Copyright (c) 2016-2021 Wang Shidong & Contributors
" Author: Wang Shidong < wsdjeg at 163.com >
" URL: https://spacevim.org
" License: GPLv3
"=============================================================================
""
" @section API, api
" SpaceVim contains a variety of public apis. To using the api, you need to
" make sure SpaceVim has been added to your &rtp. after that, you can use
" |SpaceVim#api#import| to import the API you need.
"
" @subsection usage
"
" This is just an example, and it works well in old version vim.
" >
" let s:json = SpaceVim#api#import('data#json')
" let rst = s:json.json_encode(onject)
" let rst = s:json.json_decode(string)
" <
"
" here is list of resources where SpaceVim comes from:
"
" - vital: https://github.com/vim-jp/vital.vim
let s:apis = {}
" the api itself is a dict, and it will be changed when user use the api. so
" every time when request a api, we should provide an clean api.
""
"@public
"Import API base the given {name}, and return the API object. for all
"available APIs please check |spacevim-api|
function! SpaceVim#api#import(name) abort
if has_key(s:apis, a:name)
return deepcopy(s:apis[a:name])
endif
let p = {}
try
let p = SpaceVim#api#{a:name}#get()
let s:apis[a:name] = deepcopy(p)
catch /^Vim\%((\a\+)\)\=:E117/
endtry
return p
endfunction
function! SpaceVim#api#register(name, api) abort
if !empty(SpaceVim#api#import(a:name))
echoerr '[SpaceVim api] Api : ' . a:name . ' already existed!'
else
let s:apis[a:name] = deepcopy(a:api)
endif
endfunction
" vim:set fdm=marker sw=2 nowrap: