Skip to content

Add string built-ins for multi-line text formatting: ?indent, ?dedent, ?wrap, ?pad_lines #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gdisirio wants to merge 9 commits into
base: 2.3-gae
Choose a base branch
from
Open

Add string built-ins for multi-line text formatting: ?indent, ?dedent, ?wrap, ?pad_lines #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
097fdcf
Add string built-ins for multi-line text formatting: ?indent, ?dedent…
gdisirio May 27, 2026
ecfa044
Review feedback: rename ?pad_lines to ?right_pad_lines
gdisirio May 29, 2026
3abd7f0
Review feedback: add no-argument ?dedent() form (Python textwrap.dede…
gdisirio May 29, 2026
0b6e617
Review feedback: clarify character-width semantics and non-breaking s…
gdisirio May 29, 2026
4ab4d64
[PR-130] Adjustments:
ddekany Jul 26, 2026
a633172
Add the missing ASF license header to _CoreStringUtilsTest.java.
gdisirio Aug 2, 2026
e0f32f0
Review feedback: dedent partial prefixes, indent every line, drop ?ri…
gdisirio Aug 3, 2026
621a8ac
- Code cleanup: Mostly, the refactoring of indent/dedent algorithms t…
ddekany Aug 3, 2026
99bcddc
Review feedback: ?dedent(prefix) trims too, and parametric indent/ded…
gdisirio Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion freemarker-core/src/main/java/freemarker/core/BuiltIn.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
import freemarker.core.BuiltInsForStringsMisc.evalBI;
import freemarker.core.BuiltInsForStringsMisc.evalJsonBI;
import freemarker.template.Configuration;
import freemarker.template.TemplateBooleanModel;
import freemarker.template.TemplateDateModel;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
Expand All @@ -85,7 +86,7 @@ abstract class BuiltIn extends Expression implements Cloneable {

static final Set<String> CAMEL_CASE_NAMES = new TreeSet<>();
static final Set<String> SNAKE_CASE_NAMES = new TreeSet<>();
static final int NUMBER_OF_BIS = 302;
static final int NUMBER_OF_BIS = 307;
static final HashMap<String, BuiltIn> BUILT_INS_BY_NAME = new HashMap<>(NUMBER_OF_BIS * 3 / 2 + 1, 1f);

static final String BI_NAME_SNAKE_CASE_WITH_ARGS = "with_args";
Expand Down Expand Up @@ -115,6 +116,7 @@ abstract class BuiltIn extends Expression implements Cloneable {
putBI("date_if_unknown", "dateIfUnknown", new BuiltInsForDates.dateType_if_unknownBI(TemplateDateModel.DATE));
putBI("datetime", new BuiltInsForMultipleTypes.dateBI(TemplateDateModel.DATETIME));
putBI("datetime_if_unknown", "datetimeIfUnknown", new BuiltInsForDates.dateType_if_unknownBI(TemplateDateModel.DATETIME));
putBI("dedent", new BuiltInsForStringsBasic.dedentBI());
putBI("default", new BuiltInsForExistenceHandling.defaultBI());
putBI("double", new doubleBI());
putBI("drop_while", "dropWhile", new BuiltInsForSequences.drop_whileBI());
Expand All @@ -138,6 +140,7 @@ abstract class BuiltIn extends Expression implements Cloneable {
putBI("has_next", "hasNext", new BuiltInsForLoopVariables.has_nextBI());
putBI("html", new BuiltInsForStringsEncoding.htmlBI());
putBI("if_exists", "ifExists", new BuiltInsForExistenceHandling.if_existsBI());
putBI("indent", new BuiltInsForStringsBasic.indentBI());
putBI("index", new BuiltInsForLoopVariables.indexBI());
putBI("index_of", "indexOf", new BuiltInsForStringsBasic.index_ofBI(false));
putBI("int", new intBI());
Expand Down Expand Up @@ -315,6 +318,7 @@ abstract class BuiltIn extends Expression implements Cloneable {
putBI(BI_NAME_SNAKE_CASE_WITH_ARGS_LAST, BI_NAME_CAMEL_CASE_WITH_ARGS_LAST,
new BuiltInsForCallables.with_args_lastBI());
putBI("word_list", "wordList", new BuiltInsForStringsBasic.word_listBI());
putBI("wrap", new BuiltInsForStringsBasic.wrapBI());
putBI("xhtml", new BuiltInsForStringsEncoding.xhtmlBI());
putBI("xml", new BuiltInsForStringsEncoding.xmlBI());
putBI("matches", new BuiltInsForStringsRegexp.matchesBI());
Expand Down Expand Up @@ -491,6 +495,27 @@ protected final Number getNumberMethodArg(List args, int argIdx)
}
}

/**
* Same as {@link #getBooleanMethodArg}, but checks if {@code args} is big enough, and returns {@code defaultValue}
* if it isn't.
*/
protected final boolean getOptBooleanMethodArg(List args, int argIdx, boolean defaultValue)
throws TemplateModelException {
return args.size() > argIdx ? getBooleanMethodArg(args, argIdx) : defaultValue;
}

/**
* Gets a method argument and checks if it's a boolean; it does NOT check if {@code args} is big enough.
*/
protected final boolean getBooleanMethodArg(List args, int argIdx) throws TemplateModelException {
TemplateModel arg = (TemplateModel) args.get(argIdx);
if (!(arg instanceof TemplateBooleanModel)) {
throw _MessageUtil.newMethodArgMustBeBooleanException("?" + key, argIdx, arg);
} else {
return ((TemplateBooleanModel) arg).getAsBoolean();
}
}

protected final TemplateModelException newMethodArgInvalidValueException(int argIdx, Object[] details) {
return _MessageUtil.newMethodArgInvalidValueException("?" + key, argIdx, details);
}
Expand Down
Loading