diff options
| author | Yuan Fu | 2023-02-02 17:22:22 -0800 |
|---|---|---|
| committer | Yuan Fu | 2023-02-02 18:31:19 -0800 |
| commit | 8a6bdf88b4b665916cf74dee3a30e9136a9b6df8 (patch) | |
| tree | 8deeefbb73149fdf3e5efd4a80321be98f62127e /admin | |
| parent | a2b77c79dcca64b5e0ae58862206e7cc29640944 (diff) | |
| download | emacs-8a6bdf88b4b665916cf74dee3a30e9136a9b6df8.tar.gz emacs-8a6bdf88b4b665916cf74dee3a30e9136a9b6df8.zip | |
Call treesit_record_change in insert_from_gap_1
Before this change, insert_from_gap calls treesit_record_change but
insert_from_gap_1 doesn't. However, insert_from_gap_1 is a public
function and is called in many other places outside of insdel.c. This
could lead to tree-sitter's parse tree becoming out-of-sync with the
buffer content.
This change might fix bug#60650.
* src/insdel.c (insert_from_gap_1): Call treesit_record_change.
(insert_from_gap): Remove call to treesit_record_change.
* admin/notes/tree-sitter/treesit_record_change: New file.
Diffstat (limited to 'admin')
| -rw-r--r-- | admin/notes/tree-sitter/treesit_record_change | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/admin/notes/tree-sitter/treesit_record_change b/admin/notes/tree-sitter/treesit_record_change new file mode 100644 index 00000000000..bb0f9edc353 --- /dev/null +++ b/admin/notes/tree-sitter/treesit_record_change | |||
| @@ -0,0 +1,50 @@ | |||
| 1 | NOTES ON TREESIT_RECORD_CHANGE | ||
| 2 | |||
| 3 | It is vital that Emacs informs tree-sitter of every change made to the | ||
| 4 | buffer, lest tree-sitter's parse tree would be corrupted/out of sync. | ||
| 5 | |||
| 6 | All buffer changes in Emacs are made through functions in insdel.c | ||
| 7 | (and casefiddle.c), I augmented functions in those files with calls to | ||
| 8 | treesit_record_change. Below is a manifest of all the relavent | ||
| 9 | functions in insdel.c as of Emacs 29: | ||
| 10 | |||
| 11 | Function Calls | ||
| 12 | ---------------------------------------------------------------------- | ||
| 13 | copy_text (*1) | ||
| 14 | insert insert_1_both | ||
| 15 | insert_and_inherit insert_1_both | ||
| 16 | insert_char insert | ||
| 17 | insert_string insert | ||
| 18 | insert_before_markers insert_1_both | ||
| 19 | insert_before_markers_and_inherit insert_1_both | ||
| 20 | insert_1_both treesit_record_change | ||
| 21 | insert_from_string insert_from_string_1 | ||
| 22 | insert_from_string_before_markers insert_from_string_1 | ||
| 23 | insert_from_string_1 treesit_record_change | ||
| 24 | insert_from_gap_1 treesit_record_change | ||
| 25 | insert_from_gap insert_from_gap_1 | ||
| 26 | insert_from_buffer treesit_record_change | ||
| 27 | insert_from_buffer_1 (used by insert_from_buffer) (*2) | ||
| 28 | replace_range treesit_record_change | ||
| 29 | replace_range_2 (caller needs to call treesit_r_c) | ||
| 30 | del_range del_range_1 | ||
| 31 | del_range_1 del_range_2 | ||
| 32 | del_range_byte del_range_2 | ||
| 33 | del_range_both del_range_2 | ||
| 34 | del_range_2 treesit_record_change | ||
| 35 | |||
| 36 | (*1) This functions is used only to copy from string to string when | ||
| 37 | used outside of insdel.c, and when used inside insdel.c, the caller | ||
| 38 | calls treesit_record_change. | ||
| 39 | |||
| 40 | (*2) This function is a static function, and insert_from_buffer is its | ||
| 41 | only caller. So it should be fine to call treesit_record_change in | ||
| 42 | insert_from_buffer but not insert_from_buffer_1. I also left a | ||
| 43 | reminder comment. | ||
| 44 | |||
| 45 | |||
| 46 | As for casefiddle.c, do_casify_unibyte_region and | ||
| 47 | do_casify_multibyte_region modifies buffer, but they are static | ||
| 48 | functions and are called by casify_region, which calls | ||
| 49 | treesit_record_change. Other higher-level functions calls | ||
| 50 | casify_region to do the work. \ No newline at end of file | ||