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 Free Software Foundation, Inc.
   7 ;; Based partially on earlier release by Lucid.
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 ;; This is for temporary compatibility with pre-release Emacs 19.
  31 (defalias 'x-selection 'x-get-selection)
  32 (defun x-get-selection (&optional type data-type)
  33   "Return the value of an X Windows selection.
  34 The argument TYPE (default `PRIMARY') says which selection,
  35 and the argument DATA-TYPE (default `STRING') says
  36 how to convert the data.
  37
  38 TYPE may be `SECONDARY' or `CLIPBOARD', in addition to `PRIMARY'.
  39 DATA-TYPE is usually `STRING', but can also be one of the symbols
  40 in `selection-converter-alist', which see."
  41   (x-get-selection-internal (or type 'PRIMARY) (or data-type 'STRING)))
  42
  43 (defun x-get-clipboard ()
  44   "Return text pasted to the clipboard."
  45   (x-get-selection-internal 'CLIPBOARD 'STRING))
  46
  47 (defun x-set-selection (type data)
  48   "Make an X Windows selection of type TYPE and value DATA.
  49 The argument TYPE (default `PRIMARY') says which selection,
  50 and DATA specifies the contents.  DATA may be a string,
  51 a symbol, an integer (or a cons of two integers or list of two integers).
  52
  53 The selection may also be a cons of two markers pointing to the same buffer,
  54 or an overlay.  In these cases, the selection is considered to be the text
  55 between the markers *at whatever time the selection is examined*.
  56 Thus, editing done in the buffer after you specify the selection
  57 can alter the effective value of the selection.
  58
  59 The data may also be a vector of valid non-vector selection values.
  60
  61 Interactively, the text of the region is used as the selection value
  62 if the prefix arg is set."
  63   (interactive (if (not current-prefix-arg)
  64                    (list 'PRIMARY (read-string "Set text for pasting: "))
  65                  (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
  66   ;; This is for temporary compatibility with pre-release Emacs 19.
  67   (if (stringp type)
  68       (setq type (intern type)))
  69   (or (x-valid-simple-selection-p data)
  70       (and (vectorp data)
  71            (let ((valid t)
  72                  (i (1- (length data))))
  73              (while (>= i 0)
  74                (or (x-valid-simple-selection-p (aref data i))
  75                    (setq valid nil))
  76                (setq i (1- i)))
  77              valid))
  78       (signal 'error (list "invalid selection" data)))
  79   (or type (setq type 'PRIMARY))
  80   (if data
  81       (x-own-selection-internal type data)
  82     (x-disown-selection-internal type))
  83   data)
  84
  85 (defun x-valid-simple-selection-p (data)
  86   (or (stringp data)
  87       (symbolp data)
  88       (integerp data)
  89       (and (consp data)
  90            (integerp (car data))
  91            (or (integerp (cdr data))
  92                (and (consp (cdr data))
  93                     (integerp (car (cdr data))))))
  94       (overlayp data)
  95       (and (consp data)
  96            (markerp (car data))
  97            (markerp (cdr data))
  98            (marker-buffer (car data))
  99            (marker-buffer (cdr data))
 100            (eq (marker-buffer (car data))
 101                (marker-buffer (cdr data)))
 102            (buffer-name (marker-buffer (car data)))
 103            (buffer-name (marker-buffer (cdr data))))))
 104 \f
 105 ;;; Cut Buffer support
 106
 107 (defun x-get-cut-buffer (&optional which-one)
 108   "Returns the value of one of the 8 X server cut-buffers.
 109 Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
 110 Cut buffers are considered obsolete; you should use selections instead."
 111   (x-get-cut-buffer-internal
 112    (if which-one
 113        (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3
 114               CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7]
 115              which-one)
 116      'CUT_BUFFER0)))
 117
 118 (defun x-set-cut-buffer (string &optional push)
 119   "Store STRING into the X server's primary cut buffer.
 120 If PUSH is non-nil, also rotate the cut buffers:
 121 this means the previous value of the primary cut buffer moves to the second
 122 cut buffer, and the second to the third, and so on (there are 8 buffers.)
 123 Cut buffers are considered obsolete; you should use selections instead."
 124   (or (stringp string) (signal 'wrong-type-argument (list 'string string)))
 125   (if push
 126       (x-rotate-cut-buffers-internal 1))
 127   (x-store-cut-buffer-internal 'CUT_BUFFER0 string))
 128
 129 \f
 130 ;;; Functions to convert the selection into various other selection types.
 131 ;;; Every selection type that Emacs handles is implemented this way, except
 132 ;;; for TIMESTAMP, which is a special case.
 133
 134 (defun xselect-convert-to-string (selection type value)
 135   (let (str coding)
 136     ;; Get the actual string from VALUE.
 137     (cond ((stringp value)
 138            (setq str value))
 139
 140           ((overlayp value)
 141            (save-excursion
 142              (or (buffer-name (overlay-buffer value))
 143                  (error "selection is in a killed buffer"))
 144              (set-buffer (overlay-buffer value))
 145              (setq str (buffer-substring (overlay-start value)
 146                                          (overlay-end value)))))
 147           ((and (consp value)
 148                 (markerp (car value))
 149                 (markerp (cdr value)))
 150            (or (eq (marker-buffer (car value)) (marker-buffer (cdr value)))
 151                (signal 'error
 152                        (list "markers must be in the same buffer"
 153                              (car value) (cdr value))))
 154            (save-excursion
 155              (set-buffer (or (marker-buffer (car value))
 156                              (error "selection is in a killed buffer")))
 157              (setq str (buffer-substring (car value) (cdr value))))))
 158
 159     (when str
 160       ;; If TYPE is nil, this is a local request, thus return STR as
 161       ;; is.  Otherwise, encode STR.
 162       (if (not type)
 163           str
 164         (setq coding (or next-selection-coding-system selection-coding-system))
 165         (if coding
 166             (setq coding (coding-system-base coding))
 167           (setq coding 'raw-text))
 168         ;; Suppress producing escape sequences for compositions.
 169         (remove-text-properties 0 (length str) '(composition nil) str)
 170         (cond
 171          ((eq type 'TEXT)
 172           (if (not (multibyte-string-p str))
 173               ;; Don't have to encode unibyte string.
 174               (setq type 'STRING)
 175             ;; If STR contains only ASCII, Latin-1, and raw bytes,
 176             ;; encode STR by iso-latin-1, and return it as type
 177             ;; `STRING'.  Otherwise, encode STR by CODING.  In that
 178             ;; case, the returing type depends on CODING.
 179             (let ((charsets (find-charset-string str)))
 180               (setq charsets
 181                     (delq 'ascii
 182                           (delq 'latin-iso8859-1
 183                                 (delq 'eight-bit-control
 184                                       (delq 'eight-bit-graphic charsets)))))
 185               (if charsets
 186                   (setq str (encode-coding-string str coding)
 187                         type (if (memq coding '(compound-text
 188                                                 compound-text-with-extensions))
 189                                  'COMPOUND_TEXT
 190                                'STRING))
 191                 (setq type 'STRING
 192                       str (encode-coding-string str 'iso-latin-1))))))
 193
 194          ((eq type 'COMPOUND_TEXT)
 195           (setq str (encode-coding-string str coding)))
 196
 197          ((eq type 'STRING)
 198           (if (memq coding '(compound-text
 199                              compound-text-with-extensions))
 200               (setq str (string-make-unibyte str))
 201             (setq str (encode-coding-string str coding))))
 202
 203          ((eq type 'UTF8_STRING)
 204           (setq str (encode-coding-string str 'utf-8)))
 205
 206          (t
 207           (error "Unknow selection type: %S" type))
 208          ))
 209
 210       (setq next-selection-coding-system nil)
 211       (cons type str))))
 212
 213
 214 (defun xselect-convert-to-length (selection type value)
 215   (let ((value
 216          (cond ((stringp value)
 217                 (length value))
 218                ((overlayp value)
 219                 (abs (- (overlay-end value) (overlay-start value))))
 220                ((and (consp value)
 221                      (markerp (car value))
 222                      (markerp (cdr value)))
 223                 (or (eq (marker-buffer (car value))
 224                         (marker-buffer (cdr value)))
 225                     (signal 'error
 226                             (list "markers must be in the same buffer"
 227                                   (car value) (cdr value))))
 228                 (abs (- (car value) (cdr value)))))))
 229     (if value ; force it to be in 32-bit format.
 230         (cons (ash value -16) (logand value 65535))
 231       nil)))
 232
 233 (defun xselect-convert-to-targets (selection type value)
 234   ;; return a vector of atoms, but remove duplicates first.
 235   (let* ((all (cons 'TIMESTAMP (mapcar 'car selection-converter-alist)))
 236          (rest all))
 237     (while rest
 238       (cond ((memq (car rest) (cdr rest))
 239              (setcdr rest (delq (car rest) (cdr rest))))
 240             ((eq (car (cdr rest)) '_EMACS_INTERNAL)  ; shh, it's a secret
 241              (setcdr rest (cdr (cdr rest))))
 242             (t
 243              (setq rest (cdr rest)))))
 244     (apply 'vector all)))
 245
 246 (defun xselect-convert-to-delete (selection type value)
 247   (x-disown-selection-internal selection)
 248   ;; A return value of nil means that we do not know how to do this conversion,
 249   ;; and replies with an "error".  A return value of NULL means that we have
 250   ;; done the conversion (and any side-effects) but have no value to return.
 251   'NULL)
 252
 253 (defun xselect-convert-to-filename (selection type value)
 254   (cond ((overlayp value)
 255          (buffer-file-name (or (overlay-buffer value)
 256                                (error "selection is in a killed buffer"))))
 257         ((and (consp value)
 258               (markerp (car value))
 259               (markerp (cdr value)))
 260          (buffer-file-name (or (marker-buffer (car value))
 261                                (error "selection is in a killed buffer"))))
 262         (t nil)))
 263
 264 (defun xselect-convert-to-charpos (selection type value)
 265   (let (a b tmp)
 266     (cond ((cond ((overlayp value)
 267                   (setq a (overlay-start value)
 268                         b (overlay-end value)))
 269                  ((and (consp value)
 270                        (markerp (car value))
 271                        (markerp (cdr value)))
 272                   (setq a (car value)
 273                         b (cdr value))))
 274            (setq a (1- a) b (1- b)) ; zero-based
 275            (if (< b a) (setq tmp a a b b tmp))
 276            (cons 'SPAN
 277                  (vector (cons (ash a -16) (logand a 65535))
 278                          (cons (ash b -16) (logand b 65535))))))))
 279
 280 (defun xselect-convert-to-lineno (selection type value)
 281   (let (a b buf tmp)
 282     (cond ((cond ((and (consp value)
 283                        (markerp (car value))
 284                        (markerp (cdr value)))
 285                   (setq a (marker-position (car value))
 286                         b (marker-position (cdr value))
 287                         buf (marker-buffer (car value))))
 288                  ((overlayp value)
 289                   (setq buf (overlay-buffer value)
 290                         a (overlay-start value)
 291                         b (overlay-end value)))
 292                  )
 293            (save-excursion
 294              (set-buffer buf)
 295              (setq a (count-lines 1 a)
 296                    b (count-lines 1 b)))
 297            (if (< b a) (setq tmp a a b b tmp))
 298            (cons 'SPAN
 299                  (vector (cons (ash a -16) (logand a 65535))
 300                          (cons (ash b -16) (logand b 65535))))))))
 301
 302 (defun xselect-convert-to-colno (selection type value)
 303   (let (a b buf tmp)
 304     (cond ((cond ((and (consp value)
 305                        (markerp (car value))
 306                        (markerp (cdr value)))
 307                   (setq a (car value)
 308                         b (cdr value)
 309                         buf (marker-buffer a)))
 310                  ((overlayp value)
 311                   (setq buf (overlay-buffer value)
 312                         a (overlay-start value)
 313                         b (overlay-end value)))
 314                  )
 315            (save-excursion
 316              (set-buffer buf)
 317              (goto-char a)
 318              (setq a (current-column))
 319              (goto-char b)
 320              (setq b (current-column)))
 321            (if (< b a) (setq tmp a a b b tmp))
 322            (cons 'SPAN
 323                  (vector (cons (ash a -16) (logand a 65535))
 324                          (cons (ash b -16) (logand b 65535))))))))
 325
 326 (defun xselect-convert-to-os (selection type size)
 327   (symbol-name system-type))
 328
 329 (defun xselect-convert-to-host (selection type size)
 330   (system-name))
 331
 332 (defun xselect-convert-to-user (selection type size)
 333   (user-full-name))
 334
 335 (defun xselect-convert-to-class (selection type size)
 336   "Convert selection to class.
 337 This function returns the string \"Emacs\"."
 338   "Emacs")
 339
 340 ;; We do not try to determine the name Emacs was invoked with,
 341 ;; because it is not clean for a program's behavior to depend on that.
 342 (defun xselect-convert-to-name (selection type size)
 343   "Convert selection to name.
 344 This function returns the string \"emacs\"."
 345   "emacs")
 346
 347 (defun xselect-convert-to-integer (selection type value)
 348   (and (integerp value)
 349        (cons (ash value -16) (logand value 65535))))
 350
 351 (defun xselect-convert-to-atom (selection type value)
 352   (and (symbolp value) value))
 353
 354 (defun xselect-convert-to-identity (selection type value) ; used internally
 355   (vector value))
 356
 357 (setq selection-converter-alist
 358       '((TEXT . xselect-convert-to-string)
 359         (COMPOUND_TEXT . xselect-convert-to-string)
 360         (STRING . xselect-convert-to-string)
 361         (UTF8_STRING . xselect-convert-to-string)
 362         (TARGETS . xselect-convert-to-targets)
 363         (LENGTH . xselect-convert-to-length)
 364         (DELETE . xselect-convert-to-delete)
 365         (FILE_NAME . xselect-convert-to-filename)
 366         (CHARACTER_POSITION . xselect-convert-to-charpos)
 367         (LINE_NUMBER . xselect-convert-to-lineno)
 368         (COLUMN_NUMBER . xselect-convert-to-colno)
 369         (OWNER_OS . xselect-convert-to-os)
 370         (HOST_NAME . xselect-convert-to-host)
 371         (USER . xselect-convert-to-user)
 372         (CLASS . xselect-convert-to-class)
 373         (NAME . xselect-convert-to-name)
 374         (ATOM . xselect-convert-to-atom)
 375         (INTEGER . xselect-convert-to-integer)
 376         (_EMACS_INTERNAL . xselect-convert-to-identity)
 377         ))
 378
 379 (provide 'select)
 380
 381 ;;; select.el ends here