| 1 | ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8; lexical-binding:t -*- |
| 2 | |
| 3 | ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2014 Free Software |
| 4 | ;; Foundation, Inc. |
| 5 | |
| 6 | ;; Maintainer: FSF |
| 7 | ;; Keywords: internal |
| 8 | ;; Package: emacs |
| 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 of the License, or |
| 15 | ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>. |
| 24 | |
| 25 | ;;; Commentary: |
| 26 | |
| 27 | ;;; Code: |
| 28 | |
| 29 | ;; Beware: while this file has tag `utf-8', before it's compiled, it gets |
| 30 | ;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap. |
| 31 | |
| 32 | (defmacro declare-function (_fn _file &optional _arglist _fileonly) |
| 33 | "Tell the byte-compiler that function FN is defined, in FILE. |
| 34 | Optional ARGLIST is the argument list used by the function. |
| 35 | The FILE argument is not used by the byte-compiler, but by the |
| 36 | `check-declare' package, which checks that FILE contains a |
| 37 | definition for FN. ARGLIST is used by both the byte-compiler |
| 38 | and `check-declare' to check for consistency. |
| 39 | |
| 40 | FILE can be either a Lisp file (in which case the \".el\" |
| 41 | extension is optional), or a C file. C files are expanded |
| 42 | relative to the Emacs \"src/\" directory. Lisp files are |
| 43 | searched for using `locate-library', and if that fails they are |
| 44 | expanded relative to the location of the file containing the |
| 45 | declaration. A FILE with an \"ext:\" prefix is an external file. |
| 46 | `check-declare' will check such files if they are found, and skip |
| 47 | them without error if they are not. |
| 48 | |
| 49 | FILEONLY non-nil means that `check-declare' will only check that |
| 50 | FILE exists, not that it defines FN. This is intended for |
| 51 | function-definitions that `check-declare' does not recognize, e.g. |
| 52 | `defstruct'. |
| 53 | |
| 54 | To specify a value for FILEONLY without passing an argument list, |
| 55 | set ARGLIST to t. This is necessary because nil means an |
| 56 | empty argument list, rather than an unspecified one. |
| 57 | |
| 58 | Note that for the purposes of `check-declare', this statement |
| 59 | must be the first non-whitespace on a line. |
| 60 | |
| 61 | For more information, see Info node `(elisp)Declaring Functions'." |
| 62 | ;; Does nothing - byte-compile-declare-function does the work. |
| 63 | nil) |
| 64 | |
| 65 | \f |
| 66 | ;;;; Basic Lisp macros. |
| 67 | |
| 68 | (defalias 'not 'null) |
| 69 | |
| 70 | (defmacro noreturn (form) |
| 71 | "Evaluate FORM, expecting it not to return. |
| 72 | If FORM does return, signal an error." |
| 73 | (declare (debug t)) |
| 74 | `(prog1 ,form |
| 75 | (error "Form marked with `noreturn' did return"))) |
| 76 | |
| 77 | (defmacro 1value (form) |
| 78 | "Evaluate FORM, expecting a constant return value. |
| 79 | This is the global do-nothing version. There is also `testcover-1value' |
| 80 | that complains if FORM ever does return differing values." |
| 81 | (declare (debug t)) |
| 82 | form) |
| 83 | |
| 84 | (defmacro def-edebug-spec (symbol spec) |
| 85 | "Set the `edebug-form-spec' property of SYMBOL according to SPEC. |
| 86 | Both SYMBOL and SPEC are unevaluated. The SPEC can be: |
| 87 | 0 (instrument no arguments); t (instrument all arguments); |
| 88 | a symbol (naming a function with an Edebug specification); or a list. |
| 89 | The elements of the list describe the argument types; see |
| 90 | Info node `(elisp)Specification List' for details." |
| 91 | `(put (quote ,symbol) 'edebug-form-spec (quote ,spec))) |
| 92 | |
| 93 | (defmacro lambda (&rest cdr) |
| 94 | "Return a lambda expression. |
| 95 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is |
| 96 | self-quoting; the result of evaluating the lambda expression is the |
| 97 | expression itself. The lambda expression may then be treated as a |
| 98 | function, i.e., stored as the function value of a symbol, passed to |
| 99 | `funcall' or `mapcar', etc. |
| 100 | |
| 101 | ARGS should take the same form as an argument list for a `defun'. |
| 102 | DOCSTRING is an optional documentation string. |
| 103 | If present, it should describe how to call the function. |
| 104 | But documentation strings are usually not useful in nameless functions. |
| 105 | INTERACTIVE should be a call to the function `interactive', which see. |
| 106 | It may also be omitted. |
| 107 | BODY should be a list of Lisp expressions. |
| 108 | |
| 109 | \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)" |
| 110 | (declare (doc-string 2) (indent defun) |
| 111 | (debug (&define lambda-list |
| 112 | [&optional stringp] |
| 113 | [&optional ("interactive" interactive)] |
| 114 | def-body))) |
| 115 | ;; Note that this definition should not use backquotes; subr.el should not |
| 116 | ;; depend on backquote.el. |
| 117 | (list 'function (cons 'lambda cdr))) |
| 118 | |
| 119 | (defmacro setq-local (var val) |
| 120 | "Set variable VAR to value VAL in current buffer." |
| 121 | ;; Can't use backquote here, it's too early in the bootstrap. |
| 122 | (list 'set (list 'make-local-variable (list 'quote var)) val)) |
| 123 | |
| 124 | (defmacro defvar-local (var val &optional docstring) |
| 125 | "Define VAR as a buffer-local variable with default value VAL. |
| 126 | Like `defvar' but additionally marks the variable as being automatically |
| 127 | buffer-local wherever it is set." |
| 128 | (declare (debug defvar) (doc-string 3)) |
| 129 | ;; Can't use backquote here, it's too early in the bootstrap. |
| 130 | (list 'progn (list 'defvar var val docstring) |
| 131 | (list 'make-variable-buffer-local (list 'quote var)))) |
| 132 | |
| 133 | (defun apply-partially (fun &rest args) |
| 134 | "Return a function that is a partial application of FUN to ARGS. |
| 135 | ARGS is a list of the first N arguments to pass to FUN. |
| 136 | The result is a new function which does the same as FUN, except that |
| 137 | the first N arguments are fixed at the values with which this function |
| 138 | was called." |
| 139 | `(closure (t) (&rest args) |
| 140 | (apply ',fun ,@(mapcar (lambda (arg) `',arg) args) args))) |
| 141 | |
| 142 | (defmacro push (newelt place) |
| 143 | "Add NEWELT to the list stored in the generalized variable PLACE. |
| 144 | This is morally equivalent to (setf PLACE (cons NEWELT PLACE)), |
| 145 | except that PLACE is only evaluated once (after NEWELT)." |
| 146 | (declare (debug (form gv-place))) |
| 147 | (if (symbolp place) |
| 148 | ;; Important special case, to avoid triggering GV too early in |
| 149 | ;; the bootstrap. |
| 150 | (list 'setq place |
| 151 | (list 'cons newelt place)) |
| 152 | (require 'macroexp) |
| 153 | (macroexp-let2 macroexp-copyable-p v newelt |
| 154 | (gv-letplace (getter setter) place |
| 155 | (funcall setter `(cons ,v ,getter)))))) |
| 156 | |
| 157 | (defmacro pop (place) |
| 158 | "Return the first element of PLACE's value, and remove it from the list. |
| 159 | PLACE must be a generalized variable whose value is a list. |
| 160 | If the value is nil, `pop' returns nil but does not actually |
| 161 | change the list." |
| 162 | (declare (debug (gv-place))) |
| 163 | ;; We use `car-safe' here instead of `car' because the behavior is the same |
| 164 | ;; (if it's not a cons cell, the `cdr' would have signaled an error already), |
| 165 | ;; but `car-safe' is total, so the byte-compiler can safely remove it if the |
| 166 | ;; result is not used. |
| 167 | `(car-safe |
| 168 | ,(if (symbolp place) |
| 169 | ;; So we can use `pop' in the bootstrap before `gv' can be used. |
| 170 | (list 'prog1 place (list 'setq place (list 'cdr place))) |
| 171 | (gv-letplace (getter setter) place |
| 172 | `(prog1 ,getter ,(funcall setter `(cdr ,getter))))))) |
| 173 | |
| 174 | (defmacro when (cond &rest body) |
| 175 | "If COND yields non-nil, do BODY, else return nil. |
| 176 | When COND yields non-nil, eval BODY forms sequentially and return |
| 177 | value of last one, or nil if there are none. |
| 178 | |
| 179 | \(fn COND BODY...)" |
| 180 | (declare (indent 1) (debug t)) |
| 181 | (list 'if cond (cons 'progn body))) |
| 182 | |
| 183 | (defmacro unless (cond &rest body) |
| 184 | "If COND yields nil, do BODY, else return nil. |
| 185 | When COND yields nil, eval BODY forms sequentially and return |
| 186 | value of last one, or nil if there are none. |
| 187 | |
| 188 | \(fn COND BODY...)" |
| 189 | (declare (indent 1) (debug t)) |
| 190 | (cons 'if (cons cond (cons nil body)))) |
| 191 | |
| 192 | (defmacro dolist (spec &rest body) |
| 193 | "Loop over a list. |
| 194 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
| 195 | Then evaluate RESULT to get return value, default nil. |
| 196 | |
| 197 | \(fn (VAR LIST [RESULT]) BODY...)" |
| 198 | (declare (indent 1) (debug ((symbolp form &optional form) body))) |
| 199 | ;; It would be cleaner to create an uninterned symbol, |
| 200 | ;; but that uses a lot more space when many functions in many files |
| 201 | ;; use dolist. |
| 202 | ;; FIXME: This cost disappears in byte-compiled lexical-binding files. |
| 203 | (let ((temp '--dolist-tail--)) |
| 204 | ;; This is not a reliable test, but it does not matter because both |
| 205 | ;; semantics are acceptable, tho one is slightly faster with dynamic |
| 206 | ;; scoping and the other is slightly faster (and has cleaner semantics) |
| 207 | ;; with lexical scoping. |
| 208 | (if lexical-binding |
| 209 | `(let ((,temp ,(nth 1 spec))) |
| 210 | (while ,temp |
| 211 | (let ((,(car spec) (car ,temp))) |
| 212 | ,@body |
| 213 | (setq ,temp (cdr ,temp)))) |
| 214 | ,@(cdr (cdr spec))) |
| 215 | `(let ((,temp ,(nth 1 spec)) |
| 216 | ,(car spec)) |
| 217 | (while ,temp |
| 218 | (setq ,(car spec) (car ,temp)) |
| 219 | ,@body |
| 220 | (setq ,temp (cdr ,temp))) |
| 221 | ,@(if (cdr (cdr spec)) |
| 222 | `((setq ,(car spec) nil) ,@(cdr (cdr spec)))))))) |
| 223 | |
| 224 | (defmacro dotimes (spec &rest body) |
| 225 | "Loop a certain number of times. |
| 226 | Evaluate BODY with VAR bound to successive integers running from 0, |
| 227 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get |
| 228 | the return value (nil if RESULT is omitted). |
| 229 | |
| 230 | \(fn (VAR COUNT [RESULT]) BODY...)" |
| 231 | (declare (indent 1) (debug dolist)) |
| 232 | ;; It would be cleaner to create an uninterned symbol, |
| 233 | ;; but that uses a lot more space when many functions in many files |
| 234 | ;; use dotimes. |
| 235 | ;; FIXME: This cost disappears in byte-compiled lexical-binding files. |
| 236 | (let ((temp '--dotimes-limit--) |
| 237 | (start 0) |
| 238 | (end (nth 1 spec))) |
| 239 | ;; This is not a reliable test, but it does not matter because both |
| 240 | ;; semantics are acceptable, tho one is slightly faster with dynamic |
| 241 | ;; scoping and the other has cleaner semantics. |
| 242 | (if lexical-binding |
| 243 | (let ((counter '--dotimes-counter--)) |
| 244 | `(let ((,temp ,end) |
| 245 | (,counter ,start)) |
| 246 | (while (< ,counter ,temp) |
| 247 | (let ((,(car spec) ,counter)) |
| 248 | ,@body) |
| 249 | (setq ,counter (1+ ,counter))) |
| 250 | ,@(if (cddr spec) |
| 251 | ;; FIXME: This let often leads to "unused var" warnings. |
| 252 | `((let ((,(car spec) ,counter)) ,@(cddr spec)))))) |
| 253 | `(let ((,temp ,end) |
| 254 | (,(car spec) ,start)) |
| 255 | (while (< ,(car spec) ,temp) |
| 256 | ,@body |
| 257 | (setq ,(car spec) (1+ ,(car spec)))) |
| 258 | ,@(cdr (cdr spec)))))) |
| 259 | |
| 260 | (defmacro declare (&rest _specs) |
| 261 | "Do not evaluate any arguments, and return nil. |
| 262 | If a `declare' form appears as the first form in the body of a |
| 263 | `defun' or `defmacro' form, SPECS specifies various additional |
| 264 | information about the function or macro; these go into effect |
| 265 | during the evaluation of the `defun' or `defmacro' form. |
| 266 | |
| 267 | The possible values of SPECS are specified by |
| 268 | `defun-declarations-alist' and `macro-declarations-alist'." |
| 269 | ;; FIXME: edebug spec should pay attention to defun-declarations-alist. |
| 270 | nil) |
| 271 | |
| 272 | (defmacro ignore-errors (&rest body) |
| 273 | "Execute BODY; if an error occurs, return nil. |
| 274 | Otherwise, return result of last form in BODY. |
| 275 | See also `with-demoted-errors' that does something similar |
| 276 | without silencing all errors." |
| 277 | (declare (debug t) (indent 0)) |
| 278 | `(condition-case nil (progn ,@body) (error nil))) |
| 279 | \f |
| 280 | ;;;; Basic Lisp functions. |
| 281 | |
| 282 | (defun ignore (&rest _ignore) |
| 283 | "Do nothing and return nil. |
| 284 | This function accepts any number of arguments, but ignores them." |
| 285 | (interactive) |
| 286 | nil) |
| 287 | |
| 288 | ;; Signal a compile-error if the first arg is missing. |
| 289 | (defun error (&rest args) |
| 290 | "Signal an error, making error message by passing all args to `format'. |
| 291 | In Emacs, the convention is that error messages start with a capital |
| 292 | letter but *do not* end with a period. Please follow this convention |
| 293 | for the sake of consistency." |
| 294 | (declare (advertised-calling-convention (string &rest args) "23.1")) |
| 295 | (signal 'error (list (apply 'format args)))) |
| 296 | |
| 297 | (defun user-error (format &rest args) |
| 298 | "Signal a pilot error, making error message by passing all args to `format'. |
| 299 | In Emacs, the convention is that error messages start with a capital |
| 300 | letter but *do not* end with a period. Please follow this convention |
| 301 | for the sake of consistency. |
| 302 | This is just like `error' except that `user-error's are expected to be the |
| 303 | result of an incorrect manipulation on the part of the user, rather than the |
| 304 | result of an actual problem." |
| 305 | (signal 'user-error (list (apply #'format format args)))) |
| 306 | |
| 307 | (defun define-error (name message &optional parent) |
| 308 | "Define NAME as a new error signal. |
| 309 | MESSAGE is a string that will be output to the echo area if such an error |
| 310 | is signaled without being caught by a `condition-case'. |
| 311 | PARENT is either a signal or a list of signals from which it inherits. |
| 312 | Defaults to `error'." |
| 313 | (unless parent (setq parent 'error)) |
| 314 | (let ((conditions |
| 315 | (if (consp parent) |
| 316 | (apply #'nconc |
| 317 | (mapcar (lambda (parent) |
| 318 | (cons parent |
| 319 | (or (get parent 'error-conditions) |
| 320 | (error "Unknown signal `%s'" parent)))) |
| 321 | parent)) |
| 322 | (cons parent (get parent 'error-conditions))))) |
| 323 | (put name 'error-conditions |
| 324 | (delete-dups (copy-sequence (cons name conditions)))) |
| 325 | (when message (put name 'error-message message)))) |
| 326 | |
| 327 | ;; We put this here instead of in frame.el so that it's defined even on |
| 328 | ;; systems where frame.el isn't loaded. |
| 329 | (defun frame-configuration-p (object) |
| 330 | "Return non-nil if OBJECT seems to be a frame configuration. |
| 331 | Any list whose car is `frame-configuration' is assumed to be a frame |
| 332 | configuration." |
| 333 | (and (consp object) |
| 334 | (eq (car object) 'frame-configuration))) |
| 335 | \f |
| 336 | ;;;; List functions. |
| 337 | |
| 338 | (defsubst caar (x) |
| 339 | "Return the car of the car of X." |
| 340 | (car (car x))) |
| 341 | |
| 342 | (defsubst cadr (x) |
| 343 | "Return the car of the cdr of X." |
| 344 | (car (cdr x))) |
| 345 | |
| 346 | (defsubst cdar (x) |
| 347 | "Return the cdr of the car of X." |
| 348 | (cdr (car x))) |
| 349 | |
| 350 | (defsubst cddr (x) |
| 351 | "Return the cdr of the cdr of X." |
| 352 | (cdr (cdr x))) |
| 353 | |
| 354 | (defun last (list &optional n) |
| 355 | "Return the last link of LIST. Its car is the last element. |
| 356 | If LIST is nil, return nil. |
| 357 | If N is non-nil, return the Nth-to-last link of LIST. |
| 358 | If N is bigger than the length of LIST, return LIST." |
| 359 | (if n |
| 360 | (and (>= n 0) |
| 361 | (let ((m (safe-length list))) |
| 362 | (if (< n m) (nthcdr (- m n) list) list))) |
| 363 | (and list |
| 364 | (nthcdr (1- (safe-length list)) list)))) |
| 365 | |
| 366 | (defun butlast (list &optional n) |
| 367 | "Return a copy of LIST with the last N elements removed. |
| 368 | If N is omitted or nil, the last element is removed from the |
| 369 | copy." |
| 370 | (if (and n (<= n 0)) list |
| 371 | (nbutlast (copy-sequence list) n))) |
| 372 | |
| 373 | (defun nbutlast (list &optional n) |
| 374 | "Modifies LIST to remove the last N elements. |
| 375 | If N is omitted or nil, remove the last element." |
| 376 | (let ((m (length list))) |
| 377 | (or n (setq n 1)) |
| 378 | (and (< n m) |
| 379 | (progn |
| 380 | (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil)) |
| 381 | list)))) |
| 382 | |
| 383 | (defun delete-dups (list) |
| 384 | "Destructively remove `equal' duplicates from LIST. |
| 385 | Store the result in LIST and return it. LIST must be a proper list. |
| 386 | Of several `equal' occurrences of an element in LIST, the first |
| 387 | one is kept." |
| 388 | (let ((tail list)) |
| 389 | (while tail |
| 390 | (setcdr tail (delete (car tail) (cdr tail))) |
| 391 | (setq tail (cdr tail)))) |
| 392 | list) |
| 393 | |
| 394 | ;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html |
| 395 | (defun delete-consecutive-dups (list &optional circular) |
| 396 | "Destructively remove `equal' consecutive duplicates from LIST. |
| 397 | First and last elements are considered consecutive if CIRCULAR is |
| 398 | non-nil." |
| 399 | (let ((tail list) last) |
| 400 | (while (consp tail) |
| 401 | (if (equal (car tail) (cadr tail)) |
| 402 | (setcdr tail (cddr tail)) |
| 403 | (setq last (car tail) |
| 404 | tail (cdr tail)))) |
| 405 | (if (and circular |
| 406 | (cdr list) |
| 407 | (equal last (car list))) |
| 408 | (nbutlast list) |
| 409 | list))) |
| 410 | |
| 411 | (defun number-sequence (from &optional to inc) |
| 412 | "Return a sequence of numbers from FROM to TO (both inclusive) as a list. |
| 413 | INC is the increment used between numbers in the sequence and defaults to 1. |
| 414 | So, the Nth element of the list is (+ FROM (* N INC)) where N counts from |
| 415 | zero. TO is only included if there is an N for which TO = FROM + N * INC. |
| 416 | If TO is nil or numerically equal to FROM, return (FROM). |
| 417 | If INC is positive and TO is less than FROM, or INC is negative |
| 418 | and TO is larger than FROM, return nil. |
| 419 | If INC is zero and TO is neither nil nor numerically equal to |
| 420 | FROM, signal an error. |
| 421 | |
| 422 | This function is primarily designed for integer arguments. |
| 423 | Nevertheless, FROM, TO and INC can be integer or float. However, |
| 424 | floating point arithmetic is inexact. For instance, depending on |
| 425 | the machine, it may quite well happen that |
| 426 | \(number-sequence 0.4 0.6 0.2) returns the one element list (0.4), |
| 427 | whereas (number-sequence 0.4 0.8 0.2) returns a list with three |
| 428 | elements. Thus, if some of the arguments are floats and one wants |
| 429 | to make sure that TO is included, one may have to explicitly write |
| 430 | TO as (+ FROM (* N INC)) or use a variable whose value was |
| 431 | computed with this exact expression. Alternatively, you can, |
| 432 | of course, also replace TO with a slightly larger value |
| 433 | \(or a slightly more negative value if INC is negative)." |
| 434 | (if (or (not to) (= from to)) |
| 435 | (list from) |
| 436 | (or inc (setq inc 1)) |
| 437 | (when (zerop inc) (error "The increment can not be zero")) |
| 438 | (let (seq (n 0) (next from)) |
| 439 | (if (> inc 0) |
| 440 | (while (<= next to) |
| 441 | (setq seq (cons next seq) |
| 442 | n (1+ n) |
| 443 | next (+ from (* n inc)))) |
| 444 | (while (>= next to) |
| 445 | (setq seq (cons next seq) |
| 446 | n (1+ n) |
| 447 | next (+ from (* n inc))))) |
| 448 | (nreverse seq)))) |
| 449 | |
| 450 | (defun copy-tree (tree &optional vecp) |
| 451 | "Make a copy of TREE. |
| 452 | If TREE is a cons cell, this recursively copies both its car and its cdr. |
| 453 | Contrast to `copy-sequence', which copies only along the cdrs. With second |
| 454 | argument VECP, this copies vectors as well as conses." |
| 455 | (if (consp tree) |
| 456 | (let (result) |
| 457 | (while (consp tree) |
| 458 | (let ((newcar (car tree))) |
| 459 | (if (or (consp (car tree)) (and vecp (vectorp (car tree)))) |
| 460 | (setq newcar (copy-tree (car tree) vecp))) |
| 461 | (push newcar result)) |
| 462 | (setq tree (cdr tree))) |
| 463 | (nconc (nreverse result) tree)) |
| 464 | (if (and vecp (vectorp tree)) |
| 465 | (let ((i (length (setq tree (copy-sequence tree))))) |
| 466 | (while (>= (setq i (1- i)) 0) |
| 467 | (aset tree i (copy-tree (aref tree i) vecp))) |
| 468 | tree) |
| 469 | tree))) |
| 470 | \f |
| 471 | ;;;; Various list-search functions. |
| 472 | |
| 473 | (defun assoc-default (key alist &optional test default) |
| 474 | "Find object KEY in a pseudo-alist ALIST. |
| 475 | ALIST is a list of conses or objects. Each element |
| 476 | (or the element's car, if it is a cons) is compared with KEY by |
| 477 | calling TEST, with two arguments: (i) the element or its car, |
| 478 | and (ii) KEY. |
| 479 | If that is non-nil, the element matches; then `assoc-default' |
| 480 | returns the element's cdr, if it is a cons, or DEFAULT if the |
| 481 | element is not a cons. |
| 482 | |
| 483 | If no element matches, the value is nil. |
| 484 | If TEST is omitted or nil, `equal' is used." |
| 485 | (let (found (tail alist) value) |
| 486 | (while (and tail (not found)) |
| 487 | (let ((elt (car tail))) |
| 488 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) |
| 489 | (setq found t value (if (consp elt) (cdr elt) default)))) |
| 490 | (setq tail (cdr tail))) |
| 491 | value)) |
| 492 | |
| 493 | (defun assoc-ignore-case (key alist) |
| 494 | "Like `assoc', but ignores differences in case and text representation. |
| 495 | KEY must be a string. Upper-case and lower-case letters are treated as equal. |
| 496 | Unibyte strings are converted to multibyte for comparison." |
| 497 | (declare (obsolete assoc-string "22.1")) |
| 498 | (assoc-string key alist t)) |
| 499 | |
| 500 | (defun assoc-ignore-representation (key alist) |
| 501 | "Like `assoc', but ignores differences in text representation. |
| 502 | KEY must be a string. |
| 503 | Unibyte strings are converted to multibyte for comparison." |
| 504 | (declare (obsolete assoc-string "22.1")) |
| 505 | (assoc-string key alist nil)) |
| 506 | |
| 507 | (defun member-ignore-case (elt list) |
| 508 | "Like `member', but ignore differences in case and text representation. |
| 509 | ELT must be a string. Upper-case and lower-case letters are treated as equal. |
| 510 | Unibyte strings are converted to multibyte for comparison. |
| 511 | Non-strings in LIST are ignored." |
| 512 | (while (and list |
| 513 | (not (and (stringp (car list)) |
| 514 | (eq t (compare-strings elt 0 nil (car list) 0 nil t))))) |
| 515 | (setq list (cdr list))) |
| 516 | list) |
| 517 | |
| 518 | (defun assq-delete-all (key alist) |
| 519 | "Delete from ALIST all elements whose car is `eq' to KEY. |
| 520 | Return the modified alist. |
| 521 | Elements of ALIST that are not conses are ignored." |
| 522 | (while (and (consp (car alist)) |
| 523 | (eq (car (car alist)) key)) |
| 524 | (setq alist (cdr alist))) |
| 525 | (let ((tail alist) tail-cdr) |
| 526 | (while (setq tail-cdr (cdr tail)) |
| 527 | (if (and (consp (car tail-cdr)) |
| 528 | (eq (car (car tail-cdr)) key)) |
| 529 | (setcdr tail (cdr tail-cdr)) |
| 530 | (setq tail tail-cdr)))) |
| 531 | alist) |
| 532 | |
| 533 | (defun rassq-delete-all (value alist) |
| 534 | "Delete from ALIST all elements whose cdr is `eq' to VALUE. |
| 535 | Return the modified alist. |
| 536 | Elements of ALIST that are not conses are ignored." |
| 537 | (while (and (consp (car alist)) |
| 538 | (eq (cdr (car alist)) value)) |
| 539 | (setq alist (cdr alist))) |
| 540 | (let ((tail alist) tail-cdr) |
| 541 | (while (setq tail-cdr (cdr tail)) |
| 542 | (if (and (consp (car tail-cdr)) |
| 543 | (eq (cdr (car tail-cdr)) value)) |
| 544 | (setcdr tail (cdr tail-cdr)) |
| 545 | (setq tail tail-cdr)))) |
| 546 | alist) |
| 547 | |
| 548 | (defun remove (elt seq) |
| 549 | "Return a copy of SEQ with all occurrences of ELT removed. |
| 550 | SEQ must be a list, vector, or string. The comparison is done with `equal'." |
| 551 | (if (nlistp seq) |
| 552 | ;; If SEQ isn't a list, there's no need to copy SEQ because |
| 553 | ;; `delete' will return a new object. |
| 554 | (delete elt seq) |
| 555 | (delete elt (copy-sequence seq)))) |
| 556 | |
| 557 | (defun remq (elt list) |
| 558 | "Return LIST with all occurrences of ELT removed. |
| 559 | The comparison is done with `eq'. Contrary to `delq', this does not use |
| 560 | side-effects, and the argument LIST is not modified." |
| 561 | (while (and (eq elt (car list)) (setq list (cdr list)))) |
| 562 | (if (memq elt list) |
| 563 | (delq elt (copy-sequence list)) |
| 564 | list)) |
| 565 | \f |
| 566 | ;;;; Keymap support. |
| 567 | |
| 568 | (defun kbd (keys) |
| 569 | "Convert KEYS to the internal Emacs key representation. |
| 570 | KEYS should be a string constant in the format used for |
| 571 | saving keyboard macros (see `edmacro-mode')." |
| 572 | ;; Don't use a defalias, since the `pure' property is only true for |
| 573 | ;; the calling convention of `kbd'. |
| 574 | (read-kbd-macro keys)) |
| 575 | (put 'kbd 'pure t) |
| 576 | |
| 577 | (defun undefined () |
| 578 | "Beep to tell the user this binding is undefined." |
| 579 | (interactive) |
| 580 | (ding) |
| 581 | (message "%s is undefined" (key-description (this-single-command-keys))) |
| 582 | (setq defining-kbd-macro nil) |
| 583 | (force-mode-line-update) |
| 584 | ;; If this is a down-mouse event, don't reset prefix-arg; |
| 585 | ;; pass it to the command run by the up event. |
| 586 | (setq prefix-arg |
| 587 | (when (memq 'down (event-modifiers last-command-event)) |
| 588 | current-prefix-arg))) |
| 589 | |
| 590 | ;; Prevent the \{...} documentation construct |
| 591 | ;; from mentioning keys that run this command. |
| 592 | (put 'undefined 'suppress-keymap t) |
| 593 | |
| 594 | (defun suppress-keymap (map &optional nodigits) |
| 595 | "Make MAP override all normally self-inserting keys to be undefined. |
| 596 | Normally, as an exception, digits and minus-sign are set to make prefix args, |
| 597 | but optional second arg NODIGITS non-nil treats them like other chars." |
| 598 | (define-key map [remap self-insert-command] 'undefined) |
| 599 | (or nodigits |
| 600 | (let (loop) |
| 601 | (define-key map "-" 'negative-argument) |
| 602 | ;; Make plain numbers do numeric args. |
| 603 | (setq loop ?0) |
| 604 | (while (<= loop ?9) |
| 605 | (define-key map (char-to-string loop) 'digit-argument) |
| 606 | (setq loop (1+ loop)))))) |
| 607 | |
| 608 | (defun make-composed-keymap (maps &optional parent) |
| 609 | "Construct a new keymap composed of MAPS and inheriting from PARENT. |
| 610 | When looking up a key in the returned map, the key is looked in each |
| 611 | keymap of MAPS in turn until a binding is found. |
| 612 | If no binding is found in MAPS, the lookup continues in PARENT, if non-nil. |
| 613 | As always with keymap inheritance, a nil binding in MAPS overrides |
| 614 | any corresponding binding in PARENT, but it does not override corresponding |
| 615 | bindings in other keymaps of MAPS. |
| 616 | MAPS can be a list of keymaps or a single keymap. |
| 617 | PARENT if non-nil should be a keymap." |
| 618 | `(keymap |
| 619 | ,@(if (keymapp maps) (list maps) maps) |
| 620 | ,@parent)) |
| 621 | |
| 622 | (defun define-key-after (keymap key definition &optional after) |
| 623 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
| 624 | This is like `define-key' except that the binding for KEY is placed |
| 625 | just after the binding for the event AFTER, instead of at the beginning |
| 626 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
| 627 | \(like DEFINITION). |
| 628 | |
| 629 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
| 630 | AFTER should be a single event type--a symbol or a character, not a sequence. |
| 631 | |
| 632 | Bindings are always added before any inherited map. |
| 633 | |
| 634 | The order of bindings in a keymap only matters when it is used as |
| 635 | a menu, so this function is not useful for non-menu keymaps." |
| 636 | (unless after (setq after t)) |
| 637 | (or (keymapp keymap) |
| 638 | (signal 'wrong-type-argument (list 'keymapp keymap))) |
| 639 | (setq key |
| 640 | (if (<= (length key) 1) (aref key 0) |
| 641 | (setq keymap (lookup-key keymap |
| 642 | (apply 'vector |
| 643 | (butlast (mapcar 'identity key))))) |
| 644 | (aref key (1- (length key))))) |
| 645 | (let ((tail keymap) done inserted) |
| 646 | (while (and (not done) tail) |
| 647 | ;; Delete any earlier bindings for the same key. |
| 648 | (if (eq (car-safe (car (cdr tail))) key) |
| 649 | (setcdr tail (cdr (cdr tail)))) |
| 650 | ;; If we hit an included map, go down that one. |
| 651 | (if (keymapp (car tail)) (setq tail (car tail))) |
| 652 | ;; When we reach AFTER's binding, insert the new binding after. |
| 653 | ;; If we reach an inherited keymap, insert just before that. |
| 654 | ;; If we reach the end of this keymap, insert at the end. |
| 655 | (if (or (and (eq (car-safe (car tail)) after) |
| 656 | (not (eq after t))) |
| 657 | (eq (car (cdr tail)) 'keymap) |
| 658 | (null (cdr tail))) |
| 659 | (progn |
| 660 | ;; Stop the scan only if we find a parent keymap. |
| 661 | ;; Keep going past the inserted element |
| 662 | ;; so we can delete any duplications that come later. |
| 663 | (if (eq (car (cdr tail)) 'keymap) |
| 664 | (setq done t)) |
| 665 | ;; Don't insert more than once. |
| 666 | (or inserted |
| 667 | (setcdr tail (cons (cons key definition) (cdr tail)))) |
| 668 | (setq inserted t))) |
| 669 | (setq tail (cdr tail))))) |
| 670 | |
| 671 | (defun map-keymap-sorted (function keymap) |
| 672 | "Implement `map-keymap' with sorting. |
| 673 | Don't call this function; it is for internal use only." |
| 674 | (let (list) |
| 675 | (map-keymap (lambda (a b) (push (cons a b) list)) |
| 676 | keymap) |
| 677 | (setq list (sort list |
| 678 | (lambda (a b) |
| 679 | (setq a (car a) b (car b)) |
| 680 | (if (integerp a) |
| 681 | (if (integerp b) (< a b) |
| 682 | t) |
| 683 | (if (integerp b) t |
| 684 | ;; string< also accepts symbols. |
| 685 | (string< a b)))))) |
| 686 | (dolist (p list) |
| 687 | (funcall function (car p) (cdr p))))) |
| 688 | |
| 689 | (defun keymap--menu-item-binding (val) |
| 690 | "Return the binding part of a menu-item." |
| 691 | (cond |
| 692 | ((not (consp val)) val) ;Not a menu-item. |
| 693 | ((eq 'menu-item (car val)) |
| 694 | (let* ((binding (nth 2 val)) |
| 695 | (plist (nthcdr 3 val)) |
| 696 | (filter (plist-get plist :filter))) |
| 697 | (if filter (funcall filter binding) |
| 698 | binding))) |
| 699 | ((and (consp (cdr val)) (stringp (cadr val))) |
| 700 | (cddr val)) |
| 701 | ((stringp (car val)) |
| 702 | (cdr val)) |
| 703 | (t val))) ;Not a menu-item either. |
| 704 | |
| 705 | (defun keymap--menu-item-with-binding (item binding) |
| 706 | "Build a menu-item like ITEM but with its binding changed to BINDING." |
| 707 | (cond |
| 708 | ((not (consp item)) binding) ;Not a menu-item. |
| 709 | ((eq 'menu-item (car item)) |
| 710 | (setq item (copy-sequence item)) |
| 711 | (let ((tail (nthcdr 2 item))) |
| 712 | (setcar tail binding) |
| 713 | ;; Remove any potential filter. |
| 714 | (if (plist-get (cdr tail) :filter) |
| 715 | (setcdr tail (plist-put (cdr tail) :filter nil)))) |
| 716 | item) |
| 717 | ((and (consp (cdr item)) (stringp (cadr item))) |
| 718 | (cons (car item) (cons (cadr item) binding))) |
| 719 | (t (cons (car item) binding)))) |
| 720 | |
| 721 | (defun keymap--merge-bindings (val1 val2) |
| 722 | "Merge bindings VAL1 and VAL2." |
| 723 | (let ((map1 (keymap--menu-item-binding val1)) |
| 724 | (map2 (keymap--menu-item-binding val2))) |
| 725 | (if (not (and (keymapp map1) (keymapp map2))) |
| 726 | ;; There's nothing to merge: val1 takes precedence. |
| 727 | val1 |
| 728 | (let ((map (list 'keymap map1 map2)) |
| 729 | (item (if (keymapp val1) (if (keymapp val2) nil val2) val1))) |
| 730 | (keymap--menu-item-with-binding item map))))) |
| 731 | |
| 732 | (defun keymap-canonicalize (map) |
| 733 | "Return a simpler equivalent keymap. |
| 734 | This resolves inheritance and redefinitions. The returned keymap |
| 735 | should behave identically to a copy of KEYMAP w.r.t `lookup-key' |
| 736 | and use in active keymaps and menus. |
| 737 | Subkeymaps may be modified but are not canonicalized." |
| 738 | ;; FIXME: Problem with the difference between a nil binding |
| 739 | ;; that hides a binding in an inherited map and a nil binding that's ignored |
| 740 | ;; to let some further binding visible. Currently a nil binding hides all. |
| 741 | ;; FIXME: we may want to carefully (re)order elements in case they're |
| 742 | ;; menu-entries. |
| 743 | (let ((bindings ()) |
| 744 | (ranges ()) |
| 745 | (prompt (keymap-prompt map))) |
| 746 | (while (keymapp map) |
| 747 | (setq map (map-keymap ;; -internal |
| 748 | (lambda (key item) |
| 749 | (if (consp key) |
| 750 | ;; Treat char-ranges specially. |
| 751 | (push (cons key item) ranges) |
| 752 | (push (cons key item) bindings))) |
| 753 | map))) |
| 754 | ;; Create the new map. |
| 755 | (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt)) |
| 756 | (dolist (binding ranges) |
| 757 | ;; Treat char-ranges specially. FIXME: need to merge as well. |
| 758 | (define-key map (vector (car binding)) (cdr binding))) |
| 759 | ;; Process the bindings starting from the end. |
| 760 | (dolist (binding (prog1 bindings (setq bindings ()))) |
| 761 | (let* ((key (car binding)) |
| 762 | (oldbind (assq key bindings))) |
| 763 | (push (if (not oldbind) |
| 764 | ;; The normal case: no duplicate bindings. |
| 765 | binding |
| 766 | ;; This is the second binding for this key. |
| 767 | (setq bindings (delq oldbind bindings)) |
| 768 | (cons key (keymap--merge-bindings (cdr binding) |
| 769 | (cdr oldbind)))) |
| 770 | bindings))) |
| 771 | (nconc map bindings))) |
| 772 | |
| 773 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
| 774 | |
| 775 | (defun keyboard-translate (from to) |
| 776 | "Translate character FROM to TO on the current terminal. |
| 777 | This function creates a `keyboard-translate-table' if necessary |
| 778 | and then modifies one entry in it." |
| 779 | (or (char-table-p keyboard-translate-table) |
| 780 | (setq keyboard-translate-table |
| 781 | (make-char-table 'keyboard-translate-table nil))) |
| 782 | (aset keyboard-translate-table from to)) |
| 783 | \f |
| 784 | ;;;; Key binding commands. |
| 785 | |
| 786 | (defun global-set-key (key command) |
| 787 | "Give KEY a global binding as COMMAND. |
| 788 | COMMAND is the command definition to use; usually it is |
| 789 | a symbol naming an interactively-callable function. |
| 790 | KEY is a key sequence; noninteractively, it is a string or vector |
| 791 | of characters or event types, and non-ASCII characters with codes |
| 792 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 793 | |
| 794 | Note that if KEY has a local binding in the current buffer, |
| 795 | that local binding will continue to shadow any global binding |
| 796 | that you make with this function." |
| 797 | (interactive "KSet key globally: \nCSet key %s to command: ") |
| 798 | (or (vectorp key) (stringp key) |
| 799 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 800 | (define-key (current-global-map) key command)) |
| 801 | |
| 802 | (defun local-set-key (key command) |
| 803 | "Give KEY a local binding as COMMAND. |
| 804 | COMMAND is the command definition to use; usually it is |
| 805 | a symbol naming an interactively-callable function. |
| 806 | KEY is a key sequence; noninteractively, it is a string or vector |
| 807 | of characters or event types, and non-ASCII characters with codes |
| 808 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 809 | |
| 810 | The binding goes in the current buffer's local map, which in most |
| 811 | cases is shared with all other buffers in the same major mode." |
| 812 | (interactive "KSet key locally: \nCSet key %s locally to command: ") |
| 813 | (let ((map (current-local-map))) |
| 814 | (or map |
| 815 | (use-local-map (setq map (make-sparse-keymap)))) |
| 816 | (or (vectorp key) (stringp key) |
| 817 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 818 | (define-key map key command))) |
| 819 | |
| 820 | (defun global-unset-key (key) |
| 821 | "Remove global binding of KEY. |
| 822 | KEY is a string or vector representing a sequence of keystrokes." |
| 823 | (interactive "kUnset key globally: ") |
| 824 | (global-set-key key nil)) |
| 825 | |
| 826 | (defun local-unset-key (key) |
| 827 | "Remove local binding of KEY. |
| 828 | KEY is a string or vector representing a sequence of keystrokes." |
| 829 | (interactive "kUnset key locally: ") |
| 830 | (if (current-local-map) |
| 831 | (local-set-key key nil)) |
| 832 | nil) |
| 833 | \f |
| 834 | ;;;; substitute-key-definition and its subroutines. |
| 835 | |
| 836 | (defvar key-substitution-in-progress nil |
| 837 | "Used internally by `substitute-key-definition'.") |
| 838 | |
| 839 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
| 840 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
| 841 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. |
| 842 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine |
| 843 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP. |
| 844 | |
| 845 | If you don't specify OLDMAP, you can usually get the same results |
| 846 | in a cleaner way with command remapping, like this: |
| 847 | (define-key KEYMAP [remap OLDDEF] NEWDEF) |
| 848 | \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)" |
| 849 | ;; Don't document PREFIX in the doc string because we don't want to |
| 850 | ;; advertise it. It's meant for recursive calls only. Here's its |
| 851 | ;; meaning |
| 852 | |
| 853 | ;; If optional argument PREFIX is specified, it should be a key |
| 854 | ;; prefix, a string. Redefined bindings will then be bound to the |
| 855 | ;; original key, with PREFIX added at the front. |
| 856 | (or prefix (setq prefix "")) |
| 857 | (let* ((scan (or oldmap keymap)) |
| 858 | (prefix1 (vconcat prefix [nil])) |
| 859 | (key-substitution-in-progress |
| 860 | (cons scan key-substitution-in-progress))) |
| 861 | ;; Scan OLDMAP, finding each char or event-symbol that |
| 862 | ;; has any definition, and act on it with hack-key. |
| 863 | (map-keymap |
| 864 | (lambda (char defn) |
| 865 | (aset prefix1 (length prefix) char) |
| 866 | (substitute-key-definition-key defn olddef newdef prefix1 keymap)) |
| 867 | scan))) |
| 868 | |
| 869 | (defun substitute-key-definition-key (defn olddef newdef prefix keymap) |
| 870 | (let (inner-def skipped menu-item) |
| 871 | ;; Find the actual command name within the binding. |
| 872 | (if (eq (car-safe defn) 'menu-item) |
| 873 | (setq menu-item defn defn (nth 2 defn)) |
| 874 | ;; Skip past menu-prompt. |
| 875 | (while (stringp (car-safe defn)) |
| 876 | (push (pop defn) skipped)) |
| 877 | ;; Skip past cached key-equivalence data for menu items. |
| 878 | (if (consp (car-safe defn)) |
| 879 | (setq defn (cdr defn)))) |
| 880 | (if (or (eq defn olddef) |
| 881 | ;; Compare with equal if definition is a key sequence. |
| 882 | ;; That is useful for operating on function-key-map. |
| 883 | (and (or (stringp defn) (vectorp defn)) |
| 884 | (equal defn olddef))) |
| 885 | (define-key keymap prefix |
| 886 | (if menu-item |
| 887 | (let ((copy (copy-sequence menu-item))) |
| 888 | (setcar (nthcdr 2 copy) newdef) |
| 889 | copy) |
| 890 | (nconc (nreverse skipped) newdef))) |
| 891 | ;; Look past a symbol that names a keymap. |
| 892 | (setq inner-def |
| 893 | (or (indirect-function defn t) defn)) |
| 894 | ;; For nested keymaps, we use `inner-def' rather than `defn' so as to |
| 895 | ;; avoid autoloading a keymap. This is mostly done to preserve the |
| 896 | ;; original non-autoloading behavior of pre-map-keymap times. |
| 897 | (if (and (keymapp inner-def) |
| 898 | ;; Avoid recursively scanning |
| 899 | ;; where KEYMAP does not have a submap. |
| 900 | (let ((elt (lookup-key keymap prefix))) |
| 901 | (or (null elt) (natnump elt) (keymapp elt))) |
| 902 | ;; Avoid recursively rescanning keymap being scanned. |
| 903 | (not (memq inner-def key-substitution-in-progress))) |
| 904 | ;; If this one isn't being scanned already, scan it now. |
| 905 | (substitute-key-definition olddef newdef keymap inner-def prefix))))) |
| 906 | |
| 907 | \f |
| 908 | ;;;; The global keymap tree. |
| 909 | |
| 910 | ;; global-map, esc-map, and ctl-x-map have their values set up in |
| 911 | ;; keymap.c; we just give them docstrings here. |
| 912 | |
| 913 | (defvar global-map nil |
| 914 | "Default global keymap mapping Emacs keyboard input into commands. |
| 915 | The value is a keymap which is usually (but not necessarily) Emacs's |
| 916 | global map.") |
| 917 | |
| 918 | (defvar esc-map nil |
| 919 | "Default keymap for ESC (meta) commands. |
| 920 | The normal global definition of the character ESC indirects to this keymap.") |
| 921 | |
| 922 | (defvar ctl-x-map nil |
| 923 | "Default keymap for C-x commands. |
| 924 | The normal global definition of the character C-x indirects to this keymap.") |
| 925 | |
| 926 | (defvar ctl-x-4-map (make-sparse-keymap) |
| 927 | "Keymap for subcommands of C-x 4.") |
| 928 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
| 929 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
| 930 | |
| 931 | (defvar ctl-x-5-map (make-sparse-keymap) |
| 932 | "Keymap for frame commands.") |
| 933 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
| 934 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
| 935 | |
| 936 | \f |
| 937 | ;;;; Event manipulation functions. |
| 938 | |
| 939 | (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@)) |
| 940 | |
| 941 | (defun listify-key-sequence (key) |
| 942 | "Convert a key sequence to a list of events." |
| 943 | (if (vectorp key) |
| 944 | (append key nil) |
| 945 | (mapcar (function (lambda (c) |
| 946 | (if (> c 127) |
| 947 | (logxor c listify-key-sequence-1) |
| 948 | c))) |
| 949 | key))) |
| 950 | |
| 951 | (defun eventp (obj) |
| 952 | "True if the argument is an event object." |
| 953 | (when obj |
| 954 | (or (integerp obj) |
| 955 | (and (symbolp obj) obj (not (keywordp obj))) |
| 956 | (and (consp obj) (symbolp (car obj)))))) |
| 957 | |
| 958 | (defun event-modifiers (event) |
| 959 | "Return a list of symbols representing the modifier keys in event EVENT. |
| 960 | The elements of the list may include `meta', `control', |
| 961 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
| 962 | and `down'. |
| 963 | EVENT may be an event or an event type. If EVENT is a symbol |
| 964 | that has never been used in an event that has been read as input |
| 965 | in the current Emacs session, then this function may fail to include |
| 966 | the `click' modifier." |
| 967 | (let ((type event)) |
| 968 | (if (listp type) |
| 969 | (setq type (car type))) |
| 970 | (if (symbolp type) |
| 971 | ;; Don't read event-symbol-elements directly since we're not |
| 972 | ;; sure the symbol has already been parsed. |
| 973 | (cdr (internal-event-symbol-parse-modifiers type)) |
| 974 | (let ((list nil) |
| 975 | (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@ |
| 976 | ?\H-\^@ ?\s-\^@ ?\A-\^@))))) |
| 977 | (if (not (zerop (logand type ?\M-\^@))) |
| 978 | (push 'meta list)) |
| 979 | (if (or (not (zerop (logand type ?\C-\^@))) |
| 980 | (< char 32)) |
| 981 | (push 'control list)) |
| 982 | (if (or (not (zerop (logand type ?\S-\^@))) |
| 983 | (/= char (downcase char))) |
| 984 | (push 'shift list)) |
| 985 | (or (zerop (logand type ?\H-\^@)) |
| 986 | (push 'hyper list)) |
| 987 | (or (zerop (logand type ?\s-\^@)) |
| 988 | (push 'super list)) |
| 989 | (or (zerop (logand type ?\A-\^@)) |
| 990 | (push 'alt list)) |
| 991 | list)))) |
| 992 | |
| 993 | (defun event-basic-type (event) |
| 994 | "Return the basic type of the given event (all modifiers removed). |
| 995 | The value is a printing character (not upper case) or a symbol. |
| 996 | EVENT may be an event or an event type. If EVENT is a symbol |
| 997 | that has never been used in an event that has been read as input |
| 998 | in the current Emacs session, then this function may return nil." |
| 999 | (if (consp event) |
| 1000 | (setq event (car event))) |
| 1001 | (if (symbolp event) |
| 1002 | (car (get event 'event-symbol-elements)) |
| 1003 | (let* ((base (logand event (1- ?\A-\^@))) |
| 1004 | (uncontrolled (if (< base 32) (logior base 64) base))) |
| 1005 | ;; There are some numbers that are invalid characters and |
| 1006 | ;; cause `downcase' to get an error. |
| 1007 | (condition-case () |
| 1008 | (downcase uncontrolled) |
| 1009 | (error uncontrolled))))) |
| 1010 | |
| 1011 | (defsubst mouse-movement-p (object) |
| 1012 | "Return non-nil if OBJECT is a mouse movement event." |
| 1013 | (eq (car-safe object) 'mouse-movement)) |
| 1014 | |
| 1015 | (defun mouse-event-p (object) |
| 1016 | "Return non-nil if OBJECT is a mouse click event." |
| 1017 | ;; is this really correct? maybe remove mouse-movement? |
| 1018 | (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))) |
| 1019 | |
| 1020 | (defun event-start (event) |
| 1021 | "Return the starting position of EVENT. |
| 1022 | EVENT should be a mouse click, drag, or key press event. |
| 1023 | |
| 1024 | The following accessor functions are used to access the elements |
| 1025 | of the position: |
| 1026 | |
| 1027 | `posn-window': The window the event is in. |
| 1028 | `posn-area': A symbol identifying the area the event occurred in, |
| 1029 | or nil if the event occurred in the text area. |
| 1030 | `posn-point': The buffer position of the event. |
| 1031 | `posn-x-y': The pixel-based coordiates of the event. |
| 1032 | `posn-col-row': The estimated column and row corresponding to the |
| 1033 | position of the event. |
| 1034 | `posn-actual-col-row': The actual column and row corresponding to the |
| 1035 | position of the event. |
| 1036 | `posn-string': The string object of the event, which is either |
| 1037 | nil or (STRING . POSITION)'. |
| 1038 | `posn-image': The image object of the event, if any. |
| 1039 | `posn-object': The image or string object of the event, if any. |
| 1040 | `posn-timestamp': The time the event occurred, in milliseconds. |
| 1041 | |
| 1042 | For more information, see Info node `(elisp)Click Events'." |
| 1043 | (if (consp event) (nth 1 event) |
| 1044 | (or (posn-at-point) |
| 1045 | (list (selected-window) (point) '(0 . 0) 0)))) |
| 1046 | |
| 1047 | (defun event-end (event) |
| 1048 | "Return the ending position of EVENT. |
| 1049 | EVENT should be a click, drag, or key press event. |
| 1050 | |
| 1051 | See `event-start' for a description of the value returned." |
| 1052 | (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event) |
| 1053 | (or (posn-at-point) |
| 1054 | (list (selected-window) (point) '(0 . 0) 0)))) |
| 1055 | |
| 1056 | (defsubst event-click-count (event) |
| 1057 | "Return the multi-click count of EVENT, a click or drag event. |
| 1058 | The return value is a positive integer." |
| 1059 | (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1)) |
| 1060 | \f |
| 1061 | ;;;; Extracting fields of the positions in an event. |
| 1062 | |
| 1063 | (defun posnp (obj) |
| 1064 | "Return non-nil if OBJ appears to be a valid `posn' object." |
| 1065 | (and (windowp (car-safe obj)) |
| 1066 | (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS. |
| 1067 | (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET. |
| 1068 | (integerp (car-safe (cdr obj))))) ;TIMESTAMP. |
| 1069 | |
| 1070 | (defsubst posn-window (position) |
| 1071 | "Return the window in POSITION. |
| 1072 | POSITION should be a list of the form returned by the `event-start' |
| 1073 | and `event-end' functions." |
| 1074 | (nth 0 position)) |
| 1075 | |
| 1076 | (defsubst posn-area (position) |
| 1077 | "Return the window area recorded in POSITION, or nil for the text area. |
| 1078 | POSITION should be a list of the form returned by the `event-start' |
| 1079 | and `event-end' functions." |
| 1080 | (let ((area (if (consp (nth 1 position)) |
| 1081 | (car (nth 1 position)) |
| 1082 | (nth 1 position)))) |
| 1083 | (and (symbolp area) area))) |
| 1084 | |
| 1085 | (defun posn-point (position) |
| 1086 | "Return the buffer location in POSITION. |
| 1087 | POSITION should be a list of the form returned by the `event-start' |
| 1088 | and `event-end' functions. |
| 1089 | Returns nil if POSITION does not correspond to any buffer location (e.g. |
| 1090 | a click on a scroll bar)." |
| 1091 | (or (nth 5 position) |
| 1092 | (let ((pt (nth 1 position))) |
| 1093 | (or (car-safe pt) |
| 1094 | ;; Apparently this can also be `vertical-scroll-bar' (bug#13979). |
| 1095 | (if (integerp pt) pt))))) |
| 1096 | |
| 1097 | (defun posn-set-point (position) |
| 1098 | "Move point to POSITION. |
| 1099 | Select the corresponding window as well." |
| 1100 | (if (not (windowp (posn-window position))) |
| 1101 | (error "Position not in text area of window")) |
| 1102 | (select-window (posn-window position)) |
| 1103 | (if (numberp (posn-point position)) |
| 1104 | (goto-char (posn-point position)))) |
| 1105 | |
| 1106 | (defsubst posn-x-y (position) |
| 1107 | "Return the x and y coordinates in POSITION. |
| 1108 | The return value has the form (X . Y), where X and Y are given in |
| 1109 | pixels. POSITION should be a list of the form returned by |
| 1110 | `event-start' and `event-end'." |
| 1111 | (nth 2 position)) |
| 1112 | |
| 1113 | (declare-function scroll-bar-scale "scroll-bar" (num-denom whole)) |
| 1114 | |
| 1115 | (defun posn-col-row (position) |
| 1116 | "Return the nominal column and row in POSITION, measured in characters. |
| 1117 | The column and row values are approximations calculated from the x |
| 1118 | and y coordinates in POSITION and the frame's default character width |
| 1119 | and height. |
| 1120 | For a scroll-bar event, the result column is 0, and the row |
| 1121 | corresponds to the vertical position of the click in the scroll bar. |
| 1122 | POSITION should be a list of the form returned by the `event-start' |
| 1123 | and `event-end' functions." |
| 1124 | (let* ((pair (posn-x-y position)) |
| 1125 | (window (posn-window position)) |
| 1126 | (area (posn-area position))) |
| 1127 | (cond |
| 1128 | ((null window) |
| 1129 | '(0 . 0)) |
| 1130 | ((eq area 'vertical-scroll-bar) |
| 1131 | (cons 0 (scroll-bar-scale pair (1- (window-height window))))) |
| 1132 | ((eq area 'horizontal-scroll-bar) |
| 1133 | (cons (scroll-bar-scale pair (window-width window)) 0)) |
| 1134 | (t |
| 1135 | (let* ((frame (if (framep window) window (window-frame window))) |
| 1136 | ;; FIXME: This should take line-spacing properties on |
| 1137 | ;; newlines into account. |
| 1138 | (spacing (when (display-graphic-p frame) |
| 1139 | (or (with-current-buffer (window-buffer window) |
| 1140 | line-spacing) |
| 1141 | (frame-parameter frame 'line-spacing))))) |
| 1142 | (cond ((floatp spacing) |
| 1143 | (setq spacing (truncate (* spacing |
| 1144 | (frame-char-height frame))))) |
| 1145 | ((null spacing) |
| 1146 | (setq spacing 0))) |
| 1147 | (cons (/ (car pair) (frame-char-width frame)) |
| 1148 | (- (/ (cdr pair) (+ (frame-char-height frame) spacing)) |
| 1149 | (if (null (with-current-buffer (window-buffer window) |
| 1150 | header-line-format)) |
| 1151 | 0 1)))))))) |
| 1152 | |
| 1153 | (defun posn-actual-col-row (position) |
| 1154 | "Return the actual column and row in POSITION, measured in characters. |
| 1155 | These are the actual row number in the window and character number in that row. |
| 1156 | Return nil if POSITION does not contain the actual position; in that case |
| 1157 | `posn-col-row' can be used to get approximate values. |
| 1158 | POSITION should be a list of the form returned by the `event-start' |
| 1159 | and `event-end' functions." |
| 1160 | (nth 6 position)) |
| 1161 | |
| 1162 | (defsubst posn-timestamp (position) |
| 1163 | "Return the timestamp of POSITION. |
| 1164 | POSITION should be a list of the form returned by the `event-start' |
| 1165 | and `event-end' functions." |
| 1166 | (nth 3 position)) |
| 1167 | |
| 1168 | (defun posn-string (position) |
| 1169 | "Return the string object of POSITION. |
| 1170 | Value is a cons (STRING . STRING-POS), or nil if not a string. |
| 1171 | POSITION should be a list of the form returned by the `event-start' |
| 1172 | and `event-end' functions." |
| 1173 | (let ((x (nth 4 position))) |
| 1174 | ;; Apparently this can also be `handle' or `below-handle' (bug#13979). |
| 1175 | (when (consp x) x))) |
| 1176 | |
| 1177 | (defsubst posn-image (position) |
| 1178 | "Return the image object of POSITION. |
| 1179 | Value is a list (image ...), or nil if not an image. |
| 1180 | POSITION should be a list of the form returned by the `event-start' |
| 1181 | and `event-end' functions." |
| 1182 | (nth 7 position)) |
| 1183 | |
| 1184 | (defsubst posn-object (position) |
| 1185 | "Return the object (image or string) of POSITION. |
| 1186 | Value is a list (image ...) for an image object, a cons cell |
| 1187 | \(STRING . STRING-POS) for a string object, and nil for a buffer position. |
| 1188 | POSITION should be a list of the form returned by the `event-start' |
| 1189 | and `event-end' functions." |
| 1190 | (or (posn-image position) (posn-string position))) |
| 1191 | |
| 1192 | (defsubst posn-object-x-y (position) |
| 1193 | "Return the x and y coordinates relative to the object of POSITION. |
| 1194 | The return value has the form (DX . DY), where DX and DY are |
| 1195 | given in pixels. POSITION should be a list of the form returned |
| 1196 | by `event-start' and `event-end'." |
| 1197 | (nth 8 position)) |
| 1198 | |
| 1199 | (defsubst posn-object-width-height (position) |
| 1200 | "Return the pixel width and height of the object of POSITION. |
| 1201 | The return value has the form (WIDTH . HEIGHT). POSITION should |
| 1202 | be a list of the form returned by `event-start' and `event-end'." |
| 1203 | (nth 9 position)) |
| 1204 | |
| 1205 | \f |
| 1206 | ;;;; Obsolescent names for functions. |
| 1207 | |
| 1208 | (define-obsolete-function-alias 'window-dot 'window-point "22.1") |
| 1209 | (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1") |
| 1210 | (define-obsolete-function-alias 'read-input 'read-string "22.1") |
| 1211 | (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1") |
| 1212 | (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1") |
| 1213 | (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1") |
| 1214 | |
| 1215 | (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1") |
| 1216 | (make-obsolete 'buffer-has-markers-at nil "24.3") |
| 1217 | |
| 1218 | (defun insert-string (&rest args) |
| 1219 | "Mocklisp-compatibility insert function. |
| 1220 | Like the function `insert' except that any argument that is a number |
| 1221 | is converted into a string by expressing it in decimal." |
| 1222 | (declare (obsolete insert "22.1")) |
| 1223 | (dolist (el args) |
| 1224 | (insert (if (integerp el) (number-to-string el) el)))) |
| 1225 | |
| 1226 | (defun makehash (&optional test) |
| 1227 | (declare (obsolete make-hash-table "22.1")) |
| 1228 | (make-hash-table :test (or test 'eql))) |
| 1229 | |
| 1230 | (defun log10 (x) |
| 1231 | "Return (log X 10), the log base 10 of X." |
| 1232 | (declare (obsolete log "24.4")) |
| 1233 | (log x 10)) |
| 1234 | |
| 1235 | ;; These are used by VM and some old programs |
| 1236 | (defalias 'focus-frame 'ignore "") |
| 1237 | (make-obsolete 'focus-frame "it does nothing." "22.1") |
| 1238 | (defalias 'unfocus-frame 'ignore "") |
| 1239 | (make-obsolete 'unfocus-frame "it does nothing." "22.1") |
| 1240 | (make-obsolete 'make-variable-frame-local |
| 1241 | "explicitly check for a frame-parameter instead." "22.2") |
| 1242 | (set-advertised-calling-convention |
| 1243 | 'all-completions '(string collection &optional predicate) "23.1") |
| 1244 | (set-advertised-calling-convention 'unintern '(name obarray) "23.3") |
| 1245 | (set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3") |
| 1246 | (set-advertised-calling-convention 'decode-char '(ch charset) "21.4") |
| 1247 | (set-advertised-calling-convention 'encode-char '(ch charset) "21.4") |
| 1248 | \f |
| 1249 | ;;;; Obsolescence declarations for variables, and aliases. |
| 1250 | |
| 1251 | ;; Special "default-FOO" variables which contain the default value of |
| 1252 | ;; the "FOO" variable are nasty. Their implementation is brittle, and |
| 1253 | ;; slows down several unrelated variable operations; furthermore, they |
| 1254 | ;; can lead to really odd behavior if you decide to make them |
| 1255 | ;; buffer-local. |
| 1256 | |
| 1257 | ;; Not used at all in Emacs, last time I checked: |
| 1258 | (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2") |
| 1259 | (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2") |
| 1260 | (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2") |
| 1261 | (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2") |
| 1262 | (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2") |
| 1263 | (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2") |
| 1264 | (make-obsolete-variable 'default-left-margin 'left-margin "23.2") |
| 1265 | (make-obsolete-variable 'default-tab-width 'tab-width "23.2") |
| 1266 | (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2") |
| 1267 | (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2") |
| 1268 | (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2") |
| 1269 | (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2") |
| 1270 | (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2") |
| 1271 | (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2") |
| 1272 | (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2") |
| 1273 | (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2") |
| 1274 | (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2") |
| 1275 | (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2") |
| 1276 | (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2") |
| 1277 | (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2") |
| 1278 | (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2") |
| 1279 | (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2") |
| 1280 | (make-obsolete-variable 'default-fill-column 'fill-column "23.2") |
| 1281 | (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2") |
| 1282 | (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2") |
| 1283 | (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2") |
| 1284 | (make-obsolete-variable 'default-major-mode 'major-mode "23.2") |
| 1285 | (make-obsolete-variable 'default-enable-multibyte-characters |
| 1286 | "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2") |
| 1287 | |
| 1288 | (make-obsolete-variable 'define-key-rebound-commands nil "23.2") |
| 1289 | (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1") |
| 1290 | (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1") |
| 1291 | (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1") |
| 1292 | (make-obsolete 'window-redisplay-end-trigger nil "23.1") |
| 1293 | (make-obsolete 'set-window-redisplay-end-trigger nil "23.1") |
| 1294 | |
| 1295 | (make-obsolete 'process-filter-multibyte-p nil "23.1") |
| 1296 | (make-obsolete 'set-process-filter-multibyte nil "23.1") |
| 1297 | |
| 1298 | ;; Lisp manual only updated in 22.1. |
| 1299 | (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro |
| 1300 | "before 19.34") |
| 1301 | |
| 1302 | (define-obsolete-variable-alias 'x-lost-selection-hooks |
| 1303 | 'x-lost-selection-functions "22.1") |
| 1304 | (define-obsolete-variable-alias 'x-sent-selection-hooks |
| 1305 | 'x-sent-selection-functions "22.1") |
| 1306 | |
| 1307 | ;; This was introduced in 21.4 for pre-unicode unification. That |
| 1308 | ;; usage was rendered obsolete in 23.1 which uses Unicode internally. |
| 1309 | ;; Other uses are possible, so this variable is not _really_ obsolete, |
| 1310 | ;; but Stefan insists to mark it so. |
| 1311 | (make-obsolete-variable 'translation-table-for-input nil "23.1") |
| 1312 | |
| 1313 | (defvaralias 'messages-buffer-max-lines 'message-log-max) |
| 1314 | \f |
| 1315 | ;;;; Alternate names for functions - these are not being phased out. |
| 1316 | |
| 1317 | (defalias 'send-string 'process-send-string) |
| 1318 | (defalias 'send-region 'process-send-region) |
| 1319 | (defalias 'string= 'string-equal) |
| 1320 | (defalias 'string< 'string-lessp) |
| 1321 | (defalias 'move-marker 'set-marker) |
| 1322 | (defalias 'rplaca 'setcar) |
| 1323 | (defalias 'rplacd 'setcdr) |
| 1324 | (defalias 'beep 'ding) ;preserve lingual purity |
| 1325 | (defalias 'indent-to-column 'indent-to) |
| 1326 | (defalias 'backward-delete-char 'delete-backward-char) |
| 1327 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) |
| 1328 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) |
| 1329 | (defalias 'int-to-string 'number-to-string) |
| 1330 | (defalias 'store-match-data 'set-match-data) |
| 1331 | (defalias 'chmod 'set-file-modes) |
| 1332 | (defalias 'mkdir 'make-directory) |
| 1333 | ;; These are the XEmacs names: |
| 1334 | (defalias 'point-at-eol 'line-end-position) |
| 1335 | (defalias 'point-at-bol 'line-beginning-position) |
| 1336 | |
| 1337 | (defalias 'user-original-login-name 'user-login-name) |
| 1338 | |
| 1339 | \f |
| 1340 | ;;;; Hook manipulation functions. |
| 1341 | |
| 1342 | (defun add-hook (hook function &optional append local) |
| 1343 | "Add to the value of HOOK the function FUNCTION. |
| 1344 | FUNCTION is not added if already present. |
| 1345 | FUNCTION is added (if necessary) at the beginning of the hook list |
| 1346 | unless the optional argument APPEND is non-nil, in which case |
| 1347 | FUNCTION is added at the end. |
| 1348 | |
| 1349 | The optional fourth argument, LOCAL, if non-nil, says to modify |
| 1350 | the hook's buffer-local value rather than its global value. |
| 1351 | This makes the hook buffer-local, and it makes t a member of the |
| 1352 | buffer-local value. That acts as a flag to run the hook |
| 1353 | functions of the global value as well as in the local value. |
| 1354 | |
| 1355 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 1356 | HOOK is void, it is first set to nil. If HOOK's value is a single |
| 1357 | function, it is changed to a list of functions." |
| 1358 | (or (boundp hook) (set hook nil)) |
| 1359 | (or (default-boundp hook) (set-default hook nil)) |
| 1360 | (if local (unless (local-variable-if-set-p hook) |
| 1361 | (set (make-local-variable hook) (list t))) |
| 1362 | ;; Detect the case where make-local-variable was used on a hook |
| 1363 | ;; and do what we used to do. |
| 1364 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) |
| 1365 | (setq local t))) |
| 1366 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 1367 | ;; If the hook value is a single function, turn it into a list. |
| 1368 | (when (or (not (listp hook-value)) (functionp hook-value)) |
| 1369 | (setq hook-value (list hook-value))) |
| 1370 | ;; Do the actual addition if necessary |
| 1371 | (unless (member function hook-value) |
| 1372 | (when (stringp function) |
| 1373 | (setq function (purecopy function))) |
| 1374 | (setq hook-value |
| 1375 | (if append |
| 1376 | (append hook-value (list function)) |
| 1377 | (cons function hook-value)))) |
| 1378 | ;; Set the actual variable |
| 1379 | (if local |
| 1380 | (progn |
| 1381 | ;; If HOOK isn't a permanent local, |
| 1382 | ;; but FUNCTION wants to survive a change of modes, |
| 1383 | ;; mark HOOK as partially permanent. |
| 1384 | (and (symbolp function) |
| 1385 | (get function 'permanent-local-hook) |
| 1386 | (not (get hook 'permanent-local)) |
| 1387 | (put hook 'permanent-local 'permanent-local-hook)) |
| 1388 | (set hook hook-value)) |
| 1389 | (set-default hook hook-value)))) |
| 1390 | |
| 1391 | (defun remove-hook (hook function &optional local) |
| 1392 | "Remove from the value of HOOK the function FUNCTION. |
| 1393 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 1394 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the |
| 1395 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
| 1396 | |
| 1397 | The optional third argument, LOCAL, if non-nil, says to modify |
| 1398 | the hook's buffer-local value rather than its default value." |
| 1399 | (or (boundp hook) (set hook nil)) |
| 1400 | (or (default-boundp hook) (set-default hook nil)) |
| 1401 | ;; Do nothing if LOCAL is t but this hook has no local binding. |
| 1402 | (unless (and local (not (local-variable-p hook))) |
| 1403 | ;; Detect the case where make-local-variable was used on a hook |
| 1404 | ;; and do what we used to do. |
| 1405 | (when (and (local-variable-p hook) |
| 1406 | (not (and (consp (symbol-value hook)) |
| 1407 | (memq t (symbol-value hook))))) |
| 1408 | (setq local t)) |
| 1409 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 1410 | ;; Remove the function, for both the list and the non-list cases. |
| 1411 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) |
| 1412 | (if (equal hook-value function) (setq hook-value nil)) |
| 1413 | (setq hook-value (delete function (copy-sequence hook-value)))) |
| 1414 | ;; If the function is on the global hook, we need to shadow it locally |
| 1415 | ;;(when (and local (member function (default-value hook)) |
| 1416 | ;; (not (member (cons 'not function) hook-value))) |
| 1417 | ;; (push (cons 'not function) hook-value)) |
| 1418 | ;; Set the actual variable |
| 1419 | (if (not local) |
| 1420 | (set-default hook hook-value) |
| 1421 | (if (equal hook-value '(t)) |
| 1422 | (kill-local-variable hook) |
| 1423 | (set hook hook-value)))))) |
| 1424 | |
| 1425 | (defmacro letrec (binders &rest body) |
| 1426 | "Bind variables according to BINDERS then eval BODY. |
| 1427 | The value of the last form in BODY is returned. |
| 1428 | Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds |
| 1429 | SYMBOL to the value of VALUEFORM. |
| 1430 | All symbols are bound before the VALUEFORMs are evalled." |
| 1431 | ;; Only useful in lexical-binding mode. |
| 1432 | ;; As a special-form, we could implement it more efficiently (and cleanly, |
| 1433 | ;; making the vars actually unbound during evaluation of the binders). |
| 1434 | (declare (debug let) (indent 1)) |
| 1435 | `(let ,(mapcar #'car binders) |
| 1436 | ,@(mapcar (lambda (binder) `(setq ,@binder)) binders) |
| 1437 | ,@body)) |
| 1438 | |
| 1439 | (defmacro with-wrapper-hook (hook args &rest body) |
| 1440 | "Run BODY, using wrapper functions from HOOK with additional ARGS. |
| 1441 | HOOK is an abnormal hook. Each hook function in HOOK \"wraps\" |
| 1442 | around the preceding ones, like a set of nested `around' advices. |
| 1443 | |
| 1444 | Each hook function should accept an argument list consisting of a |
| 1445 | function FUN, followed by the additional arguments in ARGS. |
| 1446 | |
| 1447 | The first hook function in HOOK is passed a FUN that, if it is called |
| 1448 | with arguments ARGS, performs BODY (i.e., the default operation). |
| 1449 | The FUN passed to each successive hook function is defined based |
| 1450 | on the preceding hook functions; if called with arguments ARGS, |
| 1451 | it does what the `with-wrapper-hook' call would do if the |
| 1452 | preceding hook functions were the only ones present in HOOK. |
| 1453 | |
| 1454 | Each hook function may call its FUN argument as many times as it wishes, |
| 1455 | including never. In that case, such a hook function acts to replace |
| 1456 | the default definition altogether, and any preceding hook functions. |
| 1457 | Of course, a subsequent hook function may do the same thing. |
| 1458 | |
| 1459 | Each hook function definition is used to construct the FUN passed |
| 1460 | to the next hook function, if any. The last (or \"outermost\") |
| 1461 | FUN is then called once." |
| 1462 | (declare (indent 2) (debug (form sexp body)) |
| 1463 | (obsolete "use a <foo>-function variable modified by add-function." |
| 1464 | "24.4")) |
| 1465 | ;; We need those two gensyms because CL's lexical scoping is not available |
| 1466 | ;; for function arguments :-( |
| 1467 | (let ((funs (make-symbol "funs")) |
| 1468 | (global (make-symbol "global")) |
| 1469 | (argssym (make-symbol "args")) |
| 1470 | (runrestofhook (make-symbol "runrestofhook"))) |
| 1471 | ;; Since the hook is a wrapper, the loop has to be done via |
| 1472 | ;; recursion: a given hook function will call its parameter in order to |
| 1473 | ;; continue looping. |
| 1474 | `(letrec ((,runrestofhook |
| 1475 | (lambda (,funs ,global ,argssym) |
| 1476 | ;; `funs' holds the functions left on the hook and `global' |
| 1477 | ;; holds the functions left on the global part of the hook |
| 1478 | ;; (in case the hook is local). |
| 1479 | (if (consp ,funs) |
| 1480 | (if (eq t (car ,funs)) |
| 1481 | (funcall ,runrestofhook |
| 1482 | (append ,global (cdr ,funs)) nil ,argssym) |
| 1483 | (apply (car ,funs) |
| 1484 | (apply-partially |
| 1485 | (lambda (,funs ,global &rest ,argssym) |
| 1486 | (funcall ,runrestofhook ,funs ,global ,argssym)) |
| 1487 | (cdr ,funs) ,global) |
| 1488 | ,argssym)) |
| 1489 | ;; Once there are no more functions on the hook, run |
| 1490 | ;; the original body. |
| 1491 | (apply (lambda ,args ,@body) ,argssym))))) |
| 1492 | (funcall ,runrestofhook ,hook |
| 1493 | ;; The global part of the hook, if any. |
| 1494 | ,(if (symbolp hook) |
| 1495 | `(if (local-variable-p ',hook) |
| 1496 | (default-value ',hook))) |
| 1497 | (list ,@args))))) |
| 1498 | |
| 1499 | (defun add-to-list (list-var element &optional append compare-fn) |
| 1500 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
| 1501 | The test for presence of ELEMENT is done with `equal', or with |
| 1502 | COMPARE-FN if that's non-nil. |
| 1503 | If ELEMENT is added, it is added at the beginning of the list, |
| 1504 | unless the optional argument APPEND is non-nil, in which case |
| 1505 | ELEMENT is added at the end. |
| 1506 | |
| 1507 | The return value is the new value of LIST-VAR. |
| 1508 | |
| 1509 | This is handy to add some elements to configuration variables, |
| 1510 | but please do not abuse it in Elisp code, where you are usually |
| 1511 | better off using `push' or `cl-pushnew'. |
| 1512 | |
| 1513 | If you want to use `add-to-list' on a variable that is not |
| 1514 | defined until a certain package is loaded, you should put the |
| 1515 | call to `add-to-list' into a hook function that will be run only |
| 1516 | after loading the package. `eval-after-load' provides one way to |
| 1517 | do this. In some cases other hooks, such as major mode hooks, |
| 1518 | can do the job." |
| 1519 | (declare |
| 1520 | (compiler-macro |
| 1521 | (lambda (exp) |
| 1522 | ;; FIXME: Something like this could be used for `set' as well. |
| 1523 | (if (or (not (eq 'quote (car-safe list-var))) |
| 1524 | (special-variable-p (cadr list-var)) |
| 1525 | (not (macroexp-const-p append))) |
| 1526 | exp |
| 1527 | (let* ((sym (cadr list-var)) |
| 1528 | (append (eval append)) |
| 1529 | (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'" |
| 1530 | sym)) |
| 1531 | ;; Big ugly hack so we only output a warning during |
| 1532 | ;; byte-compilation, and so we can use |
| 1533 | ;; byte-compile-not-lexical-var-p to silence the warning |
| 1534 | ;; when a defvar has been seen but not yet executed. |
| 1535 | (warnfun (lambda () |
| 1536 | ;; FIXME: We should also emit a warning for let-bound |
| 1537 | ;; variables with dynamic binding. |
| 1538 | (when (assq sym byte-compile--lexical-environment) |
| 1539 | (byte-compile-log-warning msg t :error)))) |
| 1540 | (code |
| 1541 | (macroexp-let2 macroexp-copyable-p x element |
| 1542 | `(if ,(if compare-fn |
| 1543 | (progn |
| 1544 | (require 'cl-lib) |
| 1545 | `(cl-member ,x ,sym :test ,compare-fn)) |
| 1546 | ;; For bootstrapping reasons, don't rely on |
| 1547 | ;; cl--compiler-macro-member for the base case. |
| 1548 | `(member ,x ,sym)) |
| 1549 | ,sym |
| 1550 | ,(if append |
| 1551 | `(setq ,sym (append ,sym (list ,x))) |
| 1552 | `(push ,x ,sym)))))) |
| 1553 | (if (not (macroexp--compiling-p)) |
| 1554 | code |
| 1555 | `(progn |
| 1556 | (macroexp--funcall-if-compiled ',warnfun) |
| 1557 | ,code))))))) |
| 1558 | (if (cond |
| 1559 | ((null compare-fn) |
| 1560 | (member element (symbol-value list-var))) |
| 1561 | ((eq compare-fn 'eq) |
| 1562 | (memq element (symbol-value list-var))) |
| 1563 | ((eq compare-fn 'eql) |
| 1564 | (memql element (symbol-value list-var))) |
| 1565 | (t |
| 1566 | (let ((lst (symbol-value list-var))) |
| 1567 | (while (and lst |
| 1568 | (not (funcall compare-fn element (car lst)))) |
| 1569 | (setq lst (cdr lst))) |
| 1570 | lst))) |
| 1571 | (symbol-value list-var) |
| 1572 | (set list-var |
| 1573 | (if append |
| 1574 | (append (symbol-value list-var) (list element)) |
| 1575 | (cons element (symbol-value list-var)))))) |
| 1576 | |
| 1577 | |
| 1578 | (defun add-to-ordered-list (list-var element &optional order) |
| 1579 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
| 1580 | The test for presence of ELEMENT is done with `eq'. |
| 1581 | |
| 1582 | The resulting list is reordered so that the elements are in the |
| 1583 | order given by each element's numeric list order. Elements |
| 1584 | without a numeric list order are placed at the end of the list. |
| 1585 | |
| 1586 | If the third optional argument ORDER is a number (integer or |
| 1587 | float), set the element's list order to the given value. If |
| 1588 | ORDER is nil or omitted, do not change the numeric order of |
| 1589 | ELEMENT. If ORDER has any other value, remove the numeric order |
| 1590 | of ELEMENT if it has one. |
| 1591 | |
| 1592 | The list order for each element is stored in LIST-VAR's |
| 1593 | `list-order' property. |
| 1594 | |
| 1595 | The return value is the new value of LIST-VAR." |
| 1596 | (let ((ordering (get list-var 'list-order))) |
| 1597 | (unless ordering |
| 1598 | (put list-var 'list-order |
| 1599 | (setq ordering (make-hash-table :weakness 'key :test 'eq)))) |
| 1600 | (when order |
| 1601 | (puthash element (and (numberp order) order) ordering)) |
| 1602 | (unless (memq element (symbol-value list-var)) |
| 1603 | (set list-var (cons element (symbol-value list-var)))) |
| 1604 | (set list-var (sort (symbol-value list-var) |
| 1605 | (lambda (a b) |
| 1606 | (let ((oa (gethash a ordering)) |
| 1607 | (ob (gethash b ordering))) |
| 1608 | (if (and oa ob) |
| 1609 | (< oa ob) |
| 1610 | oa))))))) |
| 1611 | |
| 1612 | (defun add-to-history (history-var newelt &optional maxelt keep-all) |
| 1613 | "Add NEWELT to the history list stored in the variable HISTORY-VAR. |
| 1614 | Return the new history list. |
| 1615 | If MAXELT is non-nil, it specifies the maximum length of the history. |
| 1616 | Otherwise, the maximum history length is the value of the `history-length' |
| 1617 | property on symbol HISTORY-VAR, if set, or the value of the `history-length' |
| 1618 | variable. |
| 1619 | Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil. |
| 1620 | If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even |
| 1621 | if it is empty or a duplicate." |
| 1622 | (unless maxelt |
| 1623 | (setq maxelt (or (get history-var 'history-length) |
| 1624 | history-length))) |
| 1625 | (let ((history (symbol-value history-var)) |
| 1626 | tail) |
| 1627 | (when (and (listp history) |
| 1628 | (or keep-all |
| 1629 | (not (stringp newelt)) |
| 1630 | (> (length newelt) 0)) |
| 1631 | (or keep-all |
| 1632 | (not (equal (car history) newelt)))) |
| 1633 | (if history-delete-duplicates |
| 1634 | (setq history (delete newelt history))) |
| 1635 | (setq history (cons newelt history)) |
| 1636 | (when (integerp maxelt) |
| 1637 | (if (= 0 maxelt) |
| 1638 | (setq history nil) |
| 1639 | (setq tail (nthcdr (1- maxelt) history)) |
| 1640 | (when (consp tail) |
| 1641 | (setcdr tail nil))))) |
| 1642 | (set history-var history))) |
| 1643 | |
| 1644 | \f |
| 1645 | ;;;; Mode hooks. |
| 1646 | |
| 1647 | (defvar delay-mode-hooks nil |
| 1648 | "If non-nil, `run-mode-hooks' should delay running the hooks.") |
| 1649 | (defvar delayed-mode-hooks nil |
| 1650 | "List of delayed mode hooks waiting to be run.") |
| 1651 | (make-variable-buffer-local 'delayed-mode-hooks) |
| 1652 | (put 'delay-mode-hooks 'permanent-local t) |
| 1653 | |
| 1654 | (defvar change-major-mode-after-body-hook nil |
| 1655 | "Normal hook run in major mode functions, before the mode hooks.") |
| 1656 | |
| 1657 | (defvar after-change-major-mode-hook nil |
| 1658 | "Normal hook run at the very end of major mode functions.") |
| 1659 | |
| 1660 | (defun run-mode-hooks (&rest hooks) |
| 1661 | "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. |
| 1662 | If the variable `delay-mode-hooks' is non-nil, does not run any hooks, |
| 1663 | just adds the HOOKS to the list `delayed-mode-hooks'. |
| 1664 | Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook', |
| 1665 | `delayed-mode-hooks' (in reverse order), HOOKS, and finally |
| 1666 | `after-change-major-mode-hook'. Major mode functions should use |
| 1667 | this instead of `run-hooks' when running their FOO-mode-hook." |
| 1668 | (if delay-mode-hooks |
| 1669 | ;; Delaying case. |
| 1670 | (dolist (hook hooks) |
| 1671 | (push hook delayed-mode-hooks)) |
| 1672 | ;; Normal case, just run the hook as before plus any delayed hooks. |
| 1673 | (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) |
| 1674 | (setq delayed-mode-hooks nil) |
| 1675 | (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks)) |
| 1676 | (run-hooks 'after-change-major-mode-hook))) |
| 1677 | |
| 1678 | (defmacro delay-mode-hooks (&rest body) |
| 1679 | "Execute BODY, but delay any `run-mode-hooks'. |
| 1680 | These hooks will be executed by the first following call to |
| 1681 | `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form. |
| 1682 | Only affects hooks run in the current buffer." |
| 1683 | (declare (debug t) (indent 0)) |
| 1684 | `(progn |
| 1685 | (make-local-variable 'delay-mode-hooks) |
| 1686 | (let ((delay-mode-hooks t)) |
| 1687 | ,@body))) |
| 1688 | |
| 1689 | ;; PUBLIC: find if the current mode derives from another. |
| 1690 | |
| 1691 | (defun derived-mode-p (&rest modes) |
| 1692 | "Non-nil if the current major mode is derived from one of MODES. |
| 1693 | Uses the `derived-mode-parent' property of the symbol to trace backwards." |
| 1694 | (let ((parent major-mode)) |
| 1695 | (while (and (not (memq parent modes)) |
| 1696 | (setq parent (get parent 'derived-mode-parent)))) |
| 1697 | parent)) |
| 1698 | \f |
| 1699 | ;;;; Minor modes. |
| 1700 | |
| 1701 | ;; If a minor mode is not defined with define-minor-mode, |
| 1702 | ;; add it here explicitly. |
| 1703 | ;; isearch-mode is deliberately excluded, since you should |
| 1704 | ;; not call it yourself. |
| 1705 | (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode |
| 1706 | overwrite-mode view-mode |
| 1707 | hs-minor-mode) |
| 1708 | "List of all minor mode functions.") |
| 1709 | |
| 1710 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) |
| 1711 | "Register a new minor mode. |
| 1712 | |
| 1713 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. |
| 1714 | |
| 1715 | TOGGLE is a symbol which is the name of a buffer-local variable that |
| 1716 | is toggled on or off to say whether the minor mode is active or not. |
| 1717 | |
| 1718 | NAME specifies what will appear in the mode line when the minor mode |
| 1719 | is active. NAME should be either a string starting with a space, or a |
| 1720 | symbol whose value is such a string. |
| 1721 | |
| 1722 | Optional KEYMAP is the keymap for the minor mode that will be added |
| 1723 | to `minor-mode-map-alist'. |
| 1724 | |
| 1725 | Optional AFTER specifies that TOGGLE should be added after AFTER |
| 1726 | in `minor-mode-alist'. |
| 1727 | |
| 1728 | Optional TOGGLE-FUN is an interactive function to toggle the mode. |
| 1729 | It defaults to (and should by convention be) TOGGLE. |
| 1730 | |
| 1731 | If TOGGLE has a non-nil `:included' property, an entry for the mode is |
| 1732 | included in the mode-line minor mode menu. |
| 1733 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." |
| 1734 | (unless (memq toggle minor-mode-list) |
| 1735 | (push toggle minor-mode-list)) |
| 1736 | |
| 1737 | (unless toggle-fun (setq toggle-fun toggle)) |
| 1738 | (unless (eq toggle-fun toggle) |
| 1739 | (put toggle :minor-mode-function toggle-fun)) |
| 1740 | ;; Add the name to the minor-mode-alist. |
| 1741 | (when name |
| 1742 | (let ((existing (assq toggle minor-mode-alist))) |
| 1743 | (if existing |
| 1744 | (setcdr existing (list name)) |
| 1745 | (let ((tail minor-mode-alist) found) |
| 1746 | (while (and tail (not found)) |
| 1747 | (if (eq after (caar tail)) |
| 1748 | (setq found tail) |
| 1749 | (setq tail (cdr tail)))) |
| 1750 | (if found |
| 1751 | (let ((rest (cdr found))) |
| 1752 | (setcdr found nil) |
| 1753 | (nconc found (list (list toggle name)) rest)) |
| 1754 | (push (list toggle name) minor-mode-alist)))))) |
| 1755 | ;; Add the toggle to the minor-modes menu if requested. |
| 1756 | (when (get toggle :included) |
| 1757 | (define-key mode-line-mode-menu |
| 1758 | (vector toggle) |
| 1759 | (list 'menu-item |
| 1760 | (concat |
| 1761 | (or (get toggle :menu-tag) |
| 1762 | (if (stringp name) name (symbol-name toggle))) |
| 1763 | (let ((mode-name (if (symbolp name) (symbol-value name)))) |
| 1764 | (if (and (stringp mode-name) (string-match "[^ ]+" mode-name)) |
| 1765 | (concat " (" (match-string 0 mode-name) ")")))) |
| 1766 | toggle-fun |
| 1767 | :button (cons :toggle toggle)))) |
| 1768 | |
| 1769 | ;; Add the map to the minor-mode-map-alist. |
| 1770 | (when keymap |
| 1771 | (let ((existing (assq toggle minor-mode-map-alist))) |
| 1772 | (if existing |
| 1773 | (setcdr existing keymap) |
| 1774 | (let ((tail minor-mode-map-alist) found) |
| 1775 | (while (and tail (not found)) |
| 1776 | (if (eq after (caar tail)) |
| 1777 | (setq found tail) |
| 1778 | (setq tail (cdr tail)))) |
| 1779 | (if found |
| 1780 | (let ((rest (cdr found))) |
| 1781 | (setcdr found nil) |
| 1782 | (nconc found (list (cons toggle keymap)) rest)) |
| 1783 | (push (cons toggle keymap) minor-mode-map-alist))))))) |
| 1784 | \f |
| 1785 | ;;;; Load history |
| 1786 | |
| 1787 | (defsubst autoloadp (object) |
| 1788 | "Non-nil if OBJECT is an autoload." |
| 1789 | (eq 'autoload (car-safe object))) |
| 1790 | |
| 1791 | ;; (defun autoload-type (object) |
| 1792 | ;; "Returns the type of OBJECT or `function' or `command' if the type is nil. |
| 1793 | ;; OBJECT should be an autoload object." |
| 1794 | ;; (when (autoloadp object) |
| 1795 | ;; (let ((type (nth 3 object))) |
| 1796 | ;; (cond ((null type) (if (nth 2 object) 'command 'function)) |
| 1797 | ;; ((eq 'keymap t) 'macro) |
| 1798 | ;; (type))))) |
| 1799 | |
| 1800 | ;; (defalias 'autoload-file #'cadr |
| 1801 | ;; "Return the name of the file from which AUTOLOAD will be loaded. |
| 1802 | ;; \n\(fn AUTOLOAD)") |
| 1803 | |
| 1804 | (defun symbol-file (symbol &optional type) |
| 1805 | "Return the name of the file that defined SYMBOL. |
| 1806 | The value is normally an absolute file name. It can also be nil, |
| 1807 | if the definition is not associated with any file. If SYMBOL |
| 1808 | specifies an autoloaded function, the value can be a relative |
| 1809 | file name without extension. |
| 1810 | |
| 1811 | If TYPE is nil, then any kind of definition is acceptable. If |
| 1812 | TYPE is `defun', `defvar', or `defface', that specifies function |
| 1813 | definition, variable definition, or face definition only." |
| 1814 | (if (and (or (null type) (eq type 'defun)) |
| 1815 | (symbolp symbol) |
| 1816 | (autoloadp (symbol-function symbol))) |
| 1817 | (nth 1 (symbol-function symbol)) |
| 1818 | (let ((files load-history) |
| 1819 | file) |
| 1820 | (while files |
| 1821 | (if (if type |
| 1822 | (if (eq type 'defvar) |
| 1823 | ;; Variables are present just as their names. |
| 1824 | (member symbol (cdr (car files))) |
| 1825 | ;; Other types are represented as (TYPE . NAME). |
| 1826 | (member (cons type symbol) (cdr (car files)))) |
| 1827 | ;; We accept all types, so look for variable def |
| 1828 | ;; and then for any other kind. |
| 1829 | (or (member symbol (cdr (car files))) |
| 1830 | (rassq symbol (cdr (car files))))) |
| 1831 | (setq file (car (car files)) files nil)) |
| 1832 | (setq files (cdr files))) |
| 1833 | file))) |
| 1834 | |
| 1835 | (defun locate-library (library &optional nosuffix path interactive-call) |
| 1836 | "Show the precise file name of Emacs library LIBRARY. |
| 1837 | LIBRARY should be a relative file name of the library, a string. |
| 1838 | It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is |
| 1839 | nil (which is the default, see below). |
| 1840 | This command searches the directories in `load-path' like `\\[load-library]' |
| 1841 | to find the file that `\\[load-library] RET LIBRARY RET' would load. |
| 1842 | Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes' |
| 1843 | to the specified name LIBRARY. |
| 1844 | |
| 1845 | If the optional third arg PATH is specified, that list of directories |
| 1846 | is used instead of `load-path'. |
| 1847 | |
| 1848 | When called from a program, the file name is normally returned as a |
| 1849 | string. When run interactively, the argument INTERACTIVE-CALL is t, |
| 1850 | and the file name is displayed in the echo area." |
| 1851 | (interactive (list (completing-read "Locate library: " |
| 1852 | (apply-partially |
| 1853 | 'locate-file-completion-table |
| 1854 | load-path (get-load-suffixes))) |
| 1855 | nil nil |
| 1856 | t)) |
| 1857 | (let ((file (locate-file library |
| 1858 | (or path load-path) |
| 1859 | (append (unless nosuffix (get-load-suffixes)) |
| 1860 | load-file-rep-suffixes)))) |
| 1861 | (if interactive-call |
| 1862 | (if file |
| 1863 | (message "Library is file %s" (abbreviate-file-name file)) |
| 1864 | (message "No library %s in search path" library))) |
| 1865 | file)) |
| 1866 | |
| 1867 | \f |
| 1868 | ;;;; Process stuff. |
| 1869 | |
| 1870 | (defun process-lines (program &rest args) |
| 1871 | "Execute PROGRAM with ARGS, returning its output as a list of lines. |
| 1872 | Signal an error if the program returns with a non-zero exit status." |
| 1873 | (with-temp-buffer |
| 1874 | (let ((status (apply 'call-process program nil (current-buffer) nil args))) |
| 1875 | (unless (eq status 0) |
| 1876 | (error "%s exited with status %s" program status)) |
| 1877 | (goto-char (point-min)) |
| 1878 | (let (lines) |
| 1879 | (while (not (eobp)) |
| 1880 | (setq lines (cons (buffer-substring-no-properties |
| 1881 | (line-beginning-position) |
| 1882 | (line-end-position)) |
| 1883 | lines)) |
| 1884 | (forward-line 1)) |
| 1885 | (nreverse lines))))) |
| 1886 | |
| 1887 | (defun process-live-p (process) |
| 1888 | "Returns non-nil if PROCESS is alive. |
| 1889 | A process is considered alive if its status is `run', `open', |
| 1890 | `listen', `connect' or `stop'. Value is nil if PROCESS is not a |
| 1891 | process." |
| 1892 | (and (processp process) |
| 1893 | (memq (process-status process) |
| 1894 | '(run open listen connect stop)))) |
| 1895 | |
| 1896 | ;; compatibility |
| 1897 | |
| 1898 | (make-obsolete |
| 1899 | 'process-kill-without-query |
| 1900 | "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'." |
| 1901 | "22.1") |
| 1902 | (defun process-kill-without-query (process &optional _flag) |
| 1903 | "Say no query needed if PROCESS is running when Emacs is exited. |
| 1904 | Optional second argument if non-nil says to require a query. |
| 1905 | Value is t if a query was formerly required." |
| 1906 | (let ((old (process-query-on-exit-flag process))) |
| 1907 | (set-process-query-on-exit-flag process nil) |
| 1908 | old)) |
| 1909 | |
| 1910 | (defun process-kill-buffer-query-function () |
| 1911 | "Ask before killing a buffer that has a running process." |
| 1912 | (let ((process (get-buffer-process (current-buffer)))) |
| 1913 | (or (not process) |
| 1914 | (not (memq (process-status process) '(run stop open listen))) |
| 1915 | (not (process-query-on-exit-flag process)) |
| 1916 | (yes-or-no-p |
| 1917 | (format "Buffer %S has a running process; kill it? " |
| 1918 | (buffer-name (current-buffer))))))) |
| 1919 | |
| 1920 | (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function) |
| 1921 | |
| 1922 | ;; process plist management |
| 1923 | |
| 1924 | (defun process-get (process propname) |
| 1925 | "Return the value of PROCESS' PROPNAME property. |
| 1926 | This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." |
| 1927 | (plist-get (process-plist process) propname)) |
| 1928 | |
| 1929 | (defun process-put (process propname value) |
| 1930 | "Change PROCESS' PROPNAME property to VALUE. |
| 1931 | It can be retrieved with `(process-get PROCESS PROPNAME)'." |
| 1932 | (set-process-plist process |
| 1933 | (plist-put (process-plist process) propname value))) |
| 1934 | |
| 1935 | \f |
| 1936 | ;;;; Input and display facilities. |
| 1937 | |
| 1938 | (defconst read-key-empty-map (make-sparse-keymap)) |
| 1939 | |
| 1940 | (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully. |
| 1941 | |
| 1942 | (defun read-key (&optional prompt) |
| 1943 | "Read a key from the keyboard. |
| 1944 | Contrary to `read-event' this will not return a raw event but instead will |
| 1945 | obey the input decoding and translations usually done by `read-key-sequence'. |
| 1946 | So escape sequences and keyboard encoding are taken into account. |
| 1947 | When there's an ambiguity because the key looks like the prefix of |
| 1948 | some sort of escape sequence, the ambiguity is resolved via `read-key-delay'." |
| 1949 | ;; This overriding-terminal-local-map binding also happens to |
| 1950 | ;; disable quail's input methods, so although read-key-sequence |
| 1951 | ;; always inherits the input method, in practice read-key does not |
| 1952 | ;; inherit the input method (at least not if it's based on quail). |
| 1953 | (let ((overriding-terminal-local-map nil) |
| 1954 | (overriding-local-map read-key-empty-map) |
| 1955 | (echo-keystrokes 0) |
| 1956 | (old-global-map (current-global-map)) |
| 1957 | (timer (run-with-idle-timer |
| 1958 | ;; Wait long enough that Emacs has the time to receive and |
| 1959 | ;; process all the raw events associated with the single-key. |
| 1960 | ;; But don't wait too long, or the user may find the delay |
| 1961 | ;; annoying (or keep hitting more keys which may then get |
| 1962 | ;; lost or misinterpreted). |
| 1963 | ;; This is only relevant for keys which Emacs perceives as |
| 1964 | ;; "prefixes", such as C-x (because of the C-x 8 map in |
| 1965 | ;; key-translate-table and the C-x @ map in function-key-map) |
| 1966 | ;; or ESC (because of terminal escape sequences in |
| 1967 | ;; input-decode-map). |
| 1968 | read-key-delay t |
| 1969 | (lambda () |
| 1970 | (let ((keys (this-command-keys-vector))) |
| 1971 | (unless (zerop (length keys)) |
| 1972 | ;; `keys' is non-empty, so the user has hit at least |
| 1973 | ;; one key; there's no point waiting any longer, even |
| 1974 | ;; though read-key-sequence thinks we should wait |
| 1975 | ;; for more input to decide how to interpret the |
| 1976 | ;; current input. |
| 1977 | (throw 'read-key keys))))))) |
| 1978 | (unwind-protect |
| 1979 | (progn |
| 1980 | (use-global-map |
| 1981 | (let ((map (make-sparse-keymap))) |
| 1982 | ;; Don't hide the menu-bar and tool-bar entries. |
| 1983 | (define-key map [menu-bar] (lookup-key global-map [menu-bar])) |
| 1984 | (define-key map [tool-bar] |
| 1985 | ;; This hack avoids evaluating the :filter (Bug#9922). |
| 1986 | (or (cdr (assq 'tool-bar global-map)) |
| 1987 | (lookup-key global-map [tool-bar]))) |
| 1988 | map)) |
| 1989 | (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0)) |
| 1990 | (cancel-timer timer) |
| 1991 | (use-global-map old-global-map)))) |
| 1992 | |
| 1993 | (defvar read-passwd-map |
| 1994 | ;; BEWARE: `defconst' would purecopy it, breaking the sharing with |
| 1995 | ;; minibuffer-local-map along the way! |
| 1996 | (let ((map (make-sparse-keymap))) |
| 1997 | (set-keymap-parent map minibuffer-local-map) |
| 1998 | (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570 |
| 1999 | map) |
| 2000 | "Keymap used while reading passwords.") |
| 2001 | |
| 2002 | (defun read-passwd (prompt &optional confirm default) |
| 2003 | "Read a password, prompting with PROMPT, and return it. |
| 2004 | If optional CONFIRM is non-nil, read the password twice to make sure. |
| 2005 | Optional DEFAULT is a default password to use instead of empty input. |
| 2006 | |
| 2007 | This function echoes `.' for each character that the user types. |
| 2008 | |
| 2009 | Once the caller uses the password, it can erase the password |
| 2010 | by doing (clear-string STRING)." |
| 2011 | (if confirm |
| 2012 | (let (success) |
| 2013 | (while (not success) |
| 2014 | (let ((first (read-passwd prompt nil default)) |
| 2015 | (second (read-passwd "Confirm password: " nil default))) |
| 2016 | (if (equal first second) |
| 2017 | (progn |
| 2018 | (and (arrayp second) (clear-string second)) |
| 2019 | (setq success first)) |
| 2020 | (and (arrayp first) (clear-string first)) |
| 2021 | (and (arrayp second) (clear-string second)) |
| 2022 | (message "Password not repeated accurately; please start over") |
| 2023 | (sit-for 1)))) |
| 2024 | success) |
| 2025 | (let ((hide-chars-fun |
| 2026 | (lambda (beg end _len) |
| 2027 | (clear-this-command-keys) |
| 2028 | (setq beg (min end (max (minibuffer-prompt-end) |
| 2029 | beg))) |
| 2030 | (dotimes (i (- end beg)) |
| 2031 | (put-text-property (+ i beg) (+ 1 i beg) |
| 2032 | 'display (string ?.))))) |
| 2033 | minibuf) |
| 2034 | (minibuffer-with-setup-hook |
| 2035 | (lambda () |
| 2036 | (setq minibuf (current-buffer)) |
| 2037 | ;; Turn off electricity. |
| 2038 | (setq-local post-self-insert-hook nil) |
| 2039 | (setq-local buffer-undo-list t) |
| 2040 | (setq-local select-active-regions nil) |
| 2041 | (use-local-map read-passwd-map) |
| 2042 | (setq-local inhibit-modification-hooks nil) ;bug#15501. |
| 2043 | (setq-local show-paren-mode nil) ;bug#16091. |
| 2044 | (add-hook 'after-change-functions hide-chars-fun nil 'local)) |
| 2045 | (unwind-protect |
| 2046 | (let ((enable-recursive-minibuffers t)) |
| 2047 | (read-string prompt nil t default)) ; t = "no history" |
| 2048 | (when (buffer-live-p minibuf) |
| 2049 | (with-current-buffer minibuf |
| 2050 | ;; Not sure why but it seems that there might be cases where the |
| 2051 | ;; minibuffer is not always properly reset later on, so undo |
| 2052 | ;; whatever we've done here (bug#11392). |
| 2053 | (remove-hook 'after-change-functions hide-chars-fun 'local) |
| 2054 | (kill-local-variable 'post-self-insert-hook) |
| 2055 | ;; And of course, don't keep the sensitive data around. |
| 2056 | (erase-buffer)))))))) |
| 2057 | |
| 2058 | (defun read-number (prompt &optional default) |
| 2059 | "Read a numeric value in the minibuffer, prompting with PROMPT. |
| 2060 | DEFAULT specifies a default value to return if the user just types RET. |
| 2061 | The value of DEFAULT is inserted into PROMPT. |
| 2062 | This function is used by the `interactive' code letter `n'." |
| 2063 | (let ((n nil) |
| 2064 | (default1 (if (consp default) (car default) default))) |
| 2065 | (when default1 |
| 2066 | (setq prompt |
| 2067 | (if (string-match "\\(\\):[ \t]*\\'" prompt) |
| 2068 | (replace-match (format " (default %s)" default1) t t prompt 1) |
| 2069 | (replace-regexp-in-string "[ \t]*\\'" |
| 2070 | (format " (default %s) " default1) |
| 2071 | prompt t t)))) |
| 2072 | (while |
| 2073 | (progn |
| 2074 | (let ((str (read-from-minibuffer |
| 2075 | prompt nil nil nil nil |
| 2076 | (when default |
| 2077 | (if (consp default) |
| 2078 | (mapcar 'number-to-string (delq nil default)) |
| 2079 | (number-to-string default)))))) |
| 2080 | (condition-case nil |
| 2081 | (setq n (cond |
| 2082 | ((zerop (length str)) default1) |
| 2083 | ((stringp str) (read str)))) |
| 2084 | (error nil))) |
| 2085 | (unless (numberp n) |
| 2086 | (message "Please enter a number.") |
| 2087 | (sit-for 1) |
| 2088 | t))) |
| 2089 | n)) |
| 2090 | |
| 2091 | (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit) |
| 2092 | "Read and return one of CHARS, prompting for PROMPT. |
| 2093 | Any input that is not one of CHARS is ignored. |
| 2094 | |
| 2095 | If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore |
| 2096 | keyboard-quit events while waiting for a valid input." |
| 2097 | (unless (consp chars) |
| 2098 | (error "Called `read-char-choice' without valid char choices")) |
| 2099 | (let (char done show-help (helpbuf " *Char Help*")) |
| 2100 | (let ((cursor-in-echo-area t) |
| 2101 | (executing-kbd-macro executing-kbd-macro) |
| 2102 | (esc-flag nil)) |
| 2103 | (save-window-excursion ; in case we call help-form-show |
| 2104 | (while (not done) |
| 2105 | (unless (get-text-property 0 'face prompt) |
| 2106 | (setq prompt (propertize prompt 'face 'minibuffer-prompt))) |
| 2107 | (setq char (let ((inhibit-quit inhibit-keyboard-quit)) |
| 2108 | (read-key prompt))) |
| 2109 | (and show-help (buffer-live-p (get-buffer helpbuf)) |
| 2110 | (kill-buffer helpbuf)) |
| 2111 | (cond |
| 2112 | ((not (numberp char))) |
| 2113 | ;; If caller has set help-form, that's enough. |
| 2114 | ;; They don't explicitly have to add help-char to chars. |
| 2115 | ((and help-form |
| 2116 | (eq char help-char) |
| 2117 | (setq show-help t) |
| 2118 | (help-form-show))) |
| 2119 | ((memq char chars) |
| 2120 | (setq done t)) |
| 2121 | ((and executing-kbd-macro (= char -1)) |
| 2122 | ;; read-event returns -1 if we are in a kbd macro and |
| 2123 | ;; there are no more events in the macro. Attempt to |
| 2124 | ;; get an event interactively. |
| 2125 | (setq executing-kbd-macro nil)) |
| 2126 | ((not inhibit-keyboard-quit) |
| 2127 | (cond |
| 2128 | ((and (null esc-flag) (eq char ?\e)) |
| 2129 | (setq esc-flag t)) |
| 2130 | ((memq char '(?\C-g ?\e)) |
| 2131 | (keyboard-quit)))))))) |
| 2132 | ;; Display the question with the answer. But without cursor-in-echo-area. |
| 2133 | (message "%s%s" prompt (char-to-string char)) |
| 2134 | char)) |
| 2135 | |
| 2136 | (defun sit-for (seconds &optional nodisp obsolete) |
| 2137 | "Perform redisplay, then wait for SECONDS seconds or until input is available. |
| 2138 | SECONDS may be a floating-point value. |
| 2139 | \(On operating systems that do not support waiting for fractions of a |
| 2140 | second, floating-point values are rounded down to the nearest integer.) |
| 2141 | |
| 2142 | If optional arg NODISP is t, don't redisplay, just wait for input. |
| 2143 | Redisplay does not happen if input is available before it starts. |
| 2144 | |
| 2145 | Value is t if waited the full time with no input arriving, and nil otherwise. |
| 2146 | |
| 2147 | An obsolete, but still supported form is |
| 2148 | \(sit-for SECONDS &optional MILLISECONDS NODISP) |
| 2149 | where the optional arg MILLISECONDS specifies an additional wait period, |
| 2150 | in milliseconds; this was useful when Emacs was built without |
| 2151 | floating point support." |
| 2152 | (declare (advertised-calling-convention (seconds &optional nodisp) "22.1")) |
| 2153 | (if (numberp nodisp) |
| 2154 | (setq seconds (+ seconds (* 1e-3 nodisp)) |
| 2155 | nodisp obsolete) |
| 2156 | (if obsolete (setq nodisp obsolete))) |
| 2157 | (cond |
| 2158 | (noninteractive |
| 2159 | (sleep-for seconds) |
| 2160 | t) |
| 2161 | ((input-pending-p t) |
| 2162 | nil) |
| 2163 | ((<= seconds 0) |
| 2164 | (or nodisp (redisplay))) |
| 2165 | (t |
| 2166 | (or nodisp (redisplay)) |
| 2167 | ;; FIXME: we should not read-event here at all, because it's much too |
| 2168 | ;; difficult to reliably "undo" a read-event by pushing it onto |
| 2169 | ;; unread-command-events. |
| 2170 | (let ((read (read-event nil t seconds))) |
| 2171 | (or (null read) |
| 2172 | (progn |
| 2173 | ;; If last command was a prefix arg, e.g. C-u, push this event onto |
| 2174 | ;; unread-command-events as (t . EVENT) so it will be added to |
| 2175 | ;; this-command-keys by read-key-sequence. |
| 2176 | (if (eq overriding-terminal-local-map universal-argument-map) |
| 2177 | (setq read (cons t read))) |
| 2178 | (push read unread-command-events) |
| 2179 | nil)))))) |
| 2180 | |
| 2181 | ;; Behind display-popup-menus-p test. |
| 2182 | (declare-function x-popup-dialog "menu.c" (position contents &optional header)) |
| 2183 | |
| 2184 | (defun y-or-n-p (prompt) |
| 2185 | "Ask user a \"y or n\" question. Return t if answer is \"y\". |
| 2186 | PROMPT is the string to display to ask the question. It should |
| 2187 | end in a space; `y-or-n-p' adds \"(y or n) \" to it. |
| 2188 | |
| 2189 | No confirmation of the answer is requested; a single character is |
| 2190 | enough. SPC also means yes, and DEL means no. |
| 2191 | |
| 2192 | To be precise, this function translates user input into responses |
| 2193 | by consulting the bindings in `query-replace-map'; see the |
| 2194 | documentation of that variable for more information. In this |
| 2195 | case, the useful bindings are `act', `skip', `recenter', |
| 2196 | `scroll-up', `scroll-down', and `quit'. |
| 2197 | An `act' response means yes, and a `skip' response means no. |
| 2198 | A `quit' response means to invoke `keyboard-quit'. |
| 2199 | If the user enters `recenter', `scroll-up', or `scroll-down' |
| 2200 | responses, perform the requested window recentering or scrolling |
| 2201 | and ask again. |
| 2202 | |
| 2203 | Under a windowing system a dialog box will be used if `last-nonmenu-event' |
| 2204 | is nil and `use-dialog-box' is non-nil." |
| 2205 | ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state |
| 2206 | ;; where all the keys were unbound (i.e. it somehow got triggered |
| 2207 | ;; within read-key, apparently). I had to kill it. |
| 2208 | (let ((answer 'recenter)) |
| 2209 | (cond |
| 2210 | (noninteractive |
| 2211 | (setq prompt (concat prompt |
| 2212 | (if (or (zerop (length prompt)) |
| 2213 | (eq ?\s (aref prompt (1- (length prompt))))) |
| 2214 | "" " ") |
| 2215 | "(y or n) ")) |
| 2216 | (let ((temp-prompt prompt)) |
| 2217 | (while (not (memq answer '(act skip))) |
| 2218 | (let ((str (read-string temp-prompt))) |
| 2219 | (cond ((member str '("y" "Y")) (setq answer 'act)) |
| 2220 | ((member str '("n" "N")) (setq answer 'skip)) |
| 2221 | (t (setq temp-prompt (concat "Please answer y or n. " |
| 2222 | prompt)))))))) |
| 2223 | ((and (display-popup-menus-p) |
| 2224 | (listp last-nonmenu-event) |
| 2225 | use-dialog-box) |
| 2226 | (setq answer |
| 2227 | (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip))))) |
| 2228 | (t |
| 2229 | (setq prompt (concat prompt |
| 2230 | (if (or (zerop (length prompt)) |
| 2231 | (eq ?\s (aref prompt (1- (length prompt))))) |
| 2232 | "" " ") |
| 2233 | "(y or n) ")) |
| 2234 | (while |
| 2235 | (let* ((scroll-actions '(recenter scroll-up scroll-down |
| 2236 | scroll-other-window scroll-other-window-down)) |
| 2237 | (key |
| 2238 | (let ((cursor-in-echo-area t)) |
| 2239 | (when minibuffer-auto-raise |
| 2240 | (raise-frame (window-frame (minibuffer-window)))) |
| 2241 | (read-key (propertize (if (memq answer scroll-actions) |
| 2242 | prompt |
| 2243 | (concat "Please answer y or n. " |
| 2244 | prompt)) |
| 2245 | 'face 'minibuffer-prompt))))) |
| 2246 | (setq answer (lookup-key query-replace-map (vector key) t)) |
| 2247 | (cond |
| 2248 | ((memq answer '(skip act)) nil) |
| 2249 | ((eq answer 'recenter) |
| 2250 | (recenter) t) |
| 2251 | ((eq answer 'scroll-up) |
| 2252 | (ignore-errors (scroll-up-command)) t) |
| 2253 | ((eq answer 'scroll-down) |
| 2254 | (ignore-errors (scroll-down-command)) t) |
| 2255 | ((eq answer 'scroll-other-window) |
| 2256 | (ignore-errors (scroll-other-window)) t) |
| 2257 | ((eq answer 'scroll-other-window-down) |
| 2258 | (ignore-errors (scroll-other-window-down)) t) |
| 2259 | ((or (memq answer '(exit-prefix quit)) (eq key ?\e)) |
| 2260 | (signal 'quit nil) t) |
| 2261 | (t t))) |
| 2262 | (ding) |
| 2263 | (discard-input)))) |
| 2264 | (let ((ret (eq answer 'act))) |
| 2265 | (unless noninteractive |
| 2266 | ;; FIXME this prints one too many spaces, since prompt |
| 2267 | ;; already ends in a space. Eg "... (y or n) y". |
| 2268 | (message "%s %s" prompt (if ret "y" "n"))) |
| 2269 | ret))) |
| 2270 | |
| 2271 | \f |
| 2272 | ;;; Atomic change groups. |
| 2273 | |
| 2274 | (defmacro atomic-change-group (&rest body) |
| 2275 | "Perform BODY as an atomic change group. |
| 2276 | This means that if BODY exits abnormally, |
| 2277 | all of its changes to the current buffer are undone. |
| 2278 | This works regardless of whether undo is enabled in the buffer. |
| 2279 | |
| 2280 | This mechanism is transparent to ordinary use of undo; |
| 2281 | if undo is enabled in the buffer and BODY succeeds, the |
| 2282 | user can undo the change normally." |
| 2283 | (declare (indent 0) (debug t)) |
| 2284 | (let ((handle (make-symbol "--change-group-handle--")) |
| 2285 | (success (make-symbol "--change-group-success--"))) |
| 2286 | `(let ((,handle (prepare-change-group)) |
| 2287 | ;; Don't truncate any undo data in the middle of this. |
| 2288 | (undo-outer-limit nil) |
| 2289 | (undo-limit most-positive-fixnum) |
| 2290 | (undo-strong-limit most-positive-fixnum) |
| 2291 | (,success nil)) |
| 2292 | (unwind-protect |
| 2293 | (progn |
| 2294 | ;; This is inside the unwind-protect because |
| 2295 | ;; it enables undo if that was disabled; we need |
| 2296 | ;; to make sure that it gets disabled again. |
| 2297 | (activate-change-group ,handle) |
| 2298 | ,@body |
| 2299 | (setq ,success t)) |
| 2300 | ;; Either of these functions will disable undo |
| 2301 | ;; if it was disabled before. |
| 2302 | (if ,success |
| 2303 | (accept-change-group ,handle) |
| 2304 | (cancel-change-group ,handle)))))) |
| 2305 | |
| 2306 | (defun prepare-change-group (&optional buffer) |
| 2307 | "Return a handle for the current buffer's state, for a change group. |
| 2308 | If you specify BUFFER, make a handle for BUFFER's state instead. |
| 2309 | |
| 2310 | Pass the handle to `activate-change-group' afterward to initiate |
| 2311 | the actual changes of the change group. |
| 2312 | |
| 2313 | To finish the change group, call either `accept-change-group' or |
| 2314 | `cancel-change-group' passing the same handle as argument. Call |
| 2315 | `accept-change-group' to accept the changes in the group as final; |
| 2316 | call `cancel-change-group' to undo them all. You should use |
| 2317 | `unwind-protect' to make sure the group is always finished. The call |
| 2318 | to `activate-change-group' should be inside the `unwind-protect'. |
| 2319 | Once you finish the group, don't use the handle again--don't try to |
| 2320 | finish the same group twice. For a simple example of correct use, see |
| 2321 | the source code of `atomic-change-group'. |
| 2322 | |
| 2323 | The handle records only the specified buffer. To make a multibuffer |
| 2324 | change group, call this function once for each buffer you want to |
| 2325 | cover, then use `nconc' to combine the returned values, like this: |
| 2326 | |
| 2327 | (nconc (prepare-change-group buffer-1) |
| 2328 | (prepare-change-group buffer-2)) |
| 2329 | |
| 2330 | You can then activate that multibuffer change group with a single |
| 2331 | call to `activate-change-group' and finish it with a single call |
| 2332 | to `accept-change-group' or `cancel-change-group'." |
| 2333 | |
| 2334 | (if buffer |
| 2335 | (list (cons buffer (with-current-buffer buffer buffer-undo-list))) |
| 2336 | (list (cons (current-buffer) buffer-undo-list)))) |
| 2337 | |
| 2338 | (defun activate-change-group (handle) |
| 2339 | "Activate a change group made with `prepare-change-group' (which see)." |
| 2340 | (dolist (elt handle) |
| 2341 | (with-current-buffer (car elt) |
| 2342 | (if (eq buffer-undo-list t) |
| 2343 | (setq buffer-undo-list nil))))) |
| 2344 | |
| 2345 | (defun accept-change-group (handle) |
| 2346 | "Finish a change group made with `prepare-change-group' (which see). |
| 2347 | This finishes the change group by accepting its changes as final." |
| 2348 | (dolist (elt handle) |
| 2349 | (with-current-buffer (car elt) |
| 2350 | (if (eq (cdr elt) t) |
| 2351 | (setq buffer-undo-list t))))) |
| 2352 | |
| 2353 | (defun cancel-change-group (handle) |
| 2354 | "Finish a change group made with `prepare-change-group' (which see). |
| 2355 | This finishes the change group by reverting all of its changes." |
| 2356 | (dolist (elt handle) |
| 2357 | (with-current-buffer (car elt) |
| 2358 | (setq elt (cdr elt)) |
| 2359 | (save-restriction |
| 2360 | ;; Widen buffer temporarily so if the buffer was narrowed within |
| 2361 | ;; the body of `atomic-change-group' all changes can be undone. |
| 2362 | (widen) |
| 2363 | (let ((old-car |
| 2364 | (if (consp elt) (car elt))) |
| 2365 | (old-cdr |
| 2366 | (if (consp elt) (cdr elt)))) |
| 2367 | ;; Temporarily truncate the undo log at ELT. |
| 2368 | (when (consp elt) |
| 2369 | (setcar elt nil) (setcdr elt nil)) |
| 2370 | (unless (eq last-command 'undo) (undo-start)) |
| 2371 | ;; Make sure there's no confusion. |
| 2372 | (when (and (consp elt) (not (eq elt (last pending-undo-list)))) |
| 2373 | (error "Undoing to some unrelated state")) |
| 2374 | ;; Undo it all. |
| 2375 | (save-excursion |
| 2376 | (while (listp pending-undo-list) (undo-more 1))) |
| 2377 | ;; Reset the modified cons cell ELT to its original content. |
| 2378 | (when (consp elt) |
| 2379 | (setcar elt old-car) |
| 2380 | (setcdr elt old-cdr)) |
| 2381 | ;; Revert the undo info to what it was when we grabbed the state. |
| 2382 | (setq buffer-undo-list elt)))))) |
| 2383 | \f |
| 2384 | ;;;; Display-related functions. |
| 2385 | |
| 2386 | ;; For compatibility. |
| 2387 | (define-obsolete-function-alias 'redraw-modeline |
| 2388 | 'force-mode-line-update "24.3") |
| 2389 | |
| 2390 | (defun momentary-string-display (string pos &optional exit-char message) |
| 2391 | "Momentarily display STRING in the buffer at POS. |
| 2392 | Display remains until next event is input. |
| 2393 | If POS is a marker, only its position is used; its buffer is ignored. |
| 2394 | Optional third arg EXIT-CHAR can be a character, event or event |
| 2395 | description list. EXIT-CHAR defaults to SPC. If the input is |
| 2396 | EXIT-CHAR it is swallowed; otherwise it is then available as |
| 2397 | input (as a command if nothing else). |
| 2398 | Display MESSAGE (optional fourth arg) in the echo area. |
| 2399 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." |
| 2400 | (or exit-char (setq exit-char ?\s)) |
| 2401 | (let ((ol (make-overlay pos pos)) |
| 2402 | (str (copy-sequence string))) |
| 2403 | (unwind-protect |
| 2404 | (progn |
| 2405 | (save-excursion |
| 2406 | (overlay-put ol 'after-string str) |
| 2407 | (goto-char pos) |
| 2408 | ;; To avoid trouble with out-of-bounds position |
| 2409 | (setq pos (point)) |
| 2410 | ;; If the string end is off screen, recenter now. |
| 2411 | (if (<= (window-end nil t) pos) |
| 2412 | (recenter (/ (window-height) 2)))) |
| 2413 | (message (or message "Type %s to continue editing.") |
| 2414 | (single-key-description exit-char)) |
| 2415 | (let ((event (read-key))) |
| 2416 | ;; `exit-char' can be an event, or an event description list. |
| 2417 | (or (eq event exit-char) |
| 2418 | (eq event (event-convert-list exit-char)) |
| 2419 | (setq unread-command-events |
| 2420 | (append (this-single-command-raw-keys)))))) |
| 2421 | (delete-overlay ol)))) |
| 2422 | |
| 2423 | \f |
| 2424 | ;;;; Overlay operations |
| 2425 | |
| 2426 | (defun copy-overlay (o) |
| 2427 | "Return a copy of overlay O." |
| 2428 | (let ((o1 (if (overlay-buffer o) |
| 2429 | (make-overlay (overlay-start o) (overlay-end o) |
| 2430 | ;; FIXME: there's no easy way to find the |
| 2431 | ;; insertion-type of the two markers. |
| 2432 | (overlay-buffer o)) |
| 2433 | (let ((o1 (make-overlay (point-min) (point-min)))) |
| 2434 | (delete-overlay o1) |
| 2435 | o1))) |
| 2436 | (props (overlay-properties o))) |
| 2437 | (while props |
| 2438 | (overlay-put o1 (pop props) (pop props))) |
| 2439 | o1)) |
| 2440 | |
| 2441 | (defun remove-overlays (&optional beg end name val) |
| 2442 | "Clear BEG and END of overlays whose property NAME has value VAL. |
| 2443 | Overlays might be moved and/or split. |
| 2444 | BEG and END default respectively to the beginning and end of buffer." |
| 2445 | ;; This speeds up the loops over overlays. |
| 2446 | (unless beg (setq beg (point-min))) |
| 2447 | (unless end (setq end (point-max))) |
| 2448 | (overlay-recenter end) |
| 2449 | (if (< end beg) |
| 2450 | (setq beg (prog1 end (setq end beg)))) |
| 2451 | (save-excursion |
| 2452 | (dolist (o (overlays-in beg end)) |
| 2453 | (when (eq (overlay-get o name) val) |
| 2454 | ;; Either push this overlay outside beg...end |
| 2455 | ;; or split it to exclude beg...end |
| 2456 | ;; or delete it entirely (if it is contained in beg...end). |
| 2457 | (if (< (overlay-start o) beg) |
| 2458 | (if (> (overlay-end o) end) |
| 2459 | (progn |
| 2460 | (move-overlay (copy-overlay o) |
| 2461 | (overlay-start o) beg) |
| 2462 | (move-overlay o end (overlay-end o))) |
| 2463 | (move-overlay o (overlay-start o) beg)) |
| 2464 | (if (> (overlay-end o) end) |
| 2465 | (move-overlay o end (overlay-end o)) |
| 2466 | (delete-overlay o))))))) |
| 2467 | \f |
| 2468 | ;;;; Miscellanea. |
| 2469 | |
| 2470 | (defvar suspend-hook nil |
| 2471 | "Normal hook run by `suspend-emacs', before suspending.") |
| 2472 | |
| 2473 | (defvar suspend-resume-hook nil |
| 2474 | "Normal hook run by `suspend-emacs', after Emacs is continued.") |
| 2475 | |
| 2476 | (defvar temp-buffer-show-hook nil |
| 2477 | "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer. |
| 2478 | When the hook runs, the temporary buffer is current, and the window it |
| 2479 | was displayed in is selected.") |
| 2480 | |
| 2481 | (defvar temp-buffer-setup-hook nil |
| 2482 | "Normal hook run by `with-output-to-temp-buffer' at the start. |
| 2483 | When the hook runs, the temporary buffer is current. |
| 2484 | This hook is normally set up with a function to put the buffer in Help |
| 2485 | mode.") |
| 2486 | |
| 2487 | (defconst user-emacs-directory |
| 2488 | (if (eq system-type 'ms-dos) |
| 2489 | ;; MS-DOS cannot have initial dot. |
| 2490 | "~/_emacs.d/" |
| 2491 | "~/.emacs.d/") |
| 2492 | "Directory beneath which additional per-user Emacs-specific files are placed. |
| 2493 | Various programs in Emacs store information in this directory. |
| 2494 | Note that this should end with a directory separator. |
| 2495 | See also `locate-user-emacs-file'.") |
| 2496 | \f |
| 2497 | ;;;; Misc. useful functions. |
| 2498 | |
| 2499 | (defsubst buffer-narrowed-p () |
| 2500 | "Return non-nil if the current buffer is narrowed." |
| 2501 | (/= (- (point-max) (point-min)) (buffer-size))) |
| 2502 | |
| 2503 | (defun find-tag-default-bounds () |
| 2504 | "Determine the boundaries of the default tag, based on text at point. |
| 2505 | Return a cons cell with the beginning and end of the found tag. |
| 2506 | If there is no plausible default, return nil." |
| 2507 | (let (from to bound) |
| 2508 | (when (or (progn |
| 2509 | ;; Look at text around `point'. |
| 2510 | (save-excursion |
| 2511 | (skip-syntax-backward "w_") (setq from (point))) |
| 2512 | (save-excursion |
| 2513 | (skip-syntax-forward "w_") (setq to (point))) |
| 2514 | (> to from)) |
| 2515 | ;; Look between `line-beginning-position' and `point'. |
| 2516 | (save-excursion |
| 2517 | (and (setq bound (line-beginning-position)) |
| 2518 | (skip-syntax-backward "^w_" bound) |
| 2519 | (> (setq to (point)) bound) |
| 2520 | (skip-syntax-backward "w_") |
| 2521 | (setq from (point)))) |
| 2522 | ;; Look between `point' and `line-end-position'. |
| 2523 | (save-excursion |
| 2524 | (and (setq bound (line-end-position)) |
| 2525 | (skip-syntax-forward "^w_" bound) |
| 2526 | (< (setq from (point)) bound) |
| 2527 | (skip-syntax-forward "w_") |
| 2528 | (setq to (point))))) |
| 2529 | (cons from to)))) |
| 2530 | |
| 2531 | (defun find-tag-default () |
| 2532 | "Determine default tag to search for, based on text at point. |
| 2533 | If there is no plausible default, return nil." |
| 2534 | (let ((bounds (find-tag-default-bounds))) |
| 2535 | (when bounds |
| 2536 | (buffer-substring-no-properties (car bounds) (cdr bounds))))) |
| 2537 | |
| 2538 | (defun find-tag-default-as-regexp () |
| 2539 | "Return regexp that matches the default tag at point. |
| 2540 | If there is no tag at point, return nil. |
| 2541 | |
| 2542 | When in a major mode that does not provide its own |
| 2543 | `find-tag-default-function', return a regexp that matches the |
| 2544 | symbol at point exactly." |
| 2545 | (let ((tag (funcall (or find-tag-default-function |
| 2546 | (get major-mode 'find-tag-default-function) |
| 2547 | 'find-tag-default)))) |
| 2548 | (if tag (regexp-quote tag)))) |
| 2549 | |
| 2550 | (defun find-tag-default-as-symbol-regexp () |
| 2551 | "Return regexp that matches the default tag at point as symbol. |
| 2552 | If there is no tag at point, return nil. |
| 2553 | |
| 2554 | When in a major mode that does not provide its own |
| 2555 | `find-tag-default-function', return a regexp that matches the |
| 2556 | symbol at point exactly." |
| 2557 | (let ((tag-regexp (find-tag-default-as-regexp))) |
| 2558 | (if (and tag-regexp |
| 2559 | (eq (or find-tag-default-function |
| 2560 | (get major-mode 'find-tag-default-function) |
| 2561 | 'find-tag-default) |
| 2562 | 'find-tag-default)) |
| 2563 | (format "\\_<%s\\_>" tag-regexp) |
| 2564 | tag-regexp))) |
| 2565 | |
| 2566 | (defun play-sound (sound) |
| 2567 | "SOUND is a list of the form `(sound KEYWORD VALUE...)'. |
| 2568 | The following keywords are recognized: |
| 2569 | |
| 2570 | :file FILE - read sound data from FILE. If FILE isn't an |
| 2571 | absolute file name, it is searched in `data-directory'. |
| 2572 | |
| 2573 | :data DATA - read sound data from string DATA. |
| 2574 | |
| 2575 | Exactly one of :file or :data must be present. |
| 2576 | |
| 2577 | :volume VOL - set volume to VOL. VOL must an integer in the |
| 2578 | range 0..100 or a float in the range 0..1.0. If not specified, |
| 2579 | don't change the volume setting of the sound device. |
| 2580 | |
| 2581 | :device DEVICE - play sound on DEVICE. If not specified, |
| 2582 | a system-dependent default device name is used. |
| 2583 | |
| 2584 | Note: :data and :device are currently not supported on Windows." |
| 2585 | (if (fboundp 'play-sound-internal) |
| 2586 | (play-sound-internal sound) |
| 2587 | (error "This Emacs binary lacks sound support"))) |
| 2588 | |
| 2589 | (declare-function w32-shell-dos-semantics "w32-fns" nil) |
| 2590 | |
| 2591 | (defun shell-quote-argument (argument) |
| 2592 | "Quote ARGUMENT for passing as argument to an inferior shell." |
| 2593 | (cond |
| 2594 | ((eq system-type 'ms-dos) |
| 2595 | ;; Quote using double quotes, but escape any existing quotes in |
| 2596 | ;; the argument with backslashes. |
| 2597 | (let ((result "") |
| 2598 | (start 0) |
| 2599 | end) |
| 2600 | (if (or (null (string-match "[^\"]" argument)) |
| 2601 | (< (match-end 0) (length argument))) |
| 2602 | (while (string-match "[\"]" argument start) |
| 2603 | (setq end (match-beginning 0) |
| 2604 | result (concat result (substring argument start end) |
| 2605 | "\\" (substring argument end (1+ end))) |
| 2606 | start (1+ end)))) |
| 2607 | (concat "\"" result (substring argument start) "\""))) |
| 2608 | |
| 2609 | ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics)) |
| 2610 | |
| 2611 | ;; First, quote argument so that CommandLineToArgvW will |
| 2612 | ;; understand it. See |
| 2613 | ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx |
| 2614 | ;; After we perform that level of quoting, escape shell |
| 2615 | ;; metacharacters so that cmd won't mangle our argument. If the |
| 2616 | ;; argument contains no double quote characters, we can just |
| 2617 | ;; surround it with double quotes. Otherwise, we need to prefix |
| 2618 | ;; each shell metacharacter with a caret. |
| 2619 | |
| 2620 | (setq argument |
| 2621 | ;; escape backslashes at end of string |
| 2622 | (replace-regexp-in-string |
| 2623 | "\\(\\\\*\\)$" |
| 2624 | "\\1\\1" |
| 2625 | ;; escape backslashes and quotes in string body |
| 2626 | (replace-regexp-in-string |
| 2627 | "\\(\\\\*\\)\"" |
| 2628 | "\\1\\1\\\\\"" |
| 2629 | argument))) |
| 2630 | |
| 2631 | (if (string-match "[%!\"]" argument) |
| 2632 | (concat |
| 2633 | "^\"" |
| 2634 | (replace-regexp-in-string |
| 2635 | "\\([%!()\"<>&|^]\\)" |
| 2636 | "^\\1" |
| 2637 | argument) |
| 2638 | "^\"") |
| 2639 | (concat "\"" argument "\""))) |
| 2640 | |
| 2641 | (t |
| 2642 | (if (equal argument "") |
| 2643 | "''" |
| 2644 | ;; Quote everything except POSIX filename characters. |
| 2645 | ;; This should be safe enough even for really weird shells. |
| 2646 | (replace-regexp-in-string |
| 2647 | "\n" "'\n'" |
| 2648 | (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument)))) |
| 2649 | )) |
| 2650 | |
| 2651 | (defun string-or-null-p (object) |
| 2652 | "Return t if OBJECT is a string or nil. |
| 2653 | Otherwise, return nil." |
| 2654 | (or (stringp object) (null object))) |
| 2655 | |
| 2656 | (defun booleanp (object) |
| 2657 | "Return t if OBJECT is one of the two canonical boolean values: t or nil. |
| 2658 | Otherwise, return nil." |
| 2659 | (and (memq object '(nil t)) t)) |
| 2660 | |
| 2661 | (defun special-form-p (object) |
| 2662 | "Non-nil if and only if OBJECT is a special form." |
| 2663 | (if (and (symbolp object) (fboundp object)) |
| 2664 | (setq object (indirect-function object t))) |
| 2665 | (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled))) |
| 2666 | |
| 2667 | (defun macrop (object) |
| 2668 | "Non-nil if and only if OBJECT is a macro." |
| 2669 | (let ((def (indirect-function object t))) |
| 2670 | (when (consp def) |
| 2671 | (or (eq 'macro (car def)) |
| 2672 | (and (autoloadp def) (memq (nth 4 def) '(macro t))))))) |
| 2673 | |
| 2674 | (defun field-at-pos (pos) |
| 2675 | "Return the field at position POS, taking stickiness etc into account." |
| 2676 | (let ((raw-field (get-char-property (field-beginning pos) 'field))) |
| 2677 | (if (eq raw-field 'boundary) |
| 2678 | (get-char-property (1- (field-end pos)) 'field) |
| 2679 | raw-field))) |
| 2680 | |
| 2681 | (defun sha1 (object &optional start end binary) |
| 2682 | "Return the SHA1 (Secure Hash Algorithm) of an OBJECT. |
| 2683 | OBJECT is either a string or a buffer. Optional arguments START and |
| 2684 | END are character positions specifying which portion of OBJECT for |
| 2685 | computing the hash. If BINARY is non-nil, return a string in binary |
| 2686 | form." |
| 2687 | (secure-hash 'sha1 object start end binary)) |
| 2688 | |
| 2689 | (defun function-get (f prop &optional autoload) |
| 2690 | "Return the value of property PROP of function F. |
| 2691 | If AUTOLOAD is non-nil and F is autoloaded, try to autoload it |
| 2692 | in the hope that it will set PROP. If AUTOLOAD is `macro', only do it |
| 2693 | if it's an autoloaded macro." |
| 2694 | (let ((val nil)) |
| 2695 | (while (and (symbolp f) |
| 2696 | (null (setq val (get f prop))) |
| 2697 | (fboundp f)) |
| 2698 | (let ((fundef (symbol-function f))) |
| 2699 | (if (and autoload (autoloadp fundef) |
| 2700 | (not (equal fundef |
| 2701 | (autoload-do-load fundef f |
| 2702 | (if (eq autoload 'macro) |
| 2703 | 'macro))))) |
| 2704 | nil ;Re-try `get' on the same `f'. |
| 2705 | (setq f fundef)))) |
| 2706 | val)) |
| 2707 | \f |
| 2708 | ;;;; Support for yanking and text properties. |
| 2709 | ;; Why here in subr.el rather than in simple.el? --Stef |
| 2710 | |
| 2711 | (defvar yank-handled-properties) |
| 2712 | (defvar yank-excluded-properties) |
| 2713 | |
| 2714 | (defun remove-yank-excluded-properties (start end) |
| 2715 | "Process text properties between START and END, inserted for a `yank'. |
| 2716 | Perform the handling specified by `yank-handled-properties', then |
| 2717 | remove properties specified by `yank-excluded-properties'." |
| 2718 | (let ((inhibit-read-only t)) |
| 2719 | (dolist (handler yank-handled-properties) |
| 2720 | (let ((prop (car handler)) |
| 2721 | (fun (cdr handler)) |
| 2722 | (run-start start)) |
| 2723 | (while (< run-start end) |
| 2724 | (let ((value (get-text-property run-start prop)) |
| 2725 | (run-end (next-single-property-change |
| 2726 | run-start prop nil end))) |
| 2727 | (funcall fun value run-start run-end) |
| 2728 | (setq run-start run-end))))) |
| 2729 | (if (eq yank-excluded-properties t) |
| 2730 | (set-text-properties start end nil) |
| 2731 | (remove-list-of-text-properties start end yank-excluded-properties)))) |
| 2732 | |
| 2733 | (defvar yank-undo-function) |
| 2734 | |
| 2735 | (defun insert-for-yank (string) |
| 2736 | "Call `insert-for-yank-1' repetitively for each `yank-handler' segment. |
| 2737 | |
| 2738 | See `insert-for-yank-1' for more details." |
| 2739 | (let (to) |
| 2740 | (while (setq to (next-single-property-change 0 'yank-handler string)) |
| 2741 | (insert-for-yank-1 (substring string 0 to)) |
| 2742 | (setq string (substring string to)))) |
| 2743 | (insert-for-yank-1 string)) |
| 2744 | |
| 2745 | (defun insert-for-yank-1 (string) |
| 2746 | "Insert STRING at point for the `yank' command. |
| 2747 | This function is like `insert', except it honors the variables |
| 2748 | `yank-handled-properties' and `yank-excluded-properties', and the |
| 2749 | `yank-handler' text property. |
| 2750 | |
| 2751 | Properties listed in `yank-handled-properties' are processed, |
| 2752 | then those listed in `yank-excluded-properties' are discarded. |
| 2753 | |
| 2754 | If STRING has a non-nil `yank-handler' property on its first |
| 2755 | character, the normal insert behavior is altered. The value of |
| 2756 | the `yank-handler' property must be a list of one to four |
| 2757 | elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO). |
| 2758 | FUNCTION, if non-nil, should be a function of one argument, an |
| 2759 | object to insert; it is called instead of `insert'. |
| 2760 | PARAM, if present and non-nil, replaces STRING as the argument to |
| 2761 | FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM |
| 2762 | may be a list of strings to insert as a rectangle. |
| 2763 | If NOEXCLUDE is present and non-nil, the normal removal of |
| 2764 | `yank-excluded-properties' is not performed; instead FUNCTION is |
| 2765 | responsible for the removal. This may be necessary if FUNCTION |
| 2766 | adjusts point before or after inserting the object. |
| 2767 | UNDO, if present and non-nil, should be a function to be called |
| 2768 | by `yank-pop' to undo the insertion of the current object. It is |
| 2769 | given two arguments, the start and end of the region. FUNCTION |
| 2770 | may set `yank-undo-function' to override UNDO." |
| 2771 | (let* ((handler (and (stringp string) |
| 2772 | (get-text-property 0 'yank-handler string))) |
| 2773 | (param (or (nth 1 handler) string)) |
| 2774 | (opoint (point)) |
| 2775 | (inhibit-read-only inhibit-read-only) |
| 2776 | end) |
| 2777 | |
| 2778 | (setq yank-undo-function t) |
| 2779 | (if (nth 0 handler) ; FUNCTION |
| 2780 | (funcall (car handler) param) |
| 2781 | (insert param)) |
| 2782 | (setq end (point)) |
| 2783 | |
| 2784 | ;; Prevent read-only properties from interfering with the |
| 2785 | ;; following text property changes. |
| 2786 | (setq inhibit-read-only t) |
| 2787 | |
| 2788 | (unless (nth 2 handler) ; NOEXCLUDE |
| 2789 | (remove-yank-excluded-properties opoint end)) |
| 2790 | |
| 2791 | ;; If last inserted char has properties, mark them as rear-nonsticky. |
| 2792 | (if (and (> end opoint) |
| 2793 | (text-properties-at (1- end))) |
| 2794 | (put-text-property (1- end) end 'rear-nonsticky t)) |
| 2795 | |
| 2796 | (if (eq yank-undo-function t) ; not set by FUNCTION |
| 2797 | (setq yank-undo-function (nth 3 handler))) ; UNDO |
| 2798 | (if (nth 4 handler) ; COMMAND |
| 2799 | (setq this-command (nth 4 handler))))) |
| 2800 | |
| 2801 | (defun insert-buffer-substring-no-properties (buffer &optional start end) |
| 2802 | "Insert before point a substring of BUFFER, without text properties. |
| 2803 | BUFFER may be a buffer or a buffer name. |
| 2804 | Arguments START and END are character positions specifying the substring. |
| 2805 | They default to the values of (point-min) and (point-max) in BUFFER." |
| 2806 | (let ((opoint (point))) |
| 2807 | (insert-buffer-substring buffer start end) |
| 2808 | (let ((inhibit-read-only t)) |
| 2809 | (set-text-properties opoint (point) nil)))) |
| 2810 | |
| 2811 | (defun insert-buffer-substring-as-yank (buffer &optional start end) |
| 2812 | "Insert before point a part of BUFFER, stripping some text properties. |
| 2813 | BUFFER may be a buffer or a buffer name. |
| 2814 | Arguments START and END are character positions specifying the substring. |
| 2815 | They default to the values of (point-min) and (point-max) in BUFFER. |
| 2816 | Before insertion, process text properties according to |
| 2817 | `yank-handled-properties' and `yank-excluded-properties'." |
| 2818 | ;; Since the buffer text should not normally have yank-handler properties, |
| 2819 | ;; there is no need to handle them here. |
| 2820 | (let ((opoint (point))) |
| 2821 | (insert-buffer-substring buffer start end) |
| 2822 | (remove-yank-excluded-properties opoint (point)))) |
| 2823 | |
| 2824 | (defun yank-handle-font-lock-face-property (face start end) |
| 2825 | "If `font-lock-defaults' is nil, apply FACE as a `face' property. |
| 2826 | START and END denote the start and end of the text to act on. |
| 2827 | Do nothing if FACE is nil." |
| 2828 | (and face |
| 2829 | (null font-lock-defaults) |
| 2830 | (put-text-property start end 'face face))) |
| 2831 | |
| 2832 | ;; This removes `mouse-face' properties in *Help* buffer buttons: |
| 2833 | ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html |
| 2834 | (defun yank-handle-category-property (category start end) |
| 2835 | "Apply property category CATEGORY's properties between START and END." |
| 2836 | (when category |
| 2837 | (let ((start2 start)) |
| 2838 | (while (< start2 end) |
| 2839 | (let ((end2 (next-property-change start2 nil end)) |
| 2840 | (original (text-properties-at start2))) |
| 2841 | (set-text-properties start2 end2 (symbol-plist category)) |
| 2842 | (add-text-properties start2 end2 original) |
| 2843 | (setq start2 end2)))))) |
| 2844 | |
| 2845 | \f |
| 2846 | ;;;; Synchronous shell commands. |
| 2847 | |
| 2848 | (defun start-process-shell-command (name buffer &rest args) |
| 2849 | "Start a program in a subprocess. Return the process object for it. |
| 2850 | NAME is name for process. It is modified if necessary to make it unique. |
| 2851 | BUFFER is the buffer (or buffer name) to associate with the process. |
| 2852 | Process output goes at end of that buffer, unless you specify |
| 2853 | an output stream or filter function to handle the output. |
| 2854 | BUFFER may be also nil, meaning that this process is not associated |
| 2855 | with any buffer |
| 2856 | COMMAND is the shell command to run. |
| 2857 | |
| 2858 | An old calling convention accepted any number of arguments after COMMAND, |
| 2859 | which were just concatenated to COMMAND. This is still supported but strongly |
| 2860 | discouraged." |
| 2861 | ;; We used to use `exec' to replace the shell with the command, |
| 2862 | ;; but that failed to handle (...) and semicolon, etc. |
| 2863 | (start-process name buffer shell-file-name shell-command-switch |
| 2864 | (mapconcat 'identity args " "))) |
| 2865 | (set-advertised-calling-convention 'start-process-shell-command |
| 2866 | '(name buffer command) "23.1") |
| 2867 | |
| 2868 | (defun start-file-process-shell-command (name buffer &rest args) |
| 2869 | "Start a program in a subprocess. Return the process object for it. |
| 2870 | Similar to `start-process-shell-command', but calls `start-file-process'." |
| 2871 | (start-file-process |
| 2872 | name buffer |
| 2873 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) |
| 2874 | (if (file-remote-p default-directory) "-c" shell-command-switch) |
| 2875 | (mapconcat 'identity args " "))) |
| 2876 | (set-advertised-calling-convention 'start-file-process-shell-command |
| 2877 | '(name buffer command) "23.1") |
| 2878 | |
| 2879 | (defun call-process-shell-command (command &optional infile buffer display |
| 2880 | &rest args) |
| 2881 | "Execute the shell command COMMAND synchronously in separate process. |
| 2882 | The remaining arguments are optional. |
| 2883 | The program's input comes from file INFILE (nil means `/dev/null'). |
| 2884 | Insert output in BUFFER before point; t means current buffer; |
| 2885 | nil for BUFFER means discard it; 0 means discard and don't wait. |
| 2886 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, |
| 2887 | REAL-BUFFER says what to do with standard output, as above, |
| 2888 | while STDERR-FILE says what to do with standard error in the child. |
| 2889 | STDERR-FILE may be nil (discard standard error output), |
| 2890 | t (mix it with ordinary output), or a file name string. |
| 2891 | |
| 2892 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. |
| 2893 | Remaining arguments are strings passed as additional arguments for COMMAND. |
| 2894 | Wildcards and redirection are handled as usual in the shell. |
| 2895 | |
| 2896 | If BUFFER is 0, `call-process-shell-command' returns immediately with value nil. |
| 2897 | Otherwise it waits for COMMAND to terminate and returns a numeric exit |
| 2898 | status or a signal description string. |
| 2899 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again." |
| 2900 | ;; We used to use `exec' to replace the shell with the command, |
| 2901 | ;; but that failed to handle (...) and semicolon, etc. |
| 2902 | (call-process shell-file-name |
| 2903 | infile buffer display |
| 2904 | shell-command-switch |
| 2905 | (mapconcat 'identity (cons command args) " "))) |
| 2906 | |
| 2907 | (defun process-file-shell-command (command &optional infile buffer display |
| 2908 | &rest args) |
| 2909 | "Process files synchronously in a separate process. |
| 2910 | Similar to `call-process-shell-command', but calls `process-file'." |
| 2911 | (process-file |
| 2912 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) |
| 2913 | infile buffer display |
| 2914 | (if (file-remote-p default-directory) "-c" shell-command-switch) |
| 2915 | (mapconcat 'identity (cons command args) " "))) |
| 2916 | \f |
| 2917 | ;;;; Lisp macros to do various things temporarily. |
| 2918 | |
| 2919 | (defmacro with-current-buffer (buffer-or-name &rest body) |
| 2920 | "Execute the forms in BODY with BUFFER-OR-NAME temporarily current. |
| 2921 | BUFFER-OR-NAME must be a buffer or the name of an existing buffer. |
| 2922 | The value returned is the value of the last form in BODY. See |
| 2923 | also `with-temp-buffer'." |
| 2924 | (declare (indent 1) (debug t)) |
| 2925 | `(save-current-buffer |
| 2926 | (set-buffer ,buffer-or-name) |
| 2927 | ,@body)) |
| 2928 | |
| 2929 | (defun internal--before-with-selected-window (window) |
| 2930 | (let ((other-frame (window-frame window))) |
| 2931 | (list window (selected-window) |
| 2932 | ;; Selecting a window on another frame also changes that |
| 2933 | ;; frame's frame-selected-window. We must save&restore it. |
| 2934 | (unless (eq (selected-frame) other-frame) |
| 2935 | (frame-selected-window other-frame)) |
| 2936 | ;; Also remember the top-frame if on ttys. |
| 2937 | (unless (eq (selected-frame) other-frame) |
| 2938 | (tty-top-frame other-frame))))) |
| 2939 | |
| 2940 | (defun internal--after-with-selected-window (state) |
| 2941 | ;; First reset frame-selected-window. |
| 2942 | (when (window-live-p (nth 2 state)) |
| 2943 | ;; We don't use set-frame-selected-window because it does not |
| 2944 | ;; pass the `norecord' argument to Fselect_window. |
| 2945 | (select-window (nth 2 state) 'norecord) |
| 2946 | (and (frame-live-p (nth 3 state)) |
| 2947 | (not (eq (tty-top-frame) (nth 3 state))) |
| 2948 | (select-frame (nth 3 state) 'norecord))) |
| 2949 | ;; Then reset the actual selected-window. |
| 2950 | (when (window-live-p (nth 1 state)) |
| 2951 | (select-window (nth 1 state) 'norecord))) |
| 2952 | |
| 2953 | (defmacro with-selected-window (window &rest body) |
| 2954 | "Execute the forms in BODY with WINDOW as the selected window. |
| 2955 | The value returned is the value of the last form in BODY. |
| 2956 | |
| 2957 | This macro saves and restores the selected window, as well as the |
| 2958 | selected window of each frame. It does not change the order of |
| 2959 | recently selected windows. If the previously selected window of |
| 2960 | some frame is no longer live at the end of BODY, that frame's |
| 2961 | selected window is left alone. If the selected window is no |
| 2962 | longer live, then whatever window is selected at the end of BODY |
| 2963 | remains selected. |
| 2964 | |
| 2965 | This macro uses `save-current-buffer' to save and restore the |
| 2966 | current buffer, since otherwise its normal operation could |
| 2967 | potentially make a different buffer current. It does not alter |
| 2968 | the buffer list ordering." |
| 2969 | (declare (indent 1) (debug t)) |
| 2970 | `(let ((save-selected-window--state |
| 2971 | (internal--before-with-selected-window ,window))) |
| 2972 | (save-current-buffer |
| 2973 | (unwind-protect |
| 2974 | (progn (select-window (car save-selected-window--state) 'norecord) |
| 2975 | ,@body) |
| 2976 | (internal--after-with-selected-window save-selected-window--state))))) |
| 2977 | |
| 2978 | (defmacro with-selected-frame (frame &rest body) |
| 2979 | "Execute the forms in BODY with FRAME as the selected frame. |
| 2980 | The value returned is the value of the last form in BODY. |
| 2981 | |
| 2982 | This macro saves and restores the selected frame, and changes the |
| 2983 | order of neither the recently selected windows nor the buffers in |
| 2984 | the buffer list." |
| 2985 | (declare (indent 1) (debug t)) |
| 2986 | (let ((old-frame (make-symbol "old-frame")) |
| 2987 | (old-buffer (make-symbol "old-buffer"))) |
| 2988 | `(let ((,old-frame (selected-frame)) |
| 2989 | (,old-buffer (current-buffer))) |
| 2990 | (unwind-protect |
| 2991 | (progn (select-frame ,frame 'norecord) |
| 2992 | ,@body) |
| 2993 | (when (frame-live-p ,old-frame) |
| 2994 | (select-frame ,old-frame 'norecord)) |
| 2995 | (when (buffer-live-p ,old-buffer) |
| 2996 | (set-buffer ,old-buffer)))))) |
| 2997 | |
| 2998 | (defmacro save-window-excursion (&rest body) |
| 2999 | "Execute BODY, then restore previous window configuration. |
| 3000 | This macro saves the window configuration on the selected frame, |
| 3001 | executes BODY, then calls `set-window-configuration' to restore |
| 3002 | the saved window configuration. The return value is the last |
| 3003 | form in BODY. The window configuration is also restored if BODY |
| 3004 | exits nonlocally. |
| 3005 | |
| 3006 | BEWARE: Most uses of this macro introduce bugs. |
| 3007 | E.g. it should not be used to try and prevent some code from opening |
| 3008 | a new window, since that window may sometimes appear in another frame, |
| 3009 | in which case `save-window-excursion' cannot help." |
| 3010 | (declare (indent 0) (debug t)) |
| 3011 | (let ((c (make-symbol "wconfig"))) |
| 3012 | `(let ((,c (current-window-configuration))) |
| 3013 | (unwind-protect (progn ,@body) |
| 3014 | (set-window-configuration ,c))))) |
| 3015 | |
| 3016 | (defun internal-temp-output-buffer-show (buffer) |
| 3017 | "Internal function for `with-output-to-temp-buffer'." |
| 3018 | (with-current-buffer buffer |
| 3019 | (set-buffer-modified-p nil) |
| 3020 | (goto-char (point-min))) |
| 3021 | |
| 3022 | (if temp-buffer-show-function |
| 3023 | (funcall temp-buffer-show-function buffer) |
| 3024 | (with-current-buffer buffer |
| 3025 | (let* ((window |
| 3026 | (let ((window-combination-limit |
| 3027 | ;; When `window-combination-limit' equals |
| 3028 | ;; `temp-buffer' or `temp-buffer-resize' and |
| 3029 | ;; `temp-buffer-resize-mode' is enabled in this |
| 3030 | ;; buffer bind it to t so resizing steals space |
| 3031 | ;; preferably from the window that was split. |
| 3032 | (if (or (eq window-combination-limit 'temp-buffer) |
| 3033 | (and (eq window-combination-limit |
| 3034 | 'temp-buffer-resize) |
| 3035 | temp-buffer-resize-mode)) |
| 3036 | t |
| 3037 | window-combination-limit))) |
| 3038 | (display-buffer buffer))) |
| 3039 | (frame (and window (window-frame window)))) |
| 3040 | (when window |
| 3041 | (unless (eq frame (selected-frame)) |
| 3042 | (make-frame-visible frame)) |
| 3043 | (setq minibuffer-scroll-window window) |
| 3044 | (set-window-hscroll window 0) |
| 3045 | ;; Don't try this with NOFORCE non-nil! |
| 3046 | (set-window-start window (point-min) t) |
| 3047 | ;; This should not be necessary. |
| 3048 | (set-window-point window (point-min)) |
| 3049 | ;; Run `temp-buffer-show-hook', with the chosen window selected. |
| 3050 | (with-selected-window window |
| 3051 | (run-hooks 'temp-buffer-show-hook)))))) |
| 3052 | ;; Return nil. |
| 3053 | nil) |
| 3054 | |
| 3055 | ;; Doc is very similar to with-temp-buffer-window. |
| 3056 | (defmacro with-output-to-temp-buffer (bufname &rest body) |
| 3057 | "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer. |
| 3058 | |
| 3059 | This construct makes buffer BUFNAME empty before running BODY. |
| 3060 | It does not make the buffer current for BODY. |
| 3061 | Instead it binds `standard-output' to that buffer, so that output |
| 3062 | generated with `prin1' and similar functions in BODY goes into |
| 3063 | the buffer. |
| 3064 | |
| 3065 | At the end of BODY, this marks buffer BUFNAME unmodified and displays |
| 3066 | it in a window, but does not select it. The normal way to do this is |
| 3067 | by calling `display-buffer', then running `temp-buffer-show-hook'. |
| 3068 | However, if `temp-buffer-show-function' is non-nil, it calls that |
| 3069 | function instead (and does not run `temp-buffer-show-hook'). The |
| 3070 | function gets one argument, the buffer to display. |
| 3071 | |
| 3072 | The return value of `with-output-to-temp-buffer' is the value of the |
| 3073 | last form in BODY. If BODY does not finish normally, the buffer |
| 3074 | BUFNAME is not displayed. |
| 3075 | |
| 3076 | This runs the hook `temp-buffer-setup-hook' before BODY, |
| 3077 | with the buffer BUFNAME temporarily current. It runs the hook |
| 3078 | `temp-buffer-show-hook' after displaying buffer BUFNAME, with that |
| 3079 | buffer temporarily current, and the window that was used to display it |
| 3080 | temporarily selected. But it doesn't run `temp-buffer-show-hook' |
| 3081 | if it uses `temp-buffer-show-function'. |
| 3082 | |
| 3083 | See the related form `with-temp-buffer-window'." |
| 3084 | (declare (debug t)) |
| 3085 | (let ((old-dir (make-symbol "old-dir")) |
| 3086 | (buf (make-symbol "buf"))) |
| 3087 | `(let* ((,old-dir default-directory) |
| 3088 | (,buf |
| 3089 | (with-current-buffer (get-buffer-create ,bufname) |
| 3090 | (prog1 (current-buffer) |
| 3091 | (kill-all-local-variables) |
| 3092 | ;; FIXME: delete_all_overlays |
| 3093 | (setq default-directory ,old-dir) |
| 3094 | (setq buffer-read-only nil) |
| 3095 | (setq buffer-file-name nil) |
| 3096 | (setq buffer-undo-list t) |
| 3097 | (let ((inhibit-read-only t) |
| 3098 | (inhibit-modification-hooks t)) |
| 3099 | (erase-buffer) |
| 3100 | (run-hooks 'temp-buffer-setup-hook))))) |
| 3101 | (standard-output ,buf)) |
| 3102 | (prog1 (progn ,@body) |
| 3103 | (internal-temp-output-buffer-show ,buf))))) |
| 3104 | |
| 3105 | (defmacro with-temp-file (file &rest body) |
| 3106 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. |
| 3107 | The value returned is the value of the last form in BODY. |
| 3108 | See also `with-temp-buffer'." |
| 3109 | (declare (indent 1) (debug t)) |
| 3110 | (let ((temp-file (make-symbol "temp-file")) |
| 3111 | (temp-buffer (make-symbol "temp-buffer"))) |
| 3112 | `(let ((,temp-file ,file) |
| 3113 | (,temp-buffer |
| 3114 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) |
| 3115 | (unwind-protect |
| 3116 | (prog1 |
| 3117 | (with-current-buffer ,temp-buffer |
| 3118 | ,@body) |
| 3119 | (with-current-buffer ,temp-buffer |
| 3120 | (write-region nil nil ,temp-file nil 0))) |
| 3121 | (and (buffer-name ,temp-buffer) |
| 3122 | (kill-buffer ,temp-buffer)))))) |
| 3123 | |
| 3124 | (defmacro with-temp-message (message &rest body) |
| 3125 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
| 3126 | The original message is restored to the echo area after BODY has finished. |
| 3127 | The value returned is the value of the last form in BODY. |
| 3128 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
| 3129 | If MESSAGE is nil, the echo area and message log buffer are unchanged. |
| 3130 | Use a MESSAGE of \"\" to temporarily clear the echo area." |
| 3131 | (declare (debug t) (indent 1)) |
| 3132 | (let ((current-message (make-symbol "current-message")) |
| 3133 | (temp-message (make-symbol "with-temp-message"))) |
| 3134 | `(let ((,temp-message ,message) |
| 3135 | (,current-message)) |
| 3136 | (unwind-protect |
| 3137 | (progn |
| 3138 | (when ,temp-message |
| 3139 | (setq ,current-message (current-message)) |
| 3140 | (message "%s" ,temp-message)) |
| 3141 | ,@body) |
| 3142 | (and ,temp-message |
| 3143 | (if ,current-message |
| 3144 | (message "%s" ,current-message) |
| 3145 | (message nil))))))) |
| 3146 | |
| 3147 | (defmacro with-temp-buffer (&rest body) |
| 3148 | "Create a temporary buffer, and evaluate BODY there like `progn'. |
| 3149 | See also `with-temp-file' and `with-output-to-string'." |
| 3150 | (declare (indent 0) (debug t)) |
| 3151 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
| 3152 | `(let ((,temp-buffer (generate-new-buffer " *temp*"))) |
| 3153 | ;; FIXME: kill-buffer can change current-buffer in some odd cases. |
| 3154 | (with-current-buffer ,temp-buffer |
| 3155 | (unwind-protect |
| 3156 | (progn ,@body) |
| 3157 | (and (buffer-name ,temp-buffer) |
| 3158 | (kill-buffer ,temp-buffer))))))) |
| 3159 | |
| 3160 | (defmacro with-silent-modifications (&rest body) |
| 3161 | "Execute BODY, pretending it does not modify the buffer. |
| 3162 | If BODY performs real modifications to the buffer's text, other |
| 3163 | than cosmetic ones, undo data may become corrupted. |
| 3164 | |
| 3165 | This macro will run BODY normally, but doesn't count its buffer |
| 3166 | modifications as being buffer modifications. This affects things |
| 3167 | like `buffer-modified-p', checking whether the file is locked by |
| 3168 | someone else, running buffer modification hooks, and other things |
| 3169 | of that nature. |
| 3170 | |
| 3171 | Typically used around modifications of text-properties which do |
| 3172 | not really affect the buffer's content." |
| 3173 | (declare (debug t) (indent 0)) |
| 3174 | (let ((modified (make-symbol "modified"))) |
| 3175 | `(let* ((,modified (buffer-modified-p)) |
| 3176 | (buffer-undo-list t) |
| 3177 | (inhibit-read-only t) |
| 3178 | (inhibit-modification-hooks t) |
| 3179 | deactivate-mark |
| 3180 | ;; Avoid setting and removing file locks and checking |
| 3181 | ;; buffer's uptodate-ness w.r.t the underlying file. |
| 3182 | buffer-file-name |
| 3183 | buffer-file-truename) |
| 3184 | (unwind-protect |
| 3185 | (progn |
| 3186 | ,@body) |
| 3187 | (unless ,modified |
| 3188 | (restore-buffer-modified-p nil)))))) |
| 3189 | |
| 3190 | (defmacro with-output-to-string (&rest body) |
| 3191 | "Execute BODY, return the text it sent to `standard-output', as a string." |
| 3192 | (declare (indent 0) (debug t)) |
| 3193 | `(let ((standard-output |
| 3194 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) |
| 3195 | (unwind-protect |
| 3196 | (progn |
| 3197 | (let ((standard-output standard-output)) |
| 3198 | ,@body) |
| 3199 | (with-current-buffer standard-output |
| 3200 | (buffer-string))) |
| 3201 | (kill-buffer standard-output)))) |
| 3202 | |
| 3203 | (defmacro with-local-quit (&rest body) |
| 3204 | "Execute BODY, allowing quits to terminate BODY but not escape further. |
| 3205 | When a quit terminates BODY, `with-local-quit' returns nil but |
| 3206 | requests another quit. That quit will be processed as soon as quitting |
| 3207 | is allowed once again. (Immediately, if `inhibit-quit' is nil.)" |
| 3208 | (declare (debug t) (indent 0)) |
| 3209 | `(condition-case nil |
| 3210 | (let ((inhibit-quit nil)) |
| 3211 | ,@body) |
| 3212 | (quit (setq quit-flag t) |
| 3213 | ;; This call is to give a chance to handle quit-flag |
| 3214 | ;; in case inhibit-quit is nil. |
| 3215 | ;; Without this, it will not be handled until the next function |
| 3216 | ;; call, and that might allow it to exit thru a condition-case |
| 3217 | ;; that intends to handle the quit signal next time. |
| 3218 | (eval '(ignore nil))))) |
| 3219 | |
| 3220 | (defmacro while-no-input (&rest body) |
| 3221 | "Execute BODY only as long as there's no pending input. |
| 3222 | If input arrives, that ends the execution of BODY, |
| 3223 | and `while-no-input' returns t. Quitting makes it return nil. |
| 3224 | If BODY finishes, `while-no-input' returns whatever value BODY produced." |
| 3225 | (declare (debug t) (indent 0)) |
| 3226 | (let ((catch-sym (make-symbol "input"))) |
| 3227 | `(with-local-quit |
| 3228 | (catch ',catch-sym |
| 3229 | (let ((throw-on-input ',catch-sym)) |
| 3230 | (or (input-pending-p) |
| 3231 | (progn ,@body))))))) |
| 3232 | |
| 3233 | (defmacro condition-case-unless-debug (var bodyform &rest handlers) |
| 3234 | "Like `condition-case' except that it does not prevent debugging. |
| 3235 | More specifically if `debug-on-error' is set then the debugger will be invoked |
| 3236 | even if this catches the signal." |
| 3237 | (declare (debug condition-case) (indent 2)) |
| 3238 | `(condition-case ,var |
| 3239 | ,bodyform |
| 3240 | ,@(mapcar (lambda (handler) |
| 3241 | `((debug ,@(if (listp (car handler)) (car handler) |
| 3242 | (list (car handler)))) |
| 3243 | ,@(cdr handler))) |
| 3244 | handlers))) |
| 3245 | |
| 3246 | (define-obsolete-function-alias 'condition-case-no-debug |
| 3247 | 'condition-case-unless-debug "24.1") |
| 3248 | |
| 3249 | (defmacro with-demoted-errors (format &rest body) |
| 3250 | "Run BODY and demote any errors to simple messages. |
| 3251 | FORMAT is a string passed to `message' to format any error message. |
| 3252 | It should contain a single %-sequence; e.g., \"Error: %S\". |
| 3253 | |
| 3254 | If `debug-on-error' is non-nil, run BODY without catching its errors. |
| 3255 | This is to be used around code which is not expected to signal an error |
| 3256 | but which should be robust in the unexpected case that an error is signaled. |
| 3257 | |
| 3258 | For backward compatibility, if FORMAT is not a constant string, it |
| 3259 | is assumed to be part of BODY, in which case the message format |
| 3260 | used is \"Error: %S\"." |
| 3261 | (declare (debug t) (indent 1)) |
| 3262 | (let ((err (make-symbol "err")) |
| 3263 | (format (if (and (stringp format) body) format |
| 3264 | (prog1 "Error: %S" |
| 3265 | (if format (push format body)))))) |
| 3266 | `(condition-case-unless-debug ,err |
| 3267 | ,(macroexp-progn body) |
| 3268 | (error (message ,format ,err) nil)))) |
| 3269 | |
| 3270 | (defmacro combine-after-change-calls (&rest body) |
| 3271 | "Execute BODY, but don't call the after-change functions till the end. |
| 3272 | If BODY makes changes in the buffer, they are recorded |
| 3273 | and the functions on `after-change-functions' are called several times |
| 3274 | when BODY is finished. |
| 3275 | The return value is the value of the last form in BODY. |
| 3276 | |
| 3277 | If `before-change-functions' is non-nil, then calls to the after-change |
| 3278 | functions can't be deferred, so in that case this macro has no effect. |
| 3279 | |
| 3280 | Do not alter `after-change-functions' or `before-change-functions' |
| 3281 | in BODY." |
| 3282 | (declare (indent 0) (debug t)) |
| 3283 | `(unwind-protect |
| 3284 | (let ((combine-after-change-calls t)) |
| 3285 | . ,body) |
| 3286 | (combine-after-change-execute))) |
| 3287 | |
| 3288 | (defmacro with-case-table (table &rest body) |
| 3289 | "Execute the forms in BODY with TABLE as the current case table. |
| 3290 | The value returned is the value of the last form in BODY." |
| 3291 | (declare (indent 1) (debug t)) |
| 3292 | (let ((old-case-table (make-symbol "table")) |
| 3293 | (old-buffer (make-symbol "buffer"))) |
| 3294 | `(let ((,old-case-table (current-case-table)) |
| 3295 | (,old-buffer (current-buffer))) |
| 3296 | (unwind-protect |
| 3297 | (progn (set-case-table ,table) |
| 3298 | ,@body) |
| 3299 | (with-current-buffer ,old-buffer |
| 3300 | (set-case-table ,old-case-table)))))) |
| 3301 | \f |
| 3302 | ;;; Matching and match data. |
| 3303 | |
| 3304 | (defvar save-match-data-internal) |
| 3305 | |
| 3306 | ;; We use save-match-data-internal as the local variable because |
| 3307 | ;; that works ok in practice (people should not use that variable elsewhere). |
| 3308 | ;; We used to use an uninterned symbol; the compiler handles that properly |
| 3309 | ;; now, but it generates slower code. |
| 3310 | (defmacro save-match-data (&rest body) |
| 3311 | "Execute the BODY forms, restoring the global value of the match data. |
| 3312 | The value returned is the value of the last form in BODY." |
| 3313 | ;; It is better not to use backquote here, |
| 3314 | ;; because that makes a bootstrapping problem |
| 3315 | ;; if you need to recompile all the Lisp files using interpreted code. |
| 3316 | (declare (indent 0) (debug t)) |
| 3317 | (list 'let |
| 3318 | '((save-match-data-internal (match-data))) |
| 3319 | (list 'unwind-protect |
| 3320 | (cons 'progn body) |
| 3321 | ;; It is safe to free (evaporate) markers immediately here, |
| 3322 | ;; as Lisp programs should not copy from save-match-data-internal. |
| 3323 | '(set-match-data save-match-data-internal 'evaporate)))) |
| 3324 | |
| 3325 | (defun match-string (num &optional string) |
| 3326 | "Return string of text matched by last search. |
| 3327 | NUM specifies which parenthesized expression in the last regexp. |
| 3328 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 3329 | Zero means the entire text matched by the whole regexp or whole string. |
| 3330 | STRING should be given if the last search was by `string-match' on STRING. |
| 3331 | If STRING is nil, the current buffer should be the same buffer |
| 3332 | the search/match was performed in." |
| 3333 | (if (match-beginning num) |
| 3334 | (if string |
| 3335 | (substring string (match-beginning num) (match-end num)) |
| 3336 | (buffer-substring (match-beginning num) (match-end num))))) |
| 3337 | |
| 3338 | (defun match-string-no-properties (num &optional string) |
| 3339 | "Return string of text matched by last search, without text properties. |
| 3340 | NUM specifies which parenthesized expression in the last regexp. |
| 3341 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 3342 | Zero means the entire text matched by the whole regexp or whole string. |
| 3343 | STRING should be given if the last search was by `string-match' on STRING. |
| 3344 | If STRING is nil, the current buffer should be the same buffer |
| 3345 | the search/match was performed in." |
| 3346 | (if (match-beginning num) |
| 3347 | (if string |
| 3348 | (substring-no-properties string (match-beginning num) |
| 3349 | (match-end num)) |
| 3350 | (buffer-substring-no-properties (match-beginning num) |
| 3351 | (match-end num))))) |
| 3352 | |
| 3353 | |
| 3354 | (defun match-substitute-replacement (replacement |
| 3355 | &optional fixedcase literal string subexp) |
| 3356 | "Return REPLACEMENT as it will be inserted by `replace-match'. |
| 3357 | In other words, all back-references in the form `\\&' and `\\N' |
| 3358 | are substituted with actual strings matched by the last search. |
| 3359 | Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same |
| 3360 | meaning as for `replace-match'." |
| 3361 | (let ((match (match-string 0 string))) |
| 3362 | (save-match-data |
| 3363 | (set-match-data (mapcar (lambda (x) |
| 3364 | (if (numberp x) |
| 3365 | (- x (match-beginning 0)) |
| 3366 | x)) |
| 3367 | (match-data t))) |
| 3368 | (replace-match replacement fixedcase literal match subexp)))) |
| 3369 | |
| 3370 | |
| 3371 | (defun looking-back (regexp &optional limit greedy) |
| 3372 | "Return non-nil if text before point matches regular expression REGEXP. |
| 3373 | Like `looking-at' except matches before point, and is slower. |
| 3374 | LIMIT if non-nil speeds up the search by specifying a minimum |
| 3375 | starting position, to avoid checking matches that would start |
| 3376 | before LIMIT. |
| 3377 | |
| 3378 | If GREEDY is non-nil, extend the match backwards as far as |
| 3379 | possible, stopping when a single additional previous character |
| 3380 | cannot be part of a match for REGEXP. When the match is |
| 3381 | extended, its starting position is allowed to occur before |
| 3382 | LIMIT. |
| 3383 | |
| 3384 | As a general recommendation, try to avoid using `looking-back' |
| 3385 | wherever possible, since it is slow." |
| 3386 | (let ((start (point)) |
| 3387 | (pos |
| 3388 | (save-excursion |
| 3389 | (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t) |
| 3390 | (point))))) |
| 3391 | (if (and greedy pos) |
| 3392 | (save-restriction |
| 3393 | (narrow-to-region (point-min) start) |
| 3394 | (while (and (> pos (point-min)) |
| 3395 | (save-excursion |
| 3396 | (goto-char pos) |
| 3397 | (backward-char 1) |
| 3398 | (looking-at (concat "\\(?:" regexp "\\)\\'")))) |
| 3399 | (setq pos (1- pos))) |
| 3400 | (save-excursion |
| 3401 | (goto-char pos) |
| 3402 | (looking-at (concat "\\(?:" regexp "\\)\\'"))))) |
| 3403 | (not (null pos)))) |
| 3404 | |
| 3405 | (defsubst looking-at-p (regexp) |
| 3406 | "\ |
| 3407 | Same as `looking-at' except this function does not change the match data." |
| 3408 | (let ((inhibit-changing-match-data t)) |
| 3409 | (looking-at regexp))) |
| 3410 | |
| 3411 | (defsubst string-match-p (regexp string &optional start) |
| 3412 | "\ |
| 3413 | Same as `string-match' except this function does not change the match data." |
| 3414 | (let ((inhibit-changing-match-data t)) |
| 3415 | (string-match regexp string start))) |
| 3416 | |
| 3417 | (defun subregexp-context-p (regexp pos &optional start) |
| 3418 | "Return non-nil if POS is in a normal subregexp context in REGEXP. |
| 3419 | A subregexp context is one where a sub-regexp can appear. |
| 3420 | A non-subregexp context is for example within brackets, or within a |
| 3421 | repetition bounds operator `\\=\\{...\\}', or right after a `\\'. |
| 3422 | If START is non-nil, it should be a position in REGEXP, smaller |
| 3423 | than POS, and known to be in a subregexp context." |
| 3424 | ;; Here's one possible implementation, with the great benefit that it |
| 3425 | ;; reuses the regexp-matcher's own parser, so it understands all the |
| 3426 | ;; details of the syntax. A disadvantage is that it needs to match the |
| 3427 | ;; error string. |
| 3428 | (condition-case err |
| 3429 | (progn |
| 3430 | (string-match (substring regexp (or start 0) pos) "") |
| 3431 | t) |
| 3432 | (invalid-regexp |
| 3433 | (not (member (cadr err) '("Unmatched [ or [^" |
| 3434 | "Unmatched \\{" |
| 3435 | "Trailing backslash"))))) |
| 3436 | ;; An alternative implementation: |
| 3437 | ;; (defconst re-context-re |
| 3438 | ;; (let* ((harmless-ch "[^\\[]") |
| 3439 | ;; (harmless-esc "\\\\[^{]") |
| 3440 | ;; (class-harmless-ch "[^][]") |
| 3441 | ;; (class-lb-harmless "[^]:]") |
| 3442 | ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?") |
| 3443 | ;; (class-lb (concat "\\[\\(" class-lb-harmless |
| 3444 | ;; "\\|" class-lb-colon-maybe-charclass "\\)")) |
| 3445 | ;; (class |
| 3446 | ;; (concat "\\[^?]?" |
| 3447 | ;; "\\(" class-harmless-ch |
| 3448 | ;; "\\|" class-lb "\\)*" |
| 3449 | ;; "\\[?]")) ; special handling for bare [ at end of re |
| 3450 | ;; (braces "\\\\{[0-9,]+\\\\}")) |
| 3451 | ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc |
| 3452 | ;; "\\|" class "\\|" braces "\\)*\\'")) |
| 3453 | ;; "Matches any prefix that corresponds to a normal subregexp context.") |
| 3454 | ;; (string-match re-context-re (substring regexp (or start 0) pos)) |
| 3455 | ) |
| 3456 | \f |
| 3457 | ;;;; split-string |
| 3458 | |
| 3459 | (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
| 3460 | "The default value of separators for `split-string'. |
| 3461 | |
| 3462 | A regexp matching strings of whitespace. May be locale-dependent |
| 3463 | \(as yet unimplemented). Should not match non-breaking spaces. |
| 3464 | |
| 3465 | Warning: binding this to a different value and using it as default is |
| 3466 | likely to have undesired semantics.") |
| 3467 | |
| 3468 | ;; The specification says that if both SEPARATORS and OMIT-NULLS are |
| 3469 | ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical |
| 3470 | ;; expression leads to the equivalent implementation that if SEPARATORS |
| 3471 | ;; is defaulted, OMIT-NULLS is treated as t. |
| 3472 | (defun split-string (string &optional separators omit-nulls trim) |
| 3473 | "Split STRING into substrings bounded by matches for SEPARATORS. |
| 3474 | |
| 3475 | The beginning and end of STRING, and each match for SEPARATORS, are |
| 3476 | splitting points. The substrings matching SEPARATORS are removed, and |
| 3477 | the substrings between the splitting points are collected as a list, |
| 3478 | which is returned. |
| 3479 | |
| 3480 | If SEPARATORS is non-nil, it should be a regular expression matching text |
| 3481 | which separates, but is not part of, the substrings. If nil it defaults to |
| 3482 | `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and |
| 3483 | OMIT-NULLS is forced to t. |
| 3484 | |
| 3485 | If OMIT-NULLS is t, zero-length substrings are omitted from the list (so |
| 3486 | that for the default value of SEPARATORS leading and trailing whitespace |
| 3487 | are effectively trimmed). If nil, all zero-length substrings are retained, |
| 3488 | which correctly parses CSV format, for example. |
| 3489 | |
| 3490 | If TRIM is non-nil, it should be a regular expression to match |
| 3491 | text to trim from the beginning and end of each substring. If trimming |
| 3492 | makes the substring empty, it is treated as null. |
| 3493 | |
| 3494 | If you want to trim whitespace from the substrings, the reliably correct |
| 3495 | way is using TRIM. Making SEPARATORS match that whitespace gives incorrect |
| 3496 | results when there is whitespace at the start or end of STRING. If you |
| 3497 | see such calls to `split-string', please fix them. |
| 3498 | |
| 3499 | Note that the effect of `(split-string STRING)' is the same as |
| 3500 | `(split-string STRING split-string-default-separators t)'. In the rare |
| 3501 | case that you wish to retain zero-length substrings when splitting on |
| 3502 | whitespace, use `(split-string STRING split-string-default-separators)'. |
| 3503 | |
| 3504 | Modifies the match data; use `save-match-data' if necessary." |
| 3505 | (let* ((keep-nulls (not (if separators omit-nulls t))) |
| 3506 | (rexp (or separators split-string-default-separators)) |
| 3507 | (start 0) |
| 3508 | this-start this-end |
| 3509 | notfirst |
| 3510 | (list nil) |
| 3511 | (push-one |
| 3512 | ;; Push the substring in range THIS-START to THIS-END |
| 3513 | ;; onto LIST, trimming it and perhaps discarding it. |
| 3514 | (lambda () |
| 3515 | (when trim |
| 3516 | ;; Discard the trim from start of this substring. |
| 3517 | (let ((tem (string-match trim string this-start))) |
| 3518 | (and (eq tem this-start) |
| 3519 | (setq this-start (match-end 0))))) |
| 3520 | |
| 3521 | (when (or keep-nulls (< this-start this-end)) |
| 3522 | (let ((this (substring string this-start this-end))) |
| 3523 | |
| 3524 | ;; Discard the trim from end of this substring. |
| 3525 | (when trim |
| 3526 | (let ((tem (string-match (concat trim "\\'") this 0))) |
| 3527 | (and tem (< tem (length this)) |
| 3528 | (setq this (substring this 0 tem))))) |
| 3529 | |
| 3530 | ;; Trimming could make it empty; check again. |
| 3531 | (when (or keep-nulls (> (length this) 0)) |
| 3532 | (push this list))))))) |
| 3533 | |
| 3534 | (while (and (string-match rexp string |
| 3535 | (if (and notfirst |
| 3536 | (= start (match-beginning 0)) |
| 3537 | (< start (length string))) |
| 3538 | (1+ start) start)) |
| 3539 | (< start (length string))) |
| 3540 | (setq notfirst t) |
| 3541 | (setq this-start start this-end (match-beginning 0) |
| 3542 | start (match-end 0)) |
| 3543 | |
| 3544 | (funcall push-one)) |
| 3545 | |
| 3546 | ;; Handle the substring at the end of STRING. |
| 3547 | (setq this-start start this-end (length string)) |
| 3548 | (funcall push-one) |
| 3549 | |
| 3550 | (nreverse list))) |
| 3551 | |
| 3552 | (defun combine-and-quote-strings (strings &optional separator) |
| 3553 | "Concatenate the STRINGS, adding the SEPARATOR (default \" \"). |
| 3554 | This tries to quote the strings to avoid ambiguity such that |
| 3555 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs |
| 3556 | Only some SEPARATORs will work properly." |
| 3557 | (let* ((sep (or separator " ")) |
| 3558 | (re (concat "[\\\"]" "\\|" (regexp-quote sep)))) |
| 3559 | (mapconcat |
| 3560 | (lambda (str) |
| 3561 | (if (string-match re str) |
| 3562 | (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"") |
| 3563 | str)) |
| 3564 | strings sep))) |
| 3565 | |
| 3566 | (defun split-string-and-unquote (string &optional separator) |
| 3567 | "Split the STRING into a list of strings. |
| 3568 | It understands Emacs Lisp quoting within STRING, such that |
| 3569 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs |
| 3570 | The SEPARATOR regexp defaults to \"\\s-+\"." |
| 3571 | (let ((sep (or separator "\\s-+")) |
| 3572 | (i (string-match "\"" string))) |
| 3573 | (if (null i) |
| 3574 | (split-string string sep t) ; no quoting: easy |
| 3575 | (append (unless (eq i 0) (split-string (substring string 0 i) sep t)) |
| 3576 | (let ((rfs (read-from-string string i))) |
| 3577 | (cons (car rfs) |
| 3578 | (split-string-and-unquote (substring string (cdr rfs)) |
| 3579 | sep))))))) |
| 3580 | |
| 3581 | \f |
| 3582 | ;;;; Replacement in strings. |
| 3583 | |
| 3584 | (defun subst-char-in-string (fromchar tochar string &optional inplace) |
| 3585 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. |
| 3586 | Unless optional argument INPLACE is non-nil, return a new string." |
| 3587 | (let ((i (length string)) |
| 3588 | (newstr (if inplace string (copy-sequence string)))) |
| 3589 | (while (> i 0) |
| 3590 | (setq i (1- i)) |
| 3591 | (if (eq (aref newstr i) fromchar) |
| 3592 | (aset newstr i tochar))) |
| 3593 | newstr)) |
| 3594 | |
| 3595 | (defun replace-regexp-in-string (regexp rep string &optional |
| 3596 | fixedcase literal subexp start) |
| 3597 | "Replace all matches for REGEXP with REP in STRING. |
| 3598 | |
| 3599 | Return a new string containing the replacements. |
| 3600 | |
| 3601 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the |
| 3602 | arguments with the same names of function `replace-match'. If START |
| 3603 | is non-nil, start replacements at that index in STRING. |
| 3604 | |
| 3605 | REP is either a string used as the NEWTEXT arg of `replace-match' or a |
| 3606 | function. If it is a function, it is called with the actual text of each |
| 3607 | match, and its value is used as the replacement text. When REP is called, |
| 3608 | the match data are the result of matching REGEXP against a substring |
| 3609 | of STRING. |
| 3610 | |
| 3611 | To replace only the first match (if any), make REGEXP match up to \\' |
| 3612 | and replace a sub-expression, e.g. |
| 3613 | (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1) |
| 3614 | => \" bar foo\"" |
| 3615 | |
| 3616 | ;; To avoid excessive consing from multiple matches in long strings, |
| 3617 | ;; don't just call `replace-match' continually. Walk down the |
| 3618 | ;; string looking for matches of REGEXP and building up a (reversed) |
| 3619 | ;; list MATCHES. This comprises segments of STRING which weren't |
| 3620 | ;; matched interspersed with replacements for segments that were. |
| 3621 | ;; [For a `large' number of replacements it's more efficient to |
| 3622 | ;; operate in a temporary buffer; we can't tell from the function's |
| 3623 | ;; args whether to choose the buffer-based implementation, though it |
| 3624 | ;; might be reasonable to do so for long enough STRING.] |
| 3625 | (let ((l (length string)) |
| 3626 | (start (or start 0)) |
| 3627 | matches str mb me) |
| 3628 | (save-match-data |
| 3629 | (while (and (< start l) (string-match regexp string start)) |
| 3630 | (setq mb (match-beginning 0) |
| 3631 | me (match-end 0)) |
| 3632 | ;; If we matched the empty string, make sure we advance by one char |
| 3633 | (when (= me mb) (setq me (min l (1+ mb)))) |
| 3634 | ;; Generate a replacement for the matched substring. |
| 3635 | ;; Operate only on the substring to minimize string consing. |
| 3636 | ;; Set up match data for the substring for replacement; |
| 3637 | ;; presumably this is likely to be faster than munging the |
| 3638 | ;; match data directly in Lisp. |
| 3639 | (string-match regexp (setq str (substring string mb me))) |
| 3640 | (setq matches |
| 3641 | (cons (replace-match (if (stringp rep) |
| 3642 | rep |
| 3643 | (funcall rep (match-string 0 str))) |
| 3644 | fixedcase literal str subexp) |
| 3645 | (cons (substring string start mb) ; unmatched prefix |
| 3646 | matches))) |
| 3647 | (setq start me)) |
| 3648 | ;; Reconstruct a string from the pieces. |
| 3649 | (setq matches (cons (substring string start l) matches)) ; leftover |
| 3650 | (apply #'concat (nreverse matches))))) |
| 3651 | \f |
| 3652 | (defun string-prefix-p (str1 str2 &optional ignore-case) |
| 3653 | "Return non-nil if STR1 is a prefix of STR2. |
| 3654 | If IGNORE-CASE is non-nil, the comparison is done without paying attention |
| 3655 | to case differences." |
| 3656 | (eq t (compare-strings str1 nil nil |
| 3657 | str2 0 (length str1) ignore-case))) |
| 3658 | |
| 3659 | (defun string-suffix-p (suffix string &optional ignore-case) |
| 3660 | "Return non-nil if SUFFIX is a suffix of STRING. |
| 3661 | If IGNORE-CASE is non-nil, the comparison is done without paying |
| 3662 | attention to case differences." |
| 3663 | (let ((start-pos (- (length string) (length suffix)))) |
| 3664 | (and (>= start-pos 0) |
| 3665 | (eq t (compare-strings suffix nil nil |
| 3666 | string start-pos nil ignore-case))))) |
| 3667 | |
| 3668 | (defun bidi-string-mark-left-to-right (str) |
| 3669 | "Return a string that can be safely inserted in left-to-right text. |
| 3670 | |
| 3671 | Normally, inserting a string with right-to-left (RTL) script into |
| 3672 | a buffer may cause some subsequent text to be displayed as part |
| 3673 | of the RTL segment (usually this affects punctuation characters). |
| 3674 | This function returns a string which displays as STR but forces |
| 3675 | subsequent text to be displayed as left-to-right. |
| 3676 | |
| 3677 | If STR contains any RTL character, this function returns a string |
| 3678 | consisting of STR followed by an invisible left-to-right mark |
| 3679 | \(LRM) character. Otherwise, it returns STR." |
| 3680 | (unless (stringp str) |
| 3681 | (signal 'wrong-type-argument (list 'stringp str))) |
| 3682 | (if (string-match "\\cR" str) |
| 3683 | (concat str (propertize (string ?\x200e) 'invisible t)) |
| 3684 | str)) |
| 3685 | \f |
| 3686 | ;;;; Specifying things to do later. |
| 3687 | |
| 3688 | (defun load-history-regexp (file) |
| 3689 | "Form a regexp to find FILE in `load-history'. |
| 3690 | FILE, a string, is described in the function `eval-after-load'." |
| 3691 | (if (file-name-absolute-p file) |
| 3692 | (setq file (file-truename file))) |
| 3693 | (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)") |
| 3694 | (regexp-quote file) |
| 3695 | (if (file-name-extension file) |
| 3696 | "" |
| 3697 | ;; Note: regexp-opt can't be used here, since we need to call |
| 3698 | ;; this before Emacs has been fully started. 2006-05-21 |
| 3699 | (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?")) |
| 3700 | "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|") |
| 3701 | "\\)?\\'")) |
| 3702 | |
| 3703 | (defun load-history-filename-element (file-regexp) |
| 3704 | "Get the first elt of `load-history' whose car matches FILE-REGEXP. |
| 3705 | Return nil if there isn't one." |
| 3706 | (let* ((loads load-history) |
| 3707 | (load-elt (and loads (car loads)))) |
| 3708 | (save-match-data |
| 3709 | (while (and loads |
| 3710 | (or (null (car load-elt)) |
| 3711 | (not (string-match file-regexp (car load-elt))))) |
| 3712 | (setq loads (cdr loads) |
| 3713 | load-elt (and loads (car loads))))) |
| 3714 | load-elt)) |
| 3715 | |
| 3716 | (put 'eval-after-load 'lisp-indent-function 1) |
| 3717 | (defun eval-after-load (file form) |
| 3718 | "Arrange that if FILE is loaded, FORM will be run immediately afterwards. |
| 3719 | If FILE is already loaded, evaluate FORM right now. |
| 3720 | FORM can be an Elisp expression (in which case it's passed to `eval'), |
| 3721 | or a function (in which case it's passed to `funcall' with no argument). |
| 3722 | |
| 3723 | If a matching file is loaded again, FORM will be evaluated again. |
| 3724 | |
| 3725 | If FILE is a string, it may be either an absolute or a relative file |
| 3726 | name, and may have an extension (e.g. \".el\") or may lack one, and |
| 3727 | additionally may or may not have an extension denoting a compressed |
| 3728 | format (e.g. \".gz\"). |
| 3729 | |
| 3730 | When FILE is absolute, this first converts it to a true name by chasing |
| 3731 | symbolic links. Only a file of this name (see next paragraph regarding |
| 3732 | extensions) will trigger the evaluation of FORM. When FILE is relative, |
| 3733 | a file whose absolute true name ends in FILE will trigger evaluation. |
| 3734 | |
| 3735 | When FILE lacks an extension, a file name with any extension will trigger |
| 3736 | evaluation. Otherwise, its extension must match FILE's. A further |
| 3737 | extension for a compressed format (e.g. \".gz\") on FILE will not affect |
| 3738 | this name matching. |
| 3739 | |
| 3740 | Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM |
| 3741 | is evaluated at the end of any file that `provide's this feature. |
| 3742 | If the feature is provided when evaluating code not associated with a |
| 3743 | file, FORM is evaluated immediately after the provide statement. |
| 3744 | |
| 3745 | Usually FILE is just a library name like \"font-lock\" or a feature name |
| 3746 | like 'font-lock. |
| 3747 | |
| 3748 | This function makes or adds to an entry on `after-load-alist'." |
| 3749 | (declare (compiler-macro |
| 3750 | (lambda (whole) |
| 3751 | (if (eq 'quote (car-safe form)) |
| 3752 | ;; Quote with lambda so the compiler can look inside. |
| 3753 | `(eval-after-load ,file (lambda () ,(nth 1 form))) |
| 3754 | whole)))) |
| 3755 | ;; Add this FORM into after-load-alist (regardless of whether we'll be |
| 3756 | ;; evaluating it now). |
| 3757 | (let* ((regexp-or-feature |
| 3758 | (if (stringp file) |
| 3759 | (setq file (purecopy (load-history-regexp file))) |
| 3760 | file)) |
| 3761 | (elt (assoc regexp-or-feature after-load-alist)) |
| 3762 | (func |
| 3763 | (if (functionp form) form |
| 3764 | ;; Try to use the "current" lexical/dynamic mode for `form'. |
| 3765 | (eval `(lambda () ,form) lexical-binding)))) |
| 3766 | (unless elt |
| 3767 | (setq elt (list regexp-or-feature)) |
| 3768 | (push elt after-load-alist)) |
| 3769 | ;; Is there an already loaded file whose name (or `provide' name) |
| 3770 | ;; matches FILE? |
| 3771 | (prog1 (if (if (stringp file) |
| 3772 | (load-history-filename-element regexp-or-feature) |
| 3773 | (featurep file)) |
| 3774 | (funcall func)) |
| 3775 | (let ((delayed-func |
| 3776 | (if (not (symbolp regexp-or-feature)) func |
| 3777 | ;; For features, the after-load-alist elements get run when |
| 3778 | ;; `provide' is called rather than at the end of the file. |
| 3779 | ;; So add an indirection to make sure that `func' is really run |
| 3780 | ;; "after-load" in case the provide call happens early. |
| 3781 | (lambda () |
| 3782 | (if (not load-file-name) |
| 3783 | ;; Not being provided from a file, run func right now. |
| 3784 | (funcall func) |
| 3785 | (let ((lfn load-file-name) |
| 3786 | ;; Don't use letrec, because equal (in |
| 3787 | ;; add/remove-hook) would get trapped in a cycle. |
| 3788 | (fun (make-symbol "eval-after-load-helper"))) |
| 3789 | (fset fun (lambda (file) |
| 3790 | (when (equal file lfn) |
| 3791 | (remove-hook 'after-load-functions fun) |
| 3792 | (funcall func)))) |
| 3793 | (add-hook 'after-load-functions fun 'append))))))) |
| 3794 | ;; Add FORM to the element unless it's already there. |
| 3795 | (unless (member delayed-func (cdr elt)) |
| 3796 | (nconc elt (list delayed-func))))))) |
| 3797 | |
| 3798 | (defmacro with-eval-after-load (file &rest body) |
| 3799 | "Execute BODY after FILE is loaded. |
| 3800 | FILE is normally a feature name, but it can also be a file name, |
| 3801 | in case that file does not provide any feature." |
| 3802 | (declare (indent 1) (debug t)) |
| 3803 | `(eval-after-load ,file (lambda () ,@body))) |
| 3804 | |
| 3805 | (defvar after-load-functions nil |
| 3806 | "Special hook run after loading a file. |
| 3807 | Each function there is called with a single argument, the absolute |
| 3808 | name of the file just loaded.") |
| 3809 | |
| 3810 | (defun do-after-load-evaluation (abs-file) |
| 3811 | "Evaluate all `eval-after-load' forms, if any, for ABS-FILE. |
| 3812 | ABS-FILE, a string, should be the absolute true name of a file just loaded. |
| 3813 | This function is called directly from the C code." |
| 3814 | ;; Run the relevant eval-after-load forms. |
| 3815 | (dolist (a-l-element after-load-alist) |
| 3816 | (when (and (stringp (car a-l-element)) |
| 3817 | (string-match-p (car a-l-element) abs-file)) |
| 3818 | ;; discard the file name regexp |
| 3819 | (mapc #'funcall (cdr a-l-element)))) |
| 3820 | ;; Complain when the user uses obsolete files. |
| 3821 | (when (string-match-p "/obsolete/[^/]*\\'" abs-file) |
| 3822 | ;; Maybe we should just use display-warning? This seems yucky... |
| 3823 | (let* ((file (file-name-nondirectory abs-file)) |
| 3824 | (msg (format "Package %s is obsolete!" |
| 3825 | (substring file 0 |
| 3826 | (string-match "\\.elc?\\>" file))))) |
| 3827 | ;; Cribbed from cl--compiling-file. |
| 3828 | (if (and (boundp 'byte-compile--outbuffer) |
| 3829 | (bufferp (symbol-value 'byte-compile--outbuffer)) |
| 3830 | (equal (buffer-name (symbol-value 'byte-compile--outbuffer)) |
| 3831 | " *Compiler Output*")) |
| 3832 | ;; Don't warn about obsolete files using other obsolete files. |
| 3833 | (unless (and (stringp byte-compile-current-file) |
| 3834 | (string-match-p "/obsolete/[^/]*\\'" |
| 3835 | (expand-file-name |
| 3836 | byte-compile-current-file |
| 3837 | byte-compile-root-dir))) |
| 3838 | (byte-compile-log-warning msg)) |
| 3839 | (run-with-timer 0 nil |
| 3840 | (lambda (msg) |
| 3841 | (message "%s" msg)) msg)))) |
| 3842 | |
| 3843 | ;; Finally, run any other hook. |
| 3844 | (run-hook-with-args 'after-load-functions abs-file)) |
| 3845 | |
| 3846 | (defun eval-next-after-load (file) |
| 3847 | "Read the following input sexp, and run it whenever FILE is loaded. |
| 3848 | This makes or adds to an entry on `after-load-alist'. |
| 3849 | FILE should be the name of a library, with no directory name." |
| 3850 | (declare (obsolete eval-after-load "23.2")) |
| 3851 | (eval-after-load file (read))) |
| 3852 | |
| 3853 | \f |
| 3854 | (defun display-delayed-warnings () |
| 3855 | "Display delayed warnings from `delayed-warnings-list'. |
| 3856 | Used from `delayed-warnings-hook' (which see)." |
| 3857 | (dolist (warning (nreverse delayed-warnings-list)) |
| 3858 | (apply 'display-warning warning)) |
| 3859 | (setq delayed-warnings-list nil)) |
| 3860 | |
| 3861 | (defun collapse-delayed-warnings () |
| 3862 | "Remove duplicates from `delayed-warnings-list'. |
| 3863 | Collapse identical adjacent warnings into one (plus count). |
| 3864 | Used from `delayed-warnings-hook' (which see)." |
| 3865 | (let ((count 1) |
| 3866 | collapsed warning) |
| 3867 | (while delayed-warnings-list |
| 3868 | (setq warning (pop delayed-warnings-list)) |
| 3869 | (if (equal warning (car delayed-warnings-list)) |
| 3870 | (setq count (1+ count)) |
| 3871 | (when (> count 1) |
| 3872 | (setcdr warning (cons (format "%s [%d times]" (cadr warning) count) |
| 3873 | (cddr warning))) |
| 3874 | (setq count 1)) |
| 3875 | (push warning collapsed))) |
| 3876 | (setq delayed-warnings-list (nreverse collapsed)))) |
| 3877 | |
| 3878 | ;; At present this is only used for Emacs internals. |
| 3879 | ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html |
| 3880 | (defvar delayed-warnings-hook '(collapse-delayed-warnings |
| 3881 | display-delayed-warnings) |
| 3882 | "Normal hook run to process and display delayed warnings. |
| 3883 | By default, this hook contains functions to consolidate the |
| 3884 | warnings listed in `delayed-warnings-list', display them, and set |
| 3885 | `delayed-warnings-list' back to nil.") |
| 3886 | |
| 3887 | (defun delay-warning (type message &optional level buffer-name) |
| 3888 | "Display a delayed warning. |
| 3889 | Aside from going through `delayed-warnings-list', this is equivalent |
| 3890 | to `display-warning'." |
| 3891 | (push (list type message level buffer-name) delayed-warnings-list)) |
| 3892 | |
| 3893 | \f |
| 3894 | ;;;; invisibility specs |
| 3895 | |
| 3896 | (defun add-to-invisibility-spec (element) |
| 3897 | "Add ELEMENT to `buffer-invisibility-spec'. |
| 3898 | See documentation for `buffer-invisibility-spec' for the kind of elements |
| 3899 | that can be added." |
| 3900 | (if (eq buffer-invisibility-spec t) |
| 3901 | (setq buffer-invisibility-spec (list t))) |
| 3902 | (setq buffer-invisibility-spec |
| 3903 | (cons element buffer-invisibility-spec))) |
| 3904 | |
| 3905 | (defun remove-from-invisibility-spec (element) |
| 3906 | "Remove ELEMENT from `buffer-invisibility-spec'." |
| 3907 | (if (consp buffer-invisibility-spec) |
| 3908 | (setq buffer-invisibility-spec |
| 3909 | (delete element buffer-invisibility-spec)))) |
| 3910 | \f |
| 3911 | ;;;; Syntax tables. |
| 3912 | |
| 3913 | (defmacro with-syntax-table (table &rest body) |
| 3914 | "Evaluate BODY with syntax table of current buffer set to TABLE. |
| 3915 | The syntax table of the current buffer is saved, BODY is evaluated, and the |
| 3916 | saved table is restored, even in case of an abnormal exit. |
| 3917 | Value is what BODY returns." |
| 3918 | (declare (debug t) (indent 1)) |
| 3919 | (let ((old-table (make-symbol "table")) |
| 3920 | (old-buffer (make-symbol "buffer"))) |
| 3921 | `(let ((,old-table (syntax-table)) |
| 3922 | (,old-buffer (current-buffer))) |
| 3923 | (unwind-protect |
| 3924 | (progn |
| 3925 | (set-syntax-table ,table) |
| 3926 | ,@body) |
| 3927 | (save-current-buffer |
| 3928 | (set-buffer ,old-buffer) |
| 3929 | (set-syntax-table ,old-table)))))) |
| 3930 | |
| 3931 | (defun make-syntax-table (&optional oldtable) |
| 3932 | "Return a new syntax table. |
| 3933 | Create a syntax table which inherits from OLDTABLE (if non-nil) or |
| 3934 | from `standard-syntax-table' otherwise." |
| 3935 | (let ((table (make-char-table 'syntax-table nil))) |
| 3936 | (set-char-table-parent table (or oldtable (standard-syntax-table))) |
| 3937 | table)) |
| 3938 | |
| 3939 | (defun syntax-after (pos) |
| 3940 | "Return the raw syntax descriptor for the char after POS. |
| 3941 | If POS is outside the buffer's accessible portion, return nil." |
| 3942 | (unless (or (< pos (point-min)) (>= pos (point-max))) |
| 3943 | (let ((st (if parse-sexp-lookup-properties |
| 3944 | (get-char-property pos 'syntax-table)))) |
| 3945 | (if (consp st) st |
| 3946 | (aref (or st (syntax-table)) (char-after pos)))))) |
| 3947 | |
| 3948 | (defun syntax-class (syntax) |
| 3949 | "Return the code for the syntax class described by SYNTAX. |
| 3950 | |
| 3951 | SYNTAX should be a raw syntax descriptor; the return value is a |
| 3952 | integer which encodes the corresponding syntax class. See Info |
| 3953 | node `(elisp)Syntax Table Internals' for a list of codes. |
| 3954 | |
| 3955 | If SYNTAX is nil, return nil." |
| 3956 | (and syntax (logand (car syntax) 65535))) |
| 3957 | \f |
| 3958 | ;; Utility motion commands |
| 3959 | |
| 3960 | ;; Whitespace |
| 3961 | |
| 3962 | (defun forward-whitespace (arg) |
| 3963 | "Move point to the end of the next sequence of whitespace chars. |
| 3964 | Each such sequence may be a single newline, or a sequence of |
| 3965 | consecutive space and/or tab characters. |
| 3966 | With prefix argument ARG, do it ARG times if positive, or move |
| 3967 | backwards ARG times if negative." |
| 3968 | (interactive "^p") |
| 3969 | (if (natnump arg) |
| 3970 | (re-search-forward "[ \t]+\\|\n" nil 'move arg) |
| 3971 | (while (< arg 0) |
| 3972 | (if (re-search-backward "[ \t]+\\|\n" nil 'move) |
| 3973 | (or (eq (char-after (match-beginning 0)) ?\n) |
| 3974 | (skip-chars-backward " \t"))) |
| 3975 | (setq arg (1+ arg))))) |
| 3976 | |
| 3977 | ;; Symbols |
| 3978 | |
| 3979 | (defun forward-symbol (arg) |
| 3980 | "Move point to the next position that is the end of a symbol. |
| 3981 | A symbol is any sequence of characters that are in either the |
| 3982 | word constituent or symbol constituent syntax class. |
| 3983 | With prefix argument ARG, do it ARG times if positive, or move |
| 3984 | backwards ARG times if negative." |
| 3985 | (interactive "^p") |
| 3986 | (if (natnump arg) |
| 3987 | (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg) |
| 3988 | (while (< arg 0) |
| 3989 | (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move) |
| 3990 | (skip-syntax-backward "w_")) |
| 3991 | (setq arg (1+ arg))))) |
| 3992 | |
| 3993 | ;; Syntax blocks |
| 3994 | |
| 3995 | (defun forward-same-syntax (&optional arg) |
| 3996 | "Move point past all characters with the same syntax class. |
| 3997 | With prefix argument ARG, do it ARG times if positive, or move |
| 3998 | backwards ARG times if negative." |
| 3999 | (interactive "^p") |
| 4000 | (or arg (setq arg 1)) |
| 4001 | (while (< arg 0) |
| 4002 | (skip-syntax-backward |
| 4003 | (char-to-string (char-syntax (char-before)))) |
| 4004 | (setq arg (1+ arg))) |
| 4005 | (while (> arg 0) |
| 4006 | (skip-syntax-forward (char-to-string (char-syntax (char-after)))) |
| 4007 | (setq arg (1- arg)))) |
| 4008 | |
| 4009 | \f |
| 4010 | ;;;; Text clones |
| 4011 | |
| 4012 | (defvar text-clone--maintaining nil) |
| 4013 | |
| 4014 | (defun text-clone--maintain (ol1 after beg end &optional _len) |
| 4015 | "Propagate the changes made under the overlay OL1 to the other clones. |
| 4016 | This is used on the `modification-hooks' property of text clones." |
| 4017 | (when (and after (not undo-in-progress) |
| 4018 | (not text-clone--maintaining) |
| 4019 | (overlay-start ol1)) |
| 4020 | (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0))) |
| 4021 | (setq beg (max beg (+ (overlay-start ol1) margin))) |
| 4022 | (setq end (min end (- (overlay-end ol1) margin))) |
| 4023 | (when (<= beg end) |
| 4024 | (save-excursion |
| 4025 | (when (overlay-get ol1 'text-clone-syntax) |
| 4026 | ;; Check content of the clone's text. |
| 4027 | (let ((cbeg (+ (overlay-start ol1) margin)) |
| 4028 | (cend (- (overlay-end ol1) margin))) |
| 4029 | (goto-char cbeg) |
| 4030 | (save-match-data |
| 4031 | (if (not (re-search-forward |
| 4032 | (overlay-get ol1 'text-clone-syntax) cend t)) |
| 4033 | ;; Mark the overlay for deletion. |
| 4034 | (setq end cbeg) |
| 4035 | (when (< (match-end 0) cend) |
| 4036 | ;; Shrink the clone at its end. |
| 4037 | (setq end (min end (match-end 0))) |
| 4038 | (move-overlay ol1 (overlay-start ol1) |
| 4039 | (+ (match-end 0) margin))) |
| 4040 | (when (> (match-beginning 0) cbeg) |
| 4041 | ;; Shrink the clone at its beginning. |
| 4042 | (setq beg (max (match-beginning 0) beg)) |
| 4043 | (move-overlay ol1 (- (match-beginning 0) margin) |
| 4044 | (overlay-end ol1))))))) |
| 4045 | ;; Now go ahead and update the clones. |
| 4046 | (let ((head (- beg (overlay-start ol1))) |
| 4047 | (tail (- (overlay-end ol1) end)) |
| 4048 | (str (buffer-substring beg end)) |
| 4049 | (nothing-left t) |
| 4050 | (text-clone--maintaining t)) |
| 4051 | (dolist (ol2 (overlay-get ol1 'text-clones)) |
| 4052 | (let ((oe (overlay-end ol2))) |
| 4053 | (unless (or (eq ol1 ol2) (null oe)) |
| 4054 | (setq nothing-left nil) |
| 4055 | (let ((mod-beg (+ (overlay-start ol2) head))) |
| 4056 | ;;(overlay-put ol2 'modification-hooks nil) |
| 4057 | (goto-char (- (overlay-end ol2) tail)) |
| 4058 | (unless (> mod-beg (point)) |
| 4059 | (save-excursion (insert str)) |
| 4060 | (delete-region mod-beg (point))) |
| 4061 | ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain)) |
| 4062 | )))) |
| 4063 | (if nothing-left (delete-overlay ol1)))))))) |
| 4064 | |
| 4065 | (defun text-clone-create (start end &optional spreadp syntax) |
| 4066 | "Create a text clone of START...END at point. |
| 4067 | Text clones are chunks of text that are automatically kept identical: |
| 4068 | changes done to one of the clones will be immediately propagated to the other. |
| 4069 | |
| 4070 | The buffer's content at point is assumed to be already identical to |
| 4071 | the one between START and END. |
| 4072 | If SYNTAX is provided it's a regexp that describes the possible text of |
| 4073 | the clones; the clone will be shrunk or killed if necessary to ensure that |
| 4074 | its text matches the regexp. |
| 4075 | If SPREADP is non-nil it indicates that text inserted before/after the |
| 4076 | clone should be incorporated in the clone." |
| 4077 | ;; To deal with SPREADP we can either use an overlay with `nil t' along |
| 4078 | ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay |
| 4079 | ;; (with a one-char margin at each end) with `t nil'. |
| 4080 | ;; We opted for a larger overlay because it behaves better in the case |
| 4081 | ;; where the clone is reduced to the empty string (we want the overlay to |
| 4082 | ;; stay when the clone's content is the empty string and we want to use |
| 4083 | ;; `evaporate' to make sure those overlays get deleted when needed). |
| 4084 | ;; |
| 4085 | (let* ((pt-end (+ (point) (- end start))) |
| 4086 | (start-margin (if (or (not spreadp) (bobp) (<= start (point-min))) |
| 4087 | 0 1)) |
| 4088 | (end-margin (if (or (not spreadp) |
| 4089 | (>= pt-end (point-max)) |
| 4090 | (>= start (point-max))) |
| 4091 | 0 1)) |
| 4092 | ;; FIXME: Reuse overlays at point to extend dups! |
| 4093 | (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t)) |
| 4094 | (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t)) |
| 4095 | (dups (list ol1 ol2))) |
| 4096 | (overlay-put ol1 'modification-hooks '(text-clone--maintain)) |
| 4097 | (when spreadp (overlay-put ol1 'text-clone-spreadp t)) |
| 4098 | (when syntax (overlay-put ol1 'text-clone-syntax syntax)) |
| 4099 | ;;(overlay-put ol1 'face 'underline) |
| 4100 | (overlay-put ol1 'evaporate t) |
| 4101 | (overlay-put ol1 'text-clones dups) |
| 4102 | ;; |
| 4103 | (overlay-put ol2 'modification-hooks '(text-clone--maintain)) |
| 4104 | (when spreadp (overlay-put ol2 'text-clone-spreadp t)) |
| 4105 | (when syntax (overlay-put ol2 'text-clone-syntax syntax)) |
| 4106 | ;;(overlay-put ol2 'face 'underline) |
| 4107 | (overlay-put ol2 'evaporate t) |
| 4108 | (overlay-put ol2 'text-clones dups))) |
| 4109 | \f |
| 4110 | ;;;; Mail user agents. |
| 4111 | |
| 4112 | ;; Here we include just enough for other packages to be able |
| 4113 | ;; to define them. |
| 4114 | |
| 4115 | (defun define-mail-user-agent (symbol composefunc sendfunc |
| 4116 | &optional abortfunc hookvar) |
| 4117 | "Define a symbol to identify a mail-sending package for `mail-user-agent'. |
| 4118 | |
| 4119 | SYMBOL can be any Lisp symbol. Its function definition and/or |
| 4120 | value as a variable do not matter for this usage; we use only certain |
| 4121 | properties on its property list, to encode the rest of the arguments. |
| 4122 | |
| 4123 | COMPOSEFUNC is program callable function that composes an outgoing |
| 4124 | mail message buffer. This function should set up the basics of the |
| 4125 | buffer without requiring user interaction. It should populate the |
| 4126 | standard mail headers, leaving the `to:' and `subject:' headers blank |
| 4127 | by default. |
| 4128 | |
| 4129 | COMPOSEFUNC should accept several optional arguments--the same |
| 4130 | arguments that `compose-mail' takes. See that function's documentation. |
| 4131 | |
| 4132 | SENDFUNC is the command a user would run to send the message. |
| 4133 | |
| 4134 | Optional ABORTFUNC is the command a user would run to abort the |
| 4135 | message. For mail packages that don't have a separate abort function, |
| 4136 | this can be `kill-buffer' (the equivalent of omitting this argument). |
| 4137 | |
| 4138 | Optional HOOKVAR is a hook variable that gets run before the message |
| 4139 | is actually sent. Callers that use the `mail-user-agent' may |
| 4140 | install a hook function temporarily on this hook variable. |
| 4141 | If HOOKVAR is nil, `mail-send-hook' is used. |
| 4142 | |
| 4143 | The properties used on SYMBOL are `composefunc', `sendfunc', |
| 4144 | `abortfunc', and `hookvar'." |
| 4145 | (put symbol 'composefunc composefunc) |
| 4146 | (put symbol 'sendfunc sendfunc) |
| 4147 | (put symbol 'abortfunc (or abortfunc 'kill-buffer)) |
| 4148 | (put symbol 'hookvar (or hookvar 'mail-send-hook))) |
| 4149 | \f |
| 4150 | (defvar called-interactively-p-functions nil |
| 4151 | "Special hook called to skip special frames in `called-interactively-p'. |
| 4152 | The functions are called with 3 arguments: (I FRAME1 FRAME2), |
| 4153 | where FRAME1 is a \"current frame\", FRAME2 is the next frame, |
| 4154 | I is the index of the frame after FRAME2. It should return nil |
| 4155 | if those frames don't seem special and otherwise, it should return |
| 4156 | the number of frames to skip (minus 1).") |
| 4157 | |
| 4158 | (defconst internal--call-interactively (symbol-function 'call-interactively)) |
| 4159 | |
| 4160 | (defun called-interactively-p (&optional kind) |
| 4161 | "Return t if the containing function was called by `call-interactively'. |
| 4162 | If KIND is `interactive', then only return t if the call was made |
| 4163 | interactively by the user, i.e. not in `noninteractive' mode nor |
| 4164 | when `executing-kbd-macro'. |
| 4165 | If KIND is `any', on the other hand, it will return t for any kind of |
| 4166 | interactive call, including being called as the binding of a key or |
| 4167 | from a keyboard macro, even in `noninteractive' mode. |
| 4168 | |
| 4169 | This function is very brittle, it may fail to return the intended result when |
| 4170 | the code is debugged, advised, or instrumented in some form. Some macros and |
| 4171 | special forms (such as `condition-case') may also sometimes wrap their bodies |
| 4172 | in a `lambda', so any call to `called-interactively-p' from those bodies will |
| 4173 | indicate whether that lambda (rather than the surrounding function) was called |
| 4174 | interactively. |
| 4175 | |
| 4176 | Instead of using this function, it is cleaner and more reliable to give your |
| 4177 | function an extra optional argument whose `interactive' spec specifies |
| 4178 | non-nil unconditionally (\"p\" is a good way to do this), or via |
| 4179 | \(not (or executing-kbd-macro noninteractive)). |
| 4180 | |
| 4181 | The only known proper use of `interactive' for KIND is in deciding |
| 4182 | whether to display a helpful message, or how to display it. If you're |
| 4183 | thinking of using it for any other purpose, it is quite likely that |
| 4184 | you're making a mistake. Think: what do you want to do when the |
| 4185 | command is called from a keyboard macro?" |
| 4186 | (declare (advertised-calling-convention (kind) "23.1")) |
| 4187 | (when (not (and (eq kind 'interactive) |
| 4188 | (or executing-kbd-macro noninteractive))) |
| 4189 | (let* ((i 1) ;; 0 is the called-interactively-p frame. |
| 4190 | frame nextframe |
| 4191 | (get-next-frame |
| 4192 | (lambda () |
| 4193 | (setq frame nextframe) |
| 4194 | (setq nextframe (backtrace-frame i 'called-interactively-p)) |
| 4195 | ;; (message "Frame %d = %S" i nextframe) |
| 4196 | (setq i (1+ i))))) |
| 4197 | (funcall get-next-frame) ;; Get the first frame. |
| 4198 | (while |
| 4199 | ;; FIXME: The edebug and advice handling should be made modular and |
| 4200 | ;; provided directly by edebug.el and nadvice.el. |
| 4201 | (progn |
| 4202 | ;; frame =(backtrace-frame i-2) |
| 4203 | ;; nextframe=(backtrace-frame i-1) |
| 4204 | (funcall get-next-frame) |
| 4205 | ;; `pcase' would be a fairly good fit here, but it sometimes moves |
| 4206 | ;; branches within local functions, which then messes up the |
| 4207 | ;; `backtrace-frame' data we get, |
| 4208 | (or |
| 4209 | ;; Skip special forms (from non-compiled code). |
| 4210 | (and frame (null (car frame))) |
| 4211 | ;; Skip also `interactive-p' (because we don't want to know if |
| 4212 | ;; interactive-p was called interactively but if it's caller was) |
| 4213 | ;; and `byte-code' (idem; this appears in subexpressions of things |
| 4214 | ;; like condition-case, which are wrapped in a separate bytecode |
| 4215 | ;; chunk). |
| 4216 | ;; FIXME: For lexical-binding code, this is much worse, |
| 4217 | ;; because the frames look like "byte-code -> funcall -> #[...]", |
| 4218 | ;; which is not a reliable signature. |
| 4219 | (memq (nth 1 frame) '(interactive-p 'byte-code)) |
| 4220 | ;; Skip package-specific stack-frames. |
| 4221 | (let ((skip (run-hook-with-args-until-success |
| 4222 | 'called-interactively-p-functions |
| 4223 | i frame nextframe))) |
| 4224 | (pcase skip |
| 4225 | (`nil nil) |
| 4226 | (`0 t) |
| 4227 | (_ (setq i (+ i skip -1)) (funcall get-next-frame))))))) |
| 4228 | ;; Now `frame' should be "the function from which we were called". |
| 4229 | (pcase (cons frame nextframe) |
| 4230 | ;; No subr calls `interactive-p', so we can rule that out. |
| 4231 | (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil) |
| 4232 | ;; In case #<subr call-interactively> without going through the |
| 4233 | ;; `call-interactively' symbol (bug#3984). |
| 4234 | (`(,_ . (t ,(pred (eq internal--call-interactively)) . ,_)) t) |
| 4235 | (`(,_ . (t call-interactively . ,_)) t))))) |
| 4236 | |
| 4237 | (defun interactive-p () |
| 4238 | "Return t if the containing function was run directly by user input. |
| 4239 | This means that the function was called with `call-interactively' |
| 4240 | \(which includes being called as the binding of a key) |
| 4241 | and input is currently coming from the keyboard (not a keyboard macro), |
| 4242 | and Emacs is not running in batch mode (`noninteractive' is nil). |
| 4243 | |
| 4244 | The only known proper use of `interactive-p' is in deciding whether to |
| 4245 | display a helpful message, or how to display it. If you're thinking |
| 4246 | of using it for any other purpose, it is quite likely that you're |
| 4247 | making a mistake. Think: what do you want to do when the command is |
| 4248 | called from a keyboard macro or in batch mode? |
| 4249 | |
| 4250 | To test whether your function was called with `call-interactively', |
| 4251 | either (i) add an extra optional argument and give it an `interactive' |
| 4252 | spec that specifies non-nil unconditionally (such as \"p\"); or (ii) |
| 4253 | use `called-interactively-p'." |
| 4254 | (declare (obsolete called-interactively-p "23.2")) |
| 4255 | (called-interactively-p 'interactive)) |
| 4256 | |
| 4257 | (defun internal-push-keymap (keymap symbol) |
| 4258 | (let ((map (symbol-value symbol))) |
| 4259 | (unless (memq keymap map) |
| 4260 | (unless (memq 'add-keymap-witness (symbol-value symbol)) |
| 4261 | (setq map (make-composed-keymap nil (symbol-value symbol))) |
| 4262 | (push 'add-keymap-witness (cdr map)) |
| 4263 | (set symbol map)) |
| 4264 | (push keymap (cdr map))))) |
| 4265 | |
| 4266 | (defun internal-pop-keymap (keymap symbol) |
| 4267 | (let ((map (symbol-value symbol))) |
| 4268 | (when (memq keymap map) |
| 4269 | (setf (cdr map) (delq keymap (cdr map)))) |
| 4270 | (let ((tail (cddr map))) |
| 4271 | (and (or (null tail) (keymapp tail)) |
| 4272 | (eq 'add-keymap-witness (nth 1 map)) |
| 4273 | (set symbol tail))))) |
| 4274 | |
| 4275 | (define-obsolete-function-alias |
| 4276 | 'set-temporary-overlay-map 'set-transient-map "24.4") |
| 4277 | |
| 4278 | (defun set-transient-map (map &optional keep-pred on-exit) |
| 4279 | "Set MAP as a temporary keymap taking precedence over other keymaps. |
| 4280 | Normally, MAP is used only once, to look up the very next key. |
| 4281 | However, if the optional argument KEEP-PRED is t, MAP stays |
| 4282 | active if a key from MAP is used. KEEP-PRED can also be a |
| 4283 | function of no arguments: if it returns non-nil, then MAP stays |
| 4284 | active. |
| 4285 | |
| 4286 | Optional arg ON-EXIT, if non-nil, specifies a function that is |
| 4287 | called, with no arguments, after MAP is deactivated. |
| 4288 | |
| 4289 | This uses `overriding-terminal-local-map' which takes precedence over all other |
| 4290 | keymaps. As usual, if no match for a key is found in MAP, the normal key |
| 4291 | lookup sequence then continues." |
| 4292 | (let ((clearfun (make-symbol "clear-transient-map"))) |
| 4293 | ;; Don't use letrec, because equal (in add/remove-hook) would get trapped |
| 4294 | ;; in a cycle. |
| 4295 | (fset clearfun |
| 4296 | (lambda () |
| 4297 | (with-demoted-errors "set-transient-map PCH: %S" |
| 4298 | (unless (cond |
| 4299 | ((not (eq map (cadr overriding-terminal-local-map))) |
| 4300 | ;; There's presumably some other transient-map in |
| 4301 | ;; effect. Wait for that one to terminate before we |
| 4302 | ;; remove ourselves. |
| 4303 | ;; For example, if isearch and C-u both use transient |
| 4304 | ;; maps, then the lifetime of the C-u should be nested |
| 4305 | ;; within isearch's, so the pre-command-hook of |
| 4306 | ;; isearch should be suspended during the C-u one so |
| 4307 | ;; we don't exit isearch just because we hit 1 after |
| 4308 | ;; C-u and that 1 exits isearch whereas it doesn't |
| 4309 | ;; exit C-u. |
| 4310 | t) |
| 4311 | ((null keep-pred) nil) |
| 4312 | ((eq t keep-pred) |
| 4313 | (eq this-command |
| 4314 | (lookup-key map (this-command-keys-vector)))) |
| 4315 | (t (funcall keep-pred))) |
| 4316 | (internal-pop-keymap map 'overriding-terminal-local-map) |
| 4317 | (remove-hook 'pre-command-hook clearfun) |
| 4318 | (when on-exit (funcall on-exit)))))) |
| 4319 | (add-hook 'pre-command-hook clearfun) |
| 4320 | (internal-push-keymap map 'overriding-terminal-local-map))) |
| 4321 | |
| 4322 | ;;;; Progress reporters. |
| 4323 | |
| 4324 | ;; Progress reporter has the following structure: |
| 4325 | ;; |
| 4326 | ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME |
| 4327 | ;; MIN-VALUE |
| 4328 | ;; MAX-VALUE |
| 4329 | ;; MESSAGE |
| 4330 | ;; MIN-CHANGE |
| 4331 | ;; MIN-TIME]) |
| 4332 | ;; |
| 4333 | ;; This weirdness is for optimization reasons: we want |
| 4334 | ;; `progress-reporter-update' to be as fast as possible, so |
| 4335 | ;; `(car reporter)' is better than `(aref reporter 0)'. |
| 4336 | ;; |
| 4337 | ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple |
| 4338 | ;; digits of precision, it doesn't really matter here. On the other |
| 4339 | ;; hand, it greatly simplifies the code. |
| 4340 | |
| 4341 | (defsubst progress-reporter-update (reporter &optional value) |
| 4342 | "Report progress of an operation in the echo area. |
| 4343 | REPORTER should be the result of a call to `make-progress-reporter'. |
| 4344 | |
| 4345 | If REPORTER is a numerical progress reporter---i.e. if it was |
| 4346 | made using non-nil MIN-VALUE and MAX-VALUE arguments to |
| 4347 | `make-progress-reporter'---then VALUE should be a number between |
| 4348 | MIN-VALUE and MAX-VALUE. |
| 4349 | |
| 4350 | If REPORTER is a non-numerical reporter, VALUE should be nil. |
| 4351 | |
| 4352 | This function is relatively inexpensive. If the change since |
| 4353 | last update is too small or insufficient time has passed, it does |
| 4354 | nothing." |
| 4355 | (when (or (not (numberp value)) ; For pulsing reporter |
| 4356 | (>= value (car reporter))) ; For numerical reporter |
| 4357 | (progress-reporter-do-update reporter value))) |
| 4358 | |
| 4359 | (defun make-progress-reporter (message &optional min-value max-value |
| 4360 | current-value min-change min-time) |
| 4361 | "Return progress reporter object for use with `progress-reporter-update'. |
| 4362 | |
| 4363 | MESSAGE is shown in the echo area, with a status indicator |
| 4364 | appended to the end. When you call `progress-reporter-done', the |
| 4365 | word \"done\" is printed after the MESSAGE. You can change the |
| 4366 | MESSAGE of an existing progress reporter by calling |
| 4367 | `progress-reporter-force-update'. |
| 4368 | |
| 4369 | MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete) |
| 4370 | and final (100% complete) states of operation; the latter should |
| 4371 | be larger. In this case, the status message shows the percentage |
| 4372 | progress. |
| 4373 | |
| 4374 | If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status |
| 4375 | message shows a \"spinning\", non-numeric indicator. |
| 4376 | |
| 4377 | Optional CURRENT-VALUE is the initial progress; the default is |
| 4378 | MIN-VALUE. |
| 4379 | Optional MIN-CHANGE is the minimal change in percents to report; |
| 4380 | the default is 1%. |
| 4381 | CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE |
| 4382 | and/or MAX-VALUE are nil. |
| 4383 | |
| 4384 | Optional MIN-TIME specifies the minimum interval time between |
| 4385 | echo area updates (default is 0.2 seconds.) If the function |
| 4386 | `float-time' is not present, time is not tracked at all. If the |
| 4387 | OS is not capable of measuring fractions of seconds, this |
| 4388 | parameter is effectively rounded up." |
| 4389 | (when (string-match "[[:alnum:]]\\'" message) |
| 4390 | (setq message (concat message "..."))) |
| 4391 | (unless min-time |
| 4392 | (setq min-time 0.2)) |
| 4393 | (let ((reporter |
| 4394 | ;; Force a call to `message' now |
| 4395 | (cons (or min-value 0) |
| 4396 | (vector (if (and (fboundp 'float-time) |
| 4397 | (>= min-time 0.02)) |
| 4398 | (float-time) nil) |
| 4399 | min-value |
| 4400 | max-value |
| 4401 | message |
| 4402 | (if min-change (max (min min-change 50) 1) 1) |
| 4403 | min-time)))) |
| 4404 | (progress-reporter-update reporter (or current-value min-value)) |
| 4405 | reporter)) |
| 4406 | |
| 4407 | (defun progress-reporter-force-update (reporter &optional value new-message) |
| 4408 | "Report progress of an operation in the echo area unconditionally. |
| 4409 | |
| 4410 | The first two arguments are the same as in `progress-reporter-update'. |
| 4411 | NEW-MESSAGE, if non-nil, sets a new message for the reporter." |
| 4412 | (let ((parameters (cdr reporter))) |
| 4413 | (when new-message |
| 4414 | (aset parameters 3 new-message)) |
| 4415 | (when (aref parameters 0) |
| 4416 | (aset parameters 0 (float-time))) |
| 4417 | (progress-reporter-do-update reporter value))) |
| 4418 | |
| 4419 | (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"] |
| 4420 | "Characters to use for pulsing progress reporters.") |
| 4421 | |
| 4422 | (defun progress-reporter-do-update (reporter value) |
| 4423 | (let* ((parameters (cdr reporter)) |
| 4424 | (update-time (aref parameters 0)) |
| 4425 | (min-value (aref parameters 1)) |
| 4426 | (max-value (aref parameters 2)) |
| 4427 | (text (aref parameters 3)) |
| 4428 | (current-time (float-time)) |
| 4429 | (enough-time-passed |
| 4430 | ;; See if enough time has passed since the last update. |
| 4431 | (or (not update-time) |
| 4432 | (when (>= current-time update-time) |
| 4433 | ;; Calculate time for the next update |
| 4434 | (aset parameters 0 (+ update-time (aref parameters 5))))))) |
| 4435 | (cond ((and min-value max-value) |
| 4436 | ;; Numerical indicator |
| 4437 | (let* ((one-percent (/ (- max-value min-value) 100.0)) |
| 4438 | (percentage (if (= max-value min-value) |
| 4439 | 0 |
| 4440 | (truncate (/ (- value min-value) |
| 4441 | one-percent))))) |
| 4442 | ;; Calculate NEXT-UPDATE-VALUE. If we are not printing |
| 4443 | ;; message because not enough time has passed, use 1 |
| 4444 | ;; instead of MIN-CHANGE. This makes delays between echo |
| 4445 | ;; area updates closer to MIN-TIME. |
| 4446 | (setcar reporter |
| 4447 | (min (+ min-value (* (+ percentage |
| 4448 | (if enough-time-passed |
| 4449 | ;; MIN-CHANGE |
| 4450 | (aref parameters 4) |
| 4451 | 1)) |
| 4452 | one-percent)) |
| 4453 | max-value)) |
| 4454 | (when (integerp value) |
| 4455 | (setcar reporter (ceiling (car reporter)))) |
| 4456 | ;; Only print message if enough time has passed |
| 4457 | (when enough-time-passed |
| 4458 | (if (> percentage 0) |
| 4459 | (message "%s%d%%" text percentage) |
| 4460 | (message "%s" text))))) |
| 4461 | ;; Pulsing indicator |
| 4462 | (enough-time-passed |
| 4463 | (let ((index (mod (1+ (car reporter)) 4)) |
| 4464 | (message-log-max nil)) |
| 4465 | (setcar reporter index) |
| 4466 | (message "%s %s" |
| 4467 | text |
| 4468 | (aref progress-reporter--pulse-characters |
| 4469 | index))))))) |
| 4470 | |
| 4471 | (defun progress-reporter-done (reporter) |
| 4472 | "Print reporter's message followed by word \"done\" in echo area." |
| 4473 | (message "%sdone" (aref (cdr reporter) 3))) |
| 4474 | |
| 4475 | (defmacro dotimes-with-progress-reporter (spec message &rest body) |
| 4476 | "Loop a certain number of times and report progress in the echo area. |
| 4477 | Evaluate BODY with VAR bound to successive integers running from |
| 4478 | 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get |
| 4479 | the return value (nil if RESULT is omitted). |
| 4480 | |
| 4481 | At each iteration MESSAGE followed by progress percentage is |
| 4482 | printed in the echo area. After the loop is finished, MESSAGE |
| 4483 | followed by word \"done\" is printed. This macro is a |
| 4484 | convenience wrapper around `make-progress-reporter' and friends. |
| 4485 | |
| 4486 | \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)" |
| 4487 | (declare (indent 2) (debug ((symbolp form &optional form) form body))) |
| 4488 | (let ((temp (make-symbol "--dotimes-temp--")) |
| 4489 | (temp2 (make-symbol "--dotimes-temp2--")) |
| 4490 | (start 0) |
| 4491 | (end (nth 1 spec))) |
| 4492 | `(let ((,temp ,end) |
| 4493 | (,(car spec) ,start) |
| 4494 | (,temp2 (make-progress-reporter ,message ,start ,end))) |
| 4495 | (while (< ,(car spec) ,temp) |
| 4496 | ,@body |
| 4497 | (progress-reporter-update ,temp2 |
| 4498 | (setq ,(car spec) (1+ ,(car spec))))) |
| 4499 | (progress-reporter-done ,temp2) |
| 4500 | nil ,@(cdr (cdr spec))))) |
| 4501 | |
| 4502 | \f |
| 4503 | ;;;; Comparing version strings. |
| 4504 | |
| 4505 | (defconst version-separator "." |
| 4506 | "Specify the string used to separate the version elements. |
| 4507 | |
| 4508 | Usually the separator is \".\", but it can be any other string.") |
| 4509 | |
| 4510 | |
| 4511 | (defconst version-regexp-alist |
| 4512 | '(("^[-_+ ]?snapshot$" . -4) |
| 4513 | ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases |
| 4514 | ("^[-_+]$" . -4) |
| 4515 | ;; treat "1.2.3-CVS" as snapshot release |
| 4516 | ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4) |
| 4517 | ("^[-_+ ]?alpha$" . -3) |
| 4518 | ("^[-_+ ]?beta$" . -2) |
| 4519 | ("^[-_+ ]?\\(pre\\|rc\\)$" . -1)) |
| 4520 | "Specify association between non-numeric version and its priority. |
| 4521 | |
| 4522 | This association is used to handle version string like \"1.0pre2\", |
| 4523 | \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the |
| 4524 | non-numeric part of a version string to an integer. For example: |
| 4525 | |
| 4526 | String Version Integer List Version |
| 4527 | \"0.9snapshot\" (0 9 -4) |
| 4528 | \"1.0-git\" (1 0 -4) |
| 4529 | \"1.0pre2\" (1 0 -1 2) |
| 4530 | \"1.0PRE2\" (1 0 -1 2) |
| 4531 | \"22.8beta3\" (22 8 -2 3) |
| 4532 | \"22.8 Beta3\" (22 8 -2 3) |
| 4533 | \"0.9alpha1\" (0 9 -3 1) |
| 4534 | \"0.9AlphA1\" (0 9 -3 1) |
| 4535 | \"0.9 alpha\" (0 9 -3) |
| 4536 | |
| 4537 | Each element has the following form: |
| 4538 | |
| 4539 | (REGEXP . PRIORITY) |
| 4540 | |
| 4541 | Where: |
| 4542 | |
| 4543 | REGEXP regexp used to match non-numeric part of a version string. |
| 4544 | It should begin with the `^' anchor and end with a `$' to |
| 4545 | prevent false hits. Letter-case is ignored while matching |
| 4546 | REGEXP. |
| 4547 | |
| 4548 | PRIORITY a negative integer specifying non-numeric priority of REGEXP.") |
| 4549 | |
| 4550 | |
| 4551 | (defun version-to-list (ver) |
| 4552 | "Convert version string VER into a list of integers. |
| 4553 | |
| 4554 | The version syntax is given by the following EBNF: |
| 4555 | |
| 4556 | VERSION ::= NUMBER ( SEPARATOR NUMBER )*. |
| 4557 | |
| 4558 | NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+. |
| 4559 | |
| 4560 | SEPARATOR ::= `version-separator' (which see) |
| 4561 | | `version-regexp-alist' (which see). |
| 4562 | |
| 4563 | The NUMBER part is optional if SEPARATOR is a match for an element |
| 4564 | in `version-regexp-alist'. |
| 4565 | |
| 4566 | Examples of valid version syntax: |
| 4567 | |
| 4568 | 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta |
| 4569 | |
| 4570 | Examples of invalid version syntax: |
| 4571 | |
| 4572 | 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5 |
| 4573 | |
| 4574 | Examples of version conversion: |
| 4575 | |
| 4576 | Version String Version as a List of Integers |
| 4577 | \"1.0.7.5\" (1 0 7 5) |
| 4578 | \"1.0pre2\" (1 0 -1 2) |
| 4579 | \"1.0PRE2\" (1 0 -1 2) |
| 4580 | \"22.8beta3\" (22 8 -2 3) |
| 4581 | \"22.8Beta3\" (22 8 -2 3) |
| 4582 | \"0.9alpha1\" (0 9 -3 1) |
| 4583 | \"0.9AlphA1\" (0 9 -3 1) |
| 4584 | \"0.9alpha\" (0 9 -3) |
| 4585 | \"0.9snapshot\" (0 9 -4) |
| 4586 | \"1.0-git\" (1 0 -4) |
| 4587 | |
| 4588 | See documentation for `version-separator' and `version-regexp-alist'." |
| 4589 | (or (and (stringp ver) (> (length ver) 0)) |
| 4590 | (error "Invalid version string: '%s'" ver)) |
| 4591 | ;; Change .x.y to 0.x.y |
| 4592 | (if (and (>= (length ver) (length version-separator)) |
| 4593 | (string-equal (substring ver 0 (length version-separator)) |
| 4594 | version-separator)) |
| 4595 | (setq ver (concat "0" ver))) |
| 4596 | (save-match-data |
| 4597 | (let ((i 0) |
| 4598 | (case-fold-search t) ; ignore case in matching |
| 4599 | lst s al) |
| 4600 | (while (and (setq s (string-match "[0-9]+" ver i)) |
| 4601 | (= s i)) |
| 4602 | ;; handle numeric part |
| 4603 | (setq lst (cons (string-to-number (substring ver i (match-end 0))) |
| 4604 | lst) |
| 4605 | i (match-end 0)) |
| 4606 | ;; handle non-numeric part |
| 4607 | (when (and (setq s (string-match "[^0-9]+" ver i)) |
| 4608 | (= s i)) |
| 4609 | (setq s (substring ver i (match-end 0)) |
| 4610 | i (match-end 0)) |
| 4611 | ;; handle alpha, beta, pre, etc. separator |
| 4612 | (unless (string= s version-separator) |
| 4613 | (setq al version-regexp-alist) |
| 4614 | (while (and al (not (string-match (caar al) s))) |
| 4615 | (setq al (cdr al))) |
| 4616 | (cond (al |
| 4617 | (push (cdar al) lst)) |
| 4618 | ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc. |
| 4619 | ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s) |
| 4620 | (push (- (aref (downcase (match-string 1 s)) 0) ?a -1) |
| 4621 | lst)) |
| 4622 | (t (error "Invalid version syntax: '%s'" ver)))))) |
| 4623 | (if (null lst) |
| 4624 | (error "Invalid version syntax: '%s'" ver) |
| 4625 | (nreverse lst))))) |
| 4626 | |
| 4627 | |
| 4628 | (defun version-list-< (l1 l2) |
| 4629 | "Return t if L1, a list specification of a version, is lower than L2. |
| 4630 | |
| 4631 | Note that a version specified by the list (1) is equal to (1 0), |
| 4632 | \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant. |
| 4633 | Also, a version given by the list (1) is higher than (1 -1), which in |
| 4634 | turn is higher than (1 -2), which is higher than (1 -3)." |
| 4635 | (while (and l1 l2 (= (car l1) (car l2))) |
| 4636 | (setq l1 (cdr l1) |
| 4637 | l2 (cdr l2))) |
| 4638 | (cond |
| 4639 | ;; l1 not null and l2 not null |
| 4640 | ((and l1 l2) (< (car l1) (car l2))) |
| 4641 | ;; l1 null and l2 null ==> l1 length = l2 length |
| 4642 | ((and (null l1) (null l2)) nil) |
| 4643 | ;; l1 not null and l2 null ==> l1 length > l2 length |
| 4644 | (l1 (< (version-list-not-zero l1) 0)) |
| 4645 | ;; l1 null and l2 not null ==> l2 length > l1 length |
| 4646 | (t (< 0 (version-list-not-zero l2))))) |
| 4647 | |
| 4648 | |
| 4649 | (defun version-list-= (l1 l2) |
| 4650 | "Return t if L1, a list specification of a version, is equal to L2. |
| 4651 | |
| 4652 | Note that a version specified by the list (1) is equal to (1 0), |
| 4653 | \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant. |
| 4654 | Also, a version given by the list (1) is higher than (1 -1), which in |
| 4655 | turn is higher than (1 -2), which is higher than (1 -3)." |
| 4656 | (while (and l1 l2 (= (car l1) (car l2))) |
| 4657 | (setq l1 (cdr l1) |
| 4658 | l2 (cdr l2))) |
| 4659 | (cond |
| 4660 | ;; l1 not null and l2 not null |
| 4661 | ((and l1 l2) nil) |
| 4662 | ;; l1 null and l2 null ==> l1 length = l2 length |
| 4663 | ((and (null l1) (null l2))) |
| 4664 | ;; l1 not null and l2 null ==> l1 length > l2 length |
| 4665 | (l1 (zerop (version-list-not-zero l1))) |
| 4666 | ;; l1 null and l2 not null ==> l2 length > l1 length |
| 4667 | (t (zerop (version-list-not-zero l2))))) |
| 4668 | |
| 4669 | |
| 4670 | (defun version-list-<= (l1 l2) |
| 4671 | "Return t if L1, a list specification of a version, is lower or equal to L2. |
| 4672 | |
| 4673 | Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0), |
| 4674 | etc. That is, the trailing zeroes are insignificant. Also, integer |
| 4675 | list (1) is greater than (1 -1) which is greater than (1 -2) |
| 4676 | which is greater than (1 -3)." |
| 4677 | (while (and l1 l2 (= (car l1) (car l2))) |
| 4678 | (setq l1 (cdr l1) |
| 4679 | l2 (cdr l2))) |
| 4680 | (cond |
| 4681 | ;; l1 not null and l2 not null |
| 4682 | ((and l1 l2) (< (car l1) (car l2))) |
| 4683 | ;; l1 null and l2 null ==> l1 length = l2 length |
| 4684 | ((and (null l1) (null l2))) |
| 4685 | ;; l1 not null and l2 null ==> l1 length > l2 length |
| 4686 | (l1 (<= (version-list-not-zero l1) 0)) |
| 4687 | ;; l1 null and l2 not null ==> l2 length > l1 length |
| 4688 | (t (<= 0 (version-list-not-zero l2))))) |
| 4689 | |
| 4690 | (defun version-list-not-zero (lst) |
| 4691 | "Return the first non-zero element of LST, which is a list of integers. |
| 4692 | |
| 4693 | If all LST elements are zeros or LST is nil, return zero." |
| 4694 | (while (and lst (zerop (car lst))) |
| 4695 | (setq lst (cdr lst))) |
| 4696 | (if lst |
| 4697 | (car lst) |
| 4698 | ;; there is no element different of zero |
| 4699 | 0)) |
| 4700 | |
| 4701 | |
| 4702 | (defun version< (v1 v2) |
| 4703 | "Return t if version V1 is lower (older) than V2. |
| 4704 | |
| 4705 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", |
| 4706 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
| 4707 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", |
| 4708 | which is higher than \"1alpha\", which is higher than \"1snapshot\". |
| 4709 | Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions." |
| 4710 | (version-list-< (version-to-list v1) (version-to-list v2))) |
| 4711 | |
| 4712 | (defun version<= (v1 v2) |
| 4713 | "Return t if version V1 is lower (older) than or equal to V2. |
| 4714 | |
| 4715 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", |
| 4716 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
| 4717 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", |
| 4718 | which is higher than \"1alpha\", which is higher than \"1snapshot\". |
| 4719 | Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions." |
| 4720 | (version-list-<= (version-to-list v1) (version-to-list v2))) |
| 4721 | |
| 4722 | (defun version= (v1 v2) |
| 4723 | "Return t if version V1 is equal to V2. |
| 4724 | |
| 4725 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", |
| 4726 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
| 4727 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", |
| 4728 | which is higher than \"1alpha\", which is higher than \"1snapshot\". |
| 4729 | Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions." |
| 4730 | (version-list-= (version-to-list v1) (version-to-list v2))) |
| 4731 | |
| 4732 | \f |
| 4733 | ;;; Misc. |
| 4734 | (defconst menu-bar-separator '("--") |
| 4735 | "Separator for menus.") |
| 4736 | |
| 4737 | ;; The following statement ought to be in print.c, but `provide' can't |
| 4738 | ;; be used there. |
| 4739 | ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html |
| 4740 | (when (hash-table-p (car (read-from-string |
| 4741 | (prin1-to-string (make-hash-table))))) |
| 4742 | (provide 'hashtable-print-readable)) |
| 4743 | |
| 4744 | ;; This is used in lisp/Makefile.in and in leim/Makefile.in to |
| 4745 | ;; generate file names for autoloads, custom-deps, and finder-data. |
| 4746 | (defun unmsys--file-name (file) |
| 4747 | "Produce the canonical file name for FILE from its MSYS form. |
| 4748 | |
| 4749 | On systems other than MS-Windows, just returns FILE. |
| 4750 | On MS-Windows, converts /d/foo/bar form of file names |
| 4751 | passed by MSYS Make into d:/foo/bar that Emacs can grok. |
| 4752 | |
| 4753 | This function is called from lisp/Makefile and leim/Makefile." |
| 4754 | (when (and (eq system-type 'windows-nt) |
| 4755 | (string-match "\\`/[a-zA-Z]/" file)) |
| 4756 | (setq file (concat (substring file 1 2) ":" (substring file 2)))) |
| 4757 | file) |
| 4758 | |
| 4759 | |
| 4760 | ;;; subr.el ends here |