/*
 * Copyright 2021, TeamDev. All rights reserved.
 *
 * 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
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR 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.
 */
package io.spine.tools.javadoc.style;

import com.google.common.annotations.VisibleForTesting;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static java.lang.String.format;
import static java.util.regex.Matcher.quoteReplacement;

/**
 * A formatting action, which handles a text in backticks.
 *
 * <p>The action will replace all entries like {@code `text`} by {@code {@code text}}.
 *
 * <p>A multi-line text is not supported, e.g a text as follows will not be handled:
 * <pre>{@code
 * `some multi
 * lined text`
 * }</pre>
 */
final class BacktickFormatting extends LineFormatting {

    @VisibleForTesting
    static final String BACKTICK = "`";
    private static final Pattern PATTERN_BACKTICK = Pattern.compile(BACKTICK);

    /**
     * A pattern to match a text surrounded with backticks.
     */
    private static final Pattern PATTERN_TEXT_IN_BACKTICKS = Pattern.compile("(`[^`]*?`)");

    @Override
    @SuppressWarnings("JdkObsolete") // to address later.
    String formatLine(String line) {
        // Double the line size to avoid possible memory reallocation.
        StringBuffer buffer = new StringBuffer(line.length() * 2);

        Matcher matcher = PATTERN_TEXT_IN_BACKTICKS.matcher(line);
        while (matcher.find()) {
            String partToFormat = matcher.group();
            String partWithoutBackticks = PATTERN_BACKTICK.matcher(partToFormat)
                                                          .replaceAll("");
            String replacement = wrapWithCodeTag(partWithoutBackticks);
            matcher.appendReplacement(buffer, quoteReplacement(replacement));
        }
        matcher.appendTail(buffer);
        @SuppressWarnings("JdkObsolete") // `StringBuffer` use dictated by regex API.
        String result = buffer.toString();
        return result;
    }

    @VisibleForTesting
    static String wrapWithCodeTag(String value) {
        return format("{@code %s}", value);
    }
}

@@ -1592,63 +1592,134 @@
 ace 
-all entries like %7B@code %60text%60%7D by %7B@code %7B@code text%7D%7D
+text enclosed into backticks (e.g. %7B@code %60text%60%7D) with%0A * the same text wrapped into the %7B@literal @%7D%7B@code code%7D Javadoc tag
 .%0A *

Improve Javadoc syntax