annotate src/EmacsShell.h @ 5566:4654c01af32b

Improve the implementation, documentation of #'labels, #'flet. lisp/ChangeLog addition: 2011-09-07 Aidan Kehoe <kehoea@parhasard.net> * bytecomp.el: * bytecomp.el (for-effect): Move this earlier in the file, it's referenced in byte-compile-initial-macro-environment. * bytecomp.el (byte-compile-initial-macro-environment): In the byte-compile-macro-environment definition for #'labels, put off the compiling the lambda bodies until the point where the rest of the form is being compiled, allowing the lambda bodies to access appropriate values for byte-compile-bound-variables, and reducing excessive warning about free variables. Add a byte-compile-macro-environment definition for #'flet. This modifies byte-compile-function-environment appropriately, and warns about bindings of functions that have macro definitions in the current environment, about functions that have byte codes, and about functions that have byte-compile methods (which may not do what the user wants at runtime). * bytecomp.el (byte-compile-funcall): If FUNCTION is constant, call #'byte-compile-callargs-warn if that's appropriate, giving warnings about problems with calling functions bound with #'labels. * cl-macs.el: * cl-macs.el (flet): Mention the main difference from Common Lisp, that the bindings are dynamic, not lexical. Counsel the use of #'labels, not #'flet, for this and other reasons. Explain the limited single use case for #'flet. Cross-reference to bytecomp.el in a comment. * cl-macs.el (labels): Go into detail on which functions may be called from where. Explain how to access the function definition of a label within FORM. Add a comment cross-referencing to bytecomp.el. man/ChangeLog addition: 2011-09-07 Aidan Kehoe <kehoea@parhasard.net> * cl.texi (Function Bindings): Move #'labels first, describe it in more detail, explaining that it is to be preferred over #'flet, and explaining why. Explain that dynamic bindings with #'flet will also not work when functions are accessed through their bytecodes.
author Aidan Kehoe <kehoea@parhasard.net>
date Wed, 07 Sep 2011 16:26:45 +0100
parents 308d34e9f07d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 /* Emacs shell widget external header file.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 Copyright (C) 1994 Sun Microsystems, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 This file is part of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 440
diff changeset
6 XEmacs is free software: you can redistribute it and/or modify it
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 440
diff changeset
8 Free Software Foundation, either version 3 of the License, or (at your
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 440
diff changeset
9 option) any later version.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 for more details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
5402
308d34e9f07d Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents: 440
diff changeset
17 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 /* Synched up with: Not in FSF. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 /* Written by Ben Wing, May, 1994. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 0
diff changeset
23 #ifndef INCLUDED_EmacsShell_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 0
diff changeset
24 #define INCLUDED_EmacsShell_h_
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 #ifndef XtNwidthCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 #define XtNwidthCells "widthCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 #ifndef XtCWidthCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 #define XtCWidthCells "WidthCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 #ifndef XtNheightCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 #define XtNheightCells "heightCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 #ifndef XtCHeightCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 #define XtCHeightCells "HeightCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 #ifndef XtNminWidthCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 #define XtNminWidthCells "minWidthCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 #ifndef XtCMinWidthCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 #define XtCMinWidthCells "MinWidthCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 #ifndef XtNminHeightCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 #define XtNminHeightCells "minHeightCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 #ifndef XtCMinHeightCells
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 #define XtCMinHeightCells "MinHeightCells"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 typedef struct _TopLevelEmacsShellClassRec *TopLevelEmacsShellWidgetClass;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 typedef struct _TopLevelEmacsShellRec *TopLevelEmacsShellWidget;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 extern WidgetClass topLevelEmacsShellWidgetClass;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 typedef struct _TransientEmacsShellClassRec *TransientEmacsShellWidgetClass;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 typedef struct _TransientEmacsShellRec *TransientEmacsShellWidget;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 extern WidgetClass transientEmacsShellWidgetClass;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 void EmacsShellUpdateSizeHints (Widget gw);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 void TopLevelEmacsShellUpdateSizeHints (Widget gw);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 void TransientEmacsShellUpdateSizeHints (Widget gw);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 void EmacsShellSetSizeUserSpecified (Widget gw);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 void EmacsShellSetPositionUserSpecified (Widget gw);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 void EmacsShellSmashIconicHint (Widget shell, int iconic_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 0
diff changeset
69 #endif /* INCLUDED_EmacsShell_h_ */