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