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