* limitations under the License.
 */
package gradlebuild.docs.dsl.docbook;

public interface JavadocLexer {
    /**
     * Visits the tokens in the input stream for this lexer. Reads to the end of the input.
     */
    void visit(TokenVisitor visitor);

    class TokenVisitor {
        void onStartHtmlElement(String name) {
        }

        void onHtmlElementAttribute(String name, String value) {

        lexer.visit(visitor)

        then:
        1 * visitor.onStartJavadocTag('tag')
        1 * visitor.onText('some value')
        1 * visitor.onEndJavadocTag('tag')
        1 * visitor.onEnd()
        0 * visitor._
    }

    def javadocTagCanBeEmpty() {
        when:
        lexer.pushText("{@empty}")
        lexer.visit(visitor)

        then:
        1 * visitor.onStartJavadocTag('empty')

        public VisitorImpl(TokenVisitor visitor) {
            this.visitor = visitor;
        }

        private void unwindTo(String element, TokenVisitor visitor) {
            if (elementStack.contains(element)) {
                while (!elementStack.getFirst().equals(element)) {
                    visitor.onEndHtmlElement(elementStack.removeFirst());
                }
                elementStack.removeFirst();

     */
    protected void extractFrontMatterMetadata(final Node document, final ExtractData extractData) {
        final YamlFrontMatterVisitor visitor = new YamlFrontMatterVisitor();
        document.accept(visitor);

        final Map<String, List<String>> frontMatter = visitor.getData();
        for (final Map.Entry<String, List<String>> entry : frontMatter.entrySet()) {
            final String key = "frontmatter." + entry.getKey();

/**
 * Defines a hierarchical visitor for collecting dependency node trees.
 *
 * @since 4.0.0
 */
@Experimental
@Consumer
public interface NodeVisitor {
    /**
     * Starts the visit to the specified dependency node.
     *
     * @param node the dependency node to visit
     * @return <code>true</code> to visit the specified dependency node's children, <code>false</code> to skip the

        return null
    }

    private static List<Boolean> typeParametersNullabilityOf(CtClass ctClass) {
        NullableClassTypeParametersVisitor visitor = new NullableClassTypeParametersVisitor()
        new ClassReader(byteCodeFrom(ctClass)).accept(visitor, 0)
        return visitor.typeParametersNullability
    }

    static class NullableClassTypeParametersVisitor extends ClassVisitor {

            scanner.find('}');
            String value = scanner.region();
            visitor.onText(value);
        }

        // end of tag marker
        if (scanner.lookingAt('}')) {
            visitor.onEndJavadocTag(tagName);
            scanner.next();
        }
    }

    private void parseStartElement(TokenVisitor visitor) {
        // start element marker
        scanner.next();

    object : SinceVisitor() {

        override fun visit(declaration: ClassOrInterfaceDeclaration, arg: Unit?): SinceTagStatus? =
            declaration.getSinceIfMatchesName(classSimpleName) ?: super.visit(declaration, arg)

        override fun visit(declaration: AnnotationDeclaration, arg: Unit?): SinceTagStatus? =
            declaration.getSinceIfMatchesName(classSimpleName) ?: super.visit(declaration, arg)

    }

    @Override
    public void visit(PackageDeclaration packageDeclaration, ClassMetaDataRepository<ClassMetaData> repository) {
        this.packageName = packageDeclaration.getNameAsString();
        super.visit(packageDeclaration, repository);
    }

    @Override
    public void visit(ClassOrInterfaceDeclaration classDeclaration, ClassMetaDataRepository<ClassMetaData> repository) {

    /**
     * Traverses this node and potentially its children using the specified visitor.
     *
     * @param visitor the visitor to call back, must not be {@code null}
     * @return {@code true} to visit siblings nodes of this node as well, {@code false} to skip siblings
     */
    boolean accept(@Nonnull NodeVisitor visitor);

    /**
     * Returns a new tree starting at this node, filtering the children.