dgnushack.el (dgnushack-compile): Don't compile plstore.el unless epg is available.
[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     (if (featurep 'mule)
176         (unless (locate-library "mule-ccl")
177           (autoload 'define-ccl-program "ccl" nil nil 'macro))
178       (defalias 'define-ccl-program 'ignore))
179     (autoload 'delete-annotation "annotations")
180     (autoload 'dolist "cl-macs" nil nil 'macro)
181     (autoload 'enriched-decode "enriched")
182     (autoload 'eudc-expand-inline "eudc" nil t)
183     (autoload 'executable-find "executable")
184     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
185     (when (and (emacs-version>= 21 5)
186                (not (featurep 'sxemacs)))
187       (autoload 'get-display-table "disp-table")
188       (autoload 'put-display-table "disp-table"))
189     (autoload 'info "info" nil t)
190     (autoload 'mail-extract-address-components "mail-extr")
191     (autoload 'mail-fetch-field "mail-utils")
192     (autoload 'make-annotation "annotations")
193     (autoload 'make-display-table "disp-table")
194     (autoload 'pgg-snarf-keys-region "pgg" nil t)
195     (autoload 'pp "pp")
196     (autoload 'ps-despool "ps-print" nil t)
197     (autoload 'ps-spool-buffer "ps-print" nil t)
198     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
199     (autoload 'read-passwd "passwd")
200     (autoload 'regexp-opt "regexp-opt")
201     (autoload 'reporter-submit-bug-report "reporter")
202     (if (condition-case nil
203             (progn
204               (require 'rot13)
205               (not (fboundp 'rot13-string)))
206           (error nil))
207         (defmacro rot13-string (string)
208           "Return ROT13 encryption of STRING."
209           `(let ((string ,string))
210              (with-temp-buffer
211                (insert string)
212                (translate-region (point-min) (point-max) ,rot13-display-table)
213                (buffer-string)))))
214     (if (and (emacs-version>= 21 5)
215              (not (featurep 'sxemacs)))
216         (autoload 'setenv "process" nil t)
217       (autoload 'setenv "env" nil t))
218     (autoload 'sgml-mode "psgml" nil t)
219     (autoload 'smtpmail-send-it "smtpmail")
220     (autoload 'sort-numeric-fields "sort" nil t)
221     (autoload 'sort-subr "sort")
222     (autoload 'thing-at-point "thingatpt")
223     (autoload 'toggle-truncate-lines "view-less" nil t)
224     (autoload 'trace-function-background "trace" nil t)
225     (autoload 'unmorse-region "morse" nil t)
226     (autoload 'w3-do-setup "w3")
227     (autoload 'w3-prepare-buffer "w3-display")
228     (autoload 'w3-region "w3-display" nil t)
229     (defalias 'frame-char-height 'frame-height)
230     (defalias 'frame-char-width 'frame-width)
231     (defalias 'frame-parameter 'frame-property)
232     (defalias 'make-overlay 'ignore)
233     (defalias 'overlay-end 'ignore)
234     (defalias 'overlay-get 'ignore)
235     (defalias 'overlay-put 'ignore)
236     (defalias 'overlay-start 'ignore)
237     (defalias 'overlays-in 'ignore)
238     (defalias 'replace-dehighlight 'ignore)
239     (defalias 'replace-highlight 'ignore)
240     (defalias 'gnutls-available-p 'ignore)
241     (defvar timer-list nil)
242     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
243
244 (defun dgnushack-emacs-compile-defcustom-p ()
245   "Return non-nil if Emacs byte compiles `defcustom' forms.
246 Those Emacsen will warn against undefined variables and functions used
247 in `defcustom' forms."
248   (let ((outbuf (with-temp-buffer
249                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
250                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
251     (when outbuf
252       (prog1
253           (with-current-buffer outbuf
254             (goto-char (point-min))
255             (search-forward " 'foo '(byte-code " nil t))
256         (kill-buffer outbuf)))))
257
258 (when (and (featurep 'xemacs)
259            (dgnushack-emacs-compile-defcustom-p))
260   (maybe-fbind '(defined-colors face-attribute))
261   (maybe-bind '(idna-program installation-directory)))
262
263 (when (featurep 'xemacs)
264   (defadvice byte-optimize-apply (before use-mapcan (form) activate)
265     "Replace (apply 'nconc (mapcar ...)) with (mapcan ...)."
266     (let ((last (nth (1- (length form)) form)))
267       (when (and (eq last (third form))
268                  (consp last)
269                  (eq 'mapcar (car last))
270                  (equal (nth 1 form) ''nconc))
271         (setq form (cons 'mapcan (cdr last)))))))
272
273 (defun dgnushack-compile-verbosely ()
274   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
275 patches to gnus, you should consider modifying make.bat to call
276 dgnushack-compile-verbosely.  All other users should continue to use
277 dgnushack-compile."
278   (dgnushack-compile t))
279
280 (defun dgnushack-compile-error-on-warn ()
281   "Call dgnushack-compile with minimal warnings, but with error-on-warn ENABLED.
282 This means that every warning will be reported as an error."
283   (unless (dgnushack-compile nil t)
284     (error "Error during byte compilation (warnings were reported as errors!).")))
285
286 (defun dgnushack-compile (&optional warn error-on-warn)
287   ;;(setq byte-compile-dynamic t)
288   (unless warn
289     (setq byte-compile-warnings
290           '(free-vars unresolved callargs redefine suspicious)))
291   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
292         (compilesuccess t)
293         ;;(byte-compile-generate-call-tree t)
294         file elc)
295     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
296     ;; installed.
297     (when (featurep 'xemacs)
298       (setq gnus-xmas-glyph-directory "dummy"))
299     (dolist (file '(".dir-locals.el" "dgnushack.el" "lpath.el"))
300       (setq files (delete file files)))
301     (when (featurep 'base64)
302       (setq files (delete "base64.el" files)))
303     (condition-case code
304         (require 'w3-parse)
305       (error
306        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
307        (dolist (file '("webmail.el" "nnwfm.el"))
308          (setq files (delete file files)))))
309     (condition-case code
310         ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
311         ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
312         (require 'mh-e)
313       (error
314        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
315        (setq files (delete "gnus-mh.el" files))))
316     (condition-case code
317         (require 'xml)
318       (error
319        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
320        (setq files (delete "nnrss.el" files))))
321     (dolist (file
322              (if (featurep 'xemacs)
323                  '("md5.el")
324                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
325       (setq files (delete file files)))
326     (unless (and (fboundp 'libxml-parse-html-region)
327                  ;; lpath.el binds it.
328                  (not (eq (symbol-function 'libxml-parse-html-region)
329                           'ignore)))
330       (dolist (file '("color.el" "shr-color.el" "shr.el"))
331         (setq files (delete file files))))
332     (unless (locate-library "epg")
333       (setq files (delete "plstore.el" files)))
334
335     (dolist (file files)
336       (setq file (expand-file-name file srcdir))
337       (when (and (file-exists-p
338                   (setq elc (concat (file-name-nondirectory file) "c")))
339                  (file-newer-than-file-p file elc))
340         (delete-file elc)))
341
342     (while (setq file (pop files))
343       (setq file (expand-file-name file srcdir))
344       (when (or (not (file-exists-p
345                       (setq elc (concat (file-name-nondirectory file) "c"))))
346                 (file-newer-than-file-p file elc))
347         (if error-on-warn
348             (let ((byte-compile-error-on-warn t))
349               (unless (ignore-errors
350                         (byte-compile-file file))
351                 (setq compilesuccess nil)))
352           (ignore-errors
353             (byte-compile-file file)))))
354     compilesuccess))
355
356 (defun dgnushack-recompile ()
357   (require 'gnus)
358   (byte-recompile-directory "." 0))
359
360 (defvar dgnushack-gnus-load-file
361   (if (featurep 'xemacs)
362       (expand-file-name "auto-autoloads.el")
363     (expand-file-name "gnus-load.el")))
364
365 (defvar dgnushack-cus-load-file
366   (if (featurep 'xemacs)
367       (expand-file-name "custom-load.el")
368     (expand-file-name "cus-load.el")))
369
370 (defun dgnushack-make-cus-load ()
371   (load "cus-dep")
372   (let ((cusload-base-file dgnushack-cus-load-file))
373     (defadvice directory-files (after exclude-dir-locals activate)
374       "Exclude .dir-locals.el file."
375       (dolist (file ad-return-value)
376         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
377             (setq ad-return-value (delete file ad-return-value)))))
378     (unwind-protect
379         (if (fboundp 'custom-make-dependencies)
380             (custom-make-dependencies)
381           (Custom-make-dependencies))
382       (ad-unadvise 'directory-files))
383     (when (featurep 'xemacs)
384       (message "Compiling %s..." dgnushack-cus-load-file)
385       (byte-compile-file dgnushack-cus-load-file))))
386
387 (defun dgnushack-make-auto-load ()
388   (require 'autoload)
389   (let ((generated-autoload-file dgnushack-gnus-load-file)
390         (make-backup-files nil)
391         (autoload-package-name "gnus"))
392     (if (featurep 'xemacs)
393         (if (file-exists-p generated-autoload-file)
394             (delete-file generated-autoload-file))
395       (with-temp-file generated-autoload-file
396         (insert ?\014)))
397     (defadvice directory-files (after exclude-dir-locals activate)
398       "Exclude .dir-locals.el file."
399       (dolist (file ad-return-value)
400         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
401             (setq ad-return-value (delete file ad-return-value)))))
402     (unwind-protect
403         (batch-update-autoloads)
404       (ad-unadvise 'directory-files))))
405
406 (defun dgnushack-make-load ()
407   (unless (featurep 'xemacs)
408     (message "Generating %s..." dgnushack-gnus-load-file)
409     (with-temp-file dgnushack-gnus-load-file
410       (insert-file-contents dgnushack-cus-load-file)
411       (delete-file dgnushack-cus-load-file)
412       (goto-char (point-min))
413       (search-forward ";;; Code:")
414       (forward-line)
415       (delete-region (point-min) (point))
416       (insert "\
417 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
418 ;;
419 ;;; Code:
420 ")
421       (goto-char (point-max))
422       (if (search-backward "custom-versions-load-alist" nil t)
423           (forward-line -1)
424         (forward-line -1)
425         (while (eq (char-after) ?\;)
426           (forward-line -1))
427         (forward-line))
428       (delete-region (point) (point-max))
429       (insert "\n")
430       ;; smiley-* are duplicated. Remove them all.
431       (let ((point (point)))
432         (insert-file-contents dgnushack-gnus-load-file)
433         (goto-char point)
434         (while (search-forward "smiley-" nil t)
435           (beginning-of-line)
436           (if (looking-at "(autoload ")
437               (delete-region (point) (progn (forward-sexp) (point)))
438             (forward-line))))
439       ;;
440       (goto-char (point-max))
441       (when (search-backward "\n(provide " nil t)
442         (forward-line -1)
443         (delete-region (point) (point-max)))
444       (insert "\
445
446 \(provide 'gnus-load)
447
448 ;;; Local Variables:
449 ;;; version-control: never
450 ;;; no-byte-compile: t
451 ;;; no-update-autoloads: t
452 ;;; End:
453 ;;; gnus-load.el ends here
454 ")
455       ))
456   (message "Compiling %s..." dgnushack-gnus-load-file)
457   (byte-compile-file dgnushack-gnus-load-file)
458   (when (featurep 'xemacs)
459     (message "Creating dummy gnus-load.el...")
460     (with-temp-file (expand-file-name "gnus-load.el")
461       (insert "\
462
463 \(provide 'gnus-load)
464
465 ;;; Local Variables:
466 ;;; version-control: never
467 ;;; no-byte-compile: t
468 ;;; no-update-autoloads: t
469 ;;; End:
470 ;;; gnus-load.el ends here"))))
471
472 (defun dgnushack-find-lisp-shadows (&optional lispdir)
473   "Return a list of directories in which other Gnus installations exist.
474 This function looks for the other Gnus installations which will shadow
475 the new Gnus Lisp modules which have been installed in LISPDIR, using
476 the default `load-path'.  The return value will make sense only when
477 LISPDIR is existent and is listed in the default `load-path'.  Assume
478 LISPDIR will be prepended to `load-path' by a user if the default
479 `load-path' does not contain it."
480   (unless lispdir
481     (setq lispdir (getenv "lispdir")))
482   (when (and lispdir (file-directory-p lispdir))
483     (setq lispdir (file-truename (directory-file-name lispdir)))
484     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
485                      "message.elc" "message.el" "message.el.bz2"
486                      "message.el.gz"))
487           (path (delq nil (mapcar
488                            (lambda (p)
489                              (condition-case nil
490                                  (when (and p (file-directory-p p))
491                                    (file-truename (directory-file-name p)))
492                                (error nil)))
493                            dgnushack-default-load-path)))
494           rest elcs)
495       (while path
496         (setq rest (cons (car path) rest)
497               path (delete (car rest) (cdr path))))
498       (setq path (nreverse (cdr (member lispdir rest)))
499             rest nil)
500       (while path
501         (setq elcs indices)
502         (while elcs
503           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
504             (setq rest (cons (car path) rest)
505                   elcs nil)))
506         (setq path (cdr path)))
507       (prog1
508           (setq path (nreverse rest))
509         (when path
510           (let (print-level print-length)
511             (princ (concat "\n\
512 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
513  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
514 You will need to modify the run-time `load-path', remove them manually,
515 or remove them using `make remove-installed-shadows'.\n\n"))))))))
516
517 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
518   "Remove the other Gnus installations which shadow the recent one."
519   (let ((path (with-temp-buffer
520                 (let ((standard-output (current-buffer)))
521                   (dgnushack-find-lisp-shadows lispdir))))
522         elcs files shadows file)
523     (when path
524       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
525         (error "You should build .elc files first."))
526       (setq files
527             (apply
528              'append
529              (mapcar
530               (lambda (el)
531                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
532               (append
533                (list (file-name-nondirectory dgnushack-gnus-load-file)
534                      (file-name-nondirectory dgnushack-cus-load-file))
535                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
536       (while path
537         (setq shadows files)
538         (while shadows
539           (setq file (expand-file-name (pop shadows) (car path)))
540           (when (file-exists-p file)
541             (princ (concat "  Removing " file "..."))
542             (condition-case nil
543                 (progn
544                   (delete-file file)
545                   (princ "done\n"))
546               (error (princ "failed\n")))))
547         (setq path (cdr path))))))
548
549 ;;; dgnushack.el ends here