annotate man/lispref/dragndrop.texi @ 4995:8431b52e43b1

Move the various map* functions to C; add #'map-into. src/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> Move #'mapcar*, #'mapcan, #'mapc, #'map, #'mapl, #'mapcon to C; extend #'mapvector, #'mapconcat, #'mapcar to support more SEQUENCES; have them all error with circular lists. * fns.c (Fsubseq): Call CHECK_SEQUENCE here; Flength can return from the debugger if it errors with a non-sequence, leading to a crash in Fsubseq if sequence really is *not* a sequence. (mapcarX): Rename mapcar1 to mapcarX; rework it comprehensively to take an optional lisp output argument, and a varying number of sequences. Special-case a single list argument, as we used to, saving its elements in the stack space for the results before calling FUNCTION, so FUNCTION can corrupt the list all it wants. dead_wrong_type_argument() in the other cases if we encounter a non-cons where we expected a cons. (Fmapconcat): Accept further SEQUENCES after separator here. Special-case the idiom (mapconcat 'identity SEQUENCE), don't even funcall. (FmapcarX): Rename this from Fmapcar. Accept optional SEQUENCES. (Fmapvector): Accept optional SEQUENCES. (Fmapcan, Fmapc, Fmap): Move these here from cl-extra.el. (Fmap_into): New function, as specified by Common Lisp. (maplist): New function, the guts of the implementation of Fmaplist and Fmapl. (Fmaplist, Fmapl, Fmapcon): Move these from cl-extra.el. (syms_of_fns): Add a few needed symbols here, for the type tests used by #'map. Add the new subrs, with aliases for #'mapc-internal and #'mapcar. * general-slots.h: Declare Qcoerce here, now it's used in both indent.c and fns.c * indent.c (syms_of_indent): Qcoerce is gone from here. * lisp.h: Add ARRAYP(), SEQUENCEP(), and the corresponding CHECK_* macros. Declare Fbit_vector, Fstring, FmapcarX, now other files need to use them. * data.c (Farrayp, Fsequencep): Use ARRAYP and SEQUENCEP, just added to lisp.h * buffer.c (Fbuffer_list): Now Fmapcar has been renamed FmapcarX and takes MANY arguments, update this function to reflect that. lisp/ChangeLog addition: 2010-01-31 Aidan Kehoe <kehoea@parhasard.net> * cl.el (mapcar*): Delete; this is now in fns.c. Use #'mapc, not #'mapc-internal in a couple of places. * cl-macs.el (mapc, mapcar*, map): Delete these compiler macros now the corresponding functions are in fns.c; there's no run-time advantage to the macros. * cl-extra.el (coerce): Extend the possible conversions here a little; it's not remotely comprehensive yet, though it does allow running slightly more Common Lisp code than previously. (cl-mapcar-many): Delete. (map, maplist, mapc, mapl, mapcan, mapcon): Move these to fns.c. * bytecomp.el (byte-compile-maybe-mapc): Use #'mapc itself, not #'mapc-internal, now the former is in C. (mapcar*): Use #'byte-compile-maybe-mapc as this function's byte-compile method, now a #'mapc that can take more than one sequence is in C. * obsolete.el (cl-mapc): Move this compatibility alias to this file. * update-elc.el (do-autoload-commands): Use #'mapc, not #'mapc-internal here.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 31 Jan 2010 18:29:48 +0000
parents bc4f2511bbea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 @c Copyright (C) 1998 Oliver Graf <ograf@fga.de>
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 428
diff changeset
4 @c Original reference is (c) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 @c See the file lispref.texi for copying conditions.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 @setfilename ../../info/dragndrop.texi
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 @node Drag and Drop, Modes, Scrollbars, Top
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 @chapter Drag and Drop
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 @cindex drag and drop
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 @emph{WARNING}: the Drag'n'Drop API is still under development and the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 interface may change! The current implementation is considered experimental.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 Drag'n'drop is a way to transfer information between multiple applications.
4790
bc4f2511bbea Remove support for the OffiX drag-and-drop protocol. See xemacs-patches
Jerry James <james@xemacs.org>
parents: 904
diff changeset
15 To do this several GUIs define their own protocols. Examples are CDE, Motif,
bc4f2511bbea Remove support for the OffiX drag-and-drop protocol. See xemacs-patches
Jerry James <james@xemacs.org>
parents: 904
diff changeset
16 KDE, MSWindows, GNOME, and many more. To catch all these protocols, XEmacs
bc4f2511bbea Remove support for the OffiX drag-and-drop protocol. See xemacs-patches
Jerry James <james@xemacs.org>
parents: 904
diff changeset
17 provides a generic API.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 One prime idea behind the API is to use a data interface that is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 transparent for all systems. The author thinks that this is best
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 archived by using URL and MIME data, cause any internet enabled system
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 must support these for email already. XEmacs also already provides
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 powerful interfaces to support these types of data (tm and w3).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 @menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 * Supported Protocols:: Which low-level protocols are supported.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 * Drop Interface:: How XEmacs handles a drop from another application.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 * Drag Interface:: Calls to initiate a drag from XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 @node Supported Protocols
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 @section Supported Protocols
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 The current release of XEmacs only support a small set of Drag'n'drop
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 protocols. Some of these only support limited options available in the API.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 @menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 * CDE dt:: Common Desktop Environment used on suns.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 * MSWindows OLE:: Mr. Gates way of live.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 * Loose ends:: The other protocols.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 @node CDE dt
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 @subsection CDE dt
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 @cindex CDE dt
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 CDE stands for Common Desktop Environment. It is based on the Motif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 widget library. It's drag'n'drop protocol is also an abstraction of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 Motif protocol (so it might be possible, that XEmacs will also support
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 the Motif protocol soon).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 CDE has three different types: file, buffer, and text. XEmacs only uses
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 file and buffer drags. The API will disallow full URL drags, only file
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 method URLs are passed through.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 Buffer drags are always converted to plain text.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 @node MSWindows OLE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 @subsection MSWindows OLE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 @cindex MSWindows OLE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 Only allows file drags and drops.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 @node Loose ends
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 @subsection Loose ends
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 The following protocols will be supported soon: Xdnd, Motif, Xde (if I
4790
bc4f2511bbea Remove support for the OffiX drag-and-drop protocol. See xemacs-patches
Jerry James <james@xemacs.org>
parents: 904
diff changeset
68 get some specs).
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 In particular Xdnd will be one of the protocols that can benefit from
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 the XEmacs API, cause it also uses MIME types to encode dragged data.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 @node Drop Interface
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 @section Drop Interface
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 @cindex drop
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 @cindex Drop API
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77
904
47c30044fc4e [xemacs-hg @ 2002-07-06 18:56:24 by adrian]
adrian
parents: 444
diff changeset
78 For each activated low-level protocol, an internal routine will catch
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 incoming drops and convert them to a dragdrop-drop type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 misc-user-event.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 This misc-user-event has its function argument set to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 @code{dragdrop-drop-dispatch} and the object contains the data of the drop
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 (converted to URL/MIME specific data). This function will search the variable
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 428
diff changeset
85 @code{experimental-dragdrop-drop-functions} for a function that can handle the
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 dropped data.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 To modify the drop behavior, the user can modify the variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 @code{experimental-dragdrop-drop-functions}. Each element of this list
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 specifies a possible handler for dropped data. The first one that can handle
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 the data will return @code{t} and exit. Another possibility is to set a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 extent-property with the same name. Extents are checked prior to the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 variable.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 The customization group @code{drag-n-drop} shows all variables of user
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 428
diff changeset
96 interest.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 @node Drag Interface
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 @section Drag Interface
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 @cindex drag
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 @cindex Drag API
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 This describes the drag API (not implemented yet).