poe.el

   1 ;;; poe.el --- Portable Outfit for Emacsen
   2
   3 ;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
   6 ;;      Shuhei KOBAYASHI <shuhei@aqua.ocn.ne.jp>
   7 ;; Keywords: emulation, compatibility, Nemacs, MULE, Emacs/mule, XEmacs
   8
   9 ;; This file is part of APEL (A Portable Emacs Library).
  10
  11 ;; This program is free software; you can redistribute it and/or
  12 ;; modify it under the terms of the GNU General Public License as
  13 ;; published by the Free Software Foundation; either version 2, or (at
  14 ;; your option) any later version.
  15
  16 ;; This program is distributed in the hope that it will be useful, but
  17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 ;; General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (require 'product)
  31 (product-provide (provide 'poe) (require 'apel-ver))
  32
  33 (require 'pym)
  34
  35
  36 ;;; @ Version information.
  37 ;;;
  38
  39 (static-when (= emacs-major-version 18)
  40   (require 'poe-18))
  41
  42 ;; Some ancient version of XEmacs did not provide 'xemacs.
  43 (static-when (string-match "XEmacs" emacs-version)
  44   (provide 'xemacs))
  45
  46 ;; `file-coding' was appeared in the spring of 1998, just before XEmacs
  47 ;; 21.0. Therefore it is not provided in XEmacs with MULE versions 20.4
  48 ;; or earlier.
  49 (static-when (featurep 'xemacs)
  50   ;; must be load-time check to share .elc between w/ MULE and w/o MULE.
  51   (when (featurep 'mule)
  52     (provide 'file-coding)))
  53
  54 (static-when (featurep 'xemacs)
  55   (require 'poe-xemacs))
  56
  57 ;; must be load-time check to share .elc between different systems.
  58 (or (fboundp 'open-network-stream)
  59     (require 'tcp))
  60 \f
  61
  62 ;;; @ C primitives emulation.
  63 ;;;
  64
  65 ;; Emacs 20.3 and earlier: (require FEATURE &optional FILENAME)
  66 ;; Emacs 20.4 and later: (require FEATURE &optional FILENAME NOERROR)
  67 (static-condition-case nil
  68     ;; compile-time check.
  69     (progn
  70       (require 'nofeature "nofile" 'noerror)
  71       (if (get 'require 'defun-maybe)
  72           (error "`require' is already redefined")))
  73   (error
  74    ;; load-time check.
  75    (or (fboundp 'si:require)
  76        (progn
  77          (fset 'si:require (symbol-function 'require))
  78          (put 'require 'defun-maybe t)
  79          (defun require (feature &optional filename noerror)
  80            "\
  81 If feature FEATURE is not loaded, load it from FILENAME.
  82 If FEATURE is not a member of the list `features', then the feature
  83 is not loaded; so load the file FILENAME.
  84 If FILENAME is omitted, the printname of FEATURE is used as the file name,
  85 but in this case `load' insists on adding the suffix `.el' or `.elc'.
  86 If the optional third argument NOERROR is non-nil,
  87 then return nil if the file is not found.
  88 Normally the return value is FEATURE."
  89            (if noerror
  90                (condition-case nil
  91                    (si:require feature filename)
  92                  (file-error))
  93              (si:require feature filename)))))))
  94
  95 ;; Emacs 19.29 and later: (plist-get PLIST PROP)
  96 ;; (defun-maybe plist-get (plist prop)
  97 ;;   (while (and plist
  98 ;;               (not (eq (car plist) prop)))
  99 ;;     (setq plist (cdr (cdr plist))))
 100 ;;   (car (cdr plist)))
 101 (static-unless (and (fboundp 'plist-get)
 102                     (not (get 'plist-get 'defun-maybe)))
 103   (or (fboundp 'plist-get)
 104       (progn
 105         (defvar plist-get-internal-symbol)
 106         (defun plist-get (plist prop)
 107           "\
 108 Extract a value from a property list.
 109 PLIST is a property list, which is a list of the form
 110 \(PROP1 VALUE1 PROP2 VALUE2...\).  This function returns the value
 111 corresponding to the given PROP, or nil if PROP is not
 112 one of the properties on the list."
 113           (setplist 'plist-get-internal-symbol plist)
 114           (get 'plist-get-internal-symbol prop))
 115         ;; for `load-history'.
 116         (setq current-load-list (cons 'plist-get current-load-list))
 117         (put 'plist-get 'defun-maybe t))))
 118
 119 ;; Emacs 19.29 and later: (plist-put PLIST PROP VAL)
 120 ;; (defun-maybe plist-put (plist prop val)
 121 ;;   (catch 'found
 122 ;;     (let ((tail plist)
 123 ;;           (prev nil))
 124 ;;       (while (and tail (cdr tail))
 125 ;;         (if (eq (car tail) prop)
 126 ;;             (progn
 127 ;;               (setcar (cdr tail) val)
 128 ;;               (throw 'found plist))
 129 ;;           (setq prev tail
 130 ;;                 tail (cdr (cdr tail)))))
 131 ;;       (if prev
 132 ;;           (progn
 133 ;;             (setcdr (cdr prev) (list prop val))
 134 ;;             plist)
 135 ;;         (list prop val)))))
 136 (static-unless (and (fboundp 'plist-put)
 137                     (not (get 'plist-put 'defun-maybe)))
 138   (or (fboundp 'plist-put)
 139       (progn
 140         (defvar plist-put-internal-symbol)
 141         (defun plist-put (plist prop val)
 142           "\
 143 Change value in PLIST of PROP to VAL.
 144 PLIST is a property list, which is a list of the form
 145 \(PROP1 VALUE1 PROP2 VALUE2 ...\).  PROP is a symbol and VAL is any object.
 146 If PROP is already a property on the list, its value is set to VAL,
 147 otherwise the new PROP VAL pair is added.  The new plist is returned;
 148 use `\(setq x \(plist-put x prop val\)\)' to be sure to use the new value.
 149 The PLIST is modified by side effects."
 150           (setplist 'plist-put-internal-symbol plist)
 151           (put 'plist-put-internal-symbol prop val)
 152           (symbol-plist 'plist-put-internal-symbol))
 153         ;; for `load-history'.
 154         (setq current-load-list (cons 'plist-put current-load-list))
 155         (put 'plist-put 'defun-maybe t))))
 156
 157 ;; Emacs 19.23 and later: (minibuffer-prompt-width)
 158 (defun-maybe minibuffer-prompt-width ()
 159   "Return the display width of the minibuffer prompt."
 160   (save-excursion
 161     (set-buffer (window-buffer (minibuffer-window)))
 162     (current-column)))
 163
 164 ;; (read-string PROMPT &optional INITIAL-INPUT HISTORY)
 165 ;; Emacs 19.29/XEmacs 19.14(?) and later takes optional 3rd arg HISTORY.
 166 (static-unless (or (featurep 'xemacs)
 167                    (>= emacs-major-version 20)
 168                    (and (= emacs-major-version 19)
 169                         (>= emacs-minor-version 29)))
 170   (or (fboundp 'si:read-string)
 171       (progn
 172         (fset 'si:read-string (symbol-function 'read-string))
 173         (defun read-string (prompt &optional initial-input history)
 174           "\
 175 Read a string from the minibuffer, prompting with string PROMPT.
 176 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
 177 The third arg HISTORY, is dummy for compatibility.
 178 See `read-from-minibuffer' for details of HISTORY argument."
 179           (si:read-string prompt initial-input)))))
 180
 181 ;; (completing-read prompt table &optional
 182 ;; FSF Emacs
 183 ;;      --19.7  : predicate require-match init
 184 ;; 19.7 --19.34 : predicate require-match init hist
 185 ;; 20.1 --      : predicate require-match init hist def inherit-input-method
 186 ;; XEmacs
 187 ;;      --19.(?): predicate require-match init
 188 ;;      --21.2  : predicate require-match init hist
 189 ;; 21.2 --      : predicate require-match init hist def
 190 ;; )
 191
 192 ;; We support following API.
 193 ;; (completing-read prompt table
 194 ;;                  &optional predicate require-match init hist def)
 195 (static-cond
 196  ;; add 'hist' and 'def' argument.
 197  ((< emacs-major-version 19)
 198   (or (fboundp 'si:completing-read)
 199       (progn
 200         (fset 'si:completing-read (symbol-function 'completing-read))
 201         (defun completing-read
 202           (prompt table &optional predicate require-match init
 203                                   hist def)
 204         "Read a string in the minibuffer, with completion.
 205 PROMPT is a string to prompt with; normally it ends in a colon and a space.
 206 TABLE is an alist whose elements' cars are strings, or an obarray.
 207 PREDICATE limits completion to a subset of TABLE.
 208 See `try-completion' and `all-completions' for more details
 209  on completion, TABLE, and PREDICATE.
 210
 211 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
 212  the input is (or completes to) an element of TABLE or is null.
 213  If it is also not t, Return does not exit if it does non-null completion.
 214 If the input is null, `completing-read' returns an empty string,
 215  regardless of the value of REQUIRE-MATCH.
 216
 217 If INIT is non-nil, insert it in the minibuffer initially.
 218   If it is (STRING . POSITION), the initial input
 219   is STRING, but point is placed POSITION characters into the string.
 220 HIST is ignored in this implementation.
 221 DEF, if non-nil, is the default value.
 222
 223 Completion ignores case if the ambient value of
 224   `completion-ignore-case' is non-nil."
 225         (let ((string (si:completing-read prompt table predicate
 226                                           require-match init)))
 227           (if (and (string= string "") def)
 228               def string))))))
 229  ;; add 'def' argument.
 230  ((or (and (featurep 'xemacs)
 231            (or (and (eq emacs-major-version 21)
 232                     (< emacs-minor-version 2))
 233                (< emacs-major-version 21)))
 234       (< emacs-major-version 20))
 235   (or (fboundp 'si:completing-read)
 236       (progn
 237         (fset 'si:completing-read (symbol-function 'completing-read))
 238         (defun completing-read
 239           (prompt table &optional predicate require-match init
 240                                   hist def)
 241         "Read a string in the minibuffer, with completion.
 242 PROMPT is a string to prompt with; normally it ends in a colon and a space.
 243 TABLE is an alist whose elements' cars are strings, or an obarray.
 244 PREDICATE limits completion to a subset of TABLE.
 245 See `try-completion' and `all-completions' for more details
 246  on completion, TABLE, and PREDICATE.
 247
 248 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
 249  the input is (or completes to) an element of TABLE or is null.
 250  If it is also not t, Return does not exit if it does non-null completion.
 251 If the input is null, `completing-read' returns an empty string,
 252  regardless of the value of REQUIRE-MATCH.
 253
 254 If INIT is non-nil, insert it in the minibuffer initially.
 255   If it is (STRING . POSITION), the initial input
 256   is STRING, but point is placed POSITION characters into the string.
 257 HIST, if non-nil, specifies a history list
 258   and optionally the initial position in the list.
 259   It can be a symbol, which is the history list variable to use,
 260   or it can be a cons cell (HISTVAR . HISTPOS).
 261   In that case, HISTVAR is the history list variable to use,
 262   and HISTPOS is the initial position (the position in the list
 263   which INIT corresponds to).
 264   Positions are counted starting from 1 at the beginning of the list.
 265 DEF, if non-nil, is the default value.
 266
 267 Completion ignores case if the ambient value of
 268   `completion-ignore-case' is non-nil."
 269         (let ((string (si:completing-read prompt table predicate
 270                                           require-match init hist)))
 271           (if (and (string= string "") def)
 272               def string)))))))
 273
 274 ;; v18: (string-to-int STRING)
 275 ;; v19: (string-to-number STRING)
 276 ;; v20: (string-to-number STRING &optional BASE)
 277 ;;
 278 ;; XXX: `string-to-number' of Emacs 20.3 and earlier is broken.
 279 ;;      (string-to-number "1e1" 16) => 10.0, should be 481.
 280 (static-condition-case nil
 281     ;; compile-time check.
 282     (if (= (string-to-number "1e1" 16) 481)
 283         (if (get 'string-to-number 'defun-maybe)
 284             (error "`string-to-number' is already redefined"))
 285       (error "`string-to-number' is broken"))
 286   (error
 287    ;; load-time check.
 288    (or (fboundp 'si:string-to-number)
 289        (progn
 290          (if (fboundp 'string-to-number)
 291              (fset 'si:string-to-number (symbol-function 'string-to-number))
 292            (fset 'si:string-to-number (symbol-function 'string-to-int))
 293            ;; XXX: In v18, this causes infinite loop while bytecompiling.
 294            ;; (defalias 'string-to-int 'string-to-number)
 295            )
 296          (put 'string-to-number 'defun-maybe t)
 297          (defun string-to-number (string &optional base)
 298            "\
 299 Convert STRING to a number by parsing it as a decimal number.
 300 This parses both integers and floating point numbers.
 301 It ignores leading spaces and tabs.
 302
 303 If BASE, interpret STRING as a number in that base.  If BASE isn't
 304 present, base 10 is used.  BASE must be between 2 and 16 (inclusive).
 305 If the base used is not 10, floating point is not recognized."
 306            (if (or (null base) (= base 10))
 307                (si:string-to-number string)
 308              (if (or (< base 2)(> base 16))
 309                  (signal 'args-out-of-range (cons base nil)))
 310              (let ((len (length string))
 311                    (pos 0))
 312                ;; skip leading whitespace.
 313                (while (and (< pos len)
 314                            (memq (aref string pos) '(?\  ?\t)))
 315                  (setq pos (1+ pos)))
 316                (if (= pos len)
 317                    0
 318                  (let ((number 0)(negative 1)
 319                        chr num)
 320                    (if (eq (aref string pos) ?-)
 321                        (setq negative -1
 322                              pos (1+ pos))
 323                      (if (eq (aref string pos) ?+)
 324                          (setq pos (1+ pos))))
 325                    (while (and (< pos len)
 326                                (setq chr (aref string pos)
 327                                      num (cond
 328                                           ((and (<= ?0 chr)(<= chr ?9))
 329                                            (- chr ?0))
 330                                           ((and (<= ?A chr)(<= chr ?F))
 331                                            (+ (- chr ?A) 10))
 332                                           ((and (<= ?a chr)(<= chr ?f))
 333                                            (+ (- chr ?a) 10))
 334                                           (t nil)))
 335                                (< num base))
 336                      (setq number (+ (* number base) num)
 337                            pos (1+ pos)))
 338                    (* negative number))))))))))
 339
 340 ;; Emacs 20.1 and 20.2: (concat-chars &rest CHARS)
 341 ;; Emacs 20.3/XEmacs 21.0 and later: (string &rest CHARS)
 342 (static-cond
 343  ((and (fboundp 'string)
 344        (subrp (symbol-function 'string)))
 345   ;; Emacs 20.3/XEmacs 21.0 and later.
 346   )
 347  ((and (fboundp 'concat-chars)
 348        (subrp (symbol-function 'concat-chars)))
 349   ;; Emacs 20.1 and 20.2.
 350   (defalias 'string 'concat-chars))
 351  (t
 352   ;; Use `defun-maybe' to update `load-history'.
 353   (defun-maybe string (&rest chars)
 354     "Concatenate all the argument characters and make the result a string."
 355     ;; We cannot use (apply 'concat chars) here because `concat' does not
 356     ;; work with multibyte chars on Mule 1.* and 2.*.
 357     (mapconcat (function char-to-string) chars ""))))
 358
 359 ;; Mule: (char-before POS)
 360 ;; v20: (char-before &optional POS)
 361 (static-condition-case nil
 362     ;; compile-time check.
 363     (progn
 364       (char-before)
 365       (if (get 'char-before 'defun-maybe)
 366           (error "`char-before' is already defined")))
 367   (wrong-number-of-arguments            ; Mule.
 368    ;; load-time check.
 369    (or (fboundp 'si:char-before)
 370        (progn
 371          (fset 'si:char-before (symbol-function 'char-before))
 372          (put 'char-before 'defun-maybe t)
 373          ;; takes IGNORED for backward compatibility.
 374          (defun char-before (&optional pos ignored)
 375            "\
 376 Return character in current buffer preceding position POS.
 377 POS is an integer or a buffer pointer.
 378 If POS is out of range, the value is nil."
 379            (si:char-before (or pos (point)))))))
 380   (void-function                        ; non-Mule.
 381    ;; load-time check.
 382    (defun-maybe char-before (&optional pos)
 383      "\
 384 Return character in current buffer preceding position POS.
 385 POS is an integer or a buffer pointer.
 386 If POS is out of range, the value is nil."
 387      (if pos
 388          (save-excursion
 389            (and (= (goto-char pos) (point))
 390                 (not (bobp))
 391                 (preceding-char)))
 392        (and (not (bobp))
 393             (preceding-char)))))
 394   (error                                ; found our definition at compile-time.
 395    ;; load-time check.
 396    (condition-case nil
 397        (char-before)
 398      (wrong-number-of-arguments         ; Mule.
 399       (or (fboundp 'si:char-before)
 400           (progn
 401             (fset 'si:char-before (symbol-function 'char-before))
 402             (put 'char-before 'defun-maybe t)
 403             ;; takes IGNORED for backward compatibility.
 404             (defun char-before (&optional pos ignored)
 405               "\
 406 Return character in current buffer preceding position POS.
 407 POS is an integer or a buffer pointer.
 408 If POS is out of range, the value is nil."
 409               (si:char-before (or pos (point)))))))
 410      (void-function                     ; non-Mule.
 411       (defun-maybe char-before (&optional pos)
 412         "\
 413 Return character in current buffer preceding position POS.
 414 POS is an integer or a buffer pointer.
 415 If POS is out of range, the value is nil."
 416         (if pos
 417             (save-excursion
 418               (and (= (goto-char pos) (point))
 419                    (not (bobp))
 420                    (preceding-char)))
 421           (and (not (bobp))
 422                (preceding-char))))))))
 423
 424 ;; v18, v19: (char-after POS)
 425 ;; v20: (char-after &optional POS)
 426 (static-condition-case nil
 427     ;; compile-time check.
 428     (progn
 429       (char-after)
 430       (if (get 'char-after 'defun-maybe)
 431           (error "`char-after' is already redefined")))
 432   (wrong-number-of-arguments            ; v18, v19
 433    ;; load-time check.
 434    (or (fboundp 'si:char-after)
 435        (progn
 436          (fset 'si:char-after (symbol-function 'char-after))
 437          (put 'char-after 'defun-maybe t)
 438          (defun char-after (&optional pos)
 439            "\
 440 Return character in current buffer at position POS.
 441 POS is an integer or a buffer pointer.
 442 If POS is out of range, the value is nil."
 443            (si:char-after (or pos (point)))))))
 444   (void-function                        ; NEVER happen?
 445    ;; load-time check.
 446    (defun-maybe char-after (&optional pos)
 447      "\
 448 Return character in current buffer at position POS.
 449 POS is an integer or a buffer pointer.
 450 If POS is out of range, the value is nil."
 451      (if pos
 452          (save-excursion
 453            (and (= (goto-char pos) (point))
 454                 (not (eobp))
 455                 (following-char)))
 456        (and (not (eobp))
 457             (following-char)))))
 458   (error                                ; found our definition at compile-time.
 459    ;; load-time check.
 460    (condition-case nil
 461        (char-after)
 462      (wrong-number-of-arguments         ; v18, v19
 463       (or (fboundp 'si:char-after)
 464           (progn
 465             (fset 'si:char-after (symbol-function 'char-after))
 466             (put 'char-after 'defun-maybe t)
 467             (defun char-after (&optional pos)
 468               "\
 469 Return character in current buffer at position POS.
 470 POS is an integer or a buffer pointer.
 471 If POS is out of range, the value is nil."
 472               (si:char-after (or pos (point)))))))
 473      (void-function                     ; NEVER happen?
 474       (defun-maybe char-after (&optional pos)
 475         "\
 476 Return character in current buffer at position POS.
 477 POS is an integer or a buffer pointer.
 478 If POS is out of range, the value is nil."
 479         (if pos
 480             (save-excursion
 481               (and (= (goto-char pos) (point))
 482                    (not (eobp))
 483                    (following-char)))
 484           (and (not (eobp))
 485                (following-char))))))))
 486
 487 ;; Emacs 19.29 and later: (buffer-substring-no-properties START END)
 488 (defun-maybe buffer-substring-no-properties (start end)
 489   "Return the characters of part of the buffer, without the text properties.
 490 The two arguments START and END are character positions;
 491 they can be in either order."
 492   (let ((string (buffer-substring start end)))
 493     (set-text-properties 0 (length string) nil string)
 494     string))
 495
 496 ;; Emacs 19.31 and later: (buffer-live-p OBJECT)
 497 (defun-maybe buffer-live-p (object)
 498   "Return non-nil if OBJECT is a buffer which has not been killed.
 499 Value is nil if OBJECT is not a buffer or if it has been killed."
 500   (and object
 501        (get-buffer object)
 502        (buffer-name (get-buffer object))
 503        t))
 504
 505 ;; Emacs 20: (line-beginning-position &optional N)
 506 (defun-maybe line-beginning-position (&optional n)
 507   "Return the character position of the first character on the current line.
 508 With argument N not nil or 1, move forward N - 1 lines first.
 509 If scan reaches end of buffer, return that position.
 510 This function does not move point."
 511   (save-excursion
 512     (forward-line (1- (or n 1)))
 513     (point)))
 514
 515 ;; Emacs 20: (line-end-position &optional N)
 516 (defun-maybe line-end-position (&optional n)
 517   "Return the character position of the last character on the current line.
 518 With argument N not nil or 1, move forward N - 1 lines first.
 519 If scan reaches end of buffer, return that position.
 520 This function does not move point."
 521   (save-excursion
 522     (end-of-line (or n 1))
 523     (point)))
 524
 525 ;; FSF Emacs 19.29 and later
 526 ;; (read-file-name PROMPT &optional DIR DEFAULT-FILENAME MUSTMATCH INITIAL)
 527 ;; XEmacs 19.14 and later:
 528 ;; (read-file-name (PROMPT &optional DIR DEFAULT MUST-MATCH INITIAL-CONTENTS
 529 ;;                         HISTORY)
 530
 531 ;; In FSF Emacs 19.28 and earlier (except for v18) or XEmacs 19.13 and
 532 ;; earlier, this function is incompatible with the other Emacsen.
 533 ;; For instance, if DEFAULT-FILENAME is nil, INITIAL is not and user
 534 ;; enters a null string, it returns the visited file name of the current
 535 ;; buffer if it is non-nil.
 536
 537 ;; It does not assimilate the different numbers of the optional arguments
 538 ;; on various Emacsen (yet).
 539 (static-cond
 540  ((and (not (featurep 'xemacs))
 541        (eq emacs-major-version 19)
 542        (< emacs-minor-version 29))
 543   (if (fboundp 'si:read-file-name)
 544       nil
 545     (fset 'si:read-file-name (symbol-function 'read-file-name))
 546     (defun read-file-name (prompt &optional dir default-filename mustmatch
 547                                   initial)
 548       "Read file name, prompting with PROMPT and completing in directory DIR.
 549 Value is not expanded---you must call `expand-file-name' yourself.
 550 Default name to DEFAULT-FILENAME if user enters a null string.
 551  (If DEFAULT-FILENAME is omitted, the visited file name is used,
 552   except that if INITIAL is specified, that combined with DIR is used.)
 553 Fourth arg MUSTMATCH non-nil means require existing file's name.
 554  Non-nil and non-t means also require confirmation after completion.
 555 Fifth arg INITIAL specifies text to start with.
 556 DIR defaults to current buffer's directory default."
 557       (si:read-file-name prompt dir
 558                          (or default-filename
 559                              (if initial
 560                                  (expand-file-name initial dir)))
 561                          mustmatch initial))))
 562  ((and (featurep 'xemacs)
 563        (eq emacs-major-version 19)
 564        (< emacs-minor-version 14))
 565   (if (fboundp 'si:read-file-name)
 566       nil
 567     (fset 'si:read-file-name (symbol-function 'read-file-name))
 568     (defun read-file-name (prompt &optional dir default must-match
 569                                   initial-contents history)
 570       "Read file name, prompting with PROMPT and completing in directory DIR.
 571 This will prompt with a dialog box if appropriate, according to
 572  `should-use-dialog-box-p'.
 573 Value is not expanded---you must call `expand-file-name' yourself.
 574 Value is subject to interpreted by substitute-in-file-name however.
 575 Default name to DEFAULT if user enters a null string.
 576  (If DEFAULT is omitted, the visited file name is used,
 577   except that if INITIAL-CONTENTS is specified, that combined with DIR is
 578   used.)
 579 Fourth arg MUST-MATCH non-nil means require existing file's name.
 580  Non-nil and non-t means also require confirmation after completion.
 581 Fifth arg INITIAL-CONTENTS specifies text to start with.
 582 Sixth arg HISTORY specifies the history list to use.  Default is
 583  `file-name-history'.
 584 DIR defaults to current buffer's directory default."
 585       (si:read-file-name prompt dir
 586                          (or default
 587                              (if initial-contents
 588                                  (expand-file-name initial-contents dir)))
 589                          must-match initial-contents history)))))
 590 \f
 591
 592 ;;; @ Basic lisp subroutines emulation. (lisp/subr.el)
 593 ;;;
 594
 595 ;;; @@ Lisp language features.
 596
 597 (defmacro-maybe push (newelt listname)
 598   "Add NEWELT to the list stored in the symbol LISTNAME.
 599 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
 600 LISTNAME must be a symbol."
 601   (list 'setq listname
 602         (list 'cons newelt listname)))
 603
 604 (defmacro-maybe pop (listname)
 605   "Return the first element of LISTNAME's value, and remove it from the list.
 606 LISTNAME must be a symbol whose value is a list.
 607 If the value is nil, `pop' returns nil but does not actually
 608 change the list."
 609   (list 'prog1 (list 'car listname)
 610         (list 'setq listname (list 'cdr listname))))
 611
 612 (defmacro-maybe when (cond &rest body)
 613   "If COND yields non-nil, do BODY, else return nil."
 614   (list 'if cond (cons 'progn body)))
 615 ;; (def-edebug-spec when (&rest form))
 616
 617 (defmacro-maybe unless (cond &rest body)
 618   "If COND yields nil, do BODY, else return nil."
 619   (cons 'if (cons cond (cons nil body))))
 620 ;; (def-edebug-spec unless (&rest form))
 621
 622 (defsubst-maybe caar (x)
 623   "Return the car of the car of X."
 624   (car (car x)))
 625
 626 (defsubst-maybe cadr (x)
 627   "Return the car of the cdr of X."
 628   (car (cdr x)))
 629
 630 (defsubst-maybe cdar (x)
 631   "Return the cdr of the car of X."
 632   (cdr (car x)))
 633
 634 (defsubst-maybe cddr (x)
 635   "Return the cdr of the cdr of X."
 636   (cdr (cdr x)))
 637
 638 (defun-maybe last (x &optional n)
 639   "Return the last link of the list X.  Its car is the last element.
 640 If X is nil, return nil.
 641 If N is non-nil, return the Nth-to-last link of X.
 642 If N is bigger than the length of X, return X."
 643   (if n
 644       (let ((m 0) (p x))
 645         (while (consp p)
 646           (setq m (1+ m) p (cdr p)))
 647         (if (<= n 0) p
 648           (if (< n m) (nthcdr (- m n) x) x)))
 649     (while (cdr x)
 650       (setq x (cdr x)))
 651     x))
 652
 653 ;; Actually, `butlast' and `nbutlast' are defined in lisp/cl.el.
 654 (defun-maybe butlast (x &optional n)
 655   "Returns a copy of LIST with the last N elements removed."
 656   (if (and n (<= n 0)) x
 657     (nbutlast (copy-sequence x) n)))
 658
 659 (defun-maybe nbutlast (x &optional n)
 660   "Modifies LIST to remove the last N elements."
 661   (let ((m (length x)))
 662     (or n (setq n 1))
 663     (and (< n m)
 664          (progn
 665            (if (> n 0) (setcdr (nthcdr (- (1- m) n) x) nil))
 666            x))))
 667
 668 ;; Emacs 20.3 and later: (assoc-default KEY ALIST &optional TEST DEFAULT)
 669 (defun-maybe assoc-default (key alist &optional test default)
 670   "Find object KEY in a pseudo-alist ALIST.
 671 ALIST is a list of conses or objects.  Each element (or the element's car,
 672 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
 673 If that is non-nil, the element matches;
 674 then `assoc-default' returns the element's cdr, if it is a cons,
 675 or DEFAULT if the element is not a cons.
 676
 677 If no element matches, the value is nil.
 678 If TEST is omitted or nil, `equal' is used."
 679   (let (found (tail alist) value)
 680     (while (and tail (not found))
 681       (let ((elt (car tail)))
 682         (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
 683           (setq found t value (if (consp elt) (cdr elt) default))))
 684       (setq tail (cdr tail)))
 685     value))
 686
 687 ;; The following two function use `compare-strings', which we don't
 688 ;; support yet.
 689 ;; (defun assoc-ignore-case (key alist))
 690 ;; (defun assoc-ignore-representation (key alist))
 691
 692 ;; Emacs 19.29/XEmacs 19.13 and later: (rassoc KEY LIST)
 693 ;; Actually, `rassoc' is defined in src/fns.c.
 694 (defun-maybe rassoc (key list)
 695   "Return non-nil if KEY is `equal' to the cdr of an element of LIST.
 696 The value is actually the element of LIST whose cdr equals KEY.
 697 Elements of LIST that are not conses are ignored."
 698   (catch 'found
 699     (while list
 700       (cond ((not (consp (car list))))
 701             ((equal (cdr (car list)) key)
 702              (throw 'found (car list))))
 703       (setq list (cdr list)))))
 704
 705 ;; XEmacs 19.13 and later: (remassq KEY LIST)
 706 (defun-maybe remassq (key list)
 707   "Delete by side effect any elements of LIST whose car is `eq' to KEY.
 708 The modified LIST is returned.  If the first member of LIST has a car
 709 that is `eq' to KEY, there is no way to remove it by side effect;
 710 therefore, write `(setq foo (remassq key foo))' to be sure of changing
 711 the value of `foo'."
 712   (if (setq key (assq key list))
 713       (delete key list)
 714     list))
 715
 716 ;; XEmacs 19.13 and later: (remassoc KEY LIST)
 717 (defun-maybe remassoc (key list)
 718   "Delete by side effect any elements of LIST whose car is `equal' to KEY.
 719 The modified LIST is returned.  If the first member of LIST has a car
 720 that is `equal' to KEY, there is no way to remove it by side effect;
 721 therefore, write `(setq foo (remassoc key foo))' to be sure of changing
 722 the value of `foo'."
 723   (if (setq key (assoc key list))
 724       (delete key list)
 725     list))
 726
 727 ;; XEmacs 19.13 and later: (remrassoc VALUE LIST)
 728 (defun-maybe remrassoc (value list)
 729   "Delete by side effect any elements of LIST whose cdr is `equal' to VALUE.
 730 The modified LIST is returned.  If the first member of LIST has a car
 731 that is `equal' to VALUE, there is no way to remove it by side effect;
 732 therefore, write `(setq foo (remrassoc value foo))' to be sure of changing
 733 the value of `foo'."
 734   (if (setq value (rassoc value list))
 735       (delete value list)
 736     list))
 737
 738 ;;; Define `functionp' here because "localhook" uses it.
 739
 740 ;; Emacs 20.1/XEmacs 20.3 (but first appeared in Epoch?): (functionp OBJECT)
 741 (defun-maybe functionp (object)
 742   "Non-nil if OBJECT is a type of object that can be called as a function."
 743   (or (subrp object) (byte-code-function-p object)
 744       (eq (car-safe object) 'lambda)
 745       (and (symbolp object) (fboundp object))))
 746
 747 ;;; @@ Hook manipulation functions.
 748
 749 ;; "localhook" package is written for Emacs 19.28 and earlier.
 750 ;; `run-hooks' was a lisp function in Emacs 19.29 and earlier.
 751 ;; So, in Emacs 19.29, `run-hooks' and others will be overrided.
 752 ;; But, who cares it?
 753 (static-unless (subrp (symbol-function 'run-hooks))
 754   (require 'localhook))
 755
 756 ;; Emacs 19.29/XEmacs 19.14(?) and later: (add-to-list LIST-VAR ELEMENT)
 757 (defun-maybe add-to-list (list-var element)
 758   "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
 759 The test for presence of ELEMENT is done with `equal'.
 760 If you want to use `add-to-list' on a variable that is not defined
 761 until a certain package is loaded, you should put the call to `add-to-list'
 762 into a hook function that will be run only after loading the package.
 763 `eval-after-load' provides one way to do this.  In some cases
 764 other hooks, such as major mode hooks, can do the job."
 765   (or (member element (symbol-value list-var))
 766       (set list-var (cons element (symbol-value list-var)))))
 767
 768 ;; (eval-after-load FILE FORM)
 769 ;; Emacs 19.28 and earlier do not evaluate FORM if FILE is already loaded.
 770 ;; XEmacs 20.2 and earlier have `after-load-alist', but refuse to support
 771 ;; `eval-after-load'. (see comments in XEmacs/lisp/subr.el.)
 772 (static-cond
 773  ((featurep 'xemacs)
 774   ;; for XEmacs 20.2 and earlier.
 775   (defun-maybe eval-after-load (file form)
 776     "Arrange that, if FILE is ever loaded, FORM will be run at that time.
 777 This makes or adds to an entry on `after-load-alist'.
 778 If FILE is already loaded, evaluate FORM right now.
 779 It does nothing if FORM is already on the list for FILE.
 780 FILE should be the name of a library, with no directory name."
 781     ;; Make sure there is an element for FILE.
 782     (or (assoc file after-load-alist)
 783         (setq after-load-alist (cons (list file) after-load-alist)))
 784     ;; Add FORM to the element if it isn't there.
 785     (let ((elt (assoc file after-load-alist)))
 786       (or (member form (cdr elt))
 787           (progn
 788             (nconc elt (list form))
 789             ;; If the file has been loaded already, run FORM right away.
 790             (and (assoc file load-history)
 791                  (eval form)))))
 792     form))
 793  ((>= emacs-major-version 20))
 794  ((and (= emacs-major-version 19)
 795        (< emacs-minor-version 29))
 796   ;; for Emacs 19.28 and earlier.
 797   (defun eval-after-load (file form)
 798     "Arrange that, if FILE is ever loaded, FORM will be run at that time.
 799 This makes or adds to an entry on `after-load-alist'.
 800 If FILE is already loaded, evaluate FORM right now.
 801 It does nothing if FORM is already on the list for FILE.
 802 FILE should be the name of a library, with no directory name."
 803     ;; Make sure there is an element for FILE.
 804     (or (assoc file after-load-alist)
 805         (setq after-load-alist (cons (list file) after-load-alist)))
 806     ;; Add FORM to the element if it isn't there.
 807     (let ((elt (assoc file after-load-alist)))
 808       (or (member form (cdr elt))
 809           (progn
 810             (nconc elt (list form))
 811             ;; If the file has been loaded already, run FORM right away.
 812             (and (assoc file load-history)
 813                  (eval form)))))
 814     form))
 815  (t
 816   ;; should emulate for v18?
 817   ))
 818
 819 (defun-maybe eval-next-after-load (file)
 820   "Read the following input sexp, and run it whenever FILE is loaded.
 821 This makes or adds to an entry on `after-load-alist'.
 822 FILE should be the name of a library, with no directory name."
 823   (eval-after-load file (read)))
 824
 825 ;;; @@ Input and display facilities.
 826
 827 ;; XXX: (defun read-passwd (prompt &optional confirm default))
 828
 829 ;;; @@ Miscellanea.
 830
 831 ;; Avoid compiler warnings about this variable,
 832 ;; which has a special meaning on certain system types.
 833 (defvar-maybe buffer-file-type nil
 834   "Non-nil if the visited file is a binary file.
 835 This variable is meaningful on MS-DOG and Windows NT.
 836 On those systems, it is automatically local in every buffer.
 837 On other systems, this variable is normally always nil.")
 838
 839 ;; Emacs 20.1/XEmacs 20.3(?) and later: (save-current-buffer &rest BODY)
 840 ;;
 841 ;; v20 defines `save-current-buffer' as a C primitive (in src/editfns.c)
 842 ;; and introduces a new bytecode Bsave_current_buffer(_1), replacing an
 843 ;; obsolete bytecode Bread_char.  To make things worse, Emacs 20.1 and
 844 ;; 20.2 have a bug that it will restore the current buffer without
 845 ;; confirming that it is alive.
 846 ;;
 847 ;; This is a source of incompatibility of .elc between v18/v19 and v20.
 848 ;; (XEmacs compiler takes care of it if compatibility mode is enabled.)
 849 (defmacro-maybe save-current-buffer (&rest body)
 850   "Save the current buffer; execute BODY; restore the current buffer.
 851 Executes BODY just like `progn'."
 852   (` (let ((orig-buffer (current-buffer)))
 853        (unwind-protect
 854            (progn (,@ body))
 855          (if (buffer-live-p orig-buffer)
 856              (set-buffer orig-buffer))))))
 857
 858 ;; Emacs 20.1/XEmacs 20.3(?) and later: (with-current-buffer BUFFER &rest BODY)
 859 (defmacro-maybe with-current-buffer (buffer &rest body)
 860   "Execute the forms in BODY with BUFFER as the current buffer.
 861 The value returned is the value of the last form in BODY.
 862 See also `with-temp-buffer'."
 863   (` (save-current-buffer
 864        (set-buffer (, buffer))
 865        (,@ body))))
 866
 867 ;; Emacs 20.1/XEmacs 20.3(?) and later: (with-temp-file FILE &rest FORMS)
 868 (defmacro-maybe with-temp-file (file &rest forms)
 869   "Create a new buffer, evaluate FORMS there, and write the buffer to FILE.
 870 The value of the last form in FORMS is returned, like `progn'.
 871 See also `with-temp-buffer'."
 872   (let ((temp-file (make-symbol "temp-file"))
 873         (temp-buffer (make-symbol "temp-buffer")))
 874     (` (let (((, temp-file) (, file))
 875              ((, temp-buffer)
 876               (get-buffer-create (generate-new-buffer-name " *temp file*"))))
 877          (unwind-protect
 878              (prog1
 879                  (with-current-buffer (, temp-buffer)
 880                    (,@ forms))
 881                (with-current-buffer (, temp-buffer)
 882                  (widen)
 883                  (write-region (point-min) (point-max) (, temp-file) nil 0)))
 884            (and (buffer-name (, temp-buffer))
 885                 (kill-buffer (, temp-buffer))))))))
 886
 887 ;; Emacs 20.4 and later: (with-temp-message MESSAGE &rest BODY)
 888 ;; This macro uses `current-message', which appears in v20.
 889 (static-when (and (fboundp 'current-message)
 890                   (subrp (symbol-function 'current-message)))
 891   (defmacro-maybe with-temp-message (message &rest body)
 892     "\
 893 Display MESSAGE temporarily if non-nil while BODY is evaluated.
 894 The original message is restored to the echo area after BODY has finished.
 895 The value returned is the value of the last form in BODY.
 896 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
 897 If MESSAGE is nil, the echo area and message log buffer are unchanged.
 898 Use a MESSAGE of \"\" to temporarily clear the echo area."
 899     (let ((current-message (make-symbol "current-message"))
 900           (temp-message (make-symbol "with-temp-message")))
 901       (` (let (((, temp-message) (, message))
 902                ((, current-message)))
 903            (unwind-protect
 904                (progn
 905                  (when (, temp-message)
 906                    (setq (, current-message) (current-message))
 907                    (message "%s" (, temp-message))
 908                    (,@ body))
 909                  (and (, temp-message) (, current-message)
 910                       (message "%s" (, current-message))))))))))
 911
 912 ;; Emacs 20.1/XEmacs 20.3(?) and later: (with-temp-buffer &rest FORMS)
 913 (defmacro-maybe with-temp-buffer (&rest forms)
 914   "Create a temporary buffer, and evaluate FORMS there like `progn'.
 915 See also `with-temp-file' and `with-output-to-string'."
 916   (let ((temp-buffer (make-symbol "temp-buffer")))
 917     (` (let (((, temp-buffer)
 918               (get-buffer-create (generate-new-buffer-name " *temp*"))))
 919          (unwind-protect
 920              (with-current-buffer (, temp-buffer)
 921                (,@ forms))
 922            (and (buffer-name (, temp-buffer))
 923                 (kill-buffer (, temp-buffer))))))))
 924
 925 ;; Emacs 20.1/XEmacs 20.3(?) and later: (with-output-to-string &rest BODY)
 926 (defmacro-maybe with-output-to-string (&rest body)
 927   "Execute BODY, return the text it sent to `standard-output', as a string."
 928   (` (let ((standard-output
 929             (get-buffer-create (generate-new-buffer-name " *string-output*"))))
 930        (let ((standard-output standard-output))
 931          (,@ body))
 932        (with-current-buffer standard-output
 933          (prog1
 934              (buffer-string)
 935            (kill-buffer nil))))))
 936
 937 ;; Emacs 20.1 and later: (combine-after-change-calls &rest BODY)
 938 (defmacro-maybe combine-after-change-calls (&rest body)
 939   "Execute BODY, but don't call the after-change functions till the end.
 940 If BODY makes changes in the buffer, they are recorded
 941 and the functions on `after-change-functions' are called several times
 942 when BODY is finished.
 943 The return value is the value of the last form in BODY.
 944
 945 If `before-change-functions' is non-nil, then calls to the after-change
 946 functions can't be deferred, so in that case this macro has no effect.
 947
 948 Do not alter `after-change-functions' or `before-change-functions'
 949 in BODY.
 950
 951 This emulating macro does not support after-change functions at all,
 952 just execute BODY."
 953   (cons 'progn body))
 954
 955 ;; Emacs 19.29/XEmacs 19.14(?) and later: (match-string NUM &optional STRING)
 956 (defun-maybe match-string (num &optional string)
 957   "Return string of text matched by last search.
 958 NUM specifies which parenthesized expression in the last regexp.
 959  Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
 960 Zero means the entire text matched by the whole regexp or whole string.
 961 STRING should be given if the last search was by `string-match' on STRING."
 962   (if (match-beginning num)
 963       (if string
 964           (substring string (match-beginning num) (match-end num))
 965         (buffer-substring (match-beginning num) (match-end num)))))
 966
 967 ;; Emacs 20.3 and later: (match-string-no-properties NUM &optional STRING)
 968 (defun-maybe match-string-no-properties (num &optional string)
 969   "Return string of text matched by last search, without text properties.
 970 NUM specifies which parenthesized expression in the last regexp.
 971  Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
 972 Zero means the entire text matched by the whole regexp or whole string.
 973 STRING should be given if the last search was by `string-match' on STRING."
 974   (if (match-beginning num)
 975       (if string
 976           (let ((result
 977                  (substring string (match-beginning num) (match-end num))))
 978             (set-text-properties 0 (length result) nil result)
 979             result)
 980         (buffer-substring-no-properties (match-beginning num)
 981                                         (match-end num)))))
 982
 983 ;; Emacs 19.28 and earlier
 984 ;;  (replace-match NEWTEXT &optional FIXEDCASE LITERAL)
 985 ;; Emacs 20.x (?) and later
 986 ;;  (replace-match NEWTEXT &optional FIXEDCASE LITERAL STRING SUBEXP)
 987 ;; XEmacs 21:
 988 ;;  (replace-match NEWTEXT &optional FIXEDCASE LITERAL STRING STRBUFFER)
 989 ;; We support following API.
 990 ;;  (replace-match NEWTEXT &optional FIXEDCASE LITERAL STRING)
 991 (static-condition-case nil
 992     ;; compile-time check
 993     (progn
 994       (string-match "" "")
 995       (replace-match "" nil nil "")
 996       (if (get 'replace-match 'defun-maybe)
 997           (error "`replace-match' is already defined")))
 998   (wrong-number-of-arguments ; Emacs 19.28 and earlier
 999    ;; load-time check.
1000    (or (fboundp 'si:replace-match)
1001        (progn
1002          (fset 'si:replace-match (symbol-function 'replace-match))
1003          (put 'replace-match 'defun-maybe t)
1004          (defun replace-match (newtext &optional fixedcase literal string)
1005            "Replace text matched by last search with NEWTEXT.
1006 If second arg FIXEDCASE is non-nil, do not alter case of replacement text.
1007 Otherwise maybe capitalize the whole text, or maybe just word initials,
1008 based on the replaced text.
1009 If the replaced text has only capital letters
1010 and has at least one multiletter word, convert NEWTEXT to all caps.
1011 If the replaced text has at least one word starting with a capital letter,
1012 then capitalize each word in NEWTEXT.
1013
1014 If third arg LITERAL is non-nil, insert NEWTEXT literally.
1015 Otherwise treat `\' as special:
1016   `\&' in NEWTEXT means substitute original matched text.
1017   `\N' means substitute what matched the Nth `\(...\)'.
1018        If Nth parens didn't match, substitute nothing.
1019   `\\' means insert one `\'.
1020 FIXEDCASE and LITERAL are optional arguments.
1021 Leaves point at end of replacement text.
1022
1023 The optional fourth argument STRING can be a string to modify.
1024 In that case, this function creates and returns a new string
1025 which is made by replacing the part of STRING that was matched."
1026            (if string
1027                (with-temp-buffer
1028                 (save-match-data
1029                   (insert string)
1030                   (let* ((matched (match-data))
1031                          (beg (nth 0 matched))
1032                          (end (nth 1 matched)))
1033                     (store-match-data
1034                      (list
1035                       (if (markerp beg)
1036                           (move-marker beg (1+ (match-beginning 0)))
1037                         (1+ (match-beginning 0)))
1038                       (if (markerp end)
1039                           (move-marker end (1+ (match-end 0)))
1040                         (1+ (match-end 0))))))
1041                   (si:replace-match newtext fixedcase literal)
1042                   (buffer-string)))
1043              (si:replace-match newtext fixedcase literal))))))
1044   (error ; found our definition at compile-time.
1045    ;; load-time check.
1046    (condition-case nil
1047     (progn
1048       (string-match "" "")
1049       (replace-match "" nil nil ""))
1050     (wrong-number-of-arguments ; Emacs 19.28 and earlier
1051      ;; load-time check.
1052      (or (fboundp 'si:replace-match)
1053          (progn
1054            (fset 'si:replace-match (symbol-function 'replace-match))
1055            (put 'replace-match 'defun-maybe t)
1056            (defun replace-match (newtext &optional fixedcase literal string)
1057              "Replace text matched by last search with NEWTEXT.
1058 If second arg FIXEDCASE is non-nil, do not alter case of replacement text.
1059 Otherwise maybe capitalize the whole text, or maybe just word initials,
1060 based on the replaced text.
1061 If the replaced text has only capital letters
1062 and has at least one multiletter word, convert NEWTEXT to all caps.
1063 If the replaced text has at least one word starting with a capital letter,
1064 then capitalize each word in NEWTEXT.
1065
1066 If third arg LITERAL is non-nil, insert NEWTEXT literally.
1067 Otherwise treat `\' as special:
1068   `\&' in NEWTEXT means substitute original matched text.
1069   `\N' means substitute what matched the Nth `\(...\)'.
1070        If Nth parens didn't match, substitute nothing.
1071   `\\' means insert one `\'.
1072 FIXEDCASE and LITERAL are optional arguments.
1073 Leaves point at end of replacement text.
1074
1075 The optional fourth argument STRING can be a string to modify.
1076 In that case, this function creates and returns a new string
1077 which is made by replacing the part of STRING that was matched."
1078              (if string
1079                  (with-temp-buffer
1080                   (save-match-data
1081                     (insert string)
1082                     (let* ((matched (match-data))
1083                            (beg (nth 0 matched))
1084                            (end (nth 1 matched)))
1085                       (store-match-data
1086                        (list
1087                         (if (markerp beg)
1088                             (move-marker beg (1+ (match-beginning 0)))
1089                           (1+ (match-beginning 0)))
1090                         (if (markerp end)
1091                             (move-marker end (1+ (match-end 0)))
1092                           (1+ (match-end 0))))))
1093                     (si:replace-match newtext fixedcase literal)
1094                     (buffer-string)))
1095                (si:replace-match newtext fixedcase literal)))))))))
1096
1097 ;; Emacs 20.1/XEmacs 20.3(?) and later: (split-string STRING &optional PATTERN)
1098 ;; Here is a XEmacs version.
1099 (defun-maybe split-string (string &optional pattern)
1100   "Return a list of substrings of STRING which are separated by PATTERN.
1101 If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
1102   (or pattern
1103       (setq pattern "[ \f\t\n\r\v]+"))
1104   ;; The FSF version of this function takes care not to cons in case
1105   ;; of infloop.  Maybe we should synch?
1106   (let (parts (start 0))
1107     (while (string-match pattern string start)
1108       (setq parts (cons (substring string start (match-beginning 0)) parts)
1109             start (match-end 0)))
1110     (nreverse (cons (substring string start) parts))))
1111
1112 ;; Emacs 20.4 and later:
1113 ;;  (subst-char-in-string FROMCHAR TOCHAR STRING &optional INPLACE)
1114 (defun subst-char-in-string (fromchar tochar string &optional inplace)
1115   "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
1116 Unless optional argument INPLACE is non-nil, return a new string."
1117   (let ((i (length string))
1118         (newstr (if inplace string (copy-sequence string))))
1119     (while (> i 0)
1120       (setq i (1- i))
1121       (if (eq (aref newstr i) fromchar)
1122           (aset newstr i tochar)))
1123     newstr))
1124 \f
1125
1126 ;;; @ Window commands emulation. (lisp/window.el)
1127 ;;;
1128
1129 (defmacro-maybe save-selected-window (&rest body)
1130   "Execute BODY, then select the window that was selected before BODY."
1131   (list 'let
1132         '((save-selected-window-window (selected-window)))
1133         (list 'unwind-protect
1134               (cons 'progn body)
1135               (list 'select-window 'save-selected-window-window))))
1136
1137 ;; Emacs 19.31 and later:
1138 ;;  (get-buffer-window-list &optional BUFFER MINIBUF FRAME)
1139 (defun-maybe get-buffer-window-list (buffer &optional minibuf frame)
1140   "Return windows currently displaying BUFFER, or nil if none.
1141 See `walk-windows' for the meaning of MINIBUF and FRAME."
1142   (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows)
1143     (walk-windows
1144      (function (lambda (window)
1145                  (if (eq (window-buffer window) buffer)
1146                      (setq windows (cons window windows)))))
1147      minibuf frame)
1148     windows))
1149 \f
1150
1151 ;;; @ Frame commands emulation. (lisp/frame.el)
1152 ;;;
1153
1154 ;; XEmacs 21.0 and later:
1155 ;;  (save-selected-frame &rest BODY)
1156 (defmacro-maybe save-selected-frame (&rest body)
1157   "Execute forms in BODY, then restore the selected frame."
1158   (list 'let
1159         '((save-selected-frame-frame (selected-frame)))
1160         (list 'unwind-protect
1161               (cons 'progn body)
1162               (list 'select-frame 'save-selected-frame-frame))))
1163 \f
1164
1165 ;;; @ Basic editing commands emulation. (lisp/simple.el)
1166 ;;;
1167 \f
1168
1169 ;;; @ File input and output commands emulation. (lisp/files.el)
1170 ;;;
1171
1172 (defvar-maybe temporary-file-directory
1173   (file-name-as-directory
1174    (cond ((memq system-type '(ms-dos windows-nt))
1175           (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
1176          ((memq system-type '(vax-vms axp-vms))
1177           (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
1178          (t
1179           (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
1180   "The directory for writing temporary files.")
1181
1182 ;; Actually, `path-separator' is defined in src/emacs.c and overrided
1183 ;; in dos-w32.el.
1184 (defvar-maybe path-separator ":"
1185   "The directory separator in search paths, as a string.")
1186
1187 ;; `convert-standard-filename' is defined in lisp/files.el and overrided
1188 ;; in lisp/dos-fns.el and lisp/w32-fns.el for each environment.
1189 (cond
1190  ;; must be load-time check to share .elc between different systems.
1191  ((fboundp 'convert-standard-filename))
1192  ((memq system-type '(windows-nt ms-dos))
1193   ;; should we do (require 'filename) at load-time ?
1194   ;; (require 'filename)
1195   ;; filename.el requires many modules, so we do not want to load it
1196   ;; at compile-time. Instead, suppress warnings by these autoloads.
1197   (eval-when-compile
1198     (autoload 'filename-maybe-truncate-by-size "filename")
1199     (autoload 'filename-special-filter "filename"))
1200   (defun convert-standard-filename (filename)
1201     "Convert a standard file's name to something suitable for the current OS.
1202 This function's standard definition is trivial; it just returns the argument.
1203 However, on some systems, the function is redefined
1204 with a definition that really does change some file names.
1205 Under `windows-nt' or `ms-dos', it refers `filename-replacement-alist' and
1206 `filename-limit-length' for the basic filename and each parent directory name."
1207     (require 'filename)
1208     (let* ((names (split-string filename "/"))
1209            (drive-name (car names))
1210            (filter (function
1211                     (lambda (string)
1212                       (filename-maybe-truncate-by-size
1213                        (filename-special-filter string))))))
1214       (cond
1215        ((eq 1 (length names))
1216         (funcall filter drive-name))
1217        ((string-match "^[^/]:$" drive-name)
1218         (concat drive-name "/" (mapconcat filter (cdr names) "/")))
1219        (t
1220         (mapconcat filter names "/"))))))
1221  (t
1222   (defun convert-standard-filename (filename)
1223     "Convert a standard file's name to something suitable for the current OS.
1224 This function's standard definition is trivial; it just returns the argument.
1225 However, on some systems, the function is redefined
1226 with a definition that really does change some file names.
1227 Under `windows-nt' or `ms-dos', it refers `filename-replacement-alist' and
1228 `filename-limit-length' for the basic filename and each parent directory name."
1229     filename)))
1230
1231 (static-cond
1232  ((fboundp 'insert-file-contents-literally))
1233  ((boundp 'file-name-handler-alist)
1234   ;; Use `defun-maybe' to update `load-history'.
1235   (defun-maybe insert-file-contents-literally (filename &optional visit
1236                                                         beg end replace)
1237     "Like `insert-file-contents', q.v., but only reads in the file.
1238 A buffer may be modified in several ways after reading into the buffer due
1239 to advanced Emacs features, such as file-name-handlers, format decoding,
1240 find-file-hooks, etc.
1241   This function ensures that none of these modifications will take place."
1242     (let (file-name-handler-alist)
1243       (insert-file-contents filename visit beg end replace))))
1244  (t
1245   (defalias 'insert-file-contents-literally 'insert-file-contents)))
1246
1247 (defun-maybe file-name-sans-extension (filename)
1248   "Return FILENAME sans final \"extension\".
1249 The extension, in a file name, is the part that follows the last `.'."
1250   (save-match-data
1251     (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1252           directory)
1253       (if (string-match "\\.[^.]*\\'" file)
1254           (if (setq directory (file-name-directory filename))
1255               (expand-file-name (substring file 0 (match-beginning 0))
1256                                 directory)
1257             (substring file 0 (match-beginning 0)))
1258         filename))))
1259 \f
1260
1261 ;;; @ XEmacs emulation.
1262 ;;;
1263
1264 (defun-maybe find-face (face-or-name)
1265   "Retrieve the face of the given name.
1266 If FACE-OR-NAME is a face object, it is simply returned.
1267 Otherwise, FACE-OR-NAME should be a symbol.  If there is no such face,
1268 nil is returned.  Otherwise the associated face object is returned."
1269   (car (memq face-or-name (face-list))))
1270
1271 ;; Emacs 21.1 defines this as an alias for `line-beginning-position'.
1272 ;; Therefore, optional 2nd arg BUFFER is not portable.
1273 (defun-maybe point-at-bol (&optional n buffer)
1274   "Return the character position of the first character on the current line.
1275 With argument N not nil or 1, move forward N - 1 lines first.
1276 If scan reaches end of buffer, return that position.
1277 This function does not move point."
1278   (save-excursion
1279     (if buffer (set-buffer buffer))
1280     (forward-line (1- (or n 1)))
1281     (point)))
1282
1283 ;; Emacs 21.1 defines this as an alias for `line-end-position'.
1284 ;; Therefore, optional 2nd arg BUFFER is not portable.
1285 (defun-maybe point-at-eol (&optional n buffer)
1286   "Return the character position of the last character on the current line.
1287 With argument N not nil or 1, move forward N - 1 lines first.
1288 If scan reaches end of buffer, return that position.
1289 This function does not move point."
1290   (save-excursion
1291     (if buffer (set-buffer buffer))
1292     (end-of-line (or n 1))
1293     (point)))
1294
1295 (defsubst-maybe define-obsolete-function-alias (oldfun newfun)
1296   "Define OLDFUN as an obsolete alias for function NEWFUN.
1297 This makes calling OLDFUN equivalent to calling NEWFUN and marks OLDFUN
1298 as obsolete."
1299   (defalias oldfun newfun)
1300   (make-obsolete oldfun newfun))
1301
1302 ;; XEmacs 21: (character-to-event CH &optional EVENT DEVICE)
1303 (defun-maybe character-to-event (ch)
1304   "Convert keystroke CH into an event structure, replete with bucky bits.
1305 Note that CH (the keystroke specifier) can be an integer, a character
1306 or a symbol such as 'clear."
1307   ch)
1308
1309 ;; XEmacs 21: (event-to-character EVENT
1310 ;;             &optional ALLOW-EXTRA-MODIFIERS ALLOW-META ALLOW-NON-ASCII)
1311 (defun-maybe-cond event-to-character (event)
1312   "Return the character approximation to the given event object.
1313 If the event isn't a keypress, this returns nil."
1314   ((and (fboundp 'read-event)
1315         (subrp (symbol-function 'read-event)))
1316    ;; Emacs 19 and later.
1317    (cond
1318     ((symbolp event)
1319      ;; mask is (BASE-TYPE MODIFIER-BITS) or nil.
1320      (let ((mask (get event 'event-symbol-element-mask)))
1321        (if mask
1322            (let ((base (get (car mask) 'ascii-character)))
1323              (if base
1324                  (logior base (car (cdr mask))))))))
1325     ((integerp event) event)))
1326   (t
1327    ;; v18. Is this correct?
1328    event))
1329
1330 ;; v18: no event; (read-char)
1331 ;; Emacs 19, 20.1 and 20.2: (read-event)
1332 ;; Emacs 20.3: (read-event &optional PROMPT SUPPRESS-INPUT-METHOD)
1333 ;; Emacs 20.4: (read-event &optional PROMPT INHERIT-INPUT-METHOD)
1334 ;; XEmacs: (next-event &optional EVENT PROMPT),
1335 ;;         (next-command-event &optional EVENT PROMPT)
1336 (defun-maybe-cond next-command-event (&optional event prompt)
1337   "Read an event object from the input stream.
1338 If EVENT is non-nil, it should be an event object and will be filled
1339 in and returned; otherwise a new event object will be created and
1340 returned.
1341 If PROMPT is non-nil, it should be a string and will be displayed in
1342 the echo area while this function is waiting for an event."
1343   ((and (>= emacs-major-version 20)
1344         (>= emacs-minor-version 4))
1345    ;; Emacs 20.4 and later.
1346    (read-event prompt))                 ; should specify 2nd arg?
1347   ((and (= emacs-major-version 20)
1348         (= emacs-minor-version 3))
1349    ;; Emacs 20.3.
1350    (read-event prompt))                 ; should specify 2nd arg?
1351   ((and (fboundp 'read-event)
1352         (subrp (symbol-function 'read-event)))
1353    ;; Emacs 19, 20.1 and 20.2.
1354    (if prompt (message prompt))
1355    (read-event))
1356   (t
1357    (if prompt (message prompt))
1358    (read-char)))
1359 \f
1360
1361 ;;; @ MULE 2 emulation.
1362 ;;;
1363
1364 (defun-maybe-cond cancel-undo-boundary ()
1365   "Cancel undo boundary."
1366   ((boundp 'buffer-undo-list)
1367    ;; for Emacs 19 and later.
1368    (if (and (consp buffer-undo-list)
1369             (null (car buffer-undo-list)))
1370        (setq buffer-undo-list (cdr buffer-undo-list)))))
1371 \f
1372
1373 ;;; @ End.
1374 ;;;
1375
1376 ;;; poe.el ends here