summaryrefslogtreecommitdiff
path: root/utils
diff options
context:
space:
mode:
authorIlya Zakharevich <ilya@math.berkeley.edu>2000-10-03 17:43:01 -0400
committerJarkko Hietaniemi <jhi@iki.fi>2000-10-04 12:20:16 +0000
commitb7d5fa84b877120eda5ebc2013a83a96accf6536 (patch)
treea713b43e28986e9dd6c88602677ad5b35f05cd0c /utils
parent55a105fde08b8ff7e431e93257b2fe180eb0327d (diff)
downloadperl-b7d5fa84b877120eda5ebc2013a83a96accf6536.tar.gz
[PATCH 5.7.0] h2xs not working
Message-ID: <20001003214301.A22851@monk.mps.ohio-state.edu> Date: Tue, 3 Oct 2000 21:43:01 -0400 Subject: [PATCH 5.7.0] h2xs not documenting the created module From: Ilya Zakharevich <ilya@math.ohio-state.edu> Date: Tue, 3 Oct 2000 22:55:19 -0400 Message-ID: <20001003225519.A23360@monk.mps.ohio-state.edu> p4raw-id: //depot/perl@7141
Diffstat (limited to 'utils')
-rw-r--r--utils/h2xs.PL79
1 files changed, 77 insertions, 2 deletions
diff --git a/utils/h2xs.PL b/utils/h2xs.PL
index 2885c6f5ee..a5aa72476f 100644
--- a/utils/h2xs.PL
+++ b/utils/h2xs.PL
@@ -905,6 +905,7 @@ my $exp_doc = <<EOD;
#None by default.
#
EOD
+
if (@const_names and not $opt_P) {
$exp_doc .= <<EOD;
#=head2 Exportable constants
@@ -913,21 +914,31 @@ if (@const_names and not $opt_P) {
#
EOD
}
+
if (defined $fdecls and @$fdecls and not $opt_P) {
$exp_doc .= <<EOD;
#=head2 Exportable functions
#
EOD
+
# $exp_doc .= <<EOD if $opt_p;
#When accessing these functions from Perl, prefix C<$opt_p> should be removed.
#
-EOD
+#EOD
$exp_doc .= <<EOD;
# @{[join "\n ", @known_fnames{@fnames}]}
#
EOD
}
+my $meth_doc = '';
+
+if ($opt_x && $opt_a) {
+ my($name, $struct);
+ $meth_doc .= accessor_docs($name, $struct)
+ while ($name, $struct) = each %structs;
+}
+
my $pod = <<"END" unless $opt_P;
## Below is stub documentation for your module. You better edit it!
#
@@ -947,7 +958,7 @@ my $pod = <<"END" unless $opt_P;
#unedited.
#
#Blah blah blah.
-$exp_doc$revhist
+$exp_doc$meth_doc$revhist
#=head1 AUTHOR
#
#$author, $email
@@ -1406,6 +1417,70 @@ EOF
}
}
+sub accessor_docs {
+ my($name, $struct) = @_;
+ return unless defined $struct && $name !~ /\s|_ANON/;
+ $name = normalize_type($name);
+ my $ptrname = $name . 'Ptr';
+ my @items = @$struct;
+ my @list;
+ while (@items) {
+ my $item = shift @items;
+ if ($item->[0] =~ /_ANON/) {
+ if (defined $item->[2]) {
+ push @items, map [
+ @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
+ ], @{ $structs{$item->[0]} };
+ } else {
+ push @items, @{ $structs{$item->[0]} };
+ }
+ } else {
+ push @list, $item->[2];
+ }
+ }
+ my $methods = (join '(...)>, C<', @list), '(...)';
+
+ return <<"EOF";
+
+=head2 Object and class methods for C<$name>/C<$ptrname>
+
+The principal Perl representation of a C object of type C<$name> is an
+object of class C<$ptrname> which is a reference to an integer
+representation of a C pointer. To create such an object, one may use
+a combination
+
+ my $buffer = $name->new();
+ my $obj = $buf->_to_ptr();
+
+This exersizes the following two methods, and an additional class
+C<$name>, the internal representation of which is a reference to a
+packed string with the C structure. Keep in mind that $buffer should
+better survive longer than $obj.
+
+=over
+
+=item C<\$object_of_type_$name->_to_ptr()>
+
+Converts an object of type C<$name> to an object of type C<$ptrname>.
+
+=item C<$name->new()>
+
+Creates an empty object of type C<$name>. The corresponding packed
+string is zeroed out.
+
+=item C<$methods>
+
+return the current value of the corresponding element if called
+without additional arguments. Set the element to the supplied value
+(and return the new value) if called with an additional argument.
+
+Applicable to objects of type C<$ptrname>.
+
+=back
+
+EOF
+}
+
# Should be called before any actual call to normalize_type().
sub get_typemap {
# We do not want to read ./typemap by obvios reasons.