ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From co...@apache.org
Subject cvs commit: ant/src/etc/checkstyle RequiredHeader.txt checkstyle-config checkstyle-frames.xsl checkstyle-text.xsl checkstyle-xdoc.xsl
Date Thu, 03 Jul 2003 13:59:51 GMT
conor       2003/07/03 06:59:51

  Modified:    .        check.xml
  Added:       src/etc/checkstyle RequiredHeader.txt checkstyle-config
                        checkstyle-frames.xsl checkstyle-text.xsl
                        checkstyle-xdoc.xsl
  Removed:     src/etc  RequiredHeader.txt checkstyle-frames.xsl
  Log:
  Checkstyle update
  I've updated the checkstyle buildfile (check.xml) to the
  latest version of checkstyle. I've also updated
  the HTML stylesheet and created two new stylesheets to render
  the checkstyle report in plain text and the xdoc format we
  use for the other Ant documentation.
  
  I've also moved the checkstyle related stuff into its own area.
  
  Revision  Changes    Path
  1.6       +44 -8     ant/check.xml
  
  Index: check.xml
  ===================================================================
  RCS file: /home/cvs/ant/check.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -w -u -r1.5 -r1.6
  --- check.xml	14 Apr 2003 11:58:02 -0000	1.5
  +++ check.xml	3 Jul 2003 13:59:49 -0000	1.6
  @@ -1,20 +1,56 @@
  -<project default="checkstyle" name="CheckAnt">
  -  <property name="java.dir" value="src/main"/>
  +<?xml version="1.0"?>
  +<project default="htmlreport" name="CheckAnt">
  +<!--  <import file="build.xml"/> --> 
  +  <property name="src.dir" value="src"/>
  +  <property name="java.dir" value="${src.dir}/main"/>
  +  <property name="etc.dir" value="${src.dir}/etc"/>
  +  <property name="config.dir" value="${etc.dir}/checkstyle"/>
  +  <property name="build.dir" value="build"/>
  +  
  +  <property name="checkstyle.reportdir" value="${build.dir}/reports/checkstyle"/>
  +  <property name="checkstyle.raw" value="${checkstyle.reportdir}/raw.xml"/>
  +  <property name="stylesheet.html" value="${config.dir}/checkstyle-frames.xsl"/>
  +  <property name="stylesheet.text" value="${config.dir}/checkstyle-text.xsl"/>
  +  <property name="stylesheet.xdoc" value="${config.dir}/checkstyle-xdoc.xsl"/>
  +
  +  <property name="checkstyle.basedir" location="${java.dir}"/>
  +
  +  <!-- Ant Checkstyle report -->
     <property name="tocheck" value="**/*.java"/>  
     <property name="javadoc.scope" value="public"/>
     
     <target name="checkstyle">
  -    <taskdef name="checkstyle"
  -             classname="com.puppycrawl.tools.checkstyle.CheckStyleTask"/>
  -    <checkstyle headerFile="src/etc/RequiredHeader.txt"
  -                headerIgnoreLine="4"
  -                allowProtected="true"
  -                javadocScope="${javadoc.scope}">
  +    <mkdir dir="${checkstyle.reportdir}"/>
  +    <taskdef resource="checkstyletask.properties"/>
  +    <checkstyle config="${config.dir}/checkstyle-config" failOnViolation="false">
  +      <formatter type="xml" toFile="${checkstyle.raw}"/>
         <fileset dir="${java.dir}">
           <include name="${tocheck}"/>
         </fileset>
       </checkstyle>
     </target>
  +
  +  <target name="htmlreport">
  +    <mkdir dir="${checkstyle.reportdir}"/>
  +    <style in="${checkstyle.raw}" style="${stylesheet.html}"
  +           out="${checkstyle.reportdir}/html/output.txt">
  +      <param name="basedir" expression="${checkstyle.basedir}"/>
  +    </style>
  +  </target>
  +  
  +  <target name="textreport">
  +    <style in="${checkstyle.raw}" style="${stylesheet.text}"
  +           out="${checkstyle.reportdir}/report.txt">
  +    </style>
  +  </target>
  +
  +  <target name="xdocreport">
  +    <style in="${checkstyle.raw}" style="${stylesheet.xdoc}"
  +           out="${checkstyle.reportdir}/xdocs/index.xml">
  +      <param name="basedir" expression="${checkstyle.basedir}"/>
  +    </style>
  +  </target>
  +
     
   </project>
   
  
  
  
  1.1                  ant/src/etc/checkstyle/RequiredHeader.txt
  
  Index: RequiredHeader.txt
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "Ant" and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  
  
  1.1                  ant/src/etc/checkstyle/checkstyle-config
  
  Index: checkstyle-config
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
  
  <module name="Checker">
    <module name="TreeWalker">
      <!-- Javadoc requirements -->
      <module name="JavadocType">
        <property name="scope" value="protected"/>
        <property name="authorFormat" value="\S"/>
      </module>
      <module name="JavadocMethod">
        <property name="scope" value="protected"/>
        <property name="allowUndeclaredRTE" value="true"/>
      </module>
      <module name="JavadocVariable">
         <property name="scope" value="public"/>
      </module>        
      
      <!-- element naming -->
      <module name="PackageName">
        <!-- no uppercase letters, between 2 and 8 characters -->
        <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,7})*$"/>
      </module>
      <module name="TypeName"/>
      <module name="ConstantName"/>
      <module name="LocalFinalVariableName"/>
      <module name="LocalVariableName"/>
      <module name="MemberName"/>
      <module name="MethodName"/>
      <module name="ParameterName"/>
      <module name="StaticVariableName"/>
      
      <!-- required licence file -->
      <module name="Header">
          <property name="headerFile" value="${config.dir}/RequiredHeader.txt"/>
          <property name="ignoreLines" value="4"/>
      </module>
      
      <!-- Import conventions -->
      <module name="AvoidStarImport"/>
      <module name="IllegalImport"/>
      <module name="RedundantImport"/>
      <module name="UnusedImports"/>
      
      <!-- size limits -->
      <module name="FileLength"/>
      <module name="LineLength"/>
      <module name="MethodLength"/>
      <module name="ParameterNumber"/>
  
      <!-- whitespace checks -->
      <module name="EmptyForIteratorPad"/>
      <module name="NoWhitespaceAfter"/>
      <module name="NoWhitespaceBefore"/>
      <module name="OperatorWrap"/>
      <module name="ParenPad"/>
      <module name="TabCharacter"/>
      <module name="WhitespaceAfter"/>
      <module name="WhitespaceAround"/>
  
      <!-- Modifier Checks -->
      <module name="ModifierOrder"/>
      <module name="RedundantModifier"/>
      
      
      <!-- Checks for blocks -->
      <module name="AvoidNestedBlocks"/>
      <module name="EmptyBlock"/>
      <module name="LeftCurly"/>
      <module name="NeedBraces"/>
      <module name="RightCurly"/>
      
      
      <!-- Checks for common coding problems -->
      <module name="AvoidInlineConditionals"/>
      <module name="DoubleCheckedLocking"/>   
      <module name="EmptyStatement"/>
      <module name="EqualsHashCode"/>
      <module name="IllegalInstantiation">
        <property name="classes" value="java.lang.Boolean"/>
      </module>
      <module name="InnerAssignment"/>
      <module name="MagicNumber"/>
      <module name="MissingSwitchDefault"/>
      <module name="RedundantThrows"/>
      <module name="SimplifyBooleanExpression"/>
      <module name="SimplifyBooleanReturn"/>
      
      <!-- Checks for class design -->
      <module name="DesignForExtension"/>
      <module name="FinalClass"/>
      <module name="HideUtilityClassConstructor"/>
      <module name="InterfaceIsType"/>
      <module name="VisibilityModifier"/>
      
      <!-- Miscellaneous other checks.                   -->
      <module name="ArrayTypeStyle"/>
      <module name="GenericIllegalRegexp">
        <property name="format" value="\s+$"/>
        <property name="message" value="Line has trailing spaces."/>
      </module>
      <module name="TodoComment"/>
      <module name="UpperEll"/>
    </module>
  </module>
  
  
  1.1                  ant/src/etc/checkstyle/checkstyle-frames.xsl
  
  Index: checkstyle-frames.xsl
  ===================================================================
  <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
      xmlns:lxslt="http://xml.apache.org/xslt"
      xmlns:redirect="org.apache.xalan.xslt.extensions.Redirect"
      extension-element-prefixes="redirect">
  
  <!--
   The Apache Software License, Version 1.1
  
   Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
   reserved.
  
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
  
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
  
   3. The end-user documentation included with the redistribution, if
      any, must include the following acknowlegement:
         "This product includes software developed by the
          Apache Software Foundation (http://www.apache.org/)."
      Alternately, this acknowlegement may appear in the software itself,
      if and wherever such third-party acknowlegements normally appear.
  
   4. The names "Ant" and "Apache Software
      Foundation" must not be used to endorse or promote products derived
      from this software without prior written permission. For written
      permission, please contact apache@apache.org.
  
   5. Products derived from this software may not be called "Apache"
      nor may "Apache" appear in their names without prior written
      permission of the Apache Group.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.
   ====================================================================
  
   This software consists of voluntary contributions made by many
   individuals on behalf of the Apache Software Foundation.  For more
   information on the Apache Software Foundation, please see
   <http://www.apache.org/>.
   -->
  
      <xsl:output method="html" indent="yes" encoding="US-ASCII"/>
      <xsl:decimal-format decimal-separator="." grouping-separator="," />
  
      <xsl:param name="output.dir" select="'.'"/>
      <xsl:param name="basedir" select="'.'"/>
  
      <xsl:template match="checkstyle">
          <!-- create the index.html -->
          <redirect:write file="{$output.dir}/index.html">
              <xsl:call-template name="index.html"/>
          </redirect:write>
  
          <!-- create the stylesheet.css -->
          <redirect:write file="{$output.dir}/stylesheet.css">
              <xsl:call-template name="stylesheet.css"/>
          </redirect:write>
  
          <!-- create the overview-summary.html at the root -->
          <redirect:write file="{$output.dir}/overview-frame.html">
              <xsl:apply-templates select="." mode="overview"/>
          </redirect:write>
  
          <!-- create the all-classes.html at the root -->
          <redirect:write file="{$output.dir}/allclasses-frame.html">
              <xsl:apply-templates select="." mode="all.classes"/>
          </redirect:write>
  
          <!-- process all files -->
          <xsl:apply-templates select="file[count(error) != 0]"/>
      </xsl:template>
  
      <xsl:template name="index.html">
          <html>
              <head>
                  <title>CheckStyle Audit</title>
              </head>
              <frameset cols="20%,80%">
                  <frame src="allclasses-frame.html" name="fileListFrame"/>
                  <frame src="overview-frame.html" name="fileFrame"/>
              </frameset>
              <noframes>
                  <h2>Frame Alert</h2>
                  <p>
                      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.
                  </p>
              </noframes>
          </html>
      </xsl:template>
  
      <xsl:template name="pageHeader">
          <table border="0" cellpadding="0" cellspacing="0" width="100%">
              <tr>
                  <td class="text-align:right"><h2>CheckStyle Audit</h2></td>
              </tr>
              <tr>
                  <td class="text-align:right">Designed for use with 
                    <a href='http://checkstyle.sourceforge.net/'>CheckStyle</a>
and 
                    <a href='http://ant.apache.org/'>Ant</a>.</td>
              </tr>
          </table>
          <hr size="1"/>
      </xsl:template>
  
      <xsl:template match="checkstyle" mode="overview">
          <html>
              <head>
                  <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
              </head>
              <body>
                  <!-- page header -->
                  <xsl:call-template name="pageHeader"/>
  
                  <!-- Summary part -->
                  <xsl:apply-templates select="." mode="summary"/>
                  <hr size="1" width="100%" align="left"/>
  
                  <!-- File list part -->
                  <xsl:apply-templates select="." mode="filelist"/>
              </body>
          </html>
      </xsl:template>
  
      <xsl:template name="stylesheet.css">
          .bannercell {
          border: 0px;
          padding: 0px;
          }
          body {
          margin-left: 10;
          margin-right: 10;
          font:normal 80% arial,helvetica,sanserif;
          background-color:#FFFFFF;
          color:#000000;
          }
          .a td {
          background: #efefef;
          }
          .b td {
          background: #fff;
          }
          th, td {
          text-align: left;
          vertical-align: top;
          }
          th {
          font-weight:bold;
          background: #ccc;
          color: black;
          }
          table, th, td {
          font-size:100%;
          border: none
          }
          table.log tr td, tr th {
  
          }
          h2 {
          font-weight:bold;
          font-size:140%;
          margin-bottom: 5;
          }
          h3 {
          font-size:100%;
          font-weight:bold;
          background: #525D76;
          color: white;
          text-decoration: none;
          padding: 5px;
          margin-right: 2px;
          margin-left: 2px;
          margin-bottom: 0;
          }
      </xsl:template>
  
      <!--
      Creates an all-classes.html file that contains a link to all files.
      -->
      <xsl:template match="checkstyle" mode="all.classes">
          <html>
              <head>
                  <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
              </head>
              <body>
                  <h2>Files</h2>
                  <p>
                      <table width="100%">
                          <!-- For each file create its part -->
                          <xsl:apply-templates select="file[count(error) != 0]" mode="all.classes">
                              <xsl:sort select="substring-after(@name, $basedir)"/>
                          </xsl:apply-templates>
                      </table>
                  </p>
              </body>
          </html>
      </xsl:template>
  
      <xsl:template match="checkstyle" mode="filelist">
          <h3>Files</h3>
          <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
              <tr>
                  <th>Name</th>
                  <th>Errors</th>
              </tr>
              <xsl:apply-templates select="file[count(error) != 0]" mode="filelist">
                  <xsl:sort select="count(error)" order="descending" data-type="number"/>
              </xsl:apply-templates>
          </table>
      </xsl:template>
  
      <xsl:template match="file" mode="filelist">
          <tr>
              <xsl:call-template name="alternated-row"/>
              <td nowrap="nowrap">
                  <a>
                      <xsl:attribute name="href">
                          <xsl:text>files/</xsl:text><xsl:value-of select="substring-after(@name,
$basedir)"/><xsl:text>.html</xsl:text>
                      </xsl:attribute>
                      <xsl:value-of select="substring-after(@name, $basedir)"/>
                  </a>
              </td>
              <td><xsl:value-of select="count(error)"/></td>
          </tr>
      </xsl:template>
  
      <xsl:template match="file" mode="all.classes">
          <tr>
              <td nowrap="nowrap">
                  <a target="fileFrame">
                      <xsl:attribute name="href">
                          <xsl:text>files/</xsl:text><xsl:value-of select="substring-after(@name,
$basedir)"/><xsl:text>.html</xsl:text>
                      </xsl:attribute>
                      <xsl:value-of select="substring-after(@name, $basedir)"/>
                  </a>
              </td>
          </tr>
      </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>
  
      <xsl:template match="file">
          <redirect:write file="{$output.dir}/files/{substring-after(@name, $basedir)}.html">
              <html>
                  <head>
                      <link rel="stylesheet" type="text/css">
                          <xsl:attribute name="href"><xsl:call-template name="path"><xsl:with-param
name="path" select="substring-after(@name, $basedir)"/></xsl:call-template><xsl:text>stylesheet.css</xsl:text></xsl:attribute>
                      </link>
                  </head>
                  <body>
                      <xsl:call-template name="pageHeader"/>
                      <h3>File <xsl:value-of select="substring-after(@name, $basedir)"/></h3>
                      <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
                          <tr>
                              <th>Error Description</th>
                              <th>Line</th>
                          </tr>
                          <xsl:for-each select="error">
                              <tr>
                                  <xsl:call-template name="alternated-row"/>
                                  <td><a title="{@source}"><xsl:value-of select="@message"/></a></td>
                                  <td><xsl:value-of select="@line"/></td>
                              </tr>
                          </xsl:for-each>
                      </table>
                  </body>
              </html>
          </redirect:write>
      </xsl:template>
  
      <xsl:template match="checkstyle" mode="summary">
          <h3>Summary</h3>
          <xsl:variable name="fileCount" select="count(file)"/>
          <xsl:variable name="errorCount" select="count(file/error)"/>
          <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
              <tr>
                  <th>Files</th>
                  <th>Errors</th>
              </tr>
              <tr>
                  <xsl:call-template name="alternated-row"/>
                  <td><xsl:value-of select="$fileCount"/></td>
                  <td><xsl:value-of select="$errorCount"/></td>
              </tr>
          </table>
      </xsl:template>
  
      <xsl:template name="alternated-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>
  
  
  
  
  1.1                  ant/src/etc/checkstyle/checkstyle-text.xsl
  
  Index: checkstyle-text.xsl
  ===================================================================
  <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
  
  <!--
   The Apache Software License, Version 1.1
  
   Copyright (c) 2003 The Apache Software Foundation.  All rights
   reserved.
  
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
  
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
  
   3. The end-user documentation included with the redistribution, if
      any, must include the following acknowlegement:
         "This product includes software developed by the
          Apache Software Foundation (http://www.apache.org/)."
      Alternately, this acknowlegement may appear in the software itself,
      if and wherever such third-party acknowlegements normally appear.
  
   4. The names "Ant" and "Apache Software
      Foundation" must not be used to endorse or promote products derived
      from this software without prior written permission. For written
      permission, please contact apache@apache.org.
  
   5. Products derived from this software may not be called "Apache"
      nor may "Apache" appear in their names without prior written
      permission of the Apache Group.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.
   ====================================================================
  
   This software consists of voluntary contributions made by many
   individuals on behalf of the Apache Software Foundation.  For more
   information on the Apache Software Foundation, please see
   <http://www.apache.org/>.
   -->
  
      <xsl:strip-space elements="checkstyle"/>
      <xsl:preserve-space elements="file"/>
      <xsl:output method="text"/>
      <xsl:template match="checkstyle/file/error">
          <xsl:value-of select="../@name"/>
          <xsl:text>:</xsl:text>
          <xsl:value-of select="@line"/>
          <xsl:text>:</xsl:text>
          <xsl:value-of select="@column"/>
          <xsl:text> </xsl:text>
          <xsl:value-of select="@message"/>
      </xsl:template>
  </xsl:stylesheet>
  
  
  
  
  1.1                  ant/src/etc/checkstyle/checkstyle-xdoc.xsl
  
  Index: checkstyle-xdoc.xsl
  ===================================================================
  <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
      xmlns:lxslt="http://xml.apache.org/xslt"
      xmlns:redirect="org.apache.xalan.xslt.extensions.Redirect"
      extension-element-prefixes="redirect">
  
  <!--
   The Apache Software License, Version 1.1
  
   Copyright (c) 2003 The Apache Software Foundation.  All rights
   reserved.
  
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
  
   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
  
   3. The end-user documentation included with the redistribution, if
      any, must include the following acknowlegement:
         "This product includes software developed by the
          Apache Software Foundation (http://www.apache.org/)."
      Alternately, this acknowlegement may appear in the software itself,
      if and wherever such third-party acknowlegements normally appear.
  
   4. The names "Ant" and "Apache Software
      Foundation" must not be used to endorse or promote products derived
      from this software without prior written permission. For written
      permission, please contact apache@apache.org.
  
   5. Products derived from this software may not be called "Apache"
      nor may "Apache" appear in their names without prior written
      permission of the Apache Group.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   SUCH DAMAGE.
   ====================================================================
  
   This software consists of voluntary contributions made by many
   individuals on behalf of the Apache Software Foundation.  For more
   information on the Apache Software Foundation, please see
   <http://www.apache.org/>.
   -->
  
      <xsl:output method="xml" indent="yes"/>
      <xsl:decimal-format decimal-separator="." grouping-separator="," />
  
      <xsl:param name="output.dir" select="'.'"/>
      <xsl:param name="basedir" select="'.'"/>
  
      <xsl:template match="checkstyle">
        <document>
          <properties>
            <title>Checkstyle Audit</title>
          </properties>
  
          <body>
            <xsl:apply-templates select="." mode="summary"/>
            <!-- File list part -->
            <xsl:apply-templates select="." mode="filelist"/>
            <xsl:apply-templates select="file[count(error) != 0]"/>
          </body>
        </document>
      </xsl:template>
  
      <xsl:template match="checkstyle" mode="filelist">
        <section name="Files">
          <table>
              <tr>
                  <th>Name</th>
                  <th>Errors</th>
              </tr>
              <xsl:apply-templates select="file[count(error) != 0]" mode="filelist">
                  <xsl:sort select="count(error)" order="descending" data-type="number"/>
              </xsl:apply-templates>
          </table>
        </section>
      </xsl:template>
   
      <xsl:template match="file" mode="filelist">
          <tr>
              <xsl:call-template name="alternated-row"/>
              <td nowrap="nowrap">
                  <a>
                      <xsl:attribute name="href">
                          <xsl:text>files</xsl:text><xsl:value-of select="substring-after(@name,
$basedir)"/><xsl:text>.html</xsl:text>
                      </xsl:attribute>
                      <xsl:value-of select="substring-after(@name, $basedir)"/>
                  </a>
              </td>
              <td><xsl:value-of select="count(error)"/></td>
          </tr>
      </xsl:template>
  
      <xsl:template match="file">
        <redirect:write file="{$output.dir}/files{substring-after(@name, $basedir)}.xml">
          <document>
            <properties>
              <title>Checkstyle Audit</title>
            </properties>
  
            <body>
              <section name="Details for {substring-after(@name, $basedir)}">
                <table>
                    <tr>
                        <th>Error Description</th>
                        <th>Line</th>
                    </tr>
                    <xsl:for-each select="error">
                        <tr>
                            <xsl:call-template name="alternated-row"/>
                            <td><a title="{@source}"><xsl:value-of select="@message"/></a></td>
                            <td><xsl:value-of select="@line"/></td>
                        </tr>
                    </xsl:for-each>
                </table>
              </section>
            </body>
          </document>
        </redirect:write>
      </xsl:template>
  
      <xsl:template match="checkstyle" mode="summary">
        <section name="Summary">
          <xsl:variable name="fileCount" select="count(file)"/>
          <xsl:variable name="errorCount" select="count(file/error)"/>
          <table>
              <tr>
                  <th>Files</th>
                  <th>Errors</th>
              </tr>
              <tr>
                  <xsl:call-template name="alternated-row"/>
                  <td><xsl:value-of select="$fileCount"/></td>
                  <td><xsl:value-of select="$errorCount"/></td>
              </tr>
          </table>
        </section>
      </xsl:template>
  
      <xsl:template name="alternated-row">
          <xsl:attribute name="class">
              <xsl:if test="position() mod 2 = 1">oddrow</xsl:if>
              <xsl:if test="position() mod 2 = 0">evenrow</xsl:if>
          </xsl:attribute>
      </xsl:template>
  </xsl:stylesheet>
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message