1 ;;; dgnushack.el --- a hack to set the load path for byte-compiling
2 ;; Copyright (C) 1994-2015 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. If not, see <http://www.gnu.org/licenses/>.
27 (defvar dgnushack-default-load-path (copy-sequence load-path))
29 (unless (fboundp 'declare-function)
30 (defmacro declare-function (&rest r)))
32 (defalias 'facep 'ignore)
38 (require 'org-entities)
41 (defvar srcdir (or (getenv "srcdir") "."))
42 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
44 (defun my-getenv (str)
45 (let ((val (getenv str)))
46 (if (equal val "no") nil val)))
48 (if (my-getenv "lispdir")
49 (push (my-getenv "lispdir") load-path))
51 ;(push "/usr/share/emacs/site-lisp" load-path)
53 ;; If we are building Gnus in a different directory than the source
54 ;; directory, we must read *.el from source directory and write *.elc
55 ;; into the building directory. For that, we define this function
56 ;; before loading bytecomp. Bytecomp doesn't overwrite this function.
57 (defun byte-compile-dest-file (filename)
58 "Convert an Emacs Lisp source file name to a compiled file name.
59 In addition, remove directory name part from FILENAME."
60 (setq filename (byte-compiler-base-file-name filename))
61 (setq filename (file-name-sans-versions filename))
62 (setq filename (file-name-nondirectory filename))
63 (if (eq system-type 'windows-nt)
64 (setq filename (downcase filename)))
65 (cond ((eq system-type 'vax-vms)
66 (concat (substring filename 0 (string-match ";" filename)) "c"))
67 ((string-match emacs-lisp-file-regexp filename)
68 (concat (substring filename 0 (match-beginning 0)) ".elc"))
69 (t (concat filename ".elc"))))
72 ;; To avoid having defsubsts and inlines happen.
73 ;(if (featurep 'xemacs)
74 ; (require 'byte-optimize)
75 ; (require 'byte-opt))
76 ;(defun byte-optimize-inline-handler (form)
77 ; "byte-optimize-handler for the `inline' special-form."
78 ; (cons 'progn (cdr form)))
79 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
81 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
84 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
85 ;; Subject: attachment problems found but not fixed
87 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
88 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
90 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
91 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
93 ;; Should be fixed in XEmacs (March 2007).
94 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
95 ;; When should we remove this workaround?
97 (when (and (featurep 'xemacs)
98 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
99 (modify-syntax-entry ?= " " table)
101 (with-syntax-table table
103 (goto-char (point-min))
106 ;; The original `with-syntax-table' uses `copy-syntax-table' which
107 ;; doesn't seem to copy modified syntax entries in old XEmacs 21.5.
108 (defmacro with-syntax-table (syntab &rest body)
109 "Evaluate BODY with the SYNTAB as the current syntax table."
110 `(let ((stab (syntax-table)))
113 ;;(set-syntax-table (copy-syntax-table ,syntab))
114 (set-syntax-table ,syntab)
116 (set-syntax-table stab)))))
118 (push srcdir load-path)
119 (push loaddir load-path)
120 (load (expand-file-name "lpath.el" loaddir) nil t)
122 (defalias 'device-sound-enabled-p 'ignore)
123 (defalias 'play-sound-file 'ignore)
124 (defalias 'efs-re-read-dir 'ignore)
125 (defalias 'ange-ftp-re-read-dir 'ignore)
126 (defalias 'define-mail-user-agent 'ignore)
127 (defalias 'debbugs-gnu-summary-mode 'ignore)
128 (defvar debbugs-gnu-bug-number nil)
131 (unless (featurep 'xemacs)
132 (defalias 'get-popup-menu-response 'ignore)
133 (defalias 'event-object 'ignore)
134 (autoload 'iswitchb-read-buffer "iswitchb")
135 (autoload 'netrc-credentials "netrc")
136 (defalias 'x-defined-colors 'ignore)
137 (defalias 'read-color 'ignore)))
140 (when (featurep 'xemacs)
141 (defvar window-point-insertion-type nil)
142 (unless (fboundp 'defadvice)
143 (autoload 'defadvice "advice" nil nil 'macro))
144 (unless (boundp 'help-echo-owns-message)
145 (defvar help-echo-owns-message))
146 (unless (boundp 'gnus-registry-enabled)
147 (defvar gnus-registry-enabled nil))
148 (unless (boundp 'mail-dont-reply-to-names)
149 (defvar mail-dont-reply-to-names nil))
150 (unless (fboundp 'url-retrieve-synchronously)
151 (defalias 'url-retrieve-synchronously 'url-retrieve))
152 (unless (fboundp 'url-queue-retrieve)
153 (defun url-queue-retrieve (url callback &optional cbargs silent
155 (url-retrieve url callback cbargs)))
156 (unless (boundp 'w3-configuration-directory)
157 (setq w3-configuration-directory "~/.w3/"))
158 (autoload 'Info-directory "info" nil t)
159 (autoload 'Info-index "info" nil t)
160 (autoload 'Info-index-next "info" nil t)
161 (autoload 'Info-menu "info" nil t)
162 (autoload 'ad-add-advice "advice")
163 (unless (and (emacs-version>= 21 5)
164 (not (featurep 'sxemacs)))
165 ;; calendar/auto-autoloads.el provides it.
166 (autoload 'add-to-invisibility-spec "dummy"))
167 (autoload 'annotations-at "annotations")
168 (autoload 'apropos "apropos" nil t)
169 (autoload 'apropos-command "apropos" nil t)
170 (autoload 'bbdb-complete-name "bbdb-com" nil t)
171 (autoload 'browse-url "browse-url" nil t)
172 (autoload 'browse-url-of-file "browse-url" nil t)
173 (autoload 'c-mode "cc-mode" nil t)
174 (autoload 'customize-apropos "cus-edit" nil t)
175 (autoload 'customize-group "cus-edit" nil t)
176 (autoload 'customize-save-variable "cus-edit" nil t)
177 (autoload 'customize-set-variable "cus-edit" nil t)
178 (autoload 'customize-variable "cus-edit" nil t)
179 (autoload 'debug "debug" nil t)
180 (autoload 'sha1 "sha1")
182 (unless (locate-library "mule-ccl")
183 (autoload 'define-ccl-program "ccl" nil nil 'macro))
184 (defalias 'define-ccl-program 'ignore))
185 (autoload 'delete-annotation "annotations")
186 (autoload 'dolist "cl-macs" nil nil 'macro)
187 (autoload 'enriched-decode "enriched")
188 (autoload 'eudc-expand-inline "eudc" nil t)
189 (autoload 'executable-find "executable")
190 (autoload 'font-lock-fontify-buffer "font-lock" nil t)
191 (when (and (emacs-version>= 21 5)
192 (not (featurep 'sxemacs)))
193 (autoload 'get-display-table "disp-table")
194 (autoload 'put-display-table "disp-table"))
195 (autoload 'info "info" nil t)
196 (autoload 'mail-extract-address-components "mail-extr")
197 (autoload 'mail-fetch-field "mail-utils")
198 (autoload 'make-annotation "annotations")
199 (autoload 'make-display-table "disp-table")
201 (autoload 'ps-despool "ps-print" nil t)
202 (autoload 'ps-spool-buffer "ps-print" nil t)
203 (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
204 (autoload 'read-passwd "passwd")
205 (autoload 'regexp-opt "regexp-opt")
206 (autoload 'reporter-submit-bug-report "reporter")
207 (if (condition-case nil
210 (not (fboundp 'rot13-string)))
212 (defmacro rot13-string (string)
213 "Return ROT13 encryption of STRING."
214 `(let ((string ,string))
217 (translate-region (point-min) (point-max) ,rot13-display-table)
219 (if (and (emacs-version>= 21 5)
220 (not (featurep 'sxemacs)))
221 (autoload 'setenv "process" nil t)
222 (autoload 'setenv "env" nil t))
223 (autoload 'sgml-mode "psgml" nil t)
224 (autoload 'smtpmail-send-it "smtpmail")
225 (autoload 'sort-numeric-fields "sort" nil t)
226 (autoload 'sort-subr "sort")
227 (autoload 'thing-at-point "thingatpt")
228 (autoload 'toggle-truncate-lines "view-less" nil t)
229 (autoload 'trace-function-background "trace" nil t)
230 (autoload 'unmorse-region "morse" nil t)
231 (defalias 'frame-char-height 'frame-height)
232 (defalias 'frame-char-width 'frame-width)
233 (defalias 'frame-parameter 'frame-property)
234 (defalias 'make-overlay 'ignore)
235 (defalias 'overlay-end 'ignore)
236 (defalias 'overlay-get 'ignore)
237 (defalias 'overlay-put 'ignore)
238 (defalias 'overlay-start 'ignore)
239 (defalias 'overlays-in 'ignore)
240 (defalias 'replace-dehighlight 'ignore)
241 (defalias 'replace-highlight 'ignore)
242 (defalias 'gnutls-available-p 'ignore)
243 (defvar timer-list nil)
244 (defvar scroll-margin 0)))
246 (defun dgnushack-emacs-compile-defcustom-p ()
247 "Return non-nil if Emacs byte compiles `defcustom' forms.
248 Those Emacsen will warn against undefined variables and functions used
249 in `defcustom' forms."
250 (let ((outbuf (with-temp-buffer
251 (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
252 (byte-compile-from-buffer (current-buffer) "foo.el"))))
255 (with-current-buffer outbuf
256 (goto-char (point-min))
257 (search-forward " 'foo '(byte-code " nil t))
258 (kill-buffer outbuf)))))
260 (when (and (featurep 'xemacs)
261 (dgnushack-emacs-compile-defcustom-p))
262 (maybe-fbind '(defined-colors face-attribute))
263 (maybe-bind '(idna-program installation-directory)))
265 (when (featurep 'xemacs)
266 (defadvice byte-optimize-apply (before use-mapcan (form) activate)
267 "Replace (apply 'nconc (mapcar ...)) with (mapcan ...)."
268 (let ((last (nth (1- (length form)) form)))
269 (when (and (eq last (third form))
271 (eq 'mapcar (car last))
272 (equal (nth 1 form) ''nconc))
273 (setq form (cons 'mapcan (cdr last)))))))
275 (if (featurep 'emacs)
276 (defun dgnushack-compile-file (file)
277 "Byte-compile FILE after reporting that it's being compiled."
278 (message "Compiling %s..." (file-name-nondirectory file))
279 ;; The Emacs 25 version of it doesn't say much.
280 (byte-compile-file file))
281 (defalias 'dgnushack-compile-file 'byte-compile-file))
283 (defun dgnushack-compile-verbosely ()
284 "Call dgnushack-compile with warnings ENABLED. If you are compiling
285 patches to gnus, you should consider modifying make.bat to call
286 dgnushack-compile-verbosely. All other users should continue to use
288 (dgnushack-compile t))
290 (defun dgnushack-compile-error-on-warn ()
291 "Call dgnushack-compile with minimal warnings, but with error-on-warn ENABLED.
292 This means that every warning will be reported as an error."
293 (unless (dgnushack-compile nil t)
294 (error "Error during byte compilation (warnings were reported as errors!).")))
296 (defun dgnushack-compile (&optional warn error-on-warn)
297 ;;(setq byte-compile-dynamic t)
299 (setq byte-compile-warnings
300 '(free-vars unresolved callargs redefine suspicious)))
301 (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
303 ;;(byte-compile-generate-call-tree t)
305 ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
307 (when (featurep 'xemacs)
308 (setq gnus-xmas-glyph-directory "dummy"))
309 (dolist (file '(".dir-locals.el" "dgnushack.el" "lpath.el"))
310 (setq files (delete file files)))
311 (when (featurep 'base64)
312 (setq files (delete "base64.el" files)))
314 ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
315 ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
318 (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
319 (setq files (delete "gnus-mh.el" files))))
323 (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
324 (setq files (delete "nnrss.el" files))))
326 (if (featurep 'xemacs)
328 '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
329 (setq files (delete file files)))
330 (unless (and (fboundp 'libxml-parse-html-region)
331 ;; lpath.el binds it.
332 (not (eq (symbol-function 'libxml-parse-html-region)
334 (dolist (file '("color.el"))
335 (setq files (delete file files))))
336 (unless (locate-library "epg")
337 (setq files (delete "plstore.el" files)))
338 ;; Temporary code until we fix pcase and defmethod stuff.
339 (when (or (featurep 'xemacs)
340 (or (< emacs-major-version 24)
341 (< emacs-minor-version 3)))
342 (setq files (delete "gnus-icalendar.el" files))
343 ;; Temporary during development.
344 (setq files (delete "gnus-cloud.el" files)))
346 (setq file (expand-file-name file srcdir))
347 (when (and (file-exists-p
348 (setq elc (concat (file-name-nondirectory file) "c")))
349 (file-newer-than-file-p file elc))
352 (while (setq file (pop files))
353 (setq file (expand-file-name file srcdir))
354 (when (or (not (file-exists-p
355 (setq elc (concat (file-name-nondirectory file) "c"))))
356 (file-newer-than-file-p file elc))
358 (let ((byte-compile-error-on-warn t))
359 (unless (ignore-errors
360 (dgnushack-compile-file file))
361 (setq compilesuccess nil)))
363 (dgnushack-compile-file file)))))
366 (defun dgnushack-recompile ()
368 (byte-recompile-directory "." 0))
370 (defvar dgnushack-gnus-load-file
371 (if (featurep 'xemacs)
372 (expand-file-name "auto-autoloads.el")
373 (expand-file-name "gnus-load.el")))
375 (defvar dgnushack-cus-load-file
376 (if (featurep 'xemacs)
377 (expand-file-name "custom-load.el")
378 (expand-file-name "cus-load.el")))
380 (defun dgnushack-make-cus-load ()
382 (let ((cusload-base-file dgnushack-cus-load-file))
383 (defadvice directory-files (after exclude-dir-locals activate)
384 "Exclude .dir-locals.el file."
385 (dolist (file ad-return-value)
386 (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
387 (setq ad-return-value (delete file ad-return-value)))))
389 (if (fboundp 'custom-make-dependencies)
390 (custom-make-dependencies)
391 (Custom-make-dependencies))
392 (ad-unadvise 'directory-files))
393 (when (featurep 'xemacs)
394 (message "Compiling %s..." dgnushack-cus-load-file)
395 (byte-compile-file dgnushack-cus-load-file))))
397 (defun dgnushack-make-auto-load ()
399 (let ((generated-autoload-file dgnushack-gnus-load-file)
400 (make-backup-files nil)
401 (autoload-package-name "gnus"))
402 (if (featurep 'xemacs)
403 (if (file-exists-p generated-autoload-file)
404 (delete-file generated-autoload-file))
405 (with-temp-file generated-autoload-file
407 (defadvice directory-files (after exclude-dir-locals activate)
408 "Exclude .dir-locals.el file."
409 (dolist (file ad-return-value)
410 (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
411 (setq ad-return-value (delete file ad-return-value)))))
413 (batch-update-autoloads)
414 (ad-unadvise 'directory-files))))
416 (defun dgnushack-make-load ()
417 (unless (featurep 'xemacs)
418 (message "Generating %s..." dgnushack-gnus-load-file)
419 (with-temp-file dgnushack-gnus-load-file
420 (insert-file-contents dgnushack-cus-load-file)
421 (delete-file dgnushack-cus-load-file)
422 (goto-char (point-min))
423 (search-forward ";;; Code:")
425 (delete-region (point-min) (point))
427 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
431 (goto-char (point-max))
432 (if (search-backward "custom-versions-load-alist" nil t)
435 (while (eq (char-after) ?\;)
438 (delete-region (point) (point-max))
440 ;; smiley-* are duplicated. Remove them all.
441 (let ((point (point)))
442 (insert-file-contents dgnushack-gnus-load-file)
444 (while (search-forward "smiley-" nil t)
446 (if (looking-at "(autoload ")
447 (delete-region (point) (progn (forward-sexp) (point)))
450 (goto-char (point-max))
451 (when (search-backward "\n(provide " nil t)
453 (delete-region (point) (point-max)))
456 \(provide 'gnus-load)
459 ;;; version-control: never
460 ;;; no-byte-compile: t
461 ;;; no-update-autoloads: t
463 ;;; gnus-load.el ends here
466 (message "Compiling %s..." dgnushack-gnus-load-file)
467 (byte-compile-file dgnushack-gnus-load-file)
468 (when (featurep 'xemacs)
469 (message "Creating dummy gnus-load.el...")
470 (with-temp-file (expand-file-name "gnus-load.el")
473 \(provide 'gnus-load)
476 ;;; version-control: never
477 ;;; no-byte-compile: t
478 ;;; no-update-autoloads: t
480 ;;; gnus-load.el ends here"))))
482 (defun dgnushack-find-lisp-shadows (&optional lispdir)
483 "Return a list of directories in which other Gnus installations exist.
484 This function looks for the other Gnus installations which will shadow
485 the new Gnus Lisp modules which have been installed in LISPDIR, using
486 the default `load-path'. The return value will make sense only when
487 LISPDIR is existent and is listed in the default `load-path'. Assume
488 LISPDIR will be prepended to `load-path' by a user if the default
489 `load-path' does not contain it."
491 (setq lispdir (getenv "lispdir")))
492 (when (and lispdir (file-directory-p lispdir))
493 (setq lispdir (file-truename (directory-file-name lispdir)))
494 (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
495 "message.elc" "message.el" "message.el.bz2"
497 (path (delq nil (mapcar
500 (when (and p (file-directory-p p))
501 (file-truename (directory-file-name p)))
503 dgnushack-default-load-path)))
506 (setq rest (cons (car path) rest)
507 path (delete (car rest) (cdr path))))
508 (setq path (nreverse (cdr (member lispdir rest)))
513 (when (file-exists-p (expand-file-name (pop elcs) (car path)))
514 (setq rest (cons (car path) rest)
516 (setq path (cdr path)))
518 (setq path (nreverse rest))
520 (let (print-level print-length)
522 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
523 been detected in:\n\n " (mapconcat 'identity path "\n ") "\n\n\
524 You will need to modify the run-time `load-path', remove them manually,
525 or remove them using `make remove-installed-shadows'.\n\n"))))))))
527 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
528 "Remove the other Gnus installations which shadow the recent one."
529 (let ((path (with-temp-buffer
530 (let ((standard-output (current-buffer)))
531 (dgnushack-find-lisp-shadows lispdir))))
532 elcs files shadows file)
534 (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
535 (error "You should build .elc files first."))
541 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
543 (list (file-name-nondirectory dgnushack-gnus-load-file)
544 (file-name-nondirectory dgnushack-cus-load-file))
545 (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
549 (setq file (expand-file-name (pop shadows) (car path)))
550 (when (file-exists-p file)
551 (princ (concat " Removing " file "..."))
556 (error (princ "failed\n")))))
557 (setq path (cdr path))))))
559 (unless (fboundp 'with-demoted-errors)
560 (defmacro with-demoted-errors (&rest body)
561 "Run BODY and demote any errors to simple messages.
562 If `debug-on-error' is non-nil, run BODY without catching its errors.
563 This is to be used around code which is not expected to signal an error
564 but which should be robust in the unexpected case that an error is signaled."
565 (declare (debug t) (indent 0))
566 (let ((err (make-symbol "err")))
567 `(condition-case ,err
569 (error (message "Error: %S" ,err) nil)))))
571 ;; XEmacs's `define-obsolete-variable-alias' takes only two arguments:
572 ;; (define-obsolete-variable-alias OLDVAR NEWVAR)
575 (defvar dgnushack-obsolete-name nil)
576 (defvar dgnushack-current-name nil)
578 (define-obsolete-variable-alias
579 'dgnushack-obsolete-name 'dgnushack-current-name "0")
580 (makunbound 'dgnushack-obsolete-name)
581 (makunbound 'dgnushack-current-name)))
582 (wrong-number-of-arguments
583 (defadvice define-obsolete-variable-alias (around ignore-rest-args
584 (oldvar newvar &rest args)
586 "Ignore arguments other than the 1st and the 2nd ones."
588 (put 'define-obsolete-variable-alias 'byte-optimizer
590 (setcdr (nthcdr 2 form) nil)
593 ;;; dgnushack.el ends here