#!/usr/bin/perl use IO::File; # Open up the output files $fh = new IO::File "> api.html"; # Lists for the index @IText = (); @ISettings = (); @IDrawing = (); @IDevices = (); @IInteractive = (); @Device = (); @Test = (); @Settings = (); @Drawing = (); @Interactive = (); # Subroutine for parsing individual comments sub processComment { my $fh; my @prototype; my $type = ''; my $name = ''; my $desciption = ''; my @seeAlso; my @lists; $desciption = ''; undef @lists; undef @seeAlso; undef @prototype; # Get all the info do { # Get the name and type if ($_[0] =~ m/.* (Interactive|Text|Drawing|Device|Settings):\s*(.*)$/) { ($type, $name) = ($1, $2); } # Get the desciption elsif ($_[0] =~ m/^.*Synopsis:\s*(.*)$/) { $description = $1; while ($_[1] =~ m/\s\*\s*(\S.*)$/) { $description = $description . ' ' . $1; shift; } } # Get the see also list elsif ($_[0] =~ m/.* See Also: (.*)$/) { @seeAlso = split (/,\s*/, $1); } # Get any lists elsif ($_[0] =~ m/\s*\*\s*(\S.*):/) { # the title my @tmp = (); push @tmp, $1; # the items while ($_[1] =~ m/\s*\*\s*\-(.*)\s*:\-\s*(\S.*)$/) { push @tmp, $1; push @tmp, $2; shift; # Items over more than one line. while ($_[1] !~ m/^\s*\*\s*\-.*\s*:\-\s*\S.*$/ && $_[1] !~ m/^\s*\*\s*$/ && $_[1] =~ m/^\s*\*/) { $_[1] =~ m/^\s*\*\s*(\S.*)$/; push (@tmp, pop (@tmp) . ' ' . $1); shift; } } push @lists, \@tmp; } # Fuction prototype elsif ($_[0] !~ m/^ \*/) { # Type chomp ($_[0]); push @prototype, $_[0]; shift; chomp ($_[0]); # Name push @prototype, substr ($_[0], 0, index ($_[0], ' ')); # Arguments push @prototype, substr ($_[0], index ($_[0], ' ')); while (shift) { $_[0] =~ m/^\s*(.*)$/; push @prototype, pop (@prototype) . " $1"; } } } while (shift); # Add to the index and description lists if ($type eq "Text") { $IFile = \@IText; $File = \@Text; } elsif ($type eq "Drawing") { $IFile = \@IDrawing; $File = \@Drawing; } elsif ($type eq "Device") { $IFile = \@IDevice; $File = \@Device; } elsif ($type eq "Settings") { $IFile = \@ISettings; $File = \@Settings; } elsif ($type eq "Interactive") { $IFile = \@IInteractive; $File = \@Interactive; } else { return; } push @$IFile, $name; # Name push @$File, "

$name

\n"; # Prototype push @$File, "\n
" . shift (@prototype) . "" . shift (@prototype) . "" . shift (@prototype) . ";
"; # Description push @$File, "

$description

\n"; # Lists foreach $item (@lists) { # Name push @$File, "

" . shift (@$item) . ":

\n"; # Table preamble push @$File, ""; # Table contents while (@$item) { push @$File, "\n"; push @$File, "\n"; } # Table postamble push @$File, "
" . shift (@$item) . ":" . shift (@$item) . "
"; } # See Also if (@seeAlso) { push @$File, "

See Also:

"; foreach (@seeAlso) { push @$File, "$_ "; } push @$File, "

"; } } # prossess each comment my @currentComment = (); my $inComment = 0; while (<>) { # Begin a comment if ($_ =~ m/\/\*\*/ && $inComment == 0) { $inComment = 1; } # End comment elsif ($_ =~ m/\*\// && $inComment == 1) { # Get the prototype as well my $nextL = <>; while ($nextL && $nextL !~ m/{/) { push @currentComment, $nextL; $nextL = <>; } &processComment (@currentComment); @currentComment = (); $inComment = 0; } # Add to comment elsif ($inComment == 1) { push (@currentComment, $_); } } # Write the output file # First the formating junk $fh->print ( " giza - API Reference Manual
\"giza\"

API Reference Manual

Here we provided a function by function reference for the low-level C API to giza.
The giza API is stable. From version 1.0 we aim to keep backwards compatibility, although new functionality may be added

Index

"); # Then the index $fh->print ("
Device Management
\n"); foreach (@IDevice) { $fh->print ("
$_
\n"); } $fh->print ("
Drawing
\n"); foreach (@IDrawing) { $fh->print ("
$_
\n"); } $fh->print ("
Text
\n"); foreach (@IText) { $fh->print ("
$_
\n"); } $fh->print ("
Settings
\n"); foreach (@ISettings) { $fh->print ("
$_
\n"); } $fh->print ("
Interactive
\n"); foreach (@IInteractive) { $fh->print ("
$_
\n"); } $fh->print ("
"); # Write descriptions for Device Management $fh->print ("

Device Managment

\n"); foreach (@Device) { $fh->print ("$_"); } # Write descriptions for Drawing $fh->print ("

Drawing

\n"); foreach (@Drawing) { $fh->print ("$_"); } # Write descriptions for Text $fh->print ("

Text

\n"); foreach (@Text) { $fh->print ("$_"); } # Write descriptions for Settings $fh->print ("

Settings

\n"); foreach (@Settings) { $fh->print ("$_"); } # Write descriptions for Interactive $fh->print ("

Interactive

\n"); foreach (@Interactive) { $fh->print ("$_"); } # Close the files $fh->flush (); $fh->close ();