/*   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *  limitations under the License.
 */


package xmlcursor.common;

import junit.framework.*;
import junit.framework.Assert.*;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlCursor.TokenType;
import org.apache.xmlbeans.XmlError;

import javax.xml.namespace.QName;
import java.util.*;

/**
 * 
 */
public class BasicCursorTestCase extends TestCase {
     protected XmlObject m_xo;
     protected XmlCursor m_xc;

    public BasicCursorTestCase(String sName) {
        super(sName);
    }

    protected void setUp() throws Exception {
    }

    protected void tearDown() {
        m_xo = null;
        if (m_xc != null) {
            m_xc.dispose();
            m_xc = null;
        }
    }

    /*
    public void testRuntimeClassPath() throws Exception
    {
        fail(System.getProperty("java.class.path"));
    }
    */

    /**
     * Method testFilesInClassPath
     *
     * tests for files directory in local environment:
     *                  ${cajun.dir}/knex/test/local/files
     *   or automation environment:
     *                  ${install.tempdir}/testcase/files
     *
     * If these directories are not in runtime classpath, locating files
     * using getSystemResource() will fail causing false test failures.
     *
     * TODO: we should really make these identical as the test isn't foolproof
     *
     * @throws   Exception
     *
     */
    public void testForFilesInClassPath() throws Exception {
        String sClassPath = System.getProperty("java.class.path");
        int i = sClassPath.indexOf("schemajars");
        if (i < 0) {
            fail("files directory not found in runtime classpath.  Ant script error!");
        }
        assertTrue(true);
    }

    public void toNextTokenOfType(XmlCursor xc, TokenType tt) throws IllegalArgumentException {
        if (xc == null) {
            throw new IllegalArgumentException("Invalid argument: null XmlCursor");
        } else if (tt == null) {
            throw new IllegalArgumentException("Invalid argument: null TokenType");
        }

        while (xc.toNextToken() != tt) {
            if (xc.currentTokenType() == TokenType.ENDDOC)
                fail("Expected Token not found! " + tt.toString());
        }
        assertEquals(tt, xc.currentTokenType());
    }

    public void toPrevTokenOfType(XmlCursor xc, TokenType tt)
            throws IllegalArgumentException {
        if (xc == null) {
            throw new IllegalArgumentException("Invalid argument: null XmlCursor");
        } else if (tt == null) {
            throw new IllegalArgumentException("Invalid argument: null TokenType");
        }

        while (xc.toPrevToken() != tt) {
            if (xc.currentTokenType() == TokenType.STARTDOC)
                fail("Expected Token not found! " + tt.toString());
        }
        assertEquals(tt, xc.currentTokenType());
    }

    /**
     * Method compareDocTokens
     *
     * TODO: should really compare values also.
     *
     * @param    tc                  a  TestCase
     * @param    a                   a  XmlCursor
     * @param    b                   a  XmlCursor
     *
     *
     */
    public void compareDocTokens(XmlCursor a, XmlCursor b) {
        while (a.hasNextToken() && b.hasNextToken()) {
            TokenType ttOrig = a.currentTokenType();
            TokenType ttRoundTrip = b.currentTokenType();
            if (ttOrig != ttRoundTrip) {
                fail("Round trip failed.  Original Cursor TokenType = "
                     + ttOrig + " Roundtrip Cursor TokenType = "
                     + ttRoundTrip);

            }
            a.toNextToken();
            b.toNextToken();
        }
    }

}