> {
+
+ /**
+ * Used to match the message insertion
+ *
+ * format:
+ *
- to insert parsed line {prefix}#content-id#{offset-above,offset-down}
+ *
- to insert original line {prefix}@content-id@{offset-above,offset-down}
+ *
example:
+ *
+ * - {- }#content-id#{1,1}
+ * - @content-id@{1,1}
+ *
+ */
+ public static final @NotNull Pattern INSERT_PATTERN = Pattern.compile(
+ "^(?:\\{(?.*)})?(?[#@])(?.*)[#@](?:\\{(?-?\\d+)(?:,(?-?\\d+))?})?$"
+ );
+
+ protected final @NotNull TextContents texts;
+
+ protected BiFunction parser = (receiver, value) -> value;
+ protected String lineSeparator = System.lineSeparator();
+
+ /**
+ * Used to store the placeholders of the message
+ */
+ protected @NotNull Map placeholders = new HashMap<>();
+ protected @NotNull UnaryOperator paramBuilder = s -> "%(" + s + ")";
+ protected @NotNull String[] params;
+
+ /**
+ * Used to store the insertion of the message
+ */
+ protected @NotNull Map> insertion = new HashMap<>();
+ protected boolean disableInsertion = false;
+
+ protected TextParser(@NotNull TextContents texts, @NotNull String... params) {
+ this.texts = texts;
+ this.params = params;
+ }
+
+ public abstract SELF self();
+
+ /**
+ * Disable the insertion of the text.
+ *
If the insertion is disabled, the text will be parsed directly.
+ *
+ * @return the current {@link TextParser} instance
+ */
+ public SELF disableInsertion() {
+ this.disableInsertion = true;
+ return self();
+ }
+
+ /**
+ * Enable the insertion of the text.
+ *
+ * @return the current {@link TextParser} instance
+ */
+ public SELF enableInsertion() {
+ this.disableInsertion = false;
+ return self();
+ }
+
+ /**
+ * Set the line separator for the text.
+ *
+ * @param lineSeparator the line separator, default is {@link System#lineSeparator()}
+ * @return the current {@link TextParser} instance
+ */
+ public SELF lineSeparator(@NotNull String lineSeparator) {
+ this.lineSeparator = lineSeparator;
+ return self();
+ }
+
+ /**
+ * Set all the placeholders for the text.
+ *
Will override the previous placeholders modifications.
+ *
+ * @param placeholders the placeholders
+ * @return the current {@link TextParser} instance
+ */
+ public SELF placeholders(@NotNull Map placeholders) {
+ this.placeholders = placeholders;
+ return self();
+ }
+
+ /**
+ * Set the placeholders for the text.
+ *
+ * @param consumer the placeholders
+ * @return the current {@link TextParser} instance
+ */
+ public SELF placeholders(@NotNull Consumer> consumer) {
+ consumer.accept(this.placeholders);
+ return self();
+ }
+
+ /**
+ * Set the placeholders for the text.
+ *
+ * @param values the values of the placeholders
+ * @return the current {@link TextParser} instance
+ */
+ public SELF placeholders(@Nullable Object... values) {
+ return placeholders(map -> map.putAll(buildParams(this.paramBuilder, this.params, values)));
+ }
+
+ /**
+ * Set the placeholder for the text.
+ *
+ * @param key the key of the placeholder
+ * @param value the value of the placeholder
+ * @return the current {@link TextParser} instance
+ */
+ public SELF placeholder(@NotNull String key, @Nullable Object value) {
+ this.placeholders.put(paramBuilder.apply(key), value);
+ return self();
+ }
+
+ /**
+ * Set the params for the text,
+ * used for {@link #placeholders(Object...)} to build the placeholders.
+ *
+ * @param params the params
+ * @return the current {@link TextParser} instance
+ */
+ public SELF params(@NotNull String... params) {
+ this.params = params;
+ return self();
+ }
+
+ /**
+ * Insert the specific contents by the id.
+ *
+ * @param id the id of the insertion text
+ * @param lines the lines to insert
+ * @return the current {@link TextParser} instance
+ */
+ public SELF insert(@NotNull String id, @NotNull String... lines) {
+ this.insertion.put(id, Arrays.asList(lines));
+ return self();
+ }
+
+ /**
+ * Insert the specific contents by the id.
+ *
+ * @param id the id of the insertion text
+ * @param lines the lines to insert
+ * @return the current {@link TextParser} instance
+ */
+ public SELF insert(@NotNull String id, @NotNull List lines) {
+ this.insertion.put(id, lines);
+ return self();
+ }
+
+ /**
+ * Insert the specific contents by the id.
+ *
If the text not found in {@link TextContents#optionalLines()},
+ * nothing will happen.
+ *
+ * @param id the id of the insertion text
+ * @return the current {@link TextParser} instance
+ */
+ public SELF insert(@NotNull String id) {
+ List lines = this.texts.optionalLines().get(id);
+ if (lines == null) return self();
+ else return insert(id, lines);
+ }
+
+ /**
+ * Set the parser for the text.
+ *
+ * @param parser The parser
+ * @return The current {@link TextParser} instance
+ */
+ public SELF parser(@NotNull BiFunction parser) {
+ this.parser = parser;
+ return self();
+ }
+
+ /**
+ * Parse the texts for the receiver.
+ *
+ * @param receiver the receiver
+ * @param compiler the compiler
+ * @param the type of the message
+ * @return the parsed line
+ */
+ public List parse(@Nullable RECEIVER receiver, @NotNull BiFunction compiler) {
+ List result = new ArrayList<>();
+ handleTexts(receiver, s -> result.add(compiler.apply(receiver, s)));
+ return result;
+ }
+
+ /**
+ * Parse the texts as a single line for the receiver.
+ *
+ * @param receiver the receiver
+ * @param compiler the compiler
+ * @param the type of the message
+ * @return the parsed line
+ */
+ public @Nullable V parseLine(@Nullable RECEIVER receiver, @NotNull BiFunction compiler) {
+ if (this.texts.isEmpty()) return null;
+ StringBuilder builder = new StringBuilder();
+ handleTexts(receiver, s -> builder.append(s).append(this.lineSeparator));
+ // Remove the last line separator, if it exists
+ if (builder.length() > 0) builder.delete(builder.length() - this.lineSeparator.length(), builder.length());
+ return compiler.apply(receiver, builder.toString());
+ }
+
+
+ /**
+ * Parse the supplied single text for the receiver.
+ *
+ * @param receiver the receiver
+ * @param text the text to parse
+ * @return the parsed text
+ */
+ protected @Nullable String parseText(@Nullable RECEIVER receiver, @NotNull String text) {
+ return this.parser.apply(receiver, setPlaceholders(text, this.placeholders));
+ }
+
+
+ public void handleTexts(@Nullable RECEIVER receiver, @NotNull Consumer lineConsumer) {
+ if (this.texts.isEmpty()) return; // Nothing to parse
+
+ if (this.disableInsertion) {
+ this.texts.lines().forEach(line -> lineConsumer.accept(parseText(receiver, line)));
+ return; // Simple parsed
+ }
+
+ for (String line : this.texts.lines()) {
+ Matcher matcher = INSERT_PATTERN.matcher(line);
+ if (!matcher.matches()) {
+ lineConsumer.accept(parseText(receiver, line));
+ continue;
+ }
+
+ String id = matcher.group("id");
+ List values = this.insertion.get(id);
+ if (values == null) continue;
+
+ String prefix = matcher.group("prefix");
+ String type = matcher.group("type");
+ boolean original = type.equals("@");
+ int offsetAbove = Optional.ofNullable(matcher.group("above"))
+ .map(Integer::parseInt).orElse(0);
+ int offsetDown = Optional.ofNullable(matcher.group("down"))
+ .map(Integer::parseInt).orElse(offsetAbove); // If offsetDown is not set, use offsetAbove
+
+ IntStream.range(0, Math.max(0, offsetAbove)).mapToObj(i -> "").forEach(lineConsumer);
+ String prefixContent = Optional.ofNullable(prefix).map(p -> parseText(receiver, p)).orElse("");
+ if (original) {
+ values.stream().map(value -> prefixContent + value).forEach(lineConsumer);
+ } else {
+ values.stream().map(value -> prefixContent + parseText(receiver, value)).forEach(lineConsumer);
+ }
+ IntStream.range(0, Math.max(0, offsetDown)).mapToObj(i -> "").forEach(lineConsumer);
+ }
+ }
+
+ public static String setPlaceholders(@NotNull String messages,
+ @NotNull Map placeholders) {
+ if (messages.isEmpty()) return messages;
+ String parsed = messages;
+ for (Map.Entry entry : placeholders.entrySet()) {
+ parsed = parsed.replace(entry.getKey(), entry.getValue() == null ? "" : entry.getValue().toString());
+ }
+ return parsed;
+ }
+
+ public static Map buildParams(@NotNull UnaryOperator paramBuilder,
+ @Nullable String[] params, @Nullable Object[] values) {
+ Map map = new HashMap<>();
+ if (params == null || params.length == 0) return map;
+ for (int i = 0; i < params.length; i++) {
+ map.put(paramBuilder.apply(params[i]), (values != null && values.length > i) ? values[i] : "?");
+ }
+ return map;
+ }
+
+}
diff --git a/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ConfigTest.java b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ConfigTest.java
new file mode 100644
index 0000000..719a460
--- /dev/null
+++ b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ConfigTest.java
@@ -0,0 +1,47 @@
+package cc.carm.lib.configuration.value.text.tests;
+
+
+import cc.carm.lib.configuration.source.ConfigurationHolder;
+import cc.carm.lib.configuration.source.yaml.YAMLConfigFactory;
+import cc.carm.lib.configuration.value.text.tests.conf.AppMessages;
+import org.junit.Test;
+
+public class ConfigTest {
+
+
+ public static final String[] WEBSITES = new String[]{
+ "https://carm.cc",
+ "https://www.baidu.com",
+ "https://www.google.com"
+ };
+
+
+ @Test
+ public void test() {
+
+ ConfigurationHolder holder = YAMLConfigFactory.from("target/messages.yml").build();
+
+ holder.initialize(AppMessages.class);
+
+ System.out.println("--------------------------");
+
+ AppMessages.WELCOME.prepare()
+ .placeholders("Carm")
+ .insert("guidance")
+ .insert("websites", WEBSITES)
+ .to(System.out);
+
+ System.out.println("--------------------------");
+
+ AppMessages.NOT_AVAILABLE.sendTo(System.out);
+
+ System.out.println("--------------------------");
+
+ AppMessages.NO_PERMISSION.sendTo(System.out);
+
+ System.out.println("--------------------------");
+
+ }
+
+
+}
diff --git a/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ParseTest.java b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ParseTest.java
new file mode 100644
index 0000000..d1541a1
--- /dev/null
+++ b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/ParseTest.java
@@ -0,0 +1,49 @@
+package cc.carm.lib.configuration.value.text.tests;
+
+import cc.carm.lib.configuration.value.text.PreparedText;
+import cc.carm.lib.configuration.value.text.data.TextContents;
+import org.junit.Test;
+
+import java.io.PrintStream;
+import java.util.*;
+
+public class ParseTest {
+
+
+ @Test
+ public void test() {
+
+ List lines = new ArrayList<>();
+ lines.add("Hello, %(name)");
+ lines.add("#more-creating#{1}");
+ lines.add("This is a test message");
+ lines.add("#guidance#");
+ lines.add("{- }#websites#{0,1}");
+ lines.add("Thanks for your reading!");
+
+
+ Map> optional = new HashMap<>();
+ optional.put("guidance", Arrays.asList("To get more information for %(name), see:"));
+ optional.put("websites", Arrays.asList("https://www.baidu.com", "https://www.google.com"));
+
+ TextContents textContents = new TextContents(lines, optional);
+
+ PreparedText msg = new PreparedText(textContents)
+ .dispatcher((p, s) -> s.forEach(p::println))
+ .parser((p, s) -> s)
+ .compiler((p, s) -> s);
+
+ msg.placeholder("name", "Carm")
+ .insert("guidance")
+ .insert("websites", "Baidu", "Bilibili", "Google");
+
+ System.out.println("----------------------------");
+ msg.to(System.out);
+ System.out.println("----------------------------");
+ System.out.println(msg.compileLine(System.out));
+ System.out.println("----------------------------");
+
+ }
+
+
+}
diff --git a/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/AppMessages.java b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/AppMessages.java
new file mode 100644
index 0000000..71cf455
--- /dev/null
+++ b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/AppMessages.java
@@ -0,0 +1,28 @@
+package cc.carm.lib.configuration.value.text.tests.conf;
+
+import cc.carm.lib.configuration.Configuration;
+import cc.carm.lib.configuration.annotation.ConfigPath;
+
+@ConfigPath(root = true)
+public interface AppMessages extends Configuration {
+
+ ConfiguredMsg WELCOME = ConfiguredMsg.builder()
+ .defaults(
+ "Hello, %(name)",
+ "#more-creating#{1}",
+ "This is a test message",
+ "#guidance#",
+ "{- }#websites#{0,1}",
+ "Thanks for your reading!")
+ .optional("guidance", "To get more information for %(name), see:")
+ .params("name").build();
+
+ ConfiguredMsg NO_PERMISSION = ConfiguredMsg.builder()
+ .defaults("Sorry! But you don't have permissions to do this.")
+ .build();
+
+ ConfiguredMsg NOT_AVAILABLE = ConfiguredMsg.builder()
+ .defaults("Error! Service is not available now.", "Please contact your system manager.")
+ .build();
+
+}
diff --git a/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/ConfiguredMsg.java b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/ConfiguredMsg.java
new file mode 100644
index 0000000..3c61fff
--- /dev/null
+++ b/features/text/src/test/java/cc/carm/lib/configuration/value/text/tests/conf/ConfiguredMsg.java
@@ -0,0 +1,47 @@
+package cc.carm.lib.configuration.value.text.tests.conf;
+
+import cc.carm.lib.configuration.value.ValueManifest;
+import cc.carm.lib.configuration.value.text.ConfiguredText;
+import cc.carm.lib.configuration.value.text.data.TextContents;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.PrintStream;
+
+public class ConfiguredMsg extends ConfiguredText {
+
+ public static @NotNull MsgBuilder builder() {
+ return new MsgBuilder();
+ }
+
+ public static @NotNull ConfiguredMsg of(@NotNull String... text) {
+ return builder().defaults(text).build();
+ }
+
+ public ConfiguredMsg(@NotNull ValueManifest manifest, @NotNull String[] params) {
+ super(
+ manifest,
+ (p, s) -> s,
+ (p, s) -> s,
+ (p, s) -> s.forEach(p::println),
+ params
+ );
+ }
+
+ public void print(@NotNull Object... values) {
+ sendTo(System.out, values);
+ }
+
+ public static class MsgBuilder extends Builder {
+
+ @Override
+ protected @NotNull MsgBuilder self() {
+ return this;
+ }
+
+ @Override
+ public @NotNull ConfiguredMsg build() {
+ return new ConfiguredMsg(buildManifest(), params);
+
+ }
+ }
+}
diff --git a/pom.xml b/pom.xml
index 979f228..afc1dd4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,6 +22,7 @@
features/file
features/commentable
features/versioned
+ features/text
providers/yaml
providers/gson