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