1 ;;; dgnushack.el --- a hack to set the load path for byte-compiling
2 ;; Copyright (C) 1994-2011 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, path
8 ;; This file is part of GNU Emacs.
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)
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.
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.
29 (defvar dgnushack-default-load-path (copy-sequence load-path))
31 (defalias 'facep 'ignore)
37 (require 'org-entities)
40 (defvar srcdir (or (getenv "srcdir") "."))
41 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
43 (defun my-getenv (str)
44 (let ((val (getenv str)))
45 (if (equal val "no") nil val)))
47 (if (my-getenv "lispdir")
48 (push (my-getenv "lispdir") load-path))
50 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
53 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
56 ;(push "/usr/share/emacs/site-lisp" load-path)
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"))))
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)
86 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
89 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
90 ;; Subject: attachment problems found but not fixed
92 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
93 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
95 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
96 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
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?
102 (when (and (featurep 'xemacs)
103 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
104 (modify-syntax-entry ?= " " table)
106 (with-syntax-table table
108 (goto-char (point-min))
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)))
118 ;;(set-syntax-table (copy-syntax-table ,syntab))
119 (set-syntax-table ,syntab)
121 (set-syntax-table stab)))))
123 (push srcdir load-path)
124 (push loaddir load-path)
125 (load (expand-file-name "lpath.el" loaddir) nil t)
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)
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)))
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)
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)
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
205 (not (fboundp 'rot13-string)))
207 (defmacro rot13-string (string)
208 "Return ROT13 encryption of STRING."
209 `(let ((string ,string))
212 (translate-region (point-min) (point-max) ,rot13-display-table)
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)))
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"))))
253 (with-current-buffer outbuf
254 (goto-char (point-min))
255 (search-forward " 'foo '(byte-code " nil t))
256 (kill-buffer outbuf)))))
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)))
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))
269 (eq 'mapcar (car last))
270 (equal (nth 1 form) ''nconc))
271 (setq form (cons 'mapcan (cdr last)))))))
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
278 (dgnushack-compile t))
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!).")))
286 (defun dgnushack-compile (&optional warn error-on-warn)
287 ;;(setq byte-compile-dynamic t)
289 (setq byte-compile-warnings
290 '(free-vars unresolved callargs redefine suspicious)))
291 (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
293 ;;(byte-compile-generate-call-tree t)
295 ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
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)))
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)))))
310 ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
311 ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
314 (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
315 (setq files (delete "gnus-mh.el" files))))
319 (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
320 (setq files (delete "nnrss.el" files))))
322 (if (featurep 'xemacs)
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)
330 (dolist (file '("color.el" "shr-color.el" "shr.el"))
331 (setq files (delete file files))))
334 (setq file (expand-file-name file srcdir))
335 (when (and (file-exists-p
336 (setq elc (concat (file-name-nondirectory file) "c")))
337 (file-newer-than-file-p file elc))
340 (while (setq file (pop files))
341 (setq file (expand-file-name file srcdir))
342 (when (or (not (file-exists-p
343 (setq elc (concat (file-name-nondirectory file) "c"))))
344 (file-newer-than-file-p file elc))
346 (let ((byte-compile-error-on-warn t))
347 (unless (ignore-errors
348 (byte-compile-file file))
349 (setq compilesuccess nil)))
351 (byte-compile-file file)))))
354 (defun dgnushack-recompile ()
356 (byte-recompile-directory "." 0))
358 (defvar dgnushack-gnus-load-file
359 (if (featurep 'xemacs)
360 (expand-file-name "auto-autoloads.el")
361 (expand-file-name "gnus-load.el")))
363 (defvar dgnushack-cus-load-file
364 (if (featurep 'xemacs)
365 (expand-file-name "custom-load.el")
366 (expand-file-name "cus-load.el")))
368 (defun dgnushack-make-cus-load ()
370 (let ((cusload-base-file dgnushack-cus-load-file))
371 (defadvice directory-files (after exclude-dir-locals activate)
372 "Exclude .dir-locals.el file."
373 (dolist (file ad-return-value)
374 (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
375 (setq ad-return-value (delete file ad-return-value)))))
377 (if (fboundp 'custom-make-dependencies)
378 (custom-make-dependencies)
379 (Custom-make-dependencies))
380 (ad-unadvise 'directory-files))
381 (when (featurep 'xemacs)
382 (message "Compiling %s..." dgnushack-cus-load-file)
383 (byte-compile-file dgnushack-cus-load-file))))
385 (defun dgnushack-make-auto-load ()
387 (let ((generated-autoload-file dgnushack-gnus-load-file)
388 (make-backup-files nil)
389 (autoload-package-name "gnus"))
390 (if (featurep 'xemacs)
391 (if (file-exists-p generated-autoload-file)
392 (delete-file generated-autoload-file))
393 (with-temp-file generated-autoload-file
395 (defadvice directory-files (after exclude-dir-locals activate)
396 "Exclude .dir-locals.el file."
397 (dolist (file ad-return-value)
398 (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
399 (setq ad-return-value (delete file ad-return-value)))))
401 (batch-update-autoloads)
402 (ad-unadvise 'directory-files))))
404 (defun dgnushack-make-load ()
405 (unless (featurep 'xemacs)
406 (message "Generating %s..." dgnushack-gnus-load-file)
407 (with-temp-file dgnushack-gnus-load-file
408 (insert-file-contents dgnushack-cus-load-file)
409 (delete-file dgnushack-cus-load-file)
410 (goto-char (point-min))
411 (search-forward ";;; Code:")
413 (delete-region (point-min) (point))
415 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
419 (goto-char (point-max))
420 (if (search-backward "custom-versions-load-alist" nil t)
423 (while (eq (char-after) ?\;)
426 (delete-region (point) (point-max))
428 ;; smiley-* are duplicated. Remove them all.
429 (let ((point (point)))
430 (insert-file-contents dgnushack-gnus-load-file)
432 (while (search-forward "smiley-" nil t)
434 (if (looking-at "(autoload ")
435 (delete-region (point) (progn (forward-sexp) (point)))
438 (goto-char (point-max))
439 (when (search-backward "\n(provide " nil t)
441 (delete-region (point) (point-max)))
444 \(provide 'gnus-load)
447 ;;; version-control: never
448 ;;; no-byte-compile: t
449 ;;; no-update-autoloads: t
451 ;;; gnus-load.el ends here
454 (message "Compiling %s..." dgnushack-gnus-load-file)
455 (byte-compile-file dgnushack-gnus-load-file)
456 (when (featurep 'xemacs)
457 (message "Creating dummy gnus-load.el...")
458 (with-temp-file (expand-file-name "gnus-load.el")
461 \(provide 'gnus-load)
464 ;;; version-control: never
465 ;;; no-byte-compile: t
466 ;;; no-update-autoloads: t
468 ;;; gnus-load.el ends here"))))
470 (defun dgnushack-find-lisp-shadows (&optional lispdir)
471 "Return a list of directories in which other Gnus installations exist.
472 This function looks for the other Gnus installations which will shadow
473 the new Gnus Lisp modules which have been installed in LISPDIR, using
474 the default `load-path'. The return value will make sense only when
475 LISPDIR is existent and is listed in the default `load-path'. Assume
476 LISPDIR will be prepended to `load-path' by a user if the default
477 `load-path' does not contain it."
479 (setq lispdir (getenv "lispdir")))
480 (when (and lispdir (file-directory-p lispdir))
481 (setq lispdir (file-truename (directory-file-name lispdir)))
482 (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
483 "message.elc" "message.el" "message.el.bz2"
485 (path (delq nil (mapcar
488 (when (and p (file-directory-p p))
489 (file-truename (directory-file-name p)))
491 dgnushack-default-load-path)))
494 (setq rest (cons (car path) rest)
495 path (delete (car rest) (cdr path))))
496 (setq path (nreverse (cdr (member lispdir rest)))
501 (when (file-exists-p (expand-file-name (pop elcs) (car path)))
502 (setq rest (cons (car path) rest)
504 (setq path (cdr path)))
506 (setq path (nreverse rest))
508 (let (print-level print-length)
510 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
511 been detected in:\n\n " (mapconcat 'identity path "\n ") "\n\n\
512 You will need to modify the run-time `load-path', remove them manually,
513 or remove them using `make remove-installed-shadows'.\n\n"))))))))
515 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
516 "Remove the other Gnus installations which shadow the recent one."
517 (let ((path (with-temp-buffer
518 (let ((standard-output (current-buffer)))
519 (dgnushack-find-lisp-shadows lispdir))))
520 elcs files shadows file)
522 (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
523 (error "You should build .elc files first."))
529 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
531 (list (file-name-nondirectory dgnushack-gnus-load-file)
532 (file-name-nondirectory dgnushack-cus-load-file))
533 (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
537 (setq file (expand-file-name (pop shadows) (car path)))
538 (when (file-exists-p file)
539 (princ (concat " Removing " file "..."))
544 (error (princ "failed\n")))))
545 (setq path (cdr path))))))
547 ;;; dgnushack.el ends here