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