1 /* 16-bit Windows Selection processing for emacs on MS-Windows
2 Copyright (C) 1996, 1997, 2001 Free Software Foundation.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* These functions work by using WinOldAp interface. WinOldAp
22 (WINOLDAP.MOD) is a Microsoft Windows extension supporting
23 "old" (character-mode) application access to Dynamic Data Exchange,
24 menus, and the Windows clipboard. */
26 /* Written by Dale P. Smith <dpsm@en.com> */
27 /* Adapted to DJGPP v1 by Eli Zaretskii <eliz@is.elta.co.il> */
35 #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"
44 /* If ever some function outside this file will need to call any
45 clipboard-related function, the following prototypes and constants
46 should be put on a header file. Right now, nobody else uses them. */
49 #define CF_BITMAP 0x02
50 #define CF_METAFILE 0x03
54 #define CF_OEMTEXT 0x07
55 #define CF_DIBBITMAP 0x08
56 #define CF_WINWRITE 0x80
57 #define CF_DSPTEXT 0x81
58 #define CF_DSPBITMAP 0x82
60 unsigned identify_winoldap_version (void);
61 unsigned open_clipboard (void);
62 unsigned empty_clipboard (void);
63 unsigned set_clipboard_data (unsigned, void *, unsigned, int);
64 unsigned get_clipboard_data_size (unsigned);
65 unsigned get_clipboard_data (unsigned, void *, unsigned, int);
66 unsigned close_clipboard (void);
67 unsigned clipboard_compact (unsigned);
69 Lisp_Object QCLIPBOARD
, QPRIMARY
;
71 /* Coding system for communicating with other Windows programs via the
73 static Lisp_Object Vselection_coding_system
;
75 /* Coding system for the next communicating with other Windows programs. */
76 static Lisp_Object Vnext_selection_coding_system
;
78 /* The segment address and the size of the buffer in low
79 memory used to move data between us and WinOldAp module. */
82 unsigned short rm_segment
;
83 } clipboard_xfer_buf_info
;
85 /* The last text we put into the clipboard. This is used to prevent
86 passing back our own text from the clipboard, instead of using the
87 kill ring. The former is undesirable because the clipboard data
88 could be MULEtilated by inappropriately chosen
89 (next-)selection-coding-system. For this reason, we must store the
90 text *after* it was encoded/Unix-to-DOS-converted. */
91 static unsigned char *last_clipboard_text
;
93 /* The size of allocated storage for storing the clipboard data. */
94 static size_t clipboard_storage_size
;
96 /* Emulation of `__dpmi_int' and friends for DJGPP v1.x */
100 typedef _go32_dpmi_registers __dpmi_regs
;
101 #define __tb _go32_info_block.linear_address_of_transfer_buffer
102 #define _dos_ds _go32_info_block.selector_for_linear_memory
105 __dpmi_int (intno
, regs
)
109 regs
->x
.ss
= regs
->x
.sp
= regs
->x
.flags
= 0;
110 return _go32_dpmi_simulate_int (intno
, regs
);
113 #endif /* __DJGPP__ < 2 */
115 /* C functions to access the Windows 3.1x clipboard from DOS apps.
117 The information was obtained from the Microsoft Knowledge Base,
118 article Q67675 and can be found at:
119 http://www.microsoft.com/kb/developr/win_dk/q67675.htm */
121 /* See also Ralf Brown's Interrupt List.
123 I also seem to remember reading about this in Dr. Dobbs Journal a
124 while ago, but if you knew my memory... :-)
126 Dale P. Smith <dpsm@en.com> */
128 /* Return the WinOldAp support version, or 0x1700 if not supported. */
130 identify_winoldap_version ()
134 /* Calls Int 2Fh/AX=1700h
135 Return Values AX == 1700H: Clipboard functions not available
136 <> 1700H: AL = Major version number
137 AH = Minor version number */
139 __dpmi_int(0x2f, ®s
);
143 /* Open the clipboard, return non-zero if successfull. */
149 /* Is WINOLDAP supported? */
150 /* Kludge alert!! If WinOldAp is not supported, we return a 0,
151 which is the same as ``Clipboard already open''. Currently,
152 this is taken as an error by all the functions that use
153 `open_clipboard', but if somebody someday will use that ``open''
154 clipboard, they will have interesting time debugging it... */
155 if (identify_winoldap_version () == 0x1700)
158 /* Calls Int 2Fh/AX=1701h
159 Return Values AX == 0: Clipboard already open
160 <> 0: Clipboard opened */
162 __dpmi_int(0x2f, ®s
);
166 /* Empty clipboard, return non-zero if successfull. */
172 /* Calls Int 2Fh/AX=1702h
173 Return Values AX == 0: Error occurred
174 <> 0: OK, Clipboard emptied */
176 __dpmi_int(0x2f, ®s
);
180 /* Ensure we have a buffer in low memory with enough memory for data
181 of size WANT_SIZE. Return the linear address of the buffer. */
183 alloc_xfer_buf (want_size
)
188 /* If the usual DJGPP transfer buffer is large enough, use that. */
189 if (want_size
<= _go32_info_block
.size_of_transfer_buffer
)
190 return __tb
& 0xfffff;
192 /* Don't even try to allocate more than 1MB of memory: DOS cannot
193 possibly handle that (it will overflow the BX register below). */
194 if (want_size
> 0xfffff)
197 /* Need size rounded up to the nearest paragraph, and in
198 paragraph units (1 paragraph = 16 bytes). */
199 clipboard_xfer_buf_info
.size
= (want_size
+ 15) >> 4;
201 /* The NT DPMI host crashes us if we free DOS memory via the
202 DPMI service. Work around by calling DOS allocate/free block. */
204 regs
.x
.bx
= clipboard_xfer_buf_info
.size
;
205 __dpmi_int (0x21, ®s
);
206 if (regs
.x
.flags
& 1)
208 clipboard_xfer_buf_info
.size
= 0;
212 clipboard_xfer_buf_info
.rm_segment
= regs
.x
.ax
;
213 return (((int)clipboard_xfer_buf_info
.rm_segment
) << 4) & 0xfffff;
216 /* Free our clipboard buffer. We always free it after use, because
217 keeping it leaves less free conventional memory for subprocesses.
218 The clipboard buffer tends to be large in size, because for small
219 clipboard data sizes we use the DJGPP transfer buffer. */
223 /* If the size is 0, we used DJGPP transfer buffer, so don't free. */
224 if (clipboard_xfer_buf_info
.size
)
228 /* The NT DPMI host crashes us if we free DOS memory via
229 the DPMI service. Work around by calling DOS free block. */
231 regs
.x
.es
= clipboard_xfer_buf_info
.rm_segment
;
232 __dpmi_int (0x21, ®s
);
233 clipboard_xfer_buf_info
.size
= 0;
237 /* Copy data into the clipboard, return zero if successfull. */
239 set_clipboard_data (Format
, Data
, Size
, Raw
)
247 unsigned long xbuf_addr
, buf_offset
;
248 unsigned char *dp
= Data
, *dstart
= dp
;
250 if (Format
!= CF_OEMTEXT
)
253 /* need to know final size after '\r' chars are inserted (the
254 standard CF_OEMTEXT clipboard format uses CRLF line endings,
255 while Emacs uses just LF internally). */
256 truelen
= Size
+ 1; /* +1 for the terminating null */
260 /* avoid using strchr because it recomputes the length everytime */
261 while ((dp
= memchr (dp
, '\n', Size
- (dp
- dstart
))) != 0)
268 if (clipboard_compact (truelen
) < truelen
)
271 if ((xbuf_addr
= alloc_xfer_buf (truelen
)) == 0)
274 /* Move the buffer into the low memory, convert LF into CR-LF if needed. */
277 dosmemput (Data
, Size
, xbuf_addr
);
279 /* Terminate with a null, otherwise Windows does strange things
280 when the text size is an integral multiple of 32 bytes. */
281 _farpokeb (_dos_ds
, xbuf_addr
+ Size
, '\0');
286 buf_offset
= xbuf_addr
;
287 _farsetsel (_dos_ds
);
290 /* Don't allow them to put binary data into the clipboard, since
291 it will cause yanked data to be truncated at the first null. */
295 _farnspokeb (buf_offset
++, '\r');
296 _farnspokeb (buf_offset
++, *dp
++);
299 /* Terminate with a null, otherwise Windows does strange things
300 when the text size is an integral multiple of 32 bytes. */
301 _farnspokeb (buf_offset
, '\0');
304 /* Stash away the data we are about to put into the clipboard, so we
305 could later check inside get_clipboard_data whether the clipboard
306 still holds our data. */
307 if (clipboard_storage_size
< truelen
)
309 clipboard_storage_size
= truelen
+ 100;
310 last_clipboard_text
=
311 (char *) xrealloc (last_clipboard_text
, clipboard_storage_size
);
313 if (last_clipboard_text
)
314 dosmemget (xbuf_addr
, truelen
, last_clipboard_text
);
316 /* Calls Int 2Fh/AX=1703h with:
317 DX = WinOldAp-Supported Clipboard format
318 ES:BX = Pointer to data
319 SI:CX = Size of data in bytes
320 Return Values AX == 0: Error occurred
321 <> 0: OK. Data copied into the Clipboard. */
324 regs
.x
.si
= truelen
>> 16;
325 regs
.x
.cx
= truelen
& 0xffff;
326 regs
.x
.es
= xbuf_addr
>> 4;
327 regs
.x
.bx
= xbuf_addr
& 15;
328 __dpmi_int(0x2f, ®s
);
332 /* If the above failed, invalidate the local copy of the clipboard. */
334 *last_clipboard_text
= '\0';
336 /* Zero means success, otherwise (1, 2, or 3) it's an error. */
337 return regs
.x
.ax
> 0 ? 0 : 3;
340 /* Return the size of the clipboard data of format FORMAT. */
342 get_clipboard_data_size (Format
)
347 /* Calls Int 2Fh/AX=1704h with:
348 DX = WinOldAp-Supported Clipboard format
349 Return Values DX:AX == Size of the data in bytes, including any
351 == 0 If data in this format is not in
355 __dpmi_int(0x2f, ®s
);
356 return ( (((unsigned)regs
.x
.dx
) << 16) | regs
.x
.ax
);
359 /* Get clipboard data, return its length.
360 Warning: this doesn't check whether DATA has enough space to hold
363 get_clipboard_data (Format
, Data
, Size
, Raw
)
370 unsigned long xbuf_addr
;
371 unsigned char *dp
= Data
;
373 if (Format
!= CF_OEMTEXT
)
379 if ((xbuf_addr
= alloc_xfer_buf (Size
)) == 0)
382 /* Calls Int 2Fh/AX=1705h with:
383 DX = WinOldAp-Supported Clipboard format
384 ES:BX = Pointer to data buffer to hold data
385 Return Values AX == 0: Error occurred (or data in this format is not
390 regs
.x
.es
= xbuf_addr
>> 4;
391 regs
.x
.bx
= xbuf_addr
& 15;
392 __dpmi_int(0x2f, ®s
);
395 unsigned char null_char
= '\0';
396 unsigned long xbuf_beg
= xbuf_addr
;
398 /* If last_clipboard_text is NULL, we don't want to slow down
399 the next loop by an additional test. */
400 register unsigned char *lcdp
=
401 last_clipboard_text
== NULL
? &null_char
: last_clipboard_text
;
403 /* Copy data from low memory, remove CR
404 characters before LF if needed. */
405 _farsetsel (_dos_ds
);
408 register unsigned char c
= _farnspeekb (xbuf_addr
++);
413 if ((*dp
++ = c
) == '\r' && !Raw
&& _farnspeekb (xbuf_addr
) == '\n')
421 /* Windows reportedly rounds up the size of clipboard data
422 (passed in SIZE) to a multiple of 32, and removes trailing
423 spaces from each line without updating SIZE. We therefore
424 bail out when we see the first null character. */
429 /* If the text in clipboard is identical to what we put there
430 last time set_clipboard_data was called, pretend there's no
431 data in the clipboard. This is so we don't pass our own text
432 from the clipboard (which might be troublesome if the killed
433 text includes null characters). */
434 if (last_clipboard_text
&&
435 xbuf_addr
- xbuf_beg
== (long)(lcdp
- last_clipboard_text
))
436 dp
= (unsigned char *)Data
+ 1;
441 return (unsigned) (dp
- (unsigned char *)Data
- 1);
444 /* Close clipboard, return non-zero if successfull. */
450 /* Calls Int 2Fh/AX=1708h
451 Return Values AX == 0: Error occurred
454 __dpmi_int(0x2f, ®s
);
458 /* Compact clipboard data so that at least SIZE bytes is available. */
460 clipboard_compact (Size
)
465 /* Calls Int 2Fh/AX=1709H with:
466 SI:CX = Desired memory size in bytes.
467 Return Values DX:AX == Number of bytes of largest block of free memory.
468 == 0 if error or no memory */
470 regs
.x
.si
= Size
>> 16;
471 regs
.x
.cx
= Size
& 0xffff;
472 __dpmi_int(0x2f, ®s
);
473 return ((unsigned)regs
.x
.dx
<< 16) | regs
.x
.ax
;
476 static char no_mem_msg
[] =
477 "(Not enough DOS memory to put saved text into clipboard.)";
478 static char binary_msg
[] =
479 "(Binary characters in saved text; clipboard data not set.)";
480 static char system_error_msg
[] =
481 "(Clipboard interface failure; clipboard data not set.)";
483 DEFUN ("w16-set-clipboard-data", Fw16_set_clipboard_data
, Sw16_set_clipboard_data
, 1, 2, 0,
484 doc
: /* This sets the clipboard data to the given text. */)
486 Lisp_Object string
, frame
;
488 unsigned ok
= 1, put_status
= 0;
490 unsigned char *src
, *dst
= NULL
;
492 int no_crlf_conversion
;
494 CHECK_STRING (string
);
497 frame
= Fselected_frame ();
499 CHECK_LIVE_FRAME (frame
);
500 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
505 nbytes
= STRING_BYTES (XSTRING (string
));
506 src
= XSTRING (string
)->data
;
508 /* Since we are now handling multilingual text, we must consider
509 encoding text for the clipboard. */
510 charset_info
= find_charset_in_text (src
, XSTRING (string
)->size
, nbytes
,
513 if (charset_info
== 0)
515 /* No multibyte character in OBJ. We need not encode it, but we
516 will have to convert it to DOS CR-LF style. */
517 no_crlf_conversion
= 0;
521 /* We must encode contents of STRING according to what
522 clipboard-coding-system specifies. */
524 struct coding_system coding
;
525 unsigned char *htext2
;
527 if (NILP (Vnext_selection_coding_system
))
528 Vnext_selection_coding_system
= Vselection_coding_system
;
530 (Fcheck_coding_system (Vnext_selection_coding_system
), &coding
);
531 if (SYMBOLP (coding
.pre_write_conversion
)
532 && !NILP (Ffboundp (coding
.pre_write_conversion
)))
534 string
= run_pre_post_conversion_on_str (string
, &coding
, 1);
535 src
= XSTRING (string
)->data
;
536 nbytes
= STRING_BYTES (XSTRING (string
));
538 coding
.src_multibyte
= 1;
539 coding
.dst_multibyte
= 0;
540 Vnext_selection_coding_system
= Qnil
;
541 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
542 Vlast_coding_system_used
= coding
.symbol
;
543 bufsize
= encoding_buffer_size (&coding
, nbytes
);
544 dst
= (unsigned char *) xmalloc (bufsize
);
545 encode_coding (&coding
, src
, dst
, nbytes
, bufsize
);
546 no_crlf_conversion
= 1;
547 nbytes
= coding
.produced
;
551 if (!open_clipboard ())
554 ok
= empty_clipboard ()
556 = set_clipboard_data (CF_OEMTEXT
, src
, nbytes
, no_crlf_conversion
))
559 if (!no_crlf_conversion
)
560 Vlast_coding_system_used
= Qraw_text
;
563 if (ok
) goto unblock
;
574 /* Notify user if the text is too large to fit into DOS memory.
575 (This will happen somewhere after 600K bytes (470K in DJGPP v1.x),
576 depending on user system configuration.) If we just silently
577 fail the function, people might wonder why their text sometimes
578 doesn't make it to the clipboard. */
584 message2 (no_mem_msg
, sizeof (no_mem_msg
) - 1, 0);
587 message2 (binary_msg
, sizeof (binary_msg
) - 1, 0);
590 message2 (system_error_msg
, sizeof (system_error_msg
) - 1, 0);
593 sit_for (2, 0, 0, 1, 1);
598 return (ok
&& put_status
== 0 ? string
: Qnil
);
601 DEFUN ("w16-get-clipboard-data", Fw16_get_clipboard_data
, Sw16_get_clipboard_data
, 0, 1, 0,
602 doc
: /* This gets the clipboard data in text format. */)
606 unsigned data_size
, truelen
;
607 unsigned char *htext
;
608 Lisp_Object ret
= Qnil
;
609 int no_crlf_conversion
;
610 int require_encoding
= 0;
613 frame
= Fselected_frame ();
615 CHECK_LIVE_FRAME (frame
);
616 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
621 if (!open_clipboard ())
624 if ((data_size
= get_clipboard_data_size (CF_OEMTEXT
)) == 0 ||
625 (htext
= (unsigned char *)xmalloc (data_size
)) == 0)
628 /* need to know final size after '\r' chars are removed because
629 we can't change the string size manually, and doing an extra
631 if ((truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 0)) == 0)
634 /* Do we need to decode it? */
636 /* If the clipboard data contains any 8-bit Latin-1 code, we
637 need to decode it. */
640 for (i
= 0; i
< truelen
; i
++)
642 if (htext
[i
] >= 0x80)
644 require_encoding
= 1;
649 if (require_encoding
)
653 struct coding_system coding
;
655 if (NILP (Vnext_selection_coding_system
))
656 Vnext_selection_coding_system
= Vselection_coding_system
;
658 (Fcheck_coding_system (Vnext_selection_coding_system
), &coding
);
659 coding
.src_multibyte
= 0;
660 coding
.dst_multibyte
= 1;
661 Vnext_selection_coding_system
= Qnil
;
662 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
663 truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 1);
664 bufsize
= decoding_buffer_size (&coding
, truelen
);
665 buf
= (unsigned char *) xmalloc (bufsize
);
666 decode_coding (&coding
, htext
, buf
, truelen
, bufsize
);
667 ret
= make_string_from_bytes ((char *) buf
,
668 coding
.produced_char
, coding
.produced
);
670 if (SYMBOLP (coding
.post_read_conversion
)
671 && !NILP (Ffboundp (coding
.post_read_conversion
)))
672 ret
= run_pre_post_conversion_on_str (ret
, &coding
, 0);
673 Vlast_coding_system_used
= coding
.symbol
;
677 ret
= make_unibyte_string ((char *) htext
, truelen
);
678 Vlast_coding_system_used
= Qraw_text
;
694 /* Support checking for a clipboard selection. */
696 DEFUN ("x-selection-exists-p", Fx_selection_exists_p
, Sx_selection_exists_p
,
698 doc
: /* Whether there is an owner for the given X Selection.
699 The arg should be the name of the selection in question, typically one of
700 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
701 \(Those are literal upper-case symbol names, since that's what X expects.)
702 For convenience, the symbol nil is the same as `PRIMARY',
703 and t is the same as `SECONDARY'. */)
705 Lisp_Object selection
;
707 CHECK_SYMBOL (selection
);
709 /* Return nil for SECONDARY selection. For PRIMARY (or nil)
710 selection, check if there is some text on the kill-ring;
711 for CLIPBOARD, check if the clipboard currently has valid
712 text format contents.
714 The test for killed text on the kill-ring emulates the Emacs
715 behavior on X, where killed text is also put into X selection
716 by the X interface code. (On MSDOS, killed text is only put
717 into the clipboard if we run under Windows, so we cannot check
718 the clipboard alone.) */
719 if ((EQ (selection
, Qnil
) || EQ (selection
, QPRIMARY
))
720 && ! NILP (SYMBOL_VALUE (Fintern_soft (build_string ("kill-ring"),
724 if (EQ (selection
, QCLIPBOARD
))
726 Lisp_Object val
= Qnil
;
728 if (open_clipboard ())
730 if (get_clipboard_data_size (CF_OEMTEXT
))
740 syms_of_win16select ()
742 defsubr (&Sw16_set_clipboard_data
);
743 defsubr (&Sw16_get_clipboard_data
);
744 defsubr (&Sx_selection_exists_p
);
746 DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system
,
747 doc
: /* Coding system for communicating with other X clients.
748 When sending or receiving text via cut_buffer, selection, and clipboard,
749 the text is encoded or decoded by this coding system.
750 A default value is `iso-latin-1-dos'. */);
751 Vselection_coding_system
=intern ("iso-latin-1-dos");
753 DEFVAR_LISP ("next-selection-coding-system", &Vnext_selection_coding_system
,
754 doc
: /* Coding system for the next communication with other X clients.
755 Usually, `selection-coding-system' is used for communicating with
756 other X clients. But, if this variable is set, it is used for the
757 next communication only. After the communication, this variable is
759 Vnext_selection_coding_system
= Qnil
;
761 QPRIMARY
= intern ("PRIMARY"); staticpro (&QPRIMARY
);
762 QCLIPBOARD
= intern ("CLIPBOARD"); staticpro (&QCLIPBOARD
);