vim: src/README.md annotate

annotate src/README.md @ 16957:1266ca221df8 v8.1.1479

patch 8.1.1479: change included for debugging only commit https://github.com/vim/vim/commit/133c737357ceff21348d55c7d53903421c5ce094 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Jun 6 14:38:06 2019 +0200 patch 8.1.1479: change included for debugging only Problem: Change included for debugging only. Solution: Restore the REDIR_TEST_TO_NULL line.

author	Bram Moolenaar <Bram@vim.org>
date	Thu, 06 Jun 2019 14:45:04 +0200
parents	30de89c1d090
children	ba06a1c42274

rev	line source
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	1 ![Vim Logo](https://github.com/vim/vim/blob/master/runtime/vimlogo.gif)
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	2
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	3 # Vim source code #
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	4
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	5 Here are a few hints for finding your way around the source code. This
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	6 doesn't make it less complex than it is, but it gets you started.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	7
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	8 You might also want to read
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	9 [`:help development`](http://vimdoc.sourceforge.net/htmldoc/develop.html#development).
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	10
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	11
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	12 ## Jumping around ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	13
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	14 First of all, use `:make tags` to generate a tags file, so that you can jump
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	15 around in the source code.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	16
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	17 To jump to a function or variable definition, move the cursor on the name and
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	18 use the `CTRL-]` command. Use `CTRL-T` or `CTRL-O` to jump back.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	19
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	20 To jump to a file, move the cursor on its name and use the `gf` command.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	21
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	22 Most code can be found in a file with an obvious name (incomplete list):
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	23
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	24 File name \| Description
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	25 --------- \| -----------
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	26 autocmd.c \| autocommands
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	27 buffer.c \| manipulating buffers (loaded files)
16632 30de89c1d090 patch 8.1.1318: code for text changes is in a "misc" file Bram Moolenaar <Bram@vim.org> parents: 16411 diff changeset	28 change.c \| handling changes to text
16391 3fc956fc63b6 patch 8.1.1200: old style comments in debugger source Bram Moolenaar <Bram@vim.org> parents: 16186 diff changeset	29 debugger.c \| vim script debugger
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	30 diff.c \| diff mode (vimdiff)
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	31 eval.c \| expression evaluation
16411 5b5c5daf57de patch 8.1.1210: support for user commands is spread out Bram Moolenaar <Bram@vim.org> parents: 16407 diff changeset	32 evalfunc.c \| built-in functions
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	33 fileio.c \| reading and writing files
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	34 findfile.c \| search for files in 'path'
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	35 fold.c \| folding
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	36 getchar.c \| getting characters and key mapping
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	37 indent.c \| C and Lisp indentation
16186 e12336bb8ced patch 8.1.1098: quickfix code duplication Bram Moolenaar <Bram@vim.org> parents: 16129 diff changeset	38 insexpand.c \| Insert mode completion
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	39 mark.c \| marks
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	40 mbyte.c \| multi-byte character handling
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	41 memfile.c \| storing lines for buffers in a swapfile
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	42 memline.c \| storing lines for buffers in memory
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	43 menu.c \| menus
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	44 message.c \| (error) messages
16411 5b5c5daf57de patch 8.1.1210: support for user commands is spread out Bram Moolenaar <Bram@vim.org> parents: 16407 diff changeset	45 ops.c \| handling operators ("d", "y", "p")
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	46 option.c \| options
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	47 quickfix.c \| quickfix commands (":make", ":cn")
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	48 regexp.c \| pattern matching
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	49 screen.c \| updating the windows
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	50 search.c \| pattern searching
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	51 sign.c \| signs
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	52 spell.c \| spell checking
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	53 syntax.c \| syntax and other highlighting
16411 5b5c5daf57de patch 8.1.1210: support for user commands is spread out Bram Moolenaar <Bram@vim.org> parents: 16407 diff changeset	54 tag.c \| tags
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	55 term.c \| terminal handling, termcap codes
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	56 undo.c \| undo and redo
16411 5b5c5daf57de patch 8.1.1210: support for user commands is spread out Bram Moolenaar <Bram@vim.org> parents: 16407 diff changeset	57 usercmd.c \| user defined commands
5b5c5daf57de patch 8.1.1210: support for user commands is spread out Bram Moolenaar <Bram@vim.org> parents: 16407 diff changeset	58 userfunc.c \| user defined functions
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	59 window.c \| handling split windows
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	60
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	61
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	62 ## Debugging ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	63
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	64 If you have a reasonable recent version of gdb, you can use the `:Termdebug`
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	65 command to debug Vim. See `:help :Termdebug`.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	66
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	67 When something is time critical or stepping through code is a hassle, use the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	68 channel logging to create a time-stamped log file. Add lines to the code like
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	69 this:
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	70
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	71 ch_log(NULL, "Value is now %02x", value);
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	72
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	73 After compiling and starting Vim, do:
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	74
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	75 :call ch_logfile('debuglog', 'w')
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	76
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	77 And edit `debuglog` to see what happens. The channel functions already have
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	78 `ch_log()` calls, thus you always see that in the log.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	79
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	80
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	81 ## Important Variables ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	82
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	83 The current mode is stored in `State`. The values it can have are `NORMAL`,
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	84 `INSERT`, `CMDLINE`, and a few others.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	85
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	86 The current window is `curwin`. The current buffer is `curbuf`. These point
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	87 to structures with the cursor position in the window, option values, the file
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	88 name, etc. These are defined in
16407 cbb6e28af4cb patch 8.1.1208: links to repository use wrong file name Bram Moolenaar <Bram@vim.org> parents: 16391 diff changeset	89 [`structs.h`](https://github.com/vim/vim/blob/master/src/structs.h).
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	90
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	91 All the global variables are declared in
16407 cbb6e28af4cb patch 8.1.1208: links to repository use wrong file name Bram Moolenaar <Bram@vim.org> parents: 16391 diff changeset	92 [`globals.h`](https://github.com/vim/vim/blob/master/src/globals.h).
16129 52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	93
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	94
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	95 ## The main loop ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	96
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	97 This is conveniently called `main_loop()`. It updates a few things and then
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	98 calls `normal_cmd()` to process a command. This returns when the command is
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	99 finished.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	100
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	101 The basic idea is that Vim waits for the user to type a character and
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	102 processes it until another character is needed. Thus there are several places
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	103 where Vim waits for a character to be typed. The `vgetc()` function is used
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	104 for this. It also handles mapping.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	105
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	106 Updating the screen is mostly postponed until a command or a sequence of
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	107 commands has finished. The work is done by `update_screen()`, which calls
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	108 `win_update()` for every window, which calls `win_line()` for every line.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	109 See the start of
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	110 [`screen.c`](https://github.com/vim/vim/blob/master/src/screen.c)
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	111 for more explanations.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	112
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	113
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	114 ## Command-line mode ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	115
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	116 When typing a `:`, `normal_cmd()` will call `getcmdline()` to obtain a line
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	117 with an Ex command. `getcmdline()` contains a loop that will handle each typed
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	118 character. It returns when hitting `CR` or `Esc` or some other character that
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	119 ends the command line mode.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	120
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	121
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	122 ## Ex commands ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	123
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	124 Ex commands are handled by the function `do_cmdline()`. It does the generic
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	125 parsing of the `:` command line and calls `do_one_cmd()` for each separate
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	126 command. It also takes care of while loops.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	127
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	128 `do_one_cmd()` parses the range and generic arguments and puts them in the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	129 `exarg_t` and passes it to the function that handles the command.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	130
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	131 The `:` commands are listed in `ex_cmds.h`. The third entry of each item is
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	132 the name of the function that handles the command. The last entry are the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	133 flags that are used for the command.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	134
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	135
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	136 ## Normal mode commands ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	137
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	138 The Normal mode commands are handled by the `normal_cmd()` function. It also
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	139 handles the optional count and an extra character for some commands. These
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	140 are passed in a `cmdarg_t` to the function that handles the command.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	141
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	142 There is a table `nv_cmds` in
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	143 [`normal.c`](https://github.com/vim/vim/blob/master/src/normal.c)
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	144 which lists the first character of every command. The second entry of each
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	145 item is the name of the function that handles the command.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	146
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	147
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	148 ## Insert mode commands ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	149
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	150 When doing an `i` or `a` command, `normal_cmd()` will call the `edit()`
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	151 function. It contains a loop that waits for the next character and handles it.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	152 It returns when leaving Insert mode.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	153
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	154
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	155 ## Options ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	156
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	157 There is a list with all option names in
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	158 [`option.c`](https://github.com/vim/vim/blob/master/src/option.c),
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	159 called `options[]`.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	160
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	161
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	162 ## The GUI ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	163
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	164 Most of the GUI code is implemented like it was a clever terminal. Typing a
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	165 character, moving a scrollbar, clicking the mouse, etc. are all translated
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	166 into events which are written in the input buffer. These are read by the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	167 main code, just like reading from a terminal. The code for this is scattered
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	168 through [`gui.c`](https://github.com/vim/vim/blob/master/src/gui.c).
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	169 For example, `gui_send_mouse_event()` for a mouse click and `gui_menu_cb()` for
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	170 a menu action. Key hits are handled by the system-specific GUI code, which
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	171 calls `add_to_input_buf()` to send the key code.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	172
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	173 Updating the GUI window is done by writing codes in the output buffer, just
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	174 like writing to a terminal. When the buffer gets full or is flushed,
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	175 `gui_write()` will parse the codes and draw the appropriate items. Finally the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	176 system-specific GUI code will be called to do the work.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	177
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	178
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	179 ## Debugging the GUI ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	180
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	181 Remember to prevent that gvim forks and the debugger thinks Vim has exited,
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	182 add the `-f` argument. In gdb: `run -f -g`.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	183
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	184 When stepping through display updating code, the focus event is triggered
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	185 when going from the debugger to Vim and back. To avoid this, recompile with
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	186 some code in `gui_focus_change()` disabled.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	187
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	188
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	189 ## Contributing ##
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	190
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	191 If you would like to help making Vim better, see the
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	192 [`CONTRIBUTING.md`](https://github.com/vim/vim/blob/master/CONTRIBUTING.md)
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	193 file.
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	194
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	195
52ae47071830 patch 8.1.1069: source README file doesn't look nice on github Bram Moolenaar <Bram@vim.org> parents: diff changeset	196 This is `README.md` for version 8.1 of the Vim source code.

Mercurial > vim

annotate src/README.md @ 16957:1266ca221df8 v8.1.1479