[bpt/emacs.git] / lisp / textmodes / reftex-global.el

;;; reftex-global.el --- operations on entire documents with RefTeX
;; Copyright (C) 1997, 1998, 1999, 2000, 2003, 2004, 2005,
;;   2006 Free Software Foundation, Inc.

;; Author: Carsten Dominik <dominik@science.uva.nl>
;; Version: 4.31

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;;; Code:

(eval-when-compile (require 'cl))
(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-file-buffer-force 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)
  "Do `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], RET or q), 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))))

(eval-when-compile
  (defvar TeX-master)
  (defvar isearch-next-buffer-function))

(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)
  "Run `query-replace-regexp' of FROM with TO in all macro arguments.
Works on the entire multifile document.
If you exit (\\[keyboard-quit], RET or q), 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 "{" (regexp-quote from) "}")
     (format "{%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))
                                (int-to-string (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"))

    (reftex-ensure-write-access (reftex-all-document-files))

    ;; 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))))))

(defun reftex-ensure-write-access (files)
  "Make sure we have write access to all files in FILES.
Also checks if buffers visiting the files are in read-only mode."
  (let (file buf)
    (while (setq file (pop files))
      (unless (file-exists-p file)
        (ding)
        (or (y-or-n-p (format "No such file %s. Continue? " file))
            (error "Abort")))
      (unless (file-writable-p file)
        (ding)
        (or (y-or-n-p (format "No write access to %s. Continue? " file))
            (error "Abort")))
      (when (and (setq buf (reftex-get-buffer-visiting file))
                 (save-excursion
                   (set-buffer buf)
                   buffer-read-only))
        (ding)
        (or (y-or-n-p (format "Buffer %s is read-only. Continue? "
                              (buffer-name buf)))
            (error "Abort"))))))

(defun reftex-isearch-wrap-function ()
  (if (not isearch-word)
      (switch-to-buffer 
       (funcall isearch-next-buffer-function (current-buffer) t)))
  (goto-char (if isearch-forward (point-min) (point-max))))

(defun reftex-isearch-push-state-function ()
  `(lambda (cmd)
     (reftex-isearch-pop-state-function cmd ,(current-buffer))))

(defun reftex-isearch-pop-state-function (cmd buffer)
  (switch-to-buffer buffer))

(defun reftex-isearch-isearch-search (string bound noerror)
  (let ((nxt-buff nil)
	(search-fun
	 (cond
	  (isearch-word
	   (if isearch-forward 'word-search-forward 'word-search-backward))
	  (isearch-regexp
	   (if isearch-forward 're-search-forward 're-search-backward))
	  (t
	   (if isearch-forward 'search-forward 'search-backward)))))
    (or
     (funcall search-fun string bound noerror)
     (unless bound
       (condition-case nil
	   (when isearch-next-buffer-function
	     (while (not (funcall search-fun string bound noerror))
	       (cond
		(isearch-forward
		 (setq nxt-buff
		       (funcall isearch-next-buffer-function
				(current-buffer)))
		 (if (not nxt-buff)
		     (progn
		       (error "Wrap forward"))
		   (switch-to-buffer nxt-buff)
		   (goto-char (point-min))))
		(t
		 (setq nxt-buff
		       (funcall isearch-next-buffer-function
					 (current-buffer)))
		 (if (not nxt-buff)
		     (progn
		       (error "Wrap backward"))
		   (switch-to-buffer nxt-buff)
		   (goto-char (point-max))))))
	     (point))
	 (error nil))))))

;;; This function is called when isearch reaches the end of a
;;; buffer. For reftex what we want to do is not wrap to the
;;; beginning, but switch to the next buffer in the logical order of
;;; the document.  This function looks through list of files in the
;;; document (reftex-all-document-files), searches for the current
;;; buffer and switches to the next/previous one in the logical order
;;; of the document.  If WRAPP is true then wrap the search to the
;;; beginning/end of the file list, depending of the search direction.
(defun reftex-isearch-switch-to-next-file (crt-buf &optional wrapp)
  (reftex-access-scan-info)
  (let* ((cb (buffer-file-name crt-buf))
	 (flist (reftex-all-document-files))
	 (orig-flist flist))
    (when flist
      (if wrapp
	  (unless isearch-forward
	      (setq flist (last flist)))
	(unless isearch-forward
	  (setq flist (nreverse (copy-list flist)))
	  (setq orig-flist flist))
	(while (not (string= (car flist) cb))
	  (setq flist (cdr flist)))
	(setq flist (cdr flist)))
      (when flist
	(find-file  (car flist))))))

;;;###autoload
(defun reftex-isearch-minor-mode (&optional arg)
  "When on, isearch searches the whole document, not only the current file.
This minor mode allows isearch to search through all the files of
the current TeX document.

With no argument, this command toggles
`reftex-isearch-minor-mode'.  With a prefix argument ARG, turn
`reftex-isearch-minor-mode' on iff ARG is positive."
  (interactive "P")
  (let ((old-reftex-isearch-minor-mode reftex-isearch-minor-mode))
    (setq reftex-isearch-minor-mode 
	  (not (or (and (null arg) reftex-isearch-minor-mode)
		   (<= (prefix-numeric-value arg) 0))))
    (unless (eq reftex-isearch-minor-mode old-reftex-isearch-minor-mode)
      (if reftex-isearch-minor-mode
	  (progn
	    (dolist (crt-buf (buffer-list))
	      (with-current-buffer crt-buf
		(when reftex-mode
		  (set (make-local-variable 'isearch-wrap-function)
		       'reftex-isearch-wrap-function)
		  (set (make-local-variable 'isearch-search-fun-function)
		       (lambda () 'reftex-isearch-isearch-search))
		  (set (make-local-variable 'isearch-push-state-function)
		       'reftex-isearch-push-state-function)
		  (set (make-local-variable 'isearch-next-buffer-function)
		       'reftex-isearch-switch-to-next-file)
		  (setq reftex-isearch-minor-mode t))))
	    (add-hook 'reftex-mode-hook 'reftex-isearch-minor-mode))
	(dolist (crt-buf (buffer-list))
	  (with-current-buffer crt-buf
	    (when reftex-mode
	      (kill-local-variable 'isearch-wrap-function)
	      (kill-local-variable 'isearch-search-fun-function)
	      (kill-local-variable 'isearch-push-state-function)
	      (kill-local-variable 'isearch-next-buffer-function)
	      (setq reftex-isearch-minor-mode nil))))
	(remove-hook 'reftex-mode-hook 'reftex-isearch-minor-mode)))
    ;; Force modeline redisplay.
    (set-buffer-modified-p (buffer-modified-p))))

(add-minor-mode 'reftex-isearch-minor-mode "/I" nil nil 
		'reftex-isearch-minor-mode)

;;; arch-tag: 2dbf7633-92c8-4340-8656-7aa019d0f80d
;;; reftex-global.el ends here
Commit	Line	Data
3afbc435	1	;;; reftex-global.el --- operations on entire documents with RefTeX
ceb4c4d3 TTN	2	;; Copyright (C) 1997, 1998, 1999, 2000, 2003, 2004, 2005,
ceb4c4d3 TTN	3	;; 2006 Free Software Foundation, Inc.
3ba2590f	4
6fbeb429	5	;; Author: Carsten Dominik <dominik@science.uva.nl>
5d2a58e0	6	;; Version: 4.31
3ba2590f RS	7
	8	;; This file is part of GNU Emacs.
	9
	10	;; GNU Emacs is free software; you can redistribute it and/or modify
	11	;; it under the terms of the GNU General Public License as published by
	12	;; the Free Software Foundation; either version 2, or (at your option)
	13	;; any later version.
	14
	15	;; GNU Emacs is distributed in the hope that it will be useful,
	16	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	;; GNU General Public License for more details.
	19
	20	;; You should have received a copy of the GNU General Public License
	21	;; along with GNU Emacs; see the file COPYING. If not, write to the
27e81652 TTN	22	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27e81652 TTN	23	;; Boston, MA 02110-1301, USA.
1a9461d0	24
3afbc435 PJ	25	;;; Commentary:
	26
	27	;;; Code:
	28
7c4d13cc	29	(eval-when-compile (require 'cl))
1a9461d0 CD	30	(provide 'reftex-global)
	31	(require 'reftex)
	32	;;;
	33
	34	(defun reftex-create-tags-file ()
	35	"Create TAGS file by running `etags' on the current document.
	36	The TAGS file is also immediately visited with `visit-tags-table'."
	37	(interactive)
	38	(reftex-access-scan-info current-prefix-arg)
	39	(let* ((master (reftex-TeX-master-file))
	40	(files (reftex-all-document-files))
	41	(cmd (format "etags %s" (mapconcat 'identity files " "))))
	42	(save-excursion
11b4a0d2	43	(set-buffer (reftex-get-file-buffer-force master))
1a9461d0 CD	44	(message "Running etags to create TAGS file...")
	45	(shell-command cmd)
	46	(visit-tags-table "TAGS"))))
	47
	48	;; History of grep commands.
	49	(defvar reftex-grep-history nil)
	50	(defvar reftex-grep-command "grep -n "
	51	"Last grep command used in \\[reftex-grep-document]; default for next grep.")
	52
	53	(defun reftex-grep-document (grep-cmd)
	54	"Run grep query through all files related to this document.
	55	With prefix arg, force to rescan document.
	56	No active TAGS table is required."
	57
	58	(interactive
	59	(list (read-from-minibuffer "Run grep on document (like this): "
	60	reftex-grep-command nil nil
	61	'reftex-grep-history)))
	62	(reftex-access-scan-info current-prefix-arg)
	63	(let* ((files (reftex-all-document-files t))
	64	(cmd (format
	65	"%s %s" grep-cmd
	66	(mapconcat 'identity files " "))))
	67	(grep cmd)))
	68
	69	(defun reftex-search-document (&optional regexp)
	70	"Regexp search through all files of the current document.
	71	Starts always in the master file. Stops when a match is found.
	72	To continue searching for next match, use command \\[tags-loop-continue].
	73	No active TAGS table is required."
	74	(interactive)
	75	(let ((default (reftex-this-word)))
	76	(unless regexp
	77	(setq regexp (read-string (format "Search regexp in document [%s]: "
	78	default))))
	79	(if (string= regexp "") (setq regexp (regexp-quote default)))
	80
	81	(reftex-access-scan-info current-prefix-arg)
	82	(tags-search regexp (list 'reftex-all-document-files))))
	83
	84	(defun reftex-query-replace-document (&optional from to delimited)
44fc58f2	85	"Do `query-replace-regexp' of FROM with TO over the entire document.
1a9461d0	86	Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
44fc58f2	87	If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
1a9461d0 CD	88	with the command \\[tags-loop-continue].
	89	No active TAGS table is required."
	90	(interactive)
	91	(let ((default (reftex-this-word)))
	92	(unless from
	93	(setq from (read-string (format "Replace regexp in document [%s]: "
	94	default)))
	95	(if (string= from "") (setq from (regexp-quote default))))
	96	(unless to
	97	(setq to (read-string (format "Replace regexp %s with: " from))))
	98	(reftex-access-scan-info current-prefix-arg)
	99	(tags-query-replace from to (or delimited current-prefix-arg)
	100	(list 'reftex-all-document-files))))
	101
7b07114a CD	102	(eval-when-compile
	103	(defvar TeX-master)
	104	(defvar isearch-next-buffer-function))
	105
1a9461d0 CD	106	(defun reftex-find-duplicate-labels ()
	107	"Produce a list of all duplicate labels in the document."
	108
	109	(interactive)
	110
	111	;; Rescan the document to make sure
	112	(reftex-access-scan-info t)
	113
	114	(let ((master (reftex-TeX-master-file))
3666daf6	115	(cnt 0)
1a9461d0 CD	116	(dlist
1a9461d0 CD	117	(mapcar
3666daf6 CD	118	(lambda (x)
	119	(let (x1)
	120	(cond
	121	((memq (car x)
	122	'(toc bof eof bib thebib label-numbers xr xr-doc
	123	master-dir file-error bibview-cache appendix
	124	is-multi index))
	125	nil)
	126	(t
	127	(setq x1 (reftex-all-assoc-string
	128	(car x) (symbol-value reftex-docstruct-symbol)))
	129	(if (< 1 (length x1))
	130	(append (list (car x))
	131	(mapcar (lambda(x)
	132	(abbreviate-file-name (nth 3 x)))
	133	x1))
	134	(list nil))))))
1a9461d0 CD	135	(reftex-uniquify-by-car (symbol-value reftex-docstruct-symbol)))))
	136
	137	(setq dlist (reftex-uniquify-by-car dlist))
	138	(if (null dlist) (error "No duplicate labels in document"))
	139	(switch-to-buffer-other-window "Duplicate Labels")
	140	(set (make-local-variable 'TeX-master) master)
	141	(erase-buffer)
	142	(insert " MULTIPLE LABELS IN CURRENT DOCUMENT:\n")
7b07114a	143	(insert
1a9461d0 CD	144	" Move point to label and type `r' to run a query-replace on the label\n"
	145	" and its references. Type `q' to exit this buffer.\n\n")
	146	(insert " LABEL FILE\n")
	147	(insert " -------------------------------------------------------------\n")
	148	(use-local-map (make-sparse-keymap))
	149	(local-set-key [?q] (lambda () "Kill this buffer." (interactive)
3666daf6	150	(kill-buffer (current-buffer)) (delete-window)))
1a9461d0 CD	151	(local-set-key [?r] 'reftex-change-label)
	152	(while dlist
	153	(when (and (car (car dlist))
	154	(cdr (car dlist)))
3666daf6	155	(incf cnt)
1a9461d0 CD	156	(insert (mapconcat 'identity (car dlist) "\n ") "\n"))
	157	(pop dlist))
	158	(goto-char (point-min))
	159	(when (= cnt 0)
	160	(kill-buffer (current-buffer))
	161	(delete-window)
	162	(message "Document does not contain duplicate labels."))))
	163
	164	(defun reftex-change-label (&optional from to)
3666daf6	165	"Run `query-replace-regexp' of FROM with TO in all macro arguments.
1a9461d0	166	Works on the entire multifile document.
44fc58f2	167	If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
1a9461d0 CD	168	with the command \\[tags-loop-continue].
	169	No active TAGS table is required."
	170	(interactive)
	171	(let ((default (reftex-this-word "-a-zA-Z0-9_*.:")))
	172	(unless from
	173	(setq from (read-string (format "Replace label globally [%s]: "
	174	default))))
	175	(if (string= from "") (setq from default))
	176	(unless to
	177	(setq to (read-string (format "Replace label %s with: "
	178	from))))
	179	(reftex-query-replace-document
3666daf6 CD	180	(concat "{" (regexp-quote from) "}")
3666daf6 CD	181	(format "{%s}" to))))
1a9461d0 CD	182
	183	(defun reftex-renumber-simple-labels ()
	184	"Renumber all simple labels in the document to make them sequentially.
	185	Simple labels are the ones created by RefTeX, consisting only of the
	186	prefix and a number. After the command completes, all these labels will
	187	have sequential numbers throughout the document. Any references to
	188	the labels will be changed as well. For this, RefTeX looks at the
	189	arguments of any macros which either start or end in the string `ref'.
	190	This command should be used with care, in particular in multifile
	191	documents. You should not use it if another document refers to this
	192	one with the `xr' package."
	193	(interactive)
	194	;; Resan the entire document
	195	(reftex-access-scan-info 1)
	196	;; Get some insurance
	197	(if (and (reftex-is-multi)
3666daf6	198	(not (yes-or-no-p "Replacing all simple labels in multiple files is risky. Continue? ")))
1a9461d0 CD	199	(error "Abort"))
1a9461d0 CD	200	;; Make the translation list
7b07114a CD	201	(let* ((re-core (concat "\\("
7b07114a CD	202	(mapconcat 'cdr reftex-typekey-to-prefix-alist "\\\|")
3666daf6 CD	203	"\\)"))
	204	(label-re (concat "\\`" re-core "\\([0-9]+\\)\\'"))
	205	(search-re (concat "[{,]\\(" re-core "\\([0-9]+\\)\\)[,}]"))
	206	(error-fmt "Undefined label or reference %s. Ignore and continue? ")
	207	(label-numbers-alist (mapcar (lambda (x) (cons (cdr x) 0))
	208	reftex-typekey-to-prefix-alist))
	209	(files (reftex-all-document-files))
	210	(list (symbol-value reftex-docstruct-symbol))
	211	translate-alist n entry label new-label nr-cell changed-sequence)
1a9461d0 CD	212
	213	(while (setq entry (pop list))
	214	(when (and (stringp (car entry))
3666daf6 CD	215	(string-match label-re (car entry)))
	216	(setq label (car entry)
	217	nr-cell (assoc (match-string 1 (car entry))
	218	label-numbers-alist))
	219	(if (assoc label translate-alist)
	220	(error "Duplicate label %s" label))
	221	(setq new-label (concat (match-string 1 (car entry))
	222	(int-to-string (incf (cdr nr-cell)))))
	223	(push (cons label new-label) translate-alist)
	224	(or (string= label new-label) (setq changed-sequence t))))
1a9461d0 CD	225
	226	(unless changed-sequence
	227	(error "Simple labels are already in correct sequence"))
	228
d8fb2015 CD	229	(reftex-ensure-write-access (reftex-all-document-files))
d8fb2015 CD	230
1a9461d0 CD	231	;; Save all document buffers before this operation
	232	(reftex-save-all-document-buffers)
	233
	234	;; First test to check for erros
7b07114a	235	(setq n (reftex-translate
3666daf6	236	files search-re translate-alist error-fmt 'test))
1a9461d0 CD	237
1a9461d0 CD	238	;; Now the real thing.
7b07114a	239	(if (yes-or-no-p
3666daf6 CD	240	(format "Replace %d items at %d places in %d files? "
	241	(length translate-alist) n (length files)))
	242	(progn
	243	(let ((inhibit-quit t)) ;; Do not disturb...
	244	(reftex-translate
	245	files search-re translate-alist error-fmt nil)
	246	(setq quit-flag nil))
	247	(if (and (reftex-is-multi)
	248	(yes-or-no-p "Save entire document? "))
	249	(reftex-save-all-document-buffers))
	250	;; Rescan again...
	251	(reftex-access-scan-info 1)
	252	(message "Done replacing simple labels."))
1a9461d0 CD	253	(message "No replacements done"))))
	254
	255	(defun reftex-translate (files search-re translate-alist error-fmt test)
	256	;; In FILES, look for SEARCH-RE and replace match 1 of it with
7b07114a	257	;; its association in TRANSLATE-ALSIT.
1a9461d0	258	;; If we do not find an association and TEST is non-nil, query
7b07114a	259	;; to ignore the problematic string.
1a9461d0 CD	260	;; If TEST is nil, it is ignored without query.
	261	;; Return the number of replacements.
	262	(let ((n 0) file label match-data buf macro pos cell)
	263	(while (setq file (pop files))
	264	(setq buf (reftex-get-file-buffer-force file))
	265	(unless buf
3666daf6	266	(error "No such file %s" file))
1a9461d0 CD	267	(set-buffer buf)
1a9461d0 CD	268	(save-excursion
3666daf6 CD	269	(save-restriction
	270	(widen)
	271	(goto-char (point-min))
	272	(while (re-search-forward search-re nil t)
	273	(backward-char)
	274	(save-excursion
	275	(setq label (reftex-match-string 1)
	276	cell (assoc label translate-alist)
	277	match-data (match-data)
	278	macro (reftex-what-macro 1)
	279	pos (cdr macro))
	280	(goto-char (or pos (point)))
	281	(when (and macro
	282	(or (looking-at "\\\\ref")
	283	(looking-at "\\\\[a-zA-Z]*ref\\(range\\)?[^a-zA-Z]")
	284	(looking-at "\\\\ref[a-zA-Z]*[^a-zA-Z]")
7b07114a	285	(looking-at (format
3666daf6 CD	286	reftex-find-label-regexp-format
	287	(regexp-quote label)))))
	288	;; OK, we should replace it.
	289	(set-match-data match-data)
	290	(cond
	291	((and test (not cell))
	292	;; We've got a problem
	293	(unwind-protect
	294	(progn
	295	(reftex-highlight 1 (match-beginning 0) (match-end 0))
	296	(ding)
	297	(or (y-or-n-p (format error-fmt label))
	298	(error "Abort")))
	299	(reftex-unhighlight 1)))
	300	((and test cell)
	301	(incf n))
	302	((and (not test) cell)
	303	;; Replace
	304	(goto-char (match-beginning 1))
	305	(delete-region (match-beginning 1) (match-end 1))
	306	(insert (cdr cell)))
	307	(t nil))))))))
1a9461d0 CD	308	n))
	309
	310	(defun reftex-save-all-document-buffers ()
	311	"Save all documents associated with the current document.
	312	The function is useful after a global action like replacing or renumbering
	313	labels."
	314	(interactive)
	315	(let ((files (reftex-all-document-files))
3666daf6	316	file buffer)
1a9461d0 CD	317	(save-excursion
1a9461d0 CD	318	(while (setq file (pop files))
3666daf6 CD	319	(setq buffer (reftex-get-buffer-visiting file))
	320	(when buffer
	321	(set-buffer buffer)
	322	(save-buffer))))))
1a9461d0	323
d8fb2015 CD	324	(defun reftex-ensure-write-access (files)
	325	"Make sure we have write access to all files in FILES.
	326	Also checks if buffers visiting the files are in read-only mode."
	327	(let (file buf)
	328	(while (setq file (pop files))
	329	(unless (file-exists-p file)
3666daf6 CD	330	(ding)
	331	(or (y-or-n-p (format "No such file %s. Continue? " file))
	332	(error "Abort")))
d8fb2015	333	(unless (file-writable-p file)
3666daf6 CD	334	(ding)
	335	(or (y-or-n-p (format "No write access to %s. Continue? " file))
	336	(error "Abort")))
d8fb2015	337	(when (and (setq buf (reftex-get-buffer-visiting file))
3666daf6 CD	338	(save-excursion
	339	(set-buffer buf)
	340	buffer-read-only))
	341	(ding)
	342	(or (y-or-n-p (format "Buffer %s is read-only. Continue? "
	343	(buffer-name buf)))
	344	(error "Abort"))))))
1a9461d0	345
0072e19e CD	346	(defun reftex-isearch-wrap-function ()
0072e19e CD	347	(if (not isearch-word)
7b07114a	348	(switch-to-buffer
0072e19e CD	349	(funcall isearch-next-buffer-function (current-buffer) t)))
	350	(goto-char (if isearch-forward (point-min) (point-max))))
	351
	352	(defun reftex-isearch-push-state-function ()
	353	`(lambda (cmd)
	354	(reftex-isearch-pop-state-function cmd ,(current-buffer))))
	355
	356	(defun reftex-isearch-pop-state-function (cmd buffer)
	357	(switch-to-buffer buffer))
	358
	359	(defun reftex-isearch-isearch-search (string bound noerror)
	360	(let ((nxt-buff nil)
	361	(search-fun
	362	(cond
	363	(isearch-word
	364	(if isearch-forward 'word-search-forward 'word-search-backward))
	365	(isearch-regexp
	366	(if isearch-forward 're-search-forward 're-search-backward))
	367	(t
	368	(if isearch-forward 'search-forward 'search-backward)))))
	369	(or
	370	(funcall search-fun string bound noerror)
	371	(unless bound
	372	(condition-case nil
	373	(when isearch-next-buffer-function
	374	(while (not (funcall search-fun string bound noerror))
	375	(cond
	376	(isearch-forward
	377	(setq nxt-buff
	378	(funcall isearch-next-buffer-function
	379	(current-buffer)))
	380	(if (not nxt-buff)
	381	(progn
	382	(error "Wrap forward"))
	383	(switch-to-buffer nxt-buff)
	384	(goto-char (point-min))))
	385	(t
	386	(setq nxt-buff
	387	(funcall isearch-next-buffer-function
	388	(current-buffer)))
	389	(if (not nxt-buff)
	390	(progn
	391	(error "Wrap backward"))
	392	(switch-to-buffer nxt-buff)
	393	(goto-char (point-max))))))
	394	(point))
	395	(error nil))))))
	396
	397	;;; This function is called when isearch reaches the end of a
	398	;;; buffer. For reftex what we want to do is not wrap to the
	399	;;; beginning, but switch to the next buffer in the logical order of
	400	;;; the document. This function looks through list of files in the
	401	;;; document (reftex-all-document-files), searches for the current
	402	;;; buffer and switches to the next/previous one in the logical order
	403	;;; of the document. If WRAPP is true then wrap the search to the
	404	;;; beginning/end of the file list, depending of the search direction.
	405	(defun reftex-isearch-switch-to-next-file (crt-buf &optional wrapp)
	406	(reftex-access-scan-info)
	407	(let* ((cb (buffer-file-name crt-buf))
	408	(flist (reftex-all-document-files))
	409	(orig-flist flist))
	410	(when flist
	411	(if wrapp
	412	(unless isearch-forward
413	(setq flist (last flist)))
414	(unless isearch-forward
415	(setq flist (nreverse (copy-list flist)))
416	(setq orig-flist flist))
417	(while (not (string= (car flist) cb))
418	(setq flist (cdr flist)))
419	(setq flist (cdr flist)))
420	(when flist
421	(find-file (car flist))))))
422
0072e19e CD	423	;;;###autoload
	424	(defun reftex-isearch-minor-mode (&optional arg)
	425	"When on, isearch searches the whole document, not only the current file.
	426	This minor mode allows isearch to search through all the files of
	427	the current TeX document.
	428
	429	With no argument, this command toggles
	430	`reftex-isearch-minor-mode'. With a prefix argument ARG, turn
	431	`reftex-isearch-minor-mode' on iff ARG is positive."
	432	(interactive "P")
	433	(let ((old-reftex-isearch-minor-mode reftex-isearch-minor-mode))
7b07114a	434	(setq reftex-isearch-minor-mode
0072e19e CD	435	(not (or (and (null arg) reftex-isearch-minor-mode)
	436	(<= (prefix-numeric-value arg) 0))))
	437	(unless (eq reftex-isearch-minor-mode old-reftex-isearch-minor-mode)
	438	(if reftex-isearch-minor-mode
	439	(progn
	440	(dolist (crt-buf (buffer-list))
	441	(with-current-buffer crt-buf
	442	(when reftex-mode
	443	(set (make-local-variable 'isearch-wrap-function)
	444	'reftex-isearch-wrap-function)
	445	(set (make-local-variable 'isearch-search-fun-function)
	446	(lambda () 'reftex-isearch-isearch-search))
	447	(set (make-local-variable 'isearch-push-state-function)
	448	'reftex-isearch-push-state-function)
	449	(set (make-local-variable 'isearch-next-buffer-function)
	450	'reftex-isearch-switch-to-next-file)
	451	(setq reftex-isearch-minor-mode t))))
	452	(add-hook 'reftex-mode-hook 'reftex-isearch-minor-mode))
	453	(dolist (crt-buf (buffer-list))
	454	(with-current-buffer crt-buf
	455	(when reftex-mode
	456	(kill-local-variable 'isearch-wrap-function)
	457	(kill-local-variable 'isearch-search-fun-function)
	458	(kill-local-variable 'isearch-push-state-function)
	459	(kill-local-variable 'isearch-next-buffer-function)
	460	(setq reftex-isearch-minor-mode nil))))
	461	(remove-hook 'reftex-mode-hook 'reftex-isearch-minor-mode)))
	462	;; Force modeline redisplay.
	463	(set-buffer-modified-p (buffer-modified-p))))
	464
7b07114a	465	(add-minor-mode 'reftex-isearch-minor-mode "/I" nil nil
0072e19e CD	466	'reftex-isearch-minor-mode)
0072e19e CD	467
ab5796a9	468	;;; arch-tag: 2dbf7633-92c8-4340-8656-7aa019d0f80d
1a9461d0	469	;;; reftex-global.el ends here