/*
 * Copyright (c) 2021, 2025, 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
 * @bug 6251738 8226279 8297802 8305407
 * @summary JDK-8226279 javadoc should support a new at-spec tag
 * @library /tools/lib ../../lib
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
 * @build toolbox.ToolBox javadoc.tester.*
 * @run main TestSpecTag
 */

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import javadoc.tester.JavadocTester;
import toolbox.ToolBox;

public class TestSpecTag extends JavadocTester {
    public static void main(String... args) throws Exception {
        var tester = new TestSpecTag();
        tester.runTests();
    }

    ToolBox tb = new ToolBox();

    enum LinkKind { ABSOLUTE, RELATIVE }

    @Test
    public void testBadSpecBaseURI(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, "package p; public class C { }");

        javadoc("-d", base.resolve("out").toString(),
                "--spec-base-url", "http://[",
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.CMDERR);
        checkOutput(Output.OUT, true,
                "error: invalid URL: Expected closing bracket for IPv6 address at index 8: http://[");
    }

    @Test
    public void testBadSpecURI(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, "package p; /** @spec http://[ label */ public class C { }");

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.ERROR);

        checkOutput(Output.OUT, true,
                "testBadSpecURI/src/p/C.java:1:".replace('/', File.separatorChar)
                    + " error: invalid URL: Expected closing bracket for IPv6 address at index 8: http://[");

        checkOutput("p/C.html", true,
                """
                        <dl class="notes">
                        <dt>External Specifications</dt>
                        <dd>
                        <ul class="tag-list">
                        <li><span id="label" class="search-tag-result">label</span></li>
                        </ul>
                        </dd>
                        </dl>
                        """);

        checkOutput("external-specs.html", true,
                """
                    <div class="col-first even-row-color">label</div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#label">class p.C</a></code></li>
                    </ul>
                    </div>""");
    }

    @Test
    public void testNavigation(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, "package p; /** @spec http://example.com label */ public class C { }");

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOutput("external-specs.html", true,
                """
                    <!-- ========= START OF TOP NAVBAR ======= -->
                    <div class="top-nav" id="navbar-top">
                    <div class="nav-content">
                    <div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="na\
                    vbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class\
                    ="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</sp\
                    an><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
                    <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">S\
                    kip navigation links</a></div>
                    <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
                    <li><a href="p/package-summary.html">Package</a></li>
                    <li><a href="p/package-tree.html">Tree</a></li>
                    <li><a href="index-all.html">Index</a></li>
                    <li><a href="search.html">Search</a></li>
                    <li><a href="help-doc.html#external-specs">Help</a></li>
                    </ul>
                    </div>
                    </div>
                    <div class="sub-nav">
                    <div class="nav-content">
                    <ol class="sub-nav-list"></ol>
                    <div class="nav-list-search"><input type="text" id="search-input" disabled place\
                    holder="Search documentation (type /)" aria-label="Search in documentation" auto\
                    complete="off" spellcheck="false"><input type="reset" id="reset-search" disabled\
                     value="Reset"></div>
                    </div>
                    </div>
                    <!-- ========= END OF TOP NAVBAR ========= -->
                    """);
    }

    @Test
    public void testEncodedURI(Path base) throws IOException {
        Path src = base.resolve("src");
        // The default encoding for OpenJDK source files is ASCII.
        // The following writes a file using UTF-8 containing a non-ASCII character (section)
        // and a Unicode escape for another character (plus or minus)
        tb.writeJavaFiles(src, """
                package p;
                /**
                 * @spec http://example.com/a+b         space: plus
                 * @spec http://example.com/a%20b       space: percent
                 * @spec http://example.com/a\u00A7b    other: section; U+00A7, UTF-8 c2 a7
                 * @spec http://example.com/a\\u00B1b   unicode: plus or minus; U+00B1, UTF-8 c2 b1
                 */
                public class C { }
                """);

        // Ensure the source file is read using UTF-8
        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "-encoding", "UTF-8",
                "p");
        checkExit(Exit.OK);

        checkOutput("p/C.html", true,
                """
                        <dl class="notes">
                        <dt>External Specifications</dt>
                        <dd>
                        <ul class="tag-list-long">
                        <li><a href="http://example.com/a+b"><span id="space:plus" class="search-tag-result">space: plus</span></a></li>
                        <li><a href="http://example.com/a%20b"><span id="space:percent" class="search-tag-result">space: percent</span></a></li>
                        <li><a href="http://example.com/a%C2%A7b"><span id="other:section;U+00A7,UTF-8c2a7" class="search-tag-result">other: section; U+00A7, UTF-8 c2 a7</span></a></li>
                        <li><a href="http://example.com/a%C2%B1b"><span id="unicode:plusorminus;U+00B1,UTF-8c2b1" class="search-tag-result">unicode: plus or minus; U+00B1, UTF-8 c2 b1</span></a></li>
                        </ul>
                        </dd>
                        </dl>
                        """);

        checkOutput("external-specs.html", true,
                """
                    <div class="table-header col-first">Specification</div>
                    <div class="table-header col-last">Referenced In</div>
                    <div class="col-first even-row-color"><a href="http://example.com/a%C2%A7b">other: section; U+00A7, UTF-8 c2 a7</a></div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#other:section;U+00A7,UTF-8c2a7">class p.C</a></code></li>
                    </ul>
                    </div>
                    <div class="col-first odd-row-color"><a href="http://example.com/a%20b">space: percent</a></div>
                    <div class="col-last odd-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#space:percent">class p.C</a></code></li>
                    </ul>
                    </div>
                    <div class="col-first even-row-color"><a href="http://example.com/a+b">space: plus</a></div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#space:plus">class p.C</a></code></li>
                    </ul>
                    </div>
                    <div class="col-first odd-row-color"><a href="http://example.com/a%C2%B1b">unicode: plus or minus; U+00B1, UTF-8 c2 b1</a></div>
                    <div class="col-last odd-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#unicode:plusorminus;U+00B1,UTF-8c2b1">class p.C</a></code></li>
                    </ul>
                    </div>""");
    }

    @Test
    public void testDuplicateRefs(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /**
                 * @spec http://example.com/ example
                 */
                public class C {
                    /**
                     * @spec http://example.com/ example
                     */
                     public void m() { }
                    /**
                     * @spec http://example.com/ example
                     */
                     public int f;
                }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOrder("p/C.html",
                "<h1 title=\"Class C\" class=\"title\">Class C</h1>",
                """
                    <dt>External Specifications</dt>
                    <dd>
                    <ul class="tag-list">
                    <li><a href="http://example.com/"><span id="example" class="search-tag-result">example</span></a></li>
                    </ul>
                    </dd>
                    """,
                "<section class=\"field-details\" id=\"field-detail\">",
                """
                    <dt>External Specifications</dt>
                    <dd>
                    <ul class="tag-list">
                    <li><a href="http://example.com/"><span id="example-1" class="search-tag-result">example</span></a></li>
                    </ul>
                    </dd>
                    """,
                "<section class=\"detail\" id=\"m()\">",
                """
                    <dt>External Specifications</dt>
                    <dd>
                    <ul class="tag-list">
                    <li><a href="http://example.com/"><span id="example-2" class="search-tag-result">example</span></a></li>
                    </ul>
                    </dd>
                    """);

        checkOutput("external-specs.html", true,
                """
                    <div class="col-first even-row-color"><a href="http://example.com/">example</a></div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#example">class p.C</a></code></li>
                    <li><code><a href="p/C.html#example-1">p.C.f</a></code></li>
                    <li><code><a href="p/C.html#example-2">p.C.m()</a></code></li>
                    </ul>
                    </div>""");

    }

    @Test
    public void testMultiple(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /**
                 * First sentence.
                 * @spec http://example.com/1 example-1
                 * @spec http://example.com/2 example-2
                 */
                public class C { }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOutput("p/C.html", true,
                """
                    <dt>External Specifications</dt>
                    <dd>
                    <ul class="tag-list">
                    <li><a href="http://example.com/1"><span id="example-1" class="search-tag-result">example-1</span></a></li>
                    <li><a href="http://example.com/2"><span id="example-2" class="search-tag-result">example-2</span></a></li>
                    </ul>
                    </dd>
                    """);

        checkOutput("external-specs.html", true,
                """
                    <div class="col-first even-row-color"><a href="http://example.com/1">example-1</a></div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#example-1">class p.C</a></code></li>
                    </ul>
                    </div>
                    <div class="col-first odd-row-color"><a href="http://example.com/2">example-2</a></div>
                    <div class="col-last odd-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#example-2">class p.C</a></code></li>
                    </ul>
                    </div>
                    """);
    }
    @Test
    public void testMultipleHosts(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /**
                 * First sentence.
                 * @spec http://example.com/1 example-1
                 * @spec http://example.net/2 example-2
                 */
                public class C { }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOutput("p/C.html", true,
                """
                    <dt>External Specifications</dt>
                    <dd>
                    <ul class="tag-list">
                    <li><a href="http://example.com/1"><span id="example-1" class="search-tag-result">example-1</span></a></li>
                    <li><a href="http://example.net/2"><span id="example-2" class="search-tag-result">example-2</span></a></li>
                    </ul>
                    </dd>
                    """);

        checkOutput("external-specs.html", true,
                """
                    <div class="table-tabs" role="tablist" aria-orientation="horizontal">\
                    <button id="external-specs-tab0" role="tab" aria-selected="true" aria-controls="external-specs.tabpanel" \
                    tabindex="0" onkeydown="switchTab(event)" onclick="show('external-specs', 'external-specs', 2)" \
                    class="active-table-tab">All Specifications</button>\
                    <button id="external-specs-tab1" role="tab" aria-selected="false" aria-controls="external-specs.tabpanel" \
                    tabindex="-1" onkeydown="switchTab(event)" onclick="show('external-specs', 'external-specs-tab1', 2)" \
                    class="table-tab">example.com</button>\
                    <button id="external-specs-tab2" role="tab" aria-selected="false" aria-controls="external-specs.tabpanel" \
                    tabindex="-1" onkeydown="switchTab(event)" onclick="show('external-specs', 'external-specs-tab2', 2)" \
                    class="table-tab">example.net</button></div>
                    <div id="external-specs.tabpanel" role="tabpanel" aria-labelledby="external-specs-tab0">
                    <div class="summary-table two-column-summary">
                    <div class="table-header col-first">Specification</div>
                    <div class="table-header col-last">Referenced In</div>""",
                """
                    <div class="col-first even-row-color external-specs external-specs-tab1"><a href="http://example.com/1">example-1</a></div>
                    <div class="col-last even-row-color external-specs external-specs-tab1">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#example-1">class p.C</a></code></li>
                    </ul>
                    </div>
                    <div class="col-first odd-row-color external-specs external-specs-tab2"><a href="http://example.net/2">example-2</a></div>
                    <div class="col-last odd-row-color external-specs external-specs-tab2">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#example-2">class p.C</a></code></li>
                    </ul>
                    </div>""");
    }

    @Test
    public void testMultipleTitlesForURL(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /** Class C. */
                public class C {
                    private C() { }

                    /**
                     * Method m1.
                     * @spec http://example.com/index.html first
                     */
                     public void m1() { }

                    /**
                     * Method m2.
                     * @spec http://example.com/index.html second
                     */
                     public void m2() { }
                }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.ERROR);

        checkOutput(Output.OUT, true,
                """
                    error: 2 different titles given in @spec tags for the external specification at http://example.com/index.html
                    #FILE#:8: Note: url: http://example.com/index.html, title: "first"
                         * @spec http://example.com/index.html first
                           ^
                    #FILE#:14: Note: url: http://example.com/index.html, title: "second"
                         * @spec http://example.com/index.html second
                           ^
                    """
                    .replace("#FILE#", src.resolve("p").resolve("C.java").toString()));
    }

    @Test
    public void testDifferentWhitespaceTitlesForURL(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /** Class C. */
                public class C {
                    private C() { }

                    /**
                     * Method m1.
                     * @spec http://example.com/index.html abc def
                     */
                     public void m1() { }

                    /**
                     * Method m2.
                     * @spec http://example.com/index.html abc         def
                     */
                     public void m2() { }
                }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOutput(Output.OUT, false, "error");

        checkOutput("external-specs.html", true,
                """
                    <div class="summary-table two-column-summary">
                    <div class="table-header col-first">Specification</div>
                    <div class="table-header col-last">Referenced In</div>
                    <div class="col-first even-row-color"><a href="http://example.com/index.html">abc def</a></div>
                    <div class="col-last even-row-color">
                    <ul class="ref-list">
                    <li><code><a href="p/C.html#abcdef">p.C.m1()</a></code></li>
                    <li><code><a href="p/C.html#abcdef-1">p.C.m2()</a></code></li>
                    </ul>
                    </div>
                    </div>""");
    }

    @Test
    public void testMultipleURLsForTitle(Path base) throws IOException {
        Path src = base.resolve("src");
        tb.writeJavaFiles(src, """
                package p;
                /** Class C. */
                public class C {
                    private C() { }

                    /**
                     * Method m1.
                     * @spec http://example.com/index1.html Example Title
                     */
                     public void m1() { }

                    /**
                     * Method m2.
                     * @spec http://example.com/index2.html Example Title
                     */
                     public void m2() { }
                }
                """);

        javadoc("-d", base.resolve("out").toString(),
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.ERROR);

        checkOutput(Output.OUT, true,
                """
                    error: The title "Example Title" is used for 2 different external specifications in @spec tags
                    #FILE#:8: Note: title: "Example Title", url: http://example.com/index1.html
                         * @spec http://example.com/index1.html Example Title
                           ^
                    #FILE#:14: Note: title: "Example Title", url: http://example.com/index2.html
                         * @spec http://example.com/index2.html Example Title
                           ^
                    """
                    .replace("#FILE#", src.resolve("p").resolve("C.java").toString()));
    }

    @Test
    public void testCombo(Path base) throws IOException {
        for (LinkKind lk : LinkKind.values()) {
            test(base, lk);
        }
    }

    void test(Path base, LinkKind lk) throws IOException {
        Path dir = Files.createDirectories(base.resolve(lk.toString()));
        Path src = genSource(dir, lk);

        javadoc("-d", dir.resolve("out").toString(),
                "--spec-base-url", "http://example.com/",
                "--source-path", src.toString(),
                "p");
        checkExit(Exit.OK);

        checkOutput("p/C.html", true,
                """
                        <dl class="notes">
                        <dt>External Specifications</dt>
                        <dd>
                        <ul class="tag-list">
                        <li><a href="http://example.com/#LK#"><span id="#LK#reference" class="search-tag-result">#LK# reference</span></a></li>
                        </ul>
                        </dd>
                        </dl>"""
                .replaceAll("#LK#", lk.toString().toLowerCase()));

        checkOutput("external-specs.html", true,
                """
                        <div class="col-first even-row-color"><a href="http://example.com/#LK#">#LK# reference</a></div>
                        <div class="col-last even-row-color">
                        <ul class="ref-list">
                        <li><code><a href="p/C.html##LK#reference">class p.C</a></code></li>
                        </ul>
                        </div>"""
                        .replaceAll("#LK#", lk.toString().toLowerCase()));
    }

    Path genSource(Path base, LinkKind lk) throws IOException {
        Path src = base.resolve("src");
        String template = """
                /**
                 * First sentence.
                 * @spec #SPEC#
                 */
                """;

        String spec = switch (lk) {
            case ABSOLUTE -> "http://example.com/absolute absolute reference";
            case RELATIVE -> "relative                    relative reference";
        };
        String comment = template.replace("#SPEC#", spec);
        tb.writeJavaFiles(src,
                "package p;\n" + comment + "public class C { }");

        return src;
    }
}