admin.el 26.3 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2
;;; admin.el --- utilities for Emacs administration

3
;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4 5 6

;; This file is part of GNU Emacs.

7
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
8
;; it under the terms of the GNU General Public License as published by
9 10
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
11 12 13 14 15 16 17

;; 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
18
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
19 20 21

;;; Commentary:

22 23
;; add-release-logs	Add ``Version X released'' change log entries.
;; set-version		Change Emacs version number in source tree.
24
;; set-copyright        Change Emacs short copyright string (eg as
Glenn Morris's avatar
Glenn Morris committed
25
;;                      printed by --version) in source tree.
Gerd Moellmann's avatar
Gerd Moellmann committed
26 27 28

;;; Code:

29 30
(defvar add-log-time-format)		; in add-log

Glenn Morris's avatar
Glenn Morris committed
31 32 33 34
;; Does this information need to be in every ChangeLog, as opposed to
;; just the top-level one?  Only if you allow changes the same
;; day as the release.
;; http://lists.gnu.org/archive/html/emacs-devel/2013-03/msg00161.html
35
(defun add-release-logs (root version &optional date)
Gerd Moellmann's avatar
Gerd Moellmann committed
36
  "Add \"Version VERSION released.\" change log entries in ROOT.
37 38 39 40 41 42 43 44
Root must be the root of an Emacs source tree.
Optional argument DATE is the release date, default today."
  (interactive (list (read-directory-name "Emacs root directory: ")
		     (read-string "Version number: "
				  (format "%s.%s" emacs-major-version
					  emacs-minor-version))
		     (read-string "Release date: "
				  (progn (require 'add-log)
45 46
					 (let ((add-log-time-zone-rule t))
					   (funcall add-log-time-format))))))
47
  (setq root (expand-file-name root))
Gerd Moellmann's avatar
Gerd Moellmann committed
48
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
49
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
50
  (require 'add-log)
51 52
  (or date (setq date (let ((add-log-time-zone-rule t))
			(funcall add-log-time-format))))
Gerd Moellmann's avatar
Gerd Moellmann committed
53 54
  (let* ((logs (process-lines "find" root "-name" "ChangeLog"))
	 (entry (format "%s  %s  <%s>\n\n\t* Version %s released.\n\n"
55
			date
56 57 58
			(or add-log-full-name (user-full-name))
			(or add-log-mailing-address user-mail-address)
			version)))
Gerd Moellmann's avatar
Gerd Moellmann committed
59
    (dolist (log logs)
60 61 62
      (find-file log)
      (goto-char (point-min))
      (insert entry))))
Gerd Moellmann's avatar
Gerd Moellmann committed
63 64

(defun set-version-in-file (root file version rx)
Xue Fuqiao's avatar
Xue Fuqiao committed
65
  "Subroutine of `set-version' and `set-copyright'."
Gerd Moellmann's avatar
Gerd Moellmann committed
66 67
  (find-file (expand-file-name file root))
  (goto-char (point-min))
68 69
  (unless (re-search-forward rx nil :noerror)
    (user-error "Version not found in %s" file))
Gerd Moellmann's avatar
Gerd Moellmann committed
70 71 72 73 74
  (replace-match (format "%s" version) nil nil nil 1))

(defun set-version (root version)
  "Set Emacs version to VERSION in relevant files under ROOT.
Root must be the root of an Emacs source tree."
75
  (interactive "DEmacs root directory: \nsVersion number: ")
Gerd Moellmann's avatar
Gerd Moellmann committed
76
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
77
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Xue Fuqiao's avatar
Xue Fuqiao committed
78 79 80
  ;; There's also a "version 3" (standing for GPLv3) at the end of
  ;; `README', but since `set-version-in-file' only replaces the first
  ;; occurence, it won't be replaced.
Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83
  (set-version-in-file root "README" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
84
  (set-version-in-file root "configure.ac" version
85 86 87
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
88 89 90
  (set-version-in-file root "doc/emacs/emacsver.texi" version
		       (rx (and "EMACSVER" (1+ space)
				(submatch (1+ (in "0-9."))))))
91 92 93 94
  (set-version-in-file root "doc/man/emacs.1" version
		       (rx (and ".TH EMACS" (1+ not-newline)
                                "GNU Emacs" (1+ space)
				(submatch (1+ (in "0-9."))))))
95 96
  (set-version-in-file root "nt/config.nt" version
		       (rx (and bol "#" (0+ blank) "define" (1+ blank)
97
				"VERSION" (1+ blank) "\""
98
				(submatch (1+ (in "0-9."))))))
99 100
  (set-version-in-file root "msdos/sed2v2.inp" version
		       (rx (and bol "/^#undef " (1+ not-newline)
101
				"define VERSION" (1+ space) "\""
102
				(submatch (1+ (in "0-9."))))))
103 104 105
  (set-version-in-file root "nt/makefile.w32-in" version
		       (rx (and "VERSION" (0+ space) "=" (0+ space)
				(submatch (1+ (in "0-9."))))))
106 107 108 109 110
  ;; nt/emacs.rc also contains the version number, but in an awkward
  ;; format. It must contain four components, separated by commas, and
  ;; in two places those commas are followed by space, in two other
  ;; places they are not.
  (let* ((version-components (append (split-string version "\\.")
Xue Fuqiao's avatar
Xue Fuqiao committed
111
				     '("0" "0")))
112 113 114
	 (comma-version
	  (concat (car version-components) ","
		  (cadr version-components) ","
115
		  (cadr (cdr version-components)) ","
116 117 118 119
		  (cadr (cdr (cdr version-components)))))
	 (comma-space-version
	  (concat (car version-components) ", "
		  (cadr version-components) ", "
120
		  (cadr (cdr version-components)) ", "
121 122 123 124 125 126 127 128 129 130 131 132 133
		  (cadr (cdr (cdr version-components))))))
    (set-version-in-file root "nt/emacs.rc" comma-version
			 (rx (and "FILEVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacs.rc" comma-version
			 (rx (and "PRODUCTVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacs.rc" comma-space-version
			 (rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
				  ?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
    (set-version-in-file root "nt/emacs.rc" comma-space-version
			 (rx (and "\"ProductVersion\"" (0+ space) ?,
				  (0+ space) ?\" (submatch (1+ (in "0-9, ")))
134 135 136 137 138 139 140 141 142 143 144 145
				  "\\0\"")))
    ;; Likewise for emacsclient.rc
    (set-version-in-file root "nt/emacsclient.rc" comma-version
			 (rx (and "FILEVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacsclient.rc" comma-version
			 (rx (and "PRODUCTVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacsclient.rc" comma-space-version
			 (rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
				  ?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
    (set-version-in-file root "nt/emacsclient.rc" comma-space-version
146 147
			 (rx (and "\"ProductVersion\"" (0+ space) ?,
				  (0+ space) ?\" (submatch (1+ (in "0-9, ")))
148
				  "\\0\"")))
149
    ;; Major version only.
150 151
    (when (string-match "\\([0-9]\\{2,\\}\\)" version)
      (setq version (match-string 1 version))
152 153 154
      (set-version-in-file root "src/msdos.c" version
			   (rx (and "Vwindow_system_version" (1+ not-newline)
				    ?\( (submatch (1+ (in "0-9"))) ?\))))
155 156 157 158 159 160 161
      (set-version-in-file root "etc/refcards/ru-refcard.tex" version
			   "\\\\newcommand{\\\\versionemacs}\\[0\\]\
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")
      (set-version-in-file root "etc/refcards/emacsver.tex" version
			   "\\\\def\\\\versionemacs\
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs"))))

162

Glenn Morris's avatar
Glenn Morris committed
163 164 165 166 167 168 169 170 171 172 173
;; Note this makes some assumptions about form of short copyright.
(defun set-copyright (root copyright)
  "Set Emacs short copyright to COPYRIGHT in relevant files under ROOT.
Root must be the root of an Emacs source tree."
  (interactive (list
                (read-directory-name "Emacs root directory: " nil nil t)
                (read-string
                 "Short copyright string: "
                 (format "Copyright (C) %s Free Software Foundation, Inc."
                         (format-time-string "%Y")))))
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
174
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
175 176
  (set-version-in-file root "configure.ac" copyright
		       (rx (and bol "copyright" (0+ (not (in ?\")))
177
        			?\" (submatch (1+ (not (in ?\")))) ?\")))
178 179 180 181
  (set-version-in-file root "msdos/sed2v2.inp" copyright
		       (rx (and bol "/^#undef " (1+ not-newline)
				"define COPYRIGHT" (1+ space)
				?\" (submatch (1+ (not (in ?\")))) ?\")))
182 183 184 185
  (set-version-in-file root "nt/config.nt" copyright
		       (rx (and bol "#" (0+ blank) "define" (1+ blank)
				"COPYRIGHT" (1+ blank)
				?\" (submatch (1+ (not (in ?\")))) ?\")))
Glenn Morris's avatar
Glenn Morris committed
186
  (set-version-in-file root "lib-src/rcs2log" copyright
187 188 189 190
        	       (rx (and "Copyright" (0+ space) ?= (0+ space)
        			?\' (submatch (1+ nonl)))))
  (when (string-match "\\([0-9]\\{4\\}\\)" copyright)
    (setq copyright (match-string 1 copyright))
191 192 193 194 195 196
    (set-version-in-file root "etc/refcards/ru-refcard.tex" copyright
			 "\\\\newcommand{\\\\cyear}\\[0\\]\
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
    (set-version-in-file root "etc/refcards/emacsver.tex" copyright
			 "\\\\def\\\\year\
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")))
Glenn Morris's avatar
Glenn Morris committed
197

198 199
;;; Various bits of magic for generating the web manuals

200
(defun manual-misc-manuals (root)
Xue Fuqiao's avatar
Xue Fuqiao committed
201 202
  "Return doc/misc manuals as list of strings.
ROOT should be the root of an Emacs source tree."
203 204
  ;; Similar to `make -C doc/misc echo-info', but works if unconfigured,
  ;; and for INFO_TARGETS rather than INFO_INSTALL.
205 206
  (with-temp-buffer
    (insert-file-contents (expand-file-name "doc/misc/Makefile.in" root))
207 208 209
    ;; Should really use expanded value of INFO_TARGETS.
    (search-forward "INFO_COMMON = ")
    (let ((start (point)))
210 211 212 213
      (end-of-line)
      (while (and (looking-back "\\\\")
		  (zerop (forward-line 1)))
	(end-of-line))
214 215 216 217
      (append (split-string (replace-regexp-in-string
			     "\\(\\\\\\|\\.info\\)" ""
			     (buffer-substring start (point))))
	      '("efaq-w32")))))
218

219 220
(defun make-manuals (root &optional type)
  "Generate the web manuals for the Emacs webpage.
Xue Fuqiao's avatar
Xue Fuqiao committed
221
ROOT should be the root of an Emacs source tree.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
Interactively with a prefix argument, prompt for TYPE.
Optional argument TYPE is type of output (nil means all)."
  (interactive (let ((root (read-directory-name "Emacs root directory: "
						source-directory nil t)))
		 (list root
		       (if current-prefix-arg
			   (completing-read
			    "Type: "
			    (append
			     '("misc" "pdf" "ps")
			     (let (res)
			       (dolist (i '("emacs" "elisp" "eintr") res)
				 (dolist (j '("" "-mono" "-node" "-ps" "-pdf"))
				   (push (concat i j) res))))
			     (manual-misc-manuals root)))))))
237 238 239
  (let* ((dest (expand-file-name "manual" root))
	 (html-node-dir (expand-file-name "html_node" dest))
	 (html-mono-dir (expand-file-name "html_mono" dest))
240
	 (ps-dir (expand-file-name "ps" dest))
241 242 243 244 245 246 247
	 (pdf-dir (expand-file-name "pdf" dest))
	 (emacs (expand-file-name "doc/emacs/emacs.texi" root))
	 (elisp (expand-file-name "doc/lispref/elisp.texi" root))
	 (eintr (expand-file-name "doc/lispintro/emacs-lisp-intro.texi" root))
	 (misc (manual-misc-manuals root)))
    ;; TODO this makes it non-continuable.
    ;; Instead, delete the individual dest directory each time.
248
    (when (file-directory-p dest)
249
      (if (y-or-n-p (format "Directory %s exists, delete it first? " dest))
250
	  (delete-directory dest t)
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
	(user-error "Aborted")))
    (if (member type '(nil "emacs" "emacs-node"))
	(manual-html-node emacs (expand-file-name "emacs" html-node-dir)))
    (if (member type '(nil "emacs" "emacs-mono"))
	(manual-html-mono emacs (expand-file-name "emacs.html" html-mono-dir)))
    (if (member type '(nil "emacs" "emacs-pdf" "pdf"))
	(manual-pdf emacs (expand-file-name "emacs.pdf" pdf-dir)))
    (if (member type '(nil "emacs" "emacs-ps" "ps"))
	(manual-ps emacs (expand-file-name "emacs.ps" ps-dir)))
    (if (member type '(nil "elisp" "elisp-node"))
	(manual-html-node elisp (expand-file-name "elisp" html-node-dir)))
    (if (member type '(nil "elisp" "elisp-mono"))
	(manual-html-mono elisp (expand-file-name "elisp.html" html-mono-dir)))
    (if (member type '(nil "elisp" "elisp-pdf" "pdf"))
	(manual-pdf elisp (expand-file-name "elisp.pdf" pdf-dir)))
    (if (member type '(nil "elisp" "elisp-ps" "ps"))
	(manual-ps elisp (expand-file-name "elisp.ps" ps-dir)))
    (if (member type '(nil "eintr" "eintr-node"))
	(manual-html-node eintr (expand-file-name "eintr" html-node-dir)))
    (if (member type '(nil "eintr" "eintr-node"))
	(manual-html-mono eintr (expand-file-name "eintr.html" html-mono-dir)))
    (if (member type '(nil "eintr" "eintr-pdf" "pdf"))
	(manual-pdf eintr (expand-file-name "eintr.pdf" pdf-dir)))
    (if (member type '(nil "eintr" "eintr-ps" "ps"))
	(manual-ps eintr (expand-file-name "eintr.ps" ps-dir)))
276
    ;; Misc manuals
277 278 279
    (dolist (manual misc)
      (if (member type `(nil ,manual "misc"))
	  (manual-misc-html manual root html-node-dir html-mono-dir)))
280 281 282 283 284 285 286 287 288 289 290 291 292 293
    (message "Manuals created in %s" dest)))

(defconst manual-doctype-string
  "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
\"http://www.w3.org/TR/html4/loose.dtd\">\n\n")

(defconst manual-meta-string
  "<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">
<link rev=\"made\" href=\"mailto:webmasters@gnu.org\">
<link rel=\"icon\" type=\"image/png\" href=\"/graphics/gnu-head-mini.png\">
<meta name=\"ICBM\" content=\"42.256233,-71.006581\">
<meta name=\"DC.title\" content=\"gnu.org\">\n\n")

(defconst manual-style-string "<style type=\"text/css\">
294
@import url('/software/emacs/manual.css');\n</style>\n")
295

296
(defun manual-misc-html (name root html-node-dir html-mono-dir)
297
  ;; Hack to deal with the cases where .texi creates a different .info.
298
  ;; Blech.  TODO Why not just rename the .texi (or .info) files?
299 300 301
  (let* ((texiname (cond ((equal name "ccmode") "cc-mode")
			 (t name)))
	 (texi (expand-file-name (format "doc/misc/%s.texi" texiname) root)))
302 303 304 305
    (manual-html-node texi (expand-file-name name html-node-dir))
    (manual-html-mono texi (expand-file-name (concat name ".html")
					     html-mono-dir))))

306 307 308 309 310
(defun manual-html-mono (texi-file dest)
  "Run Makeinfo on TEXI-FILE, emitting mono HTML output to DEST.
This function also edits the HTML files so that they validate as
HTML 4.01 Transitional, and pulls in the gnu.org stylesheet using
the @import directive."
311
  (make-directory (or (file-name-directory dest) ".") t)
312
  (call-process "makeinfo" nil nil nil
313
		"-D" "WWW_GNU_ORG"
314 315 316 317
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
		"--html" "--no-split" texi-file "-o" dest)
  (with-temp-buffer
    (insert-file-contents dest)
    (setq buffer-file-name dest)
    (manual-html-fix-headers)
    (manual-html-fix-index-1)
    (manual-html-fix-index-2 t)
    (manual-html-fix-node-div)
    (goto-char (point-max))
    (re-search-backward "</body>[\n \t]*</html>")
    (insert "</div>\n\n")
    (save-buffer)))

(defun manual-html-node (texi-file dir)
  "Run Makeinfo on TEXI-FILE, emitting per-node HTML output to DIR.
This function also edits the HTML files so that they validate as
HTML 4.01 Transitional, and pulls in the gnu.org stylesheet using
the @import directive."
  (unless (file-exists-p texi-file)
Xue Fuqiao's avatar
Xue Fuqiao committed
337
    (user-error "Manual file %s not found" texi-file))
338
  (make-directory dir t)
339
  (call-process "makeinfo" nil nil nil
340
		"-D" "WWW_GNU_ORG"
341 342 343 344
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
		"--html" texi-file "-o" dir)
  ;; Loop through the node files, fixing them up.
  (dolist (f (directory-files dir nil "\\.html\\'"))
    (let (opoint)
      (with-temp-buffer
	(insert-file-contents (expand-file-name f dir))
	(setq buffer-file-name (expand-file-name f dir))
	(if (looking-at "<meta http-equiv")
	    ;; Ignore those HTML files that are just redirects.
	    (set-buffer-modified-p nil)
	  (manual-html-fix-headers)
	  (if (equal f "index.html")
	      (let (copyright-text)
		(manual-html-fix-index-1)
		;; Move copyright notice to the end.
360 361 362 363 364
		(when (re-search-forward "[ \t]*<p>Copyright &copy;" nil t)
		  (setq opoint (match-beginning 0))
		  (re-search-forward "</blockquote>")
		  (setq copyright-text (buffer-substring opoint (point)))
		  (delete-region opoint (point)))
365
		(manual-html-fix-index-2)
366 367 368
		(if copyright-text
		    (insert copyright-text))
		(insert "\n</div>\n"))
369 370 371 372 373
	    ;; For normal nodes, give the header div a blue bg.
	    (manual-html-fix-node-div))
	  (save-buffer))))))

(defun manual-pdf (texi-file dest)
Xue Fuqiao's avatar
Xue Fuqiao committed
374
  "Run texi2pdf on TEXI-FILE, emitting PDF output to DEST."
375
  (make-directory (or (file-name-directory dest) ".") t)
376 377 378 379
  (let ((default-directory (file-name-directory texi-file)))
    (call-process "texi2pdf" nil nil nil
		  "-I" "../emacs" "-I" "../misc"
		  texi-file "-o" dest)))
380

381 382
(defun manual-ps (texi-file dest)
  "Generate a PostScript version of TEXI-FILE as DEST."
383
  (make-directory (or (file-name-directory dest) ".") t)
384 385
  (let ((dvi-dest (concat (file-name-sans-extension dest) ".dvi"))
	(default-directory (file-name-directory texi-file)))
Xue Fuqiao's avatar
Xue Fuqiao committed
386
    ;; FIXME: Use `texi2dvi --ps'?  --xfq
387
    (call-process "texi2dvi" nil nil nil
388
		  "-I" "../emacs" "-I" "../misc"
389 390 391 392
		  texi-file "-o" dvi-dest)
    (call-process "dvips" nil nil nil dvi-dest "-o" dest)
    (delete-file dvi-dest)
    (call-process "gzip" nil nil nil dest)))
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426

(defun manual-html-fix-headers ()
  "Fix up HTML headers for the Emacs manual in the current buffer."
  (let (opoint)
    (insert manual-doctype-string)
    (search-forward "<head>\n")
    (insert manual-meta-string)
    (search-forward "<meta")
    (setq opoint (match-beginning 0))
    (re-search-forward "<!--")
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
    (insert manual-style-string)
    (search-forward "<meta http-equiv=\"Content-Style")
    (setq opoint (match-beginning 0))
    (search-forward "</head>")
    (delete-region opoint (match-beginning 0))))

(defun manual-html-fix-node-div ()
  "Fix up HTML \"node\" divs in the current buffer."
  (let (opoint div-end)
    (while (search-forward "<div class=\"node\">" nil t)
      (replace-match
       "<div class=\"node\" style=\"background-color:#DDDDFF\">"
       t t)
      (setq opoint (point))
      (re-search-forward "</div>")
      (setq div-end (match-beginning 0))
      (goto-char opoint)
      (if (search-forward "<hr>" div-end 'move)
	  (replace-match "" t t)))))

(defun manual-html-fix-index-1 ()
  (let (opoint)
427 428 429
    (re-search-forward "<body>\n")
    (setq opoint (match-end 0))
    (search-forward "<h2 class=\"")
430 431 432 433 434 435 436 437
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
    (insert "<div id=\"content\" class=\"inner\">\n\n")))

(defun manual-html-fix-index-2 (&optional table-workaround)
  "Replace the index list in the current buffer with a HTML table."
  (let (done open-td tag desc)
    ;; Convert the list that Makeinfo made into a table.
438 439
    (or (search-forward "<ul class=\"menu\">" nil t)
	(search-forward "<ul>"))
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
    (replace-match "<table style=\"float:left\" width=\"100%\">")
    (forward-line 1)
    (while (not done)
      (cond
       ((or (looking-at "<li>\\(<a.+</a>\\):[ \t]+\\(.*\\)$")
	    (looking-at "<li>\\(<a.+</a>\\)$"))
	(setq tag (match-string 1))
	(setq desc (match-string 2))
	(replace-match "" t t)
	(when open-td
	  (save-excursion
	    (forward-char -1)
	    (skip-chars-backward " ")
	    (delete-region (point) (line-end-position))
	    (insert "</td>\n  </tr>")))
	(insert "  <tr>\n    ")
	(if table-workaround
	    ;; This works around a Firefox bug in the mono file.
	    (insert "<td bgcolor=\"white\">")
	  (insert "<td>"))
	(insert tag "</td>\n    <td>" (or desc ""))
	(setq open-td t))
       ((eq (char-after) ?\n)
	(delete-char 1)
	;; Negate the following `forward-line'.
	(forward-line -1))
       ((looking-at "<!-- ")
	(search-forward "-->"))
       ((looking-at "<p>[- ]*The Detailed Node Listing[- \n]*")
	(replace-match "  </td></tr></table>\n
<h3>Detailed Node Listing</h3>\n\n" t t)
	(search-forward "<p>")
472
	(search-forward "<p>" nil t)
473 474 475 476 477 478 479 480 481 482 483 484 485
	(goto-char (match-beginning 0))
	(skip-chars-backward "\n ")
	(setq open-td nil)
	(insert "</p>\n\n<table  style=\"float:left\" width=\"100%\">"))
       ((looking-at "</li></ul>")
	(replace-match "" t t))
       ((looking-at "<p>")
	(replace-match "" t t)
	(when open-td
	  (insert "  </td></tr>")
	  (setq open-td nil))
	(insert "  <tr>
    <th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
486 487
	(if (re-search-forward "</p>[ \t\n]*<ul class=\"menu\">" nil t)
	    (replace-match "  </th></tr>")))
488 489 490 491 492 493 494 495
       ((looking-at "[ \t]*</ul>[ \t]*$")
	(replace-match
	 (if open-td
	     "  </td></tr>\n</table>"
	   "</table>") t t)
	(setq done t))
       (t
	(if (eobp)
496 497
	    (error "Parse error in %s"
		   (file-name-nondirectory buffer-file-name)))
498 499 500 501
	(unless open-td
	  (setq done t))))
      (forward-line 1))))

502

Xue Fuqiao's avatar
Xue Fuqiao committed
503
;; Stuff to check new `defcustom's got :version tags.
504 505 506
;; Adapted from check-declare.el.

(defun cusver-find-files (root &optional old)
Xue Fuqiao's avatar
Xue Fuqiao committed
507 508
  "Find .el files beneath directory ROOT that contain `defcustom's.
If optional OLD is non-nil, also include `defvar's."
509 510 511 512 513 514 515 516 517
  (process-lines find-program root
		 "-name" "*.el"
		 "-exec" grep-program
		 "-l" "-E" (format "^[ \\t]*\\(def%s"
				   (if old "(custom|var)"
				     "custom"
				     ))
		 "{}" "+"))

518 519
(defvar cusver-new-version (format "%s.%s" emacs-major-version
				   (1+ emacs-minor-version))
Xue Fuqiao's avatar
Xue Fuqiao committed
520
  "Version number that new `defcustom's should have.")
521

522 523 524 525 526
(defun cusver-scan (file &optional old)
  "Scan FILE for `defcustom' calls.
Return a list with elements of the form (VAR . VER),
This means that FILE contains a defcustom for variable VAR, with
a :version tag having value VER (may be nil).
Xue Fuqiao's avatar
Xue Fuqiao committed
527
If optional argument OLD is non-nil, also scan for `defvar's."
528 529
  (let ((m (format "Scanning %s..." file))
	(re (format "^[ \t]*\\((def%s\\)[ \t\n]"
530 531
		    (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
        alist var ver form glist grp)
532 533 534 535
    (message "%s" m)
    (with-temp-buffer
      (insert-file-contents file)
      ;; FIXME we could theoretically be inside a string.
Xue Fuqiao's avatar
Xue Fuqiao committed
536
      (while (re-search-forward re nil :noerror)
537 538
        (goto-char (match-beginning 1))
        (if (and (setq form (ignore-errors (read (current-buffer))))
539
		 (setq var (car-safe (cdr-safe form)))
540 541
		 ;; Exclude macros, eg (defcustom ,varname ...).
		 (symbolp var))
542 543 544 545 546 547 548 549 550 551 552 553 554 555
	    (progn
	      (setq ver (car (cdr-safe (memq :version form))))
	      (if (equal "group" (match-string 2))
		  ;; Group :version could be old.
		  (if (equal ver cusver-new-version)
		      (setq glist (cons (cons var ver) glist)))
		;; If it specifies a group and the whole group has a
		;; version. use that.
		(unless ver
		  (setq grp (car (cdr-safe (memq :group form))))
		  (and grp
		       (setq grp (car (cdr-safe grp))) ; (quote foo) -> foo
		       (setq ver (assq grp glist))))
		(setq alist (cons (cons var ver) alist))))
556 557 558 559
          (if form (message "Malformed defcustom: `%s'" form)))))
    (message "%sdone" m)
    alist))

560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
(defun cusver-scan-cus-start (file)
  "Scan cus-start.el and return an alist with elements (VAR . VER)."
  (if (file-readable-p file)
      (with-temp-buffer
	(insert-file-contents file)
	(when (search-forward "(let ((all '(" nil t)
	  (backward-char 1)
	  (let (var ver alist)
	    (dolist (elem (ignore-errors (read (current-buffer))))
	      (when (symbolp (setq var (car-safe elem)))
		(or (stringp (setq ver (nth 3 elem)))
		    (setq ver nil))
		(setq alist (cons (cons var ver) alist))))
	    alist)))))

575 576 577
(define-button-type 'cusver-xref 'action #'cusver-goto-xref)

(defun cusver-goto-xref (button)
Xue Fuqiao's avatar
Xue Fuqiao committed
578
  "Jump to a Lisp file for the BUTTON at point."
579 580 581 582 583 584 585 586 587 588 589
  (let ((file (button-get button 'file))
	(var (button-get button 'var)))
    (if (not (file-readable-p file))
	(message "Cannot read `%s'" file)
      (with-current-buffer (find-file-noselect file)
	(goto-char (point-min))
	(or (re-search-forward (format "^[ \t]*(defcustom[ \t]*%s" var) nil t)
	    (message "Unable to locate defcustom"))
	(pop-to-buffer (current-buffer))))))

;; You should probably at least do a grep over the old directory
590 591 592
;; to check the results of this look sensible.
;; TODO Check cus-start if something moved from C to Lisp.
;; TODO Handle renamed things with aliases to the old names.
593
(defun cusver-check (newdir olddir version)
Xue Fuqiao's avatar
Xue Fuqiao committed
594 595 596 597 598 599 600
  "Check that `defcustom's have :version tags where needed.
NEWDIR is the current lisp/ directory, OLDDIR is that from the
previous release, VERSION is the new version number.  A
`defcustom' that is only in NEWDIR should have a :version tag.
We exclude cases where a `defvar' exists in OLDDIR, since just
converting a `defvar' to a `defcustom' does not require
a :version bump.
601 602 603

Note that a :version tag should also be added if the value of a defcustom
changes (in a non-trivial way).  This function does not check for that."
604 605 606 607 608
  (interactive (list (read-directory-name "New Lisp directory: ")
		     (read-directory-name "Old Lisp directory: ")
		     (number-to-string
		      (read-number "New version number: "
				   (string-to-number cusver-new-version)))))
609
  (or (file-directory-p (setq newdir (expand-file-name newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
610
      (user-error "Directory `%s' not found" newdir))
611
  (or (file-directory-p (setq olddir (expand-file-name olddir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
612
      (user-error "Directory `%s' not found" olddir))
613
  (setq cusver-new-version version)
Xue Fuqiao's avatar
Xue Fuqiao committed
614
  (let* ((newfiles (progn (message "Finding new files with `defcustom's...")
615
			  (cusver-find-files newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
616
	 (oldfiles (progn (message "Finding old files with `defcustom's...")
617
			  (cusver-find-files olddir t)))
Xue Fuqiao's avatar
Xue Fuqiao committed
618
	 (newcus (progn (message "Reading new `defcustom's...")
619 620 621
			(mapcar
			 (lambda (file)
			   (cons file (cusver-scan file))) newfiles)))
622
	 oldcus result thisfile file)
Xue Fuqiao's avatar
Xue Fuqiao committed
623
    (message "Reading old `defcustom's...")
624 625
    (dolist (file oldfiles)
      (setq oldcus (append oldcus (cusver-scan file t))))
626 627
    (setq oldcus (append oldcus (cusver-scan-cus-start
				 (expand-file-name "cus-start.el" olddir))))
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
    ;; newcus has elements (FILE (VAR VER) ... ).
    ;; oldcus just (VAR . VER).
    (message "Checking for version tags...")
    (dolist (new newcus)
      (setq file (car new)
	    thisfile
	    (let (missing var)
	      (dolist (cons (cdr new))
		(or (cdr cons)
		    (assq (setq var (car cons)) oldcus)
		    (push var missing)))
	      (if missing
		  (cons file missing))))
      (if thisfile
	  (setq result (cons thisfile result))))
    (message "Checking for version tags... done")
    (if (not result)
	(message "No missing :version tags")
      (pop-to-buffer "*cusver*")
      (erase-buffer)
Xue Fuqiao's avatar
Xue Fuqiao committed
648
      (insert "These `defcustom's might be missing :version tags:\n\n")
649 650 651 652 653 654 655 656 657 658 659 660
      (dolist (elem result)
	(let* ((str (file-relative-name (car elem) newdir))
	       (strlen (length str)))
	  (dolist (var (cdr elem))
	    (insert (format "%s: %s\n" str var))
	    (make-text-button (+ (line-beginning-position 0) strlen 2)
			      (line-end-position 0)
			      'file (car elem)
			      'var var
			      'help-echo "Mouse-2: visit this definition"
			      :type 'cusver-xref)))))))

Glenn Morris's avatar
Glenn Morris committed
661 662
(provide 'admin)

663
;;; admin.el ends here