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 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 by Eli Zaretskii <eliz@gnu.org> */
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 /* C functions to access the Windows 3.1x clipboard from DOS apps.
99 The information was obtained from the Microsoft Knowledge Base,
100 article Q67675 and can be found at:
101 http://www.microsoft.com/kb/developr/win_dk/q67675.htm */
103 /* See also Ralf Brown's Interrupt List.
105 I also seem to remember reading about this in Dr. Dobbs Journal a
106 while ago, but if you knew my memory... :-)
108 Dale P. Smith <dpsm@en.com> */
110 /* Return the WinOldAp support version, or 0x1700 if not supported. */
112 identify_winoldap_version ()
116 /* Calls Int 2Fh/AX=1700h
117 Return Values AX == 1700H: Clipboard functions not available
118 <> 1700H: AL = Major version number
119 AH = Minor version number */
121 __dpmi_int(0x2f, ®s
);
125 /* Open the clipboard, return non-zero if successfull. */
131 /* Is WINOLDAP supported? */
132 /* Kludge alert!! If WinOldAp is not supported, we return a 0,
133 which is the same as ``Clipboard already open''. Currently,
134 this is taken as an error by all the functions that use
135 `open_clipboard', but if somebody someday will use that ``open''
136 clipboard, they will have interesting time debugging it... */
137 if (identify_winoldap_version () == 0x1700)
140 /* Calls Int 2Fh/AX=1701h
141 Return Values AX == 0: Clipboard already open
142 <> 0: Clipboard opened */
144 __dpmi_int(0x2f, ®s
);
148 /* Empty clipboard, return non-zero if successfull. */
154 /* Calls Int 2Fh/AX=1702h
155 Return Values AX == 0: Error occurred
156 <> 0: OK, Clipboard emptied */
158 __dpmi_int(0x2f, ®s
);
162 /* Ensure we have a buffer in low memory with enough memory for data
163 of size WANT_SIZE. Return the linear address of the buffer. */
165 alloc_xfer_buf (want_size
)
170 /* If the usual DJGPP transfer buffer is large enough, use that. */
171 if (want_size
<= _go32_info_block
.size_of_transfer_buffer
)
172 return __tb
& 0xfffff;
174 /* Don't even try to allocate more than 1MB of memory: DOS cannot
175 possibly handle that (it will overflow the BX register below). */
176 if (want_size
> 0xfffff)
179 /* Need size rounded up to the nearest paragraph, and in
180 paragraph units (1 paragraph = 16 bytes). */
181 clipboard_xfer_buf_info
.size
= (want_size
+ 15) >> 4;
183 /* The NT DPMI host crashes us if we free DOS memory via the
184 DPMI service. Work around by calling DOS allocate/free block. */
186 regs
.x
.bx
= clipboard_xfer_buf_info
.size
;
187 __dpmi_int (0x21, ®s
);
188 if (regs
.x
.flags
& 1)
190 clipboard_xfer_buf_info
.size
= 0;
194 clipboard_xfer_buf_info
.rm_segment
= regs
.x
.ax
;
195 return (((int)clipboard_xfer_buf_info
.rm_segment
) << 4) & 0xfffff;
198 /* Free our clipboard buffer. We always free it after use, because
199 keeping it leaves less free conventional memory for subprocesses.
200 The clipboard buffer tends to be large in size, because for small
201 clipboard data sizes we use the DJGPP transfer buffer. */
205 /* If the size is 0, we used DJGPP transfer buffer, so don't free. */
206 if (clipboard_xfer_buf_info
.size
)
210 /* The NT DPMI host crashes us if we free DOS memory via
211 the DPMI service. Work around by calling DOS free block. */
213 regs
.x
.es
= clipboard_xfer_buf_info
.rm_segment
;
214 __dpmi_int (0x21, ®s
);
215 clipboard_xfer_buf_info
.size
= 0;
219 /* Copy data into the clipboard, return zero if successfull. */
221 set_clipboard_data (Format
, Data
, Size
, Raw
)
229 unsigned long xbuf_addr
, buf_offset
;
230 unsigned char *dp
= Data
, *dstart
= dp
;
232 if (Format
!= CF_OEMTEXT
)
235 /* need to know final size after '\r' chars are inserted (the
236 standard CF_OEMTEXT clipboard format uses CRLF line endings,
237 while Emacs uses just LF internally). */
238 truelen
= Size
+ 1; /* +1 for the terminating null */
242 /* avoid using strchr because it recomputes the length everytime */
243 while ((dp
= memchr (dp
, '\n', Size
- (dp
- dstart
))) != 0)
250 if (clipboard_compact (truelen
) < truelen
)
253 if ((xbuf_addr
= alloc_xfer_buf (truelen
)) == 0)
256 /* Move the buffer into the low memory, convert LF into CR-LF if needed. */
259 dosmemput (Data
, Size
, xbuf_addr
);
261 /* Terminate with a null, otherwise Windows does strange things
262 when the text size is an integral multiple of 32 bytes. */
263 _farpokeb (_dos_ds
, xbuf_addr
+ Size
, '\0');
268 buf_offset
= xbuf_addr
;
269 _farsetsel (_dos_ds
);
272 /* Don't allow them to put binary data into the clipboard, since
273 it will cause yanked data to be truncated at the first null. */
277 _farnspokeb (buf_offset
++, '\r');
278 _farnspokeb (buf_offset
++, *dp
++);
281 /* Terminate with a null, otherwise Windows does strange things
282 when the text size is an integral multiple of 32 bytes. */
283 _farnspokeb (buf_offset
, '\0');
286 /* Stash away the data we are about to put into the clipboard, so we
287 could later check inside get_clipboard_data whether the clipboard
288 still holds our data. */
289 if (clipboard_storage_size
< truelen
)
291 clipboard_storage_size
= truelen
+ 100;
292 last_clipboard_text
=
293 (char *) xrealloc (last_clipboard_text
, clipboard_storage_size
);
295 if (last_clipboard_text
)
296 dosmemget (xbuf_addr
, truelen
, last_clipboard_text
);
298 /* Calls Int 2Fh/AX=1703h with:
299 DX = WinOldAp-Supported Clipboard format
300 ES:BX = Pointer to data
301 SI:CX = Size of data in bytes
302 Return Values AX == 0: Error occurred
303 <> 0: OK. Data copied into the Clipboard. */
306 regs
.x
.si
= truelen
>> 16;
307 regs
.x
.cx
= truelen
& 0xffff;
308 regs
.x
.es
= xbuf_addr
>> 4;
309 regs
.x
.bx
= xbuf_addr
& 15;
310 __dpmi_int(0x2f, ®s
);
314 /* If the above failed, invalidate the local copy of the clipboard. */
316 *last_clipboard_text
= '\0';
318 /* Zero means success, otherwise (1, 2, or 3) it's an error. */
319 return regs
.x
.ax
> 0 ? 0 : 3;
322 /* Return the size of the clipboard data of format FORMAT. */
324 get_clipboard_data_size (Format
)
329 /* Calls Int 2Fh/AX=1704h with:
330 DX = WinOldAp-Supported Clipboard format
331 Return Values DX:AX == Size of the data in bytes, including any
333 == 0 If data in this format is not in
337 __dpmi_int(0x2f, ®s
);
338 return ( (((unsigned)regs
.x
.dx
) << 16) | regs
.x
.ax
);
341 /* Get clipboard data, return its length.
342 Warning: this doesn't check whether DATA has enough space to hold
345 get_clipboard_data (Format
, Data
, Size
, Raw
)
352 unsigned long xbuf_addr
;
353 unsigned char *dp
= Data
;
355 if (Format
!= CF_OEMTEXT
)
361 if ((xbuf_addr
= alloc_xfer_buf (Size
)) == 0)
364 /* Calls Int 2Fh/AX=1705h with:
365 DX = WinOldAp-Supported Clipboard format
366 ES:BX = Pointer to data buffer to hold data
367 Return Values AX == 0: Error occurred (or data in this format is not
372 regs
.x
.es
= xbuf_addr
>> 4;
373 regs
.x
.bx
= xbuf_addr
& 15;
374 __dpmi_int(0x2f, ®s
);
377 unsigned char null_char
= '\0';
378 unsigned long xbuf_beg
= xbuf_addr
;
380 /* If last_clipboard_text is NULL, we don't want to slow down
381 the next loop by an additional test. */
382 register unsigned char *lcdp
=
383 last_clipboard_text
== NULL
? &null_char
: last_clipboard_text
;
385 /* Copy data from low memory, remove CR
386 characters before LF if needed. */
387 _farsetsel (_dos_ds
);
390 register unsigned char c
= _farnspeekb (xbuf_addr
++);
395 if ((*dp
++ = c
) == '\r' && !Raw
&& _farnspeekb (xbuf_addr
) == '\n')
403 /* Windows reportedly rounds up the size of clipboard data
404 (passed in SIZE) to a multiple of 32, and removes trailing
405 spaces from each line without updating SIZE. We therefore
406 bail out when we see the first null character. */
411 /* If the text in clipboard is identical to what we put there
412 last time set_clipboard_data was called, pretend there's no
413 data in the clipboard. This is so we don't pass our own text
414 from the clipboard (which might be troublesome if the killed
415 text includes null characters). */
416 if (last_clipboard_text
&&
417 xbuf_addr
- xbuf_beg
== (long)(lcdp
- last_clipboard_text
))
418 dp
= (unsigned char *)Data
+ 1;
423 return (unsigned) (dp
- (unsigned char *)Data
- 1);
426 /* Close clipboard, return non-zero if successfull. */
432 /* Calls Int 2Fh/AX=1708h
433 Return Values AX == 0: Error occurred
436 __dpmi_int(0x2f, ®s
);
440 /* Compact clipboard data so that at least SIZE bytes is available. */
442 clipboard_compact (Size
)
447 /* Calls Int 2Fh/AX=1709H with:
448 SI:CX = Desired memory size in bytes.
449 Return Values DX:AX == Number of bytes of largest block of free memory.
450 == 0 if error or no memory */
452 regs
.x
.si
= Size
>> 16;
453 regs
.x
.cx
= Size
& 0xffff;
454 __dpmi_int(0x2f, ®s
);
455 return ((unsigned)regs
.x
.dx
<< 16) | regs
.x
.ax
;
458 static char no_mem_msg
[] =
459 "(Not enough DOS memory to put saved text into clipboard.)";
460 static char binary_msg
[] =
461 "(Binary characters in saved text; clipboard data not set.)";
462 static char system_error_msg
[] =
463 "(Clipboard interface failure; clipboard data not set.)";
465 DEFUN ("w16-set-clipboard-data", Fw16_set_clipboard_data
, Sw16_set_clipboard_data
, 1, 2, 0,
466 doc
: /* This sets the clipboard data to the given text. */)
468 Lisp_Object string
, frame
;
470 unsigned ok
= 1, put_status
= 0;
471 int nbytes
, charset_info
, no_crlf_conversion
;
472 unsigned char *src
, *dst
= NULL
;
474 CHECK_STRING (string
);
477 frame
= Fselected_frame ();
479 CHECK_LIVE_FRAME (frame
);
480 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
485 if (!open_clipboard ())
488 nbytes
= SBYTES (string
);
489 src
= SDATA (string
);
491 /* Do we need to encode this text? */
492 for (dst
= src
; dst
< src
+ nbytes
; dst
++)
494 if (*dst
== '\0' || *dst
>= 0x80)
497 if (dst
>= src
+ nbytes
)
499 /* No multibyte characters in text. We need not encode it, but we
500 will have to convert it to DOS CR-LF style. */
501 no_crlf_conversion
= 0;
502 Vlast_coding_system_used
= Qraw_text
;
503 dst
= NULL
; /* so we don't try to free a random pointer */
507 /* We must encode contents of STRING according to what
508 clipboard-coding-system specifies. */
510 struct coding_system coding
;
511 unsigned char *htext2
;
512 Lisp_Object coding_system
=
513 NILP (Vnext_selection_coding_system
) ?
514 Vselection_coding_system
: Vnext_selection_coding_system
;
516 setup_coding_system (Fcheck_coding_system (coding_system
), &coding
);
517 coding
.dst_bytes
= nbytes
* 4;
518 coding
.destination
= (unsigned char *) xmalloc (coding
.dst_bytes
);
519 Vnext_selection_coding_system
= Qnil
;
520 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
521 dst
= coding
.destination
;
522 encode_coding_object (&coding
, string
, 0, 0,
523 SCHARS (string
), nbytes
, Qnil
);
524 no_crlf_conversion
= 1;
525 nbytes
= coding
.produced
;
526 Vlast_coding_system_used
= CODING_ID_NAME (coding
.id
);
530 ok
= empty_clipboard ()
532 = set_clipboard_data (CF_OEMTEXT
, src
, nbytes
, no_crlf_conversion
))
535 if (!no_crlf_conversion
)
538 if (ok
) goto unblock
;
548 /* Notify user if the text is too large to fit into DOS memory.
549 (This will happen somewhere after 600K bytes (470K in DJGPP v1.x),
550 depending on user system configuration.) If we just silently
551 fail the function, people might wonder why their text sometimes
552 doesn't make it to the clipboard. */
558 message2 (no_mem_msg
, sizeof (no_mem_msg
) - 1, 0);
561 message2 (binary_msg
, sizeof (binary_msg
) - 1, 0);
564 message2 (system_error_msg
, sizeof (system_error_msg
) - 1, 0);
567 sit_for (make_number (2), 0, 2);
572 return (ok
&& put_status
== 0 ? string
: Qnil
);
575 DEFUN ("w16-get-clipboard-data", Fw16_get_clipboard_data
, Sw16_get_clipboard_data
, 0, 1, 0,
576 doc
: /* This gets the clipboard data in text format. */)
580 unsigned data_size
, truelen
;
581 unsigned char *htext
= NULL
;
582 Lisp_Object ret
= Qnil
;
583 int no_crlf_conversion
, require_decoding
= 0;
586 frame
= Fselected_frame ();
588 CHECK_LIVE_FRAME (frame
);
589 if ( !FRAME_MSDOS_P (XFRAME (frame
)))
594 if (!open_clipboard ())
597 if ((data_size
= get_clipboard_data_size (CF_OEMTEXT
)) == 0 ||
598 (htext
= (unsigned char *)xmalloc (data_size
)) == 0)
601 /* need to know final size after '\r' chars are removed because
602 we can't change the string size manually, and doing an extra
604 if ((truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 0)) == 0)
607 /* Do we need to decode it? */
609 /* If the clipboard data contains any 8-bit Latin-1 code, we
610 need to decode it. */
613 for (i
= 0; i
< truelen
; i
++)
615 if (htext
[i
] >= 0x80)
617 require_decoding
= 1;
622 if (require_decoding
)
626 struct coding_system coding
;
627 Lisp_Object coding_system
= Vnext_selection_coding_system
;
629 truelen
= get_clipboard_data (CF_OEMTEXT
, htext
, data_size
, 1);
630 if (NILP (coding_system
))
631 coding_system
= Vselection_coding_system
;
632 setup_coding_system (Fcheck_coding_system (coding_system
), &coding
);
633 coding
.source
= htext
;
634 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
635 /* We explicitly disable composition handling because selection
636 data should not contain any composition sequence. */
637 coding
.mode
&= CODING_ANNOTATION_MASK
;
638 decode_coding_object (&coding
, Qnil
, 0, 0, truelen
, truelen
, Qt
);
639 ret
= coding
.dst_object
;
640 Vlast_coding_system_used
= CODING_ID_NAME (coding
.id
);
644 ret
= make_unibyte_string ((char *) htext
, truelen
);
645 Vlast_coding_system_used
= Qraw_text
;
649 Vnext_selection_coding_system
= Qnil
;
662 /* Support checking for a clipboard selection. */
664 DEFUN ("x-selection-exists-p", Fx_selection_exists_p
, Sx_selection_exists_p
,
666 doc
: /* Whether there is an owner for the given X Selection.
667 The arg should be the name of the selection in question, typically one of
668 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
669 \(Those are literal upper-case symbol names, since that's what X expects.)
670 For convenience, the symbol nil is the same as `PRIMARY',
671 and t is the same as `SECONDARY'. */)
673 Lisp_Object selection
;
675 CHECK_SYMBOL (selection
);
677 /* Return nil for SECONDARY selection. For PRIMARY (or nil)
678 selection, check if there is some text on the kill-ring;
679 for CLIPBOARD, check if the clipboard currently has valid
680 text format contents.
682 The test for killed text on the kill-ring emulates the Emacs
683 behavior on X, where killed text is also put into X selection
684 by the X interface code. (On MSDOS, killed text is only put
685 into the clipboard if we run under Windows, so we cannot check
686 the clipboard alone.) */
687 if ((EQ (selection
, Qnil
) || EQ (selection
, QPRIMARY
))
688 && ! NILP (Fsymbol_value (Fintern_soft (build_string ("kill-ring"),
692 if (EQ (selection
, QCLIPBOARD
))
694 Lisp_Object val
= Qnil
;
696 if (open_clipboard ())
698 if (get_clipboard_data_size (CF_OEMTEXT
))
708 syms_of_win16select ()
710 defsubr (&Sw16_set_clipboard_data
);
711 defsubr (&Sw16_get_clipboard_data
);
712 defsubr (&Sx_selection_exists_p
);
714 DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system
,
715 doc
: /* Coding system for communicating with other X clients.
716 When sending or receiving text via cut_buffer, selection, and clipboard,
717 the text is encoded or decoded by this coding system.
718 The default value is `iso-latin-1-dos'. */);
719 Vselection_coding_system
= intern ("iso-latin-1-dos");
721 DEFVAR_LISP ("next-selection-coding-system", &Vnext_selection_coding_system
,
722 doc
: /* Coding system for the next communication with other X clients.
723 Usually, `selection-coding-system' is used for communicating with
724 other X clients. But, if this variable is set, it is used for the
725 next communication only. After the communication, this variable is
727 Vnext_selection_coding_system
= Qnil
;
729 QPRIMARY
= intern ("PRIMARY"); staticpro (&QPRIMARY
);
730 QCLIPBOARD
= intern ("CLIPBOARD"); staticpro (&QCLIPBOARD
);
735 /* arch-tag: 085a22c8-7324-436e-a6da-102464ce95d8
736 (do not change this comment) */