5713N/A<?xml version="1.0"?>
0N/A<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
0N/A xmlns:lxslt="http://xml.apache.org/xslt"
0N/A xmlns:redirect="org.apache.xalan.lib.Redirect"
0N/A extension-element-prefixes="redirect">
0N/A<xsl:output method="html" indent="yes" encoding="US-ASCII"/>
0N/A<xsl:decimal-format decimal-separator="." grouping-separator="," />
0N/A<!--
809N/A Licensed to the Apache Software Foundation (ASF) under one or more
809N/A contributor license agreements. See the NOTICE file distributed with
809N/A this work for additional information regarding copyright ownership.
809N/A The ASF licenses this file to You under the Apache License, Version 2.0
809N/A (the "License"); you may not use this file except in compliance with
809N/A the License. You may obtain a copy of the License at
809N/A
809N/A http://www.apache.org/licenses/LICENSE-2.0
809N/A
809N/A Unless required by applicable law or agreed to in writing, software
809N/A distributed under the License is distributed on an "AS IS" BASIS,
809N/A WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
809N/A See the License for the specific language governing permissions and
809N/A limitations under the License.
0N/A-->
0N/A<!--
0N/A
0N/A Stylesheet to transform an XML file generated by the Ant MAudit task into
0N/A a set of JavaDoc-like HTML page to make pages more convenient to be browsed.
0N/A
0N/A It use the Xalan redirect extension to write to multiple output files.
0N/A
0N/A @author Stephane Bailliez <a href="mailto:sbailliez@apache.org"/>
0N/A-->
0N/A
0N/A<xsl:param name="output.dir" select="'.'"/>
0N/A
0N/A
0N/A<xsl:template match="classes">
0N/A <!-- create the index.html -->
0N/A <redirect:write file="{$output.dir}/index.html">
0N/A <xsl:call-template name="index.html"/>
0N/A </redirect:write>
0N/A
0N/A <!-- create the stylesheet.css -->
0N/A <redirect:write file="{$output.dir}/stylesheet.css">
0N/A <xsl:call-template name="stylesheet.css"/>
0N/A </redirect:write>
0N/A
0N/A <!-- create the overview-packages.html at the root -->
0N/A <redirect:write file="{$output.dir}/overview-summary.html">
0N/A <xsl:apply-templates select="." mode="overview.packages"/>
0N/A </redirect:write>
0N/A
0N/A <!-- create the all-packages.html at the root -->
0N/A <redirect:write file="{$output.dir}/overview-frame.html">
0N/A <xsl:apply-templates select="." mode="all.packages"/>
0N/A </redirect:write>
0N/A
0N/A <!-- create the all-classes.html at the root -->
0N/A <redirect:write file="{$output.dir}/allclasses-frame.html">
0N/A <xsl:apply-templates select="." mode="all.classes"/>
0N/A </redirect:write>
0N/A
0N/A <!-- process all packages -->
0N/A <xsl:for-each select="/class[not(./@package = preceding-sibling::class/@package)]">
0N/A <xsl:call-template name="package">
0N/A <xsl:with-param name="name" select="@package"/>
0N/A </xsl:call-template>
0N/A </xsl:for-each>
0N/A</xsl:template>
0N/A
0N/A
0N/A<xsl:template name="package">
0N/A <xsl:param name="name"/>
0N/A <xsl:variable name="package.dir">
0N/A <xsl:if test="not($name = '')"><xsl:value-of select="translate($name,'.','/')"/></xsl:if>
0N/A <xsl:if test="$name = ''">.</xsl:if>
0N/A </xsl:variable>
0N/A <!--Processing package <xsl:value-of select="@name"/> in <xsl:value-of select="$output.dir"/> -->
0N/A <!-- create a classes-list.html in the package directory -->
0N/A <redirect:write file="{$output.dir}/{$package.dir}/package-frame.html">
0N/A <xsl:call-template name="classes.list">
0N/A <xsl:with-param name="name" select="$name"/>
0N/A </xsl:call-template>
0N/A </redirect:write>
0N/A
0N/A <!-- create a package-summary.html in the package directory -->
0N/A <redirect:write file="{$output.dir}/{$package.dir}/package-summary.html">
0N/A <xsl:call-template name="package.summary">
0N/A <xsl:with-param name="name" select="$name"/>
0N/A </xsl:call-template>
0N/A </redirect:write>
0N/A
0N/A <!-- for each class, creates a @name.html -->
0N/A <!-- @bug there will be a problem with inner classes having the same name, it will be overwritten -->
0N/A <xsl:for-each select="/classes/class[@package = $name]">
0N/A <redirect:write file="{$output.dir}/{$package.dir}/{@name}.html">
0N/A <xsl:apply-templates select="." mode="class.details"/>
0N/A </redirect:write>
0N/A </xsl:for-each>
0N/A</xsl:template>
0N/A
0N/A<xsl:template name="index.html">
0N/A<HTML>
0N/A <HEAD><TITLE>Audit Results.</TITLE></HEAD>
0N/A <FRAMESET cols="20%,80%">
0N/A <FRAMESET rows="30%,70%">
0N/A <FRAME src="overview-frame.html" name="packageListFrame"/>
0N/A <FRAME src="allclasses-frame.html" name="classListFrame"/>
0N/A </FRAMESET>
0N/A <FRAME src="overview-summary.html" name="classFrame"/>
0N/A </FRAMESET>
0N/A <noframes>
0N/A <H2>Frame Alert</H2>
0N/A <P>
0N/A This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
0N/A </P>
0N/A </noframes>
0N/A</HTML>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- this is the stylesheet css to use for nearly everything -->
0N/A<xsl:template name="stylesheet.css">
0N/A .bannercell {
0N/A border: 0px;
0N/A padding: 0px;
0N/A }
0N/A body {
0N/A margin-left: 10;
0N/A margin-right: 10;
0N/A font:normal 80% arial,helvetica,sanserif;
0N/A background-color:#FFFFFF;
0N/A color:#000000;
0N/A }
0N/A .a td {
0N/A background: #efefef;
0N/A }
0N/A .b td {
0N/A background: #fff;
0N/A }
0N/A th, td {
0N/A text-align: left;
0N/A vertical-align: top;
0N/A }
0N/A th {
0N/A font-weight:bold;
0N/A background: #ccc;
0N/A color: black;
0N/A }
0N/A table, th, td {
0N/A font-size:100%;
0N/A border: none
0N/A }
0N/A table.log tr td, tr th {
0N/A
0N/A }
0N/A h2 {
0N/A font-weight:bold;
0N/A font-size:140%;
0N/A margin-bottom: 5;
0N/A }
0N/A h3 {
0N/A font-size:100%;
0N/A font-weight:bold;
0N/A background: #525D76;
0N/A color: white;
0N/A text-decoration: none;
0N/A padding: 5px;
0N/A margin-right: 2px;
0N/A margin-left: 2px;
0N/A margin-bottom: 0;
0N/A }
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- print the violations of the class -->
0N/A<xsl:template match="class" mode="class.details">
0N/A <xsl:variable name="package.name" select="@package"/>
0N/A <HTML>
0N/A <HEAD>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name" select="$package.name"/>
0N/A </xsl:call-template>
0N/A </HEAD>
0N/A <BODY>
0N/A <xsl:call-template name="pageHeader"/>
0N/A <H3>Class <xsl:if test="not($package.name = '')"><xsl:value-of select="$package.name"/>.</xsl:if><xsl:value-of select="@name"/></H3>
0N/A
0N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <xsl:call-template name="class.audit.header"/>
0N/A <xsl:apply-templates select="." mode="print.audit"/>
0N/A </table>
0N/A
0N/A <H3>Violations</H3>
0N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <xsl:call-template name="violation.audit.header"/>
0N/A <xsl:apply-templates select="/violation" mode="print.audit">
0N/A <xsl:sort data-type="number" select="@line"/>
0N/A </xsl:apply-templates>
0N/A </table>
0N/A <xsl:call-template name="pageFooter"/>
0N/A </BODY>
0N/A </HTML>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- list of classes in a package -->
0N/A<xsl:template name="classes.list">
0N/A <xsl:param name="name"/>
0N/A <HTML>
0N/A <HEAD>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name" select="$name"/>
0N/A </xsl:call-template>
0N/A </HEAD>
0N/A <BODY>
0N/A <table width="100%">
0N/A <tr>
0N/A <td nowrap="nowrap">
0N/A <H2><a href="package-summary.html" target="classFrame"><xsl:value-of select="$name"/></a></H2>
0N/A </td>
0N/A </tr>
0N/A </table>
0N/A
0N/A <h2>Classes</h2>
0N/A <TABLE WIDTH="100%">
0N/A <xsl:apply-templates select="/classes/class[./@package = $name]" mode="classes.list">
0N/A <xsl:sort select="@name"/>
0N/A </xsl:apply-templates>
0N/A </TABLE>
0N/A </BODY>
0N/A </HTML>
0N/A</xsl:template>
0N/A<!-- the class to list -->
0N/A<xsl:template match="class" mode="classes.list">
0N/A <tr>
0N/A <td nowrap="nowrap">
0N/A <!-- @bug naming to fix for inner classes -->
0N/A <a href="{@name}.html" target="classFrame"><xsl:value-of select="@name"/></a>
0N/A </td>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!--
0N/A Creates an all-classes.html file that contains a link to all package-summary.html
0N/A on each class.
0N/A-->
0N/A<xsl:template match="classes" mode="all.classes">
0N/A <html>
0N/A <head>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name"/>
0N/A </xsl:call-template>
0N/A </head>
0N/A <body>
0N/A <h2>Classes</h2>
0N/A <table width="100%">
0N/A <xsl:apply-templates select=".//class" mode="all.classes">
0N/A <xsl:sort select="@name"/>
0N/A </xsl:apply-templates>
0N/A </table>
0N/A </body>
0N/A </html>
0N/A</xsl:template>
0N/A
0N/A<xsl:template match="class" mode="all.classes">
0N/A <!-- (ancestor::package)[last()] is buggy in MSXML3 ? -->
0N/A <xsl:variable name="package.name" select="@package"/>
0N/A <tr>
0N/A <td nowrap="nowrap">
0N/A <a target="classFrame">
0N/A <xsl:attribute name="href">
0N/A <xsl:if test="not($package.name='')">
0N/A <xsl:value-of select="translate($package.name,'.','/')"/><xsl:text>/</xsl:text>
0N/A </xsl:if><xsl:value-of select="@name"/><xsl:text>.html</xsl:text>
0N/A </xsl:attribute>
0N/A <xsl:value-of select="@name"/>
0N/A </a>
0N/A </td>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!--
0N/A Creates an html file that contains a link to all package-summary.html files on
0N/A each package existing on testsuites.
0N/A @bug there will be a problem here, I don't know yet how to handle unnamed package :(
0N/A-->
0N/A<xsl:template match="classes" mode="all.packages">
0N/A <html>
0N/A <head>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name"/>
0N/A </xsl:call-template>
0N/A </head>
0N/A <body>
0N/A <h2><a href="overview-summary.html" target="classFrame">Home</a></h2>
0N/A <h2>Packages</h2>
0N/A <table width="100%">
0N/A <xsl:apply-templates select="class[not(./@package = preceding-sibling::class/@package)]" mode="all.packages">
0N/A <xsl:sort select="@package" order="ascending"/>
0N/A </xsl:apply-templates>
0N/A </table>
0N/A </body>
0N/A </html>
0N/A</xsl:template>
0N/A
0N/A<xsl:template match="class" mode="all.packages">
0N/A <tr>
0N/A <td nowrap="nowrap">
0N/A <a href="{translate(@package,'.','/')}/package-summary.html" target="classFrame">
0N/A <xsl:value-of select="@package"/>
0N/A </a>
0N/A </td>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A
0N/A<xsl:template match="classes" mode="overview.packages">
0N/A <html>
0N/A <head>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name"/>
0N/A </xsl:call-template>
0N/A </head>
0N/A <body onload="open('allclasses-frame.html','classListFrame')">
0N/A <xsl:call-template name="pageHeader"/>
0N/A <h3>Summary</h3>
0N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <tr>
0N/A <th>Audited classes</th>
0N/A <th>Reported classes</th>
0N/A <th>Violations</th>
0N/A </tr>
0N/A <tr class="a">
0N/A <td><xsl:value-of select="@audited"/></td>
0N/A <td><xsl:value-of select="@reported"/></td>
0N/A <td><xsl:value-of select="@violations"/></td>
0N/A </tr>
0N/A </table>
0N/A <table border="0" width="100%">
0N/A <tr>
0N/A <td style="text-align: justify;">
0N/A Note: Rules checked have originated from style guidelines suggested by the language designers,
0N/A experience from the Java development community and insite experience. Violations are generally
0N/A reported with a reference to the <a href="http://java.sun.com/docs/books/jls/second_edition/html/jTOC.doc.html">Java Language Specifications</a> (JLS x.x.x)
0N/A and Metamata Audit rules (x.x).
0N/A Please consult these documents for additional information about violations.
0N/A <p/>
0N/A Rules checked also enforce adherence to <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Sun Java coding guidelines</a> in use at Jakarta.
0N/A <p/>
0N/A One should note that these violations do not necessary underline errors but should be used
0N/A as an indication for <i>possible</i> errors. As always, use your best judgment and review
0N/A them carefully, it might save you hours of debugging.
0N/A </td>
0N/A </tr>
0N/A </table>
0N/A
0N/A <h3>Packages</h3>
0N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <xsl:call-template name="class.audit.header"/>
0N/A <xsl:for-each select="class[not(./@package = preceding-sibling::class/@package)]">
0N/A <xsl:sort select="@package" order="ascending"/>
0N/A <tr>
0N/A <xsl:call-template name="alternate-row"/>
0N/A <td><a href="{translate(@package,'.','/')}/package-summary.html"><xsl:value-of select="@package"/></a></td>
0N/A <td><xsl:value-of select="sum(/classes/class[./@package = current()/@package]/@violations)"/></td>
0N/A </tr>
0N/A </xsl:for-each>
0N/A </table>
0N/A <xsl:call-template name="pageFooter"/>
0N/A </body>
0N/A </html>
0N/A</xsl:template>
0N/A
0N/A
0N/A<xsl:template name="package.summary">
0N/A <xsl:param name="name"/>
0N/A <HTML>
0N/A <HEAD>
0N/A <xsl:call-template name="create.stylesheet.link">
0N/A <xsl:with-param name="package.name" select="$name"/>
0N/A </xsl:call-template>
0N/A </HEAD>
0N/A <BODY>
0N/A <xsl:attribute name="onload">open('package-frame.html','classListFrame')</xsl:attribute>
0N/A <xsl:call-template name="pageHeader"/>
0N/A <h3>Package <xsl:value-of select="$name"/></h3>
0N/A
0N/A <!--table border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <xsl:call-template name="class.metrics.header"/>
0N/A <xsl:apply-templates select="." mode="print.metrics"/>
0N/A </table-->
0N/A
0N/A <xsl:if test="count(/classes/class[./@package = $name]) &gt; 0">
0N/A <H3>Classes</H3>
0N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
0N/A <xsl:call-template name="class.audit.header"/>
0N/A <xsl:apply-templates select="/classes/class[./@package = $name]" mode="print.audit">
0N/A <xsl:sort select="@name"/>
0N/A </xsl:apply-templates>
0N/A </table>
0N/A </xsl:if>
0N/A <xsl:call-template name="pageFooter"/>
0N/A </BODY>
0N/A </HTML>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!--
0N/A transform string like a.b.c to ../../../
0N/A @param path the path to transform into a descending directory path
0N/A-->
0N/A<xsl:template name="path">
0N/A <xsl:param name="path"/>
0N/A <xsl:if test="contains($path,'.')">
0N/A <xsl:text>../</xsl:text>
0N/A <xsl:call-template name="path">
0N/A <xsl:with-param name="path"><xsl:value-of select="substring-after($path,'.')"/></xsl:with-param>
0N/A </xsl:call-template>
0N/A </xsl:if>
0N/A <xsl:if test="not(contains($path,'.')) and not($path = '')">
0N/A <xsl:text>../</xsl:text>
0N/A </xsl:if>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- create the link to the stylesheet based on the package name -->
0N/A<xsl:template name="create.stylesheet.link">
0N/A <xsl:param name="package.name"/>
0N/A <LINK REL ="stylesheet" TYPE="text/css" TITLE="Style"><xsl:attribute name="href"><xsl:if test="not($package.name = 'unnamed package')"><xsl:call-template name="path"><xsl:with-param name="path" select="$package.name"/></xsl:call-template></xsl:if>stylesheet.css</xsl:attribute></LINK>
0N/A</xsl:template>
0N/A
0N/A<!-- Page HEADER -->
0N/A<xsl:template name="pageHeader">
0N/A
0N/A <!-- jakarta logo -->
0N/A <table border="0" cellpadding="0" cellspacing="0" width="100%">
0N/A <tr>
0N/A <td class="bannercell" rowspan="2">
0N/A <a href="http://jakarta.apache.org/">
0N/A <img src="http://jakarta.apache.org/images/jakarta-logo.gif" alt="http://jakarta.apache.org" align="left" border="0"/>
0N/A </a>
0N/A </td>
0N/A <td style="text-align:right"><h2>Source Code Audit</h2></td>
0N/A </tr>
0N/A <tr>
0N/A <td style="text-align:right">Designed for use with <a href='http://www.webgain.com/products/quality_analyzer/'>Webgain QA/Metamata Audit</a> and <a href='http://jakarta.apache.org'>Ant</a>.</td>
0N/A </tr>
0N/A </table>
0N/A <hr size="1"/>
0N/A</xsl:template>
0N/A
0N/A<!-- Page HEADER -->
0N/A<xsl:template name="pageFooter">
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- class header -->
0N/A<xsl:template name="class.audit.header">
0N/A <tr>
0N/A <th width="80%">Name</th>
0N/A <th>Violations</th>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A<!-- method header -->
0N/A<xsl:template name="violation.audit.header">
0N/A <tr>
0N/A <th>Line</th>
0N/A <th>Message</th>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A
0N/A<!-- class information -->
0N/A<xsl:template match="class" mode="print.audit">
0N/A <tr>
0N/A <xsl:call-template name="alternate-row"/>
0N/A <td><a href="{@name}.html"><xsl:value-of select="@name"/></a></td>
0N/A <td><xsl:apply-templates select="@violations"/></td>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A<xsl:template match="violation" mode="print.audit">
0N/A <tr>
0N/A <xsl:call-template name="alternate-row"/>
0N/A <td><xsl:value-of select="@line"/></td>
0N/A <td><xsl:apply-templates select="@message"/></td>
0N/A </tr>
0N/A</xsl:template>
0N/A
0N/A<!-- alternated row style -->
0N/A<xsl:template name="alternate-row">
0N/A<xsl:attribute name="class">
0N/A <xsl:if test="position() mod 2 = 1">a</xsl:if>
0N/A <xsl:if test="position() mod 2 = 0">b</xsl:if>
0N/A</xsl:attribute>
0N/A</xsl:template>
0N/A
0N/A</xsl:stylesheet>
0N/A