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, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003,
   3 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010
   4 ;;        Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Version: 4.19
   8 ;; Keywords: news, path
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 3, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 (defvar dgnushack-default-load-path (copy-sequence load-path))
  32
  33 (defalias 'facep 'ignore)
  34
  35 (require 'cl)
  36 (require 'iswitchb)
  37
  38 (condition-case nil
  39     (require 'org-entities)
  40   (error nil))
  41
  42 (defvar srcdir (or (getenv "srcdir") "."))
  43 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
  44
  45 (defun my-getenv (str)
  46   (let ((val (getenv str)))
  47     (if (equal val "no") nil val)))
  48
  49 (if (my-getenv "lispdir")
  50     (push (my-getenv "lispdir") load-path))
  51
  52 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
  53       load-path)
  54
  55 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
  56       load-path)
  57
  58 ;(push "/usr/share/emacs/site-lisp" load-path)
  59
  60 ;; If we are building w3 in a different directory than the source
  61 ;; directory, we must read *.el from source directory and write *.elc
  62 ;; into the building directory.  For that, we define this function
  63 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
  64 (defun byte-compile-dest-file (filename)
  65   "Convert an Emacs Lisp source file name to a compiled file name.
  66  In addition, remove directory name part from FILENAME."
  67   (setq filename (byte-compiler-base-file-name filename))
  68   (setq filename (file-name-sans-versions filename))
  69   (setq filename (file-name-nondirectory filename))
  70   (if (eq system-type 'windows-nt)
  71       (setq filename (downcase filename)))
  72   (cond ((eq system-type 'vax-vms)
  73          (concat (substring filename 0 (string-match ";" filename)) "c"))
  74         ((string-match emacs-lisp-file-regexp filename)
  75          (concat (substring filename 0 (match-beginning 0)) ".elc"))
  76         (t (concat filename ".elc"))))
  77
  78 (require 'bytecomp)
  79 ;; To avoid having defsubsts and inlines happen.
  80 ;(if (featurep 'xemacs)
  81 ;    (require 'byte-optimize)
  82 ;  (require 'byte-opt))
  83 ;(defun byte-optimize-inline-handler (form)
  84 ;  "byte-optimize-handler for the `inline' special-form."
  85 ;  (cons 'progn (cdr form)))
  86 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
  87
  88 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
  89 ;; following threads:
  90 ;;
  91 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
  92 ;; Subject: attachment problems found but not fixed
  93 ;;
  94 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
  95 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
  96 ;;
  97 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
  98 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
  99 ;;
 100 ;; Should be fixed in XEmacs (March 2007).
 101 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
 102 ;; When should we remove this workaround?
 103 ;;
 104 (when (and (featurep 'xemacs)
 105            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
 106              (modify-syntax-entry ?= " " table)
 107              (with-temp-buffer
 108                (with-syntax-table table
 109                  (insert "foo=bar")
 110                  (goto-char (point-min))
 111                  (forward-sexp 1)
 112                  (eolp)))))
 113   ;; The original `with-syntax-table' uses `copy-syntax-table' which
 114   ;; doesn't seem to copy modified syntax entries in old XEmacs 21.5.
 115   (defmacro with-syntax-table (syntab &rest body)
 116     "Evaluate BODY with the SYNTAB as the current syntax table."
 117     `(let ((stab (syntax-table)))
 118        (unwind-protect
 119            (progn
 120              ;;(set-syntax-table (copy-syntax-table ,syntab))
 121              (set-syntax-table ,syntab)
 122              ,@body)
 123          (set-syntax-table stab)))))
 124
 125 (push srcdir load-path)
 126 (push loaddir load-path)
 127 (load (expand-file-name "lpath.el" loaddir) nil t)
 128
 129 (defalias 'device-sound-enabled-p 'ignore)
 130 (defalias 'play-sound-file 'ignore)
 131 (defalias 'efs-re-read-dir 'ignore)
 132 (defalias 'ange-ftp-re-read-dir 'ignore)
 133 (defalias 'define-mail-user-agent 'ignore)
 134
 135 (eval-and-compile
 136   (unless (featurep 'xemacs)
 137     (defalias 'get-popup-menu-response 'ignore)
 138     (defalias 'event-object 'ignore)
 139     (autoload 'iswitchb-read-buffer "iswitchb")
 140     (autoload 'netrc-credentials "netrc")
 141     (defalias 'x-defined-colors 'ignore)
 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       (setq files (delete "shr-color.el" (delete "shr.el" files))))
 316
 317     (dolist (file files)
 318       (setq file (expand-file-name file srcdir))
 319       (when (and (file-exists-p
 320                   (setq elc (concat (file-name-nondirectory file) "c")))
 321                  (file-newer-than-file-p file elc))
 322         (delete-file elc)))
 323
 324     (while (setq file (pop files))
 325       (setq file (expand-file-name file srcdir))
 326       (when (or (not (file-exists-p
 327                       (setq elc (concat (file-name-nondirectory file) "c"))))
 328                 (file-newer-than-file-p file elc))
 329         (ignore-errors
 330           (byte-compile-file file))))))
 331
 332 (defun dgnushack-recompile ()
 333   (require 'gnus)
 334   (byte-recompile-directory "." 0))
 335
 336 (defvar dgnushack-gnus-load-file
 337   (if (featurep 'xemacs)
 338       (expand-file-name "auto-autoloads.el")
 339     (expand-file-name "gnus-load.el")))
 340
 341 (defvar dgnushack-cus-load-file
 342   (if (featurep 'xemacs)
 343       (expand-file-name "custom-load.el")
 344     (expand-file-name "cus-load.el")))
 345
 346 (defun dgnushack-make-cus-load ()
 347   (load "cus-dep")
 348   (let ((cusload-base-file dgnushack-cus-load-file))
 349     (defadvice directory-files (after exclude-dir-locals activate)
 350       "Exclude .dir-locals.el file."
 351       (dolist (file ad-return-value)
 352         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
 353             (setq ad-return-value (delete file ad-return-value)))))
 354     (unwind-protect
 355         (if (fboundp 'custom-make-dependencies)
 356             (custom-make-dependencies)
 357           (Custom-make-dependencies))
 358       (ad-unadvise 'directory-files))
 359     (when (featurep 'xemacs)
 360       (message "Compiling %s..." dgnushack-cus-load-file)
 361       (byte-compile-file dgnushack-cus-load-file))))
 362
 363 (defun dgnushack-make-auto-load ()
 364   (require 'autoload)
 365   (let ((generated-autoload-file dgnushack-gnus-load-file)
 366         (make-backup-files nil)
 367         (autoload-package-name "gnus"))
 368     (if (featurep 'xemacs)
 369         (if (file-exists-p generated-autoload-file)
 370             (delete-file generated-autoload-file))
 371       (with-temp-file generated-autoload-file
 372         (insert ?\014)))
 373     (defadvice directory-files (after exclude-dir-locals activate)
 374       "Exclude .dir-locals.el file."
 375       (dolist (file ad-return-value)
 376         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
 377             (setq ad-return-value (delete file ad-return-value)))))
 378     (unwind-protect
 379         (batch-update-autoloads)
 380       (ad-unadvise 'directory-files))))
 381
 382 (defun dgnushack-make-load ()
 383   (unless (featurep 'xemacs)
 384     (message "Generating %s..." dgnushack-gnus-load-file)
 385     (with-temp-file dgnushack-gnus-load-file
 386       (insert-file-contents dgnushack-cus-load-file)
 387       (delete-file dgnushack-cus-load-file)
 388       (goto-char (point-min))
 389       (search-forward ";;; Code:")
 390       (forward-line)
 391       (delete-region (point-min) (point))
 392       (insert "\
 393 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
 394 ;;
 395 ;;; Code:
 396 ")
 397       (goto-char (point-max))
 398       (if (search-backward "custom-versions-load-alist" nil t)
 399           (forward-line -1)
 400         (forward-line -1)
 401         (while (eq (char-after) ?\;)
 402           (forward-line -1))
 403         (forward-line))
 404       (delete-region (point) (point-max))
 405       (insert "\n")
 406       ;; smiley-* are duplicated. Remove them all.
 407       (let ((point (point)))
 408         (insert-file-contents dgnushack-gnus-load-file)
 409         (goto-char point)
 410         (while (search-forward "smiley-" nil t)
 411           (beginning-of-line)
 412           (if (looking-at "(autoload ")
 413               (delete-region (point) (progn (forward-sexp) (point)))
 414             (forward-line))))
 415       ;;
 416       (goto-char (point-max))
 417       (when (search-backward "\n(provide " nil t)
 418         (forward-line -1)
 419         (delete-region (point) (point-max)))
 420       (insert "\
 421
 422 \(provide 'gnus-load)
 423
 424 ;;; Local Variables:
 425 ;;; version-control: never
 426 ;;; no-byte-compile: t
 427 ;;; no-update-autoloads: t
 428 ;;; End:
 429 ;;; gnus-load.el ends here
 430 ")
 431       ))
 432   (message "Compiling %s..." dgnushack-gnus-load-file)
 433   (byte-compile-file dgnushack-gnus-load-file)
 434   (when (featurep 'xemacs)
 435     (message "Creating dummy gnus-load.el...")
 436     (with-temp-file (expand-file-name "gnus-load.el")
 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 (defun dgnushack-find-lisp-shadows (&optional lispdir)
 449   "Return a list of directories in which other Gnus installations exist.
 450 This function looks for the other Gnus installations which will shadow
 451 the new Gnus Lisp modules which have been installed in LISPDIR, using
 452 the default `load-path'.  The return value will make sense only when
 453 LISPDIR is existent and is listed in the default `load-path'.  Assume
 454 LISPDIR will be prepended to `load-path' by a user if the default
 455 `load-path' does not contain it."
 456   (unless lispdir
 457     (setq lispdir (getenv "lispdir")))
 458   (when (and lispdir (file-directory-p lispdir))
 459     (setq lispdir (file-truename (directory-file-name lispdir)))
 460     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
 461                      "message.elc" "message.el" "message.el.bz2"
 462                      "message.el.gz"))
 463           (path (delq nil (mapcar
 464                            (lambda (p)
 465                              (condition-case nil
 466                                  (when (and p (file-directory-p p))
 467                                    (file-truename (directory-file-name p)))
 468                                (error nil)))
 469                            dgnushack-default-load-path)))
 470           rest elcs)
 471       (while path
 472         (setq rest (cons (car path) rest)
 473               path (delete (car rest) (cdr path))))
 474       (setq path (nreverse (cdr (member lispdir rest)))
 475             rest nil)
 476       (while path
 477         (setq elcs indices)
 478         (while elcs
 479           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
 480             (setq rest (cons (car path) rest)
 481                   elcs nil)))
 482         (setq path (cdr path)))
 483       (prog1
 484           (setq path (nreverse rest))
 485         (when path
 486           (let (print-level print-length)
 487             (princ (concat "\n\
 488 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
 489  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
 490 You will need to modify the run-time `load-path', remove them manually,
 491 or remove them using `make remove-installed-shadows'.\n\n"))))))))
 492
 493 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
 494   "Remove the other Gnus installations which shadow the recent one."
 495   (let ((path (with-temp-buffer
 496                 (let ((standard-output (current-buffer)))
 497                   (dgnushack-find-lisp-shadows lispdir))))
 498         elcs files shadows file)
 499     (when path
 500       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
 501         (error "You should build .elc files first."))
 502       (setq files
 503             (apply
 504              'append
 505              (mapcar
 506               (lambda (el)
 507                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
 508               (append
 509                (list (file-name-nondirectory dgnushack-gnus-load-file)
 510                      (file-name-nondirectory dgnushack-cus-load-file))
 511                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
 512       (while path
 513         (setq shadows files)
 514         (while shadows
 515           (setq file (expand-file-name (pop shadows) (car path)))
 516           (when (file-exists-p file)
 517             (princ (concat "  Removing " file "..."))
 518             (condition-case nil
 519                 (progn
 520                   (delete-file file)
 521                   (princ "done\n"))
 522               (error (princ "failed\n")))))
 523         (setq path (cdr path))))))
 524
 525 ;;; dgnushack.el ends here