lisp/select.el

   1 ;;; select.el --- lisp portion of standard selection support
   2
   3 ;; Maintainer: FSF
   4 ;; Keywords: internal
   5
   6 ;; Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   7 ;;   2008, 2009 Free Software Foundation, Inc.
   8 ;; Based partially on earlier release by Lucid.
   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 (defcustom selection-coding-system nil
  30   "Coding system for communicating with other X clients.
  31
  32 When sending text via selection and clipboard, if the target
  33 data-type matches with the type of this coding system, it is used
  34 for encoding the text.  Otherwise (including the case that this
  35 variable is nil), a proper coding system is used as below:
  36
  37 data-type       coding system
  38 ---------       -------------
  39 UTF8_STRING     utf-8
  40 COMPOUND_TEXT   compound-text-with-extensions
  41 STRING          iso-latin-1
  42 C_STRING        no-conversion
  43
  44 When receiving text, if this coding system is non-nil, it is used
  45 for decoding regardless of the data-type.  If this is nil, a
  46 proper coding system is used according to the data-type as above.
  47
  48 See also the documentation of the variable `x-select-request-type' how
  49 to control which data-type to request for receiving text.
  50
  51 The default value is nil."
  52   :type 'coding-system
  53   :group 'mule
  54   ;; Default was compound-text-with-extensions in 22.x (pre-unicode).
  55   :version "23.1"
  56   :set (lambda (symbol value)
  57          (set-selection-coding-system value)
  58          (set symbol value)))
  59
  60 (defvar next-selection-coding-system nil
  61   "Coding system for the next communication with other X clients.
  62 Usually, `selection-coding-system' is used for communicating with
  63 other X clients.  But, if this variable is set, it is used for
  64 the next communication only.  After the communication, this
  65 variable is set to nil.")
  66
  67 (declare-function x-get-selection-internal "xselect.c"
  68                   (selection-symbol target-type &optional time-stamp))
  69
  70 ;; This is for temporary compatibility with pre-release Emacs 19.
  71 (defalias 'x-selection 'x-get-selection)
  72 (defun x-get-selection (&optional type data-type)
  73   "Return the value of an X Windows selection.
  74 The argument TYPE (default `PRIMARY') says which selection,
  75 and the argument DATA-TYPE (default `STRING') says
  76 how to convert the data.
  77
  78 TYPE may be any symbol \(but nil stands for `PRIMARY').  However,
  79 only a few symbols are commonly used.  They conventionally have
  80 all upper-case names.  The most often used ones, in addition to
  81 `PRIMARY', are `SECONDARY' and `CLIPBOARD'.
  82
  83 DATA-TYPE is usually `STRING', but can also be one of the symbols
  84 in `selection-converter-alist', which see."
  85   (let ((data (x-get-selection-internal (or type 'PRIMARY)
  86                                         (or data-type 'STRING)))
  87         coding)
  88     (when (and (stringp data)
  89                (setq data-type (get-text-property 0 'foreign-selection data)))
  90       (setq coding (or next-selection-coding-system
  91                        selection-coding-system
  92                        (cond ((eq data-type 'UTF8_STRING)
  93                               'utf-8)
  94                              ((eq data-type 'COMPOUND_TEXT)
  95                               'compound-text-with-extensions)
  96                              ((eq data-type 'C_STRING)
  97                               nil)
  98                              ((eq data-type 'STRING)
  99                               'iso-8859-1)
 100                              (t
 101                               (error "Unknow selection data type: %S" type))))
 102             data (if coding (decode-coding-string data coding)
 103                    (string-to-multibyte data)))
 104       (setq next-selection-coding-system nil)
 105       (put-text-property 0 (length data) 'foreign-selection data-type data))
 106     data))
 107
 108 (defun x-get-clipboard ()
 109   "Return text pasted to the clipboard."
 110   (x-get-selection-internal 'CLIPBOARD 'STRING))
 111
 112 (declare-function x-own-selection-internal "xselect.c"
 113                   (selection-name selection-value))
 114 (declare-function x-disown-selection-internal "xselect.c"
 115                   (selection &optional time))
 116
 117 (defun x-set-selection (type data)
 118   "Make an X Windows selection of type TYPE and value DATA.
 119 The argument TYPE (nil means `PRIMARY') says which selection, and
 120 DATA specifies the contents.  TYPE must be a symbol.  \(It can also
 121 be a string, which stands for the symbol with that name, but this
 122 is considered obsolete.)  DATA may be a string, a symbol, an
 123 integer (or a cons of two integers or list of two integers).
 124
 125 The selection may also be a cons of two markers pointing to the same buffer,
 126 or an overlay.  In these cases, the selection is considered to be the text
 127 between the markers *at whatever time the selection is examined*.
 128 Thus, editing done in the buffer after you specify the selection
 129 can alter the effective value of the selection.
 130
 131 The data may also be a vector of valid non-vector selection values.
 132
 133 The return value is DATA.
 134
 135 Interactively, this command sets the primary selection.  Without
 136 prefix argument, it reads the selection in the minibuffer.  With
 137 prefix argument, it uses the text of the region as the selection value ."
 138   (interactive (if (not current-prefix-arg)
 139                    (list 'PRIMARY (read-string "Set text for pasting: "))
 140                  (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
 141   ;; This is for temporary compatibility with pre-release Emacs 19.
 142   (if (stringp type)
 143       (setq type (intern type)))
 144   (or (x-valid-simple-selection-p data)
 145       (and (vectorp data)
 146            (let ((valid t)
 147                  (i (1- (length data))))
 148              (while (>= i 0)
 149                (or (x-valid-simple-selection-p (aref data i))
 150                    (setq valid nil))
 151                (setq i (1- i)))
 152              valid))
 153       (signal 'error (list "invalid selection" data)))
 154   (or type (setq type 'PRIMARY))
 155   (if data
 156       (x-own-selection-internal type data)
 157     (x-disown-selection-internal type))
 158   data)
 159
 160 (defun x-valid-simple-selection-p (data)
 161   (or (stringp data)
 162       (symbolp data)
 163       (integerp data)
 164       (and (consp data)
 165            (integerp (car data))
 166            (or (integerp (cdr data))
 167                (and (consp (cdr data))
 168                     (integerp (car (cdr data))))))
 169       (overlayp data)
 170       (and (consp data)
 171            (markerp (car data))
 172            (markerp (cdr data))
 173            (marker-buffer (car data))
 174            (marker-buffer (cdr data))
 175            (eq (marker-buffer (car data))
 176                (marker-buffer (cdr data)))
 177            (buffer-name (marker-buffer (car data)))
 178            (buffer-name (marker-buffer (cdr data))))))
 179 \f
 180 ;;; Cut Buffer support
 181
 182 (declare-function x-get-cut-buffer-internal "xselect.c")
 183
 184 (defun x-get-cut-buffer (&optional which-one)
 185   "Return the value of one of the 8 X server cut-buffers.
 186 Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
 187 Cut buffers are considered obsolete; you should use selections instead."
 188   (x-get-cut-buffer-internal
 189    (if which-one
 190        (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3
 191               CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7]
 192              which-one)
 193      'CUT_BUFFER0)))
 194
 195 (declare-function x-rotate-cut-buffers-internal "xselect.c")
 196 (declare-function x-store-cut-buffer-internal "xselect.c")
 197
 198 (defun x-set-cut-buffer (string &optional push)
 199   "Store STRING into the X server's primary cut buffer.
 200 If PUSH is non-nil, also rotate the cut buffers:
 201 this means the previous value of the primary cut buffer moves to the second
 202 cut buffer, and the second to the third, and so on (there are 8 buffers.)
 203 Cut buffers are considered obsolete; you should use selections instead."
 204   (or (stringp string) (signal 'wrong-type-argument (list 'stringp string)))
 205   (if push
 206       (x-rotate-cut-buffers-internal 1))
 207   (x-store-cut-buffer-internal 'CUT_BUFFER0 string))
 208
 209 \f
 210 ;; Functions to convert the selection into various other selection types.
 211 ;; Every selection type that Emacs handles is implemented this way, except
 212 ;; for TIMESTAMP, which is a special case.
 213
 214 (defun xselect-convert-to-string (selection type value)
 215   (let (str coding)
 216     ;; Get the actual string from VALUE.
 217     (cond ((stringp value)
 218            (setq str value))
 219
 220           ((overlayp value)
 221            (save-excursion
 222              (or (buffer-name (overlay-buffer value))
 223                  (error "selection is in a killed buffer"))
 224              (set-buffer (overlay-buffer value))
 225              (setq str (buffer-substring (overlay-start value)
 226                                          (overlay-end value)))))
 227           ((and (consp value)
 228                 (markerp (car value))
 229                 (markerp (cdr value)))
 230            (or (eq (marker-buffer (car value)) (marker-buffer (cdr value)))
 231                (signal 'error
 232                        (list "markers must be in the same buffer"
 233                              (car value) (cdr value))))
 234            (save-excursion
 235              (set-buffer (or (marker-buffer (car value))
 236                              (error "selection is in a killed buffer")))
 237              (setq str (buffer-substring (car value) (cdr value))))))
 238
 239     (when str
 240       ;; If TYPE is nil, this is a local request, thus return STR as
 241       ;; is.  Otherwise, encode STR.
 242       (if (not type)
 243           str
 244         (setq coding (or next-selection-coding-system selection-coding-system))
 245         (if coding
 246             (setq coding (coding-system-base coding)))
 247         (let ((inhibit-read-only t))
 248           ;; Suppress producing escape sequences for compositions.
 249           (remove-text-properties 0 (length str) '(composition nil) str)
 250           (if (eq type 'TEXT)
 251               ;; TEXT is a polymorphic target.  We must select the
 252               ;; actual type from `UTF8_STRING', `COMPOUND_TEXT',
 253               ;; `STRING', and `C_STRING'.
 254               (if (not (multibyte-string-p str))
 255                   (setq type 'C_STRING)
 256                 (let (non-latin-1 non-unicode eight-bit)
 257                   (mapc #'(lambda (x)
 258                             (if (>= x #x100)
 259                                 (if (< x #x110000)
 260                                     (setq non-latin-1 t)
 261                                   (if (< x #x3FFF80)
 262                                       (setq non-unicode t)
 263                                     (setq eight-bit t)))))
 264                         str)
 265                   (setq type (if non-unicode 'COMPOUND_TEXT
 266                                (if non-latin-1 'UTF8_STRING
 267                                  (if eight-bit 'C_STRING 'STRING)))))))
 268           (cond
 269            ((eq type 'UTF8_STRING)
 270             (if (or (not coding)
 271                     (not (eq (coding-system-type coding) 'utf-8)))
 272                 (setq coding 'utf-8))
 273             (setq str (encode-coding-string str coding)))
 274
 275            ((eq type 'STRING)
 276             (if (or (not coding)
 277                     (not (eq (coding-system-type coding) 'charset)))
 278                 (setq coding 'iso-8859-1))
 279             (setq str (encode-coding-string str coding)))
 280
 281            ((eq type 'COMPOUND_TEXT)
 282             (if (or (not coding)
 283                     (not (eq (coding-system-type coding) 'iso-2022)))
 284                 (setq coding 'compound-text-with-extensions))
 285             (setq str (encode-coding-string str coding)))
 286
 287            ((eq type 'C_STRING)
 288             (setq str (string-make-unibyte str)))
 289
 290            (t
 291             (error "Unknow selection type: %S" type))
 292            )))
 293
 294       (setq next-selection-coding-system nil)
 295       (cons type str))))
 296
 297
 298 (defun xselect-convert-to-length (selection type value)
 299   (let ((value
 300          (cond ((stringp value)
 301                 (length value))
 302                ((overlayp value)
 303                 (abs (- (overlay-end value) (overlay-start value))))
 304                ((and (consp value)
 305                      (markerp (car value))
 306                      (markerp (cdr value)))
 307                 (or (eq (marker-buffer (car value))
 308                         (marker-buffer (cdr value)))
 309                     (signal 'error
 310                             (list "markers must be in the same buffer"
 311                                   (car value) (cdr value))))
 312                 (abs (- (car value) (cdr value)))))))
 313     (if value ; force it to be in 32-bit format.
 314         (cons (ash value -16) (logand value 65535))
 315       nil)))
 316
 317 (defun xselect-convert-to-targets (selection type value)
 318   ;; return a vector of atoms, but remove duplicates first.
 319   (let* ((all (cons 'TIMESTAMP (mapcar 'car selection-converter-alist)))
 320          (rest all))
 321     (while rest
 322       (cond ((memq (car rest) (cdr rest))
 323              (setcdr rest (delq (car rest) (cdr rest))))
 324             ((eq (car (cdr rest)) '_EMACS_INTERNAL)  ; shh, it's a secret
 325              (setcdr rest (cdr (cdr rest))))
 326             (t
 327              (setq rest (cdr rest)))))
 328     (apply 'vector all)))
 329
 330 (defun xselect-convert-to-delete (selection type value)
 331   (x-disown-selection-internal selection)
 332   ;; A return value of nil means that we do not know how to do this conversion,
 333   ;; and replies with an "error".  A return value of NULL means that we have
 334   ;; done the conversion (and any side-effects) but have no value to return.
 335   'NULL)
 336
 337 (defun xselect-convert-to-filename (selection type value)
 338   (cond ((overlayp value)
 339          (buffer-file-name (or (overlay-buffer value)
 340                                (error "selection is in a killed buffer"))))
 341         ((and (consp value)
 342               (markerp (car value))
 343               (markerp (cdr value)))
 344          (buffer-file-name (or (marker-buffer (car value))
 345                                (error "selection is in a killed buffer"))))
 346         (t nil)))
 347
 348 (defun xselect-convert-to-charpos (selection type value)
 349   (let (a b tmp)
 350     (cond ((cond ((overlayp value)
 351                   (setq a (overlay-start value)
 352                         b (overlay-end value)))
 353                  ((and (consp value)
 354                        (markerp (car value))
 355                        (markerp (cdr value)))
 356                   (setq a (car value)
 357                         b (cdr value))))
 358            (setq a (1- a) b (1- b)) ; zero-based
 359            (if (< b a) (setq tmp a a b b tmp))
 360            (cons 'SPAN
 361                  (vector (cons (ash a -16) (logand a 65535))
 362                          (cons (ash b -16) (logand b 65535))))))))
 363
 364 (defun xselect-convert-to-lineno (selection type value)
 365   (let (a b buf tmp)
 366     (cond ((cond ((and (consp value)
 367                        (markerp (car value))
 368                        (markerp (cdr value)))
 369                   (setq a (marker-position (car value))
 370                         b (marker-position (cdr value))
 371                         buf (marker-buffer (car value))))
 372                  ((overlayp value)
 373                   (setq buf (overlay-buffer value)
 374                         a (overlay-start value)
 375                         b (overlay-end value)))
 376                  )
 377            (save-excursion
 378              (set-buffer buf)
 379              (setq a (count-lines 1 a)
 380                    b (count-lines 1 b)))
 381            (if (< b a) (setq tmp a a b b tmp))
 382            (cons 'SPAN
 383                  (vector (cons (ash a -16) (logand a 65535))
 384                          (cons (ash b -16) (logand b 65535))))))))
 385
 386 (defun xselect-convert-to-colno (selection type value)
 387   (let (a b buf tmp)
 388     (cond ((cond ((and (consp value)
 389                        (markerp (car value))
 390                        (markerp (cdr value)))
 391                   (setq a (car value)
 392                         b (cdr value)
 393                         buf (marker-buffer a)))
 394                  ((overlayp value)
 395                   (setq buf (overlay-buffer value)
 396                         a (overlay-start value)
 397                         b (overlay-end value)))
 398                  )
 399            (save-excursion
 400              (set-buffer buf)
 401              (goto-char a)
 402              (setq a (current-column))
 403              (goto-char b)
 404              (setq b (current-column)))
 405            (if (< b a) (setq tmp a a b b tmp))
 406            (cons 'SPAN
 407                  (vector (cons (ash a -16) (logand a 65535))
 408                          (cons (ash b -16) (logand b 65535))))))))
 409
 410 (defun xselect-convert-to-os (selection type size)
 411   (symbol-name system-type))
 412
 413 (defun xselect-convert-to-host (selection type size)
 414   (system-name))
 415
 416 (defun xselect-convert-to-user (selection type size)
 417   (user-full-name))
 418
 419 (defun xselect-convert-to-class (selection type size)
 420   "Convert selection to class.
 421 This function returns the string \"Emacs\"."
 422   "Emacs")
 423
 424 ;; We do not try to determine the name Emacs was invoked with,
 425 ;; because it is not clean for a program's behavior to depend on that.
 426 (defun xselect-convert-to-name (selection type size)
 427   "Convert selection to name.
 428 This function returns the string \"emacs\"."
 429   "emacs")
 430
 431 (defun xselect-convert-to-integer (selection type value)
 432   (and (integerp value)
 433        (cons (ash value -16) (logand value 65535))))
 434
 435 (defun xselect-convert-to-atom (selection type value)
 436   (and (symbolp value) value))
 437
 438 (defun xselect-convert-to-identity (selection type value) ; used internally
 439   (vector value))
 440
 441 (setq selection-converter-alist
 442       '((TEXT . xselect-convert-to-string)
 443         (COMPOUND_TEXT . xselect-convert-to-string)
 444         (STRING . xselect-convert-to-string)
 445         (UTF8_STRING . xselect-convert-to-string)
 446         (TARGETS . xselect-convert-to-targets)
 447         (LENGTH . xselect-convert-to-length)
 448         (DELETE . xselect-convert-to-delete)
 449         (FILE_NAME . xselect-convert-to-filename)
 450         (CHARACTER_POSITION . xselect-convert-to-charpos)
 451         (LINE_NUMBER . xselect-convert-to-lineno)
 452         (COLUMN_NUMBER . xselect-convert-to-colno)
 453         (OWNER_OS . xselect-convert-to-os)
 454         (HOST_NAME . xselect-convert-to-host)
 455         (USER . xselect-convert-to-user)
 456         (CLASS . xselect-convert-to-class)
 457         (NAME . xselect-convert-to-name)
 458         (ATOM . xselect-convert-to-atom)
 459         (INTEGER . xselect-convert-to-integer)
 460         (_EMACS_INTERNAL . xselect-convert-to-identity)
 461         ))
 462
 463 (provide 'select)
 464
 465 ;; arch-tag: bb634f97-8a3b-4b0a-b940-f6e09982328c
 466 ;;; select.el ends here