* dgnushack.el: Autoload sha1 on XEmacs.
[gnus] / lisp / dgnushack.el
1 ;;; dgnushack.el --- a hack to set the load path for byte-compiling
2 ;; Copyright (C) 1994-2011 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; Version: 4.19
6 ;; Keywords: news, path
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (defvar dgnushack-default-load-path (copy-sequence load-path))
30
31 (defalias 'facep 'ignore)
32
33 (require 'cl)
34 (require 'iswitchb)
35
36 (condition-case nil
37     (require 'org-entities)
38   (error nil))
39
40 (defvar srcdir (or (getenv "srcdir") "."))
41 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
42
43 (defun my-getenv (str)
44   (let ((val (getenv str)))
45     (if (equal val "no") nil val)))
46
47 (if (my-getenv "lispdir")
48     (push (my-getenv "lispdir") load-path))
49
50 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
51       load-path)
52
53 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
54       load-path)
55
56 ;(push "/usr/share/emacs/site-lisp" load-path)
57
58 ;; If we are building w3 in a different directory than the source
59 ;; directory, we must read *.el from source directory and write *.elc
60 ;; into the building directory.  For that, we define this function
61 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
62 (defun byte-compile-dest-file (filename)
63   "Convert an Emacs Lisp source file name to a compiled file name.
64  In addition, remove directory name part from FILENAME."
65   (setq filename (byte-compiler-base-file-name filename))
66   (setq filename (file-name-sans-versions filename))
67   (setq filename (file-name-nondirectory filename))
68   (if (eq system-type 'windows-nt)
69       (setq filename (downcase filename)))
70   (cond ((eq system-type 'vax-vms)
71          (concat (substring filename 0 (string-match ";" filename)) "c"))
72         ((string-match emacs-lisp-file-regexp filename)
73          (concat (substring filename 0 (match-beginning 0)) ".elc"))
74         (t (concat filename ".elc"))))
75
76 (require 'bytecomp)
77 ;; To avoid having defsubsts and inlines happen.
78 ;(if (featurep 'xemacs)
79 ;    (require 'byte-optimize)
80 ;  (require 'byte-opt))
81 ;(defun byte-optimize-inline-handler (form)
82 ;  "byte-optimize-handler for the `inline' special-form."
83 ;  (cons 'progn (cdr form)))
84 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
85
86 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
87 ;; following threads:
88 ;;
89 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
90 ;; Subject: attachment problems found but not fixed
91 ;;
92 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
93 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
94 ;;
95 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
96 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
97 ;;
98 ;; Should be fixed in XEmacs (March 2007).
99 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
100 ;; When should we remove this workaround?
101 ;;
102 (when (and (featurep 'xemacs)
103            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
104              (modify-syntax-entry ?= " " table)
105              (with-temp-buffer
106                (with-syntax-table table
107                  (insert "foo=bar")
108                  (goto-char (point-min))
109                  (forward-sexp 1)
110                  (eolp)))))
111   ;; The original `with-syntax-table' uses `copy-syntax-table' which
112   ;; doesn't seem to copy modified syntax entries in old XEmacs 21.5.
113   (defmacro with-syntax-table (syntab &rest body)
114     "Evaluate BODY with the SYNTAB as the current syntax table."
115     `(let ((stab (syntax-table)))
116        (unwind-protect
117            (progn
118              ;;(set-syntax-table (copy-syntax-table ,syntab))
119              (set-syntax-table ,syntab)
120              ,@body)
121          (set-syntax-table stab)))))
122
123 (push srcdir load-path)
124 (push loaddir load-path)
125 (load (expand-file-name "lpath.el" loaddir) nil t)
126
127 (defalias 'device-sound-enabled-p 'ignore)
128 (defalias 'play-sound-file 'ignore)
129 (defalias 'efs-re-read-dir 'ignore)
130 (defalias 'ange-ftp-re-read-dir 'ignore)
131 (defalias 'define-mail-user-agent 'ignore)
132
133 (eval-and-compile
134   (unless (featurep 'xemacs)
135     (defalias 'get-popup-menu-response 'ignore)
136     (defalias 'event-object 'ignore)
137     (autoload 'iswitchb-read-buffer "iswitchb")
138     (autoload 'netrc-credentials "netrc")
139     (defalias 'x-defined-colors 'ignore)
140     (defalias 'read-color 'ignore)))
141
142 (eval-and-compile
143   (when (featurep 'xemacs)
144     (unless (fboundp 'defadvice)
145       (autoload 'defadvice "advice" nil nil 'macro))
146     (unless (boundp 'help-echo-owns-message)
147       (defvar help-echo-owns-message))
148     (unless (fboundp 'url-retrieve-synchronously)
149       (defalias 'url-retrieve-synchronously 'url-retrieve))
150     (unless (fboundp 'url-queue-retrieve)
151       (defun url-queue-retrieve (url callback &optional cbargs silent)
152         (url-retrieve url callback cbargs)))
153     (autoload 'Info-directory "info" nil t)
154     (autoload 'Info-index "info" nil t)
155     (autoload 'Info-index-next "info" nil t)
156     (autoload 'Info-menu "info" nil t)
157     (autoload 'ad-add-advice "advice")
158     (unless (and (emacs-version>= 21 5)
159                  (not (featurep 'sxemacs)))
160       ;; calendar/auto-autoloads.el provides it.
161       (autoload 'add-to-invisibility-spec "dummy"))
162     (autoload 'annotations-at "annotations")
163     (autoload 'apropos "apropos" nil t)
164     (autoload 'apropos-command "apropos" nil t)
165     (autoload 'bbdb-complete-name "bbdb-com" nil t)
166     (autoload 'browse-url "browse-url" nil t)
167     (autoload 'browse-url-of-file "browse-url" nil t)
168     (autoload 'c-mode "cc-mode" nil t)
169     (autoload 'customize-apropos "cus-edit" nil t)
170     (autoload 'customize-group "cus-edit" nil t)
171     (autoload 'customize-save-variable "cus-edit" nil t)
172     (autoload 'customize-set-variable "cus-edit" nil t)
173     (autoload 'customize-variable "cus-edit" nil t)
174     (autoload 'debug "debug" nil t)
175     (autoload 'sha1 "sha1")
176     (if (featurep 'mule)
177         (unless (locate-library "mule-ccl")
178           (autoload 'define-ccl-program "ccl" nil nil 'macro))
179       (defalias 'define-ccl-program 'ignore))
180     (autoload 'delete-annotation "annotations")
181     (autoload 'dolist "cl-macs" nil nil 'macro)
182     (autoload 'enriched-decode "enriched")
183     (autoload 'eudc-expand-inline "eudc" nil t)
184     (autoload 'executable-find "executable")
185     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
186     (when (and (emacs-version>= 21 5)
187                (not (featurep 'sxemacs)))
188       (autoload 'get-display-table "disp-table")
189       (autoload 'put-display-table "disp-table"))
190     (autoload 'info "info" nil t)
191     (autoload 'mail-extract-address-components "mail-extr")
192     (autoload 'mail-fetch-field "mail-utils")
193     (autoload 'make-annotation "annotations")
194     (autoload 'make-display-table "disp-table")
195     (autoload 'pgg-snarf-keys-region "pgg" nil t)
196     (autoload 'pp "pp")
197     (autoload 'ps-despool "ps-print" nil t)
198     (autoload 'ps-spool-buffer "ps-print" nil t)
199     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
200     (autoload 'read-passwd "passwd")
201     (autoload 'regexp-opt "regexp-opt")
202     (autoload 'reporter-submit-bug-report "reporter")
203     (if (condition-case nil
204             (progn
205               (require 'rot13)
206               (not (fboundp 'rot13-string)))
207           (error nil))
208         (defmacro rot13-string (string)
209           "Return ROT13 encryption of STRING."
210           `(let ((string ,string))
211              (with-temp-buffer
212                (insert string)
213                (translate-region (point-min) (point-max) ,rot13-display-table)
214                (buffer-string)))))
215     (if (and (emacs-version>= 21 5)
216              (not (featurep 'sxemacs)))
217         (autoload 'setenv "process" nil t)
218       (autoload 'setenv "env" nil t))
219     (autoload 'sgml-mode "psgml" nil t)
220     (autoload 'smtpmail-send-it "smtpmail")
221     (autoload 'sort-numeric-fields "sort" nil t)
222     (autoload 'sort-subr "sort")
223     (autoload 'thing-at-point "thingatpt")
224     (autoload 'toggle-truncate-lines "view-less" nil t)
225     (autoload 'trace-function-background "trace" nil t)
226     (autoload 'unmorse-region "morse" nil t)
227     (autoload 'w3-do-setup "w3")
228     (autoload 'w3-prepare-buffer "w3-display")
229     (autoload 'w3-region "w3-display" nil t)
230     (defalias 'frame-char-height 'frame-height)
231     (defalias 'frame-char-width 'frame-width)
232     (defalias 'frame-parameter 'frame-property)
233     (defalias 'make-overlay 'ignore)
234     (defalias 'overlay-end 'ignore)
235     (defalias 'overlay-get 'ignore)
236     (defalias 'overlay-put 'ignore)
237     (defalias 'overlay-start 'ignore)
238     (defalias 'overlays-in 'ignore)
239     (defalias 'replace-dehighlight 'ignore)
240     (defalias 'replace-highlight 'ignore)
241     (defalias 'gnutls-available-p 'ignore)
242     (defvar timer-list nil)
243     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
244
245 (defun dgnushack-emacs-compile-defcustom-p ()
246   "Return non-nil if Emacs byte compiles `defcustom' forms.
247 Those Emacsen will warn against undefined variables and functions used
248 in `defcustom' forms."
249   (let ((outbuf (with-temp-buffer
250                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
251                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
252     (when outbuf
253       (prog1
254           (with-current-buffer outbuf
255             (goto-char (point-min))
256             (search-forward " 'foo '(byte-code " nil t))
257         (kill-buffer outbuf)))))
258
259 (when (and (featurep 'xemacs)
260            (dgnushack-emacs-compile-defcustom-p))
261   (maybe-fbind '(defined-colors face-attribute))
262   (maybe-bind '(idna-program installation-directory)))
263
264 (when (featurep 'xemacs)
265   (defadvice byte-optimize-apply (before use-mapcan (form) activate)
266     "Replace (apply 'nconc (mapcar ...)) with (mapcan ...)."
267     (let ((last (nth (1- (length form)) form)))
268       (when (and (eq last (third form))
269                  (consp last)
270                  (eq 'mapcar (car last))
271                  (equal (nth 1 form) ''nconc))
272         (setq form (cons 'mapcan (cdr last)))))))
273
274 (defun dgnushack-compile-verbosely ()
275   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
276 patches to gnus, you should consider modifying make.bat to call
277 dgnushack-compile-verbosely.  All other users should continue to use
278 dgnushack-compile."
279   (dgnushack-compile t))
280
281 (defun dgnushack-compile-error-on-warn ()
282   "Call dgnushack-compile with minimal warnings, but with error-on-warn ENABLED.
283 This means that every warning will be reported as an error."
284   (unless (dgnushack-compile nil t)
285     (error "Error during byte compilation (warnings were reported as errors!).")))
286
287 (defun dgnushack-compile (&optional warn error-on-warn)
288   ;;(setq byte-compile-dynamic t)
289   (unless warn
290     (setq byte-compile-warnings
291           '(free-vars unresolved callargs redefine suspicious)))
292   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
293         (compilesuccess t)
294         ;;(byte-compile-generate-call-tree t)
295         file elc)
296     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
297     ;; installed.
298     (when (featurep 'xemacs)
299       (setq gnus-xmas-glyph-directory "dummy"))
300     (dolist (file '(".dir-locals.el" "dgnushack.el" "lpath.el"))
301       (setq files (delete file files)))
302     (when (featurep 'base64)
303       (setq files (delete "base64.el" files)))
304     (condition-case code
305         (require 'w3-parse)
306       (error
307        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
308        (dolist (file '("webmail.el" "nnwfm.el"))
309          (setq files (delete file files)))))
310     (condition-case code
311         ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
312         ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
313         (require 'mh-e)
314       (error
315        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
316        (setq files (delete "gnus-mh.el" files))))
317     (condition-case code
318         (require 'xml)
319       (error
320        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
321        (setq files (delete "nnrss.el" files))))
322     (dolist (file
323              (if (featurep 'xemacs)
324                  '("md5.el")
325                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
326       (setq files (delete file files)))
327     (unless (and (fboundp 'libxml-parse-html-region)
328                  ;; lpath.el binds it.
329                  (not (eq (symbol-function 'libxml-parse-html-region)
330                           'ignore)))
331       (dolist (file '("color.el" "shr-color.el" "shr.el"))
332         (setq files (delete file files))))
333     (unless (locate-library "epg")
334       (setq files (delete "plstore.el" files)))
335
336     (dolist (file files)
337       (setq file (expand-file-name file srcdir))
338       (when (and (file-exists-p
339                   (setq elc (concat (file-name-nondirectory file) "c")))
340                  (file-newer-than-file-p file elc))
341         (delete-file elc)))
342
343     (while (setq file (pop files))
344       (setq file (expand-file-name file srcdir))
345       (when (or (not (file-exists-p
346                       (setq elc (concat (file-name-nondirectory file) "c"))))
347                 (file-newer-than-file-p file elc))
348         (if error-on-warn
349             (let ((byte-compile-error-on-warn t))
350               (unless (ignore-errors
351                         (byte-compile-file file))
352                 (setq compilesuccess nil)))
353           (ignore-errors
354             (byte-compile-file file)))))
355     compilesuccess))
356
357 (defun dgnushack-recompile ()
358   (require 'gnus)
359   (byte-recompile-directory "." 0))
360
361 (defvar dgnushack-gnus-load-file
362   (if (featurep 'xemacs)
363       (expand-file-name "auto-autoloads.el")
364     (expand-file-name "gnus-load.el")))
365
366 (defvar dgnushack-cus-load-file
367   (if (featurep 'xemacs)
368       (expand-file-name "custom-load.el")
369     (expand-file-name "cus-load.el")))
370
371 (defun dgnushack-make-cus-load ()
372   (load "cus-dep")
373   (let ((cusload-base-file dgnushack-cus-load-file))
374     (defadvice directory-files (after exclude-dir-locals activate)
375       "Exclude .dir-locals.el file."
376       (dolist (file ad-return-value)
377         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
378             (setq ad-return-value (delete file ad-return-value)))))
379     (unwind-protect
380         (if (fboundp 'custom-make-dependencies)
381             (custom-make-dependencies)
382           (Custom-make-dependencies))
383       (ad-unadvise 'directory-files))
384     (when (featurep 'xemacs)
385       (message "Compiling %s..." dgnushack-cus-load-file)
386       (byte-compile-file dgnushack-cus-load-file))))
387
388 (defun dgnushack-make-auto-load ()
389   (require 'autoload)
390   (let ((generated-autoload-file dgnushack-gnus-load-file)
391         (make-backup-files nil)
392         (autoload-package-name "gnus"))
393     (if (featurep 'xemacs)
394         (if (file-exists-p generated-autoload-file)
395             (delete-file generated-autoload-file))
396       (with-temp-file generated-autoload-file
397         (insert ?\014)))
398     (defadvice directory-files (after exclude-dir-locals activate)
399       "Exclude .dir-locals.el file."
400       (dolist (file ad-return-value)
401         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
402             (setq ad-return-value (delete file ad-return-value)))))
403     (unwind-protect
404         (batch-update-autoloads)
405       (ad-unadvise 'directory-files))))
406
407 (defun dgnushack-make-load ()
408   (unless (featurep 'xemacs)
409     (message "Generating %s..." dgnushack-gnus-load-file)
410     (with-temp-file dgnushack-gnus-load-file
411       (insert-file-contents dgnushack-cus-load-file)
412       (delete-file dgnushack-cus-load-file)
413       (goto-char (point-min))
414       (search-forward ";;; Code:")
415       (forward-line)
416       (delete-region (point-min) (point))
417       (insert "\
418 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
419 ;;
420 ;;; Code:
421 ")
422       (goto-char (point-max))
423       (if (search-backward "custom-versions-load-alist" nil t)
424           (forward-line -1)
425         (forward-line -1)
426         (while (eq (char-after) ?\;)
427           (forward-line -1))
428         (forward-line))
429       (delete-region (point) (point-max))
430       (insert "\n")
431       ;; smiley-* are duplicated. Remove them all.
432       (let ((point (point)))
433         (insert-file-contents dgnushack-gnus-load-file)
434         (goto-char point)
435         (while (search-forward "smiley-" nil t)
436           (beginning-of-line)
437           (if (looking-at "(autoload ")
438               (delete-region (point) (progn (forward-sexp) (point)))
439             (forward-line))))
440       ;;
441       (goto-char (point-max))
442       (when (search-backward "\n(provide " nil t)
443         (forward-line -1)
444         (delete-region (point) (point-max)))
445       (insert "\
446
447 \(provide 'gnus-load)
448
449 ;;; Local Variables:
450 ;;; version-control: never
451 ;;; no-byte-compile: t
452 ;;; no-update-autoloads: t
453 ;;; End:
454 ;;; gnus-load.el ends here
455 ")
456       ))
457   (message "Compiling %s..." dgnushack-gnus-load-file)
458   (byte-compile-file dgnushack-gnus-load-file)
459   (when (featurep 'xemacs)
460     (message "Creating dummy gnus-load.el...")
461     (with-temp-file (expand-file-name "gnus-load.el")
462       (insert "\
463
464 \(provide 'gnus-load)
465
466 ;;; Local Variables:
467 ;;; version-control: never
468 ;;; no-byte-compile: t
469 ;;; no-update-autoloads: t
470 ;;; End:
471 ;;; gnus-load.el ends here"))))
472
473 (defun dgnushack-find-lisp-shadows (&optional lispdir)
474   "Return a list of directories in which other Gnus installations exist.
475 This function looks for the other Gnus installations which will shadow
476 the new Gnus Lisp modules which have been installed in LISPDIR, using
477 the default `load-path'.  The return value will make sense only when
478 LISPDIR is existent and is listed in the default `load-path'.  Assume
479 LISPDIR will be prepended to `load-path' by a user if the default
480 `load-path' does not contain it."
481   (unless lispdir
482     (setq lispdir (getenv "lispdir")))
483   (when (and lispdir (file-directory-p lispdir))
484     (setq lispdir (file-truename (directory-file-name lispdir)))
485     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
486                      "message.elc" "message.el" "message.el.bz2"
487                      "message.el.gz"))
488           (path (delq nil (mapcar
489                            (lambda (p)
490                              (condition-case nil
491                                  (when (and p (file-directory-p p))
492                                    (file-truename (directory-file-name p)))
493                                (error nil)))
494                            dgnushack-default-load-path)))
495           rest elcs)
496       (while path
497         (setq rest (cons (car path) rest)
498               path (delete (car rest) (cdr path))))
499       (setq path (nreverse (cdr (member lispdir rest)))
500             rest nil)
501       (while path
502         (setq elcs indices)
503         (while elcs
504           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
505             (setq rest (cons (car path) rest)
506                   elcs nil)))
507         (setq path (cdr path)))
508       (prog1
509           (setq path (nreverse rest))
510         (when path
511           (let (print-level print-length)
512             (princ (concat "\n\
513 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
514  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
515 You will need to modify the run-time `load-path', remove them manually,
516 or remove them using `make remove-installed-shadows'.\n\n"))))))))
517
518 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
519   "Remove the other Gnus installations which shadow the recent one."
520   (let ((path (with-temp-buffer
521                 (let ((standard-output (current-buffer)))
522                   (dgnushack-find-lisp-shadows lispdir))))
523         elcs files shadows file)
524     (when path
525       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
526         (error "You should build .elc files first."))
527       (setq files
528             (apply
529              'append
530              (mapcar
531               (lambda (el)
532                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
533               (append
534                (list (file-name-nondirectory dgnushack-gnus-load-file)
535                      (file-name-nondirectory dgnushack-cus-load-file))
536                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
537       (while path
538         (setq shadows files)
539         (while shadows
540           (setq file (expand-file-name (pop shadows) (car path)))
541           (when (file-exists-p file)
542             (princ (concat "  Removing " file "..."))
543             (condition-case nil
544                 (progn
545                   (delete-file file)
546                   (princ "done\n"))
547               (error (princ "failed\n")))))
548         (setq path (cdr path))))))
549
550 ;;; dgnushack.el ends here