Changeset 11981

Timestamp:

07/24/10 19:42:37 (19 months ago)

Author:

azawawi

Message:

Removed HTML formatting from method descriptions and converted C++ constructor to their Perl equivalent. The generated wxwidgets.pod looks like:
=head1 Wx::class_name
=head2 Wx::class_name::method_name
...

File:

• trunk/tools/parse_wxwidgets_docs.pl (modified) (4 diffs)

trunk/tools/parse_wxwidgets_docs.pl

@@ -10 +10 @@
 use HTTP::Request    ();
 use Archive::Extract ();
+use HTML::Parse      qw(parse_html);
+use HTML::FormatText ();
 
 my $WX_WIGDETS_HTML_ZIP = 'wxWidgets-2.8.10-HTML.zip';
@@ -25 +27 @@
 print "Found " . @wxclasses . " Wx Classes to parse\n";
 
-# Step 4: Process all Wx classes gathering information
-my $func = {};
-foreach my $wxclass (@wxclasses) {
-    my $file = File::Spec->join($wx_dir, $wxclass->{file});
-    my $class = $wxclass->{class};
-    print "Processing $class...\n";
-    
-    if(open my $fh, '<', $file) {
-        my $begin_block = 0;
-        my $buffer = '';
-        my $name;
-        while(my $line = <$fh>) {
-            if($line =~ /<HR>/) {
-                $begin_block = 1;
-                $buffer = '';
-            } elsif($begin_block && $line =~ /<H3>(.+?)<\/H3>/) {
-                $name = $1;
-                $name =~ s/wx(.+?)/Wx::$1/;
-            } elsif($line =~ /^\s*$/) {
-                $begin_block = 0;
-                if($name) {
-                    $func->{$name} = $buffer;
-                }
-                $name = undef;
-            } else {
-                $buffer .= $line;
-            }
-        }
-    }
-}
+# Step 4: Write the final POD while processing all html files
+write_pod($wx_dir, @wxclasses);
 
-# Step 5: Write the final POD
-my $pod_file = 'wxwidgets.pod';
-print "Writing $pod_file\n";
-if(open(my $fh, '>', 'wxwidgets.pod')) {
-    foreach my $name (keys %$func) {
-        my $desc = $func->{$name};
-        print $fh "=head1 $name\n$desc\n\n";
-    }
-} else {
-    die "Couldnt write $pod_file\n";
-}
+# and we're done
 exit;
 
@@ -131 +95 @@
                 my ($file, $class) = ($1, $2);
                 $class =~ s/wx(.+?)/Wx::$1/;
-                push @wxclasses, { "file" => $file, "class" => $class };
+                push @wxclasses, { file => $file, class => $class };
             }
         }
@@ -139 +103 @@
 
     return @wxclasses;
+}
+
+#
+# Writes wxwidgets.pod... :)
+#
+sub write_pod {
+    my ($wx_dir, @wxclasses) = @_;
+    my $pod_file = 'wxwidgets.pod';
+    print "Writing $pod_file\n";
+    if(open(my $pod, '>', 'wxwidgets.pod')) {
+        my $oldclass;
+        foreach my $wxclass (@wxclasses) {
+            my $file = File::Spec->join($wx_dir, $wxclass->{file});
+            my $class = $wxclass->{class};
+            print "Processing $class...\n";
+            
+            if(open my $html_file, '<', $file) {
+                my $desc = '';
+                my $name;
+                while(my $line = <$html_file>) {
+                    if($line =~ /<H3>(.+?)<\/H3>/) {
+                        $name = $1;
+                        $name =~ s/wx(.+?)/Wx::$1/;
+                        if($name =~ /^Wx::(.+?)::(.+?)$/) {
+                            if($2 eq "wx$1") {
+                                # C++ constructor... convert to Perl ::new
+                                $name = "$class\:\:new"
+                            }
+                        }
+                        $desc = '';
+                    } elsif($line =~ /^\s*$/) {
+                        if($name) {
+                            if(!$oldclass || $class ne $oldclass) {
+                                # print out new class header
+                                print $pod "=head1 $class\n\n";
+                                $oldclass = $class;
+                            }
+
+                            # print out method description
+$desc = HTML::FormatText->new->format(parse_html($desc));
+                            print $pod "=head2 $name\n$desc\n";
+
+                            $name = undef;
+                        }
+                    } else {
+                        $desc .= $line;
+                    }
+                }
+                close $html_file;
+            }
+        }
+        close $pod;
+    } else {
+        die "Couldnt write $pod_file\n";
+    }
+
 }