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

3
;; Copyright (C) 1985, 1986, 1988, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

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 32

(defvar change-log-default-name nil
  "*Name of a change log file for \\[add-change-log-entry].")

33 34 35 36 37 38
(defvar add-log-current-defun-function nil
  "\
*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'
instead) with no arguments.  It returns a string or nil if it cannot guess.")

39
;;;###autoload
40
(defvar add-log-full-name nil
41 42 43
  "*Full name of user, for inclusion in ChangeLog daily headers.
This defaults to the value returned by the `user-full-name' function.")

44
;;;###autoload
45
(defvar add-log-mailing-address nil
46
  "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
47
This defaults to the value of `user-mail-address'.")
48

49
(defvar change-log-font-lock-keywords
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
  '(;;
    ;; Date lines, new and old styles.
    ("^\\sw........."
     (0 font-lock-string-face)
     ("[A-Z][^\n<]+" nil nil (0 font-lock-reference-face)))
    ;;
    ;; File names.
    ("^\t\\* \\([^ ,:([\n]+\\)"
     (1 font-lock-function-name-face)
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 font-lock-function-name-face)))
    ;;
    ;; Function or variable names.
    ("(\\([^ ,:\n]+\\)"
     (1 font-lock-keyword-face)
     ("\\=, \\([^ ,:\n]+\\)" nil nil (1 font-lock-keyword-face)))
    ;;
    ;; Conditionals.
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face))
    ;;
    ;; Acknowledgments.
    ("^\t\\(From\\|Reported by\\)" 1 font-lock-comment-face)
    )
72 73
  "Additional expressions to highlight in Change Log mode.")

Karl Heuer's avatar
Karl Heuer committed
74 75 76 77 78 79
(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)))

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
(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.")

(defun iso8601-time-zone (time)
  (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)))

Eric S. Raymond's avatar
Eric S. Raymond committed
98 99
(defun change-log-name ()
  (or change-log-default-name
100
      (if (eq system-type 'vax-vms) 
101 102
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
103

104
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
105 106
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
107 108 109 110 111 112 113 114 115 116 117 118 119 120
  (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
121

122 123 124
;;;###autoload
(defun find-change-log (&optional file-name)
  "Find a change log file for \\[add-change-log-entry] and return the name.
125 126

Optional arg FILE-NAME specifies the file to use.
127 128 129 130 131 132 133
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
simply find it in the current directory.  Otherwise, search in the current 
directory and its successive parents for a file so named.
134 135 136

Once a file is found, `change-log-default-name' is set locally in the
current buffer to the complete file name."
137 138
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
139
  (or file-name
140 141 142
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
      (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.
	    (setq file1 (expand-file-name 
			 (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)
178

Eric S. Raymond's avatar
Eric S. Raymond committed
179
;;;###autoload
180
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
181 182 183
  "Find change log file and add an entry for today.
Optional arg (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'.
184 185
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;
186 187
never append to an existing entry.  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
188 189
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
190 191 192 193
  (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))
194 195 196
  (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
197 198 199 200
	 ;; 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.
201 202 203 204 205
	(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)))
	paragraph-end entry)
206

207
    (setq file-name (expand-file-name (find-change-log file-name)))
208 209 210 211 212 213 214 215 216 217 218 219

    ;; 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))
	 (setq entry (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))))

Eric S. Raymond's avatar
Eric S. Raymond committed
220 221 222
    (if (and other-window (not (equal file-name buffer-file-name)))
	(find-file-other-window file-name)
      (find-file file-name))
223 224
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
225 226
    (undo-boundary)
    (goto-char (point-min))
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
    (let ((new-entry (concat (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)
					  (iso8601-time-zone now)))
				     (set-time-zone-rule tz)))
			       (format-time-string "%Y-%m-%d"))
			     "  " add-log-full-name
			     "  <" add-log-mailing-address ">")))
      (if (looking-at (regexp-quote new-entry))
	  (forward-line 1)
	(insert new-entry "\n\n")))
244

245
    ;; Search only within the first paragraph.
246 247 248
    (if (looking-at "\n*[^\n* \t]")
	(skip-chars-forward "\n")
      (forward-paragraph 1))
249
    (setq paragraph-end (point))
Eric S. Raymond's avatar
Eric S. Raymond committed
250
    (goto-char (point-min))
251

252
    ;; Now insert the new line for this entry.
253 254 255 256
    (cond ((re-search-forward "^\\s *\\*\\s *$" paragraph-end t)
	   ;; Put this file name into the existing empty entry.
	   (if entry
	       (insert entry)))
257
	  ((and (not new-entry)
258 259 260 261 262 263 264
		(let (case-fold-search)
		  (re-search-forward
		   (concat (regexp-quote (concat "* " entry))
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
		   paragraph-end t)))
265 266
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
267 268
	   (goto-char (match-beginning 0))
	   ;; Delete excess empty lines; make just 2.
269
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
270 271 272
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
273
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
274
	  (t
Roland McGrath's avatar
Roland McGrath committed
275 276 277 278
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
279
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
280 281 282
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
283 284
	   (indent-to left-margin)
	   (insert "* " (or entry ""))))
285
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
286 287 288 289
    ;; 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
290
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
291
	  (undo-boundary)
Roland McGrath's avatar
Roland McGrath committed
292 293 294 295 296 297
	  (insert (if (save-excursion
			(beginning-of-line 1)
			(looking-at "\\s *$")) 
		      ""
		    " ")
		  "(" defun "): "))
298
      ;; No function name, so put in a colon unless we have just a star.
Roland McGrath's avatar
Roland McGrath committed
299 300 301
      (if (not (save-excursion
		 (beginning-of-line 1)
		 (looking-at "\\s *\\(\\*\\s *\\)?$")))
302
	  (insert ": ")))))
Eric S. Raymond's avatar
Eric S. Raymond committed
303 304 305 306

;;;###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.
307 308 309
Optional arg (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'."
Eric S. Raymond's avatar
Eric S. Raymond committed
310 311 312 313
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
314
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
315

316
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
317
(defun change-log-mode ()
318
  "Major mode for editing change logs; like Indented Text Mode.
319
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
Roland McGrath's avatar
Roland McGrath committed
320 321 322
New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
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
323 324 325
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
326 327 328
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
329
	fill-column 74
330 331
	indent-tabs-mode t
	tab-width 8)
Karl Heuer's avatar
Karl Heuer committed
332
  (use-local-map change-log-mode-map)
333 334
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
Eric S. Raymond's avatar
Eric S. Raymond committed
335
  ;; Let each entry behave as one paragraph:
336 337
  ;; 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.
338 339
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
  (set (make-local-variable 'paragraph-separate) "\\s *$\\|\f\\|^\\<")
Eric S. Raymond's avatar
Eric S. Raymond committed
340
  ;; Let all entries for one day behave as one page.
341 342
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
343
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
344 345
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
346 347
  (set (make-local-variable 'font-lock-defaults)
       '(change-log-font-lock-keywords t))
Eric S. Raymond's avatar
Eric S. Raymond committed
348 349
  (run-hooks 'change-log-mode-hook))

350 351 352 353 354 355 356 357
;; 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")
358 359
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
360
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
361 362
    (fill-region beg end justify)
    t))
363

Eric S. Raymond's avatar
Eric S. Raymond committed
364
(defvar add-log-current-defun-header-regexp
365
  "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]"
Eric S. Raymond's avatar
Eric S. Raymond committed
366 367
  "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.")

368
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
369 370 371
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

372
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
373
Texinfo (@node titles), Perl, and Fortran.
Eric S. Raymond's avatar
Eric S. Raymond committed
374 375 376 377 378 379 380

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."
381 382 383
  (condition-case nil
      (save-excursion
	(let ((location (point)))
384 385
	  (cond ((memq major-mode '(emacs-lisp-mode lisp-mode scheme-mode
						    lisp-interaction-mode))
386
		 ;; If we are now precisely at the beginning of a defun,
387 388 389 390 391
		 ;; 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.
392 393
		 (if (and (looking-at "\\s(")
			  (progn (end-of-defun)
394 395 396 397
				 (< location (point)))
			  (progn (forward-sexp -1)
				 (>= location (point))))
		     (progn
398 399 400
		       (if (looking-at "\\s(")
			   (forward-char 1))
		       (forward-sexp 1)
401
		       (skip-chars-forward " '")
402 403
		       (buffer-substring (point)
					 (progn (forward-sexp 1) (point))))))
404
		((and (memq major-mode '(c-mode c++-mode c++-c-mode objc-mode))
405 406 407 408 409
		      (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)) ?\\)
Roland McGrath's avatar
Roland McGrath committed
410
					(forward-line -1))
411 412 413 414 415 416 417 418 419
				      (looking-at "[ \t]*#[ \t]*define[ \t]")))
		 ;; 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))))
420
		((memq major-mode '(c-mode c++-mode c++-c-mode objc-mode))
421 422 423 424 425 426 427 428 429 430 431 432 433
		 (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
434

435 436 437 438 439 440 441 442 443
			 (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
444 445 446
					(end-of-line)
					(while (= (preceding-char) ?\\)
					  (end-of-line 2))
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
					(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))))
462 463 464 465
                           (if (looking-at "^[+-]")
                               (get-method-definition)
                             ;; Ordinary C function syntax.
                             (setq beg (point))
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
                             (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)))
488 489 490
                                          ;; Consistency check: going down and up
                                          ;; shouldn't take us back before BEG.
                                          (> (point) beg))
491 492 493 494 495 496 497 498 499 500 501 502
				 (let (end middle)
				   ;; Don't include any final newline
				   ;; in the name we use.
				   (if (= (preceding-char) ?\n)
				       (forward-char -1))
				   (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)
503 504 505 506 507 508 509 510
				   ;; 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))
511 512 513 514
				   (and (bolp)
					(looking-at "struct \\|union \\|class ")
					(setq middle (point)))
				   (buffer-substring middle end)))))))))
515 516 517 518 519 520 521 522 523 524 525 526 527
		((memq major-mode
		       '(TeX-mode plain-TeX-mode LaTeX-mode;; tex-mode.el
				  plain-tex-mode latex-mode;; cmutex.el
				  ))
		 (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)
528
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
529 530
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
531 532 533 534
		((eq major-mode 'perl-mode)
		 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
535 536 537 538 539 540 541 542
                ((eq major-mode 'fortran-mode)
                 ;; must be inside function body for this to work
                 (beginning-of-fortran-subprogram)
                 (let ((case-fold-search t)) ; case-insensitive
                   ;; search for fortran subprogram start
                   (if (re-search-forward
			 "^[ \t]*\\(program\\|subroutine\\|function\
\\|[ \ta-z0-9*]*[ \t]+function\\)"
543
			 nil t)
544 545 546 547 548 549 550 551 552 553
                       (progn
                         ;; move to EOL or before first left paren
                         (if (re-search-forward "[(\n]" nil t)
			     (progn (forward-char -1)
				    (skip-chars-backward " \t"))
			   (end-of-line))
			 ;; Use the name preceding that.
                         (buffer-substring (point)
                                           (progn (forward-sexp -1)
                                                  (point)))))))
554 555 556 557 558 559 560 561 562 563
		(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
564

565 566
(defvar get-method-definition-md)

567 568 569 570
;; Subroutine used within get-method-definition.
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
(defun get-method-definition-1 (end)
571 572 573 574
  (setq get-method-definition-md
	(concat get-method-definition-md 
		(buffer-substring (match-beginning 1) (match-end 1))
		end))
575 576 577 578
  (goto-char (match-end 0)))

;; For objective C, return the method name if we are in a method.
(defun get-method-definition ()
579
  (let ((get-method-definition-md "["))
580
    (save-excursion
581
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
582 583 584
	  (get-method-definition-1 " ")))
    (save-excursion
      (cond
585
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
586 587 588
	(get-method-definition-1 "")
	(while (not (looking-at "[{;]"))
	  (looking-at
589
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
590
	  (get-method-definition-1 ""))
591
	(concat get-method-definition-md "]"))))))
592

Jim Blandy's avatar
Jim Blandy committed
593

594 595
(provide 'add-log)

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