/* ======================================================================
The Bodington System Software License, Version 1.0
 
Copyright (c) 2001 The University of Leeds.  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 acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.
 
4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.
 
5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.
 
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS 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 was originally created by the University of Leeds and may contain voluntary
contributions from others.  For more information on the Bodington Open Source Project, please
see http://bodington.org/
 
====================================================================== */

package org.bodington.util.html;

import org.htmlparser.Attribute;
import org.htmlparser.Tag;
import org.htmlparser.lexer.Page;

public class Utils
{
    /**
     * Limit the value to the bounds.
     * @param value The value to limit.
     * @param lower The lower limit.
     * @param upper The upper limit.
     * @return The value inside the bounds.
     */
    public static int bound(int value, int lower, int upper)
    {
        if (value < lower)
            return lower;
        if (value > upper)
            return upper;
        return value;
    }

    /**
     * Gets the texts surrounding the supplied tag.
     * @param tag The tag to get the text surrounding.
     * @return A string containing the tag and a little more.
     */
    public static String getInContext(Tag tag)
    {
        final int lower = 0;
        final int upper = tag.getPage().getSource().offset();
        return tag.getPage().getText(
            bound(tag.getStartPosition() - 5, lower, upper),
            bound(tag.getEndPosition() + 5, lower, upper));
    }
    
    /**
     * Get the line of the input that contains the start of the tag.
     * @param tag The tag to get the line for.
     * @return The line of text.
     */
    public static String getInLine(Tag tag)
    {
        return tag.getPage().getLine(tag.getStartPosition());
    }
    
    public static String formatLineColumn(Tag tag)
    {
        Page page = tag.getPage();
        int start = tag.getStartPosition();
        return "( line: " + (page.row(start) + 1) + ", column: "
            + (page.column(start) + 1) + " )";
    }
    
    public static String badTag(Tag tag)
    {
        return "Invalid tag <"+ tag.getTagName()+ "> at "+
            formatLineColumn(tag);
    }
    
    public static String badTagContent(Tag tag)
    {
        return "Invalid content for tag <"+ tag.getTagName()+ "> at "+
        formatLineColumn(tag);
    }
    
    
    public static String badAttribute(Tag tag, Attribute attribute)
    {
        return "Invalid attribute '"+ attribute.getName()+ "' found in tag <"+
        tag.getTagName()+ "> "+ formatLineColumn(tag);
    }
    
    public static String badAttributeValue(Tag tag, Attribute attribute)
    {
        return "Invalid content for attribute '"+ attribute.getName()+ "' found in tag <"+
        tag.getTagName()+ "> at "+ formatLineColumn(tag);
    }

}