Created
September 27, 2014 12:50
-
-
Save myitcv/dcf7343645d682deecc9 to your computer and use it in GitHub Desktop.
Complete API proposal
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| error_types: | |
| Exception: {id: 0} | |
| Validation: {id: 1} | |
| features: | |
| clipboard: [clipboard_get, clipboard_set] | |
| python: [python_execute, python_execute_file, python_do_range, python_eval] | |
| types: | |
| Buffer: {id: 0} | |
| Tabpage: {id: 2} | |
| Window: {id: 1} | |
| functions: | |
| - name: tabpage_get_windows | |
| can_fail: true | |
| parameters: | |
| - [Tabpage, tabpage] | |
| return_type: ArrayOf(Window) | |
| - name: tabpage_get_var | |
| can_fail: true | |
| parameters: | |
| - [Tabpage, tabpage] | |
| - [String, name] | |
| return_type: Object | |
| - name: tabpage_set_var | |
| can_fail: true | |
| parameters: | |
| - [Tabpage, tabpage] | |
| - [String, name] | |
| - [Object, value] | |
| return_type: Object | |
| - name: tabpage_get_window | |
| can_fail: true | |
| parameters: | |
| - [Tabpage, tabpage] | |
| return_type: Window | |
| - name: tabpage_is_valid | |
| parameters: | |
| - [Tabpage, tabpage] | |
| return_type: Boolean | |
| - name: buffer_line_count | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| return_type: Integer | |
| - name: buffer_get_line | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, index] | |
| return_type: Binary | |
| - name: buffer_set_line | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, index] | |
| - [Binary, line] | |
| return_type: void | |
| - name: buffer_del_line | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, index] | |
| return_type: void | |
| - name: buffer_get_line_slice | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, start] | |
| - [Integer, end] | |
| - [Boolean, include_start] | |
| - [Boolean, include_end] | |
| return_type: ArrayOf(Binary) | |
| - name: buffer_set_line_slice | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, start] | |
| - [Integer, end] | |
| - [Boolean, include_start] | |
| - [Boolean, include_end] | |
| - [ArrayOf(Binary), replacement] | |
| return_type: void | |
| - name: buffer_get_var | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| return_type: Object | |
| - name: buffer_set_var | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| - [Object, value] | |
| return_type: Object | |
| - name: buffer_get_option | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| return_type: Object | |
| - name: buffer_set_option | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| - [Object, value] | |
| return_type: void | |
| - name: buffer_get_number | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| return_type: Integer | |
| - name: buffer_get_name | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| return_type: String | |
| - name: buffer_set_name | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| return_type: void | |
| - name: buffer_is_valid | |
| parameters: | |
| - [Buffer, buffer] | |
| return_type: Boolean | |
| - name: buffer_insert_lines | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [Integer, lnum] | |
| - [ArrayOf(Binary), lines] | |
| return_type: void | |
| - name: buffer_get_mark | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| - [String, name] | |
| return_type: ArrayOf(Integer, 2) | |
| - name: vim_push_keys | |
| parameters: | |
| - [String, str] | |
| return_type: void | |
| - name: vim_command | |
| can_fail: true | |
| parameters: | |
| - [String, str] | |
| return_type: void | |
| - name: vim_feedkeys | |
| parameters: | |
| - [String, keys] | |
| - [String, mode] | |
| return_type: void | |
| - name: vim_replace_termcodes | |
| parameters: | |
| - [String, str] | |
| - [Boolean, from_part] | |
| - [Boolean, do_lt] | |
| - [Boolean, special] | |
| return_type: String | |
| - name: vim_eval | |
| can_fail: true | |
| parameters: | |
| - [String, str] | |
| return_type: Object | |
| - name: vim_strwidth | |
| can_fail: true | |
| parameters: | |
| - [String, str] | |
| return_type: Integer | |
| - name: vim_list_runtime_paths | |
| parameters: [] | |
| return_type: ArrayOf(String) | |
| - name: vim_change_directory | |
| can_fail: true | |
| parameters: | |
| - [String, dir] | |
| return_type: void | |
| - name: vim_get_current_line | |
| can_fail: true | |
| parameters: [] | |
| return_type: Binary | |
| - name: vim_set_current_line | |
| can_fail: true | |
| parameters: | |
| - [Binary, line] | |
| return_type: void | |
| - name: vim_del_current_line | |
| can_fail: true | |
| parameters: [] | |
| return_type: void | |
| - name: vim_get_var | |
| can_fail: true | |
| parameters: | |
| - [String, name] | |
| return_type: Object | |
| - name: vim_set_var | |
| can_fail: true | |
| parameters: | |
| - [String, name] | |
| - [Object, value] | |
| return_type: Object | |
| - name: vim_get_vvar | |
| can_fail: true | |
| parameters: | |
| - [String, name] | |
| return_type: Object | |
| - name: vim_get_option | |
| can_fail: true | |
| parameters: | |
| - [String, name] | |
| return_type: Object | |
| - name: vim_set_option | |
| can_fail: true | |
| parameters: | |
| - [String, name] | |
| - [Object, value] | |
| return_type: void | |
| - name: vim_out_write | |
| parameters: | |
| - [Binary, str] | |
| return_type: void | |
| - name: vim_err_write | |
| parameters: | |
| - [String, str] | |
| return_type: void | |
| - name: vim_report_error | |
| parameters: | |
| - [String, str] | |
| return_type: void | |
| - name: vim_get_buffers | |
| parameters: [] | |
| return_type: ArrayOf(Buffer) | |
| - name: vim_get_current_buffer | |
| parameters: [] | |
| return_type: Buffer | |
| - name: vim_set_current_buffer | |
| can_fail: true | |
| parameters: | |
| - [Buffer, buffer] | |
| return_type: void | |
| - name: vim_get_windows | |
| parameters: [] | |
| return_type: ArrayOf(Window) | |
| - name: vim_get_current_window | |
| parameters: [] | |
| return_type: Window | |
| - name: vim_set_current_window | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: void | |
| - name: vim_get_tabpages | |
| parameters: [] | |
| return_type: ArrayOf(Tabpage) | |
| - name: vim_get_current_tabpage | |
| parameters: [] | |
| return_type: Tabpage | |
| - name: vim_set_current_tabpage | |
| can_fail: true | |
| parameters: | |
| - [Tabpage, tabpage] | |
| return_type: void | |
| - name: vim_subscribe | |
| parameters: | |
| - [String, event] | |
| receives_channel_id: true | |
| return_type: void | |
| - name: vim_unsubscribe | |
| parameters: | |
| - [String, event] | |
| receives_channel_id: true | |
| return_type: void | |
| - name: vim_register_provider | |
| can_fail: true | |
| parameters: | |
| - [String, feature] | |
| receives_channel_id: true | |
| return_type: void | |
| - name: vim_get_api_info | |
| parameters: [] | |
| receives_channel_id: true | |
| return_type: Array | |
| - name: window_get_buffer | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: Buffer | |
| - name: window_get_cursor | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: ArrayOf(Integer, 2) | |
| - name: window_set_cursor | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - ['ArrayOf(Integer, 2)', pos] | |
| return_type: void | |
| - name: window_get_height | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: Integer | |
| - name: window_set_height | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [Integer, height] | |
| return_type: void | |
| - name: window_get_width | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: Integer | |
| - name: window_set_width | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [Integer, width] | |
| return_type: void | |
| - name: window_get_var | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [String, name] | |
| return_type: Object | |
| - name: window_set_var | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [String, name] | |
| - [Object, value] | |
| return_type: Object | |
| - name: window_get_option | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [String, name] | |
| return_type: Object | |
| - name: window_set_option | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| - [String, name] | |
| - [Object, value] | |
| return_type: void | |
| - name: window_get_position | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: ArrayOf(Integer, 2) | |
| - name: window_get_tabpage | |
| can_fail: true | |
| parameters: | |
| - [Window, window] | |
| return_type: Tabpage | |
| - name: window_is_valid | |
| parameters: | |
| - [Window, window] | |
| return_type: Boolean |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment