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