emacs: lisp/textmodes/refer.el comparison

comparison lisp/textmodes/refer.el @ 16473:4ef76e689d69

(refer-bib-directory): New variable, list of directories where to look for bib files. Special values `texinputs' and `bibinputs' mean take directory list from corresponding environment variable. (refer-bib-files): New special value `auto', for looking up all files in directories pointed to by refer-bib-directory. I have the feeling that this isn't really my code but came from the net (copylefted). However, I cannot trace this down any more. If it isn't mine, it's probably Ashwin's. (refer-get-bib-files): Support `auto' value of refer-bib-files. Support `texinputs', `bibinputs' value of refer-bib-directory. (refer-saved-state, refer-previous-keywords, refer-saved-pos, refer-same-file): Properly declared (defvar) these variables. (refer-yank-key): New function. (refer-find-entry-internal): Find bibliography entries in other window, with minimal reconfiguration of windows. (refer-expand-files): New function.

author	Richard M. Stallman <rms@gnu.org>
date	Sat, 26 Oct 1996 18:15:32 +0000
parents	83f275dcd93a
children	9b831f34ff7d

comparison

equal deleted inserted replaced

-:dbfab9e8b6d8
+:4ef76e689d69
 ;;; refer.el --- look up references in bibliography files.
-;; Copyright (C) 1992 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1996 Free Software Foundation, Inc.
-;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu>
+;; Author: Ashwin Ram <ashwin@cc.gatech.edu>
+;; Maintainer: Gernot Heiser <gernot@jungfrau.disy.cse.unsw.EDU.AU>
 ;; Adapted-By: ESR
 ;; Keywords: bib
 ;; This file is part of GNU Emacs.
 ;;          as search strings).
 ;;
 ;;      To continue the previous search, i.e., to search for the next occurrence
 ;;      of the keywords, use refer-find-next-entry, or invoke refer-find-entry
 ;;      with a prefix argument.
+;;
+;;	Once you've found the entry you want to reference, invoke
+;;	refer-yank-key to insert it at point in the current buffer
+;;	(typically as the argument of a \cite{} command).
+;;
+;;	I use (define-key tex-mode-map    "\C-c\C-y"  'refer-yank-key)
+;;	to bind this often-used function to a key in (la)tex-mode.
 ;;
 ;;      If the list of bibliography files changes, reinitialize the variable
 ;;      refer-bib-files.
 ;;
 ;; To customize:
 ;;      specified.  So you should be able to use pretty much any bib file with
 ;;      this code.  If your bib file does not use paragraphs to separate
 ;;      entries, try setting the paragraph-start/separate variables, or changing
 ;;      the (forward-paragraph 1) call in refer-find-entry-in-file.
-;;; ChangeLog:
-;; 01/08/89 Ashwin Ram <Ram-Ashwin@cs.yale.edu>
-;;          Initial release.
-;;
 ;;; Code:
 (provide 'refer)
+(defvar refer-bib-directory nil
+"Directory, or list of directories, to search for \\.bib files. Can
+be set to 'bibinputs or 'texinputs, in which case the environment
+variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a
+list of directories.  Useful only if refer-bib-files is set to 'dir or
+a list of file names (without directory). A value of nil indicates the
+current working directory.
+If refer-bib-directory is 'bibinputs or 'texinputs, it is setq'd to
+the appropriate list of directories when it is first used.
+Note that an empty directory is interpreted by BibTeX as indicating
+the default search path. Since Refer does not know that default path,
+it cannot search it. Include that path explicitly in your BIBINPUTS
+environment if you really want it searched (which is not likely to
+happen anyway).")
 (defvar refer-bib-files 'dir
 "*List of \\.bib files to search for references,
 or one of the following special values:
 nil  = prompt for \\.bib file (if visiting a \\.bib file, use it as default)
-auto = read \\.bib file names from appropriate command in buffer (see refer-bib-files-regexp)
+auto = read \\.bib file names from appropriate command in buffer (see
-dir  = use all \\.bib files in current directory.
+refer-bib-files-regexp) unless the buffer's mode is bibtex-mode,
+in which case only the buffer is searched
+dir  = use all \\.bib files in directories referenced by refer-bib-directory.
 If a specified file doesn't exist and has no extension, a \\.bib extension
 is automatically tried.
 If refer-bib-files is nil, auto or dir, it is setq'd to the appropriate
 (defvar refer-bib-files-regexp "\\\\bibliography"
 "*Regexp matching a bibliography file declaration.
 The current buffer is expected to contain a line such as
 \\bibliography{file1,file2,file3}
 which is read to set up refer-bib-files.  The regexp must specify the command
-\(such as \\bibliography) that is used to specify the list of bib files.  The
+(such as \\bibliography) that is used to specify the list of bib files.  The
 command is expected to specify a file name, or a list of comma-separated file
 names, within curly braces.
 If a specified file doesn't exist and has no extension, a \\.bib extension
 is automatically tried.")
 (make-variable-buffer-local 'refer-bib-files)
 (make-variable-buffer-local 'refer-cache-bib-files)
+(make-variable-buffer-local 'refer-bib-directory)
+;;; Internal variables
+(defvar refer-saved-state nil)
+(defvar refer-previous-keywords nil)
+(defvar refer-saved-pos nil)
+(defvar refer-same-file nil)
 (defun refer-find-entry (keywords &optional continue)
 "Find entry in refer-bib-files containing KEYWORDS.
 If KEYWORDS is nil, prompt user for blank-separated list of keywords.
 If CONTINUE is t, or if called interactively with a prefix arg, look for next
 entry by continuing search from previous point."
 (interactive (list nil current-prefix-arg))
 (or keywords (setq keywords (if continue
 refer-previous-keywords
 (read-string "Keywords: "))))
 (setq refer-previous-keywords keywords)
 (refer-find-entry-internal keywords continue))
 (defun refer-find-next-entry ()
 "Find next occurrence of entry in refer-bib-files.  See refer-find-entry."
 (interactive)
 (refer-find-entry-internal refer-previous-keywords t))
+(defun refer-yank-key ()
+"Inserts at point in current buffer the \"key\" field of the entry
+found on the last refer-find-entry or refer-find-next-entry."
+(interactive)
+(let ((old-point (point)))
+(insert
+(save-window-excursion
+(save-excursion
+(find-file (car refer-saved-state))
+(if (looking-at
+"[ \t\n]*@\\s-*[a-zA-Z][a-zA-Z0-9]*\\s-*{\\s-*\\([^ \t\n,]+\\)\\s-*,")
+(buffer-substring (match-beginning 1) (match-end 1))
+(error "Cannot find key for entry in file %s."
+(car refer-saved-state))))))
+(if (not (= (point) old-point))
+(set-mark old-point))))
 (defun refer-find-entry-internal (keywords continue)
 (let ((keywords-list (refer-convert-string-to-list-of-strings keywords))
+(old-buffer (current-buffer))
+(old-window (selected-window))
+(new-window (selected-window))
 (files (if continue
 refer-saved-state
-(refer-get-bib-files))))
+(setq refer-saved-pos nil)
-(catch 'found
+(refer-get-bib-files)))
-(while files
+(n 0)
-(let ((file (cond ((file-exists-p (car files)) (car files))
+(found nil)
-((file-exists-p (concat (car files) ".bib")) (concat (car files) ".bib")))))
+(file nil))
-(setq refer-saved-state files)
+;; find window in which to display bibliography file.
-(if file
+;; if a bibliography file is already displayed in a window, use
-(if (refer-find-entry-in-file keywords-list file continue)
+;; that one, otherwise use any window other than the current one
-(throw 'found (find-file file))
+(while (not found)
-(setq files (cdr files)))
+(while (and (not (null (setq file (nth n files))))
-(progn (message "Scanning %s... No such file" (car files) (ding))
+(setq n (1+ n))
-(sit-for 1)
+(not (string-equal file
-(setq files (cdr files))))))
+(buffer-file-name
-(message "Keywords \"%s\" not found in any \.bib file" keywords (ding)))))
+(window-buffer new-window))))))
+(setq found
-(defun refer-find-entry-in-file (keywords-list file &optional continue)
+(if (null file)
-(message "Scanning %s..." file) ; (expand-file-name file)
+(eq (setq new-window (next-window new-window 'nomini))
+old-window)
+'t)))
+(if (null file)                     ; didn't find bib file in any window:
+(progn (if (one-window-p 'nomini)
+(setq old-window (split-window)))
+(setq new-window (next-window old-window 'nomini))))
+(select-window (if refer-same-file
+old-window
+new-window))  ; the window in which to show the bib file
+(catch 'found
+(while files
+(let ((file (cond ((file-exists-p (car files)) (car files))
+((file-exists-p (concat (car files) ".bib"))
+(concat (car files) ".bib")))))
+(setq refer-saved-state files)
+(if file
+(if (refer-find-entry-in-file keywords-list file refer-saved-pos)
+(progn
+(setq refer-saved-pos (point))
+(recenter 0)
+(throw 'found (find-file file)))
+(setq refer-saved-pos nil
+files (cdr files)))
+(progn (message "Scanning %s... No such file" (car files) (ding))
+(sit-for 1)
+(setq files (cdr files))))))
+(message "Keywords \"%s\" not found in any \.bib file" keywords (ding)))
+(select-window old-window)))
+(defun refer-find-entry-in-file (keywords-list file &optional old-pos)
+(message "Scanning %s..." file)
+(expand-file-name file)
 (set-buffer (find-file-noselect file))
-(if continue
+(find-file file)
-(forward-paragraph 1)
+(if (not old-pos)
-(goto-char (point-min)))
+(goto-char (point-min))
+(goto-char old-pos)
+(forward-paragraph 1))
 (let ((begin (point))
 (end 0)
 (found nil))
 (while (and (not found)
 (not (eobp)))
 (forward-paragraph 1)
 (setq end (point))
 (setq found
 (refer-every (function (lambda (keyword)
-					(goto-char begin)
+(goto-char begin)
-					(re-search-forward keyword end t)))
+(re-search-forward keyword end t)))
-			    keywords-list))
+keywords-list))
 (if (not found)
 (progn
 (setq begin end)
 (goto-char begin))))
 (if found
 (progn (goto-char begin)
 (re-search-forward "\\W" nil t)
 (message "Scanning %s... found" file))
 (progn (message "Scanning %s... not found" file)
 nil))))
 (defun refer-every (pred l)
 (cond ((null l) nil)
-((funcall pred (car l))
+	((funcall pred (car l))
-(or (null (cdr l))
+	 (or (null (cdr l))
-(refer-every pred (cdr l))))))
+	     (refer-every pred (cdr l))))))
 (defun refer-convert-string-to-list-of-strings (s)
 (let ((current (current-buffer))
 (temp-buffer (get-buffer-create "*refer-temp*")))
 (set-buffer temp-buffer)
 (insert "\")")
 (goto-char (point-min))
 (prog1 (read temp-buffer)
 (set-buffer current))))
+(defun refer-expand-files (file-list dir-list)
+(let (file files dir dirs)
+(while (setq file (car file-list))
+(setq dirs (copy-alist dir-list))
+(while (setq dir (car dirs))
+(if (file-exists-p (expand-file-name file dir))
+(setq files (append files (list (expand-file-name file dir)))
+dirs  nil)
+(if (file-exists-p (expand-file-name (concat file ".bib") dir))
+(setq files (append files (list (expand-file-name (concat file ".bib")
+dir)))
+dirs  nil)
+(setq dirs (cdr dirs)))))
+(setq file-list (cdr file-list)))
+files))
 (defun refer-get-bib-files ()
-(let ((files
+(let* ((dir-list
-(cond ((null refer-bib-files)
+(cond
-(list (expand-file-name
+((null refer-bib-directory)
-(if (eq major-mode 'bibtex-mode)
+'("."))
-(read-file-name (format ".bib file: (default %s) " (file-name-nondirectory (buffer-file-name)))
+((or (eq refer-bib-directory 'texinputs)
-(file-name-directory (buffer-file-name))
+(eq refer-bib-directory 'bibinputs))
-(file-name-nondirectory (buffer-file-name))
+(let ((envvar (getenv (if (eq refer-bib-directory 'texinputs)
-t)
+"TEXINPUTS"
-(read-file-name ".bib file: " nil nil t)))))
+"BIBINPUTS")))
-((listp refer-bib-files) refer-bib-files)
+(dirs nil))
-((eq refer-bib-files 'auto)
+(if (null envvar)
-(save-excursion
+(setq envvar "."))
-(if (progn (goto-char (point-min))
+(while (string-match ":" envvar)
-(re-search-forward (concat refer-bib-files-regexp "\{") nil t))
+		(let ((dir (substring envvar 0 (match-beginning 0))))
-(let ((files (list (buffer-substring (point)
+		  (if (and (not (string-equal "" dir))
-(progn (re-search-forward "[,\}]" nil t)
+(file-directory-p dir))
-(backward-char 1)
+		      (setq dirs (append (list (expand-file-name dir nil))
-(point))))))
+dirs))))
-(while (not (looking-at "\}"))
+(setq envvar (substring envvar (match-end 0))))
-(setq files (append files
+	      (if (and (not (string-equal "" envvar))
-(list (buffer-substring (progn (forward-char 1)
+(file-directory-p envvar))
-(point))
+		  (setq dirs (append (list envvar) dirs)))
-(progn (re-search-forward "[,\}]" nil t)
+(setq dirs (nreverse dirs))))
-(backward-char 1)
+	   ((listp refer-bib-directory)
-(point)))))))
+	    refer-bib-directory)
-files)
+(t
-(error "No \\\\bibliography command in this buffer, can't read refer-bib-files"))))
+(list refer-bib-directory))))
-((eq refer-bib-files 'dir)
+(files
-(directory-files "." t "\\.bib$"))
+(cond
-(t (error "Illegal value for refer-bib-files: %s" refer-bib-files)))))
+((null refer-bib-files)
-(if refer-cache-bib-files
+(list (expand-file-name
-(setq refer-bib-files files))
+(if (eq major-mode 'bibtex-mode)
-files))
+(read-file-name
+(format ".bib file: (default %s) "
+(file-name-nondirectory
+(buffer-file-name)))
+(file-name-directory (buffer-file-name))
+(file-name-nondirectory (buffer-file-name))
+t)
+(read-file-name ".bib file: " nil nil t)))))
+((eq refer-bib-files 'auto)
+(let ((files
+(save-excursion
+(if (setq refer-same-file (eq major-mode 'bibtex-mode))
+(list buffer-file-name)
+(if (progn
+(goto-char (point-min))
+(re-search-forward (concat refer-bib-files-regexp
+"\\s-*\{") nil t))
+(let ((files (list (buffer-substring
+(point)
+(progn
+(re-search-forward "[,\}]"
+nil t)
+(backward-char 1)
+(point))))))
+(while (not (looking-at "\}"))
+(setq files (append files
+(list (buffer-substring
+(progn (forward-char 1)
+(point))
+(progn (re-search-forward
+"[,\}]" nil t)
+(backward-char 1)
+(point)))))))
+files)
+(error (concat "No \\\\bibliography command in this "
+"buffer, can't read refer-bib-files")))))))
+(refer-expand-files files dir-list)))
+((eq refer-bib-files 'dir)
+(let ((dirs (nreverse dir-list))
+dir files)
+(while (setq dir (car dirs))
+(setq files
+(append (directory-files dir t "\\.bib$")
+files))
+(setq dirs (cdr dirs)))
+files))
+((and (listp refer-bib-files)
+(or (eq refer-bib-directory 'texinputs)
+(eq refer-bib-directory 'bibinputs)))
+(refer-expand-files refer-bib-files dir-list))
+((listp refer-bib-files) refer-bib-files)
+(t (error "Illegal value for refer-bib-files: %s"
+refer-bib-files)))))
+(if (or (eq refer-bib-directory 'texinputs)
+(eq refer-bib-directory 'bibinputs))
+(setq refer-bib-directory dir-list))
+(if refer-cache-bib-files
+(setq refer-bib-files files))
+files))
 ;;; refer.el ends here

Mercurial > emacs

comparison lisp/textmodes/refer.el @ 16473:4ef76e689d69