IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge #5752 from justinmk/doc

Browse Source 
doc: api_info(), typval_encode.h
This commit is contained in:
Justin M. Keyes 2016-12-11 02:04:33 +01:00 committed by GitHub
commit 29e651515f
5 changed files with 28 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
runtime/doc/api.txt
View File

@ -49,15 +49,20 @@ Tabpage -> enum value kObjectTypeTabpage
==============================================================================
3. API metadata *api-metadata*
Nvim exposes metadata about the API as a Dictionary with the following keys:
Nvim exposes API metadata as a Dictionary. Some items are described below:
version Nvim version, API level/compatibility
functions API function signatures
types Custom handle types defined by Nvim
error_types Possible error types returned by API functions
version Nvim version, API level/compatibility
version.api_level Current API level
version.api_compatible API is backwards-compatible with this level
version.api_prerelease Declares the current API level as unstable >
(version.api_prerelease && fn.since == version.api_level)
functions API function signatures
{fn}.since API level where function {fn} was introduced
{fn}.deprecated_since API level where function {fn} was deprecated
types Custom handle types defined by Nvim
error_types Possible error types returned by API functions
This metadata is mostly useful for external programs accessing the API via
RPC, see |rpc-api|.
External programs ("clients") can use the metadata to discover the |rpc-api|.
==============================================================================
4. Buffer highlighting *api-highlights*

2
src/nvim/api/private/helpers.c
View File

@ -472,6 +472,8 @@ static inline void typval_encode_dict_end(EncodedData *const edata)
#define TYPVAL_ENCODE_CONV_RECURSE(val, conv_type) \
TYPVAL_ENCODE_CONV_NIL()
// object_convert_one_value()
// encode_vim_to_object()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(static, object, EncodedData *const, edata)
#undef TYPVAL_ENCODE_CONV_STRING

2
src/nvim/eval.c
View File

@ -18242,6 +18242,8 @@ void free_tv(typval_T *varp)
#define TYPVAL_ENCODE_CONV_RECURSE(ignored1, ignored2)
// nothing_convert_one_value()
// encode_vim_to_nothing()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(static, nothing, void *, ignored)
#undef TYPVAL_ENCODE_ALLOW_SPECIALS

8
src/nvim/eval/encode.c
View File

@ -383,6 +383,8 @@ int encode_read_from_list(ListReaderState *const state, char *const buf,
#define TYPVAL_ENCODE_ALLOW_SPECIALS false
// string_convert_one_value()
// encode_vim_to_string()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(static, string, garray_T *const, gap)
#undef TYPVAL_ENCODE_CONV_RECURSE
@ -413,6 +415,8 @@ TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(static, string, garray_T *const, gap)
return OK; \
} while (0)
// echo_convert_one_value()
// encode_vim_to_echo()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(, echo, garray_T *const, gap)
#undef TYPVAL_ENCODE_CONV_RECURSE
@ -704,6 +708,8 @@ bool encode_check_json_key(const typval_T *const tv)
} \
} while (0)
// json_convert_one_value()
// encode_vim_to_json()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(static, json, garray_T *const, gap)
#undef TYPVAL_ENCODE_CONV_STRING
@ -886,6 +892,8 @@ char *encode_tv2json(typval_T *tv, size_t *len)
#define TYPVAL_ENCODE_ALLOW_SPECIALS true
// msgpack_convert_one_value()
// encode_vim_to_msgpack()
TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(, msgpack, msgpack_packer *const, packer)
#undef TYPVAL_ENCODE_CONV_STRING

8
src/nvim/eval/typval_encode.h
View File

@ -212,10 +212,9 @@ static inline size_t tv_strlen(const typval_T *const tv)
: strlen((char *) tv->vval.v_string));
}
/// Define functions which convert VimL value to something else
///
/// Creates function `vim_to_{name}(firstargtype firstargname, typval_T *const
/// tv)` which returns OK or FAIL and helper functions.
/// Define functions to convert a VimL value:
/// `{name}_convert_one_value(...)`
/// `encode_vim_to_{name}(...)`
///
/// @param scope Scope of the main function: either nothing or `static`.
/// @param name Name of the target converter.
@ -224,6 +223,7 @@ static inline size_t tv_strlen(const typval_T *const tv)
/// @param firstargname Name of the first argument.
#define TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(scope, name, firstargtype, \
firstargname) \
/* Returns OK or FAIL */ \
static int name##_convert_one_value(firstargtype firstargname, \
MPConvStack *const mpstack, \
typval_T *const tv, \