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

3
;; Copyright (C) 2001-2014 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))
Glenn Morris's avatar
Glenn Morris committed
68
  (setq version (format "%s" version))
69 70
  (unless (re-search-forward rx nil :noerror)
    (user-error "Version not found in %s" file))
Glenn Morris's avatar
Glenn Morris committed
71 72 73 74
  (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
75 76 77 78

(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
79 80 81 82 83
  (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
84
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
85
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
86
  (message "Setting version numbers...")
Xue Fuqiao's avatar
Xue Fuqiao committed
87 88
  ;; 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
89
  ;; occurrence, it won't be replaced.
Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92
  (set-version-in-file root "README" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
93
  (set-version-in-file root "configure.ac" version
94 95 96
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
Glenn Morris's avatar
Glenn Morris committed
97
  ;; No longer used, broken in multiple ways, updating version seems pointless.
98 99
  (set-version-in-file root "nt/config.nt" version
		       (rx (and bol "#" (0+ blank) "define" (1+ blank)
100
				"VERSION" (1+ blank) "\""
101
				(submatch (1+ (in "0-9."))))))
102 103
  (set-version-in-file root "msdos/sed2v2.inp" version
		       (rx (and bol "/^#undef " (1+ not-newline)
104
				"define VERSION" (1+ space) "\""
105
				(submatch (1+ (in "0-9."))))))
Glenn Morris's avatar
Glenn Morris committed
106
  ;; No longer used, broken in multiple ways, updating version seems pointless.
107 108 109
  (set-version-in-file root "nt/makefile.w32-in" version
		       (rx (and "VERSION" (0+ space) "=" (0+ space)
				(submatch (1+ (in "0-9."))))))
110 111 112 113 114
  ;; 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
115
				     '("0" "0")))
116 117 118
	 (comma-version
	  (concat (car version-components) ","
		  (cadr version-components) ","
119
		  (cadr (cdr version-components)) ","
120 121 122 123
		  (cadr (cdr (cdr version-components)))))
	 (comma-space-version
	  (concat (car version-components) ", "
		  (cadr version-components) ", "
124
		  (cadr (cdr version-components)) ", "
125 126 127 128 129 130 131 132 133 134 135 136 137
		  (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, ")))
138 139 140 141 142 143 144 145 146 147 148 149
				  "\\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
150 151
			 (rx (and "\"ProductVersion\"" (0+ space) ?,
				  (0+ space) ?\" (submatch (1+ (in "0-9, ")))
152
				  "\\0\"")))
153
    ;; Major version only.
154 155
    (when (string-match "\\([0-9]\\{2,\\}\\)" version)
      (setq version (match-string 1 version))
156 157 158
      (set-version-in-file root "src/msdos.c" version
			   (rx (and "Vwindow_system_version" (1+ not-newline)
				    ?\( (submatch (1+ (in "0-9"))) ?\))))
159 160
      (set-version-in-file root "etc/refcards/ru-refcard.tex" version
			   "\\\\newcommand{\\\\versionemacs}\\[0\\]\
Glenn Morris's avatar
Glenn Morris committed
161 162
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")))
  (message "Setting version numbers...done"))
163

Glenn Morris's avatar
Glenn Morris committed
164 165 166 167 168 169 170 171 172 173 174
;; 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))
175
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
176
  (message "Setting copyrights...")
177 178
  (set-version-in-file root "configure.ac" copyright
		       (rx (and bol "copyright" (0+ (not (in ?\")))
179
        			?\" (submatch (1+ (not (in ?\")))) ?\")))
180 181 182 183
  (set-version-in-file root "msdos/sed2v2.inp" copyright
		       (rx (and bol "/^#undef " (1+ not-newline)
				"define COPYRIGHT" (1+ space)
				?\" (submatch (1+ (not (in ?\")))) ?\")))
184 185 186 187
  (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
188
  (set-version-in-file root "lib-src/rcs2log" copyright
189 190 191 192
        	       (rx (and "Copyright" (0+ space) ?= (0+ space)
        			?\' (submatch (1+ nonl)))))
  (when (string-match "\\([0-9]\\{4\\}\\)" copyright)
    (setq copyright (match-string 1 copyright))
193 194 195
    (set-version-in-file root "etc/refcards/ru-refcard.tex" copyright
			 "\\\\newcommand{\\\\cyear}\\[0\\]\
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
196
    (set-version-in-file root "etc/refcards/emacsver.tex.in" copyright
197
			 "\\\\def\\\\year\
Glenn Morris's avatar
Glenn Morris committed
198 199
{\\([0-9]\\{4\\}\\)}.+%.+copyright year"))
  (message "Setting copyrights...done"))
Glenn Morris's avatar
Glenn Morris committed
200

201 202
;;; Various bits of magic for generating the web manuals

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

222
;; TODO report the progress
223 224
(defun make-manuals (root &optional type)
  "Generate the web manuals for the Emacs webpage.
Xue Fuqiao's avatar
Xue Fuqiao committed
225
ROOT should be the root of an Emacs source tree.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
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)))))))
241 242 243
  (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))
244
	 (ps-dir (expand-file-name "ps" dest))
245 246 247 248 249 250 251
	 (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.
252
    (when (file-directory-p dest)
253
      (if (y-or-n-p (format "Directory %s exists, delete it first? " dest))
254
	  (delete-directory dest t)
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	(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)))
280
    ;; Misc manuals
281 282 283
    (dolist (manual misc)
      (if (member type `(nil ,manual "misc"))
	  (manual-misc-html manual root html-node-dir html-mono-dir)))
284 285 286 287 288 289 290 291 292 293 294 295 296 297
    (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\">
298
@import url('/software/emacs/manual.css');\n</style>\n")
299

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

310 311 312 313 314
(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."
315
  (make-directory (or (file-name-directory dest) ".") t)
316
  (call-process "makeinfo" nil nil nil
317
		"-D" "WWW_GNU_ORG"
318 319 320 321
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
322 323 324 325 326 327 328 329 330 331
		"--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>")
332
    ;; Close the div id="content" that fix-index-1 added.
333 334 335 336 337 338 339 340 341
    (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
342
    (user-error "Manual file %s not found" texi-file))
343
  (make-directory dir t)
344
  (call-process "makeinfo" nil nil nil
345
		"-D" "WWW_GNU_ORG"
346 347 348 349
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
		"--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.
365 366 367 368 369
		(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)))
370
		(manual-html-fix-index-2)
371 372
		(if copyright-text
		    (insert copyright-text))
373
		;; Close the div id="content" that fix-index-1 added.
374
		(insert "\n</div>\n"))
375
	    ;; For normal nodes, give the header div a blue bg.
376
	    (manual-html-fix-node-div t))
377 378 379
	  (save-buffer))))))

(defun manual-pdf (texi-file dest)
Xue Fuqiao's avatar
Xue Fuqiao committed
380
  "Run texi2pdf on TEXI-FILE, emitting PDF output to DEST."
381
  (make-directory (or (file-name-directory dest) ".") t)
382 383 384 385
  (let ((default-directory (file-name-directory texi-file)))
    (call-process "texi2pdf" nil nil nil
		  "-I" "../emacs" "-I" "../misc"
		  texi-file "-o" dest)))
386

387 388
(defun manual-ps (texi-file dest)
  "Generate a PostScript version of TEXI-FILE as DEST."
389
  (make-directory (or (file-name-directory dest) ".") t)
390 391
  (let ((dvi-dest (concat (file-name-sans-extension dest) ".dvi"))
	(default-directory (file-name-directory texi-file)))
Xue Fuqiao's avatar
Xue Fuqiao committed
392
    ;; FIXME: Use `texi2dvi --ps'?  --xfq
393
    (call-process "texi2dvi" nil nil nil
394
		  "-I" "../emacs" "-I" "../misc"
395 396 397 398
		  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)))
399 400 401

(defun manual-html-fix-headers ()
  "Fix up HTML headers for the Emacs manual in the current buffer."
402 403 404 405 406
  (let ((texi5 (search-forward "<!DOCTYPE" nil t))
	opoint)
    ;; Texinfo 5 supplies a DOCTYPE.
    (or texi5
	(insert manual-doctype-string))
407 408 409 410
    (search-forward "<head>\n")
    (insert manual-meta-string)
    (search-forward "<meta")
    (setq opoint (match-beginning 0))
411 412
    (unless texi5
      (search-forward "<!--")
413 414 415
      (goto-char (match-beginning 0))
      (delete-region opoint (point))
      (search-forward "<meta http-equiv=\"Content-Style")
416
      (setq opoint (match-beginning 0)))
417
    (search-forward "</head>")
418 419
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
420 421 422 423 424 425 426 427
    (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"))))
428

429
;; Texinfo 5 changed these from class = "node" to "header", yay.
430
(defun manual-html-fix-node-div (&optional split)
431
  "Fix up HTML \"node\" divs in the current buffer."
432
  (let (opoint div-end type)
433
    (while (re-search-forward "<div class=\"\\(node\\|header\\)\"\\(>\\)" nil t)
434 435 436 437 438 439
      (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...
440
      (replace-match " style=\"background-color:#DDDDFF\">" t t nil 2)
441
      (setq opoint (point))
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
      (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))))))

462 463

(defun manual-html-fix-index-1 ()
464 465
  "Remove the h1 header, and the short and long contents lists.
Also start a \"content\" div."
466
  (let (opoint)
467
    (re-search-forward "<body.*>\n")
468
    (setq opoint (match-end 0))
469 470 471
    ;; 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=\""))
472 473
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
474
    ;; NB caller must close this div.
475 476 477
    (insert "<div id=\"content\" class=\"inner\">\n\n")))

(defun manual-html-fix-index-2 (&optional table-workaround)
478 479
  "Replace the index list in the current buffer with a HTML table.
Leave point after the table."
480
  (if (re-search-forward "<table class=\"menu\"\\(.*\\)>" nil t)
481
      ;; Texinfo 5 already uses a table.  Tweak it a bit.
482 483
      (let (opoint done)
	(replace-match " style=\"float:left\" width=\"100%\"" nil t nil 1)
484 485 486
	(forward-line 1)
	(while (not done)
	  (cond ((re-search-forward "<tr><td.*&bull; \\(<a.*</a>\\)\
487
:</td><td>&nbsp;&nbsp;</td><td[^>]*>\\(.*\\)" (line-end-position) t)
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
		 (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)))))
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
    (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
567
<h3>Detailed Node Listing</h3>\n\n" t t)
568
	  (search-forward "<p>")
569 570 571 572 573 574
	  ;; 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>"))
575 576 577 578 579 580 581 582 583 584 585 586
	  (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>
587
    <th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
	  (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)))))
603

604 605

(defconst make-manuals-dist-output-variables
606
  `(("@\\(top_\\)?srcdir@" . ".")	; top_srcdir is wrong, but not used
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 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
    ("^\\(\\(?: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))
      (if (or (string-match-p "\\(\\.texi\\'\\|/ChangeLog\\|/README\\'\\)" file)
	      (and (equal type "lispintro")
		   (string-match-p "\\.\\(eps\\|pdf\\)\\'" file)))
	  (copy-file file stem)))
    (with-temp-buffer
650 651 652 653 654 655 656
      (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))))
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
      (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))))

687

Xue Fuqiao's avatar
Xue Fuqiao committed
688
;; Stuff to check new `defcustom's got :version tags.
689 690 691
;; Adapted from check-declare.el.

(defun cusver-find-files (root &optional old)
Xue Fuqiao's avatar
Xue Fuqiao committed
692 693
  "Find .el files beneath directory ROOT that contain `defcustom's.
If optional OLD is non-nil, also include `defvar's."
694 695 696 697 698 699 700 701 702
  (process-lines find-program root
		 "-name" "*.el"
		 "-exec" grep-program
		 "-l" "-E" (format "^[ \\t]*\\(def%s"
				   (if old "(custom|var)"
				     "custom"
				     ))
		 "{}" "+"))

703 704
(defvar cusver-new-version (format "%s.%s" emacs-major-version
				   (1+ emacs-minor-version))
Xue Fuqiao's avatar
Xue Fuqiao committed
705
  "Version number that new `defcustom's should have.")
706

707 708 709 710 711
(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
712
If optional argument OLD is non-nil, also scan for `defvar's."
713 714
  (let ((m (format "Scanning %s..." file))
	(re (format "^[ \t]*\\((def%s\\)[ \t\n]"
715 716
		    (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
        alist var ver form glist grp)
717 718 719 720
    (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
721
      (while (re-search-forward re nil :noerror)
722 723
        (goto-char (match-beginning 1))
        (if (and (setq form (ignore-errors (read (current-buffer))))
724
		 (setq var (car-safe (cdr-safe form)))
725 726
		 ;; Exclude macros, eg (defcustom ,varname ...).
		 (symbolp var))
727
	    (progn
728 729 730 731 732 733
	      ;; 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)))
734 735 736 737 738 739 740 741 742 743 744 745 746
	      (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))))
747 748 749 750
          (if form (message "Malformed defcustom: `%s'" form)))))
    (message "%sdone" m)
    alist))

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
(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)))))

766 767 768
(define-button-type 'cusver-xref 'action #'cusver-goto-xref)

(defun cusver-goto-xref (button)
Xue Fuqiao's avatar
Xue Fuqiao committed
769
  "Jump to a Lisp file for the BUTTON at point."
770 771 772 773 774 775 776 777 778 779 780
  (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
781 782 783
;; 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.
784
(defun cusver-check (newdir olddir version)
Xue Fuqiao's avatar
Xue Fuqiao committed
785 786 787 788 789 790 791
  "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.
792 793 794

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."
795 796
  (interactive (list (read-directory-name "New Lisp directory: " nil nil t)
		     (read-directory-name "Old Lisp directory: " nil nil t)
797 798 799
		     (number-to-string
		      (read-number "New version number: "
				   (string-to-number cusver-new-version)))))
800
  (or (file-directory-p (setq newdir (expand-file-name newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
801
      (user-error "Directory `%s' not found" newdir))
802
  (or (file-directory-p (setq olddir (expand-file-name olddir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
803
      (user-error "Directory `%s' not found" olddir))
804
  (setq cusver-new-version version)
Xue Fuqiao's avatar
Xue Fuqiao committed
805
  (let* ((newfiles (progn (message "Finding new files with `defcustom's...")
806
			  (cusver-find-files newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
807
	 (oldfiles (progn (message "Finding old files with `defcustom's...")
808
			  (cusver-find-files olddir t)))
Xue Fuqiao's avatar
Xue Fuqiao committed
809
	 (newcus (progn (message "Reading new `defcustom's...")
810 811 812
			(mapcar
			 (lambda (file)
			   (cons file (cusver-scan file))) newfiles)))
813
	 oldcus result thisfile file)
Xue Fuqiao's avatar
Xue Fuqiao committed
814
    (message "Reading old `defcustom's...")
815 816
    (dolist (file oldfiles)
      (setq oldcus (append oldcus (cusver-scan file t))))
817 818
    (setq oldcus (append oldcus (cusver-scan-cus-start
				 (expand-file-name "cus-start.el" olddir))))
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
    ;; 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
839
      (insert "These `defcustom's might be missing :version tags:\n\n")
840 841 842 843 844 845 846 847 848 849 850 851
      (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
852 853
(provide 'admin)

854
;;; admin.el ends here