From 30acc199aaadf6a344e8628c9b2bec06669c1be1 Mon Sep 17 00:00:00 2001
From: Arnaud Roques <plantuml@gmail.com>
Date: Wed, 20 Nov 2024 22:53:27 +0100
Subject: [PATCH] feat: add %n() function

---
 .../plantuml/klimt/creole/Display.java        |  4 ++
 .../sourceforge/plantuml/tim/TContext.java    |  5 +-
 .../plantuml/tim/stdlib/NewlineShort.java     | 63 +++++++++++++++++++
 3 files changed, 70 insertions(+), 2 deletions(-)
 create mode 100644 src/net/sourceforge/plantuml/tim/stdlib/NewlineShort.java

diff --git a/src/net/sourceforge/plantuml/klimt/creole/Display.java b/src/net/sourceforge/plantuml/klimt/creole/Display.java
index 587ba40d094..0097302b6b5 100644
--- a/src/net/sourceforge/plantuml/klimt/creole/Display.java
+++ b/src/net/sourceforge/plantuml/klimt/creole/Display.java
@@ -228,6 +228,10 @@ else if (sub.startsWith("</math>") || sub.startsWith("</latex>") || sub.startsWi
 				result.add(current.toString());
 				current.setLength(0);
 				i += 9;
+			} else if (sub.startsWith("%n()")) {
+				result.add(current.toString());
+				current.setLength(0);
+				i += 3;
 			} else if (rawMode == false && c == '\\' && i < s.length() - 1) {
 				final char c2 = s.charAt(i + 1);
 				i++;
diff --git a/src/net/sourceforge/plantuml/tim/TContext.java b/src/net/sourceforge/plantuml/tim/TContext.java
index 2c428ddc868..f4647e84db1 100644
--- a/src/net/sourceforge/plantuml/tim/TContext.java
+++ b/src/net/sourceforge/plantuml/tim/TContext.java
@@ -133,6 +133,7 @@
 import net.sourceforge.plantuml.tim.stdlib.Lower;
 import net.sourceforge.plantuml.tim.stdlib.Modulo;
 import net.sourceforge.plantuml.tim.stdlib.Newline;
+import net.sourceforge.plantuml.tim.stdlib.NewlineShort;
 import net.sourceforge.plantuml.tim.stdlib.Now;
 import net.sourceforge.plantuml.tim.stdlib.Ord;
 import net.sourceforge.plantuml.tim.stdlib.RandomFunction;
@@ -222,6 +223,7 @@ private void addStandardFunctions(Defines defines) {
 		functionsSet.addFunction(new Lower());
 		functionsSet.addFunction(new Modulo());
 		functionsSet.addFunction(new Newline());
+		functionsSet.addFunction(new NewlineShort());
 		functionsSet.addFunction(new Now());
 		functionsSet.addFunction(new Ord());
 		functionsSet.addFunction(new RandomFunction());
@@ -812,7 +814,7 @@ public void appendEndOfLine(String endOfLine) {
 	public TFunction getFunctionSmart(TFunctionSignature signature) {
 		return functionsSet.getFunctionSmart(signature);
 	}
-	
+
 	/**
 	 * Retrieve data given after @startuml.
 	 */
@@ -828,5 +830,4 @@ public Optional<String> getXargs() {
 		return Optional.of(first.substring(idx + 1).trim());
 	}
 
-
 }
diff --git a/src/net/sourceforge/plantuml/tim/stdlib/NewlineShort.java b/src/net/sourceforge/plantuml/tim/stdlib/NewlineShort.java
new file mode 100644
index 00000000000..a10760d828c
--- /dev/null
+++ b/src/net/sourceforge/plantuml/tim/stdlib/NewlineShort.java
@@ -0,0 +1,63 @@
+/* ========================================================================
+ * PlantUML : a free UML diagram generator
+ * ========================================================================
+ *
+ * (C) Copyright 2009-2024, Arnaud Roques
+ *
+ * Project Info:  https://plantuml.com
+ *
+ * If you like this project or if you find it useful, you can support us at:
+ *
+ * https://plantuml.com/patreon (only 1$ per month!)
+ * https://plantuml.com/paypal
+ *
+ * This file is part of PlantUML.
+ *
+ * PlantUML is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * PlantUML 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 for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
+ * USA.
+ *
+ *
+ * Original Author:  Arnaud Roques
+ *
+ */
+package net.sourceforge.plantuml.tim.stdlib;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import net.sourceforge.plantuml.text.StringLocated;
+import net.sourceforge.plantuml.tim.TContext;
+import net.sourceforge.plantuml.tim.TFunctionSignature;
+import net.sourceforge.plantuml.tim.TMemory;
+import net.sourceforge.plantuml.tim.expression.TValue;
+
+public class NewlineShort extends SimpleReturnFunction {
+
+	public TFunctionSignature getSignature() {
+		return new TFunctionSignature("%n", 0);
+	}
+
+	@Override
+	public boolean canCover(int nbArg, Set<String> namedArgument) {
+		return nbArg == 0;
+	}
+
+	@Override
+	public TValue executeReturnFunction(TContext context, TMemory memory, StringLocated location, List<TValue> values,
+			Map<String, TValue> named) {
+		return TValue.fromString("\n");
+	}
+}