README nits pointed out by Chris Nandor <pudge@pobox.com>
[p5sagit/p5-mst-13.2.git] / makedef.pl
1 #
2 # Create the export list for perl.
3 #
4 # Needed by WIN32 and OS/2 for creating perl.dll
5 # and by AIX for creating libperl.a when -Dusershrplib is in effect.
6 #
7 # reads global.sym, pp.sym, perlvars.h, intrpvar.h, thrdvar.h, config.h
8 # On OS/2 reads miniperl.map as well
9
10 my $PLATFORM;
11 my $CCTYPE;
12
13 my %bincompat5005 =
14       (Perl_call_argv           =>      "perl_call_argv",
15        Perl_call_method         =>      "perl_call_method",
16        Perl_call_pv             =>      "perl_call_pv",
17        Perl_call_sv             =>      "perl_call_sv",
18        Perl_get_av              =>      "perl_get_av",
19        Perl_get_cv              =>      "perl_get_cv",
20        Perl_get_hv              =>      "perl_get_hv",
21        Perl_get_sv              =>      "perl_get_sv",
22        Perl_init_i18nl10n       =>      "perl_init_i18nl10n",
23        Perl_init_i18nl14n       =>      "perl_init_i18nl14n",
24        Perl_new_collate         =>      "perl_new_collate",
25        Perl_new_ctype           =>      "perl_new_ctype",
26        Perl_new_numeric         =>      "perl_new_numeric",
27        Perl_require_pv          =>      "perl_require_pv",
28        Perl_safesyscalloc       =>      "Perl_safecalloc",
29        Perl_safesysfree         =>      "Perl_safefree",
30        Perl_safesysmalloc       =>      "Perl_safemalloc",
31        Perl_safesysrealloc      =>      "Perl_saferealloc",
32        Perl_set_numeric_local   =>      "perl_set_numeric_local",
33        Perl_set_numeric_standard  =>    "perl_set_numeric_standard");
34
35 my $bincompat5005 = join("|", keys %bincompat5005);
36
37 while (@ARGV)
38  {
39   my $flag = shift;
40   $define{$1} = 1 if ($flag =~ /^-D(\w+)$/);
41   $define{$1} = $2 if ($flag =~ /^-D(\w+)=(.+)$/);
42   $CCTYPE   = $1 if ($flag =~ /^CCTYPE=(\w+)$/);
43   $PLATFORM = $1 if ($flag =~ /^PLATFORM=(\w+)$/);
44  } 
45
46 my @PLATFORM = qw(aix win32 os2);
47 my %PLATFORM;
48 @PLATFORM{@PLATFORM} = ();
49
50 defined $PLATFORM || die "PLATFORM undefined, must be one of: @PLATFORM\n";
51 exists $PLATFORM{$PLATFORM} || die "PLATFORM must be one of: @PLATFORM\n"; 
52
53 my $config_sh   = "config.sh";
54 my $config_h    = "config.h";
55 my $thrdvar_h   = "thrdvar.h";
56 my $intrpvar_h  = "intrpvar.h";
57 my $perlvars_h  = "perlvars.h";
58 my $global_sym  = "global.sym";
59 my $pp_sym      = "pp.sym";
60 my $globvar_sym = "globvar.sym";
61 my $perlio_sym  = "perlio.sym";
62
63 if ($PLATFORM eq 'aix') { 
64     # Nothing for now.
65 } elsif ($PLATFORM eq 'win32') {
66     $CCTYPE = "MSVC" unless defined $CCTYPE;
67     foreach ($thrdvar_h, $intrpvar_h, $perlvars_h, $global_sym, $pp_sym, $globvar_sym) {
68         s!^!..\\!;
69     }
70 }
71
72 unless ($PLATFORM eq 'win32') {
73     open(CFG,$config_sh) || die "Cannot open $config_sh: $!\n";
74     while (<CFG>)
75     {
76         if (/^(?:ccflags|optimize)='(.+)'$/) {
77             $_ = $1;
78             $define{$1} = 1 while /-D(\w+)/g;
79         }
80         if ($PLATFORM eq 'os2') {
81             $CONFIG_ARGS = $1 if /^(?:config_args)='(.+)'$/;
82             $ARCHNAME = $1 if /^(?:archname)='(.+)'$/;
83         }
84     }
85     close(CFG);
86 }
87
88 open(CFG,$config_h) || die "Cannot open $config_h: $!\n";
89 while (<CFG>)
90  {
91   $define{$1} = 1 if /^\s*#\s*define\s+(MYMALLOC)\b/;
92   $define{$1} = 1 if /^\s*#\s*define\s+(USE_THREADS)\b/;
93   $define{$1} = 1 if /^\s*#\s*define\s+(USE_PERLIO)\b/;
94   $define{$1} = 1 if /^\s*#\s*define\s+(MULTIPLICITY)\b/;
95   $define{$1} = 1 if /^\s*#\s*define\s+(PERL_BINCOMPAT_5005)\b/;
96  }
97 close(CFG);
98
99 if ($PLATFORM eq 'win32') {
100     warn join(' ',keys %define)."\n";
101     if ($define{PERL_OBJECT}) {
102         print "LIBRARY Perl56\n";
103         print "DESCRIPTION 'Perl interpreter'\n";
104         print "EXPORTS\n";
105 #    output_symbol("perl_alloc");
106         output_symbol("perl_get_host_info");
107         output_symbol("perl_alloc_using");
108 #    output_symbol("perl_construct");
109 #    output_symbol("perl_destruct");
110 #    output_symbol("perl_free");
111 #    output_symbol("perl_parse");
112 #    output_symbol("perl_run");
113 #    output_symbol("RunPerl");
114 #    exit(0);
115     }
116     else {
117         if ($CCTYPE ne 'GCC') {
118             print "LIBRARY Perl\n";
119             print "DESCRIPTION 'Perl interpreter, export autogenerated'\n";
120         }
121         else {
122             $define{'PERL_GLOBAL_STRUCT'} = 1;
123             $define{'MULTIPLICITY'} = 1;
124         }
125         print "EXPORTS\n";
126     } 
127 } elsif ($PLATFORM eq 'os2') {
128     ($v = $]) =~ s/(\d\.\d\d\d)(\d\d)$/$1_$2/;
129     $v .= '-thread' if $ARCHNAME =~ /-thread/;
130     #$sum = 0;
131     #for (split //, $v) {
132     #   $sum = ($sum * 33) + ord;
133     #   $sum &= 0xffffff;
134     #}
135     #$sum += $sum >> 5;
136     #$sum &= 0xffff;
137     #$sum = printf '%X', $sum;
138     ($dll = $define{PERL_DLL}) =~ s/\.dll$//i;
139     # print STDERR "'$dll' <= '$define{PERL_DLL}'\n";
140     print <<"---EOP---";
141 LIBRARY '$dll' INITINSTANCE TERMINSTANCE
142 DESCRIPTION '\@#perl5-porters\@perl.org:$v#\@ Perl interpreter, configured as $CONFIG_ARGS'
143 STACKSIZE 32768
144 CODE LOADONCALL
145 DATA LOADONCALL NONSHARED MULTIPLE
146 EXPORTS
147 ---EOP---
148 } elsif ($PLATFORM eq 'aix') {
149     print "#!\n";
150 }
151
152 my %skip;
153 my %export;
154
155 sub skip_symbols {
156     my $list = shift;
157     foreach my $symbol (@$list) {
158         $skip{$symbol} = 1;
159     }
160 }
161
162 sub emit_symbols {
163     my $list = shift;
164     foreach my $symbol (@$list) {
165         my $skipsym = $symbol;
166         # XXX hack
167         if ($define{PERL_OBJECT}) {
168             $skipsym =~ s/^Perl_[GIT](\w+)_ptr$/PL_$1/;
169         }
170         emit_symbol($symbol) unless exists $skip{$skipsym};
171     }
172 }
173
174 if ($PLATFORM eq 'win32') {
175 skip_symbols [qw(
176 PL_statusvalue_vms
177 PL_archpat_auto
178 PL_cryptseen
179 PL_DBcv
180 PL_generation
181 PL_lastgotoprobe
182 PL_linestart
183 PL_modcount
184 PL_pending_ident
185 PL_sortcxix
186 PL_sublex_info
187 PL_timesbuf
188 main
189 Perl_ErrorNo
190 Perl_GetVars
191 Perl_do_exec3
192 Perl_do_ipcctl
193 Perl_do_ipcget
194 Perl_do_msgrcv
195 Perl_do_msgsnd
196 Perl_do_semop
197 Perl_do_shmio
198 Perl_dump_fds
199 Perl_init_thread_intern
200 Perl_my_bzero
201 Perl_my_htonl
202 Perl_my_ntohl
203 Perl_my_swap
204 Perl_my_chsize
205 Perl_same_dirent
206 Perl_setenv_getix
207 Perl_unlnk
208 Perl_watch
209 Perl_safexcalloc
210 Perl_safexmalloc
211 Perl_safexfree
212 Perl_safexrealloc
213 Perl_my_memcmp
214 Perl_my_memset
215 PL_cshlen
216 PL_cshname
217 PL_opsave
218
219 Perl_do_exec
220 Perl_getenv_len
221 Perl_my_pclose
222 Perl_my_popen
223 )];
224 } elsif ($PLATFORM eq 'aix') {
225     skip_symbols([qw(
226 Perl_dump_fds
227 Perl_ErrorNo
228 Perl_GetVars
229 Perl_my_bcopy
230 Perl_my_bzero
231 Perl_my_chsize
232 Perl_my_htonl
233 Perl_my_memcmp
234 Perl_my_memset
235 Perl_my_ntohl
236 Perl_my_swap
237 Perl_safexcalloc
238 Perl_safexfree
239 Perl_safexmalloc
240 Perl_safexrealloc
241 Perl_same_dirent
242 Perl_unlnk
243 PL_cryptseen
244 PL_opsave
245 PL_statusvalue_vms
246 PL_sys_intern
247 )]);
248 }
249
250 if ($PLATFORM eq 'os2') {
251     emit_symbols([qw(
252 ctermid
253 get_sysinfo
254 Perl_OS2_init
255 OS2_Perl_data
256 dlopen
257 dlsym
258 dlerror
259 my_tmpfile
260 my_tmpnam
261 my_flock
262 malloc_mutex
263 threads_mutex
264 nthreads
265 nthreads_cond
266 os2_cond_wait
267 os2_stat
268 pthread_join
269 pthread_create
270 pthread_detach
271 XS_Cwd_change_drive
272 XS_Cwd_current_drive
273 XS_Cwd_extLibpath
274 XS_Cwd_extLibpath_set
275 XS_Cwd_sys_abspath
276 XS_Cwd_sys_chdir
277 XS_Cwd_sys_cwd
278 XS_Cwd_sys_is_absolute
279 XS_Cwd_sys_is_relative
280 XS_Cwd_sys_is_rooted
281 XS_DynaLoader_mod2fname
282 XS_File__Copy_syscopy
283 Perl_Register_MQ
284 Perl_Deregister_MQ
285 Perl_Serve_Messages
286 Perl_Process_Messages
287 init_PMWIN_entries
288 PMWIN_entries
289 Perl_hab_GET
290 )]);
291 }
292
293 if ($define{'PERL_OBJECT'}) {
294   skip_symbols [qw(
295     Perl_getenv_len
296     Perl_my_popen
297     Perl_my_pclose
298     )];
299 }
300 else {
301   skip_symbols [qw(
302     PL_Dir
303     PL_Env
304     PL_LIO
305     PL_Mem
306     PL_Proc
307     PL_Sock
308     PL_StdIO
309     )];
310 }
311
312 if ($define{'MYMALLOC'})
313  {
314   emit_symbols [qw(
315     Perl_dump_mstats
316     Perl_malloc
317     Perl_mfree
318     Perl_realloc
319     Perl_calloc)];
320  }
321 else
322  {
323   skip_symbols [qw(
324     Perl_dump_mstats
325     Perl_malloc
326     Perl_mfree
327     Perl_realloc
328     Perl_calloc
329     Perl_malloced_size)];
330  }
331
332 unless ($define{'USE_THREADS'})
333  {
334   skip_symbols [qw(
335 PL_thr_key
336 PL_sv_mutex
337 PL_strtab_mutex
338 PL_svref_mutex
339 PL_malloc_mutex
340 PL_cred_mutex
341 PL_eval_mutex
342 PL_eval_cond
343 PL_eval_owner
344 PL_threads_mutex
345 PL_nthreads
346 PL_nthreads_cond
347 PL_threadnum
348 PL_threadsv_names
349 PL_thrsv
350 PL_vtbl_mutex
351 Perl_getTHR
352 Perl_setTHR
353 Perl_condpair_magic
354 Perl_new_struct_thread
355 Perl_per_thread_magicals
356 Perl_thread_create
357 Perl_find_threadsv
358 Perl_unlock_condpair
359 Perl_magic_mutexfree
360 )];
361  }
362 unless ($define{'USE_THREADS'} or $define{'PERL_IMPLICIT_CONTEXT'}
363         or $define{'PERL_OBJECT'})
364 {
365   skip_symbols [qw(
366                    Perl_croak_nocontext
367                    Perl_die_nocontext
368                    Perl_deb_nocontext
369                    Perl_form_nocontext
370                    Perl_mess_nocontext
371                    Perl_warn_nocontext
372                    Perl_warner_nocontext
373                    Perl_newSVpvf_nocontext
374                    Perl_sv_catpvf_nocontext
375                    Perl_sv_setpvf_nocontext
376                    Perl_sv_catpvf_mg_nocontext
377                    Perl_sv_setpvf_mg_nocontext
378                    )];
379  }
380
381 unless ($define{'FAKE_THREADS'})
382  {
383   skip_symbols [qw(PL_curthr)];
384  }
385
386 sub readvar
387 {
388  my $file = shift;
389  my $proc = shift || sub { "PL_$_[2]" };
390  open(VARS,$file) || die "Cannot open $file: $!\n";
391  my @syms;
392  while (<VARS>)
393   {
394    # All symbols have a Perl_ prefix because that's what embed.h
395    # sticks in front of them.
396    push(@syms, &$proc($1,$2,$3)) if (/\bPERLVAR(A?I?C?)\(([IGT])(\w+)/);
397   } 
398  close(VARS); 
399  return \@syms;
400 }
401
402 if ($define{'USE_THREADS'} || $define{'MULTIPLICITY'})
403  {
404   my $thrd = readvar($thrdvar_h);
405   skip_symbols $thrd;
406  } 
407
408 if ($define{'MULTIPLICITY'})
409  {
410   my $interp = readvar($intrpvar_h);
411   skip_symbols $interp;
412  } 
413
414 if ($define{'PERL_GLOBAL_STRUCT'})
415  {
416   my $global = readvar($perlvars_h);
417   skip_symbols $global;
418   emit_symbols [qw(Perl_GetVars)];
419   emit_symbols [qw(PL_Vars PL_VarsPtr)] unless $CCTYPE eq 'GCC';
420  } 
421
422 unless ($define{'DEBUGGING'})
423  {
424   skip_symbols [qw(
425     Perl_deb
426     Perl_deb_growlevel
427     Perl_debop
428     Perl_debprofdump
429     Perl_debstack
430     Perl_debstackptrs
431     Perl_runops_debug
432     Perl_sv_peek
433     PL_block_type
434     PL_watchaddr
435     PL_watchok)];
436  }
437
438 if ($PLATFORM eq 'win32' && $define{'HAVE_DES_FCRYPT'})
439  {
440   emit_symbols [qw(win32_crypt)];
441  }
442
443 # functions from *.sym files
444
445 my @syms = ($global_sym, $pp_sym, $globvar_sym);
446
447 if ($define{'USE_PERLIO'})
448  {
449      push @syms, $perlio_sym;
450  }
451
452 for my $syms (@syms)
453  {
454   open (GLOBAL, "<$syms") || die "failed to open $syms: $!\n";
455   while (<GLOBAL>) 
456    {
457     next if (!/^[A-Za-z]/);
458     # Functions have a Perl_ prefix
459     # Variables have a PL_ prefix
460     chomp($_);
461     my $symbol = ($syms =~ /var\.sym$/i ? "PL_" : "");
462     $symbol .= $_;
463     emit_symbol($symbol) unless exists $skip{$symbol};
464    }
465   close(GLOBAL);
466  }
467
468 # variables
469
470 if ($define{'PERL_OBJECT'}) {
471     for my $f ($perlvars_h, $intrpvar_h, $thrdvar_h) {
472         my $glob = readvar($f, sub { "Perl_" . $_[1] . $_[2] . "_ptr" });
473         emit_symbols $glob;
474     }
475 }
476 else {
477     unless ($define{'PERL_GLOBAL_STRUCT'}) {
478         my $glob = readvar($perlvars_h);
479         emit_symbols $glob;
480     } 
481     unless ($define{'MULTIPLICITY'}) {
482         my $glob = readvar($intrpvar_h);
483         emit_symbols $glob;
484     } 
485
486     unless ($define{'MULTIPLICITY'} || $define{'USE_THREADS'}) {
487         my $glob = readvar($thrdvar_h);
488         emit_symbols $glob;
489     } 
490 }
491
492 sub try_symbol {
493     my $symbol = shift;
494
495     return if $symbol !~ /^[A-Za-z]/;
496     return if $symbol =~ /^\#/;
497     $symbol =~s/\r//g;
498     chomp($symbol);
499     return if exists $skip{$symbol};
500     emit_symbol($symbol);
501 }
502
503 while (<DATA>) {
504     try_symbol($_);
505 }
506
507 if ($PLATFORM eq 'win32') {
508     foreach my $symbol (qw(
509 boot_DynaLoader
510 Perl_getTHR
511 Perl_init_os_extras
512 Perl_setTHR
513 Perl_thread_create
514 Perl_win32_init
515 RunPerl
516 GetPerlInterpreter
517 SetPerlInterpreter
518 win32_errno
519 win32_environ
520 win32_stdin
521 win32_stdout
522 win32_stderr
523 win32_ferror
524 win32_feof
525 win32_strerror
526 win32_fprintf
527 win32_printf
528 win32_vfprintf
529 win32_vprintf
530 win32_fread
531 win32_fwrite
532 win32_fopen
533 win32_fdopen
534 win32_freopen
535 win32_fclose
536 win32_fputs
537 win32_fputc
538 win32_ungetc
539 win32_getc
540 win32_fileno
541 win32_clearerr
542 win32_fflush
543 win32_ftell
544 win32_fseek
545 win32_fgetpos
546 win32_fsetpos
547 win32_rewind
548 win32_tmpfile
549 win32_abort
550 win32_fstat
551 win32_stat
552 win32_pipe
553 win32_popen
554 win32_pclose
555 win32_rename
556 win32_setmode
557 win32_lseek
558 win32_tell
559 win32_dup
560 win32_dup2
561 win32_open
562 win32_close
563 win32_eof
564 win32_read
565 win32_write
566 win32_spawnvp
567 win32_mkdir
568 win32_rmdir
569 win32_chdir
570 win32_flock
571 win32_execv
572 win32_execvp
573 win32_htons
574 win32_ntohs
575 win32_htonl
576 win32_ntohl
577 win32_inet_addr
578 win32_inet_ntoa
579 win32_socket
580 win32_bind
581 win32_listen
582 win32_accept
583 win32_connect
584 win32_send
585 win32_sendto
586 win32_recv
587 win32_recvfrom
588 win32_shutdown
589 win32_closesocket
590 win32_ioctlsocket
591 win32_setsockopt
592 win32_getsockopt
593 win32_getpeername
594 win32_getsockname
595 win32_gethostname
596 win32_gethostbyname
597 win32_gethostbyaddr
598 win32_getprotobyname
599 win32_getprotobynumber
600 win32_getservbyname
601 win32_getservbyport
602 win32_select
603 win32_endhostent
604 win32_endnetent
605 win32_endprotoent
606 win32_endservent
607 win32_getnetent
608 win32_getnetbyname
609 win32_getnetbyaddr
610 win32_getprotoent
611 win32_getservent
612 win32_sethostent
613 win32_setnetent
614 win32_setprotoent
615 win32_setservent
616 win32_getenv
617 win32_putenv
618 win32_perror
619 win32_setbuf
620 win32_setvbuf
621 win32_flushall
622 win32_fcloseall
623 win32_fgets
624 win32_gets
625 win32_fgetc
626 win32_putc
627 win32_puts
628 win32_getchar
629 win32_putchar
630 win32_malloc
631 win32_calloc
632 win32_realloc
633 win32_free
634 win32_sleep
635 win32_times
636 win32_alarm
637 win32_open_osfhandle
638 win32_get_osfhandle
639 win32_ioctl
640 win32_utime
641 win32_uname
642 win32_wait
643 win32_waitpid
644 win32_kill
645 win32_str_os_error
646 win32_opendir
647 win32_readdir
648 win32_telldir
649 win32_seekdir
650 win32_rewinddir
651 win32_closedir
652 win32_longpath
653 win32_os_id
654                            )) {
655         try_symbol($symbol);
656     }
657 }
658 elsif ($PLATFORM eq 'os2') {
659   open MAP, 'miniperl.map' or die 'Cannot read miniperl.map';
660   /^\s*[\da-f:]+\s+(\w+)/i and $mapped{$1}++ foreach <MAP>;
661   close MAP or die 'Cannot close miniperl.map';
662   
663   @missing = grep { !exists $mapped{$_} and !exists $bincompat5005{$_} }
664     keys %export;
665   delete $export{$_} foreach @missing;
666 }
667
668 # Now all symbols should be defined because
669 # next we are going to output them.
670
671 foreach my $symbol (sort keys %export)
672  {
673    output_symbol($symbol);
674  }
675
676 sub emit_symbol {
677         my $symbol = shift;
678         chomp($symbol); 
679         $export{$symbol} = 1;
680 }
681
682 sub output_symbol {
683     my $symbol = shift;
684     $symbol = $bincompat5005{$symbol}
685         if $define{PERL_BINCOMPAT_5005} and $symbol =~ /^($bincompat5005)$/;
686     if ($PLATFORM eq 'win32') {
687         $symbol = "_$symbol" if $CCTYPE eq 'BORLAND';
688         print "\t$symbol\n";
689 # XXX: binary compatibility between compilers is an exercise
690 # in frustration :-(
691 #        if ($CCTYPE eq "BORLAND") {
692 #           # workaround Borland quirk by exporting both the straight
693 #           # name and a name with leading underscore.  Note the
694 #           # alias *must* come after the symbol itself, if both
695 #           # are to be exported. (Linker bug?)
696 #           print "\t_$symbol\n";
697 #           print "\t$symbol = _$symbol\n";
698 #       }
699 #       elsif ($CCTYPE eq 'GCC') {
700 #           # Symbols have leading _ whole process is $%@"% slow
701 #           # so skip aliases for now
702 #           nprint "\t$symbol\n";
703 #       }
704 #       else {
705 #           # for binary coexistence, export both the symbol and
706 #           # alias with leading underscore
707 #           print "\t$symbol\n";
708 #           print "\t_$symbol = $symbol\n";
709 #       }
710     } elsif ($PLATFORM eq 'os2') {
711         print qq(    "$symbol"\n);
712     } elsif ($PLATFORM eq 'aix') {
713         print "$symbol\n";
714     }
715 }
716
717 1;
718 __DATA__
719 # extra globals not included above.
720 perl_alloc
721 perl_construct
722 perl_destruct
723 perl_free
724 perl_parse
725 perl_run