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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2001-2015 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

31
(defun add-release-logs (root version &optional date)
Gerd Moellmann's avatar
Gerd Moellmann committed
32
  "Add \"Version VERSION released.\" change log entries in ROOT.
33 34 35 36 37 38 39 40
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)
41
                                         (funcall add-log-time-format nil t)))))
42
  (setq root (expand-file-name root))
Gerd Moellmann's avatar
Gerd Moellmann committed
43
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
44
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
45
  (require 'add-log)
46
  (or date (setq date (funcall add-log-time-format nil t)))
Gerd Moellmann's avatar
Gerd Moellmann committed
47 48
  (let* ((logs (process-lines "find" root "-name" "ChangeLog"))
	 (entry (format "%s  %s  <%s>\n\n\t* Version %s released.\n\n"
49
			date
50 51 52
			(or add-log-full-name (user-full-name))
			(or add-log-mailing-address user-mail-address)
			version)))
Gerd Moellmann's avatar
Gerd Moellmann committed
53
    (dolist (log logs)
54 55 56
      (find-file log)
      (goto-char (point-min))
      (insert entry))))
Gerd Moellmann's avatar
Gerd Moellmann committed
57 58

(defun set-version-in-file (root file version rx)
Xue Fuqiao's avatar
Xue Fuqiao committed
59
  "Subroutine of `set-version' and `set-copyright'."
Gerd Moellmann's avatar
Gerd Moellmann committed
60 61
  (find-file (expand-file-name file root))
  (goto-char (point-min))
Glenn Morris's avatar
Glenn Morris committed
62
  (setq version (format "%s" version))
63 64
  (unless (re-search-forward rx nil :noerror)
    (user-error "Version not found in %s" file))
Glenn Morris's avatar
Glenn Morris committed
65 66 67 68
  (if (not (equal version (match-string 1)))
      (replace-match version nil nil nil 1)
    (kill-buffer)
    (message "No need to update `%s'" file)))
Gerd Moellmann's avatar
Gerd Moellmann committed
69 70 71 72

(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."
Glenn Morris's avatar
Glenn Morris committed
73 74 75 76 77
  (interactive (list
		(read-directory-name "Emacs root directory: " source-directory)
		(read-string "Version number: "
			     (replace-regexp-in-string "\\.[0-9]+\\'" ""
						       emacs-version))))
Gerd Moellmann's avatar
Gerd Moellmann committed
78
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
79
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
80
  (message "Setting version numbers...")
Xue Fuqiao's avatar
Xue Fuqiao committed
81 82
  ;; There's also a "version 3" (standing for GPLv3) at the end of
  ;; `README', but since `set-version-in-file' only replaces the first
Paul Eggert's avatar
Paul Eggert committed
83
  ;; occurrence, it won't be replaced.
Gerd Moellmann's avatar
Gerd Moellmann committed
84 85 86
  (set-version-in-file root "README" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
87
  (set-version-in-file root "configure.ac" version
88 89 90
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
91 92
  ;; TODO: msdos could easily extract the version number from
  ;; configure.ac with sed, rather than duplicating the information.
93 94
  (set-version-in-file root "msdos/sed2v2.inp" version
		       (rx (and bol "/^#undef " (1+ not-newline)
95
				"define VERSION" (1+ space) "\""
96
				(submatch (1+ (in "0-9."))))))
97 98 99 100 101 102 103 104 105
  ;; Major version only.
  (when (string-match "\\([0-9]\\{2,\\}\\)" version)
    (setq version (match-string 1 version))
    (set-version-in-file root "src/msdos.c" version
			 (rx (and "Vwindow_system_version" (1+ not-newline)
				  ?\( (submatch (1+ (in "0-9"))) ?\))))
    (set-version-in-file root "etc/refcards/ru-refcard.tex" version
			 "\\\\newcommand{\\\\versionemacs}\\[0\\]\
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs"))
Glenn Morris's avatar
Glenn Morris committed
106
  (message "Setting version numbers...done"))
107

Glenn Morris's avatar
Glenn Morris committed
108 109 110 111 112 113 114 115 116 117 118
;; 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))
119
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
120
  (message "Setting copyrights...")
121 122
  (set-version-in-file root "configure.ac" copyright
		       (rx (and bol "copyright" (0+ (not (in ?\")))
123
        			?\" (submatch (1+ (not (in ?\")))) ?\")))
124 125 126 127
  (set-version-in-file root "msdos/sed2v2.inp" copyright
		       (rx (and bol "/^#undef " (1+ not-newline)
				"define COPYRIGHT" (1+ space)
				?\" (submatch (1+ (not (in ?\")))) ?\")))
Glenn Morris's avatar
Glenn Morris committed
128
  (set-version-in-file root "lib-src/rcs2log" copyright
129 130 131 132
        	       (rx (and "Copyright" (0+ space) ?= (0+ space)
        			?\' (submatch (1+ nonl)))))
  (when (string-match "\\([0-9]\\{4\\}\\)" copyright)
    (setq copyright (match-string 1 copyright))
133 134 135
    (set-version-in-file root "etc/refcards/ru-refcard.tex" copyright
			 "\\\\newcommand{\\\\cyear}\\[0\\]\
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
136
    (set-version-in-file root "etc/refcards/emacsver.tex.in" copyright
137
			 "\\\\def\\\\year\
Glenn Morris's avatar
Glenn Morris committed
138 139
{\\([0-9]\\{4\\}\\)}.+%.+copyright year"))
  (message "Setting copyrights...done"))
Glenn Morris's avatar
Glenn Morris committed
140

141 142
;;; Various bits of magic for generating the web manuals

143
(defun manual-misc-manuals (root)
Xue Fuqiao's avatar
Xue Fuqiao committed
144 145
  "Return doc/misc manuals as list of strings.
ROOT should be the root of an Emacs source tree."
146 147
  ;; Similar to `make -C doc/misc echo-info', but works if unconfigured,
  ;; and for INFO_TARGETS rather than INFO_INSTALL.
148 149
  (with-temp-buffer
    (insert-file-contents (expand-file-name "doc/misc/Makefile.in" root))
150 151 152
    ;; Should really use expanded value of INFO_TARGETS.
    (search-forward "INFO_COMMON = ")
    (let ((start (point)))
153 154 155 156
      (end-of-line)
      (while (and (looking-back "\\\\")
		  (zerop (forward-line 1)))
	(end-of-line))
157 158 159 160
      (append (split-string (replace-regexp-in-string
			     "\\(\\\\\\|\\.info\\)" ""
			     (buffer-substring start (point))))
	      '("efaq-w32")))))
161

162
;; TODO report the progress
163 164
(defun make-manuals (root &optional type)
  "Generate the web manuals for the Emacs webpage.
Xue Fuqiao's avatar
Xue Fuqiao committed
165
ROOT should be the root of an Emacs source tree.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
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)))))))
181 182 183
  (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))
184
	 (ps-dir (expand-file-name "ps" dest))
185 186
	 (pdf-dir (expand-file-name "pdf" dest))
	 (emacs (expand-file-name "doc/emacs/emacs.texi" root))
187
	 (emacs-xtra (expand-file-name "doc/emacs/emacs-xtra.texi" root))
188 189 190 191 192
	 (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.
193
    (when (file-directory-p dest)
194
      (if (y-or-n-p (format "Directory %s exists, delete it first? " dest))
195
	  (delete-directory dest t)
196 197 198 199 200
	(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)))
201 202 203 204 205 206 207 208
    (when (member type '(nil "emacs" "emacs-pdf" "pdf"))
      (manual-pdf emacs (expand-file-name "emacs.pdf" pdf-dir))
      ;; emacs-xtra exists only in pdf/ps format.
      ;; In other formats it is included in the Emacs manual.
      (manual-pdf emacs-xtra (expand-file-name "emacs-xtra.pdf" pdf-dir)))
    (when (member type '(nil "emacs" "emacs-ps" "ps"))
      (manual-ps emacs (expand-file-name "emacs.ps" ps-dir))
      (manual-ps emacs-xtra (expand-file-name "emacs-xtra.ps" ps-dir)))
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    (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)))
225
    ;; Misc manuals
226 227 228
    (dolist (manual misc)
      (if (member type `(nil ,manual "misc"))
	  (manual-misc-html manual root html-node-dir html-mono-dir)))
229 230 231 232 233 234 235 236
    (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\">
237
<link rev=\"made\" href=\"mailto:bug-gnu-emacs@gnu.org\">
238 239 240 241 242
<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\">
243
@import url('/software/emacs/manual.css');\n</style>\n")
244

245
(defun manual-misc-html (name root html-node-dir html-mono-dir)
246
  ;; Hack to deal with the cases where .texi creates a different .info.
247
  ;; Blech.  TODO Why not just rename the .texi (or .info) files?
248 249 250
  (let* ((texiname (cond ((equal name "ccmode") "cc-mode")
			 (t name)))
	 (texi (expand-file-name (format "doc/misc/%s.texi" texiname) root)))
251 252 253 254
    (manual-html-node texi (expand-file-name name html-node-dir))
    (manual-html-mono texi (expand-file-name (concat name ".html")
					     html-mono-dir))))

255 256 257 258 259
(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."
260
  (make-directory (or (file-name-directory dest) ".") t)
261
  (call-process "makeinfo" nil nil nil
262
		"-D" "WWW_GNU_ORG"
263 264 265 266
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
267 268 269 270 271 272 273 274 275 276
		"--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>")
277
    ;; Close the div id="content" that fix-index-1 added.
278 279 280 281 282 283 284 285 286
    (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
287
    (user-error "Manual file %s not found" texi-file))
288
  (make-directory dir t)
289
  (call-process "makeinfo" nil nil nil
290
		"-D" "WWW_GNU_ORG"
291 292 293 294
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
		"--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.
310 311 312 313 314
		(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)))
315
		(manual-html-fix-index-2)
316 317
		(if copyright-text
		    (insert copyright-text))
318
		;; Close the div id="content" that fix-index-1 added.
319
		(insert "\n</div>\n"))
320
	    ;; For normal nodes, give the header div a blue bg.
321
	    (manual-html-fix-node-div t))
322 323 324
	  (save-buffer))))))

(defun manual-pdf (texi-file dest)
Xue Fuqiao's avatar
Xue Fuqiao committed
325
  "Run texi2pdf on TEXI-FILE, emitting PDF output to DEST."
326
  (make-directory (or (file-name-directory dest) ".") t)
327 328 329 330
  (let ((default-directory (file-name-directory texi-file)))
    (call-process "texi2pdf" nil nil nil
		  "-I" "../emacs" "-I" "../misc"
		  texi-file "-o" dest)))
331

332 333
(defun manual-ps (texi-file dest)
  "Generate a PostScript version of TEXI-FILE as DEST."
334
  (make-directory (or (file-name-directory dest) ".") t)
335 336
  (let ((dvi-dest (concat (file-name-sans-extension dest) ".dvi"))
	(default-directory (file-name-directory texi-file)))
Xue Fuqiao's avatar
Xue Fuqiao committed
337
    ;; FIXME: Use `texi2dvi --ps'?  --xfq
338
    (call-process "texi2dvi" nil nil nil
339
		  "-I" "../emacs" "-I" "../misc"
340 341 342 343
		  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)))
344 345 346

(defun manual-html-fix-headers ()
  "Fix up HTML headers for the Emacs manual in the current buffer."
347 348 349 350 351
  (let ((texi5 (search-forward "<!DOCTYPE" nil t))
	opoint)
    ;; Texinfo 5 supplies a DOCTYPE.
    (or texi5
	(insert manual-doctype-string))
352 353 354 355
    (search-forward "<head>\n")
    (insert manual-meta-string)
    (search-forward "<meta")
    (setq opoint (match-beginning 0))
356 357
    (unless texi5
      (search-forward "<!--")
358 359 360
      (goto-char (match-beginning 0))
      (delete-region opoint (point))
      (search-forward "<meta http-equiv=\"Content-Style")
361
      (setq opoint (match-beginning 0)))
362
    (search-forward "</head>")
363 364
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
365 366 367 368 369 370 371 372
    (insert manual-style-string)
    ;; Remove Texinfo 5 hard-coding bgcolor, text, link, vlink, alink.
    (when (re-search-forward "<body lang=\"[^\"]+\"" nil t)
      (setq opoint (point))
      (search-forward ">")
      (if (> (point) (1+ opoint))
	  (delete-region opoint (1- (point))))
      (search-backward "</head"))))
373

374
;; Texinfo 5 changed these from class = "node" to "header", yay.
375
(defun manual-html-fix-node-div (&optional split)
376
  "Fix up HTML \"node\" divs in the current buffer."
377
  (let (opoint div-end type)
378
    (while (re-search-forward "<div class=\"\\(node\\|header\\)\"\\(>\\)" nil t)
379 380 381 382 383 384
      (setq type (match-string 1))
      ;; NB it is this that makes the bg of non-header cells in the
      ;; index tables be blue.  Is that intended?
      ;; Also, if you don't remove the <hr>, the color of the first
      ;; row in the table will be wrong.
      ;; This all seems rather odd to me...
385
      (replace-match " style=\"background-color:#DDDDFF\">" t t nil 2)
386
      (setq opoint (point))
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
      (when (or split (equal type "node"))
	;; In Texinfo 4, the <hr> (and anchor) comes after the <div>.
	(re-search-forward "</div>")
	(setq div-end (if (equal type "node")
			  (match-beginning 0)
			(line-end-position 2)))
	(goto-char opoint)
	(if (search-forward "<hr>" div-end 'move)
		(replace-match "" t t)
	  (if split (forward-line -1))))
      ;; In Texinfo 5, the <hr> (and anchor) comes before the <div> (?).
      ;; Except in split output, where it comes on the line after
      ;; the <div>.  But only sometimes.  I have no clue what the
      ;; logic of where it goes is.
      (when (equal type "header")
	(goto-char opoint)
	(when (re-search-backward "^<hr>$" (line-beginning-position -3) t)
	  (replace-match "")
	  (goto-char opoint))))))

407 408

(defun manual-html-fix-index-1 ()
409 410
  "Remove the h1 header, and the short and long contents lists.
Also start a \"content\" div."
411
  (let (opoint)
412
    (re-search-forward "<body.*>\n")
413
    (setq opoint (match-end 0))
414 415 416
    ;; FIXME?  Fragile if a Texinfo 5 document does not use @top.
    (or (re-search-forward "<h1 class=\"top\"" nil t) ; Texinfo 5
	(search-forward "<h2 class=\""))
417 418
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
419
    ;; NB caller must close this div.
420 421 422
    (insert "<div id=\"content\" class=\"inner\">\n\n")))

(defun manual-html-fix-index-2 (&optional table-workaround)
423 424
  "Replace the index list in the current buffer with a HTML table.
Leave point after the table."
425
  (if (re-search-forward "<table class=\"menu\"\\(.*\\)>" nil t)
426
      ;; Texinfo 5 already uses a table.  Tweak it a bit.
427 428
      (let (opoint done)
	(replace-match " style=\"float:left\" width=\"100%\"" nil t nil 1)
429 430 431
	(forward-line 1)
	(while (not done)
	  (cond ((re-search-forward "<tr><td.*&bull; \\(<a.*</a>\\)\
432
:</td><td>&nbsp;&nbsp;</td><td[^>]*>\\(.*\\)" (line-end-position) t)
433 434 435 436 437 438 439 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 472 473 474 475 476
		 (replace-match (format "<tr><td%s>\\1</td>\n<td>\\2"
					(if table-workaround
					    " bgcolor=\"white\"" "")))
		 (search-forward "</td></tr>")
		 (forward-line 1))
		((looking-at "<tr><th.*<pre class=\"menu-comment\">\n")
		 (replace-match "<tr><th colspan=\"2\" align=\"left\" \
style=\"text-align:left\">")
		 (search-forward "</pre></th></tr>")
		 (replace-match "</th></tr>\n"))
		;; Not all manuals have the detailed menu.
		;; If it is there, split it into a separate table.
		((re-search-forward "<tr>.*The Detailed Node Listing *"
				    (line-end-position) t)
		 (setq opoint (match-beginning 0))
		 (while (and (looking-at " *&mdash;")
			     (zerop (forward-line 1))))
		 (delete-region opoint (point))
		 (insert "</table>\n\n\
<h2>Detailed Node Listing</h2>\n\n<p>")
		 ;; FIXME Fragile!
		 ;; The Emacs and Elisp manual have some text at the
		 ;; start of the detailed menu that is not part of the menu.
		 ;; Other manuals do not.
		 (if (re-search-forward "in one step:" (line-end-position 3) t)
		     (forward-line 1))
		 (insert "</p>\n")
		 (search-forward "</pre></th></tr>")
		 (delete-region (match-beginning 0) (match-end 0))
		 (forward-line -1)
		 (or (looking-at "^$") (error "Parse error 1"))
		 (forward-line -1)
		 (if (looking-at "^$") (error "Parse error 2"))
		 (forward-line -1)
		 (or (looking-at "^$") (error "Parse error 3"))
		 (forward-line 1)
		 (insert "<table class=\"menu\" style=\"float:left\" width=\"100%\">\n\
<tr><th colspan=\"2\" align=\"left\" style=\"text-align:left\">\n")
		 (forward-line 1)
		 (insert "</th></tr>")
		 (forward-line 1))
		((looking-at ".*</table")
		 (forward-line 1)
		 (setq done t)))))
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
    (let (done open-td tag desc)
      ;; Convert the list that Makeinfo made into a table.
      (or (search-forward "<ul class=\"menu\">" nil t)
	  ;; FIXME?  The following search seems dangerously lax.
	  (search-forward "<ul>"))
      (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
512
<h3>Detailed Node Listing</h3>\n\n" t t)
513
	  (search-forward "<p>")
514 515 516 517 518 519
	  ;; FIXME Fragile!
	  ;; The Emacs and Elisp manual have some text at the
	  ;; start of the detailed menu that is not part of the menu.
	  ;; Other manuals do not.
	  (if (looking-at "Here are some other nodes")
	      (search-forward "<p>"))
520 521 522 523 524 525 526 527 528 529 530 531
	  (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>
532
    <th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
	  (if (re-search-forward "</p>[ \t\n]*<ul class=\"menu\">" nil t)
	      (replace-match "  </th></tr>")))
	 ((looking-at "[ \t]*</ul>[ \t]*$")
	  (replace-match
	   (if open-td
	       "  </td></tr>\n</table>"
	     "</table>") t t)
	  (setq done t))
	 (t
	  (if (eobp)
	      (error "Parse error in %s"
		     (file-name-nondirectory buffer-file-name)))
	  (unless open-td
	    (setq done t))))
	(forward-line 1)))))
548

549 550

(defconst make-manuals-dist-output-variables
551
  `(("@\\(top_\\)?srcdir@" . ".")	; top_srcdir is wrong, but not used
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    ("^\\(\\(?:texinfo\\|buildinfo\\|emacs\\)dir *=\\).*" . "\\1 .")
    ("^\\(clean:.*\\)" . "\\1 infoclean")
    ("@MAKEINFO@" . "makeinfo")
    ("@MKDIR_P@" . "mkdir -p")
    ("@INFO_EXT@" . ".info")
    ("@INFO_OPTS@" . "")
    ("@SHELL@" . "/bin/bash")
    ("@prefix@" . "/usr/local")
    ("@datarootdir@" . "${prefix}/share")
    ("@datadir@" . "${datarootdir}")
    ("@PACKAGE_TARNAME@" . "emacs")
    ("@docdir@" . "${datarootdir}/doc/${PACKAGE_TARNAME}")
    ("@\\(dvi\\|html\\|pdf\\|ps\\)dir@" . "${docdir}")
    ("@GZIP_PROG@" . "gzip")
    ("@INSTALL@" . "install -c")
    ("@INSTALL_DATA@" . "${INSTALL} -m 644")
    ("@configure_input@" . ""))
  "Alist of (REGEXP . REPLACEMENT) pairs for `make-manuals-dist'.")

(defun make-manuals-dist--1 (root type)
  "Subroutine of `make-manuals-dist'."
  (let* ((dest (expand-file-name "manual" root))
	 (default-directory (progn (make-directory dest t)
				   (file-name-as-directory dest)))
	 (version (with-temp-buffer
		    (insert-file-contents "../doc/emacs/emacsver.texi")
		    (re-search-forward "@set EMACSVER \\([0-9.]+\\)")
		    (match-string 1)))
	 (stem (format "emacs-%s-%s" (if (equal type "emacs") "manual" type)
		       version))
	 (tarfile (format "%s.tar" stem)))
    (message "Doing %s..." type)
    (if (file-directory-p stem)
	(delete-directory stem t))
    (make-directory stem)
    (copy-file "../doc/misc/texinfo.tex" stem)
    (or (equal type "emacs") (copy-file "../doc/emacs/emacsver.texi" stem))
    (dolist (file (directory-files (format "../doc/%s" type) t))
590
      (if (or (string-match-p "\\(\\.texi\\'\\|/README\\'\\)" file)
591 592 593 594
	      (and (equal type "lispintro")
		   (string-match-p "\\.\\(eps\\|pdf\\)\\'" file)))
	  (copy-file file stem)))
    (with-temp-buffer
595 596 597 598 599 600 601
      (let ((outvars make-manuals-dist-output-variables))
	(push `("@version@" . ,version) outvars)
	(insert-file-contents (format "../doc/%s/Makefile.in" type))
	(dolist (cons outvars)
	  (while (re-search-forward (car cons) nil t)
	    (replace-match (cdr cons) t))
	  (goto-char (point-min))))
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
      (let (ats)
	(while (re-search-forward "@[a-zA-Z_]+@" nil t)
	  (setq ats t)
	  (message "Unexpanded: %s" (match-string 0)))
	(if ats (error "Unexpanded configure variables in Makefile?")))
      (write-region nil nil (expand-file-name (format "%s/Makefile" stem))
		    nil 'silent))
    (call-process "tar" nil nil nil "-cf" tarfile stem)
    (delete-directory stem t)
    (message "...created %s" tarfile)))

;; Does anyone actually use these tarfiles?
(defun make-manuals-dist (root &optional type)
  "Make the standalone manual source tarfiles for the Emacs webpage.
ROOT should be the root of an Emacs source tree.
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: "
			    '("emacs" "lispref" "lispintro" "misc"))))))
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
  (dolist (m '("emacs" "lispref" "lispintro" "misc"))
    (if (member type (list nil m))
	(make-manuals-dist--1 root m))))

632

Xue Fuqiao's avatar
Xue Fuqiao committed
633
;; Stuff to check new `defcustom's got :version tags.
634 635 636
;; Adapted from check-declare.el.

(defun cusver-find-files (root &optional old)
Xue Fuqiao's avatar
Xue Fuqiao committed
637 638
  "Find .el files beneath directory ROOT that contain `defcustom's.
If optional OLD is non-nil, also include `defvar's."
639 640 641 642 643 644 645 646 647
  (process-lines find-program root
		 "-name" "*.el"
		 "-exec" grep-program
		 "-l" "-E" (format "^[ \\t]*\\(def%s"
				   (if old "(custom|var)"
				     "custom"
				     ))
		 "{}" "+"))

648 649
(defvar cusver-new-version (format "%s.%s" emacs-major-version
				   (1+ emacs-minor-version))
Xue Fuqiao's avatar
Xue Fuqiao committed
650
  "Version number that new `defcustom's should have.")
651

652 653 654 655 656
(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
657
If optional argument OLD is non-nil, also scan for `defvar's."
658 659
  (let ((m (format "Scanning %s..." file))
	(re (format "^[ \t]*\\((def%s\\)[ \t\n]"
660 661
		    (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
        alist var ver form glist grp)
662 663 664 665
    (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
666
      (while (re-search-forward re nil :noerror)
667 668
        (goto-char (match-beginning 1))
        (if (and (setq form (ignore-errors (read (current-buffer))))
669
		 (setq var (car-safe (cdr-safe form)))
670 671
		 ;; Exclude macros, eg (defcustom ,varname ...).
		 (symbolp var))
672
	    (progn
673 674 675 676 677 678
	      ;; FIXME It should be cus-test-apropos that does this.
	      (and (not old)
		   (equal "custom" (match-string 2))
		   (not (memq :type form))
		   (display-warning 'custom
				    (format "Missing type in: `%s'" form)))
679 680 681 682 683 684 685 686 687 688 689 690 691
	      (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))))
692 693 694 695
          (if form (message "Malformed defcustom: `%s'" form)))))
    (message "%sdone" m)
    alist))

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
(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)))))

711 712 713
(define-button-type 'cusver-xref 'action #'cusver-goto-xref)

(defun cusver-goto-xref (button)
Xue Fuqiao's avatar
Xue Fuqiao committed
714
  "Jump to a Lisp file for the BUTTON at point."
715 716 717 718 719 720 721 722 723 724 725
  (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
726 727 728
;; 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.
729
(defun cusver-check (newdir olddir version)
Xue Fuqiao's avatar
Xue Fuqiao committed
730 731 732 733 734 735 736
  "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.
737 738 739

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."
740 741
  (interactive (list (read-directory-name "New Lisp directory: " nil nil t)
		     (read-directory-name "Old Lisp directory: " nil nil t)
742 743 744
		     (number-to-string
		      (read-number "New version number: "
				   (string-to-number cusver-new-version)))))
745
  (or (file-directory-p (setq newdir (expand-file-name newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
746
      (user-error "Directory `%s' not found" newdir))
747
  (or (file-directory-p (setq olddir (expand-file-name olddir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
748
      (user-error "Directory `%s' not found" olddir))
749
  (setq cusver-new-version version)
Xue Fuqiao's avatar
Xue Fuqiao committed
750
  (let* ((newfiles (progn (message "Finding new files with `defcustom's...")
751
			  (cusver-find-files newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
752
	 (oldfiles (progn (message "Finding old files with `defcustom's...")
753
			  (cusver-find-files olddir t)))
Xue Fuqiao's avatar
Xue Fuqiao committed
754
	 (newcus (progn (message "Reading new `defcustom's...")
755 756 757
			(mapcar
			 (lambda (file)
			   (cons file (cusver-scan file))) newfiles)))
758
	 oldcus result thisfile file)
Xue Fuqiao's avatar
Xue Fuqiao committed
759
    (message "Reading old `defcustom's...")
760 761
    (dolist (file oldfiles)
      (setq oldcus (append oldcus (cusver-scan file t))))
762 763
    (setq oldcus (append oldcus (cusver-scan-cus-start
				 (expand-file-name "cus-start.el" olddir))))
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
    ;; 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
784
      (insert "These `defcustom's might be missing :version tags:\n\n")
785 786 787 788 789 790 791 792 793 794 795 796
      (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
797 798
(provide 'admin)

799
;;; admin.el ends here