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