1 /* Execution of byte code produced by bytecomp.el.
2 Copyright (C) 1985-1988, 1993, 2000-2016 Free Software Foundation,
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 (at
10 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/>. */
23 #include "blockinput.h"
24 #include "character.h"
30 /* Work around GCC bug 54561. */
31 #if GNUC_PREREQ (4, 3, 0)
32 # pragma GCC diagnostic ignored "-Wclobbered"
36 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
37 * debugging the byte compiler...)
39 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
41 /* #define BYTE_CODE_SAFE */
42 /* #define BYTE_CODE_METER */
44 /* If BYTE_CODE_THREADED is defined, then the interpreter will be
45 indirect threaded, using GCC's computed goto extension. This code,
46 as currently implemented, is incompatible with BYTE_CODE_SAFE and
48 #if (defined __GNUC__ && !defined __STRICT_ANSI__ \
49 && !defined BYTE_CODE_SAFE && !defined BYTE_CODE_METER)
50 #define BYTE_CODE_THREADED
54 #ifdef BYTE_CODE_METER
56 #define METER_2(code1, code2) AREF (AREF (Vbyte_code_meter, code1), code2)
57 #define METER_1(code) METER_2 (0, code)
59 #define METER_CODE(last_code, this_code) \
61 if (byte_metering_on) \
63 if (XFASTINT (METER_1 (this_code)) < MOST_POSITIVE_FIXNUM) \
64 XSETFASTINT (METER_1 (this_code), \
65 XFASTINT (METER_1 (this_code)) + 1); \
67 && (XFASTINT (METER_2 (last_code, this_code)) \
68 < MOST_POSITIVE_FIXNUM)) \
69 XSETFASTINT (METER_2 (last_code, this_code), \
70 XFASTINT (METER_2 (last_code, this_code)) + 1); \
74 #endif /* BYTE_CODE_METER */
80 DEFINE (Bstack_ref, 0) /* Actually, Bstack_ref+0 is not implemented: use dup. */ \
81 DEFINE (Bstack_ref1, 1) \
82 DEFINE (Bstack_ref2, 2) \
83 DEFINE (Bstack_ref3, 3) \
84 DEFINE (Bstack_ref4, 4) \
85 DEFINE (Bstack_ref5, 5) \
86 DEFINE (Bstack_ref6, 6) \
87 DEFINE (Bstack_ref7, 7) \
88 DEFINE (Bvarref, 010) \
89 DEFINE (Bvarref1, 011) \
90 DEFINE (Bvarref2, 012) \
91 DEFINE (Bvarref3, 013) \
92 DEFINE (Bvarref4, 014) \
93 DEFINE (Bvarref5, 015) \
94 DEFINE (Bvarref6, 016) \
95 DEFINE (Bvarref7, 017) \
96 DEFINE (Bvarset, 020) \
97 DEFINE (Bvarset1, 021) \
98 DEFINE (Bvarset2, 022) \
99 DEFINE (Bvarset3, 023) \
100 DEFINE (Bvarset4, 024) \
101 DEFINE (Bvarset5, 025) \
102 DEFINE (Bvarset6, 026) \
103 DEFINE (Bvarset7, 027) \
104 DEFINE (Bvarbind, 030) \
105 DEFINE (Bvarbind1, 031) \
106 DEFINE (Bvarbind2, 032) \
107 DEFINE (Bvarbind3, 033) \
108 DEFINE (Bvarbind4, 034) \
109 DEFINE (Bvarbind5, 035) \
110 DEFINE (Bvarbind6, 036) \
111 DEFINE (Bvarbind7, 037) \
112 DEFINE (Bcall, 040) \
113 DEFINE (Bcall1, 041) \
114 DEFINE (Bcall2, 042) \
115 DEFINE (Bcall3, 043) \
116 DEFINE (Bcall4, 044) \
117 DEFINE (Bcall5, 045) \
118 DEFINE (Bcall6, 046) \
119 DEFINE (Bcall7, 047) \
120 DEFINE (Bunbind, 050) \
121 DEFINE (Bunbind1, 051) \
122 DEFINE (Bunbind2, 052) \
123 DEFINE (Bunbind3, 053) \
124 DEFINE (Bunbind4, 054) \
125 DEFINE (Bunbind5, 055) \
126 DEFINE (Bunbind6, 056) \
127 DEFINE (Bunbind7, 057) \
129 DEFINE (Bpophandler, 060) \
130 DEFINE (Bpushconditioncase, 061) \
131 DEFINE (Bpushcatch, 062) \
134 DEFINE (Bsymbolp, 071) \
135 DEFINE (Bconsp, 072) \
136 DEFINE (Bstringp, 073) \
137 DEFINE (Blistp, 074) \
139 DEFINE (Bmemq, 076) \
141 DEFINE (Bcar, 0100) \
142 DEFINE (Bcdr, 0101) \
143 DEFINE (Bcons, 0102) \
144 DEFINE (Blist1, 0103) \
145 DEFINE (Blist2, 0104) \
146 DEFINE (Blist3, 0105) \
147 DEFINE (Blist4, 0106) \
148 DEFINE (Blength, 0107) \
149 DEFINE (Baref, 0110) \
150 DEFINE (Baset, 0111) \
151 DEFINE (Bsymbol_value, 0112) \
152 DEFINE (Bsymbol_function, 0113) \
153 DEFINE (Bset, 0114) \
154 DEFINE (Bfset, 0115) \
155 DEFINE (Bget, 0116) \
156 DEFINE (Bsubstring, 0117) \
157 DEFINE (Bconcat2, 0120) \
158 DEFINE (Bconcat3, 0121) \
159 DEFINE (Bconcat4, 0122) \
160 DEFINE (Bsub1, 0123) \
161 DEFINE (Badd1, 0124) \
162 DEFINE (Beqlsign, 0125) \
163 DEFINE (Bgtr, 0126) \
164 DEFINE (Blss, 0127) \
165 DEFINE (Bleq, 0130) \
166 DEFINE (Bgeq, 0131) \
167 DEFINE (Bdiff, 0132) \
168 DEFINE (Bnegate, 0133) \
169 DEFINE (Bplus, 0134) \
170 DEFINE (Bmax, 0135) \
171 DEFINE (Bmin, 0136) \
172 DEFINE (Bmult, 0137) \
174 DEFINE (Bpoint, 0140) \
175 /* Was Bmark in v17. */ \
176 DEFINE (Bsave_current_buffer, 0141) /* Obsolete. */ \
177 DEFINE (Bgoto_char, 0142) \
178 DEFINE (Binsert, 0143) \
179 DEFINE (Bpoint_max, 0144) \
180 DEFINE (Bpoint_min, 0145) \
181 DEFINE (Bchar_after, 0146) \
182 DEFINE (Bfollowing_char, 0147) \
183 DEFINE (Bpreceding_char, 0150) \
184 DEFINE (Bcurrent_column, 0151) \
185 DEFINE (Bindent_to, 0152) \
186 DEFINE (Beolp, 0154) \
187 DEFINE (Beobp, 0155) \
188 DEFINE (Bbolp, 0156) \
189 DEFINE (Bbobp, 0157) \
190 DEFINE (Bcurrent_buffer, 0160) \
191 DEFINE (Bset_buffer, 0161) \
192 DEFINE (Bsave_current_buffer_1, 0162) /* Replacing Bsave_current_buffer. */ \
193 DEFINE (Binteractive_p, 0164) /* Obsolete since Emacs-24.1. */ \
195 DEFINE (Bforward_char, 0165) \
196 DEFINE (Bforward_word, 0166) \
197 DEFINE (Bskip_chars_forward, 0167) \
198 DEFINE (Bskip_chars_backward, 0170) \
199 DEFINE (Bforward_line, 0171) \
200 DEFINE (Bchar_syntax, 0172) \
201 DEFINE (Bbuffer_substring, 0173) \
202 DEFINE (Bdelete_region, 0174) \
203 DEFINE (Bnarrow_to_region, 0175) \
204 DEFINE (Bwiden, 0176) \
205 DEFINE (Bend_of_line, 0177) \
207 DEFINE (Bconstant2, 0201) \
208 DEFINE (Bgoto, 0202) \
209 DEFINE (Bgotoifnil, 0203) \
210 DEFINE (Bgotoifnonnil, 0204) \
211 DEFINE (Bgotoifnilelsepop, 0205) \
212 DEFINE (Bgotoifnonnilelsepop, 0206) \
213 DEFINE (Breturn, 0207) \
214 DEFINE (Bdiscard, 0210) \
215 DEFINE (Bdup, 0211) \
217 DEFINE (Bsave_excursion, 0212) \
218 DEFINE (Bsave_window_excursion, 0213) /* Obsolete since Emacs-24.1. */ \
219 DEFINE (Bsave_restriction, 0214) \
220 DEFINE (Bcatch, 0215) \
222 DEFINE (Bunwind_protect, 0216) \
223 DEFINE (Bcondition_case, 0217) \
224 DEFINE (Btemp_output_buffer_setup, 0220) /* Obsolete since Emacs-24.1. */ \
225 DEFINE (Btemp_output_buffer_show, 0221) /* Obsolete since Emacs-24.1. */ \
227 DEFINE (Bunbind_all, 0222) /* Obsolete. Never used. */ \
229 DEFINE (Bset_marker, 0223) \
230 DEFINE (Bmatch_beginning, 0224) \
231 DEFINE (Bmatch_end, 0225) \
232 DEFINE (Bupcase, 0226) \
233 DEFINE (Bdowncase, 0227) \
235 DEFINE (Bstringeqlsign, 0230) \
236 DEFINE (Bstringlss, 0231) \
237 DEFINE (Bequal, 0232) \
238 DEFINE (Bnthcdr, 0233) \
239 DEFINE (Belt, 0234) \
240 DEFINE (Bmember, 0235) \
241 DEFINE (Bassq, 0236) \
242 DEFINE (Bnreverse, 0237) \
243 DEFINE (Bsetcar, 0240) \
244 DEFINE (Bsetcdr, 0241) \
245 DEFINE (Bcar_safe, 0242) \
246 DEFINE (Bcdr_safe, 0243) \
247 DEFINE (Bnconc, 0244) \
248 DEFINE (Bquo, 0245) \
249 DEFINE (Brem, 0246) \
250 DEFINE (Bnumberp, 0247) \
251 DEFINE (Bintegerp, 0250) \
253 DEFINE (BRgoto, 0252) \
254 DEFINE (BRgotoifnil, 0253) \
255 DEFINE (BRgotoifnonnil, 0254) \
256 DEFINE (BRgotoifnilelsepop, 0255) \
257 DEFINE (BRgotoifnonnilelsepop, 0256) \
259 DEFINE (BlistN, 0257) \
260 DEFINE (BconcatN, 0260) \
261 DEFINE (BinsertN, 0261) \
263 /* Bstack_ref is code 0. */ \
264 DEFINE (Bstack_set, 0262) \
265 DEFINE (Bstack_set2, 0263) \
266 DEFINE (BdiscardN, 0266) \
268 DEFINE (Bconstant, 0300)
272 #define DEFINE(name, value) name = value,
276 #ifdef BYTE_CODE_SAFE
277 Bscan_buffer
= 0153, /* No longer generated as of v18. */
278 Bset_mark
= 0163, /* this loser is no longer generated as of v18 */
282 /* Structure describing a value stack used during byte-code execution
287 /* Program counter. This points into the byte_string below
288 and is relocated when that string is relocated. */
289 const unsigned char *pc
;
291 /* The string containing the byte-code, and its current address.
292 Storing this here protects it from GC. */
293 Lisp_Object byte_string
;
294 const unsigned char *byte_string_start
;
296 /* Next entry in byte_stack_list. */
297 struct byte_stack
*next
;
300 /* A list of currently active byte-code execution value stacks.
301 Fbyte_code adds an entry to the head of this list before it starts
302 processing byte-code, and it removes the entry again when it is
303 done. Signaling an error truncates the list. */
305 struct byte_stack
*byte_stack_list
;
308 /* Relocate program counters in the stacks on byte_stack_list. Called
309 when GC has completed. */
312 relocate_byte_stack (void)
314 struct byte_stack
*stack
;
316 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
318 if (stack
->byte_string_start
!= SDATA (stack
->byte_string
))
320 ptrdiff_t offset
= stack
->pc
- stack
->byte_string_start
;
321 stack
->byte_string_start
= SDATA (stack
->byte_string
);
322 stack
->pc
= stack
->byte_string_start
+ offset
;
328 /* Fetch the next byte from the bytecode stream. */
330 #ifdef BYTE_CODE_SAFE
331 #define FETCH (eassert (stack.byte_string_start == SDATA (stack.byte_string)), *stack.pc++)
333 #define FETCH *stack.pc++
336 /* Fetch two bytes from the bytecode stream and make a 16-bit number
339 #define FETCH2 (op = FETCH, op + (FETCH << 8))
341 /* Push X onto the execution stack. The expression X should not
342 contain TOP, to avoid competing side effects. */
344 #define PUSH(x) (*++top = (x))
346 /* Pop a value off the execution stack. */
350 /* Discard n values from the execution stack. */
352 #define DISCARD(n) (top -= (n))
354 /* Get the value which is at the top of the execution stack, but don't
359 /* Check for jumping out of range. */
361 #ifdef BYTE_CODE_SAFE
363 #define CHECK_RANGE(ARG) \
364 if (ARG >= bytestr_length) emacs_abort ()
366 #else /* not BYTE_CODE_SAFE */
368 #define CHECK_RANGE(ARG)
370 #endif /* not BYTE_CODE_SAFE */
372 /* A version of the QUIT macro which makes sure that the stack top is
373 set before signaling `quit'. */
375 #define BYTE_CODE_QUIT \
377 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
379 Lisp_Object flag = Vquit_flag; \
381 if (EQ (Vthrow_on_input, flag)) \
382 Fthrow (Vthrow_on_input, Qt); \
383 Fsignal (Qquit, Qnil); \
385 else if (pending_signals) \
386 process_pending_signals (); \
390 DEFUN ("byte-code", Fbyte_code
, Sbyte_code
, 3, 3, 0,
391 doc
: /* Function used internally in byte-compiled code.
392 The first argument, BYTESTR, is a string of byte code;
393 the second, VECTOR, a vector of constants;
394 the third, MAXDEPTH, the maximum stack depth used in this function.
395 If the third argument is incorrect, Emacs may crash. */)
396 (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
)
398 return exec_byte_code (bytestr
, vector
, maxdepth
, Qnil
, 0, NULL
);
402 bcall0 (Lisp_Object f
)
407 /* Execute the byte-code in BYTESTR. VECTOR is the constant vector, and
408 MAXDEPTH is the maximum stack depth used (if MAXDEPTH is incorrect,
409 emacs may crash!). If ARGS_TEMPLATE is non-nil, it should be a lisp
410 argument list (including &rest, &optional, etc.), and ARGS, of size
411 NARGS, should be a vector of the actual arguments. The arguments in
412 ARGS are pushed on the stack according to ARGS_TEMPLATE before
413 executing BYTESTR. */
416 exec_byte_code (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
,
417 Lisp_Object args_template
, ptrdiff_t nargs
, Lisp_Object
*args
)
419 ptrdiff_t count
= SPECPDL_INDEX ();
420 #ifdef BYTE_CODE_METER
421 int volatile this_op
= 0;
425 /* Lisp_Object v1, v2; */
426 Lisp_Object
*vectorp
;
427 #ifdef BYTE_CODE_SAFE
428 ptrdiff_t const_length
;
430 ptrdiff_t bytestr_length
;
432 struct byte_stack stack
;
435 enum handlertype type
;
437 CHECK_STRING (bytestr
);
438 CHECK_VECTOR (vector
);
439 CHECK_NATNUM (maxdepth
);
441 #ifdef BYTE_CODE_SAFE
442 const_length
= ASIZE (vector
);
445 if (STRING_MULTIBYTE (bytestr
))
446 /* BYTESTR must have been produced by Emacs 20.2 or the earlier
447 because they produced a raw 8-bit string for byte-code and now
448 such a byte-code string is loaded as multibyte while raw 8-bit
449 characters converted to multibyte form. Thus, now we must
450 convert them back to the originally intended unibyte form. */
451 bytestr
= Fstring_as_unibyte (bytestr
);
453 #ifdef BYTE_CODE_SAFE
454 bytestr_length
= SBYTES (bytestr
);
456 vectorp
= XVECTOR (vector
)->contents
;
458 stack
.byte_string
= bytestr
;
459 stack
.pc
= stack
.byte_string_start
= SDATA (bytestr
);
460 if (MAX_ALLOCA
/ word_size
<= XFASTINT (maxdepth
))
461 memory_full (SIZE_MAX
);
462 top
= alloca ((XFASTINT (maxdepth
) + 1) * sizeof *top
);
463 stack
.next
= byte_stack_list
;
464 byte_stack_list
= &stack
;
466 #ifdef BYTE_CODE_SAFE
467 stacke
= stack
.bottom
- 1 + XFASTINT (maxdepth
);
470 if (INTEGERP (args_template
))
472 ptrdiff_t at
= XINT (args_template
);
473 bool rest
= (at
& 128) != 0;
474 int mandatory
= at
& 127;
475 ptrdiff_t nonrest
= at
>> 8;
476 eassert (mandatory
<= nonrest
);
477 if (nargs
<= nonrest
)
480 for (i
= 0 ; i
< nargs
; i
++, args
++)
482 if (nargs
< mandatory
)
483 /* Too few arguments. */
484 Fsignal (Qwrong_number_of_arguments
,
485 list2 (Fcons (make_number (mandatory
),
486 rest
? Qand_rest
: make_number (nonrest
)),
487 make_number (nargs
)));
490 for (; i
< nonrest
; i
++)
499 for (i
= 0 ; i
< nonrest
; i
++, args
++)
501 PUSH (Flist (nargs
- nonrest
, args
));
504 /* Too many arguments. */
505 Fsignal (Qwrong_number_of_arguments
,
506 list2 (Fcons (make_number (mandatory
), make_number (nonrest
)),
507 make_number (nargs
)));
509 else if (! NILP (args_template
))
510 /* We should push some arguments on the stack. */
512 error ("Unknown args template!");
517 #ifdef BYTE_CODE_SAFE
520 else if (top
< stack
.bottom
- 1)
524 #ifdef BYTE_CODE_METER
526 this_op
= op
= FETCH
;
527 METER_CODE (prev_op
, op
);
529 #ifndef BYTE_CODE_THREADED
534 /* The interpreter can be compiled one of two ways: as an
535 ordinary switch-based interpreter, or as a threaded
536 interpreter. The threaded interpreter relies on GCC's
537 computed goto extension, so it is not available everywhere.
538 Threading provides a performance boost. These macros are how
539 we allow the code to be compiled both ways. */
540 #ifdef BYTE_CODE_THREADED
541 /* The CASE macro introduces an instruction's body. It is
542 either a label or a case label. */
543 #define CASE(OP) insn_ ## OP
544 /* NEXT is invoked at the end of an instruction to go to the
545 next instruction. It is either a computed goto, or a
547 #define NEXT goto *(targets[op = FETCH])
548 /* FIRST is like NEXT, but is only used at the start of the
549 interpreter body. In the switch-based interpreter it is the
550 switch, so the threaded definition must include a semicolon. */
552 /* Most cases are labeled with the CASE macro, above.
553 CASE_DEFAULT is one exception; it is used if the interpreter
554 being built requires a default case. The threaded
555 interpreter does not, because the dispatch table is
556 completely filled. */
558 /* This introduces an instruction that is known to call abort. */
559 #define CASE_ABORT CASE (Bstack_ref): CASE (default)
561 /* See above for the meaning of the various defines. */
562 #define CASE(OP) case OP
564 #define FIRST switch (op)
565 #define CASE_DEFAULT case 255: default:
566 #define CASE_ABORT case 0
569 #ifdef BYTE_CODE_THREADED
571 /* A convenience define that saves us a lot of typing and makes
572 the table clearer. */
573 #define LABEL(OP) [OP] = &&insn_ ## OP
575 #if GNUC_PREREQ (4, 6, 0)
576 # pragma GCC diagnostic push
577 # pragma GCC diagnostic ignored "-Woverride-init"
578 #elif defined __clang__
579 # pragma GCC diagnostic push
580 # pragma GCC diagnostic ignored "-Winitializer-overrides"
583 /* This is the dispatch table for the threaded interpreter. */
584 static const void *const targets
[256] =
586 [0 ... (Bconstant
- 1)] = &&insn_default
,
587 [Bconstant
... 255] = &&insn_Bconstant
,
589 #define DEFINE(name, value) LABEL (name) ,
594 #if GNUC_PREREQ (4, 6, 0) || defined __clang__
595 # pragma GCC diagnostic pop
616 /* This seems to be the most frequently executed byte-code
617 among the Bvarref's, so avoid a goto here. */
627 if (XSYMBOL (v1
)->redirect
!= SYMBOL_PLAINVAL
628 || (v2
= SYMBOL_VAL (XSYMBOL (v1
)),
631 v2
= Fsymbol_value (v1
);
636 v2
= Fsymbol_value (v1
);
652 stack
.pc
= stack
.byte_string_start
+ op
;
667 wrong_type_argument (Qlistp
, v1
);
676 TOP
= EQ (v1
, TOP
) ? Qt
: Qnil
;
684 TOP
= Fmemq (TOP
, v1
);
698 wrong_type_argument (Qlistp
, v1
);
720 Lisp_Object sym
, val
;
725 /* Inline the most common case. */
727 && !EQ (val
, Qunbound
)
728 && !XSYMBOL (sym
)->redirect
729 && !SYMBOL_CONSTANT_P (sym
))
730 SET_SYMBOL_VAL (XSYMBOL (sym
), val
);
733 set_internal (sym
, val
, Qnil
, 0);
747 /* ------------------ */
765 /* Specbind can signal and thus GC. */
766 specbind (vectorp
[op
], POP
);
787 #ifdef BYTE_CODE_METER
788 if (byte_metering_on
&& SYMBOLP (TOP
))
793 v2
= Fget (v1
, Qbyte_code_meter
);
795 && XINT (v2
) < MOST_POSITIVE_FIXNUM
)
797 XSETINT (v2
, XINT (v2
) + 1);
798 Fput (v1
, Qbyte_code_meter
, v2
);
802 TOP
= Ffuncall (op
+ 1, &TOP
);
822 unbind_to (SPECPDL_INDEX () - op
, Qnil
);
825 CASE (Bunbind_all
): /* Obsolete. Never used. */
826 /* To unbind back to the beginning of this frame. Not used yet,
827 but will be needed for tail-recursion elimination. */
828 unbind_to (count
, Qnil
);
834 op
= FETCH2
; /* pc = FETCH2 loses since FETCH2 contains pc++ */
836 stack
.pc
= stack
.byte_string_start
+ op
;
839 CASE (Bgotoifnonnil
):
849 stack
.pc
= stack
.byte_string_start
+ op
;
854 CASE (Bgotoifnilelsepop
):
861 stack
.pc
= stack
.byte_string_start
+ op
;
866 CASE (Bgotoifnonnilelsepop
):
873 stack
.pc
= stack
.byte_string_start
+ op
;
881 stack
.pc
+= (int) *stack
.pc
- 127;
892 stack
.pc
+= (int) *stack
.pc
- 128;
898 CASE (BRgotoifnonnil
):
906 stack
.pc
+= (int) *stack
.pc
- 128;
912 CASE (BRgotoifnilelsepop
):
918 stack
.pc
+= op
- 128;
923 CASE (BRgotoifnonnilelsepop
):
929 stack
.pc
+= op
- 128;
943 PUSH (vectorp
[FETCH2
]);
946 CASE (Bsave_excursion
):
947 record_unwind_protect (save_excursion_restore
,
948 save_excursion_save ());
951 CASE (Bsave_current_buffer
): /* Obsolete since ??. */
952 CASE (Bsave_current_buffer_1
):
953 record_unwind_current_buffer ();
956 CASE (Bsave_window_excursion
): /* Obsolete since 24.1. */
958 ptrdiff_t count1
= SPECPDL_INDEX ();
959 record_unwind_protect (restore_window_configuration
,
960 Fcurrent_window_configuration (Qnil
));
962 unbind_to (count1
, TOP
);
966 CASE (Bsave_restriction
):
967 record_unwind_protect (save_restriction_restore
,
968 save_restriction_save ());
971 CASE (Bcatch
): /* Obsolete since 24.4. */
975 TOP
= internal_catch (TOP
, eval_sub
, v1
);
979 CASE (Bpushcatch
): /* New in 24.4. */
982 CASE (Bpushconditioncase
): /* New in 24.4. */
983 type
= CONDITION_CASE
;
986 Lisp_Object tag
= POP
;
989 struct handler
*c
= push_handler (tag
, type
);
990 c
->bytecode_dest
= dest
;
991 c
->bytecode_top
= top
;
993 if (sys_setjmp (c
->jmp
))
995 struct handler
*c
= handlerlist
;
997 top
= c
->bytecode_top
;
998 dest
= c
->bytecode_dest
;
999 handlerlist
= c
->next
;
1002 /* Might have been re-set by longjmp! */
1003 stack
.byte_string_start
= SDATA (stack
.byte_string
);
1004 stack
.pc
= stack
.byte_string_start
+ dest
;
1010 CASE (Bpophandler
): /* New in 24.4. */
1012 handlerlist
= handlerlist
->next
;
1016 CASE (Bunwind_protect
): /* FIXME: avoid closure for lexbind. */
1018 Lisp_Object handler
= POP
;
1019 /* Support for a function here is new in 24.4. */
1020 record_unwind_protect (NILP (Ffunctionp (handler
))
1021 ? unwind_body
: bcall0
,
1026 CASE (Bcondition_case
): /* Obsolete since 24.4. */
1028 Lisp_Object handlers
, body
;
1031 TOP
= internal_lisp_condition_case (TOP
, body
, handlers
);
1035 CASE (Btemp_output_buffer_setup
): /* Obsolete since 24.1. */
1037 temp_output_buffer_setup (SSDATA (TOP
));
1038 TOP
= Vstandard_output
;
1041 CASE (Btemp_output_buffer_show
): /* Obsolete since 24.1. */
1045 temp_output_buffer_show (TOP
);
1047 /* pop binding of standard-output */
1048 unbind_to (SPECPDL_INDEX () - 1, Qnil
);
1061 while (--n
>= 0 && CONSP (v1
))
1069 TOP
= SYMBOLP (TOP
) ? Qt
: Qnil
;
1073 TOP
= CONSP (TOP
) ? Qt
: Qnil
;
1077 TOP
= STRINGP (TOP
) ? Qt
: Qnil
;
1081 TOP
= CONSP (TOP
) || NILP (TOP
) ? Qt
: Qnil
;
1085 TOP
= NILP (TOP
) ? Qt
: Qnil
;
1092 TOP
= Fcons (TOP
, v1
);
1104 TOP
= list2 (TOP
, v1
);
1110 TOP
= Flist (3, &TOP
);
1115 TOP
= Flist (4, &TOP
);
1121 TOP
= Flist (op
, &TOP
);
1125 TOP
= Flength (TOP
);
1132 TOP
= Faref (TOP
, v1
);
1140 TOP
= Faset (TOP
, v1
, v2
);
1144 CASE (Bsymbol_value
):
1145 TOP
= Fsymbol_value (TOP
);
1148 CASE (Bsymbol_function
):
1149 TOP
= Fsymbol_function (TOP
);
1156 TOP
= Fset (TOP
, v1
);
1164 TOP
= Ffset (TOP
, v1
);
1172 TOP
= Fget (TOP
, v1
);
1180 TOP
= Fsubstring (TOP
, v1
, v2
);
1186 TOP
= Fconcat (2, &TOP
);
1191 TOP
= Fconcat (3, &TOP
);
1196 TOP
= Fconcat (4, &TOP
);
1202 TOP
= Fconcat (op
, &TOP
);
1211 XSETINT (v1
, XINT (v1
) - 1);
1227 XSETINT (v1
, XINT (v1
) + 1);
1241 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v1
);
1242 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v2
);
1243 if (FLOATP (v1
) || FLOATP (v2
))
1247 f1
= (FLOATP (v1
) ? XFLOAT_DATA (v1
) : XINT (v1
));
1248 f2
= (FLOATP (v2
) ? XFLOAT_DATA (v2
) : XINT (v2
));
1249 TOP
= (f1
== f2
? Qt
: Qnil
);
1252 TOP
= (XINT (v1
) == XINT (v2
) ? Qt
: Qnil
);
1260 TOP
= arithcompare (TOP
, v1
, ARITH_GRTR
);
1268 TOP
= arithcompare (TOP
, v1
, ARITH_LESS
);
1276 TOP
= arithcompare (TOP
, v1
, ARITH_LESS_OR_EQUAL
);
1284 TOP
= arithcompare (TOP
, v1
, ARITH_GRTR_OR_EQUAL
);
1290 TOP
= Fminus (2, &TOP
);
1299 XSETINT (v1
, - XINT (v1
));
1304 TOP
= Fminus (1, &TOP
);
1311 TOP
= Fplus (2, &TOP
);
1316 TOP
= Fmax (2, &TOP
);
1321 TOP
= Fmin (2, &TOP
);
1326 TOP
= Ftimes (2, &TOP
);
1331 TOP
= Fquo (2, &TOP
);
1338 TOP
= Frem (TOP
, v1
);
1345 XSETFASTINT (v1
, PT
);
1351 TOP
= Fgoto_char (TOP
);
1355 TOP
= Finsert (1, &TOP
);
1361 TOP
= Finsert (op
, &TOP
);
1367 XSETFASTINT (v1
, ZV
);
1375 XSETFASTINT (v1
, BEGV
);
1381 TOP
= Fchar_after (TOP
);
1384 CASE (Bfollowing_char
):
1387 v1
= Ffollowing_char ();
1392 CASE (Bpreceding_char
):
1395 v1
= Fprevious_char ();
1400 CASE (Bcurrent_column
):
1403 XSETFASTINT (v1
, current_column ());
1409 TOP
= Findent_to (TOP
, Qnil
);
1428 CASE (Bcurrent_buffer
):
1429 PUSH (Fcurrent_buffer ());
1433 TOP
= Fset_buffer (TOP
);
1436 CASE (Binteractive_p
): /* Obsolete since 24.1. */
1437 PUSH (call0 (intern ("interactive-p")));
1440 CASE (Bforward_char
):
1441 TOP
= Fforward_char (TOP
);
1444 CASE (Bforward_word
):
1445 TOP
= Fforward_word (TOP
);
1448 CASE (Bskip_chars_forward
):
1452 TOP
= Fskip_chars_forward (TOP
, v1
);
1456 CASE (Bskip_chars_backward
):
1460 TOP
= Fskip_chars_backward (TOP
, v1
);
1464 CASE (Bforward_line
):
1465 TOP
= Fforward_line (TOP
);
1468 CASE (Bchar_syntax
):
1472 CHECK_CHARACTER (TOP
);
1474 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1475 MAKE_CHAR_MULTIBYTE (c
);
1476 XSETFASTINT (TOP
, syntax_code_spec
[SYNTAX (c
)]);
1480 CASE (Bbuffer_substring
):
1484 TOP
= Fbuffer_substring (TOP
, v1
);
1488 CASE (Bdelete_region
):
1492 TOP
= Fdelete_region (TOP
, v1
);
1496 CASE (Bnarrow_to_region
):
1500 TOP
= Fnarrow_to_region (TOP
, v1
);
1508 CASE (Bend_of_line
):
1509 TOP
= Fend_of_line (TOP
);
1517 TOP
= Fset_marker (TOP
, v2
, v1
);
1521 CASE (Bmatch_beginning
):
1522 TOP
= Fmatch_beginning (TOP
);
1526 TOP
= Fmatch_end (TOP
);
1530 TOP
= Fupcase (TOP
);
1534 TOP
= Fdowncase (TOP
);
1537 CASE (Bstringeqlsign
):
1541 TOP
= Fstring_equal (TOP
, v1
);
1549 TOP
= Fstring_lessp (TOP
, v1
);
1557 TOP
= Fequal (TOP
, v1
);
1565 TOP
= Fnthcdr (TOP
, v1
);
1574 /* Exchange args and then do nth. */
1581 while (--n
>= 0 && CONSP (v1
))
1589 TOP
= Felt (TOP
, v1
);
1598 TOP
= Fmember (TOP
, v1
);
1606 TOP
= Fassq (TOP
, v1
);
1611 TOP
= Fnreverse (TOP
);
1618 TOP
= Fsetcar (TOP
, v1
);
1626 TOP
= Fsetcdr (TOP
, v1
);
1634 TOP
= CAR_SAFE (v1
);
1642 TOP
= CDR_SAFE (v1
);
1648 TOP
= Fnconc (2, &TOP
);
1652 TOP
= (NUMBERP (TOP
) ? Qt
: Qnil
);
1656 TOP
= INTEGERP (TOP
) ? Qt
: Qnil
;
1659 #ifdef BYTE_CODE_SAFE
1660 /* These are intentionally written using 'case' syntax,
1661 because they are incompatible with the threaded
1665 error ("set-mark is an obsolete bytecode");
1668 error ("scan-buffer is an obsolete bytecode");
1673 /* Actually this is Bstack_ref with offset 0, but we use Bdup
1674 for that instead. */
1675 /* CASE (Bstack_ref): */
1677 build_string ("Invalid byte opcode: op=%s, ptr=%d"),
1679 make_number ((stack
.pc
- 1) - stack
.byte_string_start
));
1681 /* Handy byte-codes for lexical binding. */
1688 Lisp_Object
*ptr
= top
- (op
- Bstack_ref
);
1694 Lisp_Object
*ptr
= top
- (FETCH
);
1700 Lisp_Object
*ptr
= top
- (FETCH2
);
1705 /* stack-set-0 = discard; stack-set-1 = discard-1-preserve-tos. */
1707 Lisp_Object
*ptr
= top
- (FETCH
);
1713 Lisp_Object
*ptr
= top
- (FETCH2
);
1729 #ifdef BYTE_CODE_SAFE
1734 if ((op
-= Bconstant
) >= const_length
)
1740 PUSH (vectorp
[op
- Bconstant
]);
1748 byte_stack_list
= byte_stack_list
->next
;
1750 /* Binds and unbinds are supposed to be compiled balanced. */
1751 if (SPECPDL_INDEX () != count
)
1753 if (SPECPDL_INDEX () > count
)
1754 unbind_to (count
, Qnil
);
1755 error ("binding stack not balanced (serious byte compiler bug)");
1761 /* `args_template' has the same meaning as in exec_byte_code() above. */
1763 get_byte_code_arity (Lisp_Object args_template
)
1765 eassert (NATNUMP (args_template
));
1766 EMACS_INT at
= XINT (args_template
);
1767 bool rest
= (at
& 128) != 0;
1768 int mandatory
= at
& 127;
1769 EMACS_INT nonrest
= at
>> 8;
1771 return Fcons (make_number (mandatory
),
1772 rest
? Qmany
: make_number (nonrest
));
1776 syms_of_bytecode (void)
1778 defsubr (&Sbyte_code
);
1780 #ifdef BYTE_CODE_METER
1782 DEFVAR_LISP ("byte-code-meter", Vbyte_code_meter
,
1783 doc
: /* A vector of vectors which holds a histogram of byte-code usage.
1784 \(aref (aref byte-code-meter 0) CODE) indicates how many times the byte
1785 opcode CODE has been executed.
1786 \(aref (aref byte-code-meter CODE1) CODE2), where CODE1 is not 0,
1787 indicates how many times the byte opcodes CODE1 and CODE2 have been
1788 executed in succession. */);
1790 DEFVAR_BOOL ("byte-metering-on", byte_metering_on
,
1791 doc
: /* If non-nil, keep profiling information on byte code usage.
1792 The variable byte-code-meter indicates how often each byte opcode is used.
1793 If a symbol has a property named `byte-code-meter' whose value is an
1794 integer, it is incremented each time that symbol's function is called. */);
1796 byte_metering_on
= 0;
1797 Vbyte_code_meter
= Fmake_vector (make_number (256), make_number (0));
1798 DEFSYM (Qbyte_code_meter
, "byte-code-meter");
1802 ASET (Vbyte_code_meter
, i
,
1803 Fmake_vector (make_number (256), make_number (0)));