1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
|
#!./miniperl
=head1 NAME
xsubpp - compiler to convert Perl XS code into C code
=head1 SYNOPSIS
B<xsubpp> [B<-C++>] [B<-except>] [B<-typemap typemap>] file.xs
=head1 DESCRIPTION
I<xsubpp> will compile XS code into C code by embedding the constructs
necessary to let C functions manipulate Perl values and creates the glue
necessary to let Perl access those functions. The compiler uses typemaps to
determine how to map C function parameters and variables to Perl values.
The compiler will search for typemap files called I<typemap>. It will use
the following search path to find default typemaps, with the rightmost
typemap taking precedence.
../../../typemap:../../typemap:../typemap:typemap
=head1 OPTIONS
=over 5
=item B<-C++>
Adds ``extern "C"'' to the C code.
=item B<-except>
Adds exception handling stubs to the C code.
=item B<-typemap typemap>
Indicates that a user-supplied typemap should take precedence over the
default typemaps. This option may be used multiple times, with the last
typemap having the highest precedence.
=back
=head1 ENVIRONMENT
No environment variables are used.
=head1 AUTHOR
Larry Wall
=head1 SEE ALSO
perl(1)
=cut
$usage = "Usage: xsubpp [-C++] [-except] [-typemap typemap] file.xs\n";
SWITCH: while ($ARGV[0] =~ s/^-//) {
$flag = shift @ARGV;
$spat = shift, next SWITCH if $flag eq 's';
$cplusplus = 1, next SWITCH if $flag eq 'C++';
$except = 1, next SWITCH if $flag eq 'except';
push(@tm,shift), next SWITCH if $flag eq 'typemap';
die $usage;
}
@ARGV == 1 or die $usage;
chop($pwd = `pwd`);
($dir, $filename) = @ARGV[0] =~ m#(.*)/(.*)#
or ($dir, $filename) = @ARGV[0] =~ m#(.*[>\]])(.*)#
or ($dir, $filename) = ('.', $ARGV[0]);
chdir($dir);
$typemap = shift @ARGV;
foreach $typemap (@tm) {
die "Can't find $typemap in $pwd\n" unless -r $typemap;
}
unshift @tm, qw(../../../typemap ../../typemap ../typemap typemap);
foreach $typemap (@tm) {
open(TYPEMAP, $typemap) || next;
$mode = Typemap;
$current = \$junk;
while (<TYPEMAP>) {
next if /^#/;
if (/^INPUT\s*$/) { $mode = Input, next }
if (/^OUTPUT\s*$/) { $mode = Output, next }
if (/^TYPEMAP\s*$/) { $mode = Typemap, next }
if ($mode eq Typemap) {
chop;
($typename, $kind) = split(/\t+/, $_, 2);
$type_kind{$typename} = $kind if $kind ne '';
}
elsif ($mode eq Input) {
if (/^\s/) {
$$current .= $_;
}
else {
s/\s*$//;
$input_expr{$_} = '';
$current = \$input_expr{$_};
}
}
else {
if (/^\s/) {
$$current .= $_;
}
else {
s/\s*$//;
$output_expr{$_} = '';
$current = \$output_expr{$_};
}
}
}
close(TYPEMAP);
}
foreach $key (keys %input_expr) {
$input_expr{$key} =~ s/\n+$//;
}
sub Q {
local $text = shift;
$text =~ tr/#//d;
$text =~ s/\[\[/{/g;
$text =~ s/\]\]/}/g;
$text;
}
open(F, $filename) || die "cannot open $filename\n";
while (<F>) {
last if ($Module, $foo, $Package, $foo1, $Prefix) =
/^MODULE\s*=\s*([\w:]+)(\s+PACKAGE\s*=\s*([\w:]+))?(\s+PREFIX\s*=\s*(\S+))?\s*$/;
print $_;
}
exit 0 if $_ eq "";
$lastline = $_;
sub fetch_para {
# parse paragraph
@line = ();
if ($lastline ne "") {
if ($lastline =~
/^MODULE\s*=\s*([\w:]+)(\s+PACKAGE\s*=\s*([\w:]+))?(\s+PREFIX\s*=\s*(\S+))?\s*$/) {
$Module = $1;
$foo = $2;
$Package = $3;
$foo1 = $4;
$Prefix = $5;
($Module_cname = $Module) =~ s/\W/_/g;
($Packid = $Package) =~ s/:/_/g;
$Packprefix = $Package;
$Packprefix .= "::" if defined $Packprefix && $Packprefix ne "";
while (<F>) {
chop;
next if /^#/ &&
!/^#[ \t]*(if|ifdef|ifndef|else|elif|endif|define|undef)\b/;
last if /^\S/;
}
push(@line, $_) if $_ ne "";
}
else {
push(@line, $lastline);
}
$lastline = "";
while (<F>) {
next if /^#/ &&
!/^#[ \t]*(if|ifdef|ifndef|else|elif|endif|define|undef)\b/;
chop;
if (/^\S/ && @line && $line[-1] eq "") {
$lastline = $_;
last;
}
else {
push(@line, $_);
}
}
pop(@line) while @line && $line[-1] =~ /^\s*$/;
}
$PPCODE = grep(/PPCODE:/, @line);
scalar @line;
}
while (&fetch_para) {
# initialize info arrays
undef(%args_match);
undef(%var_types);
undef(%var_addr);
undef(%defaults);
undef($class);
undef($static);
undef($elipsis);
# extract return type, function name and arguments
$ret_type = shift(@line);
if ($ret_type =~ /^BOOT:/) {
push (@BootCode, @line, "", "") ;
next ;
}
if ($ret_type =~ /^static\s+(.*)$/) {
$static = 1;
$ret_type = $1;
}
$func_header = shift(@line);
($func_name, $orig_args) = $func_header =~ /^([\w:]+)\s*\((.*)\)$/;
if ($func_name =~ /(.*)::(.*)/) {
$class = $1;
$func_name = $2;
}
($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
push(@Func_name, "${Packid}_$func_name");
push(@Func_pname, $pname);
@args = split(/\s*,\s*/, $orig_args);
if (defined($class)) {
if (defined($static)) {
unshift(@args, "CLASS");
$orig_args = "CLASS, $orig_args";
$orig_args =~ s/^CLASS, $/CLASS/;
}
else {
unshift(@args, "THIS");
$orig_args = "THIS, $orig_args";
$orig_args =~ s/^THIS, $/THIS/;
}
}
$orig_args =~ s/"/\\"/g;
$min_args = $num_args = @args;
foreach $i (0..$num_args-1) {
if ($args[$i] =~ s/\.\.\.//) {
$elipsis = 1;
$min_args--;
if ($args[i] eq '' && $i == $num_args - 1) {
pop(@args);
last;
}
}
if ($args[$i] =~ /([^=]*\S)\s*=\s*(.*)/) {
$min_args--;
$args[$i] = $1;
$defaults{$args[$i]} = $2;
$defaults{$args[$i]} =~ s/"/\\"/g;
}
}
if (defined($class)) {
$func_args = join(", ", @args[1..$#args]);
} else {
$func_args = join(", ", @args);
}
@args_match{@args} = 1..@args;
# print function header
print Q<<"EOF";
#XS(XS_${Packid}_$func_name)
#[[
# dXSARGS;
EOF
if ($elipsis) {
$cond = qq(items < $min_args);
}
elsif ($min_args == $num_args) {
$cond = qq(items != $min_args);
}
else {
$cond = qq(items < $min_args || items > $num_args);
}
print Q<<"EOF" if $except;
# char errbuf[1024];
# *errbuf = '\0';
EOF
print Q<<"EOF";
# if ($cond) {
# croak("Usage: $pname($orig_args)");
# }
EOF
print Q<<"EOF" if $PPCODE;
# SP -= items;
EOF
# Now do a block of some sort.
$condnum = 0;
if (!@line) {
@line = "CLEANUP:";
}
while (@line) {
if ($_[0] =~ s/^\s*CASE\s*:\s*//) {
$cond = shift(@line);
if ($condnum == 0) {
print " if ($cond)\n";
}
elsif ($cond ne '') {
print " else if ($cond)\n";
}
else {
print " else\n";
}
$condnum++;
}
if ($except) {
print Q<<"EOF";
# TRY [[
EOF
}
else {
print Q<<"EOF";
# [[
EOF
}
# do initialization of input variables
$thisdone = 0;
$retvaldone = 0;
$deferred = "";
while (@line) {
$_ = shift(@line);
last if /^\s*NOT_IMPLEMENTED_YET/;
last if /^\s*(PPCODE|CODE|OUTPUT|CLEANUP|CASE)\s*:/;
# Catch common error. Much more error checking required here.
blurt("Error: no tab in $pname argument declaration '$_'\n")
unless (m/\S+\s*\t\s*\S+/);
($var_type, $var_name, $var_init) =
/\s*([^\t]+)\s*([^\s=]+)\s*(=.*)?/;
if ($var_name =~ /^&/) {
$var_name =~ s/^&//;
$var_addr{$var_name} = 1;
}
$thisdone |= $var_name eq "THIS";
$retvaldone |= $var_name eq "RETVAL";
$var_types{$var_name} = $var_type;
print "\t" . &map_type($var_type);
$var_num = $args_match{$var_name};
if ($var_addr{$var_name}) {
$func_args =~ s/\b($var_name)\b/&\1/;
}
if ($var_init !~ /^=\s*NO_INIT\s*$/) {
if ($var_init !~ /^\s*$/) {
&output_init($var_type, $var_num,
"$var_name $var_init");
} elsif ($var_num) {
# generate initialization code
&generate_init($var_type, $var_num, $var_name);
} else {
print ";\n";
}
} else {
print "\t$var_name;\n";
}
}
if (!$thisdone && defined($class)) {
if (defined($static)) {
print "\tchar *";
$var_types{"CLASS"} = "char *";
&generate_init("char *", 1, "CLASS");
}
else {
print "\t$class *";
$var_types{"THIS"} = "$class *";
&generate_init("$class *", 1, "THIS");
}
}
# do code
if (/^\s*NOT_IMPLEMENTED_YET/) {
print "\ncroak(\"$pname: not implemented yet\");\n";
} else {
if ($ret_type ne "void") {
print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
if !$retvaldone;
$args_match{"RETVAL"} = 0;
$var_types{"RETVAL"} = $ret_type;
}
if (/^\s*PPCODE:/) {
print $deferred;
while (@line) {
$_ = shift(@line);
die "PPCODE must be last thing"
if /^\s*(OUTPUT|CLEANUP|CASE)\s*:/;
print "$_\n";
}
print "\tPUTBACK;\n\treturn;\n";
} elsif (/^\s*CODE:/) {
print $deferred;
while (@line) {
$_ = shift(@line);
last if /^\s*(OUTPUT|CLEANUP|CASE)\s*:/;
print "$_\n";
}
} elsif ($func_name eq "DESTROY") {
print $deferred;
print "\n\t";
print "delete THIS;\n"
} else {
print $deferred;
print "\n\t";
if ($ret_type ne "void") {
print "RETVAL = ";
}
if (defined($static)) {
if ($func_name =~ /^new/) {
$func_name = "$class";
}
else {
print "$class::";
}
} elsif (defined($class)) {
print "THIS->";
}
if (defined($spat) && $func_name =~ /^($spat)(.*)$/) {
$func_name = $2;
}
print "$func_name($func_args);\n";
&generate_output($ret_type, 0, "RETVAL")
unless $ret_type eq "void";
}
}
# do output variables
if (/^\s*OUTPUT\s*:/) {
while (@line) {
$_ = shift(@line);
last if /^\s*CLEANUP\s*:/;
s/^\s+//;
($outarg, $outcode) = split(/\t+/);
if ($outcode) {
print "\t$outcode\n";
} else {
die "$outarg not an argument"
unless defined($args_match{$outarg});
$var_num = $args_match{$outarg};
&generate_output($var_types{$outarg}, $var_num,
$outarg);
}
}
}
# do cleanup
if (/^\s*CLEANUP\s*:/) {
while (@line) {
$_ = shift(@line);
last if /^\s*CASE\s*:/;
print "$_\n";
}
}
# print function trailer
if ($except) {
print Q<<EOF;
# ]]
# BEGHANDLERS
# CATCHALL
# sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
# ENDHANDLERS
EOF
}
else {
print Q<<EOF;
# ]]
EOF
}
if (/^\s*CASE\s*:/) {
unshift(@line, $_);
}
}
print Q<<EOF if $except;
# if (errbuf[0])
# croak(errbuf);
EOF
print Q<<EOF unless $PPCODE;
# XSRETURN(1);
EOF
print Q<<EOF;
#]]
#
EOF
}
# print initialization routine
print qq/extern "C"\n/ if $cplusplus;
print Q<<"EOF";
#XS(boot_$Module_cname)
#[[
# dXSARGS;
# char* file = __FILE__;
#
EOF
for (@Func_name) {
$pname = shift(@Func_pname);
print " newXS(\"$pname\", XS_$_, file);\n";
}
if (@BootCode)
{
print "\n /* Initialisation Section */\n\n" ;
print grep (s/$/\n/, @BootCode) ;
print " /* End of Initialisation Section */\n\n" ;
}
print " ST(0) = &sv_yes;\n";
print " XSRETURN(1);\n";
print "}\n";
sub output_init {
local($type, $num, $init) = @_;
local($arg) = "ST(" . ($num - 1) . ")";
eval qq/print " $init\\\n"/;
}
sub blurt { warn @_; $errors++ }
sub generate_init {
local($type, $num, $var) = @_;
local($arg) = "ST(" . ($num - 1) . ")";
local($argoff) = $num - 1;
local($ntype);
local($tk);
blurt("$type not in typemap"), return unless defined($type_kind{$type});
($ntype = $type) =~ s/\s*\*/Ptr/g;
$subtype = $ntype;
$subtype =~ s/Ptr$//;
$subtype =~ s/Array$//;
$tk = $type_kind{$type};
$tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
$type =~ s/:/_/g;
$expr = $input_expr{$tk};
if ($expr =~ /DO_ARRAY_ELEM/) {
$subexpr = $input_expr{$type_kind{$subtype}};
$subexpr =~ s/ntype/subtype/g;
$subexpr =~ s/\$arg/ST(ix_$var)/g;
$subexpr =~ s/\n\t/\n\t\t/g;
$subexpr =~ s/is not of (.*")/[arg %d] is not of $1, ix_$var + 1/g;
$subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
$expr =~ s/DO_ARRAY_ELEM/$subexpr/;
}
if (defined($defaults{$var})) {
$expr =~ s/(\t+)/$1 /g;
$expr =~ s/ /\t/g;
eval qq/print "\\t$var;\\n"/;
$deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
} elsif ($expr !~ /^\t\$var =/) {
eval qq/print "\\t$var;\\n"/;
$deferred .= eval qq/"\\n$expr;\\n"/;
} else {
eval qq/print "$expr;\\n"/;
}
}
sub generate_output {
local($type, $num, $var) = @_;
local($arg) = "ST(" . ($num - ($num != 0)) . ")";
local($argoff) = $num - 1;
local($ntype);
if ($type =~ /^array\(([^,]*),(.*)\)/) {
print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1)), XFree((char *)$var);\n";
} else {
blurt("$type not in typemap"), return
unless defined($type_kind{$type});
($ntype = $type) =~ s/\s*\*/Ptr/g;
$ntype =~ s/\(\)//g;
$subtype = $ntype;
$subtype =~ s/Ptr$//;
$subtype =~ s/Array$//;
$expr = $output_expr{$type_kind{$type}};
if ($expr =~ /DO_ARRAY_ELEM/) {
$subexpr = $output_expr{$type_kind{$subtype}};
$subexpr =~ s/ntype/subtype/g;
$subexpr =~ s/\$arg/ST(ix_$var)/g;
$subexpr =~ s/\$var/${var}[ix_$var]/g;
$subexpr =~ s/\n\t/\n\t\t/g;
$expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
eval "print qq\a$expr\a";
}
elsif ($var eq 'RETVAL') {
if ($expr =~ /^\t\$arg = /) {
eval "print qq\a$expr\a";
print "\tsv_2mortal(ST(0));\n";
}
else {
print "\tST(0) = sv_newmortal();\n";
eval "print qq\a$expr\a";
}
}
elsif ($arg =~ /^ST\(\d+\)$/) {
eval "print qq\a$expr\a";
}
elsif ($arg =~ /^ST\(\d+\)$/) {
eval "print qq\a$expr\a";
}
elsif ($arg =~ /^ST\(\d+\)$/) {
eval "print qq\a$expr\a";
}
}
}
sub map_type {
local($type) = @_;
$type =~ s/:/_/g;
if ($type =~ /^array\(([^,]*),(.*)\)/) {
return "$1 *";
} else {
return $type;
}
}
exit $errors;
|