Fix FreeMarker utilities to accept custom class loaders

mikir · mikir · commit 2cb1f89f724d · 2024-12-09T16:17:18.000+01:00
diff --git a/compiler/core/src/zserio/extension/common/FreeMarkerUtil.java b/compiler/core/src/zserio/extension/common/FreeMarkerUtil.java
@@ -27,19 +27,20 @@ public final class FreeMarkerUtil
     /**
      * Processes FreeMarker template with the provided data model and generates output.
      *
-     * @param templateName      The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
+     * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
      * @param templateDataModel The template data model to apply.
-     * @param outputWriter      The writer to use for generated output.
+     * @param outputWriter The writer to use for generated output.
+     * @param classForTemplateLoading The class which is used to get class loader for templates.
      *
      * @throws ZserioExtensionException In case of any template error.
      */
-    public static void processTemplate(String templateName, Object templateDataModel, Writer outputWriter)
-            throws ZserioExtensionException
+    public static void processTemplate(String templateName, Object templateDataModel, Writer outputWriter,
+            Class<?> classForTemplateLoading) throws ZserioExtensionException
     {
         if (freeMarkerConfig == null)
         {
             final Configuration newFreeMarkerConfig = new Configuration(Configuration.VERSION_2_3_28);
-            newFreeMarkerConfig.setClassForTemplateLoading(FreeMarkerUtil.class, '/' + FREEMARKER_LOCATION);
+            newFreeMarkerConfig.setClassForTemplateLoading(classForTemplateLoading, '/' + FREEMARKER_LOCATION);
             newFreeMarkerConfig.setOutputEncoding("UTF-8");
 
             freeMarkerConfig = newFreeMarkerConfig;
@@ -63,30 +64,32 @@ public static void processTemplate(String templateName, Object templateDataModel
     /**
      * Processes FreeMarker template with the provided data model and generates output.
      *
-     * @param templateName      The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
+     * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
      * @param templateDataModel The template data model to apply.
-     * @param outputFile        The output to be generated.
+     * @param outputFile The output to be generated.
+     * @param classForTemplateLoading The class which is used to get class loader for templates.
      *
      * @throws ZserioExtensionException In case of any template error.
      */
-    public static void processTemplate(String templateName, Object templateDataModel, File outputFile)
-            throws ZserioExtensionException
+    public static void processTemplate(String templateName, Object templateDataModel, File outputFile,
+            Class<?> classForTemplateLoading) throws ZserioExtensionException
     {
-        processTemplate(templateName, templateDataModel, outputFile, false);
+        processTemplate(templateName, templateDataModel, outputFile, classForTemplateLoading, false);
     }
 
     /**
      * Processes FreeMarker template with the provided data model and generates output.
      *
-     * @param templateName      The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
+     * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.
      * @param templateDataModel The template data model to apply.
-     * @param outputFile        The output to be generated.
-     * @param amalgamate        True if the generated output will be amalgamated to the output file.
+     * @param outputFile The output to be generated.
+     * @param amalgamate True if the generated output will be amalgamated to the output file.
+     * @param classForTemplateLoading The class which is used to get class loader for templates.
      *
      * @throws ZserioExtensionException In case of any template error.
      */
     public static void processTemplate(String templateName, Object templateDataModel, File outputFile,
-            boolean amalgamate) throws ZserioExtensionException
+            Class<?> classForTemplateLoading, boolean amalgamate) throws ZserioExtensionException
     {
         FileUtil.createOutputDirectory(outputFile);
 
@@ -108,7 +111,7 @@ public static void processTemplate(String templateName, Object templateDataModel
 
             if (append)
                 bufferedWriter.newLine();
-            processTemplate(templateName, templateDataModel, bufferedWriter);
+            processTemplate(templateName, templateDataModel, bufferedWriter, classForTemplateLoading);
         }
         catch (IOException exception)
         {
@@ -122,14 +125,17 @@ public static void processTemplate(String templateName, Object templateDataModel
      * @param templateName Name of the FreeMarker template to read.
      *
      * @return List of lines read from FreeMarker template.
+     * @param classForTemplateLoading The class which is used to get class loader for templates.
      *
      * @throws ZserioExtensionException When the template is not available.
      */
-    public static List<String> readFreemarkerTemplate(String templateName) throws ZserioExtensionException
+    public static List<String> readFreemarkerTemplate(String templateName, Class<?> classForTemplateLoading)
+            throws ZserioExtensionException
     {
         final String fullTemplateName = FREEMARKER_LOCATION + templateName;
         try (final BufferedReader reader = new BufferedReader(new InputStreamReader(
-                     getFreemarkerTemplateStream(fullTemplateName), StandardCharsets.UTF_8)))
+                     getFreemarkerTemplateStream(fullTemplateName, classForTemplateLoading),
+                     StandardCharsets.UTF_8)))
         {
             final List<String> lines = new ArrayList<String>();
             while (reader.ready())
@@ -143,13 +149,13 @@ public static List<String> readFreemarkerTemplate(String templateName) throws Zs
         }
     }
 
-    private static InputStream getFreemarkerTemplateStream(String templateName) throws ZserioExtensionException
+    private static InputStream getFreemarkerTemplateStream(
+            String templateName, Class<?> classForTemplateLoading) throws ZserioExtensionException
     {
         InputStream resourceStream = null;
         try
         {
-            final ClassLoader classLoader = FreeMarkerUtil.class.getClassLoader();
-            resourceStream = classLoader.getResourceAsStream(templateName);
+            resourceStream = classForTemplateLoading.getClassLoader().getResourceAsStream(templateName);
         }
         catch (Exception e)
         {
diff --git a/compiler/extensions/cpp/src/zserio/extension/cpp/CppDefaultEmitter.java b/compiler/extensions/cpp/src/zserio/extension/cpp/CppDefaultEmitter.java
@@ -104,8 +104,8 @@ private void processTemplate(String templateName, Object templateData, PackageNa
             {
                 if (fileInfo) // not skipped
                 {
-                    FreeMarkerUtil.processTemplate(
-                            CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile, amalgamate);
+                    FreeMarkerUtil.processTemplate(CPP_TEMPLATE_LOCATION + templateName, templateData,
+                            outputFile, CppDefaultEmitter.class, amalgamate);
                 }
                 return;
             }
@@ -116,8 +116,8 @@ private void processTemplate(String templateName, Object templateData, PackageNa
                 !outputFileManager.checkTimestamps(outputFile) || !checkGeneratorDescription(outputFile);
         if (generate)
         {
-            FreeMarkerUtil.processTemplate(
-                    CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile, amalgamate);
+            FreeMarkerUtil.processTemplate(CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile,
+                    CppDefaultEmitter.class, amalgamate);
         }
 
         outputFileManager.registerOutputFile(outputFile, generate);
diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocFreeMarkerUtil.java b/compiler/extensions/doc/src/zserio/extension/doc/DocFreeMarkerUtil.java
@@ -16,13 +16,15 @@ final class DocFreeMarkerUtil
     public static void processTemplate(String templateName, Object templateData, File outputFile)
             throws ZserioExtensionException
     {
-        FreeMarkerUtil.processTemplate(DOC_TEMPLATE_LOCATION + templateName, templateData, outputFile);
+        FreeMarkerUtil.processTemplate(
+                DOC_TEMPLATE_LOCATION + templateName, templateData, outputFile, DocFreeMarkerUtil.class);
     }
 
     public static void processTemplate(String templateName, Object templateData, Writer outputWriter)
             throws ZserioExtensionException
     {
-        FreeMarkerUtil.processTemplate(DOC_TEMPLATE_LOCATION + templateName, templateData, outputWriter);
+        FreeMarkerUtil.processTemplate(
+                DOC_TEMPLATE_LOCATION + templateName, templateData, outputWriter, DocFreeMarkerUtil.class);
     }
 
     public static final String DOC_TEMPLATE_LOCATION = "doc/";
diff --git a/compiler/extensions/java/src/zserio/extension/java/JavaDefaultEmitter.java b/compiler/extensions/java/src/zserio/extension/java/JavaDefaultEmitter.java
@@ -94,7 +94,7 @@ private void processTemplate(String templateName, Object templateData, PackageNa
         if (generate)
         {
             FreeMarkerUtil.processTemplate(
-                    JAVA_TEMPLATE_LOCATION + templateName, templateData, outputFile, false);
+                    JAVA_TEMPLATE_LOCATION + templateName, templateData, outputFile, JavaDefaultEmitter.class);
         }
 
         outputFileManager.registerOutputFile(outputFile, generate);
diff --git a/compiler/extensions/python/src/zserio/extension/python/PythonDefaultEmitter.java b/compiler/extensions/python/src/zserio/extension/python/PythonDefaultEmitter.java
@@ -81,16 +81,17 @@ protected void processTemplate(String templateName, Object templateData, Package
                 !outputFileManager.checkTimestamps(outputFile) || !checkGeneratorDescription(outputFile);
         if (generate)
         {
-            FreeMarkerUtil.processTemplate(
-                    PYTHON_TEMPLATE_LOCATION + templateName, templateData, outputFile, false);
+            FreeMarkerUtil.processTemplate(PYTHON_TEMPLATE_LOCATION + templateName, templateData, outputFile,
+                    PythonDefaultEmitter.class);
         }
 
         outputFileManager.registerOutputFile(outputFile, generate);
     }
 
     protected static List<String> readFreemarkerTemplate(String templateName) throws ZserioExtensionException
     {
-        return FreeMarkerUtil.readFreemarkerTemplate(PYTHON_TEMPLATE_LOCATION + templateName);
+        return FreeMarkerUtil.readFreemarkerTemplate(
+                PYTHON_TEMPLATE_LOCATION + templateName, PythonDefaultEmitter.class);
     }
 
     static String getOutputFileName(String outFileNameRoot)

Original file line number	Diff line number	Diff line change
`@@ -27,19 +27,20 @@ public final class FreeMarkerUtil`
`27`	`27`	`/**`
`28`	`28`	`* Processes FreeMarker template with the provided data model and generates output.`
`29`	`29`	`*`
`30`		`- * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
	`30`	`+ * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
`31`	`31`	`* @param templateDataModel The template data model to apply.`
`32`		`- * @param outputWriter The writer to use for generated output.`
	`32`	`+ * @param outputWriter The writer to use for generated output.`
	`33`	`+ * @param classForTemplateLoading The class which is used to get class loader for templates.`
`33`	`34`	`*`
`34`	`35`	`* @throws ZserioExtensionException In case of any template error.`
`35`	`36`	`*/`
`36`		`- public static void processTemplate(String templateName, Object templateDataModel, Writer outputWriter)`
`37`		`- throws ZserioExtensionException`
	`37`	`+ public static void processTemplate(String templateName, Object templateDataModel, Writer outputWriter,`
	`38`	`+ Class<?> classForTemplateLoading) throws ZserioExtensionException`
`38`	`39`	`{`
`39`	`40`	`if (freeMarkerConfig == null)`
`40`	`41`	`{`
`41`	`42`	`final Configuration newFreeMarkerConfig = new Configuration(Configuration.VERSION_2_3_28);`
`42`		`- newFreeMarkerConfig.setClassForTemplateLoading(FreeMarkerUtil.class, '/' + FREEMARKER_LOCATION);`
	`43`	`+ newFreeMarkerConfig.setClassForTemplateLoading(classForTemplateLoading, '/' + FREEMARKER_LOCATION);`
`43`	`44`	`newFreeMarkerConfig.setOutputEncoding("UTF-8");`
`44`	`45`
`45`	`46`	`freeMarkerConfig = newFreeMarkerConfig;`
`@@ -63,30 +64,32 @@ public static void processTemplate(String templateName, Object templateDataModel`
`63`	`64`	`/**`
`64`	`65`	`* Processes FreeMarker template with the provided data model and generates output.`
`65`	`66`	`*`
`66`		`- * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
	`67`	`+ * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
`67`	`68`	`* @param templateDataModel The template data model to apply.`
`68`		`- * @param outputFile The output to be generated.`
	`69`	`+ * @param outputFile The output to be generated.`
	`70`	`+ * @param classForTemplateLoading The class which is used to get class loader for templates.`
`69`	`71`	`*`
`70`	`72`	`* @throws ZserioExtensionException In case of any template error.`
`71`	`73`	`*/`
`72`		`- public static void processTemplate(String templateName, Object templateDataModel, File outputFile)`
`73`		`- throws ZserioExtensionException`
	`74`	`+ public static void processTemplate(String templateName, Object templateDataModel, File outputFile,`
	`75`	`+ Class<?> classForTemplateLoading) throws ZserioExtensionException`
`74`	`76`	`{`
`75`		`- processTemplate(templateName, templateDataModel, outputFile, false);`
	`77`	`+ processTemplate(templateName, templateDataModel, outputFile, classForTemplateLoading, false);`
`76`	`78`	`}`
`77`	`79`
`78`	`80`	`/**`
`79`	`81`	`* Processes FreeMarker template with the provided data model and generates output.`
`80`	`82`	`*`
`81`		`- * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
	`83`	`+ * @param templateName The template name with the path relatively to "/FREEMARKER_LOCATION" directory.`
`82`	`84`	`* @param templateDataModel The template data model to apply.`
`83`		`- * @param outputFile The output to be generated.`
`84`		`- * @param amalgamate True if the generated output will be amalgamated to the output file.`
	`85`	`+ * @param outputFile The output to be generated.`
	`86`	`+ * @param amalgamate True if the generated output will be amalgamated to the output file.`
	`87`	`+ * @param classForTemplateLoading The class which is used to get class loader for templates.`
`85`	`88`	`*`
`86`	`89`	`* @throws ZserioExtensionException In case of any template error.`
`87`	`90`	`*/`
`88`	`91`	`public static void processTemplate(String templateName, Object templateDataModel, File outputFile,`
`89`		`- boolean amalgamate) throws ZserioExtensionException`
	`92`	`+ Class<?> classForTemplateLoading, boolean amalgamate) throws ZserioExtensionException`
`90`	`93`	`{`
`91`	`94`	`FileUtil.createOutputDirectory(outputFile);`
`92`	`95`
`@@ -108,7 +111,7 @@ public static void processTemplate(String templateName, Object templateDataModel`
`108`	`111`
`109`	`112`	`if (append)`
`110`	`113`	`bufferedWriter.newLine();`
`111`		`- processTemplate(templateName, templateDataModel, bufferedWriter);`
	`114`	`+ processTemplate(templateName, templateDataModel, bufferedWriter, classForTemplateLoading);`
`112`	`115`	`}`
`113`	`116`	`catch (IOException exception)`
`114`	`117`	`{`
`@@ -122,14 +125,17 @@ public static void processTemplate(String templateName, Object templateDataModel`
`122`	`125`	`* @param templateName Name of the FreeMarker template to read.`
`123`	`126`	`*`
`124`	`127`	`* @return List of lines read from FreeMarker template.`
	`128`	`+ * @param classForTemplateLoading The class which is used to get class loader for templates.`
`125`	`129`	`*`
`126`	`130`	`* @throws ZserioExtensionException When the template is not available.`
`127`	`131`	`*/`
`128`		`- public static List<String> readFreemarkerTemplate(String templateName) throws ZserioExtensionException`
	`132`	`+ public static List<String> readFreemarkerTemplate(String templateName, Class<?> classForTemplateLoading)`
	`133`	`+ throws ZserioExtensionException`
`129`	`134`	`{`
`130`	`135`	`final String fullTemplateName = FREEMARKER_LOCATION + templateName;`
`131`	`136`	`try (final BufferedReader reader = new BufferedReader(new InputStreamReader(`
`132`		`- getFreemarkerTemplateStream(fullTemplateName), StandardCharsets.UTF_8)))`
	`137`	`+ getFreemarkerTemplateStream(fullTemplateName, classForTemplateLoading),`
	`138`	`+ StandardCharsets.UTF_8)))`
`133`	`139`	`{`
`134`	`140`	`final List<String> lines = new ArrayList<String>();`
`135`	`141`	`while (reader.ready())`
`@@ -143,13 +149,13 @@ public static List<String> readFreemarkerTemplate(String templateName) throws Zs`
`143`	`149`	`}`
`144`	`150`	`}`
`145`	`151`
`146`		`- private static InputStream getFreemarkerTemplateStream(String templateName) throws ZserioExtensionException`
	`152`	`+ private static InputStream getFreemarkerTemplateStream(`
	`153`	`+ String templateName, Class<?> classForTemplateLoading) throws ZserioExtensionException`
`147`	`154`	`{`
`148`	`155`	`InputStream resourceStream = null;`
`149`	`156`	`try`
`150`	`157`	`{`
`151`		`- final ClassLoader classLoader = FreeMarkerUtil.class.getClassLoader();`
`152`		`- resourceStream = classLoader.getResourceAsStream(templateName);`
	`158`	`+ resourceStream = classForTemplateLoading.getClassLoader().getResourceAsStream(templateName);`
`153`	`159`	`}`
`154`	`160`	`catch (Exception e)`
`155`	`161`	`{`
Original file line number	Diff line number	Diff line change
`@@ -104,8 +104,8 @@ private void processTemplate(String templateName, Object templateData, PackageNa`
`104`	`104`	`{`
`105`	`105`	`if (fileInfo) // not skipped`
`106`	`106`	`{`
`107`		`- FreeMarkerUtil.processTemplate(`
`108`		`- CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile, amalgamate);`
	`107`	`+ FreeMarkerUtil.processTemplate(CPP_TEMPLATE_LOCATION + templateName, templateData,`
	`108`	`+ outputFile, CppDefaultEmitter.class, amalgamate);`
`109`	`109`	`}`
`110`	`110`	`return;`
`111`	`111`	`}`
`@@ -116,8 +116,8 @@ private void processTemplate(String templateName, Object templateData, PackageNa`
`116`	`116`	`!outputFileManager.checkTimestamps(outputFile) \|\| !checkGeneratorDescription(outputFile);`
`117`	`117`	`if (generate)`
`118`	`118`	`{`
`119`		`- FreeMarkerUtil.processTemplate(`
`120`		`- CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile, amalgamate);`
	`119`	`+ FreeMarkerUtil.processTemplate(CPP_TEMPLATE_LOCATION + templateName, templateData, outputFile,`
	`120`	`+ CppDefaultEmitter.class, amalgamate);`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`outputFileManager.registerOutputFile(outputFile, generate);`
Original file line number	Diff line number	Diff line change
`@@ -16,13 +16,15 @@ final class DocFreeMarkerUtil`
`16`	`16`	`public static void processTemplate(String templateName, Object templateData, File outputFile)`
`17`	`17`	`throws ZserioExtensionException`
`18`	`18`	`{`
`19`		`- FreeMarkerUtil.processTemplate(DOC_TEMPLATE_LOCATION + templateName, templateData, outputFile);`
	`19`	`+ FreeMarkerUtil.processTemplate(`
	`20`	`+ DOC_TEMPLATE_LOCATION + templateName, templateData, outputFile, DocFreeMarkerUtil.class);`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public static void processTemplate(String templateName, Object templateData, Writer outputWriter)`
`23`	`24`	`throws ZserioExtensionException`
`24`	`25`	`{`
`25`		`- FreeMarkerUtil.processTemplate(DOC_TEMPLATE_LOCATION + templateName, templateData, outputWriter);`
	`26`	`+ FreeMarkerUtil.processTemplate(`
	`27`	`+ DOC_TEMPLATE_LOCATION + templateName, templateData, outputWriter, DocFreeMarkerUtil.class);`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`public static final String DOC_TEMPLATE_LOCATION = "doc/";`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ private void processTemplate(String templateName, Object templateData, PackageNa`
`94`	`94`	`if (generate)`
`95`	`95`	`{`
`96`	`96`	`FreeMarkerUtil.processTemplate(`
`97`		`- JAVA_TEMPLATE_LOCATION + templateName, templateData, outputFile, false);`
	`97`	`+ JAVA_TEMPLATE_LOCATION + templateName, templateData, outputFile, JavaDefaultEmitter.class);`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`outputFileManager.registerOutputFile(outputFile, generate);`
Original file line number	Diff line number	Diff line change
`@@ -81,16 +81,17 @@ protected void processTemplate(String templateName, Object templateData, Package`
`81`	`81`	`!outputFileManager.checkTimestamps(outputFile) \|\| !checkGeneratorDescription(outputFile);`
`82`	`82`	`if (generate)`
`83`	`83`	`{`
`84`		`- FreeMarkerUtil.processTemplate(`
`85`		`- PYTHON_TEMPLATE_LOCATION + templateName, templateData, outputFile, false);`
	`84`	`+ FreeMarkerUtil.processTemplate(PYTHON_TEMPLATE_LOCATION + templateName, templateData, outputFile,`
	`85`	`+ PythonDefaultEmitter.class);`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`outputFileManager.registerOutputFile(outputFile, generate);`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`protected static List<String> readFreemarkerTemplate(String templateName) throws ZserioExtensionException`
`92`	`92`	`{`
`93`		`- return FreeMarkerUtil.readFreemarkerTemplate(PYTHON_TEMPLATE_LOCATION + templateName);`
	`93`	`+ return FreeMarkerUtil.readFreemarkerTemplate(`
	`94`	`+ PYTHON_TEMPLATE_LOCATION + templateName, PythonDefaultEmitter.class);`
`94`	`95`	`}`
`95`	`96`
`96`	`97`	`static String getOutputFileName(String outFileNameRoot)`