geekinney/tp
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add documentation for string replacement length limitation

Browse Source 
Documented that for string objects, the replacement text must have the
same length as the original matched text due to store-substring limitations.

Co-authored-by: Kinneyzhang <38454496+Kinneyzhang@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-12-15 09:03:15 +00:00
parent 0b0bfedc6b
commit 798c88e559
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tp.el
View File

@ -1101,6 +1101,11 @@ OBJECT can be a buffer or string; nil defaults to current buffer.
Returns the number of successful matches. Returns the number of successful matches.
Note: For string objects, the replacement text must have the same length
as the original matched text, since strings have fixed length in Emacs.
If the replacement is shorter, only that portion will be replaced.
If the replacement is longer, it will be truncated.
Example: Example:
;; Upcase all matched text ;; Upcase all matched text
(tp-forward-do #\\='upcase \\='marker nil my-string 3)" (tp-forward-do #\\='upcase \\='marker nil my-string 3)"
@ -1115,6 +1120,7 @@ Example:
(when (and new-text (not (equal new-text text))) (when (and new-text (not (equal new-text text)))
(if (stringp obj) (if (stringp obj)
;; For strings, we need to replace in-place ;; For strings, we need to replace in-place
;; Note: store-substring has length restrictions
(progn (progn
(store-substring obj start new-text)) (store-substring obj start new-text))
;; For buffers, delete and insert ;; For buffers, delete and insert
@ -1165,6 +1171,11 @@ OBJECT can be a buffer or string; nil defaults to current buffer.
Returns the number of successful matches. Returns the number of successful matches.
Note: For string objects, the replacement text must have the same length
as the original matched text, since strings have fixed length in Emacs.
If the replacement is shorter, only that portion will be replaced.
If the replacement is longer, it will be truncated.
Example: Example:
;; Upcase all matched text ;; Upcase all matched text
(tp-backward-do #\\='upcase \\='marker nil my-string 3)" (tp-backward-do #\\='upcase \\='marker nil my-string 3)"
@ -1179,6 +1190,7 @@ Example:
(when (and new-text (not (equal new-text text))) (when (and new-text (not (equal new-text text)))
(if (stringp obj) (if (stringp obj)
;; For strings, we need to replace in-place ;; For strings, we need to replace in-place
;; Note: store-substring has length restrictions
(progn (progn
(store-substring obj start new-text)) (store-substring obj start new-text))
;; For buffers, delete and insert ;; For buffers, delete and insert
@ -1308,6 +1320,11 @@ of FUNCTION replaces the matched text in the string or buffer.
Returns the number of matches processed. Returns the number of matches processed.
Note: For string objects, the replacement text must have the same length
as the original matched text, since strings have fixed length in Emacs.
If the replacement is shorter, only that portion will be replaced.
If the replacement is longer, it will be truncated.
Example: Example:
;; Upcase all matched text ;; Upcase all matched text
(tp-search-map #\\='upcase my-string \\='marker)" (tp-search-map #\\='upcase my-string \\='marker)"