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