admin.el 25.6 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.
Glenn Morris's avatar
Glenn Morris committed
24 25
;; set-copyright        Change emacs short copyright string (eg as
;;                      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 49
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
    (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 65 66 67 68 69 70 71 72 73

(defun set-version-in-file (root file version rx)
  (find-file (expand-file-name file root))
  (goto-char (point-min))
  (unless (re-search-forward rx nil t)
    (error "Version not found in %s" file))
  (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."
74
  (interactive "DEmacs root directory: \nsVersion number: ")
Gerd Moellmann's avatar
Gerd Moellmann committed
75 76 77 78 79
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
    (error "%s doesn't seem to be the root of an Emacs source tree" root))
  (set-version-in-file root "README" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
80
  (set-version-in-file root "configure.ac" version
81 82 83
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
84 85 86
  (set-version-in-file root "doc/emacs/emacsver.texi" version
		       (rx (and "EMACSVER" (1+ space)
				(submatch (1+ (in "0-9."))))))
87 88 89 90
  (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."))))))
91 92
  (set-version-in-file root "nt/config.nt" version
		       (rx (and bol "#" (0+ blank) "define" (1+ blank)
93
				"VERSION" (1+ blank) "\""
94
				(submatch (1+ (in "0-9."))))))
95 96
  (set-version-in-file root "msdos/sed2v2.inp" version
		       (rx (and bol "/^#undef " (1+ not-newline)
97
				"define VERSION" (1+ space) "\""
98
				(submatch (1+ (in "0-9."))))))
99 100 101
  (set-version-in-file root "nt/makefile.w32-in" version
		       (rx (and "VERSION" (0+ space) "=" (0+ space)
				(submatch (1+ (in "0-9."))))))
102 103 104 105 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 "\\.")
				    '("0" "0")))
	 (comma-version
	  (concat (car version-components) ","
		  (cadr version-components) ","
111
		  (cadr (cdr version-components)) ","
112 113 114 115
		  (cadr (cdr (cdr version-components)))))
	 (comma-space-version
	  (concat (car version-components) ", "
		  (cadr version-components) ", "
116
		  (cadr (cdr version-components)) ", "
117 118 119 120 121 122 123 124 125 126 127 128 129
		  (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, ")))
130 131 132 133 134 135 136 137 138 139 140 141
				  "\\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
142 143
			 (rx (and "\"ProductVersion\"" (0+ space) ?,
				  (0+ space) ?\" (submatch (1+ (in "0-9, ")))
144
				  "\\0\"")))
145
    ;; Major version only.
146 147
    (when (string-match "\\([0-9]\\{2,\\}\\)" version)
      (setq version (match-string 1 version))
148 149 150
      (set-version-in-file root "src/msdos.c" version
			   (rx (and "Vwindow_system_version" (1+ not-newline)
				    ?\( (submatch (1+ (in "0-9"))) ?\))))
151 152 153 154 155 156 157
      (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"))))

158

Glenn Morris's avatar
Glenn Morris committed
159 160 161 162 163 164 165 166 167 168 169 170
;; 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))
    (error "%s doesn't seem to be the root of an Emacs source tree" root))
171 172
  (set-version-in-file root "configure.ac" copyright
		       (rx (and bol "copyright" (0+ (not (in ?\")))
173
        			?\" (submatch (1+ (not (in ?\")))) ?\")))
174 175 176 177
  (set-version-in-file root "msdos/sed2v2.inp" copyright
		       (rx (and bol "/^#undef " (1+ not-newline)
				"define COPYRIGHT" (1+ space)
				?\" (submatch (1+ (not (in ?\")))) ?\")))
178 179 180 181
  (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
182
  (set-version-in-file root "lib-src/rcs2log" copyright
183 184 185 186
        	       (rx (and "Copyright" (0+ space) ?= (0+ space)
        			?\' (submatch (1+ nonl)))))
  (when (string-match "\\([0-9]\\{4\\}\\)" copyright)
    (setq copyright (match-string 1 copyright))
187 188 189 190 191 192
    (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
193

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
;;; Various bits of magic for generating the web manuals

(defun make-manuals (root)
  "Generate the web manuals for the Emacs webpage."
  (interactive "DEmacs root directory: ")
  (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))
	 (txt-dir (expand-file-name "text" dest))
	 (dvi-dir (expand-file-name "dvi" dest))
	 (ps-dir (expand-file-name "ps" dest)))
    (when (file-directory-p dest)
      (if (y-or-n-p (format "Directory %s exists, delete it first?" dest))
	  (delete-directory dest t)
	(error "Aborted")))
    (make-directory dest)
    (make-directory html-node-dir)
    (make-directory html-mono-dir)
    (make-directory txt-dir)
    (make-directory dvi-dir)
    (make-directory ps-dir)
    ;; Emacs manual
    (let ((texi (expand-file-name "doc/emacs/emacs.texi" root)))
      (manual-html-node texi (expand-file-name "emacs" html-node-dir))
      (manual-html-mono texi (expand-file-name "emacs.html" html-mono-dir))
      (manual-txt texi (expand-file-name "emacs.txt" txt-dir))
      (manual-pdf texi (expand-file-name "emacs.pdf" dest))
      (manual-dvi texi (expand-file-name "emacs.dvi" dvi-dir)
222
		  (expand-file-name "emacs.ps" ps-dir)))
223 224 225 226 227 228 229
    ;; Lisp manual
    (let ((texi (expand-file-name "doc/lispref/elisp.texi" root)))
      (manual-html-node texi (expand-file-name "elisp" html-node-dir))
      (manual-html-mono texi (expand-file-name "elisp.html" html-mono-dir))
      (manual-txt texi (expand-file-name "elisp.txt" txt-dir))
      (manual-pdf texi (expand-file-name "elisp.pdf" dest))
      (manual-dvi texi (expand-file-name "elisp.dvi" dvi-dir)
230
		  (expand-file-name "elisp.ps" ps-dir)))
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
    (let ((texi (expand-file-name "doc/lispintro/emacs-lisp-intro.texi" root))
	  (dest (expand-file-name "emacs-lisp-intro" dest))
	  dest2 dest3)
      ;; Mimic the atypical directory layout used for emacs-lisp-intro.
      (make-directory dest)
      (make-directory (setq dest2 (expand-file-name "html_node" dest)))
      (manual-html-node texi dest2)
      (make-directory (setq dest2 (expand-file-name "html_mono" dest)))
      (manual-html-mono texi (expand-file-name "emacs-lisp-intro.html" dest2))
      (make-directory (setq dest2 (expand-file-name "txt" dest)))
      (manual-txt texi (expand-file-name "emacs-lisp-intro.txt" dest2))
      (manual-pdf texi (expand-file-name "emacs-lisp-intro.pdf" dest))
      (make-directory (setq dest2 (expand-file-name "dvi" dest)))
      (make-directory (setq dest3 (expand-file-name "ps" dest)))
      (manual-dvi texi (expand-file-name "emacs-lisp-intro.dvi" dest2)
		  (expand-file-name "emacs-lisp-intro.ps" dest3)))
247
    ;; Misc manuals
248
    (let ((manuals '("ada-mode" "auth" "autotype" "bovine" "calc" "cc-mode"
249
		     "cl" "dbus" "dired-x" "ebrowse" "ede" "ediff"
250
		     "edt" "eieio" "emacs-gnutls" "emacs-mime" "epa" "erc" "ert"
251
		     "eshell" "eudc" "faq" "flymake" "forms"
252
		     "gnus" "htmlfontify" "idlwave" "info"
253 254
		     "mairix-el" "message" "mh-e" "newsticker"
		     "nxml-mode" "org" "pcl-cvs" "pgg" "rcirc"
255 256 257
		     "reftex" "remember" "sasl" "sc" "semantic"
		     "ses" "sieve" "smtpmail" "speedbar" "srecode" "tramp"
		     "url" "vip" "viper" "widget" "wisent" "woman")))
258 259
      (dolist (manual manuals)
	(manual-misc-html manual root html-node-dir html-mono-dir)))
260 261 262 263 264 265 266 267 268 269 270 271 272 273
    (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\">
274
@import url('/s/emacs/manual.css');\n</style>\n")
275

276 277 278 279 280 281
(defun manual-misc-html (name root html-node-dir html-mono-dir)
  (let ((texi (expand-file-name (format "doc/misc/%s.texi" name) root)))
    (manual-html-node texi (expand-file-name name html-node-dir))
    (manual-html-mono texi (expand-file-name (concat name ".html")
					     html-mono-dir))))

282 283 284 285 286 287
(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."
  (call-process "makeinfo" nil nil nil
288
		"-D" "WWW_GNU_ORG"
289 290 291 292
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
		"--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)
    (error "Manual file %s not found" texi-file))
  (call-process "makeinfo" nil nil nil
314
		"-D" "WWW_GNU_ORG"
315 316 317 318
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
		"--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.
334 335 336 337 338
		(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)))
339
		(manual-html-fix-index-2)
340 341 342
		(if copyright-text
		    (insert copyright-text))
		(insert "\n</div>\n"))
343 344 345 346 347 348 349
	    ;; For normal nodes, give the header div a blue bg.
	    (manual-html-fix-node-div))
	  (save-buffer))))))

(defun manual-txt (texi-file dest)
  "Run Makeinfo on TEXI-FILE, emitting plaintext output to DEST."
  (call-process "makeinfo" nil nil nil
350 351 352 353
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
354 355 356 357 358
		"--plaintext" "--no-split" texi-file "-o" dest)
  (shell-command (concat "gzip -c " dest " > " (concat dest ".gz"))))

(defun manual-pdf (texi-file dest)
  "Run texi2pdf on TEXI-FILE, emitting plaintext output to DEST."
359 360 361 362 363 364
  (call-process "texi2pdf" nil nil nil
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
		texi-file "-o" dest))
365 366 367

(defun manual-dvi (texi-file dest ps-dest)
  "Run texi2dvi on TEXI-FILE, emitting dvi output to DEST.
Juanma Barranquero's avatar
Juanma Barranquero committed
368
Also generate PostScript output in PS-DEST."
369 370 371 372 373 374
  (call-process "texi2dvi" nil nil nil
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
		texi-file "-o" dest)
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
  (call-process "dvips" nil nil nil dest "-o" ps-dest)
  (call-process "gzip" nil nil nil dest)
  (call-process "gzip" nil nil nil ps-dest))

(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)
412 413 414
    (re-search-forward "<body>\n")
    (setq opoint (match-end 0))
    (search-forward "<h2 class=\"")
415 416 417 418 419 420 421 422
    (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.
423 424
    (or (search-forward "<ul class=\"menu\">" nil t)
	(search-forward "<ul>"))
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
    (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>")
457
	(search-forward "<p>" nil t)
458 459 460 461 462 463 464 465 466 467 468 469 470
	(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\">")
471 472
	(if (re-search-forward "</p>[ \t\n]*<ul class=\"menu\">" nil t)
	    (replace-match "  </th></tr>")))
473 474 475 476 477 478 479 480
       ((looking-at "[ \t]*</ul>[ \t]*$")
	(replace-match
	 (if open-td
	     "  </td></tr>\n</table>"
	   "</table>") t t)
	(setq done t))
       (t
	(if (eobp)
481
	    (error "Parse error in %s" f)) ; f is bound in manual-html-node
482 483 484 485
	(unless open-td
	  (setq done t))))
      (forward-line 1))))

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501

;; Stuff to check new defcustoms got :version tags.
;; Adapted from check-declare.el.

(defun cusver-find-files (root &optional old)
  "Find .el files beneath directory ROOT that contain defcustoms.
If optional OLD is non-nil, also include defvars."
  (process-lines find-program root
		 "-name" "*.el"
		 "-exec" grep-program
		 "-l" "-E" (format "^[ \\t]*\\(def%s"
				   (if old "(custom|var)"
				     "custom"
				     ))
		 "{}" "+"))

502 503
(defvar cusver-new-version (format "%s.%s" emacs-major-version
				   (1+ emacs-minor-version))
504 505
  "Version number that new defcustoms should have.")

506 507 508 509 510 511 512 513
(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).
If optional argument OLD is non-nil, also scan for defvars."
  (let ((m (format "Scanning %s..." file))
	(re (format "^[ \t]*\\((def%s\\)[ \t\n]"
514 515
		    (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
        alist var ver form glist grp)
516 517 518 519 520 521 522
    (message "%s" m)
    (with-temp-buffer
      (insert-file-contents file)
      ;; FIXME we could theoretically be inside a string.
      (while (re-search-forward re nil t)
        (goto-char (match-beginning 1))
        (if (and (setq form (ignore-errors (read (current-buffer))))
523
		 (setq var (car-safe (cdr-safe form)))
524 525
		 ;; Exclude macros, eg (defcustom ,varname ...).
		 (symbolp var))
526 527 528 529 530 531 532 533 534 535 536 537 538 539
	    (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))))
540 541 542 543
          (if form (message "Malformed defcustom: `%s'" form)))))
    (message "%sdone" m)
    alist))

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
(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)))))

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
(define-button-type 'cusver-xref 'action #'cusver-goto-xref)

(defun cusver-goto-xref (button)
  "Jump to a lisp file for the BUTTON at point."
  (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
574 575 576
;; 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.
577
(defun cusver-check (newdir olddir version)
578 579 580 581 582 583 584 585
  "Check that defcustoms have :version tags where needed.
NEWDIR is the current lisp/ directory, OLDDIR is that from the previous
release.  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.

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."
586 587 588 589 590
  (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)))))
591 592 593 594
  (or (file-directory-p (setq newdir (expand-file-name newdir)))
      (error "Directory `%s' not found" newdir))
  (or (file-directory-p (setq olddir (expand-file-name olddir)))
      (error "Directory `%s' not found" olddir))
595
  (setq cusver-new-version version)
596 597 598 599 600 601 602 603
  (let* ((newfiles (progn (message "Finding new files with defcustoms...")
			  (cusver-find-files newdir)))
	 (oldfiles (progn (message "Finding old files with defcustoms...")
			  (cusver-find-files olddir t)))
	 (newcus (progn (message "Reading new defcustoms...")
			(mapcar
			 (lambda (file)
			   (cons file (cusver-scan file))) newfiles)))
604
	 oldcus result thisfile file)
605 606 607
    (message "Reading old defcustoms...")
    (dolist (file oldfiles)
      (setq oldcus (append oldcus (cusver-scan file t))))
608 609
    (setq oldcus (append oldcus (cusver-scan-cus-start
				 (expand-file-name "cus-start.el" olddir))))
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    ;; 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)
      (insert "These defcustoms might be missing :version tags:\n\n")
      (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
643 644
(provide 'admin)

645
;;; admin.el ends here