bib-mode.el 7.12 KB
Newer Older
1
;;; bib-mode.el --- major mode for editing bib files
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1989, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6 7 8
;; Maintainer: FSF
;; Keywords: bib

Jim Blandy's avatar
Jim Blandy committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
14 15 16 17 18 19 20 21
;; 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
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
25

26
;;; Commentary:
Jim Blandy's avatar
Jim Blandy committed
27 28

;;   GNU Emacs code to help maintain databases compatible with (troff)
29
;;   refer and lookbib.  The file bib-file should be set to your
Jim Blandy's avatar
Jim Blandy committed
30 31 32
;;   bibliography file.  Keys are automagically inserted as you type,
;;   and appropriate keys are presented for various kinds of entries.

33
;;; Code:
34

Stephen Eglen's avatar
Stephen Eglen committed
35 36 37
(defgroup bib nil
  "Major mode for editing bib files."
  :prefix "bib-"
Dave Love's avatar
Dave Love committed
38
  :group 'external
Stephen Eglen's avatar
Stephen Eglen committed
39
  :group 'wp)
40

Stephen Eglen's avatar
Stephen Eglen committed
41 42 43 44
(defcustom bib-file "~/my-bibliography.bib"
  "Default name of file used by `addbib'."
    :type 'file
    :group 'bib)
Jim Blandy's avatar
Jim Blandy committed
45

Stephen Eglen's avatar
Stephen Eglen committed
46 47 48 49
(defcustom unread-bib-file "~/to-be-read.bib"
   "Default name of file used by `unread-bib' in Bib mode."
   :type 'file
   :group 'bib)
Jim Blandy's avatar
Jim Blandy committed
50 51 52 53 54 55 56 57

(defvar bib-mode-map (copy-keymap text-mode-map))
(define-key bib-mode-map "\C-M" 'return-key-bib)
(define-key bib-mode-map "\C-c\C-u" 'unread-bib)
(define-key bib-mode-map "\C-c\C-@" 'mark-bib)
(define-key bib-mode-map "\e`" 'abbrev-mode)

(defun addbib ()
58
   "Set up editor to add to troff bibliography file specified
Jim Blandy's avatar
Jim Blandy committed
59 60 61 62 63 64
by global variable `bib-file'.  See description of `bib-mode'."
   (interactive)
   (find-file bib-file)
   (goto-char (point-max))
   (bib-mode)
   )
65

Stefan Monnier's avatar
Stefan Monnier committed
66
(define-derived-mode bib-mode text-mode "Bib"
67
   "Mode for editing `lookbib' style bibliographies.
Jim Blandy's avatar
Jim Blandy committed
68 69 70 71 72
Hit RETURN to get next % field key.
If you want to ignore this field, just hit RETURN again.
Use `text-mode' to turn this feature off.

 journal papers:                    A* T D J V N P K W X
73
 articles in books & proceedings:   A* T D B E* I C P K W X
Jim Blandy's avatar
Jim Blandy committed
74 75 76 77 78 79 80 81 82
 tech reports:                      A* T D R I C K W X
 books:                             A* T D I C K W X

Fields:

A uthor		T itle		D ate  		J ournal
V olume		N umber		P age		K eywords
B in book or proceedings	E ditor		C ity & state
I nstitution, school, or publisher
83
R eport number or 'phd thesis' or 'masters thesis' or 'draft' or
Jim Blandy's avatar
Jim Blandy committed
84 85 86 87 88 89 90 91 92 93 94 95 96
     'unnumbered' or 'unpublished'
W here can be found locally (login name, or ailib, etc.)
X comments (not used in indexing)

\\[unread-bib] appends current entry to a different file (for example,
a file of papers to be read in the future), given by the value of the
variable `unread-bib-file'.
\\[mark-bib] marks current or previous entry.
Abbreviations are saved in `bib-mode-abbrev-table'.
Hook can be stored in `bib-mode-hook'.
Field keys given by variable `bib-assoc'.

Commands:
Stefan Monnier's avatar
Stefan Monnier committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
\\{bib-mode-map}"
   (abbrev-mode 1))

(defconst bib-assoc
  '((" *$" . "%A ")
    ("%A ." . "%A ")
    ("%A $" . "%T ")
    ("%T " . "%D ")
    ("%D " . "%J ")
    ("%J ." . "%V ")
    ("%V " . "%N ")
    ("%N " . "%P ")
    ("%P " . "%K ")
    ("%K " . "%W ")
    ("%W " . "%X ")
    ("%X " . "")
    ("%J $" . "%B ")
    ("%B ." . "%E ")
    ("%E ." . "%E ")
    ("%E $" . "%I ")
    ("%I " . "%C ")
    ("%C " . "%P ")
    ("%B $" . "%R ")
    ("%R " . "%I "))
  "Describes bibliographic database format.
A line beginning with the car of an entry is followed by one beginning
with the cdr.")
Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129

(defun bib-find-key (slots)
   (cond
      ((null slots)
	 (if (bobp)
	    ""
130
	    (progn (forward-line -1) (bib-find-key bib-assoc))))
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136
      ((looking-at (car (car slots)))
	 (cdr (car slots)))
      (t (bib-find-key (cdr slots)))
      ))


Stephen Eglen's avatar
Stephen Eglen committed
137 138 139 140
(defcustom bib-auto-capitalize t
  "*True to automatically capitalize appropriate fields in Bib mode."
  :type 'boolean
  :group 'bib)
Jim Blandy's avatar
Jim Blandy committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

(defconst bib-capitalized-fields "%[AETCBIJR]")

(defun return-key-bib ()
  "Magic when user hits return, used by `bib-mode'."
  (interactive)
  (if (eolp)
    (let (empty new-key beg-current end-current)
      (beginning-of-line)
      (setq empty (looking-at "%. $"))
      (if (not empty)
	(progn
	  (end-of-line)
	  (newline)
	  (forward-line -1)
	  ))
      (end-of-line)
      (setq end-current (point))
      (beginning-of-line)
      (setq beg-current (point))
      (setq new-key (bib-find-key bib-assoc))
      (if (and (not empty) bib-auto-capitalize
	    (looking-at bib-capitalized-fields))
	(save-excursion
165
	  (bib-capitalize-title-region (+ (point) 3) end-current)))
Jim Blandy's avatar
Jim Blandy committed
166 167 168 169 170
      (goto-char beg-current)
      (if empty
	(kill-line nil)
	(forward-line 1)
	)
171
      (insert new-key))
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181 182 183
    (newline)))

(defun mark-bib ()
   "Set mark at beginning of current or previous bib entry, point at end."
   (interactive)
   (beginning-of-line nil)
   (if (looking-at "^ *$") (re-search-backward "[^ \n]" nil 2))
   (re-search-backward "^ *$" nil 2)
   (re-search-forward "^%")
   (beginning-of-line nil)
   (push-mark (point))
   (re-search-forward "^ *$" nil 2)
184
   (forward-line 1)
Jim Blandy's avatar
Jim Blandy committed
185 186 187 188 189 190 191 192 193 194 195 196
   (beginning-of-line nil))

(defun unread-bib ()
   "Append current or previous entry to file of unread papers
named by variable `unread-bib-file'."
   (interactive)
   (mark-bib)
   (if (get-file-buffer unread-bib-file)
      (append-to-buffer (get-file-buffer unread-bib-file) (mark) (point))
      (append-to-file (mark) (point) unread-bib-file)))


197
(defvar bib-capitalize-title-stop-words
Jim Blandy's avatar
Jim Blandy committed
198 199 200
   (concat
      "the\\|and\\|of\\|is\\|a\\|an\\|of\\|for\\|in\\|to\\|in\\|on\\|at\\|"
      "by\\|with\\|that\\|its")
201
   "Words not to be capitalized in a title (unless the first word).")
Jim Blandy's avatar
Jim Blandy committed
202

203 204
(defvar bib-capitalize-title-stop-regexp
   (concat "\\(" bib-capitalize-title-stop-words "\\)\\(\\b\\|'\\)"))
Jim Blandy's avatar
Jim Blandy committed
205

206
(defun bib-capitalize-title-region (begin end)
Jim Blandy's avatar
Jim Blandy committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
   "Like `capitalize-region', but don't capitalize stop words, except the first."
   (interactive "r")
   (let ((case-fold-search nil) (orig-syntax-table (syntax-table)))
      (unwind-protect
	 (save-restriction
	    (set-syntax-table text-mode-syntax-table)
	    (narrow-to-region begin end)
	    (goto-char (point-min))
	    (if (looking-at "[A-Z][a-z]*[A-Z]")
	       (forward-word 1)
	       (capitalize-word 1))
	    (while (re-search-forward "\\<" nil t)
	       (if (looking-at "[A-Z][a-z]*[A-Z]")
		  (forward-word 1)
		  (if (let ((case-fold-search t))
222
			 (looking-at bib-capitalize-title-stop-regexp))
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226 227 228
		     (downcase-word 1)
		     (capitalize-word 1)))
	       ))
	 (set-syntax-table orig-syntax-table))))


229
(defun bib-capitalize-title (s)
Jim Blandy's avatar
Jim Blandy committed
230 231 232 233 234
   "Like `capitalize', but don't capitalize stop words, except the first."
   (save-excursion
      (set-buffer (get-buffer-create "$$$Scratch$$$"))
      (erase-buffer)
      (insert s)
235
      (bib-capitalize-title-region (point-min) (point-max))
Jim Blandy's avatar
Jim Blandy committed
236
      (buffer-string)))
Jim Blandy's avatar
Jim Blandy committed
237 238 239

(provide 'bib-mode)

Miles Bader's avatar
Miles Bader committed
240
;;; arch-tag: e3a97958-3c2c-487f-9557-fafc3c98452d
Eric S. Raymond's avatar
Eric S. Raymond committed
241
;;; bib-mode.el ends here