1 /* 16-bit Windows Selection processing for emacs on MS-Windows
2 Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010, 2011 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 /* These functions work by using WinOldAp interface. WinOldAp
21 (WINOLDAP.MOD) is a Microsoft Windows extension supporting
22 "old" (character-mode) application access to Dynamic Data Exchange,
23 menus, and the Windows clipboard. */
25 /* Written by Dale P. Smith <dpsm@en.com> */
26 /* Adapted to DJGPP v1 by Eli Zaretskii <eliz@is.elta.co.il> */
34 #include <sys/farptr.h>
37 #include "dispextern.h" /* frame.h seems to want this */
38 #include "frame.h" /* Need this to get the X window of selected_frame */
39 #include "blockinput.h"
41 #include "character.h"
43 #include "composite.h"
45 /* If ever some function outside this file will need to call any
46 clipboard-related function, the following prototypes and constants
47 should be put on a header file. Right now, nobody else uses them. */
50 #define CF_BITMAP 0x02
51 #define CF_METAFILE 0x03
55 #define CF_OEMTEXT 0x07
56 #define CF_DIBBITMAP 0x08
57 #define CF_WINWRITE 0x80
58 #define CF_DSPTEXT 0x81
59 #define CF_DSPBITMAP 0x82
61 unsigned identify_winoldap_version (void);
62 unsigned open_clipboard (void);
63 unsigned empty_clipboard (void);
64 unsigned set_clipboard_data (unsigned, void *, unsigned, int);
65 unsigned get_clipboard_data_size (unsigned);
66 unsigned get_clipboard_data (unsigned, void *, unsigned, int);
67 unsigned close_clipboard (void);
68 unsigned clipboard_compact (unsigned);
70 Lisp_Object QCLIPBOARD
, QPRIMARY
;
72 /* Coding system for communicating with other Windows programs via the
74 static Lisp_Object Vselection_coding_system
;
76 /* Coding system for the next communicating with other Windows programs. */
77 static Lisp_Object Vnext_selection_coding_system
;
79 /* The segment address and the size of the buffer in low
80 memory used to move data between us and WinOldAp module. */
83 unsigned short rm_segment
;
84 } clipboard_xfer_buf_info
;
86 /* The last text we put into the clipboard. This is used to prevent
87 passing back our own text from the clipboard, instead of using the
88 kill ring. The former is undesirable because the clipboard data
89 could be MULEtilated by inappropriately chosen
90 (next-)selection-coding-system. For this reason, we must store the
91 text *after* it was encoded/Unix-to-DOS-converted. */
92 static unsigned char *last_clipboard_text
;
94 /* The size of allocated storage for storing the clipboard data. */
95 static size_t clipboard_storage_size
;
97 /* Emulation of `__dpmi_int' and friends for DJGPP v1.x */
101 typedef _go32_dpmi_registers __dpmi_regs
;
102 #define __tb _go32_info_block.linear_address_of_transfer_buffer
103 #define _dos_ds _go32_info_block.selector_for_linear_memory
106 __dpmi_int (intno
, regs
)
110 regs
->x
.ss
= regs
->x
.sp
= regs
->x
.flags
= 0;
111 return _go32_dpmi_simulate_int (intno
, regs
);
114 #endif /* __DJGPP__ < 2 */
116 /* C functions to access the Windows 3.1x clipboard from DOS apps.
118 The information was obtained from the Microsoft Knowledge Base,
119 article Q67675 and can be found at:
120 http://www.microsoft.com/kb/developr/win_dk/q67675.htm */
122 /* See also Ralf Brown's Interrupt List.
124 I also seem to remember reading about this in Dr. Dobbs Journal a
125 while ago, but if you knew my memory... :-)
127 Dale P. Smith <dpsm@en.com> */
129 /* Return the WinOldAp support version, or 0x1700 if not supported. */
131 identify_winoldap_version ()
135 /* Calls Int 2Fh/AX=1700h
136 Return Values AX == 1700H: Clipboard functions not available
137 <> 1700H: AL = Major version number
138 AH = Minor version number */
140 __dpmi_int(0x2f, ®s
);
144 /* Open the clipboard, return non-zero if successfull. */
150 /* Is WINOLDAP supported? */
151 /* Kludge alert!! If WinOldAp is not supported, we return a 0,
152 which is the same as ``Clipboard already open''. Currently,
153 this is taken as an error by all the functions that use
154 `open_clipboard', but if somebody someday will use that ``open''
155 clipboard, they will have interesting time debugging it... */
156 if (identify_winoldap_version () == 0x1700)
159 /* Calls Int 2Fh/AX=1701h
160 Return Values AX == 0: Clipboard already open
161 <> 0: Clipboard opened */
163 __dpmi_int(0x2f, ®s
);
167 /* Empty clipboard, return non-zero if successfull. */
173 /* Calls Int 2Fh/AX=1702h
174 Return Values AX == 0: Error occurred
175 <> 0: OK, Clipboard emptied */
177 __dpmi_int(0x2f, ®s
);
181 /* Ensure we have a buffer in low memory with enough memory for data
182 of size WANT_SIZE. Return the linear address of the buffer. */
184 alloc_xfer_buf (want_size
)
189 /* If the usual DJGPP transfer buffer is large enough, use that. */
190 if (want_size
<= _go32_info_block
.size_of_transfer_buffer
)
191 return __tb
& 0xfffff;
193 /* Don't even try to allocate more than 1MB of memory: DOS cannot
194 possibly handle that (it will overflow the BX register below). */
195 if (want_size
> 0xfffff)
198 /* Need size rounded up to the nearest paragraph, and in
199 paragraph units (1 paragraph = 16 bytes). */
200 clipboard_xfer_buf_info
.size
= (want_size
+ 15) >> 4;
202 /* The NT DPMI host crashes us if we free DOS memory via the
203 DPMI service. Work around by calling DOS allocate/free block. */
205 regs
.x
.bx
= clipboard_xfer_buf_info
.size
;
206 __dpmi_int (0x21, ®s
);
207 if (regs
.x
.flags
& 1)
209 clipboard_xfer_buf_info
.size
= 0;
213 clipboard_xfer_buf_info
.rm_segment
= regs
.x
.ax
;
214 return (((int)clipboard_xfer_buf_info
.rm_segment
) << 4) & 0xfffff;
217 /* Free our clipboard buffer. We always free it after use, because
218 keeping it leaves less free conventional memory for subprocesses.
219 The clipboard buffer tends to be large in size, because for small
220 clipboard data sizes we use the DJGPP transfer buffer. */
224 /* If the size is 0, we used DJGPP transfer buffer, so don't free. */
225 if (clipboard_xfer_buf_info
.size
)
229 /* The NT DPMI host crashes us if we free DOS memory via
230 the DPMI service. Work around by calling DOS free block. */
232 regs
.x
.es
= clipboard_xfer_buf_info
.rm_segment
;
233 __dpmi_int (0x21, ®s
);
234 clipboard_xfer_buf_info
.size
= 0;
238 /* Copy data into the clipboard, return zero if successfull. */
240 set_clipboard_data (Format
, Data
, Size
, Raw
)
248 unsigned long xbuf_addr
, buf_offset
;
249 unsigned char *dp
= Data
, *dstart
= dp
;
251 if (Format
!= CF_OEMTEXT
)
254 /* need to know final size after '\r' chars are inserted (the
255 standard CF_OEMTEXT clipboard format uses CRLF line endings,
256 while Emacs uses just LF internally). */
257 truelen
= Size
+ 1; /* +1 for the terminating null */
261 /* avoid using strchr because it recomputes the length everytime */
262 while ((dp
= memchr (dp
, '\n', Size
- (dp
- dstart
))) != 0)
269 if (clipboard_compact (truelen
) < truelen
)
272 if ((xbuf_addr
= alloc_xfer_buf (truelen
)) == 0)
275 /* Move the buffer into the low memory, convert LF into CR-LF if needed. */
278 dosmemput (Data
, Size
, xbuf_addr
);
280 /* Terminate with a null, otherwise Windows does strange things
281 when the text size is an integral multiple of 32 bytes. */
282 _farpokeb (_dos_ds
, xbuf_addr
+ Size
, '\0');
287 buf_offset
= xbuf_addr
;
288 _farsetsel (_dos_ds
);
291 /* Don't allow them to put binary data into the clipboard, since
292 it will cause yanked data to be truncated at the first null. */
296 _farnspokeb (buf_offset
++, '\r');
297 _farnspokeb (buf_offset
++, *dp
++);
300 /* Terminate with a null, otherwise Windows does strange things
301 when the text size is an integral multiple of 32 bytes. */
302 _farnspokeb (buf_offset
, '\0');
305 /* Stash away the data we are about to put into the clipboard, so we
306 could later check inside get_clipboard_data whether the clipboard
307 still holds our data. */
308 if (clipboard_storage_size
< truelen
)
310 clipboard_storage_size
= truelen
+ 100;
311 last_clipboard_text
=
312 (char *) xrealloc (last_clipboard_text
, clipboard_storage_size
);
314 if (last_clipboard_text
)
315 dosmemget (xbuf_addr
, truelen
, last_clipboard_text
);
317 /* Calls Int 2Fh/AX=1703h with:
318 DX = WinOldAp-Supported Clipboard format
319 ES:BX = Pointer to data
320 SI:CX = Size of data in bytes
321 Return Values AX == 0: Error occurred
322 <> 0: OK. Data copied into the Clipboard. */
325 regs
.x
.si
= truelen
>> 16;
326 regs
.x
.cx
= truelen
& 0xffff;
327 regs
.x
.es
= xbuf_addr
>> 4;
328 regs
.x
.bx
= xbuf_addr
& 15;
329 __dpmi_int(0x2f, ®s
);
333 /* If the above failed, invalidate the local copy of the clipboard. */
335 *last_clipboard_text
= '\0';
337 /* Zero means success, otherwise (1, 2, or 3) it's an error. */
338 return regs
.x
.ax
> 0 ? 0 : 3;
341 /* Return the size of the clipboard data of format FORMAT. */
343 get_clipboard_data_size (Format
)
348 /* Calls Int 2Fh/AX=1704h with:
349 DX = WinOldAp-Supported Clipboard format
350 Return Values DX:AX == Size of the data in bytes, including any
352 == 0 If data in this format is not in
356 __dpmi_int(0x2f, ®s
);
357 return ( (((unsigned)regs
.x
.dx
) << 16) | regs
.x
.ax
);
360 /* Get clipboard data, return its length.
361 Warning: this doesn't check whether DATA has enough space to hold
364 get_clipboard_data (Format
, Data
, Size
, Raw
)
371 unsigned long xbuf_addr
;
372 unsigned char *dp
= Data
;
374 if (Format
!= CF_OEMTEXT
)
380 if ((xbuf_addr
= alloc_xfer_buf (Size
)) == 0)
383 /* Calls Int 2Fh/AX=1705h with:
384 DX = WinOldAp-Supported Clipboard format
385 ES:BX = Pointer to data buffer to hold data
386 Return Values AX == 0: Error occurred (or data in this format is not
391 regs
.x
.es
= xbuf_addr
>> 4;
392 regs
.x
.bx
= xbuf_addr
& 15;
393 __dpmi_int(0x2f, ®s
);
396 unsigned char null_char
= '\0';
397 unsigned long xbuf_beg
= xbuf_addr
;
399 /* If last_clipboard_text is NULL, we don't want to slow down
400 the next loop by an additional test. */
401 register unsigned char *lcdp
=
402 last_clipboard_text
== NULL
? &null_char
: last_clipboard_text
;
404 /* Copy data from low memory, remove CR
405 characters before LF if needed. */
406 _farsetsel (_dos_ds
);
409 register unsigned char c
= _farnspeekb (xbuf_addr
++);
414 if ((*dp
++ = c
) == '\r' && !Raw
&& _farnspeekb (xbuf_addr
) == '\n')
422 /* Windows reportedly rounds up the size of clipboard data
423 (passed in SIZE) to a multiple of 32, and removes trailing
424 spaces from each line without updating SIZE. We therefore
425 bail out when we see the first null character. */
430 /* If the text in clipboard is identical to what we put there
431 last time set_clipboard_data was called, pretend there's no
432 data in the clipboard. This is so we don't pass our own text
433 from the clipboard (which might be troublesome if the killed
434 text includes null characters). */
435 if (last_clipboard_text
&&
436 xbuf_addr
- xbuf_beg
== (long)(lcdp
- last_clipboard_text
))
437 dp
= (unsigned char *)Data
+ 1;
442 return (unsigned) (dp
- (unsigned char *)Data
- 1);
445 /* Close clipboard, return non-zero if successfull. */
451 /* Calls Int 2Fh/AX=1708h
452 Return Values AX == 0: Error occurred
455 __dpmi_int(0x2f, ®s
);
459 /* Compact clipboard data so that at least SIZE bytes is available. */
461 clipboard_compact (Size
)
466 /* Calls Int 2Fh/AX=1709H with:
467 SI:CX = Desired memory size in bytes.
468 Return Values DX:AX == Number of bytes of largest block of free memory.
469 == 0 if error or no memory */
471 regs
.x
.si
= Size
>> 16;
472 regs
.x
.cx
= Size
& 0xffff;
473 __dpmi_int(0x2f, ®s
);
474 return ((unsigned)regs
.x
.dx
<< 16) | regs
.x
.ax
;
477 static char no_mem_msg
[] =
478 "(Not enough DOS memory to put saved text into clipboard.)";
479 static char binary_msg
[] =
480 "(Binary characters in saved text; clipboard data not set.)";
481 static char system_error_msg
[] =
482 "(Clipboard interface failure; clipboard data not set.)";
484 DEFUN ("w16-set-clipboard-data", Fw16_set_clipboard_data
, Sw16_set_clipboard_data
, 1, 2, 0,
485 doc
: /* This sets the clipboard data to the given text. */)
487 Lisp_Object string
, frame
;
489 unsigned ok
= 1, put_status
= 0;
490 int nbytes
, charset_info
, no_crlf_conversion
;
491 unsigned char *src
, *dst
= NULL
;
493 CHECK_STRING (string
);
496 frame
= Fselected_frame ();
498 CHECK_LIVE_FRAME (frame
);
499 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
504 if (!open_clipboard ())
507 nbytes
= SBYTES (string
);
508 src
= SDATA (string
);
510 /* Do we need to encode this text? */
511 for (dst
= src
; dst
< src
+ nbytes
; dst
++)
513 if (*dst
== '\0' || *dst
>= 0x80)
516 if (dst
>= src
+ nbytes
)
518 /* No multibyte characters in text. We need not encode it, but we
519 will have to convert it to DOS CR-LF style. */
520 no_crlf_conversion
= 0;
521 Vlast_coding_system_used
= Qraw_text
;
522 dst
= NULL
; /* so we don't try to free a random pointer */
526 /* We must encode contents of STRING according to what
527 clipboard-coding-system specifies. */
529 struct coding_system coding
;
530 unsigned char *htext2
;
531 Lisp_Object coding_system
=
532 NILP (Vnext_selection_coding_system
) ?
533 Vselection_coding_system
: Vnext_selection_coding_system
;
535 setup_coding_system (Fcheck_coding_system (coding_system
), &coding
);
536 coding
.dst_bytes
= nbytes
* 4;
537 coding
.destination
= (unsigned char *) xmalloc (coding
.dst_bytes
);
538 Vnext_selection_coding_system
= Qnil
;
539 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
540 dst
= coding
.destination
;
541 encode_coding_object (&coding
, string
, 0, 0,
542 SCHARS (string
), nbytes
, Qnil
);
543 no_crlf_conversion
= 1;
544 nbytes
= coding
.produced
;
545 Vlast_coding_system_used
= CODING_ID_NAME (coding
.id
);
549 ok
= empty_clipboard ()
551 = set_clipboard_data (CF_OEMTEXT
, src
, nbytes
, no_crlf_conversion
))
554 if (!no_crlf_conversion
)
557 if (ok
) goto unblock
;
567 /* Notify user if the text is too large to fit into DOS memory.
568 (This will happen somewhere after 600K bytes (470K in DJGPP v1.x),
569 depending on user system configuration.) If we just silently
570 fail the function, people might wonder why their text sometimes
571 doesn't make it to the clipboard. */
577 message2 (no_mem_msg
, sizeof (no_mem_msg
) - 1, 0);
580 message2 (binary_msg
, sizeof (binary_msg
) - 1, 0);
583 message2 (system_error_msg
, sizeof (system_error_msg
) - 1, 0);
586 sit_for (make_number (2), 0, 2);
591 return (ok
&& put_status
== 0 ? string
: Qnil
);
594 DEFUN ("w16-get-clipboard-data", Fw16_get_clipboard_data
, Sw16_get_clipboard_data
, 0, 1, 0,
595 doc
: /* This gets the clipboard data in text format. */)
599 unsigned data_size
, truelen
;
600 unsigned char *htext
= NULL
;
601 Lisp_Object ret
= Qnil
;
602 int no_crlf_conversion
, require_decoding
= 0;
605 frame
= Fselected_frame ();
607 CHECK_LIVE_FRAME (frame
);
608 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
613 if (!open_clipboard ())
616 if ((data_size
= get_clipboard_data_size (CF_OEMTEXT
)) == 0 ||
617 (htext
= (unsigned char *)xmalloc (data_size
)) == 0)
620 /* need to know final size after '\r' chars are removed because
621 we can't change the string size manually, and doing an extra
623 if ((truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 0)) == 0)
626 /* Do we need to decode it? */
628 /* If the clipboard data contains any 8-bit Latin-1 code, we
629 need to decode it. */
632 for (i
= 0; i
< truelen
; i
++)
634 if (htext
[i
] >= 0x80)
636 require_decoding
= 1;
641 if (require_decoding
)
645 struct coding_system coding
;
646 Lisp_Object coding_system
= Vnext_selection_coding_system
;
648 truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 1);
649 if (NILP (coding_system
))
650 coding_system
= Vselection_coding_system
;
651 setup_coding_system (Fcheck_coding_system (coding_system
), &coding
);
652 coding
.source
= htext
;
653 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
654 /* We explicitly disable composition handling because selection
655 data should not contain any composition sequence. */
656 coding
.mode
&= CODING_ANNOTATION_MASK
;
657 decode_coding_object (&coding
, Qnil
, 0, 0, truelen
, truelen
, Qt
);
658 ret
= coding
.dst_object
;
659 Vlast_coding_system_used
= CODING_ID_NAME (coding
.id
);
663 ret
= make_unibyte_string ((char *) htext
, truelen
);
664 Vlast_coding_system_used
= Qraw_text
;
668 Vnext_selection_coding_system
= Qnil
;
681 /* Support checking for a clipboard selection. */
683 DEFUN ("x-selection-exists-p", Fx_selection_exists_p
, Sx_selection_exists_p
,
685 doc
: /* Whether there is an owner for the given X Selection.
686 The arg should be the name of the selection in question, typically one of
687 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
688 \(Those are literal upper-case symbol names, since that's what X expects.)
689 For convenience, the symbol nil is the same as `PRIMARY',
690 and t is the same as `SECONDARY'. */)
692 Lisp_Object selection
;
694 CHECK_SYMBOL (selection
);
696 /* Return nil for SECONDARY selection. For PRIMARY (or nil)
697 selection, check if there is some text on the kill-ring;
698 for CLIPBOARD, check if the clipboard currently has valid
699 text format contents.
701 The test for killed text on the kill-ring emulates the Emacs
702 behavior on X, where killed text is also put into X selection
703 by the X interface code. (On MSDOS, killed text is only put
704 into the clipboard if we run under Windows, so we cannot check
705 the clipboard alone.) */
706 if ((EQ (selection
, Qnil
) || EQ (selection
, QPRIMARY
))
707 && ! NILP (SYMBOL_VALUE (Fintern_soft (build_string ("kill-ring"),
711 if (EQ (selection
, QCLIPBOARD
))
713 Lisp_Object val
= Qnil
;
715 if (open_clipboard ())
717 if (get_clipboard_data_size (CF_OEMTEXT
))
727 syms_of_win16select ()
729 defsubr (&Sw16_set_clipboard_data
);
730 defsubr (&Sw16_get_clipboard_data
);
731 defsubr (&Sx_selection_exists_p
);
733 DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system
,
734 doc
: /* Coding system for communicating with other X clients.
735 When sending or receiving text via cut_buffer, selection, and clipboard,
736 the text is encoded or decoded by this coding system.
737 The default value is `iso-latin-1-dos'. */);
738 Vselection_coding_system
= intern ("iso-latin-1-dos");
740 DEFVAR_LISP ("next-selection-coding-system", &Vnext_selection_coding_system
,
741 doc
: /* Coding system for the next communication with other X clients.
742 Usually, `selection-coding-system' is used for communicating with
743 other X clients. But, if this variable is set, it is used for the
744 next communication only. After the communication, this variable is
746 Vnext_selection_coding_system
= Qnil
;
748 QPRIMARY
= intern ("PRIMARY"); staticpro (&QPRIMARY
);
749 QCLIPBOARD
= intern ("CLIPBOARD"); staticpro (&QCLIPBOARD
);
754 /* arch-tag: 085a22c8-7324-436e-a6da-102464ce95d8
755 (do not change this comment) */