summaryrefslogtreecommitdiff
path: root/lisp/textmodes/reftex-global.el
diff options
context:
space:
mode:
authorCarsten Dominik <dominik@science.uva.nl>1999-08-16 07:42:41 +0000
committerCarsten Dominik <dominik@science.uva.nl>1999-08-16 07:42:41 +0000
commit1a9461d069cbf51a16b453f283b1367e05c875b9 (patch)
treed05c375019904907df3a76e416841ea70ea1526b /lisp/textmodes/reftex-global.el
parent1c25ed90c026bcd40182860500c722e632f15bd9 (diff)
downloademacs-1a9461d069cbf51a16b453f283b1367e05c875b9.tar.gz
Initial revision
Diffstat (limited to 'lisp/textmodes/reftex-global.el')
-rw-r--r--lisp/textmodes/reftex-global.el295
1 files changed, 295 insertions, 0 deletions
diff --git a/lisp/textmodes/reftex-global.el b/lisp/textmodes/reftex-global.el
new file mode 100644
index 00000000000..72cf27a4fad
--- /dev/null
+++ b/lisp/textmodes/reftex-global.el
@@ -0,0 +1,295 @@
+;;; reftex-global.el - Operations on entire documents with RefTeX
+;;; Version: 4.5
+;;;
+;;; See main file reftex.el for licensing information
+
+(provide 'reftex-global)
+(require 'reftex)
+;;;
+
+(defun reftex-create-tags-file ()
+ "Create TAGS file by running `etags' on the current document.
+The TAGS file is also immediately visited with `visit-tags-table'."
+ (interactive)
+ (reftex-access-scan-info current-prefix-arg)
+ (let* ((master (reftex-TeX-master-file))
+ (files (reftex-all-document-files))
+ (cmd (format "etags %s" (mapconcat 'identity files " "))))
+ (save-excursion
+ (set-buffer (reftex-get-buffer-visiting master))
+ (message "Running etags to create TAGS file...")
+ (shell-command cmd)
+ (visit-tags-table "TAGS"))))
+
+;; History of grep commands.
+(defvar reftex-grep-history nil)
+(defvar reftex-grep-command "grep -n "
+ "Last grep command used in \\[reftex-grep-document]; default for next grep.")
+
+(defun reftex-grep-document (grep-cmd)
+ "Run grep query through all files related to this document.
+With prefix arg, force to rescan document.
+No active TAGS table is required."
+
+ (interactive
+ (list (read-from-minibuffer "Run grep on document (like this): "
+ reftex-grep-command nil nil
+ 'reftex-grep-history)))
+ (reftex-access-scan-info current-prefix-arg)
+ (let* ((files (reftex-all-document-files t))
+ (cmd (format
+ "%s %s" grep-cmd
+ (mapconcat 'identity files " "))))
+ (grep cmd)))
+
+(defun reftex-search-document (&optional regexp)
+ "Regexp search through all files of the current document.
+Starts always in the master file. Stops when a match is found.
+To continue searching for next match, use command \\[tags-loop-continue].
+No active TAGS table is required."
+ (interactive)
+ (let ((default (reftex-this-word)))
+ (unless regexp
+ (setq regexp (read-string (format "Search regexp in document [%s]: "
+ default))))
+ (if (string= regexp "") (setq regexp (regexp-quote default)))
+
+ (reftex-access-scan-info current-prefix-arg)
+ (tags-search regexp (list 'reftex-all-document-files))))
+
+(defun reftex-query-replace-document (&optional from to delimited)
+ "Run a query-replace-regexp of FROM with TO over the entire document.
+Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
+If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
+with the command \\[tags-loop-continue].
+No active TAGS table is required."
+ (interactive)
+ (let ((default (reftex-this-word)))
+ (unless from
+ (setq from (read-string (format "Replace regexp in document [%s]: "
+ default)))
+ (if (string= from "") (setq from (regexp-quote default))))
+ (unless to
+ (setq to (read-string (format "Replace regexp %s with: " from))))
+ (reftex-access-scan-info current-prefix-arg)
+ (tags-query-replace from to (or delimited current-prefix-arg)
+ (list 'reftex-all-document-files))))
+
+(defun reftex-find-duplicate-labels ()
+ "Produce a list of all duplicate labels in the document."
+
+ (interactive)
+
+ ;; Rescan the document to make sure
+ (reftex-access-scan-info t)
+
+ (let ((master (reftex-TeX-master-file))
+ (cnt 0)
+ (dlist
+ (mapcar
+ (lambda (x)
+ (let (x1)
+ (cond
+ ((memq (car x)
+ '(toc bof eof bib thebib label-numbers xr xr-doc
+ master-dir file-error bibview-cache appendix
+ is-multi index))
+ nil)
+ (t
+ (setq x1 (reftex-all-assoc-string
+ (car x) (symbol-value reftex-docstruct-symbol)))
+ (if (< 1 (length x1))
+ (append (list (car x))
+ (mapcar (lambda(x)
+ (abbreviate-file-name (nth 3 x)))
+ x1))
+ (list nil))))))
+ (reftex-uniquify-by-car (symbol-value reftex-docstruct-symbol)))))
+
+ (setq dlist (reftex-uniquify-by-car dlist))
+ (if (null dlist) (error "No duplicate labels in document"))
+ (switch-to-buffer-other-window "*Duplicate Labels*")
+ (set (make-local-variable 'TeX-master) master)
+ (erase-buffer)
+ (insert " MULTIPLE LABELS IN CURRENT DOCUMENT:\n")
+ (insert
+ " Move point to label and type `r' to run a query-replace on the label\n"
+ " and its references. Type `q' to exit this buffer.\n\n")
+ (insert " LABEL FILE\n")
+ (insert " -------------------------------------------------------------\n")
+ (use-local-map (make-sparse-keymap))
+ (local-set-key [?q] (lambda () "Kill this buffer." (interactive)
+ (kill-buffer (current-buffer)) (delete-window)))
+ (local-set-key [?r] 'reftex-change-label)
+ (while dlist
+ (when (and (car (car dlist))
+ (cdr (car dlist)))
+ (incf cnt)
+ (insert (mapconcat 'identity (car dlist) "\n ") "\n"))
+ (pop dlist))
+ (goto-char (point-min))
+ (when (= cnt 0)
+ (kill-buffer (current-buffer))
+ (delete-window)
+ (message "Document does not contain duplicate labels."))))
+
+(defun reftex-change-label (&optional from to)
+ "Query replace FROM with TO in all \\label and \\ref commands.
+Works on the entire multifile document.
+If you exit (\\[keyboard-quit] or ESC), you can resume the query replace
+with the command \\[tags-loop-continue].
+No active TAGS table is required."
+ (interactive)
+ (let ((default (reftex-this-word "-a-zA-Z0-9_*.:")))
+ (unless from
+ (setq from (read-string (format "Replace label globally [%s]: "
+ default))))
+ (if (string= from "") (setq from default))
+ (unless to
+ (setq to (read-string (format "Replace label %s with: "
+ from))))
+ (reftex-query-replace-document
+ (concat "\\\\\\(label\\|[a-z]*ref\\){" (regexp-quote from) "}")
+ (format "\\\\\\1{%s}" to))))
+
+(defun reftex-renumber-simple-labels ()
+ "Renumber all simple labels in the document to make them sequentially.
+Simple labels are the ones created by RefTeX, consisting only of the
+prefix and a number. After the command completes, all these labels will
+have sequential numbers throughout the document. Any references to
+the labels will be changed as well. For this, RefTeX looks at the
+arguments of any macros which either start or end in the string `ref'.
+This command should be used with care, in particular in multifile
+documents. You should not use it if another document refers to this
+one with the `xr' package."
+ (interactive)
+ ;; Resan the entire document
+ (reftex-access-scan-info 1)
+ ;; Get some insurance
+ (if (and (reftex-is-multi)
+ (not (yes-or-no-p "Replacing all simple labels in multiple files is risky. Continue? ")))
+ (error "Abort"))
+ ;; Make the translation list
+ (let* ((re-core (concat "\\("
+ (mapconcat 'cdr reftex-typekey-to-prefix-alist "\\|")
+ "\\)"))
+ (label-re (concat "\\`" re-core "\\([0-9]+\\)\\'"))
+ (search-re (concat "[{,]\\(" re-core "\\([0-9]+\\)\\)[,}]"))
+ (error-fmt "Undefined label or reference %s. Ignore and continue? ")
+ (label-numbers-alist (mapcar (lambda (x) (cons (cdr x) 0))
+ reftex-typekey-to-prefix-alist))
+ (files (reftex-all-document-files))
+ (list (symbol-value reftex-docstruct-symbol))
+ translate-alist n entry label new-label nr-cell changed-sequence)
+
+ (while (setq entry (pop list))
+ (when (and (stringp (car entry))
+ (string-match label-re (car entry)))
+ (setq label (car entry)
+ nr-cell (assoc (match-string 1 (car entry))
+ label-numbers-alist))
+ (if (assoc label translate-alist)
+ (error "Duplicate label %s" label))
+ (setq new-label (concat (match-string 1 (car entry))
+ (incf (cdr nr-cell))))
+ (push (cons label new-label) translate-alist)
+ (or (string= label new-label) (setq changed-sequence t))))
+
+ (unless changed-sequence
+ (error "Simple labels are already in correct sequence"))
+
+ ;; Save all document buffers before this operation
+ (reftex-save-all-document-buffers)
+
+ ;; First test to check for erros
+ (setq n (reftex-translate
+ files search-re translate-alist error-fmt 'test))
+
+ ;; Now the real thing.
+ (if (yes-or-no-p
+ (format "Replace %d items at %d places in %d files? "
+ (length translate-alist) n (length files)))
+ (progn
+ (let ((inhibit-quit t)) ;; Do not disturb...
+ (reftex-translate
+ files search-re translate-alist error-fmt nil)
+ (setq quit-flag nil))
+ (if (and (reftex-is-multi)
+ (yes-or-no-p "Save entire document? "))
+ (reftex-save-all-document-buffers))
+ ;; Rescan again...
+ (reftex-access-scan-info 1)
+ (message "Done replacing simple labels."))
+ (message "No replacements done"))))
+
+(defun reftex-translate (files search-re translate-alist error-fmt test)
+ ;; In FILES, look for SEARCH-RE and replace match 1 of it with
+ ;; its association in TRANSLATE-ALSIT.
+ ;; If we do not find an association and TEST is non-nil, query
+ ;; to ignore the problematic string.
+ ;; If TEST is nil, it is ignored without query.
+ ;; Return the number of replacements.
+ (let ((n 0) file label match-data buf macro pos cell)
+ (while (setq file (pop files))
+ (setq buf (reftex-get-file-buffer-force file))
+ (unless buf
+ (error "No such file %s" file))
+ (set-buffer buf)
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char (point-min))
+ (while (re-search-forward search-re nil t)
+ (backward-char)
+ (save-excursion
+ (setq label (reftex-match-string 1)
+ cell (assoc label translate-alist)
+ match-data (match-data)
+ macro (reftex-what-macro 1)
+ pos (cdr macro))
+ (goto-char (or pos (point)))
+ (when (and macro
+ (or (looking-at "\\\\ref")
+ (looking-at "\\\\[a-zA-Z]*ref\\(range\\)?[^a-zA-Z]")
+ (looking-at "\\\\ref[a-zA-Z]*[^a-zA-Z]")
+ (looking-at (format
+ reftex-find-label-regexp-format
+ (regexp-quote label)))))
+ ;; OK, we should replace it.
+ (set-match-data match-data)
+ (cond
+ ((and test (not cell))
+ ;; We've got a problem
+ (unwind-protect
+ (progn
+ (reftex-highlight 1 (match-beginning 0) (match-end 0))
+ (ding)
+ (or (y-or-n-p (format error-fmt label))
+ (error "Abort")))
+ (reftex-unhighlight 1)))
+ ((and test cell)
+ (incf n))
+ ((and (not test) cell)
+ ;; Replace
+ (goto-char (match-beginning 1))
+ (delete-region (match-beginning 1) (match-end 1))
+ (insert (cdr cell)))
+ (t nil))))))))
+ n))
+
+(defun reftex-save-all-document-buffers ()
+ "Save all documents associated with the current document.
+The function is useful after a global action like replacing or renumbering
+labels."
+ (interactive)
+ (let ((files (reftex-all-document-files))
+ file buffer)
+ (save-excursion
+ (while (setq file (pop files))
+ (setq buffer (reftex-get-buffer-visiting file))
+ (when buffer
+ (set-buffer buffer)
+ (save-buffer))))))
+
+
+;;; reftex-global.el ends here