add-log.el 26.1 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; add-log.el --- change log maintenance commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1985, 86, 88, 93, 94, 97, 1998 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5
;; Keywords: tools
Eric S. Raymond's avatar
Eric S. Raymond committed
6

Eric S. Raymond's avatar
Eric S. Raymond committed
7 8 9 10
;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
11
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
12 13 14 15 16 17 18 19
;; 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
20 21 22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
23

24 25 26 27
;;; Commentary:

;; This facility is documented in the Emacs Manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
28
;;; Code:
Eric S. Raymond's avatar
Eric S. Raymond committed
29

30 31
(eval-when-compile (require 'fortran))

32 33 34
(defgroup change-log nil
  "Change log maintenance"
  :group 'tools
35
  :link '(custom-manual "(emacs)Change Log")
36 37
  :prefix "change-log-"
  :prefix "add-log-")
Eric S. Raymond's avatar
Eric S. Raymond committed
38

39 40 41 42 43 44 45

(defcustom change-log-default-name nil
  "*Name of a change log file for \\[add-change-log-entry]."
  :type '(choice (const :tag "default" nil)
		 string)
  :group 'change-log)

Dave Love's avatar
Dave Love committed
46 47 48 49 50
(defcustom change-log-mode-hook nil
  "Normal hook run by `change-log-mode'."
  :type 'hook
  :group 'change-log)

51
(defcustom add-log-current-defun-function nil
52 53 54
  "\
*If non-nil, function to guess name of current function from surrounding text.
\\[add-change-log-entry] calls this function (if nil, `add-log-current-defun'
55
instead) with no arguments.  It returns a string or nil if it cannot guess."
56
  :type 'function
57
  :group 'change-log)
58

59
;;;###autoload
60
(defcustom add-log-full-name nil
61
  "*Full name of user, for inclusion in ChangeLog daily headers.
62 63 64 65
This defaults to the value returned by the `user-full-name' function."
  :type '(choice (const :tag "Default" nil)
		 string)
  :group 'change-log)
66

67
;;;###autoload
68
(defcustom add-log-mailing-address nil
69
  "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
70 71 72 73 74
This defaults to the value of `user-mail-address'."
  :type '(choice (const :tag "Default" nil)
		 string)
  :group 'change-log)

75 76 77 78 79 80 81 82 83 84 85
(defcustom add-log-time-format 'add-log-iso8601-time-string
  "*Function that defines the time format.
For example, `add-log-iso8601-time-string', which gives the
date in international ISO 8601 format,
and `current-time-string' are two valid values."
  :type '(radio (const :tag "International ISO 8601 format"
		       add-log-iso8601-time-string)
		(const :tag "Old format, as returned by `current-time-string'"
		       current-time-string)
		(function :tag "Other"))
  :group 'change-log)
86

87
(defcustom add-log-keep-changes-together nil
88 89 90 91 92 93 94 95 96 97 98
  "*If non-nil, normally keep day's log entries for one file together.

Log entries for a given file made with \\[add-change-log-entry] or
\\[add-change-log-entry-other-window] will only be added to others \
for that file made
today if this variable is non-nil or that file comes first in today's
entries.  Otherwise another entry for that file will be started.  An
original log:

	* foo (...): ...
	* bar (...): change 1
99

100 101
in the latter case, \\[add-change-log-entry-other-window] in a \
buffer visiting `bar', yields:
102

103 104 105
	* bar (...): -!-
	* foo (...): ...
	* bar (...): change 1
106

107
and in the former:
108

109 110 111
	* foo (...): ...
	* bar (...): change 1
	(...): -!-
112

113 114 115
The NEW-ENTRY arg to `add-change-log-entry' can override the effect of
this variable."
  :version "20.3"
116 117 118
  :type 'boolean
  :group 'change-log)

119 120 121 122 123 124 125 126
(defcustom add-log-file-name-function nil
  "*If non-nil, function to call to identify the filename for a ChangeLog entry.
This function is called with one argument, `buffer-file-name' in that buffer.
If this is nil, the default is to use the file's name
relative to the directory of the change log file."
  :type 'function
  :group 'change-log)

127
(defvar change-log-font-lock-keywords
128 129
  '(;;
    ;; Date lines, new and old styles.
130
    ("^\\sw.........[0-9:+ ]*"
131
     (0 font-lock-string-face)
132 133
     ;; Name and e-mail; some people put e-mail in parens, not angles.
     ("\\([^<(]+\\)[(<]\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
134
      (1 font-lock-constant-face)
135
      (2 font-lock-variable-name-face)))
136 137 138 139
    ;;
    ;; File names.
    ("^\t\\* \\([^ ,:([\n]+\\)"
     (1 font-lock-function-name-face)
140 141 142 143 144
     ;; Possibly further names in a list:
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 font-lock-function-name-face))
     ;; Possibly a parenthesized list of names:
     ("\\= (\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face))
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face)))
145 146
    ;;
    ;; Function or variable names.
147
    ("^\t(\\([^) ,:\n]+\\)"
148
     (1 font-lock-keyword-face)
149
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face)))
150 151 152 153
    ;;
    ;; Conditionals.
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face))
    ;;
Richard M. Stallman's avatar
Richard M. Stallman committed
154
    ;; Acknowledgements.
155
    ("^\t\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
156
     1 font-lock-comment-face)
157
    ("  \\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
158
     1 font-lock-comment-face))
159 160
  "Additional expressions to highlight in Change Log mode.")

Karl Heuer's avatar
Karl Heuer committed
161 162 163 164 165 166
(defvar change-log-mode-map nil
  "Keymap for Change Log major mode.")
(if change-log-mode-map
    nil
  (setq change-log-mode-map (make-sparse-keymap)))

167 168 169 170 171
(defvar change-log-time-zone-rule nil
  "Time zone used for calculating change log time stamps.
It takes the same format as the TZ argument of `set-time-zone-rule'.
If nil, use local time.")

172 173
(defvar add-log-debugging)

174
(defun add-log-iso8601-time-zone (time)
175 176 177 178 179 180 181 182 183 184 185 186
  (let* ((utc-offset (or (car (current-time-zone time)) 0))
	 (sign (if (< utc-offset 0) ?- ?+))
	 (sec (abs utc-offset))
	 (ss (% sec 60))
	 (min (/ sec 60))
	 (mm (% min 60))
	 (hh (/ min 60)))
    (format (cond ((not (zerop ss)) "%c%02d:%02d:%02d")
		  ((not (zerop mm)) "%c%02d:%02d")
		  (t "%c%02d"))
	    sign hh mm ss)))

187 188 189 190 191 192 193 194 195 196 197 198 199 200
(defun add-log-iso8601-time-string ()
  (if change-log-time-zone-rule
      (let ((tz (getenv "TZ"))
	    (now (current-time)))
	(unwind-protect
	    (progn
	      (set-time-zone-rule
	       change-log-time-zone-rule)
	      (concat
	       (format-time-string "%Y-%m-%d " now)
	       (add-log-iso8601-time-zone now)))
	  (set-time-zone-rule tz)))
    (format-time-string "%Y-%m-%d")))

Eric S. Raymond's avatar
Eric S. Raymond committed
201 202
(defun change-log-name ()
  (or change-log-default-name
203
      (if (eq system-type 'vax-vms)
204 205
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
206

207
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
208 209
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
210 211 212 213 214 215 216 217 218 219 220 221 222 223
  (let* ((default (change-log-name))
	 (name (expand-file-name
		(read-file-name (format "Log file (default %s): " default)
				nil default))))
    ;; Handle something that is syntactically a directory name.
    ;; Look for ChangeLog or whatever in that directory.
    (if (string= (file-name-nondirectory name) "")
	(expand-file-name (file-name-nondirectory default)
			  name)
      ;; Handle specifying a file that is a directory.
      (if (file-directory-p name)
	  (expand-file-name (file-name-nondirectory default)
			    (file-name-as-directory name))
	name))))
Eric S. Raymond's avatar
Eric S. Raymond committed
224

225 226 227
;;;###autoload
(defun find-change-log (&optional file-name)
  "Find a change log file for \\[add-change-log-entry] and return the name.
228 229

Optional arg FILE-NAME specifies the file to use.
230 231 232 233 234
If FILE-NAME is nil, use the value of `change-log-default-name'.
If 'change-log-default-name' is nil, behave as though it were 'ChangeLog'
\(or whatever we use on this operating system).

If 'change-log-default-name' contains a leading directory component, then
235
simply find it in the current directory.  Otherwise, search in the current
236
directory and its successive parents for a file so named.
237 238 239

Once a file is found, `change-log-default-name' is set locally in the
current buffer to the complete file name."
240 241
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
242
  (or file-name
243 244 245
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
      (progn
	;; Chase links in the source file
	;; and use the change log in the dir where it points.
	(setq file-name (or (and buffer-file-name
				 (file-name-directory
				  (file-chase-links buffer-file-name)))
			    default-directory))
	(if (file-directory-p file-name)
	    (setq file-name (expand-file-name (change-log-name) file-name)))
	;; Chase links before visiting the file.
	;; This makes it easier to use a single change log file
	;; for several related directories.
	(setq file-name (file-chase-links file-name))
	(setq file-name (expand-file-name file-name))
	;; Move up in the dir hierarchy till we find a change log file.
	(let ((file1 file-name)
	      parent-dir)
	  (while (and (not (or (get-file-buffer file1) (file-exists-p file1)))
		      (progn (setq parent-dir
				   (file-name-directory
				    (directory-file-name
				     (file-name-directory file1))))
			     ;; Give up if we are already at the root dir.
			     (not (string= (file-name-directory file1)
					   parent-dir))))
	    ;; Move up to the parent dir and try again.
272
	    (setq file1 (expand-file-name
273 274 275 276 277 278 279 280
			 (file-name-nondirectory (change-log-name))
			 parent-dir)))
	  ;; If we found a change log in a parent, use that.
	  (if (or (get-file-buffer file1) (file-exists-p file1))
	      (setq file-name file1)))))
  ;; Make a local variable in this buffer so we needn't search again.
  (set (make-local-variable 'change-log-default-name) file-name)
  file-name)
281

Eric S. Raymond's avatar
Eric S. Raymond committed
282
;;;###autoload
283
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
284
  "Find change log file and add an entry for today.
285 286 287 288
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.

Second arg is FILE-NAME of change log.  If nil, uses `change-log-default-name'.
289 290
Third arg OTHER-WINDOW non-nil means visit in other window.
Fourth arg NEW-ENTRY non-nil means always create a new entry at the front;
291 292 293 294 295
never append to an existing entry.  Option `add-log-keep-changes-together'
otherwise affects whether a new entry is created.

Today's date is calculated according to `change-log-time-zone-rule' if
non-nil, otherwise in local time."
Eric S. Raymond's avatar
Eric S. Raymond committed
296 297
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
298 299 300 301
  (or add-log-full-name
      (setq add-log-full-name (user-full-name)))
  (or add-log-mailing-address
      (setq add-log-mailing-address user-mail-address))
302 303 304
  (if whoami
      (progn
	(setq add-log-full-name (read-input "Full name: " add-log-full-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
305 306 307 308
	 ;; Note that some sites have room and phone number fields in
	 ;; full name which look silly when inserted.  Rather than do
	 ;; anything about that here, let user give prefix argument so that
	 ;; s/he can edit the full name field in prompter if s/he wants.
309 310 311 312
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
  (let ((defun (funcall (or add-log-current-defun-function
			    'add-log-current-defun)))
313
	bound entry)
314

315
    (setq file-name (expand-file-name (find-change-log file-name)))
316 317 318 319 320

    ;; Set ENTRY to the file name to use in the new entry.
    (and buffer-file-name
	 ;; Never want to add a change log entry for the ChangeLog file itself.
	 (not (string= buffer-file-name file-name))
321 322 323 324 325 326 327 328 329
	 (setq entry
	       (if add-log-file-name-function
		   (funcall add-log-file-name-function buffer-file-name)
		 (if (string-match
		      (concat "^" (regexp-quote (file-name-directory
						 file-name)))
		      buffer-file-name)
		     (substring buffer-file-name (match-end 0))
		   (file-name-nondirectory buffer-file-name)))))
330

331 332
    (let ((buffer (find-buffer-visiting file-name)))
      (setq add-log-debugging (list (gap-position) (gap-size))))
Eric S. Raymond's avatar
Eric S. Raymond committed
333 334 335
    (if (and other-window (not (equal file-name buffer-file-name)))
	(find-file-other-window file-name)
      (find-file file-name))
336 337
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
338 339
    (undo-boundary)
    (goto-char (point-min))
340
    (let ((new-entry (concat (funcall add-log-time-format)
341 342 343 344 345
			     "  " add-log-full-name
			     "  <" add-log-mailing-address ">")))
      (if (looking-at (regexp-quote new-entry))
	  (forward-line 1)
	(insert new-entry "\n\n")))
346

347 348 349 350 351 352 353 354
    (setq bound
	  (progn
            (if (looking-at "\n*[^\n* \t]")
                (skip-chars-forward "\n")
	      (if add-log-keep-changes-together
		  (forward-page)	; page delimits entries for date
		(forward-paragraph)))	; paragraph delimits entries for file
	    (point)))
Eric S. Raymond's avatar
Eric S. Raymond committed
355
    (goto-char (point-min))
356
    ;; Now insert the new line for this entry.
357
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
358 359
	   ;; Put this file name into the existing empty entry.
	   (if entry
360
	       (insert entry)))
361
	  ((and (not new-entry)
362 363 364 365 366 367
		(let (case-fold-search)
		  (re-search-forward
		   (concat (regexp-quote (concat "* " entry))
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
368
		   bound t)))
369 370
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
371
	   (goto-char (match-beginning 0))
372 373 374 375 376 377
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n")
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
378
	  (t
Roland McGrath's avatar
Roland McGrath committed
379 380 381 382
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
383
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
384 385 386
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
387 388
	   (indent-to left-margin)
	   (insert "* " (or entry ""))))
389
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
390 391 392 393
    ;; Point is at the entry for this file,
    ;; either at the end of the line or at the first blank line.
    (if defun
	(progn
Roland McGrath's avatar
Roland McGrath committed
394
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
395
	  (undo-boundary)
Roland McGrath's avatar
Roland McGrath committed
396 397
	  (insert (if (save-excursion
			(beginning-of-line 1)
398
			(looking-at "\\s *$"))
Roland McGrath's avatar
Roland McGrath committed
399 400 401
		      ""
		    " ")
		  "(" defun "): "))
402
      ;; No function name, so put in a colon unless we have just a star.
Roland McGrath's avatar
Roland McGrath committed
403 404 405
      (if (not (save-excursion
		 (beginning-of-line 1)
		 (looking-at "\\s *\\(\\*\\s *\\)?$")))
406
	  (insert ": ")))))
Eric S. Raymond's avatar
Eric S. Raymond committed
407 408 409 410

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
  "Find change log file in other window and add an entry for today.
411 412
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.
413 414 415 416
Second optional arg FILE-NAME is file name of change log.
If nil, use `change-log-default-name'.

Affected by the same options as `add-change-log-entry'."
Eric S. Raymond's avatar
Eric S. Raymond committed
417 418 419 420
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
421
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
422

423
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
424
(defun change-log-mode ()
425
  "Major mode for editing change logs; like Indented Text Mode.
426
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
427
New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
Roland McGrath's avatar
Roland McGrath committed
428 429
Each entry behaves as a paragraph, and the entries for one day as a page.
Runs `change-log-mode-hook'."
Eric S. Raymond's avatar
Eric S. Raymond committed
430 431 432
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
433 434 435
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
436
	fill-column 74
437 438
	indent-tabs-mode t
	tab-width 8)
Karl Heuer's avatar
Karl Heuer committed
439
  (use-local-map change-log-mode-map)
440 441
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
442 443 444 445
  ;; We really do want "^" in paragraph-start below: it is only the
  ;; lines that begin at column 0 (despite the left-margin of 8) that
  ;; we are looking for.  Adding `* ' allows eliding the blank line
  ;; between entries for different files.
446
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
447
  (set (make-local-variable 'paragraph-separate) paragraph-start)
448 449
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
450
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
451 452
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
453 454
  (set (make-local-variable 'font-lock-defaults)
       '(change-log-font-lock-keywords t))
Eric S. Raymond's avatar
Eric S. Raymond committed
455 456
  (run-hooks 'change-log-mode-hook))

457 458 459 460 461 462 463 464
;; It might be nice to have a general feature to replace this.  The idea I
;; have is a variable giving a regexp matching text which should not be
;; moved from bol by filling.  change-log-mode would set this to "^\\s *\\s(".
;; But I don't feel up to implementing that today.
(defun change-log-fill-paragraph (&optional justify)
  "Fill the paragraph, but preserve open parentheses at beginning of lines.
Prefix arg means justify as well."
  (interactive "P")
465 466
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
467
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
468 469
    (fill-region beg end justify)
    t))
470

471
(defcustom add-log-current-defun-header-regexp
472
  "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]"
473 474 475
  "*Heuristic regexp used by `add-log-current-defun' for unknown major modes."
  :type 'regexp
  :group 'change-log)
Eric S. Raymond's avatar
Eric S. Raymond committed
476

477 478
;;;###autoload
(defvar add-log-lisp-like-modes
479
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
480 481 482 483 484 485 486 487 488 489 490 491
  "*Modes that look like Lisp to `add-log-current-defun'.")

;;;###autoload
(defvar add-log-c-like-modes
    '(c-mode c++-mode c++-c-mode objc-mode)
  "*Modes that look like C to `add-log-current-defun'.")

;;;###autoload
(defvar add-log-tex-like-modes
    '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode)
  "*Modes that look like TeX to `add-log-current-defun'.")

492
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
493 494 495
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

496
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
497
Texinfo (@node titles), Perl, and Fortran.
Eric S. Raymond's avatar
Eric S. Raymond committed
498 499 500 501 502 503 504

Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
identifiers followed by `:' or `=', see variable
`add-log-current-defun-header-regexp'.

Has a preference of looking backwards."
505 506 507
  (condition-case nil
      (save-excursion
	(let ((location (point)))
508
	  (cond ((memq major-mode add-log-lisp-like-modes)
509
		 ;; If we are now precisely at the beginning of a defun,
510 511 512 513 514
		 ;; make sure beginning-of-defun finds that one
		 ;; rather than the previous one.
		 (or (eobp) (forward-char 1))
		 (beginning-of-defun)
		 ;; Make sure we are really inside the defun found, not after it.
515 516 517 518 519 520 521 522 523 524 525 526
		 (when (and (looking-at "\\s(")
			    (progn (end-of-defun)
				   (< location (point)))
			    (progn (forward-sexp -1)
				   (>= location (point))))
		   (if (looking-at "\\s(")
		       (forward-char 1))
		   ;; Skip the defining construct name, typically "defun"
		   ;; or "defvar".
		   (forward-sexp 1)
		   ;; The second element is usually a symbol being defined.
		   ;; If it is not, use the first symbol in it.
Richard M. Stallman's avatar
Richard M. Stallman committed
527
		   (skip-chars-forward " \t\n'(")
528 529 530
		   (buffer-substring (point)
				     (progn (forward-sexp 1)
					    (point)))))
531 532 533 534 535 536 537 538 539
		((and (memq major-mode add-log-c-like-modes)
		      (save-excursion
			(beginning-of-line)
			;; Use eq instead of = here to avoid
			;; error when at bob and char-after
			;; returns nil.
			(while (eq (char-after (- (point) 2)) ?\\)
			  (forward-line -1))
			(looking-at "[ \t]*#[ \t]*define[ \t]")))
540 541 542 543 544 545 546 547
		 ;; Handle a C macro definition.
		 (beginning-of-line)
		 (while (eq (char-after (- (point) 2)) ?\\) ;not =; note above
		   (forward-line -1))
		 (search-forward "define")
		 (skip-chars-forward " \t")
		 (buffer-substring (point)
				   (progn (forward-sexp 1) (point))))
548
		((memq major-mode add-log-c-like-modes)
549 550 551 552 553 554 555 556 557 558 559 560 561
		 (beginning-of-line)
		 ;; See if we are in the beginning part of a function,
		 ;; before the open brace.  If so, advance forward.
		 (while (not (looking-at "{\\|\\(\\s *$\\)"))
		   (forward-line 1))
		 (or (eobp)
		     (forward-char 1))
		 (beginning-of-defun)
		 (if (progn (end-of-defun)
			    (< location (point)))
		     (progn
		       (backward-sexp 1)
		       (let (beg tem)
Eric S. Raymond's avatar
Eric S. Raymond committed
562

563 564 565 566 567 568 569 570 571
			 (forward-line -1)
			 ;; Skip back over typedefs of arglist.
			 (while (and (not (bobp))
				     (looking-at "[ \t\n]"))
			   (forward-line -1))
			 ;; See if this is using the DEFUN macro used in Emacs,
			 ;; or the DEFUN macro used by the C library.
			 (if (condition-case nil
				 (and (save-excursion
572 573 574
					(end-of-line)
					(while (= (preceding-char) ?\\)
					  (end-of-line 2))
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
					(backward-sexp 1)
					(beginning-of-line)
					(setq tem (point))
					(looking-at "DEFUN\\b"))
				      (>= location tem))
			       (error nil))
			     (progn
			       (goto-char tem)
			       (down-list 1)
			       (if (= (char-after (point)) ?\")
				   (progn
				     (forward-sexp 1)
				     (skip-chars-forward " ,")))
			       (buffer-substring (point)
						 (progn (forward-sexp 1) (point))))
590
                           (if (looking-at "^[+-]")
591
                               (change-log-get-method-definition)
592 593
                             ;; Ordinary C function syntax.
                             (setq beg (point))
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
                             (if (and (condition-case nil
					  ;; Protect against "Unbalanced parens" error.
					  (progn
					    (down-list 1) ; into arglist
					    (backward-up-list 1)
					    (skip-chars-backward " \t")
					    t)
					(error nil))
				      ;; Verify initial pos was after
				      ;; real start of function.
				      (save-excursion
					(goto-char beg)
					;; For this purpose, include the line
					;; that has the decl keywords.  This
					;; may also include some of the
					;; comments before the function.
					(while (and (not (bobp))
						    (save-excursion
						      (forward-line -1)
						      (looking-at "[^\n\f]")))
					  (forward-line -1))
					(>= location (point)))
616 617 618
                                          ;; Consistency check: going down and up
                                          ;; shouldn't take us back before BEG.
                                          (> (point) beg))
619
				 (let (end middle)
620
				   ;; Don't include any final whitespace
621
				   ;; in the name we use.
622
				   (skip-chars-backward " \t\n")
623 624 625 626 627 628 629
				   (setq end (point))
				   (backward-sexp 1)
				   ;; Now find the right beginning of the name.
				   ;; Include certain keywords if they
				   ;; precede the name.
				   (setq middle (point))
				   (forward-word -1)
630 631 632 633 634 635 636 637
				   ;; Ignore these subparts of a class decl
				   ;; and move back to the class name itself.
				   (while (looking-at "public \\|private ")
				     (skip-chars-backward " \t:")
				     (setq end (point))
				     (backward-sexp 1)
				     (setq middle (point))
				     (forward-word -1))
638
				   (and (bolp)
639
					(looking-at "enum \\|struct \\|union \\|class ")
640
					(setq middle (point)))
641 642 643 644 645
				   (goto-char end)
				   (when (eq (preceding-char) ?=)
				     (forward-char -1)
				     (skip-chars-backward " \t")
				     (setq end (point)))
646
				   (buffer-substring middle end)))))))))
647
		((memq major-mode add-log-tex-like-modes)
648 649 650 651 652 653 654 655 656
		 (if (re-search-backward
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t)
		     (progn
		       (goto-char (match-beginning 0))
		       (buffer-substring (1+ (point));; without initial backslash
					 (progn
					   (end-of-line)
					   (point))))))
		((eq major-mode 'texinfo-mode)
657
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
658 659
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
660 661 662 663
		((eq major-mode 'perl-mode)
		 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
664 665 666
                ((or (eq major-mode 'fortran-mode)
		     ;; Needs work for f90, but better than nothing.
		     (eq major-mode 'f90-mode))
667
                 ;; must be inside function body for this to work
668
                 (fortran-beginning-of-subprogram)
669 670 671
                 (let ((case-fold-search t)) ; case-insensitive
                   ;; search for fortran subprogram start
                   (if (re-search-forward
672
                        "^[ \t]*\\(program\\|subroutine\\|function\
673
\\|[ \ta-z0-9*()]*[ \t]+function\\|\\(block[ \t]*data\\)\\)"
674
                        (save-excursion (fortran-end-of-subprogram)
675 676
                                        (point))
                        t)
677
                       (or (match-string 2)
678 679 680
                           (progn
                             ;; move to EOL or before first left paren
                             (if (re-search-forward "[(\n]" nil t)
681
				 (progn (backward-char)
682 683 684 685
                                        (skip-chars-backward " \t"))
                               (end-of-line))
                             ;; Use the name preceding that.
                             (buffer-substring (point)
686 687 688
					       (progn (backward-sexp)
						      (point)))))
		     "main")))
689 690 691 692 693 694 695 696 697 698
		(t
		 ;; If all else fails, try heuristics
		 (let (case-fold-search)
		   (end-of-line)
		   (if (re-search-backward add-log-current-defun-header-regexp
					   (- (point) 10000)
					   t)
		       (buffer-substring (match-beginning 1)
					 (match-end 1))))))))
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
699

700
(defvar change-log-get-method-definition-md)
701

702
;; Subroutine used within change-log-get-method-definition.
703 704
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
705 706 707
(defun change-log-get-method-definition-1 (end)
  (setq change-log-get-method-definition-md
	(concat change-log-get-method-definition-md
708 709
		(buffer-substring (match-beginning 1) (match-end 1))
		end))
710 711 712
  (goto-char (match-end 0)))

;; For objective C, return the method name if we are in a method.
713 714
(defun change-log-get-method-definition ()
  (let ((change-log-get-method-definition-md "["))
715
    (save-excursion
716
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
717
	  (change-log-get-method-definition-1 " ")))
718 719
    (save-excursion
      (cond
720
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
721
	(change-log-get-method-definition-1 "")
722 723
	(while (not (looking-at "[{;]"))
	  (looking-at
724
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
725 726
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
727

Jim Blandy's avatar
Jim Blandy committed
728

729 730
(provide 'add-log)

Eric S. Raymond's avatar
Eric S. Raymond committed
731
;;; add-log.el ends here