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