diff options
author | Thiago de Arruda <tpadilha84@gmail.com> | 2014-05-07 17:59:16 -0300 |
---|---|---|
committer | Thiago de Arruda <tpadilha84@gmail.com> | 2014-05-12 19:28:30 -0300 |
commit | b3268d071277c8967b3e3ecb60430718e1f36472 (patch) | |
tree | 37fbdeb52835cd3fff0648301292aec12f25bb12 /src/api/vim.h | |
parent | fc22317389fa8713f27f5a754ee142ae003f5871 (diff) | |
download | rneovim-b3268d071277c8967b3e3ecb60430718e1f36472.tar.gz rneovim-b3268d071277c8967b3e3ecb60430718e1f36472.tar.bz2 rneovim-b3268d071277c8967b3e3ecb60430718e1f36472.zip |
Refactor API types and prototypes
- Split functions with multiple files in the 'api' subdirectory
- Move/Add more types in the 'api/defs.h' header
- Add more prototypes
- Refactor scripts/msgpack-gen.lua
- Move msgpack modules to 'os' subdirectory
Diffstat (limited to 'src/api/vim.h')
-rw-r--r-- | src/api/vim.h | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/src/api/vim.h b/src/api/vim.h new file mode 100644 index 0000000000..cc373e1cc2 --- /dev/null +++ b/src/api/vim.h @@ -0,0 +1,172 @@ +#ifndef NEOVIM_API_VIM_H +#define NEOVIM_API_VIM_H + +#include <stdint.h> +#include <stdbool.h> + +#include "api/defs.h" + +/// Send keys to vim input buffer, simulating user input. +/// +/// @param str The keys to send +void vim_push_keys(String str); + +/// Executes an ex-mode command str +/// +/// @param str The command str +/// @param[out] err Details of an error that may have occurred +void vim_command(String str, Error *err); + +/// Evaluates the expression str using the vim internal expression +/// evaluator (see |expression|). Returns the expression result as: +/// - a string if the Vim expression evaluates to a string or number +/// - a list if the Vim expression evaluates to a Vim list +/// - a dictionary if the Vim expression evaluates to a Vim dictionary +/// Dictionaries and lists are recursively expanded. +/// +/// @param str The expression str +/// @param[out] err Details of an error that may have occurred +/// @return The expanded object +Object vim_eval(String str, Error *err); + +/// Calculates the number of display cells `str` occupies, tab is counted as +/// one cell. +/// +/// @param str Some text +/// @return The number of cells +int64_t vim_strwidth(String str); + +/// Returns a list of paths contained in 'runtimepath' +/// +/// @return The list of paths +StringArray vim_list_runtime_paths(void); + +/// Changes vim working directory +/// +/// @param dir The new working directory +void vim_change_directory(String dir); + +/// Return the current line +/// +/// @return The current line string +String vim_get_current_line(void); + +/// Sets the current line +/// +/// @param line The line contents +void vim_set_current_line(String line); + +/// Gets a global or special variable +/// +/// @param special If it's a special(:v) variable +/// @param name The variable name +/// @param[out] err Details of an error that may have occurred +/// @return The variable value +Object vim_get_var(bool special, String name, Error *err); + +/// Sets a global or special variable +/// +/// @param special If it's a special(:v) variable +/// @param name The variable name +/// @param value The variable value +/// @param[out] err Details of an error that may have occurred +void vim_set_var(bool special, String name, Object value, Error *err); + +/// Get an option value string +/// +/// @param name The option name +/// @param[out] err Details of an error that may have occurred +/// @return The option value +String vim_get_option(String name, Error *err); + +/// Sets an option value +/// +/// @param name The option name +/// @param value The new option value +/// @param[out] err Details of an error that may have occurred +void vim_set_option(String name, String value, Error *err); + +/// Deletes an option, falling back to the default value +/// +/// @param name The option name +/// @param[out] err Details of an error that may have occurred +void vim_del_option(String name, Error *err); + +/// Write a message to vim output buffer +/// +/// @param str The message +void vim_out_write(String str); + +/// Write a message to vim error buffer +/// +/// @param str The message +void vim_err_write(String str); + +/// Gets the number of buffers +/// +/// @return The number of buffers +int64_t vim_get_buffer_count(void); + +/// Gets a buffer by index +/// +/// @param num The buffer number +/// @param[out] err Details of an error that may have occurred +/// @return The buffer handle +Buffer vim_get_buffer(int64_t num, Error *err); + +/// Return the current buffer +/// +/// @reqturn The buffer handle +Buffer vim_get_current_buffer(void); + +/// Sets the current buffer +/// +/// @param id The buffer handle +void vim_set_current_buffer(Buffer buffer); + +/// Gets the number of windows +/// +/// @return The number of windows +int64_t vim_get_window_count(void); + +/// Gets a window by index +/// +/// @param num The window number +/// @param[out] err Details of an error that may have occurred +/// @return The window handle +Window vim_get_window(int64_t num, Error *err); + +/// Return the current window +/// +/// @return The window handle +Window vim_get_current_window(void); + +/// Sets the current window +/// +/// @param handle The window handle +void vim_set_current_window(Window window); + +/// Gets the number of tab pages +/// +/// @return The number of tab pages +int64_t vim_get_tabpage_count(void); + +/// Gets a tab page by index +/// +/// @param num The tabpage number +/// @param[out] err Details of an error that may have occurred +/// @return The tab page handle +Tabpage vim_get_tabpage(int64_t num, Error *err); + +/// Return the current tab page +/// +/// @return The tab page handle +Tabpage vim_get_current_tabpage(void); + +/// Sets the current tab page +/// +/// @param handle The tab page handle +void vim_set_current_tabpage(Tabpage tabpage); + +#endif // NEOVIM_API_VIM_H + |