admin.el 36 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-2017 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
Also update the etc/HISTORY file.
34 35 36 37 38 39 40 41
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)
42
                                         (funcall add-log-time-format nil t)))))
43
  (setq root (expand-file-name root))
Gerd Moellmann's avatar
Gerd Moellmann committed
44
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
45
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
46 47 48 49 50 51 52 53 54 55 56 57 58
  (let ((clog (expand-file-name "ChangeLog" root)))
    (if (file-exists-p clog)
        ;; Basic check that a ChangeLog that exists is not your personal one.
        ;; TODO Perhaps we should move any existing file and unconditionally
        ;; call make ChangeLog?  Or make ChangeLog CHANGELOG=temp and compare
        ;; with the existing?
        (with-temp-buffer
          (insert-file-contents clog)
          (or (re-search-forward "^[ \t]*Copyright.*Free Software" nil t)
              (user-error "ChangeLog looks like a personal one - remove it?")))
      (or
       (zerop (call-process "make" nil nil nil "-C" root "ChangeLog"))
       (error "Problem generating ChangeLog"))))
59
  (require 'add-log)
60
  (or date (setq date (funcall add-log-time-format nil t)))
Gerd Moellmann's avatar
Gerd Moellmann committed
61 62
  (let* ((logs (process-lines "find" root "-name" "ChangeLog"))
	 (entry (format "%s  %s  <%s>\n\n\t* Version %s released.\n\n"
63
			date
64 65 66
			(or add-log-full-name (user-full-name))
			(or add-log-mailing-address user-mail-address)
			version)))
Gerd Moellmann's avatar
Gerd Moellmann committed
67
    (dolist (log logs)
68 69
      (find-file log)
      (goto-char (point-min))
70 71 72 73 74 75 76 77
      (insert entry)))
  (let ((histfile (expand-file-name "etc/HISTORY" root)))
    (unless (file-exists-p histfile)
      (error "%s not present" histfile))
    (find-file histfile)
    (goto-char (point-max))
    (search-backward "")
    (insert (format "GNU Emacs %s (%s) emacs-%s\n\n" version date version))))
Gerd Moellmann's avatar
Gerd Moellmann committed
78 79

(defun set-version-in-file (root file version rx)
Xue Fuqiao's avatar
Xue Fuqiao committed
80
  "Subroutine of `set-version' and `set-copyright'."
Gerd Moellmann's avatar
Gerd Moellmann committed
81 82
  (find-file (expand-file-name file root))
  (goto-char (point-min))
Glenn Morris's avatar
Glenn Morris committed
83
  (setq version (format "%s" version))
84 85
  (unless (re-search-forward rx nil :noerror)
    (user-error "Version not found in %s" file))
Glenn Morris's avatar
Glenn Morris committed
86 87 88 89
  (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
90 91 92 93

(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
94 95 96 97 98
  (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
99
  (unless (file-exists-p (expand-file-name "src/emacs.c" root))
100
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
101
  (message "Setting version numbers...")
Xue Fuqiao's avatar
Xue Fuqiao committed
102 103
  ;; 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
104
  ;; occurrence, it won't be replaced.
Gerd Moellmann's avatar
Gerd Moellmann committed
105 106 107
  (set-version-in-file root "README" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
108
  (set-version-in-file root "configure.ac" version
109 110 111
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
112 113 114
  (set-version-in-file root "nt/README.W32" version
		       (rx (and "version" (1+ space)
				(submatch (1+ (in "0-9."))))))
115 116
  ;; TODO: msdos could easily extract the version number from
  ;; configure.ac with sed, rather than duplicating the information.
117 118
  (set-version-in-file root "msdos/sed2v2.inp" version
		       (rx (and bol "/^#undef " (1+ not-newline)
119
				"define VERSION" (1+ space) "\""
120
				(submatch (1+ (in "0-9."))))))
121 122
  ;; Major version only.
  (when (string-match "\\([0-9]\\{2,\\}\\)" version)
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    (let ((newmajor (match-string 1 version)))
      (set-version-in-file root "src/msdos.c" newmajor
                           (rx (and "Vwindow_system_version" (1+ not-newline)
                                    ?\( (submatch (1+ (in "0-9"))) ?\))))
      (set-version-in-file root "etc/refcards/ru-refcard.tex" newmajor
                           "\\\\newcommand{\\\\versionemacs}\\[0\\]\
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")))
  (let* ((oldversion
          (with-temp-buffer
            (insert-file-contents (expand-file-name "README" root))
            (if (re-search-forward "version \\([0-9.]*\\)" nil t)
                (version-to-list (match-string 1)))))
         (oldmajor (if oldversion (car oldversion)))
         (newversion (version-to-list version))
         (newmajor (car newversion))
         (newshort (format "%s.%s" newmajor
                           (+ (cadr newversion)
                              (if (eq 2 (length newversion)) 0 1))))
         (majorbump (and oldversion (not (equal oldmajor newmajor))))
         (minorbump (and oldversion (not majorbump)
                         (not (equal (cadr oldversion) (cadr newversion)))))
         (newsfile (expand-file-name "etc/NEWS" root))
         (oldnewsfile (expand-file-name (format "etc/NEWS.%s" oldmajor) root)))
    (when (and majorbump
               (not (file-exists-p oldnewsfile)))
      (rename-file newsfile oldnewsfile)
      (find-file oldnewsfile)           ; to prompt you to commit it
      (copy-file oldnewsfile newsfile)
      (with-temp-buffer
        (insert-file-contents newsfile)
        (re-search-forward "is about changes in Emacs version \\([0-9]+\\)")
        (replace-match (number-to-string newmajor) nil nil nil 1)
        (re-search-forward "^See files \\(NEWS\\)")
        (replace-match (format "NEWS.%s, NEWS" oldmajor) nil nil nil 1)
        (let ((start (line-beginning-position)))
          (search-forward "in older Emacs versions")
          (or (equal start (line-beginning-position))
              (fill-region start (line-beginning-position 2))))
        (re-search-forward "^$")
        (forward-line -1)
        (let ((start (point)))
          (goto-char (point-max))
          (re-search-backward "^$" nil nil 2)
          (delete-region start (line-beginning-position 0)))
        (write-region nil nil newsfile)))
    (when (or majorbump minorbump)
      (find-file newsfile)
      (goto-char (point-min))
      (if (re-search-forward (format "^\\* .*in Emacs %s" newshort) nil t)
          (progn
            (kill-buffer)
            (message "No need to update etc/NEWS"))
        (goto-char (point-min))
        (re-search-forward "^$")
        (forward-line -1)
        (dolist (s '("Installation Changes" "Startup Changes" "Changes"
                     "Editing Changes"
                     "Changes in Specialized Modes and Packages"
                          "New Modes and Packages"
                          "Incompatible Lisp Changes"
                          "Lisp Changes"))
          (insert (format "\n\n* %s in Emacs %s\n" s newshort)))
        (insert (format "\n\n* Changes in Emacs %s on \
Non-Free Operating Systems\n" newshort)))
      ;; Because we skip "bump version" commits when merging between branches.
      ;; Probably doesn't matter in practice, because NEWS changes
      ;; will only happen on master anyway.
      (message "Commit any NEWS changes separately")))
Glenn Morris's avatar
Glenn Morris committed
191
  (message "Setting version numbers...done"))
192

Glenn Morris's avatar
Glenn Morris committed
193 194 195 196 197 198 199 200 201 202 203
;; 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))
204
    (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
Glenn Morris's avatar
Glenn Morris committed
205
  (message "Setting copyrights...")
206 207
  (set-version-in-file root "configure.ac" copyright
		       (rx (and bol "copyright" (0+ (not (in ?\")))
208
        			?\" (submatch (1+ (not (in ?\")))) ?\")))
209 210 211 212
  (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
213
  (set-version-in-file root "lib-src/rcs2log" copyright
214 215 216 217
        	       (rx (and "Copyright" (0+ space) ?= (0+ space)
        			?\' (submatch (1+ nonl)))))
  (when (string-match "\\([0-9]\\{4\\}\\)" copyright)
    (setq copyright (match-string 1 copyright))
218 219 220
    (set-version-in-file root "etc/refcards/ru-refcard.tex" copyright
			 "\\\\newcommand{\\\\cyear}\\[0\\]\
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
221
    (set-version-in-file root "etc/refcards/emacsver.tex.in" copyright
222
			 "\\\\def\\\\year\
Glenn Morris's avatar
Glenn Morris committed
223 224
{\\([0-9]\\{4\\}\\)}.+%.+copyright year"))
  (message "Setting copyrights...done"))
Glenn Morris's avatar
Glenn Morris committed
225

226 227
;;; Various bits of magic for generating the web manuals

228
(defun manual-misc-manuals (root)
Xue Fuqiao's avatar
Xue Fuqiao committed
229 230
  "Return doc/misc manuals as list of strings.
ROOT should be the root of an Emacs source tree."
231 232
  ;; Similar to `make -C doc/misc echo-info', but works if unconfigured,
  ;; and for INFO_TARGETS rather than INFO_INSTALL.
233 234
  (with-temp-buffer
    (insert-file-contents (expand-file-name "doc/misc/Makefile.in" root))
235 236 237
    ;; Should really use expanded value of INFO_TARGETS.
    (search-forward "INFO_COMMON = ")
    (let ((start (point)))
238 239 240 241
      (end-of-line)
      (while (and (looking-back "\\\\")
		  (zerop (forward-line 1)))
	(end-of-line))
242 243 244 245
      (append (split-string (replace-regexp-in-string
			     "\\(\\\\\\|\\.info\\)" ""
			     (buffer-substring start (point))))
	      '("efaq-w32")))))
246

247
;; TODO report the progress
248 249
(defun make-manuals (root &optional type)
  "Generate the web manuals for the Emacs webpage.
Xue Fuqiao's avatar
Xue Fuqiao committed
250
ROOT should be the root of an Emacs source tree.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
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)))))))
266 267 268
  (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))
269
	 (ps-dir (expand-file-name "ps" dest))
270 271
	 (pdf-dir (expand-file-name "pdf" dest))
	 (emacs (expand-file-name "doc/emacs/emacs.texi" root))
272
	 (emacs-xtra (expand-file-name "doc/emacs/emacs-xtra.texi" root))
273 274 275 276 277
	 (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.
278
    (when (file-directory-p dest)
279
      (if (y-or-n-p (format "Directory %s exists, delete it first? " dest))
280
	  (delete-directory dest t)
281 282 283 284 285
	(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)))
286 287 288 289 290 291 292 293
    (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)))
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    (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)))
310
    ;; Misc manuals
311 312 313
    (dolist (manual misc)
      (if (member type `(nil ,manual "misc"))
	  (manual-misc-html manual root html-node-dir html-mono-dir)))
314 315 316 317 318 319 320 321
    (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\">
322
<link rev=\"made\" href=\"mailto:bug-gnu-emacs@gnu.org\">
323 324 325 326 327
<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\">
328
@import url('/software/emacs/manual.css');\n</style>\n")
329

330
(defun manual-misc-html (name root html-node-dir html-mono-dir)
331
  ;; Hack to deal with the cases where .texi creates a different .info.
332
  ;; Blech.  TODO Why not just rename the .texi (or .info) files?
333 334 335
  (let* ((texiname (cond ((equal name "ccmode") "cc-mode")
			 (t name)))
	 (texi (expand-file-name (format "doc/misc/%s.texi" texiname) root)))
336 337 338 339
    (manual-html-node texi (expand-file-name name html-node-dir))
    (manual-html-mono texi (expand-file-name (concat name ".html")
					     html-mono-dir))))

340 341 342 343 344
(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."
345
  (make-directory (or (file-name-directory dest) ".") t)
346
  (call-process "makeinfo" nil nil nil
347
		"-D" "WWW_GNU_ORG"
348 349 350 351
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
352 353 354 355 356 357 358 359 360 361
		"--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>")
362
    ;; Close the div id="content" that fix-index-1 added.
363 364 365 366 367 368 369 370 371
    (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
372
    (user-error "Manual file %s not found" texi-file))
373
  (make-directory dir t)
374
  (call-process "makeinfo" nil nil nil
375
		"-D" "WWW_GNU_ORG"
376 377 378 379
		"-I" (expand-file-name "../emacs"
				       (file-name-directory texi-file))
		"-I" (expand-file-name "../misc"
				       (file-name-directory texi-file))
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
		"--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.
395 396 397 398 399
		(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)))
400
		(manual-html-fix-index-2)
401 402
		(if copyright-text
		    (insert copyright-text))
403
		;; Close the div id="content" that fix-index-1 added.
404
		(insert "\n</div>\n"))
405
	    ;; For normal nodes, give the header div a blue bg.
406
	    (manual-html-fix-node-div t))
407 408 409
	  (save-buffer))))))

(defun manual-pdf (texi-file dest)
Xue Fuqiao's avatar
Xue Fuqiao committed
410
  "Run texi2pdf on TEXI-FILE, emitting PDF output to DEST."
411
  (make-directory (or (file-name-directory dest) ".") t)
412 413 414 415
  (let ((default-directory (file-name-directory texi-file)))
    (call-process "texi2pdf" nil nil nil
		  "-I" "../emacs" "-I" "../misc"
		  texi-file "-o" dest)))
416

417 418
(defun manual-ps (texi-file dest)
  "Generate a PostScript version of TEXI-FILE as DEST."
419
  (make-directory (or (file-name-directory dest) ".") t)
420 421
  (let ((dvi-dest (concat (file-name-sans-extension dest) ".dvi"))
	(default-directory (file-name-directory texi-file)))
Xue Fuqiao's avatar
Xue Fuqiao committed
422
    ;; FIXME: Use `texi2dvi --ps'?  --xfq
423
    (call-process "texi2dvi" nil nil nil
424
		  "-I" "../emacs" "-I" "../misc"
425 426 427 428
		  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)))
429 430 431

(defun manual-html-fix-headers ()
  "Fix up HTML headers for the Emacs manual in the current buffer."
432 433 434 435 436
  (let ((texi5 (search-forward "<!DOCTYPE" nil t))
	opoint)
    ;; Texinfo 5 supplies a DOCTYPE.
    (or texi5
	(insert manual-doctype-string))
437 438 439 440
    (search-forward "<head>\n")
    (insert manual-meta-string)
    (search-forward "<meta")
    (setq opoint (match-beginning 0))
441 442
    (unless texi5
      (search-forward "<!--")
443 444 445
      (goto-char (match-beginning 0))
      (delete-region opoint (point))
      (search-forward "<meta http-equiv=\"Content-Style")
446
      (setq opoint (match-beginning 0)))
447
    (search-forward "</head>")
448 449
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
450 451 452 453 454 455 456 457
    (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"))))
458

459
;; Texinfo 5 changed these from class = "node" to "header", yay.
460
(defun manual-html-fix-node-div (&optional split)
461
  "Fix up HTML \"node\" divs in the current buffer."
462
  (let (opoint div-end type)
463
    (while (re-search-forward "<div class=\"\\(node\\|header\\)\"\\(>\\)" nil t)
464 465 466 467 468 469
      (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...
470
      (replace-match " style=\"background-color:#DDDDFF\">" t t nil 2)
471
      (setq opoint (point))
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
      (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))))))

492 493

(defun manual-html-fix-index-1 ()
494 495
  "Remove the h1 header, and the short and long contents lists.
Also start a \"content\" div."
496
  (let (opoint)
497
    (re-search-forward "<body.*>\n")
498
    (setq opoint (match-end 0))
499 500 501
    ;; 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=\""))
502 503
    (goto-char (match-beginning 0))
    (delete-region opoint (point))
504
    ;; NB caller must close this div.
505 506 507
    (insert "<div id=\"content\" class=\"inner\">\n\n")))

(defun manual-html-fix-index-2 (&optional table-workaround)
508 509
  "Replace the index list in the current buffer with a HTML table.
Leave point after the table."
510
  (if (re-search-forward "<table class=\"menu\"\\(.*\\)>" nil t)
511
      ;; Texinfo 5 already uses a table.  Tweak it a bit.
512 513
      (let (opoint done)
	(replace-match " style=\"float:left\" width=\"100%\"" nil t nil 1)
514 515 516
	(forward-line 1)
	(while (not done)
	  (cond ((re-search-forward "<tr><td.*&bull; \\(<a.*</a>\\)\
517
:</td><td>&nbsp;&nbsp;</td><td[^>]*>\\(.*\\)" (line-end-position) t)
518 519 520 521 522 523 524 525 526 527 528 529 530 531 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
		 (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)))))
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 590 591 592 593 594 595 596
    (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
597
<h3>Detailed Node Listing</h3>\n\n" t t)
598
	  (search-forward "<p>")
599 600 601 602 603 604
	  ;; 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>"))
605 606 607 608 609 610 611 612 613 614 615 616
	  (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>
617
    <th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
	  (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)))))
633

634 635

(defconst make-manuals-dist-output-variables
636
  `(("@\\(top_\\)?srcdir@" . ".")	; top_srcdir is wrong, but not used
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
    ("^\\(\\(?: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))
675
      (if (or (string-match-p "\\(\\.texi\\'\\|/README\\'\\)" file)
676 677 678 679
	      (and (equal type "lispintro")
		   (string-match-p "\\.\\(eps\\|pdf\\)\\'" file)))
	  (copy-file file stem)))
    (with-temp-buffer
680 681 682 683 684 685 686
      (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))))
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
      (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))))

717

Xue Fuqiao's avatar
Xue Fuqiao committed
718
;; Stuff to check new `defcustom's got :version tags.
719 720 721
;; Adapted from check-declare.el.

(defun cusver-find-files (root &optional old)
Xue Fuqiao's avatar
Xue Fuqiao committed
722 723
  "Find .el files beneath directory ROOT that contain `defcustom's.
If optional OLD is non-nil, also include `defvar's."
724 725 726 727 728 729 730 731 732
  (process-lines find-program root
		 "-name" "*.el"
		 "-exec" grep-program
		 "-l" "-E" (format "^[ \\t]*\\(def%s"
				   (if old "(custom|var)"
				     "custom"
				     ))
		 "{}" "+"))

733 734
(defvar cusver-new-version (format "%s.%s" emacs-major-version
				   (1+ emacs-minor-version))
Xue Fuqiao's avatar
Xue Fuqiao committed
735
  "Version number that new `defcustom's should have.")
736

737 738 739 740 741
(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
742
If optional argument OLD is non-nil, also scan for `defvar's."
743 744
  (let ((m (format "Scanning %s..." file))
	(re (format "^[ \t]*\\((def%s\\)[ \t\n]"
745 746
		    (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
        alist var ver form glist grp)
747 748 749 750
    (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
751
      (while (re-search-forward re nil :noerror)
752 753
        (goto-char (match-beginning 1))
        (if (and (setq form (ignore-errors (read (current-buffer))))
754
		 (setq var (car-safe (cdr-safe form)))
755 756
		 ;; Exclude macros, eg (defcustom ,varname ...).
		 (symbolp var))
757
	    (progn
758 759 760 761
	      ;; FIXME It should be cus-test-apropos that does this.
	      (and (not old)
		   (equal "custom" (match-string 2))
		   (not (memq :type form))
762 763
		   (display-warning
                    'custom (format-message "Missing type in: `%s'" form)))
764 765 766 767 768 769 770 771 772 773 774 775 776
	      (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))))
777
          (if form (format-message "Malformed defcustom: `%s'" form)))))
778 779 780
    (message "%sdone" m)
    alist))

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
(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)))))

796 797 798
(define-button-type 'cusver-xref 'action #'cusver-goto-xref)

(defun cusver-goto-xref (button)
Xue Fuqiao's avatar
Xue Fuqiao committed
799
  "Jump to a Lisp file for the BUTTON at point."
800 801 802 803 804 805 806 807 808 809 810
  (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
811 812 813
;; 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.
814
(defun cusver-check (newdir olddir version)
Xue Fuqiao's avatar
Xue Fuqiao committed
815 816 817 818 819 820 821
  "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.
822 823 824

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."
825 826
  (interactive (list (read-directory-name "New Lisp directory: " nil nil t)
		     (read-directory-name "Old Lisp directory: " nil nil t)
827 828 829
		     (number-to-string
		      (read-number "New version number: "
				   (string-to-number cusver-new-version)))))
830
  (or (file-directory-p (setq newdir (expand-file-name newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
831
      (user-error "Directory `%s' not found" newdir))
832
  (or (file-directory-p (setq olddir (expand-file-name olddir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
833
      (user-error "Directory `%s' not found" olddir))
834
  (setq cusver-new-version version)
Xue Fuqiao's avatar
Xue Fuqiao committed
835
  (let* ((newfiles (progn (message "Finding new files with `defcustom's...")
836
			  (cusver-find-files newdir)))
Xue Fuqiao's avatar
Xue Fuqiao committed
837
	 (oldfiles (progn (message "Finding old files with `defcustom's...")
838
			  (cusver-find-files olddir t)))
Xue Fuqiao's avatar
Xue Fuqiao committed
839
	 (newcus (progn (message "Reading new `defcustom's...")
840 841 842
			(mapcar
			 (lambda (file)
			   (cons file (cusver-scan file))) newfiles)))
843
	 oldcus result thisfile file)
Xue Fuqiao's avatar
Xue Fuqiao committed
844
    (message "Reading old `defcustom's...")
845 846
    (dolist (file oldfiles)
      (setq oldcus (append oldcus (cusver-scan file t))))
847 848
    (setq oldcus (append oldcus (cusver-scan-cus-start
				 (expand-file-name "cus-start.el" olddir))))
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
    ;; 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)
869 870
      (insert (substitute-command-keys
               "These `defcustom's might be missing :version tags:\n\n"))
871 872 873 874 875 876 877 878 879 880 881 882
      (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
883 884
(provide 'admin)

885
;;; admin.el ends here