javax0.jamal.snippet.SnipLoad Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jamal-snippet Show documentation
Jamal macro library snippet macros
The newest version!
package javax0.jamal.snippet;

import javax0.jamal.api.BadSyntax;
import javax0.jamal.api.InnerScopeDependent;
import javax0.jamal.api.Input;
import javax0.jamal.api.Macro;
import javax0.jamal.api.Position;
import javax0.jamal.api.Processor;
import javax0.jamal.tools.FileTools;
import javax0.jamal.tools.Scanner;

import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import java.util.function.Predicate;
import java.util.regex.Pattern;

public class SnipLoad implements Macro, InnerScopeDependent, Scanner.WholeInput {

    @Override
    public String evaluate(Input in, Processor processor) throws BadSyntax {
        final var ref = in.getReference();
        final var scanner = newScanner(in, processor);
        final var idRegex = scanner.str("name", "id").defaultValue("");
        final var fnRegex = scanner.str("file", "fileName").defaultValue("");
        final var textRegex = scanner.str("text", "contains").defaultValue("");
        final var input = scanner.str("input").defaultValue("");
        final var format = scanner.str("format").defaultValue("XML");
        scanner.done();
        BadSyntax.when(!"XML".equals(format.get()), "The only supported format is XML");
        final var store = SnippetStore.getInstance(processor);
        final var is = new ByteArrayInputStream(FileTools.getFileContent(FileTools.absolute(ref, input.get()), processor).getBytes(StandardCharsets.UTF_8));
        SnippetXmlReader.getSnippetsFromXml(is,
                (id, content, position) -> storeSnippet(store,
                        convertRegex(idRegex.get()),
                        convertRegex(fnRegex.get()),
                        convertRegex(textRegex.get()),
                        id, content, position)
        );
        return "";
    }

    /**
     * Store the snippet in the store.
     *
     * @param store    the store
     * @param idTest   the test for the id. Store the snippet only if the id matches.
     * @param fnTest   the test for the file name. Store the snippet only if the file name matches.
     * @param textTest the test for the text. Store the snippet only if the text matches.
     * @param id       the id of the snippet
     * @param content  the textual content of the snippet
     * @param position the position of the snippet
     * @throws BadSyntax if the snippet cannot be stored, for example it is already in the store. You cannot overwrite
     *                   snippets.
     */
    private static void storeSnippet(SnippetStore store,
                                     Predicate idTest,
                                     Predicate fnTest,
                                     Predicate textTest,
                                     String id,
                                     String content,
                                     Position position) throws BadSyntax {
        if (idTest.test(id) && fnTest.test(content) && textTest.test(content)) {
            store.snippet(id, content, position);
        }
    }

    /**
     * Convert a regex to a predicate. If the regex is null or empty then the predicate is always true.
     *
     * @param regex the regex
     * @return the predicate
     */
    private static Predicate convertRegex(String regex) {
        return regex == null || regex.length() == 0 ? x -> true : Pattern.compile(regex).asPredicate();
    }

    @Override
    public String getId() {
        return "snip:load";
    }
}