*** empty log message ***
[bpt/emacs.git] / lisp / add-log.el
index ad2e1d7..09bcc05 100644 (file)
@@ -7,7 +7,7 @@
 
 ;; 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 1, or (at your option)
+;; 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,
@@ -19,6 +19,7 @@
 ;; along with GNU Emacs; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;;; Code:
 
 ;;;###autoload
 (defvar change-log-default-name nil
@@ -64,6 +65,10 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
     (setq file-name (if (file-directory-p file-name)
                        (expand-file-name (change-log-name) file-name)
                      (expand-file-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 (or (file-symlink-p file-name) file-name))
     (set (make-local-variable 'change-log-default-name) file-name)
     (if buffer-file-name
        (setq entry (if (string-match
@@ -72,8 +77,8 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
                         buffer-file-name)
                        (substring buffer-file-name (match-end 0))
                      (file-name-nondirectory buffer-file-name))))
-    ;; Never want to add a change log entry for the ChangeLog buffer itself.
-    (if (equal file-name entry)
+    ;; Never want to add a change log entry for the ChangeLog file itself.
+    (if (equal entry "ChangeLog")
        (setq entry nil
              defun nil))
     (if (and other-window (not (equal file-name buffer-file-name)))
@@ -81,12 +86,12 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
       (find-file file-name))
     (undo-boundary)
     (goto-char (point-min))
-    (if (not (and (looking-at (substring (current-time-string) 0 10))
-                 (looking-at (concat ".* " full-name "  (" login-name "@"))))
-       (progn (insert (current-time-string)
-                      "  " full-name
-                      "  (" login-name
-                      "@" site-name ")\n\n")))
+    (or (looking-at (concat (substring (current-time-string) 0 10)
+                                ".* " full-name "  (" login-name "@"))
+       (insert (current-time-string)
+               "  " full-name
+               "  (" login-name
+               "@" site-name ")\n\n"))
     (goto-char (point-min))
     (setq empty-entry
          (and (search-forward "\n\t* \n" nil t)
@@ -112,11 +117,16 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
                                       entry-boundary
                                       t)
                                      (1- (match-end 0)))))))
+    ;; Now insert the new line for this entry.
     (cond (entry-position
           ;; Move to the existing entry for the same file.
           (goto-char entry-position)
           (re-search-forward "^\\s *$")
-          (open-line 1)
+          (beginning-of-line)
+          (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))
          (empty-entry
           ;; Put this file name into the existing empty entry.
@@ -128,14 +138,13 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
           (forward-line 1)
           (while (looking-at "\\sW")
             (forward-line 1))
-          (delete-region (point)
-                         (progn
-                           (skip-chars-backward "\n")
-                           (point)))
-          (open-line 3)
-          (forward-line 2)
+          (while (and (not (eobp)) (looking-at "^\\s *$"))
+            (delete-region (point) (save-excursion (forward-line 1) (point))))
+          (insert "\n\n\n")
+          (forward-line -2)
           (indent-to left-margin)
           (insert "* " (or entry ""))))
+    ;; Now insert the function name, if we have one.
     ;; Point is at the entry for this file,
     ;; either at the end of the line or at the first blank line.
     (if defun
@@ -148,10 +157,11 @@ Third arg OTHER-WINDOW non-nil means visit in other window."
                      ""
                    " ")
                  "(" defun "): "))
+      ;; No function name, so put in a colon unless we have just a star.
       (if (not (save-excursion
                 (beginning-of-line 1)
                 (looking-at "\\s *\\(\\*\\s *\\)?$")))
-         (insert ":")))))
+         (insert ": ")))))
 
 ;;;###autoload
 (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
@@ -167,14 +177,20 @@ Interactively, with a prefix argument, the file name is prompted for."
                         (prompt-for-change-log-name))))
   (add-change-log-entry whoami file-name t))
 
+;;;###autoload
 (defun change-log-mode ()
   "Major mode for editting change logs; like Indented Text Mode.
-New log entries are usually made with \\[add-change-log-entry]."
+Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
+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'."
   (interactive)
   (kill-all-local-variables)
   (indented-text-mode)
   (setq major-mode 'change-log-mode)
   (setq mode-name "Change Log")
+  (setq left-margin 8)
+  (setq fill-column 74)
   ;; Let each entry behave as one paragraph:
   (set (make-local-variable 'paragraph-start) "^\\s *$\\|^^L")
   (set (make-local-variable 'paragraph-separate) "^\\s *$\\|^^L\\|^\\sw")
@@ -206,45 +222,127 @@ identifiers followed by `:' or `=', see variable
 
 Has a preference of looking backwards."
   (save-excursion
-    (cond ((memq major-mode '(emacs-lisp-mode lisp-mode))
-          (beginning-of-defun)
-          (forward-word 1)
-          (skip-chars-forward " ")
-          (buffer-substring (point)
-                            (progn (forward-sexp 1) (point))))
-         ((eq major-mode 'c-mode)
-          ;; must be inside function body for this to work
-          (beginning-of-defun)
-          (forward-line -1)
-          (while (looking-at "[ \t\n]") ; skip typedefs of arglist
-            (forward-line -1))
-          (down-list 1)                ; into arglist
-          (backward-up-list 1)
-          (skip-chars-backward " \t")
-          (buffer-substring (point)
-                            (progn (backward-sexp 1)
-                                   (point))))
-         ((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)
-          (if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t)
-              (buffer-substring (match-beginning 1)
-                                (match-end 1))))
-         (t
-          ;; If all else fails, try heuristics
-          (let (case-fold-search)
-            (if (re-search-backward add-log-current-defun-header-regexp
-                                    (- (point) 10000)
-                                    t)
+    (let ((location (point)))
+      (cond ((memq major-mode '(emacs-lisp-mode lisp-mode scheme-mode))
+            ;; If we are now precisely a the beginning of a defun,
+            ;; 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.
+            (if (and (progn (end-of-defun)
+                            (< location (point)))
+                     (progn (forward-sexp -1)
+                            (>= location (point))))
+                (progn
+                  (forward-word 1)
+                  (skip-chars-forward " ")
+                  (buffer-substring (point)
+                                    (progn (forward-sexp 1) (point))))))
+           ((and (memq major-mode '(c-mode 'c++-mode))
+                 (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]")))
+            ;; Handle a C macro definition.
+            (beginning-of-line)
+            (while (= (char-after (- (point) 2)) ?\\)
+              (forward-line -1))
+            (search-forward "define")
+            (skip-chars-forward " \t")
+            (buffer-substring (point)
+                              (progn (forward-sexp 1) (point))))
+           ((memq major-mode '(c-mode 'c++-mode))
+            ;; 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)
+                  
+                    (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 (and (looking-at "DEFUN\\b")
+                             (>= location (point)))
+                        (progn
+                          (down-list 1)
+                          (if (= (char-after (point)) ?\")
+                              (progn
+                                (forward-sexp 1)
+                                (skip-chars-forward " ,")))
+                          (buffer-substring (point)
+                                            (progn (forward-sexp 1) (point))))
+                      ;; Ordinary C function syntax.
+                      (setq beg (point))
+                      (if (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.
+                          (if (and (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)))
+                                   ;; Consistency check: going down and up
+                                   ;; shouldn't take us back before BEG.
+                                   (> (point) beg))
+                              (buffer-substring (point)
+                                                (progn (backward-sexp 1)
+                                                       (point))))))))))
+           ((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)
+            (if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t)
                 (buffer-substring (match-beginning 1)
-                                  (match-end 1))))))))
+                                  (match-end 1))))
+           (t
+            ;; If all else fails, try heuristics
+            (let (case-fold-search)
+              (if (re-search-backward add-log-current-defun-header-regexp
+                                      (- (point) 10000)
+                                      t)
+                  (buffer-substring (match-beginning 1)
+                                    (match-end 1)))))))))
+
+
+
+(provide 'add-log)
+
+;;; add-log.el ends here