This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
The following commit(s) were added to refs/heads/master by this push: new d357e9a8 [DOXIA-756] Allow to customize macro execution (#244) d357e9a8 is described below commit d357e9a8ec5b4ef784d5fa381dac6dcb36d0684a Author: Konrad Windszus <k...@apache.org> AuthorDate: Tue Nov 12 16:06:55 2024 +0100 [DOXIA-756] Allow to customize macro execution (#244) Keep original macro parameter order --- .../apache/maven/doxia/macro/MacroExecutor.java | 40 ++++++++++++++++++++++ .../apache/maven/doxia/parser/AbstractParser.java | 21 ++++++++---- .../java/org/apache/maven/doxia/parser/Parser.java | 8 +++++ .../apache/maven/doxia/module/apt/AptParser.java | 4 +-- .../apache/maven/doxia/module/fml/FmlParser.java | 3 +- .../apache/maven/doxia/module/xdoc/XdocParser.java | 3 +- .../maven/doxia/module/xhtml5/Xhtml5Parser.java | 4 +-- 7 files changed, 71 insertions(+), 12 deletions(-) diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutor.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutor.java new file mode 100644 index 00000000..71d69d0b --- /dev/null +++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutor.java @@ -0,0 +1,40 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.doxia.macro; + +import org.apache.maven.doxia.macro.manager.MacroNotFoundException; +import org.apache.maven.doxia.sink.Sink; + +/** + * Interface implemented by all parsers that support macros and which can be used to overwrite macro execution via {@link Parser#setMacroExecutor(MacroExecutor)}. + */ +public interface MacroExecutor { + + /** + * Execute a macro on the given sink. + * + * @param macroId an id to lookup the macro + * @param request the corresponding MacroRequest + * @param sink the sink to receive the events + * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution + * @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if the macro could not be found + */ + void executeMacro(String macroId, MacroRequest request, Sink sink) + throws MacroExecutionException, MacroNotFoundException; +} diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java index d21e4b9c..d91b3fda 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java @@ -34,6 +34,7 @@ import java.util.Properties; import org.apache.maven.doxia.macro.Macro; import org.apache.maven.doxia.macro.MacroExecutionException; +import org.apache.maven.doxia.macro.MacroExecutor; import org.apache.maven.doxia.macro.MacroRequest; import org.apache.maven.doxia.macro.manager.MacroManager; import org.apache.maven.doxia.macro.manager.MacroNotFoundException; @@ -49,7 +50,7 @@ import org.apache.maven.doxia.sink.impl.SinkWrapperFactoryComparator; * @author Jason van Zyl * @since 1.0 */ -public abstract class AbstractParser implements Parser { +public abstract class AbstractParser implements Parser, MacroExecutor { /** Indicates that a second parsing is required. */ private boolean secondParsing = false; @@ -68,6 +69,8 @@ public abstract class AbstractParser implements Parser { private boolean emitAnchors = false; + private MacroExecutor macroExecutor = null; + private static final String DOXIA_VERSION; static { @@ -127,6 +130,10 @@ public abstract class AbstractParser implements Parser { this.emitAnchors = emitAnchors; } + @Override + public void setMacroExecutor(MacroExecutor macroExecutor) { + this.macroExecutor = macroExecutor; + } /** * Execute a macro on the given sink. * @@ -136,13 +143,15 @@ public abstract class AbstractParser implements Parser { * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution * @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if the macro could not be found */ - // Made public right now because of the structure of the APT parser and - // all its inner classes. + @Override public void executeMacro(String macroId, MacroRequest request, Sink sink) throws MacroExecutionException, MacroNotFoundException { - Macro macro = getMacroManager().getMacro(macroId); - - macro.execute(sink, request); + if (macroExecutor != null) { + macroExecutor.executeMacro(macroId, request, sink); + } else { + Macro macro = getMacroManager().getMacro(macroId); + macro.execute(sink, request); + } } /** diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java index 4b271867..3e5a20d1 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java @@ -21,6 +21,7 @@ package org.apache.maven.doxia.parser; import java.io.Reader; import org.apache.maven.doxia.index.IndexingSink; +import org.apache.maven.doxia.macro.MacroExecutor; import org.apache.maven.doxia.sink.Sink; import org.apache.maven.doxia.sink.impl.SinkWrapperFactory; @@ -110,4 +111,11 @@ public interface Parser { * @since 2.0.0 */ boolean isEmitAnchorsForIndexableEntries(); + + /** + * Delegates macro execution to the given {@link MacroExecutor}. + * @param macroExecutor (may be {@code null} to use the built-in macro executor, which resolves all macros to {@link Sink} methods)} + * @since 2.1.0 + */ + void setMacroExecutor(MacroExecutor macroExecutor); } diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java index 2d9c8eb8..f407ae1f 100644 --- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java +++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java @@ -25,7 +25,7 @@ import java.io.IOException; import java.io.Reader; import java.io.StringReader; import java.io.StringWriter; -import java.util.HashMap; +import java.util.LinkedHashMap; import java.util.Map; import java.util.StringTokenizer; @@ -2405,7 +2405,7 @@ public class AptParser extends AbstractTextParser implements AptMarkup { String macroId = params[0]; - Map<String, Object> parameters = new HashMap<>(); + Map<String, Object> parameters = new LinkedHashMap<>(); for (int i = 1; i < params.length; i++) { String[] param = StringUtils.split(params[i], "="); diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java index 559d3f2a..17759cd2 100644 --- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java +++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java @@ -28,6 +28,7 @@ import java.io.StringReader; import java.io.StringWriter; import java.util.HashMap; import java.util.Iterator; +import java.util.LinkedHashMap; import java.util.Map; import org.apache.commons.io.IOUtils; @@ -81,7 +82,7 @@ public class FmlParser extends AbstractXmlParser implements FmlMarkup { private String macroName; /** The macro parameters. */ - private Map<String, Object> macroParameters = new HashMap<>(); + private Map<String, Object> macroParameters = new LinkedHashMap<>(); /** {@inheritDoc} */ public void parse(Reader source, Sink sink, String reference) throws ParseException { diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java index e69f1434..7ca832d2 100644 --- a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java +++ b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java @@ -27,6 +27,7 @@ import java.io.Reader; import java.io.StringReader; import java.io.StringWriter; import java.util.HashMap; +import java.util.LinkedHashMap; import java.util.Map; import org.apache.commons.io.IOUtils; @@ -72,7 +73,7 @@ public class XdocParser extends Xhtml1BaseParser implements XdocMarkup { /** * The macro parameters. */ - private Map<String, Object> macroParameters = new HashMap<>(); + private Map<String, Object> macroParameters = new LinkedHashMap<>(); /** * Indicates that we're inside <properties> or <head>. diff --git a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java index 643746b2..8e0296e2 100644 --- a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java +++ b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java @@ -26,7 +26,7 @@ import java.io.IOException; import java.io.Reader; import java.io.StringReader; import java.io.StringWriter; -import java.util.HashMap; +import java.util.LinkedHashMap; import java.util.Map; import org.apache.commons.io.IOUtils; @@ -194,7 +194,7 @@ public class Xhtml5Parser extends Xhtml5BaseParser implements Xhtml5Markup { String[] params = StringUtils.split(s, "|"); String macroName = params[0]; - Map<String, Object> parameters = new HashMap<>(); + Map<String, Object> parameters = new LinkedHashMap<>(); for (int i = 1; i < params.length; i++) { String[] param = StringUtils.split(params[i], "="); if (param.length == 1) {