Mercurial > vim
annotate src/README.md @ 20789:7177dae667cd
Added tag v8.2.0946 for changeset 072ad890c227d8361eb3061f67e6b33c6998f80c
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Wed, 10 Jun 2020 16:00:05 +0200 |
parents | f502455965c0 |
children | b1fac55cf8a3 |
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 |
17377
cb008de2a6ec
patch 8.1.1687: the evalfunc.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17370
diff
changeset
|
24 File name | Description |
cb008de2a6ec
patch 8.1.1687: the evalfunc.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17370
diff
changeset
|
25 --------------- | ----------- |
17744
4a3dca734d36
patch 8.1.1869: code for the argument list is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17652
diff
changeset
|
26 arglist.c | handling argument list |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
27 autocmd.c | autocommands |
17652
9efb4dda9720
patch 8.1.1823: command line history code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17576
diff
changeset
|
28 blob.c | blob data type |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
29 buffer.c | manipulating buffers (loaded files) |
18199
e2be5a6485f5
patch 8.1.2094: the fileio.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18174
diff
changeset
|
30 bufwrite.c | writing a buffer to file |
16632
30de89c1d090
patch 8.1.1318: code for text changes is in a "misc" file
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
31 change.c | handling changes to text |
18265
fe5afdc03bd2
patch 8.1.2127: the indent.c file is a bit big
Bram Moolenaar <Bram@vim.org>
parents:
18199
diff
changeset
|
32 cindent.c | C and Lisp indentation |
19920
5e41b2e63c73
patch 8.2.0516: client-server code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
19774
diff
changeset
|
33 clientserver.c | client server functionality |
19774
00a1b89256ea
patch 8.2.0443: clipboard code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
19396
diff
changeset
|
34 clipboard.c | handling the clipboard |
17779
87a8760babec
patch 8.1.1886: command line expansion code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17744
diff
changeset
|
35 cmdexpand.c | command-line completion |
17652
9efb4dda9720
patch 8.1.1823: command line history code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17576
diff
changeset
|
36 cmdhist.c | command-line history |
16391
3fc956fc63b6
patch 8.1.1200: old style comments in debugger source
Bram Moolenaar <Bram@vim.org>
parents:
16186
diff
changeset
|
37 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
|
38 diff.c | diff mode (vimdiff) |
18124
2a806e3c39f6
patch 8.1.2057: the screen.c file is much too big
Bram Moolenaar <Bram@vim.org>
parents:
18100
diff
changeset
|
39 drawline.c | drawing a window line |
2a806e3c39f6
patch 8.1.2057: the screen.c file is much too big
Bram Moolenaar <Bram@vim.org>
parents:
18100
diff
changeset
|
40 drawscreen.c | drawing the windows |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
41 eval.c | expression evaluation |
18010
cf8e0c7e0cb9
patch 8.1.2001: some source files are too big
Bram Moolenaar <Bram@vim.org>
parents:
17966
diff
changeset
|
42 evalbuffer.c | buffer related built-in functions |
16411
5b5c5daf57de
patch 8.1.1210: support for user commands is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16407
diff
changeset
|
43 evalfunc.c | built-in functions |
17873
d50a5faa75bd
patch 8.1.1933: the eval.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17861
diff
changeset
|
44 evalvars.c | vim variables |
18010
cf8e0c7e0cb9
patch 8.1.2001: some source files are too big
Bram Moolenaar <Bram@vim.org>
parents:
17966
diff
changeset
|
45 evalwindow.c | window related 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
|
46 fileio.c | reading and writing files |
17966
46f95606b9ec
patch 8.1.1979: code for handling file names is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17873
diff
changeset
|
47 filepath.c | dealing with file names and paths |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
48 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
|
49 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
|
50 getchar.c | getting characters and key mapping |
17389
635d7f5010b8
patch 8.1.1693: syntax coloring and highlighting is in one big file
Bram Moolenaar <Bram@vim.org>
parents:
17377
diff
changeset
|
51 highlight.c | syntax highlighting |
18265
fe5afdc03bd2
patch 8.1.2127: the indent.c file is a bit big
Bram Moolenaar <Bram@vim.org>
parents:
18199
diff
changeset
|
52 indent.c | text indentation |
16186
e12336bb8ced
patch 8.1.1098: quickfix code duplication
Bram Moolenaar <Bram@vim.org>
parents:
16129
diff
changeset
|
53 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
|
54 mark.c | marks |
17576
97a750e8707f
patch 8.1.1785: map functionality mixed with character input
Bram Moolenaar <Bram@vim.org>
parents:
17536
diff
changeset
|
55 map.c | mapping and abbreviations |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
56 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
|
57 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
|
58 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
|
59 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
|
60 message.c | (error) messages |
18135
1868ec23360e
patch 8.1.2062: the mouse code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
18124
diff
changeset
|
61 mouse.c | handling the mouse |
16411
5b5c5daf57de
patch 8.1.1210: support for user commands is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16407
diff
changeset
|
62 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
|
63 option.c | options |
18100
df5778d73320
patch 8.1.2045: the option.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18010
diff
changeset
|
64 optionstr.c | handling string options |
18174
1ec6539cef68
patch 8.1.2082: some files have a weird name to fit in 8.3 characters
Bram Moolenaar <Bram@vim.org>
parents:
18172
diff
changeset
|
65 popupmenu.c | popup menu |
17377
cb008de2a6ec
patch 8.1.1687: the evalfunc.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17370
diff
changeset
|
66 popupwin.c | popup window |
17370
ba06a1c42274
patch 8.1.1684: profiling functionality is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16632
diff
changeset
|
67 profiler.c | vim script profiler |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
68 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
|
69 regexp.c | pattern matching |
18164
f57481564f2c
patch 8.1.2077: the ops.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18135
diff
changeset
|
70 register.c | handling registers |
17861
0a5c615cd949
patch 8.1.1927: code for dealing with script files is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17779
diff
changeset
|
71 scriptfile.c | runtime directory handling and sourcing scripts |
18135
1868ec23360e
patch 8.1.2062: the mouse code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
18124
diff
changeset
|
72 screen.c | lower level screen functions |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
73 search.c | pattern searching |
17536
e00d12c085a5
patch 8.1.1766: code for writing session file is spread out
Bram Moolenaar <Bram@vim.org>
parents:
17464
diff
changeset
|
74 session.c | sessions and views |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
75 sign.c | signs |
18172
6e53d83e021d
patch 8.1.2081: the spell.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18164
diff
changeset
|
76 spell.c | spell checking core |
6e53d83e021d
patch 8.1.2081: the spell.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18164
diff
changeset
|
77 spellfile.c | spell file handling |
6e53d83e021d
patch 8.1.2081: the spell.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
18164
diff
changeset
|
78 spellsuggest.c | spell correction suggestions |
17370
ba06a1c42274
patch 8.1.1684: profiling functionality is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16632
diff
changeset
|
79 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
|
80 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
|
81 term.c | terminal handling, termcap codes |
17377
cb008de2a6ec
patch 8.1.1687: the evalfunc.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17370
diff
changeset
|
82 testing.c | testing: assert and test functions |
20237
918245588b50
patch 8.2.0674: some source files are too big
Bram Moolenaar <Bram@vim.org>
parents:
20209
diff
changeset
|
83 textformat.c | text formatting |
20209
6ca6a372fef6
patch 8.2.0660: the search.c file is a bit big
Bram Moolenaar <Bram@vim.org>
parents:
19920
diff
changeset
|
84 textobject.c | text objects |
17377
cb008de2a6ec
patch 8.1.1687: the evalfunc.c file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17370
diff
changeset
|
85 textprop.c | text properties |
19396
a961efb326e5
patch 8.2.0256: time and timer related code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
86 time.c | time and timer functions |
20587
f502455965c0
patch 8.2.0847: typval related code is spread out
Bram Moolenaar <Bram@vim.org>
parents:
20237
diff
changeset
|
87 typval.c | vim script type/value functions |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
88 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
|
89 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
|
90 userfunc.c | user defined functions |
17464
3e708b5c0509
patch 8.1.1730: wrong place for mark viminfo support
Bram Moolenaar <Bram@vim.org>
parents:
17389
diff
changeset
|
91 viminfo.c | viminfo handling |
16129
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
92 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
|
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 ## Debugging ## |
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 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
|
98 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
|
99 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
100 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
|
101 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
|
102 this: |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
103 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
104 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
|
105 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
106 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
|
107 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
108 :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
|
109 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
110 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
|
111 `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
|
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 ## Important Variables ## |
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 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
|
117 `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
|
118 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 [`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
|
123 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
124 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
|
125 [`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
|
126 |
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 ## 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
|
129 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
130 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
|
131 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
|
132 finished. |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
133 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
134 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
|
135 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
|
136 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
|
137 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
|
138 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
139 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
|
140 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
|
141 `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
|
142 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
|
143 [`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
|
144 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
|
145 |
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 ## 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
|
148 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
149 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
|
150 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
|
151 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
|
152 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
|
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 ## Ex commands ## |
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 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
|
158 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
|
159 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
|
160 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
161 `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
|
162 `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
|
163 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
164 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
|
165 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
|
166 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
|
167 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
168 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
169 ## 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
|
170 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
171 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
|
172 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
|
173 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
|
174 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
175 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
|
176 [`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
|
177 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
|
178 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
|
179 |
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 ## 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
|
182 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
183 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
|
184 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
|
185 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
|
186 |
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 ## Options ## |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
189 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
190 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
|
191 [`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
|
192 called `options[]`. |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
193 |
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 ## The GUI ## |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
196 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
197 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
|
198 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
|
199 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
|
200 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
|
201 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
|
202 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
|
203 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
|
204 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
|
205 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
206 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
|
207 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
|
208 `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
|
209 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
|
210 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
211 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
212 ## 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
|
213 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
214 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
|
215 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
|
216 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
217 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
|
218 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
|
219 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
|
220 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
221 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
222 ## Contributing ## |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
223 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
224 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
|
225 [`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
|
226 file. |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
227 |
52ae47071830
patch 8.1.1069: source README file doesn't look nice on github
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
228 |
18879 | 229 This is `README.md` for version 8.2 of the Vim source code. |