This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Make entertry a LOGOP, not BASEOP/UNOP
[perl5.git] / regen / opcode.pl
CommitLineData
d6480c9d 1#!/usr/bin/perl -w
6294c161
DM
2#
3# Regenerate (overwriting only if changed):
4#
5# opcode.h
6# opnames.h
6294c161
DM
7# pp.sym
8#
9# from information stored in the DATA section of this file, plus the
10# values hardcoded into this script in @raw_alias.
11#
12# Accepts the standard regen_lib -q and -v args.
13#
14# This script is normally invoked from regen.pl.
15
d6480c9d
NC
16use strict;
17
36bb303b
NC
18BEGIN {
19 # Get function prototypes
af001346 20 require 'regen/regen_lib.pl';
36bb303b 21}
79072805 22
d6480c9d
NC
23my $opcode_new = 'opcode.h-new';
24my $opname_new = 'opnames.h-new';
424a4936
NC
25my $oc = safer_open($opcode_new);
26my $on = safer_open($opname_new);
27select $oc;
79072805
LW
28
29# Read data.
30
d6480c9d 31my %seen;
e71197e2 32my (@ops, %desc, %check, %ckname, %flags, %args, %opnum);
d6480c9d 33
79072805
LW
34while (<DATA>) {
35 chop;
36 next unless $_;
37 next if /^#/;
d6480c9d
NC
38 my ($key, $desc, $check, $flags, $args) = split(/\t+/, $_, 5);
39 $args = '' unless defined $args;
c07a80fd 40
6342d5c5
FC
41 warn qq[Description "$desc" duplicates $seen{$desc}\n]
42 if $seen{$desc} and $key ne "transr";
c07a80fd
PP
43 die qq[Opcode "$key" duplicates $seen{$key}\n] if $seen{$key};
44 $seen{$desc} = qq[description of opcode "$key"];
45 $seen{$key} = qq[opcode "$key"];
46
79072805 47 push(@ops, $key);
e71197e2 48 $opnum{$key} = $#ops;
c07a80fd 49 $desc{$key} = $desc;
79072805
LW
50 $check{$key} = $check;
51 $ckname{$check}++;
52 $flags{$key} = $flags;
53 $args{$key} = $args;
54}
55
1d5774de
NC
56# Set up aliases
57
58my %alias;
59
60# Format is "this function" => "does these op names"
61my @raw_alias = (
6faeeb49 62 Perl_do_kv => [qw( keys values )],
d83386fa 63 Perl_unimplemented_op => [qw(padany mapstart custom)],
0b612f93
NC
64 # All the ops with a body of { return NORMAL; }
65 Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
66
67 Perl_pp_goto => ['dump'],
68 Perl_pp_require => ['dofile'],
69 Perl_pp_untie => ['dbmclose'],
70 Perl_pp_sysread => [qw(read recv)],
71 Perl_pp_sysseek => ['seek'],
72 Perl_pp_ioctl => ['fcntl'],
73 Perl_pp_ssockopt => ['gsockopt'],
74 Perl_pp_getpeername => ['getsockname'],
75 Perl_pp_stat => ['lstat'],
f1cb2d48 76 Perl_pp_ftrowned => [qw(fteowned ftzero ftsock ftchr ftblk
17ad201a
NC
77 ftfile ftdir ftpipe ftsuid ftsgid
78 ftsvtx)],
0b612f93
NC
79 Perl_pp_fttext => ['ftbinary'],
80 Perl_pp_gmtime => ['localtime'],
81 Perl_pp_semget => [qw(shmget msgget)],
82 Perl_pp_semctl => [qw(shmctl msgctl)],
0b612f93
NC
83 Perl_pp_ghostent => [qw(ghbyname ghbyaddr)],
84 Perl_pp_gnetent => [qw(gnbyname gnbyaddr)],
85 Perl_pp_gprotoent => [qw(gpbyname gpbynumber)],
86 Perl_pp_gservent => [qw(gsbyname gsbyport)],
87 Perl_pp_gpwent => [qw(gpwnam gpwuid)],
88 Perl_pp_ggrent => [qw(ggrnam ggrgid)],
957b0e1d 89 Perl_pp_ftis => [qw(ftsize ftmtime ftatime ftctime)],
605b9385 90 Perl_pp_chown => [qw(unlink chmod utime kill)],
ce6987d0 91 Perl_pp_link => ['symlink'],
af9e49b4
NC
92 Perl_pp_ftrread => [qw(ftrwrite ftrexec fteread ftewrite
93 fteexec)],
ca563b4e 94 Perl_pp_shmwrite => [qw(shmread msgsnd msgrcv semop)],
64a1bc8e 95 Perl_pp_send => ['syswrite'],
c960fc3b 96 Perl_pp_defined => [qw(dor dorassign)],
62726f23
SP
97 Perl_pp_and => ['andassign'],
98 Perl_pp_or => ['orassign'],
12e9c124 99 Perl_pp_ucfirst => ['lcfirst'],
afd9910b 100 Perl_pp_sle => [qw(slt sgt sge)],
0d863452 101 Perl_pp_print => ['say'],
2723d216 102 Perl_pp_index => ['rindex'],
daa2adfd 103 Perl_pp_oct => ['hex'],
789b4bc9 104 Perl_pp_shift => ['pop'],
71302fe3 105 Perl_pp_sin => [qw(cos exp log sqrt)],
3658c1f1 106 Perl_pp_bit_or => ['bit_xor'],
17ab7946 107 Perl_pp_rv2av => ['rv2hv'],
878d132a 108 Perl_pp_akeys => ['avalues'],
cba5a3b0 109 Perl_pp_rkeys => [qw(rvalues reach)],
6342d5c5 110 Perl_pp_trans => [qw(trans transr)],
605b9385 111 );
1d5774de
NC
112
113while (my ($func, $names) = splice @raw_alias, 0, 2) {
916e4025
NC
114 foreach (@$names) {
115 $alias{$_} = $func;
116 }
1d5774de
NC
117}
118
79072805
LW
119# Emit defines.
120
748a9306 121print <<"END";
37442d52
RGS
122/* -*- buffer-read-only: t -*-
123 *
d6376244
JH
124 * opcode.h
125 *
699a97de
RGS
126 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
127 * 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
d6376244
JH
128 *
129 * You may distribute under the terms of either the GNU General Public
130 * License or the Artistic License, as specified in the README file.
131 *
132 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
d006332c
FC
133 * This file is built by regen/opcode.pl from its data. Any changes made
134 * here will be lost!
d6376244 135 */
a27f85b3 136
27da23d5
JH
137#ifndef PERL_GLOBAL_STRUCT_INIT
138
864dbfa3
GS
139#define Perl_pp_i_preinc Perl_pp_preinc
140#define Perl_pp_i_predec Perl_pp_predec
141#define Perl_pp_i_postinc Perl_pp_postinc
142#define Perl_pp_i_postdec Perl_pp_postdec
748a9306 143
65bca31a
NC
144PERL_PPDEF(Perl_unimplemented_op)
145
748a9306 146END
abdd5c84 147
424a4936 148print $on <<"END";
37442d52
RGS
149/* -*- buffer-read-only: t -*-
150 *
d6376244
JH
151 * opnames.h
152 *
cfc85103 153 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
e8e5c75e 154 * 2007, 2008 by Larry Wall and others
d6376244
JH
155 *
156 * You may distribute under the terms of either the GNU General Public
157 * License or the Artistic License, as specified in the README file.
158 *
159 *
160 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
d006332c
FC
161 * This file is built by regen/opcode.pl from its data. Any changes made
162 * here will be lost!
d6376244 163 */
abdd5c84
GS
164
165typedef enum opcode {
166END
167
d6480c9d 168my $i = 0;
79072805 169for (@ops) {
424a4936
NC
170 # print $on "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
171 print $on "\t", &tab(3,"OP_\U$_"), " = ", $i++, ",\n";
79072805 172}
424a4936
NC
173print $on "\t", &tab(3,"OP_max"), "\n";
174print $on "} opcode;\n";
175print $on "\n#define MAXO ", scalar @ops, "\n";
176print $on "#define OP_phoney_INPUT_ONLY -1\n";
177print $on "#define OP_phoney_OUTPUT_ONLY -2\n\n";
79072805 178
c07a80fd 179# Emit op names and descriptions.
79072805
LW
180
181print <<END;
73c4f7a1
GS
182START_EXTERN_C
183
79072805 184#ifndef DOINIT
27da23d5 185EXTCONST char* const PL_op_name[];
79072805 186#else
27da23d5 187EXTCONST char* const PL_op_name[] = {
79072805
LW
188END
189
190for (@ops) {
c07a80fd
PP
191 print qq(\t"$_",\n);
192}
193
194print <<END;
195};
196#endif
197
198END
199
200print <<END;
201#ifndef DOINIT
27da23d5 202EXTCONST char* const PL_op_desc[];
c07a80fd 203#else
27da23d5 204EXTCONST char* const PL_op_desc[] = {
c07a80fd
PP
205END
206
207for (@ops) {
42d38218
MS
208 my($safe_desc) = $desc{$_};
209
a567e93b 210 # Have to escape double quotes and escape characters.
b0c6325e 211 $safe_desc =~ s/([\\"])/\\$1/g;
42d38218
MS
212
213 print qq(\t"$safe_desc",\n);
79072805
LW
214}
215
216print <<END;
217};
218#endif
219
73c4f7a1
GS
220END_EXTERN_C
221
27da23d5 222#endif /* !PERL_GLOBAL_STRUCT_INIT */
22c35a8c 223END
79072805 224
22c35a8c 225# Emit function declarations.
79072805 226
22c35a8c 227#for (sort keys %ckname) {
cea2e8a9 228# print "OP *\t", &tab(3,$_),"(pTHX_ OP* o);\n";
22c35a8c
GS
229#}
230#
231#print "\n";
232#
233#for (@ops) {
cea2e8a9 234# print "OP *\t", &tab(3, "pp_$_"), "(pTHX);\n";
22c35a8c 235#}
79072805
LW
236
237# Emit ppcode switch array.
238
239print <<END;
240
73c4f7a1
GS
241START_EXTERN_C
242
27da23d5 243#ifdef PERL_GLOBAL_STRUCT_INIT
97aff369 244# define PERL_PPADDR_INITED
27da23d5 245static const Perl_ppaddr_t Gppaddr[]
79072805 246#else
27da23d5 247# ifndef PERL_GLOBAL_STRUCT
97aff369 248# define PERL_PPADDR_INITED
27da23d5
JH
249EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
250# endif
251#endif /* PERL_GLOBAL_STRUCT */
252#if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
97aff369 253# define PERL_PPADDR_INITED
27da23d5 254= {
79072805
LW
255END
256
257for (@ops) {
6faeeb49 258 if (my $name = $alias{$_}) {
ef69c8fc 259 print "\t$name,\t/* Perl_pp_$_ */\n";
6faeeb49
MB
260 }
261 else {
ef69c8fc 262 print "\tPerl_pp_$_,\n";
6faeeb49 263 }
79072805
LW
264}
265
266print <<END;
27da23d5 267}
79072805 268#endif
97aff369 269#ifdef PERL_PPADDR_INITED
27da23d5 270;
97aff369 271#endif
79072805
LW
272
273END
274
275# Emit check routines.
276
277print <<END;
27da23d5 278#ifdef PERL_GLOBAL_STRUCT_INIT
97aff369 279# define PERL_CHECK_INITED
27da23d5 280static const Perl_check_t Gcheck[]
79072805 281#else
27da23d5 282# ifndef PERL_GLOBAL_STRUCT
97aff369 283# define PERL_CHECK_INITED
27da23d5
JH
284EXT Perl_check_t PL_check[] /* or perlvars.h */
285# endif
286#endif
287#if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
97aff369 288# define PERL_CHECK_INITED
27da23d5 289= {
79072805
LW
290END
291
292for (@ops) {
ef69c8fc 293 print "\t", &tab(3, "Perl_$check{$_},"), "\t/* $_ */\n";
79072805
LW
294}
295
296print <<END;
27da23d5 297}
79072805 298#endif
97aff369 299#ifdef PERL_CHECK_INITED
27da23d5 300;
97aff369 301#endif /* #ifdef PERL_CHECK_INITED */
79072805
LW
302
303END
304
305# Emit allowed argument types.
306
c2dedb93
MHM
307my $ARGBITS = 32;
308
79072805 309print <<END;
27da23d5
JH
310#ifndef PERL_GLOBAL_STRUCT_INIT
311
79072805 312#ifndef DOINIT
1ccb7c8d 313EXTCONST U32 PL_opargs[];
79072805 314#else
1ccb7c8d 315EXTCONST U32 PL_opargs[] = {
79072805
LW
316END
317
d6480c9d
NC
318my %argnum = (
319 'S', 1, # scalar
320 'L', 2, # list
321 'A', 3, # array value
322 'H', 4, # hash value
323 'C', 5, # code value
324 'F', 6, # file value
325 'R', 7, # scalar reference
79072805
LW
326);
327
d6480c9d 328my %opclass = (
db173bac
MB
329 '0', 0, # baseop
330 '1', 1, # unop
331 '2', 2, # binop
332 '|', 3, # logop
1a67a97c
SM
333 '@', 4, # listop
334 '/', 5, # pmop
350de78d 335 '$', 6, # svop_or_padop
7934575e 336 '#', 7, # padop
1a67a97c
SM
337 '"', 8, # pvop_or_svop
338 '{', 9, # loop
339 ';', 10, # cop
340 '%', 11, # baseop_or_unop
341 '-', 12, # filestatop
342 '}', 13, # loopexop
db173bac
MB
343);
344
c2dedb93
MHM
345my %opflags = (
346 'm' => 1, # needs stack mark
347 'f' => 2, # fold constants
348 's' => 4, # always produces scalar
349 't' => 8, # needs target scalar
903fd87c
NC
350 'T' => 8 | 16, # ... which may be lexical
351 'i' => 0, # always produces integer (unused since e7311069)
c2dedb93
MHM
352 'I' => 32, # has corresponding int op
353 'd' => 64, # danger, unknown side effects
354 'u' => 128, # defaults to $_
355);
356
a85d93d9
JH
357my %OP_IS_SOCKET;
358my %OP_IS_FILETEST;
6ecf81d6 359my %OP_IS_FT_ACCESS;
903fd87c
NC
360my $OCSHIFT = 8;
361my $OASHIFT = 12;
a85d93d9 362
c2dedb93 363for my $op (@ops) {
d6480c9d 364 my $argsum = 0;
c2dedb93
MHM
365 my $flags = $flags{$op};
366 for my $flag (keys %opflags) {
367 if ($flags =~ s/$flag//) {
cb7b5e07 368 die "Flag collision for '$op' ($flags{$op}, $flag)\n"
c2dedb93
MHM
369 if $argsum & $opflags{$flag};
370 $argsum |= $opflags{$flag};
371 }
372 }
cb7b5e07 373 die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)\n]
c2dedb93
MHM
374 unless exists $opclass{$flags};
375 $argsum |= $opclass{$flags} << $OCSHIFT;
376 my $argshift = $OASHIFT;
377 for my $arg (split(' ',$args{$op})) {
a85d93d9 378 if ($arg =~ /^F/) {
e71197e2
JC
379 # record opnums of these opnames
380 $OP_IS_SOCKET{$op} = $opnum{$op} if $arg =~ s/s//;
381 $OP_IS_FILETEST{$op} = $opnum{$op} if $arg =~ s/-//;
6ecf81d6 382 $OP_IS_FT_ACCESS{$op} = $opnum{$op} if $arg =~ s/\+//;
a85d93d9 383 }
d6480c9d 384 my $argnum = ($arg =~ s/\?//) ? 8 : 0;
c2dedb93
MHM
385 die "op = $op, arg = $arg\n"
386 unless exists $argnum{$arg};
79072805 387 $argnum += $argnum{$arg};
c2dedb93
MHM
388 die "Argument overflow for '$op'\n"
389 if $argshift >= $ARGBITS ||
390 $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
391 $argsum += $argnum << $argshift;
392 $argshift += 4;
79072805
LW
393 }
394 $argsum = sprintf("0x%08x", $argsum);
c2dedb93 395 print "\t", &tab(3, "$argsum,"), "/* $op */\n";
79072805
LW
396}
397
398print <<END;
399};
400#endif
73c4f7a1 401
bae1192d
JH
402#endif /* !PERL_GLOBAL_STRUCT_INIT */
403
73c4f7a1 404END_EXTERN_C
27da23d5 405
79072805
LW
406END
407
e71197e2
JC
408# Emit OP_IS_* macros
409
424a4936 410print $on <<EO_OP_IS_COMMENT;
e71197e2
JC
411
412/* the OP_IS_(SOCKET|FILETEST) macros are optimized to a simple range
413 check because all the member OPs are contiguous in opcode.pl
414 <DATA> table. opcode.pl verifies the range contiguity. */
415
416EO_OP_IS_COMMENT
417
418gen_op_is_macro( \%OP_IS_SOCKET, 'OP_IS_SOCKET');
419gen_op_is_macro( \%OP_IS_FILETEST, 'OP_IS_FILETEST');
6ecf81d6 420gen_op_is_macro( \%OP_IS_FT_ACCESS, 'OP_IS_FILETEST_ACCESS');
e71197e2
JC
421
422sub gen_op_is_macro {
423 my ($op_is, $macname) = @_;
424 if (keys %$op_is) {
425
426 # get opnames whose numbers are lowest and highest
427 my ($first, @rest) = sort {
428 $op_is->{$a} <=> $op_is->{$b}
429 } keys %$op_is;
430
431 my $last = pop @rest; # @rest slurped, get its last
cb7b5e07 432 die "Invalid range of ops: $first .. $last\n" unless $last;
6ecf81d6 433
424a4936 434 print $on "#define $macname(op) \\\n\t(";
6ecf81d6 435
e71197e2
JC
436 # verify that op-ct matches 1st..last range (and fencepost)
437 # (we know there are no dups)
438 if ( $op_is->{$last} - $op_is->{$first} == scalar @rest + 1) {
439
440 # contiguous ops -> optimized version
424a4936
NC
441 print $on "(op) >= OP_" . uc($first) . " && (op) <= OP_" . uc($last);
442 print $on ")\n\n";
e71197e2
JC
443 }
444 else {
424a4936 445 print $on join(" || \\\n\t ",
6ecf81d6 446 map { "(op) == OP_" . uc() } sort keys %$op_is);
424a4936 447 print $on ")\n\n";
e71197e2
JC
448 }
449 }
a85d93d9
JH
450}
451
424a4936
NC
452print $oc "/* ex: set ro: */\n";
453print $on "/* ex: set ro: */\n";
37442d52 454
08858ed2
NC
455safer_close($oc);
456safer_close($on);
735e0d5c 457
424a4936
NC
458rename_if_different $opcode_new, 'opcode.h';
459rename_if_different $opname_new, 'opnames.h';
46f659cb 460
d6480c9d 461my $pp_sym_new = 'pp.sym-new';
424a4936 462my $ppsym = safer_open($pp_sym_new);
22c35a8c 463
424a4936 464print $ppsym <<"END";
37442d52 465# -*- buffer-read-only: t -*-
a27f85b3 466#
a567e93b 467# !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
d006332c
FC
468# This file is built by regen/opcode.pl from its data. Any changes made
469# here will be lost!
a27f85b3
GS
470#
471
472END
473
474
22c35a8c 475for (sort keys %ckname) {
424a4936 476 print $ppsym "Perl_$_\n";
20ce7b12 477#OP *\t", &tab(3,$_),"(OP* o);\n";
22c35a8c
GS
478}
479
735e0d5c 480for (@ops) {
15e52e56 481 next if /^i_(pre|post)(inc|dec)$/;
53e06cf0 482 next if /^custom$/;
424a4936 483 print $ppsym "Perl_pp_$_\n";
735e0d5c 484}
424a4936 485print $ppsym "\n# ex: set ro:\n";
735e0d5c 486
08858ed2 487safer_close($ppsym);
735e0d5c 488
424a4936 489rename_if_different $pp_sym_new, 'pp.sym';
46f659cb 490
24600adc 491END {
a4e74480 492 foreach ('opcode.h', 'opnames.h', 'pp.sym') {
24600adc
JH
493 1 while unlink "$_-old";
494 }
495}
496
79072805
LW
497###########################################################################
498sub tab {
d6480c9d 499 my ($l, $t) = @_;
79072805
LW
500 $t .= "\t" x ($l - (length($t) + 1) / 8);
501 $t;
502}
503###########################################################################
b162f9ea
IZ
504
505# Some comments about 'T' opcode classifier:
506
507# Safe to set if the ppcode uses:
508# tryAMAGICbin, tryAMAGICun, SETn, SETi, SETu, PUSHn, PUSHTARG, SETTARG,
509# SETs(TARG), XPUSHn, XPUSHu,
510
511# Unsafe to set if the ppcode uses dTARG or [X]RETPUSH[YES|NO|UNDEF]
512
513# lt and friends do SETs (including ncmp, but not scmp)
514
21f5b33c
GS
515# Additional mode of failure: the opcode can modify TARG before it "used"
516# all the arguments (or may call an external function which does the same).
517# If the target coincides with one of the arguments ==> kaboom.
518
b162f9ea
IZ
519# pp.c pos substr each not OK (RETPUSHUNDEF)
520# substr vec also not OK due to LV to target (are they???)
521# ref not OK (RETPUSHNO)
522# trans not OK (dTARG; TARG = sv_newmortal();)
523# ucfirst etc not OK: TMP arg processed inplace
69b47968 524# quotemeta not OK (unsafe when TARG == arg)
91e74348 525# each repeat not OK too due to list context
b162f9ea 526# pack split - unknown whether they are safe
dae78bb1
IZ
527# sprintf: is calling do_sprintf(TARG,...) which can act on TARG
528# before other args are processed.
b162f9ea 529
21f5b33c
GS
530# Suspicious wrt "additional mode of failure" (and only it):
531# schop, chop, postinc/dec, bit_and etc, negate, complement.
532
533# Also suspicious: 4-arg substr, sprintf, uc/lc (POK_only), reverse, pack.
534
535# substr/vec: doing TAINT_off()???
536
b162f9ea
IZ
537# pp_hot.c
538# readline - unknown whether it is safe
539# match subst not OK (dTARG)
540# grepwhile not OK (not always setting)
69b47968 541# join not OK (unsafe when TARG == arg)
b162f9ea 542
21f5b33c
GS
543# Suspicious wrt "additional mode of failure": concat (dealt with
544# in ck_sassign()), join (same).
545
b162f9ea
IZ
546# pp_ctl.c
547# mapwhile flip caller not OK (not always setting)
548
549# pp_sys.c
550# backtick glob warn die not OK (not always setting)
551# warn not OK (RETPUSHYES)
552# open fileno getc sysread syswrite ioctl accept shutdown
553# ftsize(etc) readlink telldir fork alarm getlogin not OK (RETPUSHUNDEF)
554# umask select not OK (XPUSHs(&PL_sv_undef);)
555# fileno getc sysread syswrite tell not OK (meth("FILENO" "GETC"))
556# sselect shm* sem* msg* syscall - unknown whether they are safe
557# gmtime not OK (list context)
558
21f5b33c
GS
559# Suspicious wrt "additional mode of failure": warn, die, select.
560
79072805
LW
561__END__
562
d83386fa
NC
563# New ops always go at the end
564# The restriction on having custom as the last op has been removed
7399586d 565
64b99527
SC
566# A recapitulation of the format of this file:
567# The file consists of five columns: the name of the op, an English
568# description, the name of the "check" routine used to optimize this
569# operation, some flags, and a description of the operands.
570
571# The flags consist of options followed by a mandatory op class signifier
572
573# The classes are:
574# baseop - 0 unop - 1 binop - 2
575# logop - | listop - @ pmop - /
576# padop/svop - $ padop - # (unused) loop - {
577# baseop/unop - % loopexop - } filestatop - -
3508218b 578# pvop/svop - " cop - ;
64b99527
SC
579
580# Other options are:
581# needs stack mark - m
582# needs constant folding - f
583# produces a scalar - s
584# produces an integer - i
585# needs a target - t
586# target can be in a pad - T
587# has a corresponding integer version - I
588# has side effects - d
589# uses $_ if no argument given - u
590
591# Values for the operands are:
592# scalar - S list - L array - A
593# hash - H sub (CV) - C file - F
6ecf81d6
JC
594# socket - Fs filetest - F- filetest_access - F-+
595
596# reference - R
64b99527
SC
597# "?" denotes an optional operand.
598
79072805
LW
599# Nothing.
600
601null null operation ck_null 0
93a17b20 602stub stub ck_null 0
db173bac 603scalar scalar ck_fun s% S
79072805
LW
604
605# Pushy stuff.
606
db173bac
MB
607pushmark pushmark ck_null s0
608wantarray wantarray ck_null is0
79072805 609
db173bac 610const constant item ck_svconst s$
79072805 611
7934575e
GS
612gvsv scalar variable ck_null ds$
613gv glob value ck_null ds$
db173bac
MB
614gelem glob elem ck_null d2 S S
615padsv private variable ck_null ds0
616padav private array ck_null d0
617padhv private hash ck_null d0
f1612b5c 618padany private value ck_null d0
79072805 619
1167e5da 620pushre push regexp ck_null d/
79072805
LW
621
622# References and stuff.
623
db173bac 624rv2gv ref-to-glob cast ck_rvconst ds1
b89fed5f 625rv2sv scalar dereference ck_rvconst ds1
db173bac 626av2arylen array length ck_null is1
b89fed5f 627rv2cv subroutine dereference ck_rvconst d1
db173bac
MB
628anoncode anonymous subroutine ck_anoncode $
629prototype subroutine prototype ck_null s% S
5d11ae5e 630refgen reference constructor ck_spair m1 L
dfa0f641 631srefgen single ref constructor ck_null fs1 S
db173bac
MB
632ref reference-type operator ck_fun stu% S?
633bless bless ck_fun s@ S S?
79072805
LW
634
635# Pushy I/O.
636
01f5bc1b 637backtick quoted execution (``, qx) ck_open tu% S?
0a753a76 638# glob defaults its first arg to $_
649da076 639glob glob ck_glob t@ S?
e4b7ebf3 640readline <HANDLE> ck_readline t% F?
5fc9b9e4 641rcatline append I/O operator ck_null t$
79072805
LW
642
643# Bindable operators.
644
f1612b5c
GS
645regcmaybe regexp internal guard ck_fun s1 S
646regcreset regexp internal reset ck_fun s1 S
647regcomp regexp compilation ck_null s| S
648match pattern match (m//) ck_match d/
649qr pattern quote (qr//) ck_match s/
59f00321 650subst substitution (s///) ck_match dis/ S
f1612b5c 651substcont substitution iterator ck_null dis|
59f00321 652trans transliteration (tr///) ck_match is" S
6342d5c5 653# transr (the /r version) is further down.
79072805
LW
654
655# Lvalue operators.
db173bac
MB
656# sassign is special-cased for op class
657
b162f9ea 658sassign scalar assignment ck_sassign s0
db173bac
MB
659aassign list assignment ck_null t2 L L
660
21f5b33c
GS
661chop chop ck_spair mts% L
662schop scalar chop ck_null stu% S?
f1612b5c
GS
663chomp chomp ck_spair mTs% L
664schomp scalar chomp ck_null sTu% S?
69794302 665defined defined operator ck_defined isu% S?
db173bac
MB
666undef undef operator ck_lfun s% S?
667study study ck_fun su% S?
668pos match position ck_lfun stu% S?
669
42d38218
MS
670preinc preincrement (++) ck_lfun dIs1 S
671i_preinc integer preincrement (++) ck_lfun dis1 S
672predec predecrement (--) ck_lfun dIs1 S
673i_predec integer predecrement (--) ck_lfun dis1 S
21f5b33c 674postinc postincrement (++) ck_lfun dIst1 S
42d38218 675i_postinc integer postincrement (++) ck_lfun disT1 S
21f5b33c 676postdec postdecrement (--) ck_lfun dIst1 S
42d38218 677i_postdec integer postdecrement (--) ck_lfun disT1 S
79072805
LW
678
679# Ordinary operators.
680
42d38218
MS
681pow exponentiation (**) ck_null fsT2 S S
682
f1612b5c 683multiply multiplication (*) ck_null IfsT2 S S
42d38218
MS
684i_multiply integer multiplication (*) ck_null ifsT2 S S
685divide division (/) ck_null IfsT2 S S
686i_divide integer division (/) ck_null ifsT2 S S
687modulo modulus (%) ck_null IifsT2 S S
688i_modulo integer modulus (%) ck_null ifsT2 S S
689repeat repeat (x) ck_repeat mt2 L S
690
691add addition (+) ck_null IfsT2 S S
692i_add integer addition (+) ck_null ifsT2 S S
693subtract subtraction (-) ck_null IfsT2 S S
694i_subtract integer subtraction (-) ck_null ifsT2 S S
df91b2c5 695concat concatenation (.) or string ck_concat fsT2 S S
b162f9ea 696stringify string ck_fun fsT@ S
db173bac 697
42d38218
MS
698left_shift left bitshift (<<) ck_bitop fsT2 S S
699right_shift right bitshift (>>) ck_bitop fsT2 S S
700
701lt numeric lt (<) ck_null Iifs2 S S
702i_lt integer lt (<) ck_null ifs2 S S
703gt numeric gt (>) ck_null Iifs2 S S
704i_gt integer gt (>) ck_null ifs2 S S
705le numeric le (<=) ck_null Iifs2 S S
706i_le integer le (<=) ck_null ifs2 S S
707ge numeric ge (>=) ck_null Iifs2 S S
708i_ge integer ge (>=) ck_null ifs2 S S
709eq numeric eq (==) ck_null Iifs2 S S
710i_eq integer eq (==) ck_null ifs2 S S
711ne numeric ne (!=) ck_null Iifs2 S S
712i_ne integer ne (!=) ck_null ifs2 S S
713ncmp numeric comparison (<=>) ck_null Iifst2 S S
714i_ncmp integer comparison (<=>) ck_null ifst2 S S
db173bac 715
2de3dbcc
JH
716slt string lt ck_null ifs2 S S
717sgt string gt ck_null ifs2 S S
718sle string le ck_null ifs2 S S
719sge string ge ck_null ifs2 S S
db173bac
MB
720seq string eq ck_null ifs2 S S
721sne string ne ck_null ifs2 S S
2de3dbcc 722scmp string comparison (cmp) ck_null ifst2 S S
db173bac 723
21f5b33c
GS
724bit_and bitwise and (&) ck_bitop fst2 S S
725bit_xor bitwise xor (^) ck_bitop fst2 S S
726bit_or bitwise or (|) ck_bitop fst2 S S
db173bac 727
21f5b33c 728negate negation (-) ck_null Ifst1 S
f1612b5c 729i_negate integer negation (-) ck_null ifsT1 S
db173bac 730not not ck_null ifs1 S
21f5b33c 731complement 1's complement (~) ck_bitop fst1 S
79072805 732
fdecdb95
NC
733smartmatch smart match ck_smartmatch s2
734
79072805
LW
735# High falutin' math.
736
f1612b5c
GS
737atan2 atan2 ck_fun fsT@ S S
738sin sin ck_fun fsTu% S?
739cos cos ck_fun fsTu% S?
740rand rand ck_fun sT% S?
83832992 741srand srand ck_fun sT% S?
f1612b5c
GS
742exp exp ck_fun fsTu% S?
743log log ck_fun fsTu% S?
744sqrt sqrt ck_fun fsTu% S?
79072805 745
cf26c822
CS
746# Lowbrow math.
747
b162f9ea
IZ
748int int ck_fun fsTu% S?
749hex hex ck_fun fsTu% S?
750oct oct ck_fun fsTu% S?
751abs abs ck_fun fsTu% S?
79072805
LW
752
753# String stuff.
754
9784f5f4 755length length ck_fun ifsTu% S?
35fba0d9 756substr substr ck_substr st@ S S S? S?
db173bac 757vec vec ck_fun ist@ S S S
79072805 758
b162f9ea
IZ
759index index ck_index isT@ S S S?
760rindex rindex ck_index isT@ S S S?
79072805 761
c427f4d2 762sprintf sprintf ck_fun fmst@ S L
db173bac 763formline formline ck_fun ms@ S L
b162f9ea
IZ
764ord ord ck_fun ifsTu% S?
765chr chr ck_fun fsTu% S?
766crypt crypt ck_fun fsT@ S S
2de3dbcc
JH
767ucfirst ucfirst ck_fun fstu% S?
768lcfirst lcfirst ck_fun fstu% S?
769uc uc ck_fun fstu% S?
770lc lc ck_fun fstu% S?
69b47968 771quotemeta quotemeta ck_fun fstu% S?
79072805
LW
772
773# Arrays.
774
f1612b5c 775rv2av array dereference ck_rvconst dt1
7934575e 776aelemfast constant array element ck_null s$ A S
db173bac
MB
777aelem array element ck_null s2 A S
778aslice array slice ck_null m@ A L
79072805 779
878d132a
NC
780aeach each on array ck_each % A
781akeys keys on array ck_each t% A
782avalues values on array ck_each t% A
783
aa689395 784# Hashes.
79072805 785
878d132a
NC
786each each ck_each % H
787values values ck_each t% H
788keys keys ck_each t% H
db173bac 789delete delete ck_delete % S
42d38218 790exists exists ck_exists is% S
f1612b5c 791rv2hv hash dereference ck_rvconst dt1
c2dedb93 792helem hash element ck_null s2 H S
db173bac 793hslice hash slice ck_null m@ H L
2e0eeeaa 794boolkeys boolkeys ck_fun % H
79072805
LW
795
796# Explosives and implosives.
797
bab9c0ac 798unpack unpack ck_unpack @ S S?
db173bac
MB
799pack pack ck_fun mst@ S L
800split split ck_split t@ S S S
297b36dc 801join join or string ck_join mst@ S L
79072805
LW
802
803# List operators.
804
db173bac
MB
805list list ck_null m@ L
806lslice list slice ck_null 2 H L L
42d38218
MS
807anonlist anonymous list ([]) ck_fun ms@ L
808anonhash anonymous hash ({}) ck_fun ms@ L
79072805 809
cba5a3b0
DG
810splice splice ck_push m@ A S? S? L
811push push ck_push imsT@ A L
26f600bc
RGS
812pop pop ck_shift s% A?
813shift shift ck_shift s% A?
cba5a3b0 814unshift unshift ck_push imsT@ A L
9850bf21 815sort sort ck_sort dm@ C? L
db173bac 816reverse reverse ck_fun mt@ L
79072805 817
f1612b5c
GS
818grepstart grep ck_grep dm@ C L
819grepwhile grep iterator ck_null dt|
79072805 820
f1612b5c
GS
821mapstart map ck_grep dm@ C L
822mapwhile map iterator ck_null dt|
a0d0e21e 823
79072805
LW
824# Range stuff.
825
1a67a97c 826range flipflop ck_null | S S
db173bac
MB
827flip range (or flip) ck_null 1 S S
828flop range (or flop) ck_null 1
79072805
LW
829
830# Control.
831
42d38218 832and logical and (&&) ck_null |
f1612b5c
GS
833or logical or (||) ck_null |
834xor logical xor ck_null fs2 S S
fdecdb95 835dor defined or (//) ck_null |
f1612b5c 836cond_expr conditional expression ck_null d|
42d38218
MS
837andassign logical and assignment (&&=) ck_null s|
838orassign logical or assignment (||=) ck_null s|
fdecdb95 839dorassign defined or assignment (//=) ck_null s|
db173bac 840
f5d5a27c 841method method lookup ck_method d1
db173bac
MB
842entersub subroutine entry ck_subr dmt1 L
843leavesub subroutine exit ck_null 1
78f9721b 844leavesublv lvalue subroutine return ck_null 1
db173bac
MB
845caller caller ck_fun t% S?
846warn warn ck_fun imst@ L
96e176bf 847die die ck_die dimst@ L
f1612b5c 848reset symbol reset ck_fun is% S?
db173bac
MB
849
850lineseq line sequence ck_null @
722969e2
DM
851nextstate next statement ck_null s;
852dbstate debug next statement ck_null s;
e9c54c90 853unstack iteration finalizer ck_null s0
79072805 854enter block entry ck_null 0
db173bac
MB
855leave block exit ck_null @
856scope block ck_null @
857enteriter foreach loop entry ck_null d{
79072805 858iter foreach loop iterator ck_null 0
db173bac
MB
859enterloop loop entry ck_null d{
860leaveloop loop exit ck_null 2
78f9721b 861return return ck_return dm@ L
db173bac
MB
862last last ck_null ds}
863next next ck_null ds}
864redo redo ck_null ds}
865dump dump ck_null ds}
866goto goto ck_null ds}
d98f61e7 867exit exit ck_exit ds% S?
fdecdb95
NC
868method_named method with known name ck_null d$
869
870entergiven given() ck_null d|
871leavegiven leave given block ck_null 1
872enterwhen when() ck_null d|
873leavewhen leave when block ck_null 1
874break break ck_null 0
875continue continue ck_null 0
79072805 876
79072805
LW
877# I/O.
878
a567e93b 879open open ck_open ismt@ F S? L
db173bac
MB
880close close ck_fun is% F?
881pipe_op pipe ck_fun is@ F F
79072805 882
db173bac 883fileno fileno ck_fun ist% F
a86a20aa 884umask umask ck_fun ist% S?
1c1fc3ea 885binmode binmode ck_fun s@ F S?
79072805 886
db173bac
MB
887tie tie ck_fun idms@ R S L
888untie untie ck_fun is% R
889tied tied ck_fun s% R
890dbmopen dbmopen ck_fun is@ H S S
891dbmclose dbmclose ck_fun is% H
79072805 892
db173bac
MB
893sselect select system call ck_select t@ S S S S
894select select ck_select st@ F?
79072805 895
db173bac 896getc getc ck_eof st% F?
d1a002d4 897read read ck_fun imst@ F R S S?
db173bac
MB
898enterwrite write ck_fun dis% F?
899leavewrite write exit ck_null 1
79072805 900
db173bac
MB
901prtf printf ck_listiob ims@ F? L
902print print ck_listiob ims@ F? L
fdecdb95 903say say ck_listiob ims@ F? L
79072805 904
db173bac
MB
905sysopen sysopen ck_fun s@ F S S S?
906sysseek sysseek ck_fun s@ F S S
d1a002d4 907sysread sysread ck_fun imst@ F R S S?
145d37e2 908syswrite syswrite ck_fun imst@ F S S? S?
79072805 909
db173bac
MB
910eof eof ck_eof is% F?
911tell tell ck_fun st% F?
912seek seek ck_fun s@ F S S
9b01e405 913# truncate really behaves as if it had both "S S" and "F S"
db173bac 914truncate truncate ck_trunc is@ S S
79072805 915
db173bac
MB
916fcntl fcntl ck_fun st@ F S S
917ioctl ioctl ck_fun st@ F S S
b162f9ea 918flock flock ck_fun isT@ F S
79072805 919
e71197e2
JC
920# Sockets. OP_IS_SOCKET wants them consecutive (so moved 1st 2)
921
922send send ck_fun imst@ Fs S S S?
923recv recv ck_fun imst@ Fs R S S
79072805 924
a85d93d9
JH
925socket socket ck_fun is@ Fs S S S
926sockpair socketpair ck_fun is@ Fs Fs S S S
79072805 927
a85d93d9
JH
928bind bind ck_fun is@ Fs S
929connect connect ck_fun is@ Fs S
930listen listen ck_fun is@ Fs S
931accept accept ck_fun ist@ Fs Fs
932shutdown shutdown ck_fun ist@ Fs S
79072805 933
a85d93d9
JH
934gsockopt getsockopt ck_fun is@ Fs S S
935ssockopt setsockopt ck_fun is@ Fs S S S
79072805 936
a85d93d9
JH
937getsockname getsockname ck_fun is% Fs
938getpeername getpeername ck_fun is% Fs
79072805 939
e71197e2 940# Stat calls. OP_IS_FILETEST wants them consecutive.
79072805 941
db173bac
MB
942lstat lstat ck_ftst u- F
943stat stat ck_ftst u- F
6ecf81d6
JC
944ftrread -R ck_ftst isu- F-+
945ftrwrite -W ck_ftst isu- F-+
946ftrexec -X ck_ftst isu- F-+
947fteread -r ck_ftst isu- F-+
948ftewrite -w ck_ftst isu- F-+
949fteexec -x ck_ftst isu- F-+
a85d93d9 950ftis -e ck_ftst isu- F-
a85d93d9
JH
951ftsize -s ck_ftst istu- F-
952ftmtime -M ck_ftst stu- F-
953ftatime -A ck_ftst stu- F-
954ftctime -C ck_ftst stu- F-
7834bb7e
NC
955ftrowned -O ck_ftst isu- F-
956fteowned -o ck_ftst isu- F-
957ftzero -z ck_ftst isu- F-
a85d93d9
JH
958ftsock -S ck_ftst isu- F-
959ftchr -c ck_ftst isu- F-
960ftblk -b ck_ftst isu- F-
961ftfile -f ck_ftst isu- F-
962ftdir -d ck_ftst isu- F-
963ftpipe -p ck_ftst isu- F-
a85d93d9
JH
964ftsuid -u ck_ftst isu- F-
965ftsgid -g ck_ftst isu- F-
966ftsvtx -k ck_ftst isu- F-
7834bb7e 967ftlink -l ck_ftst isu- F-
a85d93d9
JH
968fttty -t ck_ftst is- F-
969fttext -T ck_ftst isu- F-
970ftbinary -B ck_ftst isu- F-
79072805
LW
971
972# File calls.
973
d4ac975e
GA
974# chdir really behaves as if it had both "S?" and "F?"
975chdir chdir ck_chdir isT% S?
b162f9ea
IZ
976chown chown ck_fun imsT@ L
977chroot chroot ck_fun isTu% S?
978unlink unlink ck_fun imsTu@ L
a86a20aa 979chmod chmod ck_fun imsT@ L
b162f9ea
IZ
980utime utime ck_fun imsT@ L
981rename rename ck_fun isT@ S S
982link link ck_fun isT@ S S
983symlink symlink ck_fun isT@ S S
db173bac 984readlink readlink ck_fun stu% S?
491873e5 985mkdir mkdir ck_fun isTu@ S? S?
b162f9ea 986rmdir rmdir ck_fun isTu% S?
79072805
LW
987
988# Directory calls.
989
1e2c6ed7 990open_dir opendir ck_fun is@ F S
db173bac
MB
991readdir readdir ck_fun % F
992telldir telldir ck_fun st% F
993seekdir seekdir ck_fun s@ F S
994rewinddir rewinddir ck_fun s% F
995closedir closedir ck_fun is% F
79072805
LW
996
997# Process control.
998
db173bac 999fork fork ck_null ist0
b162f9ea
IZ
1000wait wait ck_null isT0
1001waitpid waitpid ck_fun isT@ S S
1002system system ck_exec imsT@ S? L
1003exec exec ck_exec dimsT@ S? L
1004kill kill ck_fun dimsT@ L
1005getppid getppid ck_null isT0
1006getpgrp getpgrp ck_fun isT% S?
1007setpgrp setpgrp ck_fun isT@ S? S?
1008getpriority getpriority ck_fun isT@ S S
1009setpriority setpriority ck_fun isT@ S S S
79072805
LW
1010
1011# Time calls.
1012
cd39f2b6
JH
1013# NOTE: MacOS patches the 'i' of time() away later when the interpreter
1014# is created because in MacOS time() is already returning times > 2**31-1,
1015# that is, non-integers.
1016
b162f9ea 1017time time ck_null isT0
79072805 1018tms times ck_null 0
db173bac
MB
1019localtime localtime ck_fun t% S?
1020gmtime gmtime ck_fun t% S?
1021alarm alarm ck_fun istu% S?
b162f9ea 1022sleep sleep ck_fun isT% S?
79072805
LW
1023
1024# Shared memory.
1025
db173bac
MB
1026shmget shmget ck_fun imst@ S S S
1027shmctl shmctl ck_fun imst@ S S S
1028shmread shmread ck_fun imst@ S S S S
1029shmwrite shmwrite ck_fun imst@ S S S S
79072805
LW
1030
1031# Message passing.
1032
db173bac
MB
1033msgget msgget ck_fun imst@ S S
1034msgctl msgctl ck_fun imst@ S S S
1035msgsnd msgsnd ck_fun imst@ S S S
1036msgrcv msgrcv ck_fun imst@ S S S S S
79072805
LW
1037
1038# Semaphores.
1039
7834bb7e 1040semop semop ck_fun imst@ S S
db173bac
MB
1041semget semget ck_fun imst@ S S S
1042semctl semctl ck_fun imst@ S S S S
79072805
LW
1043
1044# Eval.
1045
db173bac 1046require require ck_require du% S?
b3f4d674 1047dofile do "file" ck_fun d1 S
996c9baa 1048hintseval eval hints ck_svconst s$
b3f4d674
GS
1049entereval eval "string" ck_eval d% S
1050leaveeval eval "string" exit ck_null 1 S
db173bac 1051#evalonce eval constant string ck_null d1 S
a4256772 1052entertry eval {block} ck_eval d|
f1612b5c 1053leavetry eval {block} exit ck_null @
79072805
LW
1054
1055# Get system info.
1056
db173bac
MB
1057ghbyname gethostbyname ck_fun % S
1058ghbyaddr gethostbyaddr ck_fun @ S S
79072805 1059ghostent gethostent ck_null 0
db173bac
MB
1060gnbyname getnetbyname ck_fun % S
1061gnbyaddr getnetbyaddr ck_fun @ S S
79072805 1062gnetent getnetent ck_null 0
db173bac
MB
1063gpbyname getprotobyname ck_fun % S
1064gpbynumber getprotobynumber ck_fun @ S
79072805 1065gprotoent getprotoent ck_null 0
db173bac
MB
1066gsbyname getservbyname ck_fun @ S S
1067gsbyport getservbyport ck_fun @ S S
79072805 1068gservent getservent ck_null 0
db173bac
MB
1069shostent sethostent ck_fun is% S
1070snetent setnetent ck_fun is% S
1071sprotoent setprotoent ck_fun is% S
1072sservent setservent ck_fun is% S
1073ehostent endhostent ck_null is0
1074enetent endnetent ck_null is0
1075eprotoent endprotoent ck_null is0
1076eservent endservent ck_null is0
1077gpwnam getpwnam ck_fun % S
1078gpwuid getpwuid ck_fun % S
79072805 1079gpwent getpwent ck_null 0
db173bac
MB
1080spwent setpwent ck_null is0
1081epwent endpwent ck_null is0
1082ggrnam getgrnam ck_fun % S
1083ggrgid getgrgid ck_fun % S
79072805 1084ggrent getgrent ck_null 0
db173bac
MB
1085sgrent setgrent ck_null is0
1086egrent endgrent ck_null is0
1087getlogin getlogin ck_null st0
79072805
LW
1088
1089# Miscellaneous.
1090
db173bac 1091syscall syscall ck_fun imst@ S L
c0329465
MB
1092
1093# For multi-threading
5a47f09b 1094lock lock ck_rfun s% R
7399586d 1095
c5917253
NC
1096# For state support
1097
1098once once ck_null |
1099
53e06cf0 1100custom unknown custom operator ck_null 0
cba5a3b0
DG
1101
1102# For smart dereference for each/keys/values
1103reach each on reference ck_each % S
1104rkeys keys on reference ck_each t% S
1105rvalues values on reference ck_each t% S
6342d5c5
FC
1106
1107# y///r
1108transr transliteration (tr///) ck_match is" S