/*

 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of the License "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description: 

 *

 */

package com.nokia.helium.antlint.ant.types;

import java.io.File;

import java.util.List;

import java.io.IOException;

import javax.xml.parsers.SAXParser;

import javax.xml.parsers.SAXParserFactory;

import javax.xml.parsers.ParserConfigurationException;

import org.xml.sax.SAXException;

import org.dom4j.Element;

import org.dom4j.Node;

import com.nokia.helium.antlint.AntLintHandler;

import com.nokia.helium.antlint.ant.AntlintException;

/**

 * <code>CheckTabCharacter</code> is used to check the tab characters inside the

 * ant files.

 * 

 * <pre>

 * Usage:

 * 

 *  <antlint>

 *       <fileset id="antlint.files" dir="${antlint.test.dir}/data">

 *               <include name="*.ant.xml"/>

 *               <include name="*build.xml"/>

 *               <include name="*.antlib.xml"/>

 *       </fileset>

 *       <CheckTabCharacter" severity="error" enabled="true" />

 *  </antlint>

 * </pre>

 * 

 * @ant.task name="CheckTabCharacter" category="AntLint"

 * 

 */

public class CheckTabCharacter extends AbstractCheck {

    private File antFile;

    /**

     * {@inheritDoc}

     */

    public void run(Element node) {

        checkTabsInScript(node);

    }

    /**

     * Check against the given node.

     * 

     * @param node

     *            is the node to check.

     */

    @SuppressWarnings("unchecked")

    private void checkTabsInScript(Element node) {

        if (node.getName().equals("target")) {

            String target = node.attributeValue("name");

            List<Node> statements = node.selectNodes("//target[@name='"

                    + target + "']/script | //target[@name='" + target

                    + "']/*[name()=\"hlm:python\"]");

            for (Node statement : statements) {

                if (statement.getText().contains("\t")) {

                    this.getReporter().report(getSeverity(),

                            "Target " + target + " has a script with tabs",

                            getAntFile(), 0);

                }

            }

        }

    }

    /*

     * (non-Javadoc)

     * 

     * @see com.nokia.helium.antlint.ant.types.Check#run(java.io.File)

     */

    public void run(File antFilename) throws AntlintException {

        try {

            this.antFile = antFilename;

            SAXParserFactory saxFactory = SAXParserFactory.newInstance();

            saxFactory.setNamespaceAware(true);

            saxFactory.setValidating(true);

            SAXParser parser = saxFactory.newSAXParser();

            AntLintHandler handler = new AntLintHandler(this);

            handler.setTabCharacterCheck(true);

            parser.parse(antFilename, handler);

        } catch (ParserConfigurationException e) {

            throw new AntlintException("Not able to parse XML file "

                    + e.getMessage());

        } catch (SAXException e) {

            throw new AntlintException("Not able to parse XML file "

                    + e.getMessage());

        } catch (IOException e) {

            throw new AntlintException("Not able to find XML file "

                    + e.getMessage());

        }

    }

    /*

     * (non-Javadoc)

     * 

     * @see org.apache.tools.ant.types.DataType#toString()

     */

    public String toString() {

        return "CheckTabCharacter";

    }

    /*

     * (non-Javadoc)

     * 

     * @see com.nokia.helium.antlint.ant.types.Check#getAntFile()

     */

    public File getAntFile() {

        return this.antFile;

    }

}