annotate src/bytecode.h @ 424:11054d720c21 r21-2-20

Import from CVS: tag r21-2-20
author cvs
date Mon, 13 Aug 2007 11:26:11 +0200
parents 697ef44129c6
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 /* Definitions for bytecode interpretation and compiled-function objects.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, 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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 later version.
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 /* Synched up with: Not in FSF. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 /* Authorship:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 FSF: long ago.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 Mly: rewrote for 19.8, properly abstracted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 Jon Reid: some changes for I18N3 (domain, etc), for 19.8.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
412
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 398
diff changeset
30 #ifndef _XEMACS_BYTECODE_H_
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 398
diff changeset
31 #define _XEMACS_BYTECODE_H_
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
33 /* Meanings of slots in a Lisp_Compiled_Function.
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
34 Don't use these! For backward compatibility only. */
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
35 #define COMPILED_ARGLIST 0
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
36 #define COMPILED_INSTRUCTIONS 1
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
37 #define COMPILED_CONSTANTS 2
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
38 #define COMPILED_STACK_DEPTH 3
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
39 #define COMPILED_DOC_STRING 4
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
40 #define COMPILED_INTERACTIVE 5
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
41 #define COMPILED_DOMAIN 6
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42
233
52952cbfc5b5 Import from CVS: tag r20-5b15
cvs
parents: 185
diff changeset
43 /* It doesn't make sense to have this and also have load-history */
52952cbfc5b5 Import from CVS: tag r20-5b15
cvs
parents: 185
diff changeset
44 /* #define COMPILED_FUNCTION_ANNOTATION_HACK */
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 struct Lisp_Compiled_Function
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
47 {
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
48 struct lrecord_header lheader;
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
49 unsigned short stack_depth;
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
50 unsigned short specpdl_depth;
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
51 struct
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 {
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
53 unsigned int documentationp: 1;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
54 unsigned int interactivep: 1;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
55 /* Only used if I18N3, but always defined for simplicity. */
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
56 unsigned int domainp: 1;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
57 /* Non-zero if this bytecode came from a v18 or v19 file.
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
58 We need to Ebolify the `assoc', `delq', etc. functions. */
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
59 unsigned int ebolified: 1;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
60 } flags;
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
61 Lisp_Object instructions;
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
62 Lisp_Object constants;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
63 Lisp_Object arglist;
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
64 /* This uses the minimal number of conses; see accessors in data.c. */
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
65 Lisp_Object doc_and_interactive;
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 #ifdef COMPILED_FUNCTION_ANNOTATION_HACK
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
67 /* Something indicating where the bytecode came from */
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
68 Lisp_Object annotated;
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 #endif
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
70 };
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
71 typedef struct Lisp_Compiled_Function Lisp_Compiled_Function;
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
73 Lisp_Object run_byte_code (Lisp_Object compiled_function_or_instructions, ...);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
74
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
75 Lisp_Object compiled_function_arglist (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
76 Lisp_Object compiled_function_instructions (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
77 Lisp_Object compiled_function_constants (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
78 int compiled_function_stack_depth (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
79 Lisp_Object compiled_function_documentation (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
80 Lisp_Object compiled_function_annotation (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
81 Lisp_Object compiled_function_domain (Lisp_Compiled_Function *f);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
82 Lisp_Object compiled_function_interactive (Lisp_Compiled_Function *f);
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
84 void set_compiled_function_documentation (Lisp_Compiled_Function *f,
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
85 Lisp_Object new_doc);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
86
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
87 Lisp_Object funcall_compiled_function (Lisp_Object fun,
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
88 int nargs, Lisp_Object args[]);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
89 void optimize_compiled_function (Lisp_Object compiled_function);
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
90
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
91 DECLARE_LRECORD (compiled_function, Lisp_Compiled_Function);
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 #define XCOMPILED_FUNCTION(x) XRECORD (x, compiled_function, \
380
8626e4521993 Import from CVS: tag r21-2-5
cvs
parents: 272
diff changeset
93 Lisp_Compiled_Function)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 #define XSETCOMPILED_FUNCTION(x, p) XSETRECORD (x, p, compiled_function)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 #define COMPILED_FUNCTIONP(x) RECORDP (x, compiled_function)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 #define CHECK_COMPILED_FUNCTION(x) CHECK_RECORD (x, compiled_function)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 #define CONCHECK_COMPILED_FUNCTION(x) CONCHECK_RECORD (x, compiled_function)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 233
diff changeset
99 extern Lisp_Object Qbyte_code;
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 233
diff changeset
100
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 /* total 1765 internal 101 doc-and-int 775 doc-only 389 int-only 42 neither 559
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 no doc slot, no int slot
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 overhead : (* 1765 0) = 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 doc-and-int (args . (doc . int)): (* 775 4) = 3100
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 doc-only (args . doc) : (* 389 2) = 778
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 int-only (args . int) : (* 42 2) = 84
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 neither args : (* 559 0) = 0 = 3962
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 combined
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 overhead : (* 1765 1) = 1765
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
110 doc-and-int (doc . int) : (* 775 2) = 1550
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 doc-only doc : (* 389 0) = 0
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
112 int-only int : (* 42 0) = 0
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 neither - : (* 559 0) = 0 = 3315
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 both
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 overhead : (* 1765 2) = 3530
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 doc-and-int - : (* 775 0) = 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 doc-only - : (* 389 0) = 0
185
3d6bfa290dbd Import from CVS: tag r20-3b19
cvs
parents: 70
diff changeset
118 int-only - : (* 42 0) = 0
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 neither - : (* 559 0) = 0 = 3530
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121
412
697ef44129c6 Import from CVS: tag r21-2-14
cvs
parents: 398
diff changeset
122 #endif /* _XEMACS_BYTECODE_H_ */
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123