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