diff options
Diffstat (limited to 'ACE/MPC/devtools/document_template.pl')
| -rwxr-xr-x | ACE/MPC/devtools/document_template.pl | 372 |
1 files changed, 372 insertions, 0 deletions
diff --git a/ACE/MPC/devtools/document_template.pl b/ACE/MPC/devtools/document_template.pl new file mode 100755 index 00000000000..f1c51f65cd4 --- /dev/null +++ b/ACE/MPC/devtools/document_template.pl @@ -0,0 +1,372 @@ +#! /usr/bin/perl +eval '(exit $?0)' && eval 'exec perl -w -S $0 ${1+"$@"}' + & eval 'exec perl -w -S $0 $argv:q' + if 0; + +# ****************************************************************** +# Author: Chad Elliott +# Date: 7/12/2006 +# $Id$ +# ****************************************************************** + +# ****************************************************************** +# Pragma Section +# ****************************************************************** + +use strict; +use FileHandle; +use FindBin; +use File::Spec; +use File::Basename; + +my $basePath = $FindBin::Bin; +if ($^O eq 'VMS') { + $basePath = File::Spec->rel2abs(dirname($0)) if ($basePath eq ''); + $basePath = VMS::Filespec::unixify($basePath); +} +$basePath = dirname($basePath); +unshift(@INC, $basePath . '/modules'); + +require ProjectCreator; +require TemplateParser; +require ConfigParser; +require StringProcessor; + +# ****************************************************************** +# Data Section +# ****************************************************************** + +my %keywords; +my %arrow_op; +my $doc_ext = '.txt'; +my $version = '1.3'; + +# ****************************************************************** +# Subroutine Section +# ****************************************************************** + +sub setup_keywords { + my $language = shift; + + ## Get the main MPC keywords + my $keywords = ProjectCreator::getKeywords(); + foreach my $key (keys %$keywords) { + $keywords{$key} = 1; + } + + ## Get the MPC valid components + $keywords = ProjectCreator::getValidComponents($language); + foreach my $key (keys %$keywords) { + $keywords{lc($key)} = 1; + } + + ## Get the pseudo template variables + my $pjc = new ProjectCreator(); + $keywords = $pjc->get_command_subs(); + foreach my $key (keys %$keywords) { + $keywords{$key} = 1; + } + + ## Get the template function names + $keywords = TemplateParser::getKeywords(); + foreach my $key (keys %$keywords) { + $keywords{$key} = 1; + } + + ## Get the template parser arrow operator keys + $keywords = TemplateParser::getArrowOp(); + foreach my $key (keys %$keywords) { + $arrow_op{$key} = 1; + } +} + + +sub display_template { + my($fh, $cp, $input, $tkeys) = @_; + + print $fh '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">', "\n", + "<head>\n", + " <title>$input</title>\n", + " <style type=\"text/css\">\n", + " h1 {font: 36pt verdana, lucida; width: 800px; color: darkcyan;}\n", + " td {font: 12pt verdana, lucida; color: white; padding: 3px; background-color: cadetblue;}\n", + " td.sub {font: 12pt verdana, lucida; color: white; padding: 3px; background-color: darkcyan;}\n", + " td.subsub {font: 12pt verdana, lucida; color: white; padding: 3px; padding-left: 12px; background-color: darkcyan;}\n", + " thead tr td {font: 16pt \"trebuchet ms\", helvetica; color: white; padding: 3px; background-color: teal;}\n", + " th {font: 14pt bold verdana, lucida; background-color: teal; color: white; padding: 3px;}\n", + " </style>\n", + "</head>\n", + "<body>\n", + " <h1>$input</h1>\n", + " <table>\n", + " <tr>\n", + " <th>Template Variable</th>\n", + " <th>Default Value</th>\n", + " <th>Description</th>\n", + " </tr>\n"; + foreach my $key (sort keys %$tkeys) { + my $desc = $cp->get_value($key) || ' '; + my $def; + if (defined $$tkeys{$key}) { + foreach my $ikey (sort keys %{$$tkeys{$key}}) { + if (defined $def) { + $def .= ' <b>or</b> '; + } + else { + $def = ''; + } + $def .= StringProcessor::process_special(undef, $ikey); + } + } + + ## Convert < and > to html friendly codes + $desc =~ s/</</g; + $desc =~ s/>/>/g; + + print $fh " <tr>\n", + " <td>$key</td>\n", + " <td>", (defined $def ? $def : ' '), "</td>\n", + " <td>$desc</td>\n", + " </tr>\n"; + } + print $fh " </table>\n", + "</body>\n"; +} + + +sub usageAndExit { + print "document_template.pl v$version\n", + "Usage: ", basename($0), " <template> [<html output> [language]]\n\n", + "html output - This defaults to the name of the template file ", + "with the .mpd\n extenion replaced with .html.\n", + "language - This defaults to the language for which the ", + "template is designed.\n It can be any of the valid ", + "language settings for MPC:\n ", + join(' ', sort(Creator::validLanguages())), "\n"; + exit(0); +} + +# ****************************************************************** +# Main Section +# ****************************************************************** + +my $status = 0; +my $fh = new FileHandle(); +my $input = $ARGV[0]; +my $output = $ARGV[1]; +my $language = $ARGV[2]; + +usageAndExit() if (!defined $input || $input =~ /^-/); + +if (!defined $output) { + $output = $input; + $output =~ s/\.mpd$//; + $output .= '.html'; +} + +if (open($fh, $input)) { + if (!defined $language) { + if (index($input, 'vb') != -1) { + $language = Creator::vb(); + } + elsif (index($input, 'csharp') != -1 || index($input, '.net') != -1) { + $language = Creator::csharp(); + } + elsif (index($input, 'java') != -1) { + $language = Creator::java(); + } + else { + $language = Creator::cplusplus(); + } + } + + my %template_keys; + setup_keywords($language); + + my @foreach; + my $findex = -1; + while(<$fh>) { + my $len = length($_); + for(my $start = 0; $start < $len;) { + my $sindex = index($_, '<%', $start); + if ($sindex >= 0) { + my $eindex = index($_, '%>', $sindex); + if ($eindex >= $sindex) { + $eindex += 2; + } + else { + $eindex = $len; + } + + my $part = substr($_, $sindex, $eindex - $sindex); + my $key = substr($part, 2, length($part) - 4); + my $name = lc($key); + my $tvar; + my $def; + if ($key =~ /^([^\(]+)\((.*)\)/) { + $name = lc($1); + my $vname = $2; + + if (defined $keywords{$name}) { + $tvar = 1; + if ($name eq 'foreach') { + ++$findex; + + ## Remove the functions inside the foreach + foreach my $keyword (keys %keywords) { + $vname =~ s/$keyword\(([^\)]+)\)/$1/gi; + } + + my $remove_s = 1; + if ($vname =~ /([^,]*),(.*)/) { + my $n = $1; + my $v = $2; + $n =~ s/^\s+//; + $n =~ s/\s+$//; + $v =~ s/^\s+//; + $v =~ s/\s+$//; + + if ($n =~ /^\d+$/) { + $n = $v; + } + else { + $remove_s = undef; + } + $vname = $n; + } + + $name = lc($vname); + + $key = lc($vname); + $vname =~ s/\s.*//; + $vname =~ s/s$// if ($remove_s); + + $foreach[$findex] = lc($vname); + $tvar = undef; + } + elsif ($name eq 'if') { + $vname =~ s/(!|&&|\|\|)//g; + + ## Keep pulling off keyword functions until we get down to + ## the actual template variable used in the function call. + my $retry; + do { + $retry = undef; + foreach my $keyword (keys %keywords) { + if ($vname =~ s/$keyword\((.*)[\)]?/$1/g) { + $retry = 1 if ($vname ne ''); + last; + } + } + } while($retry); + $vname =~ s/\s*,.*//; + $vname =~ s/\)//g; + + if ($vname !~ /^\s*$/) { + $name = lc($vname); + $key = lc($vname); + $tvar = undef; + } + } + } + else { + $def = $2; + } + } + else { + $key = lc($key); + } + + my $otvar = $tvar; + foreach my $k (split(/\s+/, $key)) { + $tvar = $otvar; + if (defined $keywords{$k}) { + $tvar = 1; + if ($k eq 'endfor') { + $foreach[$findex] = undef; + --$findex; + } + } + else { + foreach my $ao (keys %arrow_op) { + if ($k =~ /^$ao/) { + $tvar = 1; + last; + } + } + } + + if (!$tvar) { + for(my $index = 0; $index <= $findex; $index++) { + if ($foreach[$index] eq $k) { + $tvar = 1; + last; + } + } + } + + if (!$tvar) { + foreach my $n (split(/\s+/, $name)) { + $tvar = undef; + if (defined $keywords{$n}) { + } + else { + foreach my $ao (keys %arrow_op) { + if ($n =~ /^$ao/) { + $tvar = 1; + last; + } + } + if (!$tvar) { + if (defined $template_keys{$n}) { + if (defined $def) { + $template_keys{$n}->{$def} = 1; + } + } + else { + $template_keys{$n} = {}; + $template_keys{$n}->{$def} = 1 if (defined $def); + } + } + } + } + } + } + $start = $eindex; + } + else { + $start += ($len - $start); + } + } + } + close($fh); + + my $cp = new ConfigParser(); + $cp->read_file("$basePath/docs/templates/common$doc_ext"); + + my $doc = $input; + $doc =~ s/\.[^\.]+$/$doc_ext/; + $doc =~ s/templates/docs\/templates/; + if (-r $doc) { + $cp->read_file($doc); + } + else { + $cp->read_file("$basePath/docs/templates/" . basename($doc)); + } + + if (open($fh, ">$output")) { + display_template($fh, $cp, $input, \%template_keys); + close($fh); + } + else { + print STDERR "ERROR: Unable to open $output for writing\n"; + ++$status; + } +} +else { + print STDERR "ERROR: Unable to open $input for reading\n"; + ++$status; +} + +exit($status); + |