Mercurial > vim
annotate src/README.txt @ 15818:89486329d9e6 v8.1.0916
patch 8.1.0916: with Python 3.7 "find_module" is not made available
commit https://github.com/vim/vim/commit/b999ba2778b6c02fdd100e498a9ba5b2e7036f7d
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Feb 14 13:28:45 2019 +0100
patch 8.1.0916: with Python 3.7 "find_module" is not made available
Problem: With Python 3.7 "find_module" is not made available.
Solution: Also add "find_module" with Python 3.7. (Joel Frederico,
closes #3954)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Thu, 14 Feb 2019 13:30:14 +0100 |
parents | 99ebf78686a9 |
children |
rev | line source |
---|---|
7 | 1 README for the Vim source code |
2 | |
3 Here are a few hints for finding your way around the source code. This | |
4 doesn't make it less complex than it is, but it gets you started. | |
5 | |
6 You might also want to read ":help development". | |
7 | |
8 | |
9 JUMPING AROUND | |
10 | |
13353
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
11 First of all, use ":make tags" to generate a tags file, so that you can jump |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
12 around in the source code. |
7 | 13 |
14 To jump to a function or variable definition, move the cursor on the name and | |
15 use the CTRL-] command. Use CTRL-T or CTRL-O to jump back. | |
16 | |
17 To jump to a file, move the cursor on its name and use the "gf" command. | |
18 | |
19 Most code can be found in a file with an obvious name (incomplete list): | |
15634
746b95fd25ad
patch 8.1.0825: code for autocommands is mixed with file I/O code
Bram Moolenaar <Bram@vim.org>
parents:
15330
diff
changeset
|
20 autocmd.c autocommands |
7 | 21 buffer.c manipulating buffers (loaded files) |
22 diff.c diff mode (vimdiff) | |
23 eval.c expression evaluation | |
24 fileio.c reading and writing files | |
15814
99ebf78686a9
patch 8.1.0914: code related to findfile() is spread out
Bram Moolenaar <Bram@vim.org>
parents:
15634
diff
changeset
|
25 findfile.c search for files in 'path' |
7 | 26 fold.c folding |
27 getchar.c getting characters and key mapping | |
15814
99ebf78686a9
patch 8.1.0914: code related to findfile() is spread out
Bram Moolenaar <Bram@vim.org>
parents:
15634
diff
changeset
|
28 indent.c C and Lisp indentation |
7 | 29 mark.c marks |
2577
073ff46fe397
Fold Vim 7.2 default branch back to trunk to avoid two heads. (Tony
Bram Moolenaar <bram@vim.org>
parents:
2165
diff
changeset
|
30 mbyte.c multi-byte character handling |
7 | 31 memfile.c storing lines for buffers in a swapfile |
32 memline.c storing lines for buffers in memory | |
33 menu.c menus | |
34 message.c (error) messages | |
35 ops.c handling operators ("d", "y", "p") | |
36 option.c options | |
37 quickfix.c quickfix commands (":make", ":cn") | |
372 | 38 regexp.c pattern matching |
7 | 39 screen.c updating the windows |
40 search.c pattern searching | |
15330
a6330a49e036
patch 8.1.0673: functionality for signs is spread out over several files
Bram Moolenaar <Bram@vim.org>
parents:
13353
diff
changeset
|
41 sign.c signs |
372 | 42 spell.c spell checking |
43 syntax.c syntax and other highlighting | |
7 | 44 tag.c tags |
45 term.c terminal handling, termcap codes | |
46 undo.c undo and redo | |
47 window.c handling split windows | |
48 | |
49 | |
13353
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
50 DEBUGGING |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
51 |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
52 If you have a reasonable recent version of gdb, you can use the :Termdebug |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
53 command to debug Vim. See ":help :Termdebug". |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
54 |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
55 When something is time critical or stepping through code is a hassle, use the |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
56 channel logging to create a time-stamped log file. Add lines to the code like |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
57 this: |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
58 ch_log(NULL, "Value is now %02x", value); |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
59 After compiling and starting Vim, do: |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
60 :call ch_logfile('debuglog', 'w') |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
61 And edit "debuglog" to see what happens. The channel functions already have |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
62 ch_log() calls, thus you always see that in the log. |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
63 |
8412df1479a3
patch 8.0.1550: various small problems in source files
Christian Brabandt <cb@256bit.org>
parents:
2577
diff
changeset
|
64 |
7 | 65 IMPORTANT VARIABLES |
66 | |
67 The current mode is stored in "State". The values it can have are NORMAL, | |
68 INSERT, CMDLINE, and a few others. | |
69 | |
70 The current window is "curwin". The current buffer is "curbuf". These point | |
71 to structures with the cursor position in the window, option values, the file | |
72 name, etc. These are defined in structs.h. | |
73 | |
74 All the global variables are declared in globals.h. | |
75 | |
76 | |
77 THE MAIN LOOP | |
78 | |
79 This is conveniently called main_loop(). It updates a few things and then | |
80 calls normal_cmd() to process a command. This returns when the command is | |
81 finished. | |
82 | |
83 The basic idea is that Vim waits for the user to type a character and | |
84 processes it until another character is needed. Thus there are several places | |
85 where Vim waits for a character to be typed. The vgetc() function is used for | |
86 this. It also handles mapping. | |
87 | |
88 Updating the screen is mostly postponed until a command or a sequence of | |
89 commands has finished. The work is done by update_screen(), which calls | |
90 win_update() for every window, which calls win_line() for every line. | |
91 See the start of screen.c for more explanations. | |
92 | |
93 | |
94 COMMAND-LINE MODE | |
95 | |
96 When typing a ":", normal_cmd() will call getcmdline() to obtain a line with | |
97 an Ex command. getcmdline() contains a loop that will handle each typed | |
98 character. It returns when hitting <CR> or <Esc> or some other character that | |
99 ends the command line mode. | |
100 | |
101 | |
102 EX COMMANDS | |
103 | |
104 Ex commands are handled by the function do_cmdline(). It does the generic | |
105 parsing of the ":" command line and calls do_one_cmd() for each separate | |
106 command. It also takes care of while loops. | |
107 | |
108 do_one_cmd() parses the range and generic arguments and puts them in the | |
109 exarg_t and passes it to the function that handles the command. | |
110 | |
111 The ":" commands are listed in ex_cmds.h. The third entry of each item is the | |
112 name of the function that handles the command. The last entry are the flags | |
113 that are used for the command. | |
114 | |
115 | |
116 NORMAL MODE COMMANDS | |
117 | |
118 The Normal mode commands are handled by the normal_cmd() function. It also | |
119 handles the optional count and an extra character for some commands. These | |
120 are passed in a cmdarg_t to the function that handles the command. | |
121 | |
122 There is a table nv_cmds in normal.c which lists the first character of every | |
123 command. The second entry of each item is the name of the function that | |
124 handles the command. | |
125 | |
126 | |
127 INSERT MODE COMMANDS | |
128 | |
129 When doing an "i" or "a" command, normal_cmd() will call the edit() function. | |
130 It contains a loop that waits for the next character and handles it. It | |
131 returns when leaving Insert mode. | |
132 | |
133 | |
134 OPTIONS | |
135 | |
136 There is a list with all option names in option.c, called options[]. | |
137 | |
138 | |
139 THE GUI | |
140 | |
141 Most of the GUI code is implemented like it was a clever terminal. Typing a | |
142 character, moving a scrollbar, clicking the mouse, etc. are all translated | |
143 into events which are written in the input buffer. These are read by the | |
144 main code, just like reading from a terminal. The code for this is scattered | |
145 through gui.c. For example: gui_send_mouse_event() for a mouse click and | |
146 gui_menu_cb() for a menu action. Key hits are handled by the system-specific | |
147 GUI code, which calls add_to_input_buf() to send the key code. | |
148 | |
149 Updating the GUI window is done by writing codes in the output buffer, just | |
150 like writing to a terminal. When the buffer gets full or is flushed, | |
151 gui_write() will parse the codes and draw the appropriate items. Finally the | |
152 system-specific GUI code will be called to do the work. | |
153 | |
154 | |
155 DEBUGGING THE GUI | |
156 | |
157 Remember to prevent that gvim forks and the debugger thinks Vim has exited, | |
158 add the "-f" argument. In gdb: "run -f -g". | |
159 | |
1197 | 160 When stepping through display updating code, the focus event is triggered |
7 | 161 when going from the debugger to Vim and back. To avoid this, recompile with |
162 some code in gui_focus_change() disabled. |