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