1 /* Selection processing for Emacs on the Microsoft Windows API.
3 Copyright (C) 1993-1994, 2001-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* Written by Kevin Gallo, Benjamin Riefenstahl */
24 * Notes on usage of selection-coding-system and
25 * next-selection-coding-system on MS Windows:
27 * The selection coding system variables apply only to the version of
28 * the clipboard data that is closest in type, i.e. when a 16-bit
29 * Unicode coding system is given, they apply to he Unicode clipboard
30 * (CF_UNICODETEXT), when a well-known console codepage is given, they
31 * apply to the console version of the clipboard data (CF_OEMTEXT),
32 * else they apply to the normal 8-bit text clipboard (CF_TEXT).
34 * When pasting (getting data from the OS), the clipboard format that
35 * matches the {next-}selection-coding-system is retrieved. If
36 * Unicode is requested, but not available, 8-bit text (CF_TEXT) is
37 * used. In all other cases the OS will transparently convert
38 * formats, so no other fallback is needed.
40 * When copying or cutting (sending data to the OS), the data is
41 * announced and stored internally, but only actually rendered on
42 * request. The requestor determines the format provided. The
43 * {next-}selection-coding-system is only used, when its corresponding
44 * clipboard type matches the type requested.
46 * Scenarios to use the facilities for customizing the selection
49 * ;; Generally use KOI8-R instead of the russian MS codepage for
50 * ;; the 8-bit clipboard.
51 * (set-selection-coding-system 'koi8-r-dos)
55 * ;; Create a special clipboard copy function that uses codepage
56 * ;; 1253 (Greek) to copy Greek text to a specific non-Unicode
58 * (defun greek-copy (beg end)
60 * (set-next-selection-coding-system 'cp1253-dos)
61 * (copy-region-as-kill beg end))
62 * (global-set-key "\C-c\C-c" 'greek-copy)
66 * Ideas for further directions:
68 * The encoding and decoding routines could be moved to Lisp code
69 * similar to how xselect.c does it (using well-known routine names
70 * for the delayed rendering). If the definition of which clipboard
71 * types should be supported is also moved to Lisp, functionality
72 * could be expanded to CF_HTML, CF_RTF and maybe other types.
77 #include "w32term.h" /* for all of the w32 includes */
78 #include "w32heap.h" /* os_subtype */
79 #include "blockinput.h"
82 #include "composite.h"
85 static HGLOBAL
convert_to_handle_as_ascii (void);
86 static HGLOBAL
convert_to_handle_as_coded (Lisp_Object coding_system
);
87 static Lisp_Object
render (Lisp_Object oformat
);
88 static Lisp_Object
render_locale (void);
89 static Lisp_Object
render_all (Lisp_Object ignore
);
90 static void run_protected (Lisp_Object (*code
) (Lisp_Object
), Lisp_Object arg
);
91 static Lisp_Object
lisp_error_handler (Lisp_Object error
);
92 static LRESULT CALLBACK
owner_callback (HWND win
, UINT msg
,
93 WPARAM wp
, LPARAM lp
);
94 static HWND
create_owner (void);
96 static void setup_config (void);
97 static BOOL WINAPI
enum_locale_callback (/*const*/ char* loc_string
);
98 static UINT
cp_from_locale (LCID lcid
, UINT format
);
99 static Lisp_Object
coding_from_cp (UINT codepage
);
100 static Lisp_Object
validate_coding_system (Lisp_Object coding_system
);
101 static void setup_windows_coding_system (Lisp_Object coding_system
,
102 struct coding_system
* coding
);
105 /* A remnant from X11: Symbol for the CLIPBORD selection type. Other
106 selections are not used on Windows, so we don't need symbols for
107 PRIMARY and SECONDARY. */
108 Lisp_Object QCLIPBOARD
;
110 /* Internal pseudo-constants, initialized in globals_of_w32select()
111 based on current system parameters. */
112 static LCID DEFAULT_LCID
;
113 static UINT ANSICP
, OEMCP
;
114 static Lisp_Object QUNICODE
, QANSICP
, QOEMCP
;
116 /* A hidden window just for the clipboard management. */
117 static HWND clipboard_owner
;
118 /* A flag to tell WM_DESTROYCLIPBOARD who is to blame this time (just
119 checking GetClipboardOwner() doesn't work, sadly). */
120 static int modifying_clipboard
= 0;
122 /* Configured transfer parameters, based on the last inspection of
123 selection-coding-system. */
124 static Lisp_Object cfg_coding_system
;
125 static UINT cfg_codepage
;
126 static LCID cfg_lcid
;
127 static UINT cfg_clipboard_type
;
129 /* The current state for delayed rendering. */
130 static Lisp_Object current_text
;
131 static Lisp_Object current_coding_system
;
132 static int current_requires_encoding
, current_num_nls
;
133 static UINT current_clipboard_type
;
134 static LCID current_lcid
;
137 #define ONTRACE(stmt) stmt
139 #define ONTRACE(stmt) /*stmt*/
143 /* This function assumes that there is no multibyte character in
144 current_text, so we can short-cut encoding. */
147 convert_to_handle_as_ascii (void)
149 HGLOBAL htext
= NULL
;
155 ONTRACE (fprintf (stderr
, "convert_to_handle_as_ascii\n"));
157 nbytes
= SBYTES (current_text
) + 1;
158 src
= SDATA (current_text
);
160 /* We need to add to the size the number of LF chars where we have
161 to insert CR chars (the standard CF_TEXT clipboard format uses
162 CRLF line endings, while Emacs uses just LF internally). */
164 truelen
= nbytes
+ current_num_nls
;
166 if ((htext
= GlobalAlloc (GMEM_MOVEABLE
| GMEM_DDESHARE
, truelen
)) == NULL
)
169 if ((dst
= (unsigned char *) GlobalLock (htext
)) == NULL
)
175 /* convert to CRLF line endings expected by clipboard */
179 /* copy next line or remaining bytes including '\0' */
180 next
= _memccpy (dst
, src
, '\n', nbytes
);
183 /* copied one line ending with '\n' */
184 int copied
= next
- dst
;
187 /* insert '\r' before '\n' */
193 /* copied remaining partial line -> now finished */
197 GlobalUnlock (htext
);
202 /* This function assumes that there are multibyte or NUL characters in
203 current_text, or that we need to construct Unicode. It runs the
204 text through the encoding machinery. */
207 convert_to_handle_as_coded (Lisp_Object coding_system
)
210 unsigned char *dst
= NULL
;
211 struct coding_system coding
;
213 ONTRACE (fprintf (stderr
, "convert_to_handle_as_coded: %s\n",
214 SDATA (SYMBOL_NAME (coding_system
))));
216 setup_windows_coding_system (coding_system
, &coding
);
217 coding
.dst_bytes
= SBYTES (current_text
) * 2;
218 coding
.destination
= xmalloc (coding
.dst_bytes
);
219 encode_coding_object (&coding
, current_text
, 0, 0,
220 SCHARS (current_text
), SBYTES (current_text
), Qnil
);
222 htext
= GlobalAlloc (GMEM_MOVEABLE
| GMEM_DDESHARE
, coding
.produced
+2);
225 dst
= (unsigned char *) GlobalLock (htext
);
229 memcpy (dst
, coding
.destination
, coding
.produced
);
230 /* Add the string terminator. Add two NULs in case we are
231 producing Unicode here. */
232 dst
[coding
.produced
] = dst
[coding
.produced
+1] = '\0';
234 GlobalUnlock (htext
);
237 xfree (coding
.destination
);
243 render (Lisp_Object oformat
)
245 HGLOBAL htext
= NULL
;
246 UINT format
= XFASTINT (oformat
);
248 ONTRACE (fprintf (stderr
, "render\n"));
250 if (NILP (current_text
))
253 if (current_requires_encoding
|| format
== CF_UNICODETEXT
)
255 if (format
== current_clipboard_type
)
256 htext
= convert_to_handle_as_coded (current_coding_system
);
261 htext
= convert_to_handle_as_coded (QUNICODE
);
267 cs
= coding_from_cp (cp_from_locale (current_lcid
, format
));
268 htext
= convert_to_handle_as_coded (cs
);
274 htext
= convert_to_handle_as_ascii ();
276 ONTRACE (fprintf (stderr
, "render: htext = 0x%08X\n", (unsigned) htext
));
281 if (SetClipboardData (format
, htext
) == NULL
)
293 HANDLE hlocale
= NULL
;
296 ONTRACE (fprintf (stderr
, "render_locale\n"));
298 if (current_lcid
== LOCALE_NEUTRAL
|| current_lcid
== DEFAULT_LCID
)
301 hlocale
= GlobalAlloc (GMEM_MOVEABLE
| GMEM_DDESHARE
, sizeof (current_lcid
));
305 if ((lcid_ptr
= (LCID
*) GlobalLock (hlocale
)) == NULL
)
307 GlobalFree (hlocale
);
311 *lcid_ptr
= current_lcid
;
312 GlobalUnlock (hlocale
);
314 if (SetClipboardData (CF_LOCALE
, hlocale
) == NULL
)
316 GlobalFree (hlocale
);
323 /* At the end of the program, we want to ensure that our clipboard
324 data survives us. This code will do that. */
327 render_all (Lisp_Object ignore
)
329 ONTRACE (fprintf (stderr
, "render_all\n"));
331 /* According to the docs we should not call OpenClipboard() here,
332 but testing on W2K and working code in other projects shows that
333 it is actually necessary. */
335 OpenClipboard (NULL
);
337 /* There is no useful means to report errors here, there are none
338 expected anyway, and even if there were errors, they wouldn't do
339 any harm. So we just go ahead and do what has to be done without
340 bothering with error handling. */
342 ++modifying_clipboard
;
344 --modifying_clipboard
;
346 /* For text formats that we don't render here, the OS can use its
347 own translation rules instead, so we don't really need to offer
348 everything. To minimize memory consumption we cover three
349 possible situations based on our primary format as detected from
350 selection-coding-system (see setup_config()):
352 - Post CF_TEXT only. Let the OS convert to CF_OEMTEXT and the OS
353 (on NT) or the application (on 9x/Me) convert to
356 - Post CF_OEMTEXT only. Similar automatic conversions happen as
359 - Post CF_UNICODETEXT + CF_TEXT. 9x itself ignores
360 CF_UNICODETEXT, even though some applications can still handle
363 Note 1: We render the less capable CF_TEXT *before* the more
364 capable CF_UNICODETEXT, to prevent clobbering through automatic
365 conversions, just in case.
367 Note 2: We could check os_subtype here and only render the
368 additional CF_TEXT on 9x/Me. But OTOH with
369 current_clipboard_type == CF_UNICODETEXT we don't involve the
370 automatic conversions anywhere else, so to get consistent
371 results, we probably don't want to rely on it here either. */
375 if (current_clipboard_type
== CF_UNICODETEXT
)
376 render (make_number (CF_TEXT
));
377 render (make_number (current_clipboard_type
));
385 run_protected (Lisp_Object (*code
) (Lisp_Object
), Lisp_Object arg
)
387 /* FIXME: This works but it doesn't feel right. Too much fiddling
388 with global variables and calling strange looking functions. Is
389 this really the right way to run Lisp callbacks? */
391 extern int waiting_for_input
; /* from keyboard.c */
396 /* Fsignal calls emacs_abort () if it sees that waiting_for_input is
398 owfi
= waiting_for_input
;
399 waiting_for_input
= 0;
401 internal_condition_case_1 (code
, arg
, Qt
, lisp_error_handler
);
403 waiting_for_input
= owfi
;
409 lisp_error_handler (Lisp_Object error
)
411 Vsignaling_function
= Qnil
;
412 cmd_error_internal (error
, "Error in delayed clipboard rendering: ");
418 static LRESULT CALLBACK
419 owner_callback (HWND win
, UINT msg
, WPARAM wp
, LPARAM lp
)
423 case WM_RENDERFORMAT
:
424 ONTRACE (fprintf (stderr
, "WM_RENDERFORMAT\n"));
425 run_protected (render
, make_number (wp
));
428 case WM_RENDERALLFORMATS
:
429 ONTRACE (fprintf (stderr
, "WM_RENDERALLFORMATS\n"));
430 run_protected (render_all
, Qnil
);
433 case WM_DESTROYCLIPBOARD
:
434 if (!modifying_clipboard
)
436 ONTRACE (fprintf (stderr
, "WM_DESTROYCLIPBOARD (other)\n"));
438 current_coding_system
= Qnil
;
442 ONTRACE (fprintf (stderr
, "WM_DESTROYCLIPBOARD (self)\n"));
447 if (win
== clipboard_owner
)
448 clipboard_owner
= NULL
;
452 return DefWindowProc (win
, msg
, wp
, lp
);
458 static const char CLASSNAME
[] = "Emacs Clipboard";
461 memset (&wc
, 0, sizeof (wc
));
462 wc
.lpszClassName
= CLASSNAME
;
463 wc
.lpfnWndProc
= owner_callback
;
466 return CreateWindow (CLASSNAME
, CLASSNAME
, 0, 0, 0, 0, 0, NULL
, NULL
,
470 /* Called on exit by term_ntproc() in w32.c */
473 term_w32select (void)
475 /* This is needed to trigger WM_RENDERALLFORMATS. */
476 if (clipboard_owner
!= NULL
)
478 DestroyWindow (clipboard_owner
);
479 clipboard_owner
= NULL
;
486 const char *coding_name
;
490 Lisp_Object coding_system
;
491 Lisp_Object dos_coding_system
;
493 CHECK_SYMBOL (Vselection_coding_system
);
495 coding_system
= NILP (Vnext_selection_coding_system
) ?
496 Vselection_coding_system
: Vnext_selection_coding_system
;
498 dos_coding_system
= validate_coding_system (coding_system
);
499 if (NILP (dos_coding_system
))
501 list2 (build_string ("Coding system is invalid or doesn't have "
502 "an eol variant for dos line ends"),
505 /* Check if we have it cached */
506 if (!NILP (cfg_coding_system
)
507 && EQ (cfg_coding_system
, dos_coding_system
))
509 cfg_coding_system
= dos_coding_system
;
511 /* Set some sensible fallbacks */
512 cfg_codepage
= ANSICP
;
513 cfg_lcid
= LOCALE_NEUTRAL
;
514 cfg_clipboard_type
= CF_TEXT
;
516 /* Interpret the coding system symbol name */
517 coding_name
= SDATA (SYMBOL_NAME (cfg_coding_system
));
519 /* "(.*-)?utf-16.*" -> CF_UNICODETEXT */
520 cp
= strstr (coding_name
, "utf-16");
521 if (cp
!= NULL
&& (cp
== coding_name
|| cp
[-1] == '-'))
523 cfg_clipboard_type
= CF_UNICODETEXT
;
527 /* "cp[0-9]+.*" or "windows-[0-9]+.*" -> CF_TEXT or CF_OEMTEXT */
528 slen
= strlen (coding_name
);
529 if (slen
>= 4 && coding_name
[0] == 'c' && coding_name
[1] == 'p')
530 cp
= coding_name
+ 2;
531 else if (slen
>= 10 && memcmp (coding_name
, "windows-", 8) == 0)
532 cp
= coding_name
+ 8;
537 cfg_codepage
= strtol (cp
, &end
, 10);
539 /* Error return from strtol() or number of digits < 2 -> Restore the
540 default and drop it. */
541 if (cfg_codepage
== 0 || (end
-cp
) < 2 )
543 cfg_codepage
= ANSICP
;
547 /* Is it the currently active system default? */
548 if (cfg_codepage
== ANSICP
)
550 /* cfg_clipboard_type = CF_TEXT; */
553 if (cfg_codepage
== OEMCP
)
555 cfg_clipboard_type
= CF_OEMTEXT
;
559 /* Else determine a suitable locale the hard way. */
560 EnumSystemLocales (enum_locale_callback
, LCID_INSTALLED
);
564 enum_locale_callback (/*const*/ char* loc_string
)
569 lcid
= strtoul (loc_string
, NULL
, 16);
571 /* Is the wanted codepage the "ANSI" codepage for this locale? */
572 codepage
= cp_from_locale (lcid
, CF_TEXT
);
573 if (codepage
== cfg_codepage
)
576 cfg_clipboard_type
= CF_TEXT
;
577 return FALSE
; /* Stop enumeration */
580 /* Is the wanted codepage the OEM codepage for this locale? */
581 codepage
= cp_from_locale (lcid
, CF_OEMTEXT
);
582 if (codepage
== cfg_codepage
)
585 cfg_clipboard_type
= CF_OEMTEXT
;
586 return FALSE
; /* Stop enumeration */
589 return TRUE
; /* Continue enumeration */
593 cp_from_locale (LCID lcid
, UINT format
)
595 char buffer
[20] = "";
599 format
== CF_TEXT
? LOCALE_IDEFAULTANSICODEPAGE
: LOCALE_IDEFAULTCODEPAGE
;
601 GetLocaleInfo (lcid
, variant
, buffer
, sizeof (buffer
));
602 cp
= strtoul (buffer
, NULL
, 10);
606 else if (cp
== CP_OEMCP
)
613 coding_from_cp (UINT codepage
)
616 sprintf (buffer
, "cp%d-dos", (int) codepage
);
617 return intern (buffer
);
618 /* We don't need to check that this coding system actually exists
619 right here, because that is done later for all coding systems
620 used, regardless of where they originate. */
624 validate_coding_system (Lisp_Object coding_system
)
626 Lisp_Object eol_type
;
628 /* Make sure the input is valid. */
629 if (NILP (Fcoding_system_p (coding_system
)))
632 /* Make sure we use a DOS coding system as mandated by the system
634 eol_type
= Fcoding_system_eol_type (coding_system
);
636 /* Already a DOS coding system? */
637 if (EQ (eol_type
, make_number (1)))
638 return coding_system
;
640 /* Get EOL_TYPE vector of the base of CODING_SYSTEM. */
641 if (!VECTORP (eol_type
))
643 eol_type
= Fcoding_system_eol_type (Fcoding_system_base (coding_system
));
644 if (!VECTORP (eol_type
))
648 return AREF (eol_type
, 1);
652 setup_windows_coding_system (Lisp_Object coding_system
,
653 struct coding_system
* coding
)
655 memset (coding
, 0, sizeof (*coding
));
656 setup_coding_system (coding_system
, coding
);
658 /* Unset CODING_ANNOTATE_COMPOSITION_MASK. Previous code had
659 comments about crashes in encode_coding_iso2022 trying to
660 dereference a null pointer when composition was on. Selection
661 data should not contain any composition sequence on Windows.
663 CODING_ANNOTATION_MASK also includes
664 CODING_ANNOTATE_DIRECTION_MASK and CODING_ANNOTATE_CHARSET_MASK,
665 which both apply to ISO6429 only. We don't know if these really
666 need to be unset on Windows, but it probably doesn't hurt
668 coding
->mode
&= ~CODING_ANNOTATION_MASK
;
669 coding
->mode
|= CODING_MODE_LAST_BLOCK
| CODING_MODE_SAFE_ENCODING
;
674 DEFUN ("w32-set-clipboard-data", Fw32_set_clipboard_data
,
675 Sw32_set_clipboard_data
, 1, 2, 0,
676 doc
: /* This sets the clipboard data to the given text. */)
677 (Lisp_Object string
, Lisp_Object ignored
)
685 /* This parameter used to be the current frame, but we don't use
689 CHECK_STRING (string
);
693 current_text
= string
;
694 current_coding_system
= cfg_coding_system
;
695 current_clipboard_type
= cfg_clipboard_type
;
696 current_lcid
= cfg_lcid
;
698 current_requires_encoding
= 0;
702 /* Check for non-ASCII characters. While we are at it, count the
703 number of LFs, so we know how many CRs we will have to add later
704 (just in the case where we can use our internal ASCII rendering,
705 see code and comment in convert_to_handle_as_ascii() above). */
706 nbytes
= SBYTES (string
);
707 src
= SDATA (string
);
709 for (dst
= src
, end
= src
+nbytes
; dst
< end
; dst
++)
713 else if (*dst
>= 0x80 || *dst
== 0)
715 current_requires_encoding
= 1;
720 if (!current_requires_encoding
)
722 /* If all we have is ASCII we don't need to pretend we offer
724 current_coding_system
= Qraw_text
;
725 current_clipboard_type
= CF_TEXT
;
726 current_lcid
= LOCALE_NEUTRAL
;
729 if (!OpenClipboard (clipboard_owner
))
732 ++modifying_clipboard
;
733 ok
= EmptyClipboard ();
734 --modifying_clipboard
;
736 /* If we have something non-ASCII we may want to set a locale. We
737 do that directly (non-delayed), as it's just a small bit. */
739 ok
= !NILP (render_locale ());
743 if (clipboard_owner
== NULL
)
745 /* If for some reason we don't have a clipboard_owner, we
746 just set the text format as chosen by the configuration
747 and than forget about the whole thing. */
748 ok
= !NILP (render (make_number (current_clipboard_type
)));
750 current_coding_system
= Qnil
;
754 /* Advertise all supported formats so that whatever the
755 requestor chooses, only one encoding step needs to be
756 made. This is intentionally different from what we do in
757 the handler for WM_RENDERALLFORMATS. */
758 SetClipboardData (CF_UNICODETEXT
, NULL
);
759 SetClipboardData (CF_TEXT
, NULL
);
760 SetClipboardData (CF_OEMTEXT
, NULL
);
766 /* With delayed rendering we haven't really "used" this coding
767 system yet, and it's even unclear if we ever will. But this is a
768 way to tell the upper level what we *would* use under ideal
771 We don't signal the actually used coding-system later when we
772 finally render, because that can happen at any time and we don't
773 want to disturb the "foreground" action. */
775 Vlast_coding_system_used
= current_coding_system
;
777 Vnext_selection_coding_system
= Qnil
;
785 current_coding_system
= Qnil
;
790 return (ok
? string
: Qnil
);
794 DEFUN ("w32-get-clipboard-data", Fw32_get_clipboard_data
,
795 Sw32_get_clipboard_data
, 0, 1, 0,
796 doc
: /* This gets the clipboard data in text format. */)
797 (Lisp_Object ignored
)
800 Lisp_Object ret
= Qnil
;
801 UINT actual_clipboard_type
;
802 int use_configured_coding_system
= 1;
804 /* This parameter used to be the current frame, but we don't use
808 /* Don't pass our own text from the clipboard (which might be
809 troublesome if the killed text includes null characters). */
810 if (!NILP (current_text
))
814 actual_clipboard_type
= cfg_clipboard_type
;
818 if (!OpenClipboard (clipboard_owner
))
821 if ((htext
= GetClipboardData (actual_clipboard_type
)) == NULL
)
823 /* If we want CF_UNICODETEXT but can't get it, the current
824 coding system is useless. OTOH we can still try and decode
825 CF_TEXT based on the locale that the system gives us and that
826 we get down below. */
827 if (actual_clipboard_type
== CF_UNICODETEXT
)
829 htext
= GetClipboardData (CF_TEXT
);
832 actual_clipboard_type
= CF_TEXT
;
833 use_configured_coding_system
= 0;
845 int require_decoding
= 0;
847 if ((src
= (unsigned char *) GlobalLock (htext
)) == NULL
)
850 /* If the clipboard data contains any non-ascii code, we need to
851 decode it with a coding system. */
852 if (actual_clipboard_type
== CF_UNICODETEXT
)
854 nbytes
= lstrlenW ((WCHAR
*)src
) * 2;
855 require_decoding
= 1;
861 nbytes
= strlen (src
);
863 for (i
= 0; i
< nbytes
; i
++)
867 require_decoding
= 1;
873 if (require_decoding
)
875 struct coding_system coding
;
876 Lisp_Object coding_system
= Qnil
;
877 Lisp_Object dos_coding_system
;
879 /* `next-selection-coding-system' should override everything,
880 even when the locale passed by the system disagrees. The
881 only exception is when `next-selection-coding-system'
882 requested CF_UNICODETEXT and we couldn't get that. */
883 if (use_configured_coding_system
884 && !NILP (Vnext_selection_coding_system
))
885 coding_system
= Vnext_selection_coding_system
;
887 /* If we have CF_TEXT or CF_OEMTEXT, we want to check out
889 else if (actual_clipboard_type
!= CF_UNICODETEXT
)
892 LCID lcid
= DEFAULT_LCID
;
895 /* Documentation says that the OS always generates
896 CF_LOCALE info automatically, so the locale handle
897 should always be present. Fact is that this is not
898 always true on 9x ;-(. */
899 hlocale
= GetClipboardData (CF_LOCALE
);
902 const LCID
* lcid_ptr
;
903 lcid_ptr
= (const LCID
*) GlobalLock (hlocale
);
904 if (lcid_ptr
!= NULL
)
907 GlobalUnlock (hlocale
);
910 /* 9x has garbage as the sort order (to be exact there
911 is another instance of the language id in the upper
912 word). We don't care about sort order anyway, so
913 we just filter out the unneeded mis-information to
914 avoid irritations. */
915 lcid
= MAKELCID (LANGIDFROMLCID (lcid
), SORT_DEFAULT
);
918 /* If we are using fallback from CF_UNICODETEXT, we can't
919 use the configured coding system. Also we don't want
920 to use it, if the system has supplied us with a locale
921 and it is not just the system default. */
922 if (!use_configured_coding_system
|| lcid
!= DEFAULT_LCID
)
924 cp
= cp_from_locale (lcid
, actual_clipboard_type
);
925 /* If it's just our current standard setting anyway,
926 use the coding system that the user has selected.
927 Otherwise create a new spec to match the locale
928 that was specified by the other side or the
930 if (!use_configured_coding_system
|| cp
!= cfg_codepage
)
931 coding_system
= coding_from_cp (cp
);
935 if (NILP (coding_system
))
936 coding_system
= Vselection_coding_system
;
937 Vnext_selection_coding_system
= Qnil
;
939 dos_coding_system
= validate_coding_system (coding_system
);
940 if (!NILP (dos_coding_system
))
942 setup_windows_coding_system (dos_coding_system
, &coding
);
944 decode_coding_object (&coding
, Qnil
, 0, 0, nbytes
, nbytes
, Qt
);
945 ret
= coding
.dst_object
;
947 Vlast_coding_system_used
= CODING_ID_NAME (coding
.id
);
952 /* FIXME: We may want to repeat the code in this branch for
955 /* Need to know final size after CR chars are removed because
956 we can't change the string size manually, and doing an
957 extra copy is silly. We only remove CR when it appears as
962 /* avoid using strchr because it recomputes the length everytime */
963 while ((dst
= memchr (dst
, '\r', nbytes
- (dst
- src
))) != NULL
)
965 if (dst
[1] == '\n') /* safe because of trailing '\0' */
970 ret
= make_uninit_string (truelen
);
972 /* Convert CRLF line endings (the standard CF_TEXT clipboard
973 format) to LF endings as used internally by Emacs. */
979 /* copy next line or remaining bytes excluding '\0' */
980 next
= _memccpy (dst
, src
, '\r', nbytes
);
983 /* copied one line ending with '\r' */
984 int copied
= next
- dst
;
989 dst
--; /* overwrite '\r' with '\n' */
992 /* copied remaining partial line -> now finished */
996 Vlast_coding_system_used
= Qraw_text
;
999 GlobalUnlock (htext
);
1011 /* Support checking for a clipboard selection. */
1013 DEFUN ("x-selection-exists-p", Fx_selection_exists_p
, Sx_selection_exists_p
,
1015 doc
: /* Whether there is an owner for the given X selection.
1016 SELECTION should be the name of the selection in question, typically
1017 one of the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'. (X expects
1018 these literal upper-case names.) The symbol nil is the same as
1019 `PRIMARY', and t is the same as `SECONDARY'.
1021 TERMINAL should be a terminal object or a frame specifying the X
1022 server to query. If omitted or nil, that stands for the selected
1023 frame's display, or the first available X display. */)
1024 (Lisp_Object selection
, Lisp_Object terminal
)
1026 CHECK_SYMBOL (selection
);
1028 /* Return nil for PRIMARY and SECONDARY selections; for CLIPBOARD, check
1029 if the clipboard currently has valid text format contents. */
1031 if (EQ (selection
, QCLIPBOARD
))
1033 Lisp_Object val
= Qnil
;
1037 if (OpenClipboard (NULL
))
1040 while ((format
= EnumClipboardFormats (format
)))
1041 /* Check CF_TEXT in addition to cfg_clipboard_type,
1042 because we can fall back on that if CF_UNICODETEXT is
1043 not available. Actually a check for CF_TEXT only
1044 should be enough. */
1045 if (format
== cfg_clipboard_type
|| format
== CF_TEXT
)
1057 /* One-time init. Called in the un-dumped Emacs, but not in the
1061 syms_of_w32select (void)
1063 defsubr (&Sw32_set_clipboard_data
);
1064 defsubr (&Sw32_get_clipboard_data
);
1065 defsubr (&Sx_selection_exists_p
);
1067 DEFVAR_LISP ("selection-coding-system", Vselection_coding_system
,
1068 doc
: /* Coding system for communicating with other programs.
1070 For MS-Windows and MS-DOS:
1071 When sending or receiving text via selection and clipboard, the text
1072 is encoded or decoded by this coding system. The default value is
1073 the current system default encoding on 9x/Me, `utf-16le-dos'
1074 \(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.
1077 When sending text via selection and clipboard, if the target
1078 data-type matches with the type of this coding system, it is used
1079 for encoding the text. Otherwise (including the case that this
1080 variable is nil), a proper coding system is used as below:
1082 data-type coding system
1083 --------- -------------
1085 COMPOUND_TEXT compound-text-with-extensions
1087 C_STRING no-conversion
1089 When receiving text, if this coding system is non-nil, it is used
1090 for decoding regardless of the data-type. If this is nil, a
1091 proper coding system is used according to the data-type as above.
1093 See also the documentation of the variable `x-select-request-type' how
1094 to control which data-type to request for receiving text.
1096 The default value is nil. */);
1097 /* The actual value is set dynamically in the dumped Emacs, see
1099 Vselection_coding_system
= Qnil
;
1101 DEFVAR_LISP ("next-selection-coding-system", Vnext_selection_coding_system
,
1102 doc
: /* Coding system for the next communication with other programs.
1103 Usually, `selection-coding-system' is used for communicating with
1104 other programs (X Windows clients or MS Windows programs). But, if this
1105 variable is set, it is used for the next communication only.
1106 After the communication, this variable is set to nil. */);
1107 Vnext_selection_coding_system
= Qnil
;
1109 DEFSYM (QCLIPBOARD
, "CLIPBOARD");
1111 cfg_coding_system
= Qnil
; staticpro (&cfg_coding_system
);
1112 current_text
= Qnil
; staticpro (¤t_text
);
1113 current_coding_system
= Qnil
; staticpro (¤t_coding_system
);
1115 DEFSYM (QUNICODE
, "utf-16le-dos");
1116 QANSICP
= Qnil
; staticpro (&QANSICP
);
1117 QOEMCP
= Qnil
; staticpro (&QOEMCP
);
1120 /* One-time init. Called in the dumped Emacs, but not in the
1121 un-dumped version. */
1124 globals_of_w32select (void)
1126 DEFAULT_LCID
= GetUserDefaultLCID ();
1127 /* Drop the sort order from the LCID, so we can compare this with
1128 CF_LOCALE objects that have the same fix on 9x. */
1129 DEFAULT_LCID
= MAKELCID (LANGIDFROMLCID (DEFAULT_LCID
), SORT_DEFAULT
);
1132 OEMCP
= GetOEMCP ();
1134 QANSICP
= coding_from_cp (ANSICP
);
1135 QOEMCP
= coding_from_cp (OEMCP
);
1137 if (os_subtype
== OS_NT
)
1138 Vselection_coding_system
= QUNICODE
;
1139 else if (inhibit_window_system
)
1140 Vselection_coding_system
= QOEMCP
;
1142 Vselection_coding_system
= QANSICP
;
1144 clipboard_owner
= create_owner ();