/*

 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/**

 * @test

 * @summary tests RegExp framework (use -Dseed=X to set PRNG seed)

 * @author Mike McCloskey

 * @bug 4481568 4482696 4495089 4504687 4527731 4599621 4631553 4619345

 * 4630911 4672616 4711773 4727935 4750573 4792284 4803197 4757029 4808962

 * 4872664 4803179 4892980 4900747 4945394 4938995 4979006 4994840 4997476

 * 5013885 5003322 4988891 5098443 5110268 6173522 4829857 5027748 6376940

 * 6358731 6178785 6284152 6231989 6497148 6486934 6233084 6504326 6635133

 * 6350801 6676425 6878475 6919132 6931676 6948903 6990617 7014645 7039066

 * 7067045 7014640 7189363 8007395 8013252 8013254 8012646 8023647 6559590

 * @library /lib/testlibrary

 * @build jdk.testlibrary.*

 * @run main RegExTest

 * @key randomness

 */

import java.util.function.Function;

import java.util.regex.*;

import java.util.Random;

import java.io.*;

import java.util.*;

import java.nio.CharBuffer;

import java.util.function.Predicate;

import jdk.testlibrary.RandomFactory;

/**

 * This is a test class created to check the operation of

 * the Pattern and Matcher classes.

 */

public class RegExTest {

    private static Random generator = RandomFactory.getRandom();

    private static boolean failure = false;

    private static int failCount = 0;

    private static String firstFailure = null;

    /**

     * Main to interpret arguments and run several tests.

     *

     */

    public static void main(String[] args) throws Exception {

        // Most of the tests are in a file

        processFile("TestCases.txt");

        //processFile("PerlCases.txt");

        processFile("BMPTestCases.txt");

        processFile("SupplementaryTestCases.txt");

        // These test many randomly generated char patterns

        bm();

        slice();

        // These are hard to put into the file

        escapes();

        blankInput();

        // Substitition tests on randomly generated sequences

        globalSubstitute();

        stringbufferSubstitute();

        stringbuilderSubstitute();

        substitutionBasher();

        substitutionBasher2();

        // Canonical Equivalence

        ceTest();

        // Anchors

        anchorTest();

        // boolean match calls

        matchesTest();

        lookingAtTest();

        // Pattern API

        patternMatchesTest();

        // Misc

        lookbehindTest();

        nullArgumentTest();

        backRefTest();

        groupCaptureTest();

        caretTest();

        charClassTest();

        emptyPatternTest();

        findIntTest();

        group0Test();

        longPatternTest();

        octalTest();

        ampersandTest();

        negationTest();

        splitTest();

        appendTest();

        caseFoldingTest();

        commentsTest();

        unixLinesTest();

        replaceFirstTest();

        gTest();

        zTest();

        serializeTest();

        reluctantRepetitionTest();

        multilineDollarTest();

        dollarAtEndTest();

        caretBetweenTerminatorsTest();

        // This RFE rejected in Tiger numOccurrencesTest();

        javaCharClassTest();

        nonCaptureRepetitionTest();

        notCapturedGroupCurlyMatchTest();

        escapedSegmentTest();

        literalPatternTest();

        literalReplacementTest();

        regionTest();

        toStringTest();

        negatedCharClassTest();

        findFromTest();

        boundsTest();

        unicodeWordBoundsTest();

        caretAtEndTest();

        wordSearchTest();

        hitEndTest();

        toMatchResultTest();

        toMatchResultTest2();

        surrogatesInClassTest();

        removeQEQuotingTest();

        namedGroupCaptureTest();

        nonBmpClassComplementTest();

        unicodePropertiesTest();

        unicodeHexNotationTest();

        unicodeClassesTest();

        horizontalAndVerticalWSTest();

        linebreakTest();

        branchTest();

        groupCurlyNotFoundSuppTest();

        groupCurlyBackoffTest();

        patternAsPredicate();

        invalidFlags();

        if (failure) {

            throw new

                RuntimeException("RegExTest failed, 1st failure: " +

                                 firstFailure);

        } else {

            System.err.println("OKAY: All tests passed.");

        }

    }

    // Utility functions

    private static String getRandomAlphaString(int length) {

        StringBuffer buf = new StringBuffer(length);

        for (int i=0; i<length; i++) {

            char randChar = (char)(97 + generator.nextInt(26));

            buf.append(randChar);

        }

        return buf.toString();

    }

    private static void check(Matcher m, String expected) {

        m.find();

        if (!m.group().equals(expected))

            failCount++;

    }

    private static void check(Matcher m, String result, boolean expected) {

        m.find();

        if (m.group().equals(result) != expected)

            failCount++;

    }

    private static void check(Pattern p, String s, boolean expected) {

        if (p.matcher(s).find() != expected)

            failCount++;

    }

    private static void check(String p, String s, boolean expected) {

        Matcher matcher = Pattern.compile(p).matcher(s);

        if (matcher.find() != expected)

            failCount++;

    }

    private static void check(String p, char c, boolean expected) {

        String propertyPattern = expected ? "\\p" + p : "\\P" + p;

        Pattern pattern = Pattern.compile(propertyPattern);

        char[] ca = new char[1]; ca[0] = c;

        Matcher matcher = pattern.matcher(new String(ca));

        if (!matcher.find())

            failCount++;

    }

    private static void check(String p, int codePoint, boolean expected) {

        String propertyPattern = expected ? "\\p" + p : "\\P" + p;

        Pattern pattern = Pattern.compile(propertyPattern);

        char[] ca = Character.toChars(codePoint);

        Matcher matcher = pattern.matcher(new String(ca));

        if (!matcher.find())

            failCount++;

    }

    private static void check(String p, int flag, String input, String s,

                              boolean expected)

    {

        Pattern pattern = Pattern.compile(p, flag);

        Matcher matcher = pattern.matcher(input);

        if (expected)

            check(matcher, s, expected);

        else

            check(pattern, input, false);

    }

    private static void report(String testName) {

        int spacesToAdd = 30 - testName.length();

        StringBuffer paddedNameBuffer = new StringBuffer(testName);

        for (int i=0; i<spacesToAdd; i++)

            paddedNameBuffer.append(" ");

        String paddedName = paddedNameBuffer.toString();

        System.err.println(paddedName + ": " +

                           (failCount==0 ? "Passed":"Failed("+failCount+")"));

        if (failCount > 0) {

            failure = true;

            if (firstFailure == null) {

                firstFailure = testName;

            }

        }

        failCount = 0;

    }

    /**

     * Converts ASCII alphabet characters [A-Za-z] in the given 's' to

     * supplementary characters. This method does NOT fully take care

     * of the regex syntax.

     */

    private static String toSupplementaries(String s) {

        int length = s.length();

        StringBuffer sb = new StringBuffer(length * 2);

        for (int i = 0; i < length; ) {

            char c = s.charAt(i++);

            if (c == '\\') {

                sb.append(c);

                if (i < length) {

                    c = s.charAt(i++);

                    sb.append(c);

                    if (c == 'u') {

                        // assume no syntax error

                        sb.append(s.charAt(i++));

                        sb.append(s.charAt(i++));

                        sb.append(s.charAt(i++));

                        sb.append(s.charAt(i++));

                    }

                }

            } else if ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z')) {

                sb.append('\ud800').append((char)('\udc00'+c));

            } else {

                sb.append(c);

            }

        }

        return sb.toString();

    }

    // Regular expression tests

    // This is for bug 6178785

    // Test if an expected NPE gets thrown when passing in a null argument

    private static boolean check(Runnable test) {

        try {

            test.run();

            failCount++;

            return false;

        } catch (NullPointerException npe) {

            return true;

        }

    }

    private static void nullArgumentTest() {

        check(() -> Pattern.compile(null));

        check(() -> Pattern.matches(null, null));

        check(() -> Pattern.matches("xyz", null));

        check(() -> Pattern.quote(null));

        check(() -> Pattern.compile("xyz").split(null));

        check(() -> Pattern.compile("xyz").matcher(null));

        final Matcher m = Pattern.compile("xyz").matcher("xyz");

        m.matches();

        check(() -> m.appendTail((StringBuffer) null));

        check(() -> m.appendTail((StringBuilder)null));

        check(() -> m.replaceAll((String) null));

        check(() -> m.replaceAll((Function<MatchResult, String>)null));

        check(() -> m.replaceFirst((String)null));

        check(() -> m.replaceFirst((Function<MatchResult, String>) null));

        check(() -> m.appendReplacement((StringBuffer)null, null));

        check(() -> m.appendReplacement((StringBuilder)null, null));

        check(() -> m.reset(null));

        check(() -> Matcher.quoteReplacement(null));

        //check(() -> m.usePattern(null));

        report("Null Argument");

    }

    // This is for bug6635133

    // Test if surrogate pair in Unicode escapes can be handled correctly.

    private static void surrogatesInClassTest() throws Exception {

        Pattern pattern = Pattern.compile("[\\ud834\\udd21-\\ud834\\udd24]");

        Matcher matcher = pattern.matcher("\ud834\udd22");

        if (!matcher.find())

            failCount++;

        report("Surrogate pair in Unicode escape");

    }

    // This is for bug6990617

    // Test if Pattern.RemoveQEQuoting works correctly if the octal unicode

    // char encoding is only 2 or 3 digits instead of 4 and the first quoted

    // char is an octal digit.

    private static void removeQEQuotingTest() throws Exception {

        Pattern pattern =

            Pattern.compile("\\011\\Q1sometext\\E\\011\\Q2sometext\\E");

        Matcher matcher = pattern.matcher("\t1sometext\t2sometext");

        if (!matcher.find())

            failCount++;

        report("Remove Q/E Quoting");

    }

    // This is for bug 4988891

    // Test toMatchResult to see that it is a copy of the Matcher

    // that is not affected by subsequent operations on the original

    private static void toMatchResultTest() throws Exception {

        Pattern pattern = Pattern.compile("squid");

        Matcher matcher = pattern.matcher(

            "agiantsquidofdestinyasmallsquidoffate");

        matcher.find();

        int matcherStart1 = matcher.start();

        MatchResult mr = matcher.toMatchResult();

        if (mr == matcher)

            failCount++;

        int resultStart1 = mr.start();

        if (matcherStart1 != resultStart1)

            failCount++;

        matcher.find();

        int matcherStart2 = matcher.start();

        int resultStart2 = mr.start();

        if (matcherStart2 == resultStart2)

            failCount++;

        if (resultStart1 != resultStart2)

            failCount++;

        MatchResult mr2 = matcher.toMatchResult();

        if (mr == mr2)

            failCount++;

        if (mr2.start() != matcherStart2)

            failCount++;

        report("toMatchResult is a copy");

    }

    private static void checkExpectedISE(Runnable test) {

        try {

            test.run();

            failCount++;

        } catch (IllegalStateException x) {

        } catch (IndexOutOfBoundsException xx) {

            failCount++;

        }

    }

    private static void checkExpectedIOOE(Runnable test) {

        try {

            test.run();

            failCount++;

        } catch (IndexOutOfBoundsException x) {}

    }

    // This is for bug 8074678

    // Test the result of toMatchResult throws ISE if no match is availble

    private static void toMatchResultTest2() throws Exception {

        Matcher matcher = Pattern.compile("nomatch").matcher("hello world");

        matcher.find();

        MatchResult mr = matcher.toMatchResult();

        checkExpectedISE(() -> mr.start());

        checkExpectedISE(() -> mr.start(2));

        checkExpectedISE(() -> mr.end());

        checkExpectedISE(() -> mr.end(2));

        checkExpectedISE(() -> mr.group());

        checkExpectedISE(() -> mr.group(2));

        matcher = Pattern.compile("(match)").matcher("there is a match");

        matcher.find();

        MatchResult mr2 = matcher.toMatchResult();

        checkExpectedIOOE(() -> mr2.start(2));

        checkExpectedIOOE(() -> mr2.end(2));

        checkExpectedIOOE(() -> mr2.group(2));

        report("toMatchResult2 appropriate exceptions");

    }

    // This is for bug 5013885

    // Must test a slice to see if it reports hitEnd correctly

    private static void hitEndTest() throws Exception {

        // Basic test of Slice node

        Pattern p = Pattern.compile("^squidattack");

        Matcher m = p.matcher("squack");

        m.find();

        if (m.hitEnd())

            failCount++;

        m.reset("squid");

        m.find();

        if (!m.hitEnd())

            failCount++;

        // Test Slice, SliceA and SliceU nodes

        for (int i=0; i<3; i++) {

            int flags = 0;

            if (i==1) flags = Pattern.CASE_INSENSITIVE;

            if (i==2) flags = Pattern.UNICODE_CASE;

            p = Pattern.compile("^abc", flags);

            m = p.matcher("ad");

            m.find();

            if (m.hitEnd())

                failCount++;

            m.reset("ab");

            m.find();

            if (!m.hitEnd())

                failCount++;

        }

        // Test Boyer-Moore node

        p = Pattern.compile("catattack");

        m = p.matcher("attack");

        m.find();

        if (!m.hitEnd())

            failCount++;

        p = Pattern.compile("catattack");

        m = p.matcher("attackattackattackcatatta");

        m.find();

        if (!m.hitEnd())

            failCount++;

        report("hitEnd from a Slice");

    }

    // This is for bug 4997476

    // It is weird code submitted by customer demonstrating a regression

    private static void wordSearchTest() throws Exception {

        String testString = new String("word1 word2 word3");

        Pattern p = Pattern.compile("\\b");

        Matcher m = p.matcher(testString);

        int position = 0;

        int start = 0;

        while (m.find(position)) {

            start = m.start();

            if (start == testString.length())

                break;

            if (m.find(start+1)) {

                position = m.start();

            } else {

                position = testString.length();

            }

            if (testString.substring(start, position).equals(" "))

                continue;

            if (!testString.substring(start, position-1).startsWith("word"))

                failCount++;

        }

        report("Customer word search");

    }

    // This is for bug 4994840

    private static void caretAtEndTest() throws Exception {

        // Problem only occurs with multiline patterns

        // containing a beginning-of-line caret "^" followed

        // by an expression that also matches the empty string.

        Pattern pattern = Pattern.compile("^x?", Pattern.MULTILINE);

        Matcher matcher = pattern.matcher("\r");

        matcher.find();

        matcher.find();

        report("Caret at end");

    }

    // This test is for 4979006

    // Check to see if word boundary construct properly handles unicode

    // non spacing marks

    private static void unicodeWordBoundsTest() throws Exception {

        String spaces = "  ";

        String wordChar = "a";

        String nsm = "\u030a";

        assert (Character.getType('\u030a') == Character.NON_SPACING_MARK);