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
|
################################################################################
#
# mkppport_fnc.pl -- generate ppport.fnc
#
# This program should be run when regenerating the data for ppport.h
# (devel/regenerate). It should be run after parts/embed.fnc is updated, and
# after mkapidoc.pl has been run.
#
# Its purpose is to generate ppport.fnc, a file which has the same syntax as
# embed.fnc and apidoc.fnc, but contains entries that should only be tested
# when ppport.h is enabled during the test.
#
# Thus it includes items that are Devel::PPPort only, and items that it
# figures out aren't tested by the other two functions.
#
# These otherwise-untested items are those:
# 1) for which D:P provides and are not found in embed.fnc nor apidoc.fnc,
# or aren't listed as public API in those files
# 2) and for which tests can be automatically generated that they at least
# compile.
#
# The reason that an item isn't in those two files is that it is an
# undocumented macro. (If it's not a macro, it has to be in embed.fnc, and if
# it's documented, mkapidoc.pl would find it and place it in apidoc.fnc.)
#
# And, the reason we can't generate tests for undocumented macros is we don't
# readily know the types of the parameters, which we need to get a C program
# to compile. We could easily discover the number of parameters, but gleaning
# their types is harder.
#
# Instead of expending effort to cope with undocumented items, document them
# instead, improving the product doubly.
#
# However, if the macro has no parameters, there are no types to need to know.
# And, it turns out, that it may be that many of these macros (which typically
# just define constants) really don't need to be documented. They may be
# something that is considered to be provided, but should actually have been
# internal constants, not exposed to the outside world. And they're a lot of
# them. So this function was written to handle them.
#
# Algorithms could be devised to read the =xsubs sections and associate code
# found therein with the item, and to include the code as the test for the
# item, but again, it would be better to just document them.
#
# scanprov, run as part of regeneration, will find when all functions, API or
# not, became defined; but not macros.
################################################################################
#
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
#
################################################################################
use strict;
use warnings;
use re '/aa';
my $main_dir = $0;
my $source_dir = $ARGV[0];
die "Need base directory as argument" unless -e $source_dir;
# Up one level
$main_dir =~ s;[^/]*$;;;
$main_dir =~ s;/$;;;
# Up a second level
$main_dir =~ s;[^/]*$;;;
$main_dir =~ s;/$;;;
$main_dir = '.' unless $main_dir;
require "$main_dir/parts/ppptools.pl";
my @provided = map { /^(\w+)/ ? $1 : () } `$^X ppport.h --list-provided`;
die "Nothing provided" unless @provided;
my $api_fnc = "$main_dir/parts/apidoc.fnc";
my $embed_fnc = "$main_dir/parts/embed.fnc";
# One of the outputs is a known element provided only by us.
my @out = 'Am|void|sv_magic_portable|NN SV* sv|NULLOK SV* obj|int how|NULLOK const char* name|I32 namlen';
# First, get the known elements
my @embeds = parse_embed($api_fnc, $embed_fnc);
# Look for %include lines in the ppport.h generator
my $PPPort = "$main_dir/PPPort_pm.PL";
open F, "<", $PPPort or die "Can't open $PPPort: $!";
# Now find all the elements furnished by us whose signatures we don't know
# (hence not in embed.fnc nor apidoc.fnc) and have no parameters.
my @no_parameters;
while (<F>) {
next unless/^%include (\w+)/;
my @implementation = split /\n/,
parse_partspec("$main_dir/parts/inc/$1")->{'implementation'};
while (defined (my $line = shift @implementation)) {
my $var;
if ($line =~ /^ \s* __UNDEFINED__ \s+ (\w+) \s /x) {
$var = $1;
}
elsif ($line =~ /^ \s* __NEED_VAR__ \s+ (\w+) \s+ (\w+) /x) {
$var = $2;
}
elsif ($line =~ / ^ \# \s* define \s+ ( \w+ ) \s /x) {
$var = $1;
}
next unless defined $var;
next if $var =~ / ^ D_PPP_ /x; # Skip internal only
next if grep { $1 eq $_->{'name'} } @embeds; # Skip known elements
next if grep { $1 eq $_ } @no_parameters; # Skip if already have it
push @no_parameters, $var;
}
}
push @out, map { "AmnT|void|$_" } @no_parameters;
@out = sort sort_api_lines @out;
my $out = "parts/ppport.fnc";
open OUT, ">", $out or die "Could open '$out' for writing: $!";
print OUT <<EOF;
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
:
: !!!! Do NOT edit this file directly! -- Edit devel/mkppport_fnc.pl instead. !!!!
:
: Perl/Pollution/Portability
:
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
:
: Version 3.x, Copyright (C) 2004-2013, Marcus Holland-Moritz.
: Version 2.x, Copyright (C) 2001, Paul Marquess.
: Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
:
: This program is free software; you can redistribute it and/or
: modify it under the same terms as Perl itself.
:
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
:
: This file lists all functions/macros that are provided by Devel::PPPort that
: would not be tested otherwise; because either they are not public, or they
: exist only in D:P. It is in the same format as the F<embed.fnc> that ships
: with the Perl source code.
:
: Since these are used only to provide the argument types, it's ok to have the
: return value be void for some where it's a potential issue.
EOF
print OUT map { "$_\n" } sort sort_api_lines @out;
print OUT "\n";
print "$out regenerated\n";
close OUT;
|
