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