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