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