Github/emacs
2
0
Fork 1
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-16 17:24:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix ispell’s handling of comment-end when adding local words

Browse source 
* lisp/textmodes/ispell.el (ispell-add-per-file-word-list): Deal
with `comment-end' in a way that works for comments that don’t
nest.

We proceed as follows: when `comment-end' is non-empty, we only
ever insert one start and one end comment, the first time we add
a local word.  This works with both C-style (which don’t nest)
and Rust-style comments (which do).

If we’re using line comments (i.e. comments that only have a
`comment-start'), then continue to insert one on each line.

* test/lisp/textmodes/ispell-tests/ispell-tests.el
(ispell/ispell-add-per-file-word-list/nxml): Adjust test.

Bug#79871
This commit is contained in:
Reuben Thomas 2025-11-20 14:38:18 +00:00 committed by Eli Zaretskii
parent 0762d9b4de
commit e1f851e840
2 changed files with 39 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
lisp/textmodes/ispell.el
View file

@ -4270,6 +4270,14 @@ Both should not be used to define a buffer-local dictionary."
;; If comment-normalize-vars is defined, newcomment must be loaded.
(declare-function comment-normalize-vars "newcomment" (&optional noerror))
(defun ispell--comment-prefix ()
"Return the comment marker for the current mode."
(progn
(comment-normalize-vars)
(comment-padright comment-start
(comment-add nil))
comment-start))
(defun ispell-add-per-file-word-list (word)
"Add WORD to the per-file word list."
(or ispell-buffer-local-name
@ -4280,37 +4288,34 @@ Both should not be used to define a buffer-local dictionary."
(while (not done)
(let ((case-fold-search nil))
(setq search (search-forward ispell-words-keyword nil t)
found (or found search)
line-okay (< (+ (length word) 1 ; 1 for space after word..
(progn (end-of-line) (current-column)))
found (or found search)
line-okay (< (+ (length word) 1 ; 1 for space after word..
(progn (end-of-line) (current-column)))
fill-column)))
(if (or (and search line-okay)
(null search))
(progn
(setq done t)
(if (null search)
(progn
(if found (insert "\n") ;; after an existing LocalWords
(goto-char (point-max)) ;; no LocalWords, go to end of file
(open-line 1)
(newline))
(insert (if comment-start
(concat
(progn
;; Try and use the proper comment marker,
;; e.g. ";;" rather than ";".
(comment-normalize-vars)
(comment-padright comment-start
(comment-add nil))
comment-start)
" ")
"")
ispell-words-keyword)
(if (and comment-end (> (length comment-end) 0))
(save-excursion
(newline)
(insert comment-end)))))
(insert (concat " " word))))))))
(if (or (and search line-okay)
(null search))
(progn
(setq done t)
(if (null search)
(progn
(let ((empty-comment-end (or (not comment-end) (= (length comment-end) 0))))
(progn
(if found (progn ;; after an existing LocalWords
(insert "\n")
(when (and empty-comment-end comment-start)
(insert (ispell--comment-prefix) " ")))
(goto-char (point-max)) ;; no LocalWords, go to end of file
(open-line 1)
(newline)
;; Insert an end marker if needed, preceded by a newline.
(if (not empty-comment-end)
(save-excursion
(newline)
(insert comment-end)))
(when comment-start
(insert (ispell--comment-prefix) (if (not empty-comment-end) "\n" " "))))
(insert ispell-words-keyword)))))
(insert (concat " " word))))))))
(provide 'ispell)

10
test/lisp/textmodes/ispell-tests/ispell-tests.el
View file

@ -393,7 +393,8 @@ xml comment syntax, which has an opening and a closing marker."
(ispell-add-per-file-word-list testword)
(should (equal (buffer-string)
(concat "
<!-- " ispell-words-keyword " " testword "
<!--
" ispell-words-keyword " " testword "
-->
"))))))
@ -421,7 +422,6 @@ Uses default
xml comment syntax, which has an opening and a closing marker.
This test fails, because ispell.el does not work well with
nXML comments."
:expected-result :failed
(ispell-tests--letopt ((ispell-program-name "ispell"))
(with-temp-buffer
(let* ((testword (format "%s" (random)))
@ -434,11 +434,9 @@ nXML comments."
(ispell-add-per-file-word-list testword)
(should (equal (buffer-string)
(concat "
<!-- " ispell-words-keyword (make-string fill-column ?a) "
-->
<!-- " ispell-words-keyword (make-string fill-column ?a)
"
"
<!-- " ispell-words-keyword " " testword "
" ispell-words-keyword " " testword "
-->
")))))))