"weak" references internals, still needs perlguts documentation
[p5sagit/p5-mst-13.2.git] / embed.pl
1 #!/usr/bin/perl -w
2
3 require 5.003;
4
5 # XXX others that may need adding
6 #       warnhook
7 #       hints
8 #       copline
9 my @extvars = qw(sv_undef sv_yes sv_no na dowarn
10                  curcop compiling 
11                  tainting tainted stack_base stack_sp sv_arenaroot
12                  no_modify
13                  curstash DBsub DBsingle debstash
14                  rsfp 
15                  stdingv
16                  defgv
17                  errgv
18                  rsfp_filters
19                  perldb
20                  diehook
21                  dirty
22                  perl_destruct_level
23                 );
24
25 sub readsyms (\%$) {
26     my ($syms, $file) = @_;
27     local (*FILE, $_);
28     open(FILE, "< $file")
29         or die "embed.pl: Can't open $file: $!\n";
30     while (<FILE>) {
31         s/[ \t]*#.*//;          # Delete comments.
32         if (/^\s*(\S+)\s*$/) {
33             my $sym = $1;
34             warn "duplicate symbol $sym while processing $file\n"
35                 if exists $$syms{$sym};
36             $$syms{$sym} = 1;
37         }
38     }
39     close(FILE);
40 }
41
42 readsyms %global, 'global.sym';
43 readsyms %global, 'pp.sym';
44
45 sub readvars(\%$$@) {
46     my ($syms, $file,$pre,$keep_pre) = @_;
47     local (*FILE, $_);
48     open(FILE, "< $file")
49         or die "embed.pl: Can't open $file: $!\n";
50     while (<FILE>) {
51         s/[ \t]*#.*//;          # Delete comments.
52         if (/PERLVARI?C?\($pre(\w+)/) {
53             my $sym = $1;
54             $sym = $pre . $sym if $keep_pre;
55             warn "duplicate symbol $sym while processing $file\n"
56                 if exists $$syms{$sym};
57             $$syms{$sym} = 1;
58         }
59     }
60     close(FILE);
61 }
62
63 my %intrp;
64 my %thread;
65
66 readvars %intrp,  'intrpvar.h','I';
67 readvars %thread, 'thrdvar.h','T';
68 readvars %globvar, 'perlvars.h','G';
69 readvars %objvar, 'intrpvar.h','pi', 1;
70
71 foreach my $sym (sort keys %intrp)
72  {
73   if (exists $global{$sym})
74    {
75     delete $global{$sym};
76     warn "$sym in {global,pp}.sym as well as intrpvar.h\n";
77    }
78  }
79
80 foreach my $sym (sort keys %globvar)
81  {
82   if (exists $global{$sym})
83    {
84     delete $global{$sym};
85     warn "$sym in {global,pp}.sym as well as perlvars.h\n";
86    }
87  }
88
89 foreach my $sym (sort keys %thread)
90  {
91   warn "$sym in intrpvar.h as well as thrdvar.h\n" if exists $intrp{$sym};
92   if (exists $global{$sym})
93    {
94     delete $global{$sym};
95     warn "$sym in {global,pp}.sym as well as thrdvar.h\n";
96    }
97  }
98
99 sub undefine ($) {
100     my ($sym) = @_;
101     "#undef  $sym\n";
102 }
103
104 sub hide ($$) {
105     my ($from, $to) = @_;
106     my $t = int(length($from) / 8);
107     "#define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
108 }
109
110 sub embed ($) {
111     my ($sym) = @_;
112     hide($sym, "Perl_$sym");
113 }
114
115 sub embedobj ($) {
116     my ($sym) = @_;
117     hide($sym, $sym =~ /^perl_/i ? "CPerlObj::$sym" : "CPerlObj::Perl_$sym");
118 }
119
120 sub objxsub_func ($) {
121     my ($sym) = @_;
122     undefine($sym) . hide($sym, $sym =~ /^perl_/i
123                                 ? "pPerl->$sym"
124                                 : "pPerl->Perl_$sym");
125 }
126
127 sub objxsub_var ($) {
128     my ($sym) = @_;
129     undefine("PL_$sym") . hide("PL_$sym", "pPerl->PL_$sym");
130 }
131
132 sub embedvar ($) {
133     my ($sym) = @_;
134 #   hide($sym, "Perl_$sym");
135     return '';
136 }
137
138 sub multon ($$$) {
139     my ($sym,$pre,$ptr) = @_;
140     hide("PL_$sym", "($ptr$pre$sym)");
141 }
142 sub multoff ($$) {
143     my ($sym,$pre) = @_;
144     return hide("PL_$pre$sym", "PL_$sym");
145 }
146
147 unlink 'embed.h';
148 open(EM, '> embed.h')
149     or die "Can't create embed.h: $!\n";
150
151 print EM <<'END';
152 /* !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!! 
153    This file is built by embed.pl from global.sym, pp.sym, intrpvar.h,
154    perlvars.h and thrdvar.h.  Any changes made here will be lost!
155 */
156
157 /* (Doing namespace management portably in C is really gross.) */
158
159 /* NO_EMBED is no longer supported. i.e. EMBED is always active. */
160
161 /* Hide global symbols */
162
163 #if !defined(PERL_OBJECT)
164
165 END
166
167 for $sym (sort keys %global) {
168     print EM embed($sym);
169 }
170
171 print EM <<'END';
172
173 #else   /* PERL_OBJECT */
174
175 END
176
177 # XXX these should be in a *.sym file
178 my @staticfuncs = qw(
179     perl_init_i18nl10n
180     perl_init_i18nl14n
181     perl_new_collate
182     perl_new_ctype
183     perl_new_numeric
184     perl_set_numeric_local
185     perl_set_numeric_standard
186     perl_construct
187     perl_destruct
188     perl_atexit
189     perl_free
190     perl_parse
191     perl_run
192     perl_get_sv
193     perl_get_av
194     perl_get_hv
195     perl_get_cv
196     perl_call_argv
197     perl_call_pv
198     perl_call_method
199     perl_call_sv
200     perl_eval_pv
201     perl_eval_sv
202     perl_require_pv
203
204     hsplit
205     hfreeentries
206     more_he
207     new_he
208     del_he
209     save_hek
210     mess_alloc
211     gv_init_sv
212     save_scalar_at
213     asIV
214     asUV
215     more_sv
216     more_xiv
217     more_xnv
218     more_xpv
219     more_xrv
220     new_xiv
221     new_xnv
222     new_xpv
223     new_xrv
224     del_xiv
225     del_xnv
226     del_xpv
227     del_xrv
228     sv_unglob
229     avhv_index_sv
230     do_report_used
231     do_clean_objs
232     do_clean_named_objs
233     do_clean_all
234     not_a_number
235     my_safemalloc
236     visit
237     qsortsv
238     sortcv
239     save_magic
240     magic_methpack
241     magic_methcall
242     magic_methcall
243     doform
244     doencodes
245     refto
246     seed
247     docatch
248     dofindlabel
249     doparseform
250     dopoptoeval
251     dopoptolabel
252     dopoptoloop
253     dopoptosub
254     dopoptosub_at
255     save_lines
256     doeval
257     doopen
258     sv_ncmp
259     sv_i_ncmp
260     amagic_ncmp
261     amagic_i_ncmp
262     amagic_cmp
263     amagic_cmp_locale
264     mul128
265     is_an_int
266     div128
267     runops_standard
268     runops_debug
269     check_uni
270     force_next
271     force_version
272     force_word
273     tokeq
274     scan_const
275     scan_formline
276     scan_heredoc
277     scan_ident
278     scan_inputsymbol
279     scan_pat
280     scan_str
281     scan_subst
282     scan_trans
283     scan_word
284     skipspace
285     checkcomma
286     force_ident
287     incline
288     intuit_method
289     intuit_more
290     lop
291     missingterm
292     no_op
293     set_csh
294     sublex_done
295     sublex_push
296     sublex_start
297     uni
298     filter_gets
299     new_constant
300     ao
301     depcom
302     win32_textfilter
303     incl_perldb
304     isa_lookup
305     get_db_sub
306     list_assignment
307     bad_type
308     modkids
309     no_fh_allowed
310     scalarboolean
311     too_few_arguments
312     too_many_arguments
313     null
314     pad_findlex
315     newDEFSVOP
316     gv_ename
317     cv_clone2
318     find_beginning
319     forbid_setid
320     incpush
321     init_interp
322     init_ids
323     init_debugger
324     init_lexer
325     init_main_stash
326     init_perllib
327     init_postdump_symbols
328     init_predump_symbols
329     my_exit_jump
330     nuke_stacks
331     open_script
332     usage
333     validate_suid
334     emulate_eaccess
335     reg
336     reganode
337     regatom
338     regbranch
339     regc
340     reguni
341     regclass
342     regclassutf8
343     regcurly
344     reg_node
345     regpiece
346     reginsert
347     regoptail
348     regset
349     regtail
350     regwhite
351     nextchar
352     dumpuntil
353     scan_commit
354     study_chunk
355     add_data
356     re_croak2
357     regpposixcc
358     clear_re
359     regmatch
360     regrepeat
361     regrepeat_hard
362     regtry
363     reginclass
364     reginclassutf8
365     regcppush
366     regcppop
367     regcp_set_to
368     cache_re
369     restore_pos
370     reghop
371     reghopmaybe
372     dump
373     do_aspawn
374     debprof
375     bset_obj_store
376     new_logop
377     simplify_sort
378     is_handle_constructor
379     sv_add_backref
380     sv_del_backref
381     do_trans_CC_simple
382     do_trans_CC_count
383     do_trans_CC_complex
384     do_trans_UU_simple
385     do_trans_UU_count
386     do_trans_UU_complex
387     do_trans_UC_simple
388     do_trans_CU_simple
389     do_trans_UC_trivial
390     do_trans_CU_trivial
391     unwind_handler_stack
392     restore_magic
393     restore_rsfp
394     restore_expect
395     restore_lex_expect
396     yydestruct
397     del_sv
398     fprintf
399 );
400
401 for $sym (sort(keys(%global),@staticfuncs)) {
402     print EM embedobj($sym);
403 }
404
405 print EM <<'END';
406
407 #endif  /* PERL_OBJECT */
408
409 /* compatibility stubs */
410
411 #define sv_setptrobj(rv,ptr,name)       sv_setref_iv(rv,name,(IV)ptr)
412 #define sv_setptrref(rv,ptr)            sv_setref_iv(rv,Nullch,(IV)ptr)
413
414 END
415
416 close(EM);
417
418 unlink 'embedvar.h';
419 open(EM, '> embedvar.h')
420     or die "Can't create embedvar.h: $!\n";
421
422 print EM <<'END';
423 /* !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!! 
424    This file is built by embed.pl from global.sym, pp.sym, intrpvar.h,
425    perlvars.h and thrdvar.h.  Any changes made here will be lost!
426 */
427
428 /* (Doing namespace management portably in C is really gross.) */
429
430 /* Put interpreter-specific symbols into a struct? */
431
432 #ifdef MULTIPLICITY
433
434 #ifndef USE_THREADS
435 /* If we do not have threads then per-thread vars are per-interpreter */
436
437 END
438
439 for $sym (sort keys %thread) {
440     print EM multon($sym,'T','PL_curinterp->');
441 }
442
443 print EM <<'END';
444
445 #endif /* !USE_THREADS */
446
447 /* These are always per-interpreter if there is more than one */
448
449 END
450
451 for $sym (sort keys %intrp) {
452     print EM multon($sym,'I','PL_curinterp->');
453 }
454
455 print EM <<'END';
456
457 #else   /* !MULTIPLICITY */
458
459 END
460
461 for $sym (sort keys %intrp) {
462     print EM multoff($sym,'I');
463 }
464
465 print EM <<'END';
466
467 #ifndef USE_THREADS
468
469 END
470
471 for $sym (sort keys %thread) {
472     print EM multoff($sym,'T');
473 }
474
475 print EM <<'END';
476
477 #endif /* USE_THREADS */
478
479 /* Hide what would have been interpreter-specific symbols? */
480
481 END
482
483 for $sym (sort keys %intrp) {
484     print EM embedvar($sym);
485 }
486
487 print EM <<'END';
488
489 #ifndef USE_THREADS
490
491 END
492
493 for $sym (sort keys %thread) {
494     print EM embedvar($sym);
495 }
496
497 print EM <<'END';
498
499 #endif /* USE_THREADS */
500 #endif /* MULTIPLICITY */
501
502 /* Now same trickey for per-thread variables */
503
504 #ifdef USE_THREADS
505
506 END
507
508 for $sym (sort keys %thread) {
509     print EM multon($sym,'T','thr->');
510 }
511
512 print EM <<'END';
513
514 #endif /* USE_THREADS */
515
516 #ifdef PERL_GLOBAL_STRUCT
517
518 END
519
520 for $sym (sort keys %globvar) {
521     print EM multon($sym,'G','PL_Vars.');
522 }
523
524 print EM <<'END';
525
526 #else /* !PERL_GLOBAL_STRUCT */
527
528 END
529
530 for $sym (sort keys %globvar) {
531     print EM multoff($sym,'G');
532 }
533
534 print EM <<'END';
535
536 END
537
538 for $sym (sort keys %globvar) {
539     print EM embedvar($sym);
540 }
541
542 print EM <<'END';
543
544 #endif /* PERL_GLOBAL_STRUCT */
545
546 END
547
548 print EM <<'END';
549
550 #ifdef PERL_POLLUTE             /* disabled by default in 5.006 */
551
552 END
553
554 for $sym (sort @extvars) {
555     print EM hide($sym,"PL_$sym");
556 }
557
558 print EM <<'END';
559
560 #endif /* PERL_POLLUTE */
561 END
562
563
564 close(EM);
565
566 unlink 'objXSUB.h';
567 open(OBX, '> objXSUB.h')
568     or die "Can't create objXSUB.h: $!\n";
569
570 print OBX <<'EOT';
571 /* !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!! 
572    This file is built by embed.pl from global.sym, pp.sym, intrpvar.h,
573    perlvars.h and thrdvar.h.  Any changes made here will be lost!
574 */
575
576 #ifndef __objXSUB_h__
577 #define __objXSUB_h__
578
579 /* Variables */
580
581 EOT
582
583 foreach my $sym (sort(keys(%intrp),
584                       keys(%thread),
585                       keys(%globvar),
586                       keys(%objvar)))
587 {
588     print OBX objxsub_var($sym);
589 }
590
591 print OBX <<'EOT';
592
593 /* Functions */
594
595 EOT
596
597
598 for $sym (sort(keys(%global),@staticfuncs)) {
599     print OBX objxsub_func($sym);
600 }
601
602
603 print OBX <<'EOT';
604
605 #endif  /* __objXSUB_h__ */
606 EOT
607
608 close(OBX);