;;; select.el --- lisp portion of standard selection support
+;; Copyright (C) 1993-1994, 2001-2013 Free Software Foundation, Inc.
+
;; Maintainer: FSF
;; Keywords: internal
-;; Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007 Free Software Foundation, Inc.
-;; Based partially on earlier release by Lucid.
-
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
+;; Based partially on earlier release by Lucid.
+
;;; Code:
-;; This is for temporary compatibility with pre-release Emacs 19.
-(defalias 'x-selection 'x-get-selection)
+(defcustom selection-coding-system nil
+ "Coding system for communicating with other programs.
+
+For MS-Windows and MS-DOS:
+When sending or receiving text via selection and clipboard, the text
+is encoded or decoded by this coding system. The default value is
+the current system default encoding on 9x/Me, `utf-16le-dos'
+\(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.
+
+For X Windows:
+When sending text via selection and clipboard, if the target
+data-type matches with the type of this coding system, it is used
+for encoding the text. Otherwise (including the case that this
+variable is nil), a proper coding system is used as below:
+
+data-type coding system
+--------- -------------
+UTF8_STRING utf-8
+COMPOUND_TEXT compound-text-with-extensions
+STRING iso-latin-1
+C_STRING no-conversion
+
+When receiving text, if this coding system is non-nil, it is used
+for decoding regardless of the data-type. If this is nil, a
+proper coding system is used according to the data-type as above.
+
+See also the documentation of the variable `x-select-request-type' how
+to control which data-type to request for receiving text.
+
+The default value is nil."
+ :type 'coding-system
+ :group 'mule
+ ;; Default was compound-text-with-extensions in 22.x (pre-unicode).
+ :version "23.1"
+ :set (lambda (symbol value)
+ (set-selection-coding-system value)
+ (set symbol value)))
+
+(defvar next-selection-coding-system nil
+ "Coding system for the next communication with other programs.
+Usually, `selection-coding-system' is used for communicating with
+other programs (X Windows clients or MS Windows programs). But, if this
+variable is set, it is used for the next communication only.
+After the communication, this variable is set to nil.")
+
+(declare-function x-get-selection-internal "xselect.c"
+ (selection-symbol target-type &optional time-stamp terminal))
+
+;; Only declared obsolete in 23.3.
+(define-obsolete-function-alias 'x-selection 'x-get-selection "at least 19.34")
+
(defun x-get-selection (&optional type data-type)
"Return the value of an X Windows selection.
The argument TYPE (default `PRIMARY') says which selection,
coding)
(when (and (stringp data)
(setq data-type (get-text-property 0 'foreign-selection data)))
- (setq coding (if (eq data-type 'UTF8_STRING)
- 'utf-8
- (or next-selection-coding-system
- selection-coding-system))
- data (decode-coding-string data coding))
+ (setq coding (or next-selection-coding-system
+ selection-coding-system
+ (cond ((eq data-type 'UTF8_STRING)
+ 'utf-8)
+ ((eq data-type 'COMPOUND_TEXT)
+ 'compound-text-with-extensions)
+ ((eq data-type 'C_STRING)
+ nil)
+ ((eq data-type 'STRING)
+ 'iso-8859-1)
+ (t
+ (error "Unknown selection data type: %S" type))))
+ data (if coding (decode-coding-string data coding)
+ (string-to-multibyte data)))
+ (setq next-selection-coding-system nil)
(put-text-property 0 (length data) 'foreign-selection data-type data))
data))
"Return text pasted to the clipboard."
(x-get-selection-internal 'CLIPBOARD 'STRING))
+(declare-function x-own-selection-internal "xselect.c"
+ (selection-name selection-value &optional frame))
+(declare-function x-disown-selection-internal "xselect.c"
+ (selection &optional time terminal))
+
(defun x-set-selection (type data)
- "Make an X Windows selection of type TYPE and value DATA.
+ "Make an X selection of type TYPE and value DATA.
The argument TYPE (nil means `PRIMARY') says which selection, and
DATA specifies the contents. TYPE must be a symbol. \(It can also
be a string, which stands for the symbol with that name, but this
Interactively, this command sets the primary selection. Without
prefix argument, it reads the selection in the minibuffer. With
-prefix argument, it uses the text of the region as the selection value ."
+prefix argument, it uses the text of the region as the selection value.
+
+Note that on MS-Windows, primary and secondary selections set by Emacs
+are not available to other programs."
(interactive (if (not current-prefix-arg)
(list 'PRIMARY (read-string "Set text for pasting: "))
(list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
- ;; This is for temporary compatibility with pre-release Emacs 19.
- (if (stringp type)
- (setq type (intern type)))
+ (if (stringp type) (setq type (intern type)))
(or (x-valid-simple-selection-p data)
(and (vectorp data)
(let ((valid t)
data)
(defun x-valid-simple-selection-p (data)
- (or (stringp data)
- (symbolp data)
- (integerp data)
- (and (consp data)
- (integerp (car data))
- (or (integerp (cdr data))
- (and (consp (cdr data))
- (integerp (car (cdr data))))))
- (overlayp data)
+ (or (bufferp data)
(and (consp data)
(markerp (car data))
(markerp (cdr data))
(marker-buffer (car data))
- (marker-buffer (cdr data))
- (eq (marker-buffer (car data))
- (marker-buffer (cdr data)))
(buffer-name (marker-buffer (car data)))
- (buffer-name (marker-buffer (cdr data))))))
-\f
-;;; Cut Buffer support
-
-(defun x-get-cut-buffer (&optional which-one)
- "Returns the value of one of the 8 X server cut-buffers.
-Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
-Cut buffers are considered obsolete; you should use selections instead."
- (x-get-cut-buffer-internal
- (if which-one
- (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3
- CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7]
- which-one)
- 'CUT_BUFFER0)))
-
-(defun x-set-cut-buffer (string &optional push)
- "Store STRING into the X server's primary cut buffer.
-If PUSH is non-nil, also rotate the cut buffers:
-this means the previous value of the primary cut buffer moves to the second
-cut buffer, and the second to the third, and so on (there are 8 buffers.)
-Cut buffers are considered obsolete; you should use selections instead."
- (or (stringp string) (signal 'wrong-type-argument (list 'string string)))
- (if push
- (x-rotate-cut-buffers-internal 1))
- (x-store-cut-buffer-internal 'CUT_BUFFER0 string))
-
+ (eq (marker-buffer (car data))
+ (marker-buffer (cdr data))))
+ (stringp data)
+ (and (overlayp data)
+ (overlay-buffer data)
+ (buffer-name (overlay-buffer data)))
+ (symbolp data)
+ (integerp data)))
\f
-;;; Functions to convert the selection into various other selection types.
-;;; Every selection type that Emacs handles is implemented this way, except
-;;; for TIMESTAMP, which is a special case.
-
-(eval-when-compile (require 'ccl))
-
-(define-ccl-program ccl-check-utf-8
- '(0
- ((r0 = 1)
- (loop
- (read-if (r1 < #x80) (repeat)
- ((r0 = 0)
- (if (r1 < #xC2) (end))
- (read r2)
- (if ((r2 & #xC0) != #x80) (end))
- (if (r1 < #xE0) ((r0 = 1) (repeat)))
- (read r2)
- (if ((r2 & #xC0) != #x80) (end))
- (if (r1 < #xF0) ((r0 = 1) (repeat)))
- (read r2)
- (if ((r2 & #xC0) != #x80) (end))
- (if (r1 < #xF8) ((r0 = 1) (repeat)))
- (read r2)
- (if ((r2 & #xC0) != #x80) (end))
- (if (r1 == #xF8) ((r0 = 1) (repeat)))
- (end))))))
- "Check if the input unibyte string is a valid UTF-8 sequence or not.
-If it is valid, set the register `r0' to 1, else set it to 0.")
-
-(defun string-utf-8-p (string)
- "Return non-nil iff STRING is a unibyte string of valid UTF-8 sequence."
- (if (or (not (stringp string))
- (multibyte-string-p string))
- (error "Not a unibyte string: %s" string))
- (let ((status (make-vector 9 0)))
- (ccl-execute-on-string ccl-check-utf-8 status string)
- (= (aref status 0) 1)))
-
-
-(defun xselect-convert-to-string (selection type value)
- (let (str coding)
- ;; Get the actual string from VALUE.
- (cond ((stringp value)
- (setq str value))
-
- ((overlayp value)
- (save-excursion
- (or (buffer-name (overlay-buffer value))
- (error "selection is in a killed buffer"))
- (set-buffer (overlay-buffer value))
- (setq str (buffer-substring (overlay-start value)
- (overlay-end value)))))
- ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (or (eq (marker-buffer (car value)) (marker-buffer (cdr value)))
- (signal 'error
- (list "markers must be in the same buffer"
- (car value) (cdr value))))
- (save-excursion
- (set-buffer (or (marker-buffer (car value))
- (error "selection is in a killed buffer")))
- (setq str (buffer-substring (car value) (cdr value))))))
-
- (when str
- ;; If TYPE is nil, this is a local request, thus return STR as
- ;; is. Otherwise, encode STR.
- (if (not type)
- str
- (setq coding (or next-selection-coding-system selection-coding-system))
+;; Functions to convert the selection into various other selection types.
+;; Every selection type that Emacs handles is implemented this way, except
+;; for TIMESTAMP, which is a special case.
+
+(defun xselect--selection-bounds (value)
+ "Return bounds of X selection value VALUE.
+The return value is a list (BEG END BUF) if VALUE is a cons of
+two markers or an overlay. Otherwise, it is nil."
+ (cond ((bufferp value)
+ (with-current-buffer value
+ (when (mark t)
+ (list (mark t) (point) value))))
+ ((and (consp value)
+ (markerp (car value))
+ (markerp (cdr value)))
+ (when (and (marker-buffer (car value))
+ (buffer-name (marker-buffer (car value)))
+ (eq (marker-buffer (car value))
+ (marker-buffer (cdr value))))
+ (list (marker-position (car value))
+ (marker-position (cdr value))
+ (marker-buffer (car value)))))
+ ((overlayp value)
+ (when (overlay-buffer value)
+ (list (overlay-start value)
+ (overlay-end value)
+ (overlay-buffer value))))))
+
+(defun xselect--int-to-cons (n)
+ (cons (ash n -16) (logand n 65535)))
+
+(defun xselect--encode-string (type str &optional can-modify)
+ (when str
+ ;; If TYPE is nil, this is a local request; return STR as-is.
+ (if (null type)
+ str
+ ;; Otherwise, encode STR.
+ (let ((coding (or next-selection-coding-system
+ selection-coding-system)))
(if coding
- (setq coding (coding-system-base coding))
- (setq coding 'raw-text))
+ (setq coding (coding-system-base coding)))
(let ((inhibit-read-only t))
;; Suppress producing escape sequences for compositions.
+ ;; But avoid modifying the string if it's a buffer name etc.
+ (unless can-modify (setq str (substring str 0)))
(remove-text-properties 0 (length str) '(composition nil) str)
+ ;; For X selections, TEXT is a polymorphic target; choose
+ ;; the actual type from `UTF8_STRING', `COMPOUND_TEXT',
+ ;; `STRING', and `C_STRING'. On Nextstep, always use UTF-8
+ ;; (see ns_string_to_pasteboard_internal in nsselect.m).
+ (when (eq type 'TEXT)
+ (cond
+ ((featurep 'ns)
+ (setq type 'UTF8_STRING))
+ ((not (multibyte-string-p str))
+ (setq type 'C_STRING))
+ (t
+ (let (non-latin-1 non-unicode eight-bit)
+ (mapc #'(lambda (x)
+ (if (>= x #x100)
+ (if (< x #x110000)
+ (setq non-latin-1 t)
+ (if (< x #x3FFF80)
+ (setq non-unicode t)
+ (setq eight-bit t)))))
+ str)
+ (setq type (if (or non-unicode
+ (and
+ non-latin-1
+ ;; If a coding is specified for
+ ;; selection, and that is
+ ;; compatible with COMPOUND_TEXT,
+ ;; use it.
+ coding
+ (eq (coding-system-get coding :mime-charset)
+ 'x-ctext)))
+ 'COMPOUND_TEXT
+ (if non-latin-1 'UTF8_STRING
+ (if eight-bit 'C_STRING
+ 'STRING))))))))
(cond
- ((eq type 'TEXT)
- (if (not (multibyte-string-p str))
- ;; Don't have to encode unibyte string.
- (setq type 'STRING)
- ;; If STR contains only ASCII, Latin-1, and raw bytes,
- ;; encode STR by iso-latin-1, and return it as type
- ;; `STRING'. Otherwise, encode STR by CODING. In that
- ;; case, the returing type depends on CODING.
- (let ((charsets (find-charset-string str)))
- (setq charsets
- (delq 'ascii
- (delq 'latin-iso8859-1
- (delq 'eight-bit-control
- (delq 'eight-bit-graphic charsets)))))
- (if charsets
- (setq str (encode-coding-string str coding)
- type (if (memq coding '(compound-text
- compound-text-with-extensions))
- 'COMPOUND_TEXT
- 'STRING))
- (setq type 'STRING
- str (encode-coding-string str 'iso-latin-1))))))
+ ((eq type 'UTF8_STRING)
+ (if (or (not coding)
+ (not (eq (coding-system-type coding) 'utf-8)))
+ (setq coding 'utf-8))
+ (setq str (encode-coding-string str coding)))
+
+ ((eq type 'STRING)
+ (if (or (not coding)
+ (not (eq (coding-system-type coding) 'charset)))
+ (setq coding 'iso-8859-1))
+ (setq str (encode-coding-string str coding)))
((eq type 'COMPOUND_TEXT)
+ (if (or (not coding)
+ (not (eq (coding-system-type coding) 'iso-2022)))
+ (setq coding 'compound-text-with-extensions))
(setq str (encode-coding-string str coding)))
- ((eq type 'STRING)
- (if (memq coding '(compound-text
- compound-text-with-extensions))
- (setq str (string-make-unibyte str))
- (setq str (encode-coding-string str coding))))
+ ((eq type 'C_STRING)
+ (setq str (string-make-unibyte str)))
- ((eq type 'UTF8_STRING)
- (if (multibyte-string-p str)
- (setq str (encode-coding-string str 'utf-8)))
- (if (not (string-utf-8-p str))
- (setq str nil))) ;; Decline request as we don't have UTF-8 data.
(t
- (error "Unknow selection type: %S" type))
- )))
+ (error "Unknown selection type: %S" type)))))
(setq next-selection-coding-system nil)
(cons type str))))
-
-(defun xselect-convert-to-length (selection type value)
- (let ((value
- (cond ((stringp value)
- (length value))
- ((overlayp value)
- (abs (- (overlay-end value) (overlay-start value))))
- ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (or (eq (marker-buffer (car value))
- (marker-buffer (cdr value)))
- (signal 'error
- (list "markers must be in the same buffer"
- (car value) (cdr value))))
- (abs (- (car value) (cdr value)))))))
- (if value ; force it to be in 32-bit format.
- (cons (ash value -16) (logand value 65535))
- nil)))
-
-(defun xselect-convert-to-targets (selection type value)
+(defun xselect-convert-to-string (_selection type value)
+ (let ((str (cond ((stringp value) value)
+ ((setq value (xselect--selection-bounds value))
+ (with-current-buffer (nth 2 value)
+ (buffer-substring (nth 0 value)
+ (nth 1 value)))))))
+ (xselect--encode-string type str t)))
+
+(defun xselect-convert-to-length (_selection _type value)
+ (let ((len (cond ((stringp value)
+ (length value))
+ ((setq value (xselect--selection-bounds value))
+ (abs (- (nth 0 value) (nth 1 value)))))))
+ (if len
+ (xselect--int-to-cons len))))
+
+(defun xselect-convert-to-targets (_selection _type _value)
;; return a vector of atoms, but remove duplicates first.
- (let* ((all (cons 'TIMESTAMP (mapcar 'car selection-converter-alist)))
+ (let* ((all (cons 'TIMESTAMP
+ (cons 'MULTIPLE
+ (mapcar 'car selection-converter-alist))))
(rest all))
(while rest
(cond ((memq (car rest) (cdr rest))
(setq rest (cdr rest)))))
(apply 'vector all)))
-(defun xselect-convert-to-delete (selection type value)
+(defun xselect-convert-to-delete (selection _type _value)
(x-disown-selection-internal selection)
;; A return value of nil means that we do not know how to do this conversion,
;; and replies with an "error". A return value of NULL means that we have
;; done the conversion (and any side-effects) but have no value to return.
'NULL)
-(defun xselect-convert-to-filename (selection type value)
- (cond ((overlayp value)
- (buffer-file-name (or (overlay-buffer value)
- (error "selection is in a killed buffer"))))
- ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (buffer-file-name (or (marker-buffer (car value))
- (error "selection is in a killed buffer"))))
- (t nil)))
-
-(defun xselect-convert-to-charpos (selection type value)
- (let (a b tmp)
- (cond ((cond ((overlayp value)
- (setq a (overlay-start value)
- b (overlay-end value)))
- ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (setq a (car value)
- b (cdr value))))
- (setq a (1- a) b (1- b)) ; zero-based
- (if (< b a) (setq tmp a a b b tmp))
- (cons 'SPAN
- (vector (cons (ash a -16) (logand a 65535))
- (cons (ash b -16) (logand b 65535))))))))
-
-(defun xselect-convert-to-lineno (selection type value)
- (let (a b buf tmp)
- (cond ((cond ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (setq a (marker-position (car value))
- b (marker-position (cdr value))
- buf (marker-buffer (car value))))
- ((overlayp value)
- (setq buf (overlay-buffer value)
- a (overlay-start value)
- b (overlay-end value)))
- )
- (save-excursion
- (set-buffer buf)
- (setq a (count-lines 1 a)
- b (count-lines 1 b)))
- (if (< b a) (setq tmp a a b b tmp))
- (cons 'SPAN
- (vector (cons (ash a -16) (logand a 65535))
- (cons (ash b -16) (logand b 65535))))))))
-
-(defun xselect-convert-to-colno (selection type value)
- (let (a b buf tmp)
- (cond ((cond ((and (consp value)
- (markerp (car value))
- (markerp (cdr value)))
- (setq a (car value)
- b (cdr value)
- buf (marker-buffer a)))
- ((overlayp value)
- (setq buf (overlay-buffer value)
- a (overlay-start value)
- b (overlay-end value)))
- )
- (save-excursion
- (set-buffer buf)
- (goto-char a)
- (setq a (current-column))
- (goto-char b)
- (setq b (current-column)))
- (if (< b a) (setq tmp a a b b tmp))
- (cons 'SPAN
- (vector (cons (ash a -16) (logand a 65535))
- (cons (ash b -16) (logand b 65535))))))))
-
-(defun xselect-convert-to-os (selection type size)
- (symbol-name system-type))
-
-(defun xselect-convert-to-host (selection type size)
- (system-name))
-
-(defun xselect-convert-to-user (selection type size)
- (user-full-name))
-
-(defun xselect-convert-to-class (selection type size)
+(defun xselect-convert-to-filename (_selection _type value)
+ (when (setq value (xselect--selection-bounds value))
+ (xselect--encode-string 'TEXT (buffer-file-name (nth 2 value)))))
+
+(defun xselect-convert-to-charpos (_selection _type value)
+ (when (setq value (xselect--selection-bounds value))
+ (let ((beg (1- (nth 0 value))) ; zero-based
+ (end (1- (nth 1 value))))
+ (cons 'SPAN (vector (xselect--int-to-cons (min beg end))
+ (xselect--int-to-cons (max beg end)))))))
+
+(defun xselect-convert-to-lineno (_selection _type value)
+ (when (setq value (xselect--selection-bounds value))
+ (with-current-buffer (nth 2 value)
+ (let ((beg (line-number-at-pos (nth 0 value)))
+ (end (line-number-at-pos (nth 1 value))))
+ (cons 'SPAN (vector (xselect--int-to-cons (min beg end))
+ (xselect--int-to-cons (max beg end))))))))
+
+(defun xselect-convert-to-colno (_selection _type value)
+ (when (setq value (xselect--selection-bounds value))
+ (with-current-buffer (nth 2 value)
+ (let ((beg (progn (goto-char (nth 0 value)) (current-column)))
+ (end (progn (goto-char (nth 1 value)) (current-column))))
+ (cons 'SPAN (vector (xselect--int-to-cons (min beg end))
+ (xselect--int-to-cons (max beg end))))))))
+
+(defun xselect-convert-to-os (_selection _type _size)
+ (xselect--encode-string 'TEXT (symbol-name system-type)))
+
+(defun xselect-convert-to-host (_selection _type _size)
+ (xselect--encode-string 'TEXT (system-name)))
+
+(defun xselect-convert-to-user (_selection _type _size)
+ (xselect--encode-string 'TEXT (user-full-name)))
+
+(defun xselect-convert-to-class (_selection _type _size)
"Convert selection to class.
This function returns the string \"Emacs\"."
"Emacs")
;; We do not try to determine the name Emacs was invoked with,
;; because it is not clean for a program's behavior to depend on that.
-(defun xselect-convert-to-name (selection type size)
+(defun xselect-convert-to-name (_selection _type _size)
"Convert selection to name.
This function returns the string \"emacs\"."
"emacs")
-(defun xselect-convert-to-integer (selection type value)
+(defun xselect-convert-to-integer (_selection _type value)
(and (integerp value)
- (cons (ash value -16) (logand value 65535))))
+ (xselect--int-to-cons value)))
-(defun xselect-convert-to-atom (selection type value)
+(defun xselect-convert-to-atom (_selection _type value)
(and (symbolp value) value))
-(defun xselect-convert-to-identity (selection type value) ; used internally
+(defun xselect-convert-to-identity (_selection _type value) ; used internally
(vector value))
+;; Null target that tells clipboard managers we support SAVE_TARGETS
+;; (see freedesktop.org Clipboard Manager spec).
+(defun xselect-convert-to-save-targets (selection _type _value)
+ (when (eq selection 'CLIPBOARD)
+ 'NULL))
+
(setq selection-converter-alist
'((TEXT . xselect-convert-to-string)
(COMPOUND_TEXT . xselect-convert-to-string)
(NAME . xselect-convert-to-name)
(ATOM . xselect-convert-to-atom)
(INTEGER . xselect-convert-to-integer)
- (_EMACS_INTERNAL . xselect-convert-to-identity)
- ))
+ (SAVE_TARGETS . xselect-convert-to-save-targets)
+ (_EMACS_INTERNAL . xselect-convert-to-identity)))
(provide 'select)
-;;; arch-tag: bb634f97-8a3b-4b0a-b940-f6e09982328c
;;; select.el ends here