From 20a2538a0dc0280568f7b567ca1a063281d22d48 Mon Sep 17 00:00:00 2001 From: Miki Rozloznik Date: Fri, 5 Jan 2024 10:08:18 +0100 Subject: [PATCH] Add clang-format to the Doc extension project --- compiler/extensions/doc/build.xml | 18 +++++- .../extension/doc/AstNodeNameMapper.java | 10 ++-- .../extension/doc/AstNodePackageMapper.java | 6 +- .../extension/doc/AstNodeTypeNameMapper.java | 10 ++-- .../doc/BeginPackageTemplateData.java | 28 +++++----- .../extension/doc/BitmaskTemplateData.java | 15 ++--- .../extension/doc/ChoiceTemplateData.java | 39 +++++++------ .../doc/CompoundTypeTemplateData.java | 14 +++-- .../extension/doc/ConstantTemplateData.java | 3 +- .../doc/DocClassicToHtmlConverter.java | 2 +- .../doc/DocCommentsTemplateData.java | 13 ++--- .../zserio/extension/doc/DocDirectories.java | 4 +- .../doc/DocExpressionFormattingPolicy.java | 4 +- .../zserio/extension/doc/DocExtension.java | 4 +- .../extension/doc/DocExtensionParameters.java | 13 +++-- .../doc/DocMarkdownToHtmlConverter.java | 56 ++++++++----------- .../extension/doc/DocResourceManager.java | 30 +++++----- .../extension/doc/DotToSvgConverter.java | 6 +- .../doc/EnumerationTemplateData.java | 17 +++--- .../doc/HeaderNavigationTemplateData.java | 9 ++- .../extension/doc/HtmlResourceEmitter.java | 8 +-- .../doc/HtmlResourceTemplateData.java | 4 +- .../extension/doc/HtmlRuntimeEmitter.java | 6 +- .../zserio/extension/doc/PackageEmitter.java | 24 ++++---- .../extension/doc/PackageFileNameMapper.java | 4 +- .../doc/PackageTemplateDataBase.java | 7 ++- .../extension/doc/PubsubTemplateData.java | 9 ++- .../extension/doc/RulesOverviewEmitter.java | 13 ++--- .../doc/RulesOverviewTemplateData.java | 12 ++-- .../extension/doc/ServiceTemplateData.java | 11 ++-- .../extension/doc/SqlTableTemplateData.java | 9 +-- .../extension/doc/StylesheetEmitter.java | 4 +- .../extension/doc/SubtypeTemplateData.java | 3 +- .../doc/SymbolCollaborationDotEmitter.java | 21 ++++--- .../extension/doc/SymbolTemplateData.java | 10 ++-- .../doc/SymbolTemplateDataCreator.java | 21 +++---- .../extension/doc/TemplateDataContext.java | 4 +- .../extension/doc/UsedByChoiceCollector.java | 14 ++--- .../zserio/extension/doc/UsedByCollector.java | 2 +- 39 files changed, 258 insertions(+), 229 deletions(-) diff --git a/compiler/extensions/doc/build.xml b/compiler/extensions/doc/build.xml index 8647d903c..7d3b21fcb 100644 --- a/compiler/extensions/doc/build.xml +++ b/compiler/extensions/doc/build.xml @@ -19,6 +19,7 @@ zserio_doc.install_dir - Directory where to install Zserio Doc Extension zserio_core.jar_file - Zserio core jar file used for classpath. Default is "${zserio_extensions.build_dir}/../core/${ant.java.version}/jar/ zserio_core.jar". +clang_format.exe_file - Clang-format executable file. If not set, clang-format is not run. spotbugs.home_dir - Location of the spotbugs tool. If not set, spotbugs is not run. --> @@ -184,7 +185,22 @@ spotbugs.home_dir - Location of the spotbugs tool. If not set, spotb - + + +Command hints to reformat source using clang-format tool: + git clang-format + clang-format --style=file -i [SOURCE] + + + + + + + + + + + diff --git a/compiler/extensions/doc/src/zserio/extension/doc/AstNodeNameMapper.java b/compiler/extensions/doc/src/zserio/extension/doc/AstNodeNameMapper.java index 2ff60d22e..51a33b205 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/AstNodeNameMapper.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/AstNodeNameMapper.java @@ -59,8 +59,8 @@ public static String getName(AstNode node) final String name = visitor.getName(); if (name == null) { - ZserioToolPrinter.printWarning(node, "Unhandled AST node '" + node.getClass().getName() + - "' in AstNodeNameMapper!"); + ZserioToolPrinter.printWarning( + node, "Unhandled AST node '" + node.getClass().getName() + "' in AstNodeNameMapper!"); return "UnknownName"; } @@ -213,8 +213,10 @@ public void visitTypeInstantiation(TypeInstantiation typeInstantiation) { if (typeInstantiation instanceof ArrayInstantiation) { - ((ArrayInstantiation)typeInstantiation).getElementTypeInstantiation() - .getTypeReference().accept(this); + ((ArrayInstantiation)typeInstantiation) + .getElementTypeInstantiation() + .getTypeReference() + .accept(this); } else { diff --git a/compiler/extensions/doc/src/zserio/extension/doc/AstNodePackageMapper.java b/compiler/extensions/doc/src/zserio/extension/doc/AstNodePackageMapper.java index 660dd56ad..611d31797 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/AstNodePackageMapper.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/AstNodePackageMapper.java @@ -150,8 +150,10 @@ public void visitTypeInstantiation(TypeInstantiation typeInstantiation) { if (typeInstantiation instanceof ArrayInstantiation) { - ((ArrayInstantiation)typeInstantiation).getElementTypeInstantiation() - .getTypeReference().accept(this); + ((ArrayInstantiation)typeInstantiation) + .getElementTypeInstantiation() + .getTypeReference() + .accept(this); } else { diff --git a/compiler/extensions/doc/src/zserio/extension/doc/AstNodeTypeNameMapper.java b/compiler/extensions/doc/src/zserio/extension/doc/AstNodeTypeNameMapper.java index 660e34bf2..0f40ebb6d 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/AstNodeTypeNameMapper.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/AstNodeTypeNameMapper.java @@ -64,8 +64,8 @@ public static String getTypeName(AstNode node) final String typeName = visitor.getTypeName(); if (typeName == null) { - ZserioToolPrinter.printWarning(node, "Unhandled AST node '" + node.getClass().getName() + - "' in AstNodeTypeNameMapper!"); + ZserioToolPrinter.printWarning( + node, "Unhandled AST node '" + node.getClass().getName() + "' in AstNodeTypeNameMapper!"); return "UnknownTypeName"; } @@ -251,8 +251,10 @@ public void visitTypeInstantiation(TypeInstantiation typeInstantiation) { if (typeInstantiation instanceof ArrayInstantiation) { - ((ArrayInstantiation)typeInstantiation).getElementTypeInstantiation() - .getTypeReference().accept(this); + ((ArrayInstantiation)typeInstantiation) + .getElementTypeInstantiation() + .getTypeReference() + .accept(this); } else { diff --git a/compiler/extensions/doc/src/zserio/extension/doc/BeginPackageTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/BeginPackageTemplateData.java index cb07cd3c7..4dba97aeb 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/BeginPackageTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/BeginPackageTemplateData.java @@ -20,7 +20,7 @@ public final class BeginPackageTemplateData { public BeginPackageTemplateData(PackageTemplateDataContext context, Package pkg, Map> nodesMap, HeaderNavigationTemplateData headerNavigation) - throws ZserioExtensionException + throws ZserioExtensionException { cssDirectory = context.getCssDirectory(); isDefaultPackage = pkg.getPackageName().isEmpty(); @@ -29,8 +29,9 @@ public BeginPackageTemplateData(PackageTemplateDataContext context, Package pkg, this.headerNavigation = headerNavigation; - compatibilityVersion = pkg.getCompatibilityVersion() != null ? - new CompatibilityVersionTemplateData(context, pkg.getCompatibilityVersion()) : null; + compatibilityVersion = pkg.getCompatibilityVersion() != null + ? new CompatibilityVersionTemplateData(context, pkg.getCompatibilityVersion()) + : null; for (Import importNode : pkg.getImports()) importNodes.add(new ImportTemplateData(context, importNode)); @@ -92,11 +93,11 @@ public Iterable getTocSymbols() return tocSymbols; } - public static final class PackageSymbolOverviewTemplateData implements - Comparable + public static final class PackageSymbolOverviewTemplateData + implements Comparable { - public PackageSymbolOverviewTemplateData(PackageTemplateDataContext context, Package pkg, - List packageSymbols) + public PackageSymbolOverviewTemplateData( + PackageTemplateDataContext context, Package pkg, List packageSymbols) { symbol = SymbolTemplateDataCreator.createData(context, pkg); for (AstNode packageSymbol : packageSymbols) @@ -141,8 +142,8 @@ public Iterable getPackageSymbols() public static final class CompatibilityVersionTemplateData { - public CompatibilityVersionTemplateData(PackageTemplateDataContext context, - CompatibilityVersion compatibilityVersion) + public CompatibilityVersionTemplateData( + PackageTemplateDataContext context, CompatibilityVersion compatibilityVersion) { version = compatibilityVersion.getVersion().toString(); docComments = new DocCommentsTemplateData(context, compatibilityVersion.getDocComments()); @@ -168,11 +169,12 @@ public ImportTemplateData(PackageTemplateDataContext context, Import importNode) throws ZserioExtensionException { docComments = new DocCommentsTemplateData(context, importNode.getDocComments()); - importedPackageSymbol = SymbolTemplateDataCreator.createData(context, - importNode.getImportedPackage()); + importedPackageSymbol = + SymbolTemplateDataCreator.createData(context, importNode.getImportedPackage()); final PackageSymbol importedPackageSymbol = importNode.getImportedSymbol(); - importedSymbol = (importedPackageSymbol == null) ? null : - SymbolTemplateDataCreator.createData(context, importedPackageSymbol); + importedSymbol = (importedPackageSymbol == null) + ? null + : SymbolTemplateDataCreator.createData(context, importedPackageSymbol); } public DocCommentsTemplateData getDocComments() diff --git a/compiler/extensions/doc/src/zserio/extension/doc/BitmaskTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/BitmaskTemplateData.java index 60853b495..495ad53ed 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/BitmaskTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/BitmaskTemplateData.java @@ -50,23 +50,24 @@ public BitmaskValueTemplateData(PackageTemplateDataContext context, BitmaskType final ExpressionFormatter docExpressionFormatter = context.getExpressionFormatter(); final Expression valueExpression = bitmaskValue.getValueExpression(); hasValueExpression = valueExpression != null; - value = hasValueExpression ? docExpressionFormatter.formatGetter(bitmaskValue.getValueExpression()) : - bitmaskValue.getValue().toString(); + value = hasValueExpression + ? docExpressionFormatter.formatGetter(bitmaskValue.getValueExpression()) + : bitmaskValue.getValue().toString(); docComments = new DocCommentsTemplateData(context, bitmaskValue.getDocComments()); final UsedByChoiceCollector usedByChoiceCollector = context.getUsedByChoiceCollector(); seeSymbols = new ArrayList(); for (UsedByChoiceCollector.ChoiceCaseReference choiceCaseRef : - usedByChoiceCollector.getUsedByChoices(bitmaskValue)) + usedByChoiceCollector.getUsedByChoices(bitmaskValue)) { final ChoiceType choiceType = choiceCaseRef.getChoiceType(); final ChoiceCase choiceCase = choiceCaseRef.getChoiceCase(); final Expression caseExpression = choiceCaseRef.getChoiceCaseExpression().getExpression(); - final SymbolTemplateData choiceCaseSymbol = SymbolTemplateDataCreator.createData(context, - choiceType, choiceCase, docExpressionFormatter.formatGetter(caseExpression)); - final SymbolTemplateData choiceTypeSymbol = SymbolTemplateDataCreator.createData(context, - choiceType); + final SymbolTemplateData choiceCaseSymbol = SymbolTemplateDataCreator.createData( + context, choiceType, choiceCase, docExpressionFormatter.formatGetter(caseExpression)); + final SymbolTemplateData choiceTypeSymbol = + SymbolTemplateDataCreator.createData(context, choiceType); seeSymbols.add(new SeeSymbolTemplateData(choiceCaseSymbol, choiceTypeSymbol)); } } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/ChoiceTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/ChoiceTemplateData.java index eed0c5611..9b690d273 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/ChoiceTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/ChoiceTemplateData.java @@ -23,7 +23,8 @@ */ public final class ChoiceTemplateData extends CompoundTypeTemplateData { - public ChoiceTemplateData(PackageTemplateDataContext context, ChoiceType choiceType) throws ZserioExtensionException + public ChoiceTemplateData(PackageTemplateDataContext context, ChoiceType choiceType) + throws ZserioExtensionException { super(context, choiceType); @@ -34,13 +35,14 @@ public ChoiceTemplateData(PackageTemplateDataContext context, ChoiceType choiceT for (ChoiceCase choiceCase : choiceType.getChoiceCases()) caseMembers.add(new CaseMemberTemplateData(context, choiceType, choiceCase)); - defaultMember = (choiceType.getChoiceDefault() != null) ? new DefaultMemberTemplateData(context, - choiceType) : null; + defaultMember = (choiceType.getChoiceDefault() != null) + ? new DefaultMemberTemplateData(context, choiceType) + : null; } public String getSelectorExpression() { - return selectorExpression; + return selectorExpression; } public Iterable getCaseMemberList() @@ -55,8 +57,8 @@ public DefaultMemberTemplateData getDefaultMember() public static final class CaseMemberTemplateData { - public CaseMemberTemplateData(PackageTemplateDataContext context, ChoiceType choiceType, ChoiceCase choiceCase) - throws ZserioExtensionException + public CaseMemberTemplateData(PackageTemplateDataContext context, ChoiceType choiceType, + ChoiceCase choiceCase) throws ZserioExtensionException { caseList = new ArrayList(); final Iterable caseExpressions = choiceCase.getExpressions(); @@ -64,8 +66,9 @@ public CaseMemberTemplateData(PackageTemplateDataContext context, ChoiceType cho caseList.add(new CaseTemplateData(context, choiceType, choiceCase, caseExpression.getExpression(), caseExpression.getDocComments())); - field = (choiceCase.getField() != null) ? new FieldTemplateData(context, choiceType, - choiceCase.getField()) : null; + field = (choiceCase.getField() != null) + ? new FieldTemplateData(context, choiceType, choiceCase.getField()) + : null; } public Iterable getCaseList() @@ -86,7 +89,7 @@ public static final class CaseTemplateData { public CaseTemplateData(PackageTemplateDataContext context, ChoiceType choiceType, ChoiceCase choiceCase, Expression caseExpression, List docComments) - throws ZserioExtensionException + throws ZserioExtensionException { final ExpressionFormatter docExpressionFormatter = context.getExpressionFormatter(); final String expression = docExpressionFormatter.formatGetter(caseExpression); @@ -98,13 +101,14 @@ public CaseTemplateData(PackageTemplateDataContext context, ChoiceType choiceTyp final AstNode caseExpressionObject = caseExpression.getExprSymbolObject(); final ZserioType selectorExpressionType = choiceType.getSelectorExpression().getExprZserioType(); - if (caseExpressionObject instanceof EnumItem && selectorExpressionType instanceof EnumType || - caseExpressionObject instanceof BitmaskValue && selectorExpressionType instanceof BitmaskType) + if (caseExpressionObject instanceof EnumItem && selectorExpressionType instanceof EnumType || + caseExpressionObject instanceof BitmaskValue && + selectorExpressionType instanceof BitmaskType) { - final SymbolTemplateData memberSymbol = SymbolTemplateDataCreator.createData(context, - selectorExpressionType, caseExpressionObject); - final SymbolTemplateData typeSymbol = SymbolTemplateDataCreator.createData(context, - selectorExpressionType); + final SymbolTemplateData memberSymbol = SymbolTemplateDataCreator.createData( + context, selectorExpressionType, caseExpressionObject); + final SymbolTemplateData typeSymbol = + SymbolTemplateDataCreator.createData(context, selectorExpressionType); seeSymbol = new SeeSymbolTemplateData(memberSymbol, typeSymbol); } else @@ -145,8 +149,9 @@ public DefaultMemberTemplateData(PackageTemplateDataContext context, ChoiceType throws ZserioExtensionException { final ChoiceDefault choiceDefault = choiceType.getChoiceDefault(); - field = (choiceDefault.getField() == null) ? null : new FieldTemplateData(context, choiceType, - choiceDefault.getField()); + field = (choiceDefault.getField() == null) + ? null + : new FieldTemplateData(context, choiceType, choiceDefault.getField()); symbol = SymbolTemplateDataCreator.createData(context, choiceType, choiceDefault, "default"); docComments = new DocCommentsTemplateData(context, choiceDefault.getDocComments()); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/CompoundTypeTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/CompoundTypeTemplateData.java index 37f370dc8..00303c1b2 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/CompoundTypeTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/CompoundTypeTemplateData.java @@ -11,9 +11,9 @@ import zserio.ast.Function; import zserio.ast.Parameter; import zserio.ast.ParameterizedTypeInstantiation; -import zserio.ast.TypeInstantiation; import zserio.ast.SqlConstraint; import zserio.ast.TemplateParameter; +import zserio.ast.TypeInstantiation; import zserio.extension.common.ExpressionFormatter; import zserio.extension.common.ZserioExtensionException; @@ -62,7 +62,8 @@ public Iterable getFunctions() public static final class TemplateParameterTemplateData { - public TemplateParameterTemplateData(PackageTemplateDataContext context, TemplateParameter templateParameter) + public TemplateParameterTemplateData( + PackageTemplateDataContext context, TemplateParameter templateParameter) { name = templateParameter.getName(); } @@ -155,8 +156,9 @@ public FieldTemplateData(PackageTemplateDataContext context, CompoundType compou optionalClauseExpression = formatExpression(field.getOptionalClauseExpr(), docExpressionFormatter); offsetExpression = formatExpression(field.getOffsetExpr(), docExpressionFormatter); final SqlConstraint sqlConstraint = field.getSqlConstraint(); - sqlConstraintExpression = (sqlConstraint == null) ? "" : - formatExpression(sqlConstraint.getConstraintExpr(), docExpressionFormatter); + sqlConstraintExpression = (sqlConstraint == null) + ? "" + : formatExpression(sqlConstraint.getConstraintExpr(), docExpressionFormatter); } public SymbolTemplateData getSymbol() @@ -271,8 +273,8 @@ private String formatExpression(Expression expression, ExpressionFormatter docEx public static final class FunctionTemplateData { - public FunctionTemplateData(PackageTemplateDataContext context, CompoundType compoundType, Function function) - throws ZserioExtensionException + public FunctionTemplateData(PackageTemplateDataContext context, CompoundType compoundType, + Function function) throws ZserioExtensionException { symbol = SymbolTemplateDataCreator.createData(context, compoundType, function); returnSymbol = SymbolTemplateDataCreator.createData(context, function.getReturnTypeReference()); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/ConstantTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/ConstantTemplateData.java index 8fe931899..d7c5df748 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/ConstantTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/ConstantTemplateData.java @@ -8,7 +8,8 @@ */ public final class ConstantTemplateData extends PackageTemplateDataBase { - public ConstantTemplateData(PackageTemplateDataContext context, Constant constant) throws ZserioExtensionException + public ConstantTemplateData(PackageTemplateDataContext context, Constant constant) + throws ZserioExtensionException { super(context, constant); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocClassicToHtmlConverter.java b/compiler/extensions/doc/src/zserio/extension/doc/DocClassicToHtmlConverter.java index 9f9024bac..cff082ae0 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocClassicToHtmlConverter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocClassicToHtmlConverter.java @@ -333,7 +333,7 @@ private static String findHtmlTag(String text, int startIndex) "", "", "", - "" + "", }; private static final Set startHtmlTagList = new HashSet(Arrays.asList(startHtmlTags)); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocCommentsTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/DocCommentsTemplateData.java index 458cea09a..51658465d 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocCommentsTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocCommentsTemplateData.java @@ -95,8 +95,8 @@ public DocCommentTemplateData(ContentTemplateDataContext context, DocCommentMark isDeprecated = false; final DocResourceManager docResourceManager = context.getDocResourceManager(); - markdownHtml = DocMarkdownToHtmlConverter.convert(docResourceManager, - docCommentMarkdown.getLocation(), docCommentMarkdown.getMarkdown()); + markdownHtml = DocMarkdownToHtmlConverter.convert( + docResourceManager, docCommentMarkdown.getLocation(), docCommentMarkdown.getMarkdown()); this.isOneLiner = docCommentMarkdown.isOneLiner(); } @@ -205,8 +205,7 @@ public static final class DocLineElementData public DocLineElementData(ContentTemplateDataContext context, DocLineElement docLineElement) { final DocText docText = docLineElement.getDocText(); - docString = docText != null ? - DocClassicToHtmlConverter.convert(docText.getText()) : null; + docString = docText != null ? DocClassicToHtmlConverter.convert(docText.getText()) : null; final DocTagSee docTagSee = docLineElement.getSeeTag(); seeTag = docTagSee != null ? new DocTagSeeData(context, docTagSee) : null; @@ -233,7 +232,7 @@ public static final class DocTagSeeData { public DocTagSeeData(ContentTemplateDataContext context, DocTagSee docTagSee) { - seeSymbol = SymbolTemplateDataCreator.createData(context, docTagSee); + seeSymbol = SymbolTemplateDataCreator.createData(context, docTagSee); } public SymbolTemplateData getSeeSymbol() @@ -273,8 +272,8 @@ public DocMultilineData getDescription() private final boolean isOneLiner; } - private DocCommentTemplateData createDocCommentTemplateData(ContentTemplateDataContext context, - DocComment docComment) + private DocCommentTemplateData createDocCommentTemplateData( + ContentTemplateDataContext context, DocComment docComment) { if (docComment instanceof DocCommentMarkdown) { diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocDirectories.java b/compiler/extensions/doc/src/zserio/extension/doc/DocDirectories.java index 5c007c53d..7334df199 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocDirectories.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocDirectories.java @@ -14,6 +14,6 @@ final class DocDirectories public static final String PACKAGES_DIRECTORY = CONTENT_DIRECTORY + File.separator + "packages"; public static final String DOC_RESOURCES_DIRECTORY = RESOURCES_DIRECTORY + File.separator + "doc"; - public static final String SYMBOL_COLLABORATION_DIRECTORY = RESOURCES_DIRECTORY + File.separator + - "diagrams"; + public static final String SYMBOL_COLLABORATION_DIRECTORY = + RESOURCES_DIRECTORY + File.separator + "diagrams"; } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocExpressionFormattingPolicy.java b/compiler/extensions/doc/src/zserio/extension/doc/DocExpressionFormattingPolicy.java index 7c4a41e2b..b938e7bf2 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocExpressionFormattingPolicy.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocExpressionFormattingPolicy.java @@ -81,13 +81,13 @@ public UnaryExpressionFormatting getFunctionCall(Expression expr) @Override public UnaryExpressionFormatting getLengthOf(Expression expr) { - return new UnaryExpressionFormatting("lengthof(" , ")"); + return new UnaryExpressionFormatting("lengthof(", ")"); } @Override public UnaryExpressionFormatting getValueOf(Expression expr) { - return new UnaryExpressionFormatting("valueof(" , ")"); + return new UnaryExpressionFormatting("valueof(", ")"); } @Override diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocExtension.java b/compiler/extensions/doc/src/zserio/extension/doc/DocExtension.java index 38247ea81..fa1f4623a 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocExtension.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocExtension.java @@ -91,8 +91,8 @@ public void process(Root rootNode, ExtensionParameters parameters) throws Zserio // emit HTML rules overview if (ruleGroupVisitor.hasSchemaRules()) { - final RulesOverviewEmitter rulesOverviewEmitter = new RulesOverviewEmitter(outputFileManager, - docParameters, docResourceManager); + final RulesOverviewEmitter rulesOverviewEmitter = + new RulesOverviewEmitter(outputFileManager, docParameters, docResourceManager); rootNode.walk(rulesOverviewEmitter); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocExtensionParameters.java b/compiler/extensions/doc/src/zserio/extension/doc/DocExtensionParameters.java index 4543e8cfe..5a562dafe 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocExtensionParameters.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocExtensionParameters.java @@ -19,8 +19,9 @@ public DocExtensionParameters(ExtensionParameters parameters) throws ZserioExten pathName = parameters.getPathName(); outputDir = parameters.getCommandLineArg(OptionDoc); withSvgDiagrams = parameters.argumentExists(OptionWithSvgDiagrams); - dotExecutable = (parameters.argumentExists(OptionSetDotExecutable)) ? - parameters.getCommandLineArg(OptionSetDotExecutable) : DefaultDotExecutable; + dotExecutable = (parameters.argumentExists(OptionSetDotExecutable)) + ? parameters.getCommandLineArg(OptionSetDotExecutable) + : DefaultDotExecutable; if (withSvgDiagrams && !DotToSvgConverter.isDotExecAvailable(dotExecutable)) throw new ZserioExtensionException("The dot executable '" + dotExecutable + "' not found!"); @@ -56,14 +57,14 @@ static void registerOptions(org.apache.commons.cli.Options options) final OptionGroup svgDiagramsGroup = new OptionGroup(); option = new Option(OptionWithSvgDiagrams, false, "enable generation of svg diagrams from dot files"); svgDiagramsGroup.addOption(option); - option = new Option(OptionWithoutSvgDiagrams, false, - "disable generation of svg diagrams from dot files (default)"); + option = new Option( + OptionWithoutSvgDiagrams, false, "disable generation of svg diagrams from dot files (default)"); svgDiagramsGroup.addOption(option); svgDiagramsGroup.setRequired(false); options.addOptionGroup(svgDiagramsGroup); - option = new Option(OptionSetDotExecutable, true, - "set dot executable to use for conversions to svg format"); + option = new Option( + OptionSetDotExecutable, true, "set dot executable to use for conversions to svg format"); option.setArgName("dotExec"); option.setRequired(false); options.addOption(option); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocMarkdownToHtmlConverter.java b/compiler/extensions/doc/src/zserio/extension/doc/DocMarkdownToHtmlConverter.java index f669e4d50..b06ac0c66 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocMarkdownToHtmlConverter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocMarkdownToHtmlConverter.java @@ -6,26 +6,25 @@ import java.util.Map; import java.util.Set; -import org.commonmark.node.Node; +import org.commonmark.Extension; +import org.commonmark.ext.autolink.AutolinkExtension; +import org.commonmark.ext.gfm.tables.TablesExtension; +import org.commonmark.ext.heading.anchor.HeadingAnchorExtension; import org.commonmark.node.Image; import org.commonmark.node.Link; -import org.commonmark.Extension; +import org.commonmark.node.Node; import org.commonmark.parser.Parser; import org.commonmark.renderer.NodeRenderer; -import org.commonmark.renderer.html.HtmlRenderer; - -import zserio.ast.AstLocation; -import zserio.tools.ZserioToolPrinter; - import org.commonmark.renderer.html.AttributeProvider; import org.commonmark.renderer.html.AttributeProviderContext; import org.commonmark.renderer.html.AttributeProviderFactory; import org.commonmark.renderer.html.CoreHtmlNodeRenderer; import org.commonmark.renderer.html.HtmlNodeRendererContext; import org.commonmark.renderer.html.HtmlNodeRendererFactory; -import org.commonmark.ext.autolink.AutolinkExtension; -import org.commonmark.ext.heading.anchor.HeadingAnchorExtension; -import org.commonmark.ext.gfm.tables.TablesExtension; +import org.commonmark.renderer.html.HtmlRenderer; + +import zserio.ast.AstLocation; +import zserio.tools.ZserioToolPrinter; /** * Converter for the Markdown documentation comment text into HTML format. @@ -37,45 +36,37 @@ class DocMarkdownToHtmlConverter { static String convert(DocResourceManager docResourceManager, AstLocation location, String markdown) { - final List extensions = Arrays.asList(AutolinkExtension.create(), - HeadingAnchorExtension.create(), TablesExtension.create()); + final List extensions = Arrays.asList( + AutolinkExtension.create(), HeadingAnchorExtension.create(), TablesExtension.create()); final Parser parser = Parser.builder().extensions(extensions).build(); final Node document = parser.parse(markdown); - final HtmlRenderer renderer = HtmlRenderer.builder() - .extensions(extensions) - .nodeRendererFactory( - new HtmlNodeRendererFactory() - { + final HtmlRenderer renderer = + HtmlRenderer.builder() + .extensions(extensions) + .nodeRendererFactory(new HtmlNodeRendererFactory() { @Override public NodeRenderer create(HtmlNodeRendererContext context) { return new ResourcesRenderer(context, docResourceManager, location); } - } - ) - .attributeProviderFactory( - new AttributeProviderFactory() - { + }) + .attributeProviderFactory(new AttributeProviderFactory() { @Override public AttributeProvider create(AttributeProviderContext arg0) { return new AnchorAttributeProvider(); } - } - ) - .attributeProviderFactory( - new AttributeProviderFactory() - { + }) + .attributeProviderFactory(new AttributeProviderFactory() { @Override public AttributeProvider create(AttributeProviderContext arg0) { return new ImageAttributeProvider(); } - } - ) - .build(); + }) + .build(); final String html = renderer.render(document); @@ -84,8 +75,8 @@ public AttributeProvider create(AttributeProviderContext arg0) private static class ResourcesRenderer extends CoreHtmlNodeRenderer { - ResourcesRenderer(HtmlNodeRendererContext context, - DocResourceManager docResourceManager, AstLocation location) + ResourcesRenderer( + HtmlNodeRendererContext context, DocResourceManager docResourceManager, AstLocation location) { super(context); this.docResourceManager = docResourceManager; @@ -121,7 +112,6 @@ public void visit(Image image) { final String mappedResource = docResourceManager.addResource(location, image.getDestination()); image.setDestination(convertToHtmlDestination(mappedResource)); - } catch (Exception e) { diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DocResourceManager.java b/compiler/extensions/doc/src/zserio/extension/doc/DocResourceManager.java index 83d94645b..ebaac0d0c 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DocResourceManager.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DocResourceManager.java @@ -42,10 +42,10 @@ public DocResourceManager(OutputFileManager outputFileManager, DocExtensionParam this.packageCollector = packageCollector; final String outputDir = docParameters.getOutputDir(); - final String htmlPackagesDirectory = StringJoinUtil.joinStrings( - outputDir, DocDirectories.PACKAGES_DIRECTORY, File.separator); - final String docResourceDirectory = StringJoinUtil.joinStrings( - outputDir, DocDirectories.DOC_RESOURCES_DIRECTORY, File.separator); + final String htmlPackagesDirectory = + StringJoinUtil.joinStrings(outputDir, DocDirectories.PACKAGES_DIRECTORY, File.separator); + final String docResourceDirectory = + StringJoinUtil.joinStrings(outputDir, DocDirectories.DOC_RESOURCES_DIRECTORY, File.separator); packagesDir = Paths.get(htmlPackagesDirectory).toAbsolutePath(); resourcesDir = Paths.get(docResourceDirectory).toAbsolutePath(); @@ -101,8 +101,8 @@ private LocalResource mapLocalResource(LocalResource resource) throws ZserioExte } else { - mappedResource = addMappedResource(resourcesDir, resource.getBaseName(), - resource.getExtension()); + mappedResource = + addMappedResource(resourcesDir, resource.getBaseName(), resource.getExtension()); } resources.put(resource, mappedResource); @@ -126,12 +126,12 @@ private void copyResource(LocalResource srcResource, LocalResource dstResource) try { currentOutputDir = dstResource.getPath(); - final String markdown = new String(Files.readAllBytes(srcResource.getFullPath()), - StandardCharsets.UTF_8); - final String bodyContent = DocMarkdownToHtmlConverter.convert(this, - new AstLocation(srcResource.getFullPath().toString(), 0, 0), markdown); - htmlResourceEmitter.emit(dstResource.getPath(), - dstResource.getFileName(), srcResource.getFileName(), bodyContent); + final String markdown = + new String(Files.readAllBytes(srcResource.getFullPath()), StandardCharsets.UTF_8); + final String bodyContent = DocMarkdownToHtmlConverter.convert( + this, new AstLocation(srcResource.getFullPath().toString(), 0, 0), markdown); + htmlResourceEmitter.emit(dstResource.getPath(), dstResource.getFileName(), + srcResource.getFileName(), bodyContent); } catch (ZserioExtensionException e) { @@ -163,8 +163,8 @@ private LocalResource addMappedResource(Path path, String baseName, String exten int duplicityMarkerIndex = 0; while (!mappedResources.add(mappedResource)) { - mappedResource = new LocalResource( - path, baseName + "(" + (++duplicityMarkerIndex) + ")", extension); + mappedResource = + new LocalResource(path, baseName + "(" + (++duplicityMarkerIndex) + ")", extension); } return mappedResource; } @@ -227,7 +227,7 @@ public LocalResource(Path currentDir, String resourcePath) final int lastDotIndex = fileName.lastIndexOf('.'); baseName = (lastDotIndex != -1) ? fileName.substring(0, lastDotIndex) : fileName; - extension = (lastDotIndex != -1) ? fileName.substring(lastDotIndex) : ""; + extension = (lastDotIndex != -1) ? fileName.substring(lastDotIndex) : ""; } public LocalResource(Path path, String baseName, String extension) diff --git a/compiler/extensions/doc/src/zserio/extension/doc/DotToSvgConverter.java b/compiler/extensions/doc/src/zserio/extension/doc/DotToSvgConverter.java index 5969fc27c..0babdaf3e 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/DotToSvgConverter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/DotToSvgConverter.java @@ -15,7 +15,7 @@ final class DotToSvgConverter { public static boolean isDotExecAvailable(String dotExecutable) { - final String commandWithArguments[] = { dotExecutable, "-V" }; + final String commandWithArguments[] = {dotExecutable, "-V"}; try { @@ -30,8 +30,8 @@ public static boolean isDotExecAvailable(String dotExecutable) public static void convert(String dotExecutable, File inputDotFile, File outputSvgFile) throws ZserioExtensionException { - final String commandWithArguments[] = { dotExecutable, inputDotFile.toString(), "-T", "svg", "-o", - outputSvgFile.toString() }; + final String commandWithArguments[] = { + dotExecutable, inputDotFile.toString(), "-T", "svg", "-o", outputSvgFile.toString()}; if (!runDotExecutable(commandWithArguments)) throw new ZserioExtensionException("Failure to convert '" + inputDotFile + "' to SVG format!"); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/EnumerationTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/EnumerationTemplateData.java index 5b3ad76e7..4ab9421f3 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/EnumerationTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/EnumerationTemplateData.java @@ -24,7 +24,7 @@ public EnumerationTemplateData(PackageTemplateDataContext context, EnumType enum typeSymbol = SymbolTemplateDataCreator.createData(context, enumType.getTypeInstantiation()); items = new ArrayList(); - for (EnumItem item: enumType.getItems()) + for (EnumItem item : enumType.getItems()) items.add(new EnumItemTemplateData(context, enumType, item)); } @@ -48,8 +48,9 @@ public EnumItemTemplateData(PackageTemplateDataContext context, EnumType enumTyp final Expression valueExpression = enumItem.getValueExpression(); final ExpressionFormatter docExpressionFormatter = context.getExpressionFormatter(); hasValueExpression = (valueExpression != null); - value = hasValueExpression ? docExpressionFormatter.formatGetter(valueExpression) : - enumItem.getValue().toString(); + value = hasValueExpression + ? docExpressionFormatter.formatGetter(valueExpression) + : enumItem.getValue().toString(); isDeprecated = enumItem.isDeprecated(); isRemoved = enumItem.isRemoved(); @@ -59,15 +60,15 @@ public EnumItemTemplateData(PackageTemplateDataContext context, EnumType enumTyp seeSymbols = new ArrayList(); final UsedByChoiceCollector usedByChoiceCollector = context.getUsedByChoiceCollector(); for (UsedByChoiceCollector.ChoiceCaseReference choiceCaseRef : - usedByChoiceCollector.getUsedByChoices(enumItem)) + usedByChoiceCollector.getUsedByChoices(enumItem)) { final ChoiceType choiceType = choiceCaseRef.getChoiceType(); final ChoiceCase choiceCase = choiceCaseRef.getChoiceCase(); final Expression caseExpression = choiceCaseRef.getChoiceCaseExpression().getExpression(); - final SymbolTemplateData choiceCaseSymbol = SymbolTemplateDataCreator.createData(context, - choiceType, choiceCase, docExpressionFormatter.formatGetter(caseExpression)); - final SymbolTemplateData choiceTypeSymbol = SymbolTemplateDataCreator.createData(context, - choiceType); + final SymbolTemplateData choiceCaseSymbol = SymbolTemplateDataCreator.createData( + context, choiceType, choiceCase, docExpressionFormatter.formatGetter(caseExpression)); + final SymbolTemplateData choiceTypeSymbol = + SymbolTemplateDataCreator.createData(context, choiceType); seeSymbols.add(new SeeSymbolTemplateData(choiceCaseSymbol, choiceTypeSymbol)); } } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/HeaderNavigationTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/HeaderNavigationTemplateData.java index d8af51886..7ea150130 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/HeaderNavigationTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/HeaderNavigationTemplateData.java @@ -10,12 +10,11 @@ */ public final class HeaderNavigationTemplateData { - public HeaderNavigationTemplateData(TemplateDataContext context, Package rootPackage, - boolean hasSchemaRules, ActiveItem activeItem) + public HeaderNavigationTemplateData( + TemplateDataContext context, Package rootPackage, boolean hasSchemaRules, ActiveItem activeItem) { final SymbolTemplateData rootPackageSymbol = SymbolTemplateDataCreator.createData(context, rootPackage); - navigationItems.add(new NavigationItem( - "Packages", rootPackageSymbol.getHtmlLink().getHtmlPage())); + navigationItems.add(new NavigationItem("Packages", rootPackageSymbol.getHtmlLink().getHtmlPage())); if (hasSchemaRules) { navigationItems.add(new NavigationItem( @@ -74,7 +73,7 @@ private ActiveItem(int index) } private final int index; - }; + } private final List navigationItems = new ArrayList(); private final ActiveItem activeItem; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceEmitter.java index 94d7bff3f..a58a3a151 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceEmitter.java @@ -29,10 +29,10 @@ public HtmlResourceEmitter(OutputFileManager outputFileManager, DocExtensionPara public void emit(Path outputDir, String fileName, String title, String bodyContent) throws ZserioExtensionException { - final TemplateDataContext context = new TemplateDataContext(docParameters, - outputDir.relativize(htmlRootDirectory).toString()); - final HtmlResourceTemplateData templateData = new HtmlResourceTemplateData( - context, rootPackage, hasSchemaRules, title, bodyContent); + final TemplateDataContext context = + new TemplateDataContext(docParameters, outputDir.relativize(htmlRootDirectory).toString()); + final HtmlResourceTemplateData templateData = + new HtmlResourceTemplateData(context, rootPackage, hasSchemaRules, title, bodyContent); final File outputFile = new File(outputDir.toString(), fileName); DocFreeMarkerUtil.processTemplate(TEMPLATE_SOURCE_NAME, templateData, outputFile); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceTemplateData.java index 8cbe0be3e..c2610f590 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/HtmlResourceTemplateData.java @@ -12,8 +12,8 @@ public HtmlResourceTemplateData(TemplateDataContext context, Package rootPackage { this.cssDirectory = context.getCssDirectory(); this.stylesheetName = StylesheetEmitter.STYLESHEET_FILE_NAME; - this.headerNavigation = new HeaderNavigationTemplateData(context, rootPackage, hasSchemaRules, - HeaderNavigationTemplateData.ActiveItem.NO_ITEM); + this.headerNavigation = new HeaderNavigationTemplateData( + context, rootPackage, hasSchemaRules, HeaderNavigationTemplateData.ActiveItem.NO_ITEM); this.title = title; this.bodyContent = bodyContent; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/HtmlRuntimeEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/HtmlRuntimeEmitter.java index f8d4b39ea..038379916 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/HtmlRuntimeEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/HtmlRuntimeEmitter.java @@ -23,12 +23,12 @@ */ final class HtmlRuntimeEmitter { - static void emit(OutputFileManager outputFileManager, - DocExtensionParameters docParameters) throws ZserioExtensionException + static void emit(OutputFileManager outputFileManager, DocExtensionParameters docParameters) + throws ZserioExtensionException { try { - final String[] jarRuntimeSubdirs = { DocDirectories.CSS_DIRECTORY, DocDirectories.JS_DIRECTORY }; + final String[] jarRuntimeSubdirs = {DocDirectories.CSS_DIRECTORY, DocDirectories.JS_DIRECTORY}; for (String jarRuntimeSubdir : jarRuntimeSubdirs) { final List jarResources = getJarRuntimeResources(jarRuntimeSubdir); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/PackageEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/PackageEmitter.java index fd1a18fa3..51042fb18 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/PackageEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/PackageEmitter.java @@ -34,25 +34,25 @@ final class PackageEmitter extends DefaultTreeWalker { public PackageEmitter(OutputFileManager outputFileManager, DocExtensionParameters docParameters, - DocResourceManager docResourceManager,SymbolCollector symbolCollector, + DocResourceManager docResourceManager, SymbolCollector symbolCollector, PackageCollector packageCollector, UsedByCollector usedByCollector, UsedByChoiceCollector usedByChoiceCollector, Package rootPackage, boolean hasSchemaRules) { this.outputFileManager = outputFileManager; final String outputDir = docParameters.getOutputDir(); - htmlPackagesDirectory = StringJoinUtil.joinStrings(outputDir, DocDirectories.PACKAGES_DIRECTORY, - File.separator); + htmlPackagesDirectory = + StringJoinUtil.joinStrings(outputDir, DocDirectories.PACKAGES_DIRECTORY, File.separator); docResourceManager.setCurrentOutputDir(htmlPackagesDirectory); nodesMap = symbolCollector.getNodesMap(); final String htmlRootDirectory = StringJoinUtil.joinStrings("..", "..", File.separator); - context = new PackageTemplateDataContext(docParameters, htmlRootDirectory, usedByCollector, - usedByChoiceCollector, docResourceManager); + context = new PackageTemplateDataContext( + docParameters, htmlRootDirectory, usedByCollector, usedByChoiceCollector, docResourceManager); - headerNavigation = new HeaderNavigationTemplateData(context, rootPackage, hasSchemaRules, - HeaderNavigationTemplateData.ActiveItem.PACKAGES_ITEM); + headerNavigation = new HeaderNavigationTemplateData( + context, rootPackage, hasSchemaRules, HeaderNavigationTemplateData.ActiveItem.PACKAGES_ITEM); } @Override @@ -69,8 +69,8 @@ public void beginPackage(Package pkg) throws ZserioExtensionException FileUtil.createOutputDirectory(outputFile); writer = FileUtil.createWriter(outputFile); - final BeginPackageTemplateData templateData = new BeginPackageTemplateData( - context, pkg, nodesMap, headerNavigation); + final BeginPackageTemplateData templateData = + new BeginPackageTemplateData(context, pkg, nodesMap, headerNavigation); DocFreeMarkerUtil.processTemplate("begin_package.html.ftl", templateData, writer); @@ -96,7 +96,7 @@ public void beginConst(Constant constant) throws ZserioExtensionException public void beginRuleGroup(RuleGroup ruleGroup) throws ZserioExtensionException { final RuleGroupTemplateData templateData = new RuleGroupTemplateData(context, ruleGroup); - DocFreeMarkerUtil.processTemplate("rule_group.html.ftl", templateData, writer); + DocFreeMarkerUtil.processTemplate("rule_group.html.ftl", templateData, writer); } @Override @@ -181,8 +181,8 @@ static String getPackageHtmlLink(Package pkg, String htmlPackagesDirectory) { final String packageFileName = PackageFileNameMapper.getFileName(pkg); - return StringJoinUtil.joinStrings(htmlPackagesDirectory, packageFileName + HTML_FILE_EXTENSION, - File.separator); + return StringJoinUtil.joinStrings( + htmlPackagesDirectory, packageFileName + HTML_FILE_EXTENSION, File.separator); } private static final String HTML_FILE_EXTENSION = ".html"; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/PackageFileNameMapper.java b/compiler/extensions/doc/src/zserio/extension/doc/PackageFileNameMapper.java index 708b2f5ab..8b98ba93a 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/PackageFileNameMapper.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/PackageFileNameMapper.java @@ -14,8 +14,8 @@ final class PackageFileNameMapper public static String getFileName(Package pkg) { final PackageName packageName = pkg.getPackageName(); - final String packageFileName = (packageName.isEmpty()) ? DEFAULT_PACKAGE_FILE_NAME : - packageName.toString(); + final String packageFileName = + (packageName.isEmpty()) ? DEFAULT_PACKAGE_FILE_NAME : packageName.toString(); return packageFileName; } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/PackageTemplateDataBase.java b/compiler/extensions/doc/src/zserio/extension/doc/PackageTemplateDataBase.java index b9b10f623..9bf0b701c 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/PackageTemplateDataBase.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/PackageTemplateDataBase.java @@ -21,9 +21,10 @@ public PackageTemplateDataBase(PackageTemplateDataContext context, DocumentableA final boolean svgCollaborationExists = SymbolCollaborationDotEmitter.svgSymbolCollaborationDiagramExists( astNode, usedByCollector, context.getWithSvgDiagrams()); - this.collaborationDiagramSvg = (svgCollaborationExists) ? - SymbolCollaborationDotEmitter.getSvgSymbolCollaborationHtmlLink(astNode, - context.getSymbolCollaborationDirectory()) : null; + this.collaborationDiagramSvg = (svgCollaborationExists) + ? SymbolCollaborationDotEmitter.getSvgSymbolCollaborationHtmlLink( + astNode, context.getSymbolCollaborationDirectory()) + : null; usedBySymbols = new TreeSet(); for (AstNode usedByNode : usedByCollector.getUsedBySymbols(astNode)) diff --git a/compiler/extensions/doc/src/zserio/extension/doc/PubsubTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/PubsubTemplateData.java index a8f247c3b..768b72d42 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/PubsubTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/PubsubTemplateData.java @@ -13,7 +13,8 @@ */ public final class PubsubTemplateData extends PackageTemplateDataBase { - public PubsubTemplateData(PackageTemplateDataContext context, PubsubType pubsubType) throws ZserioExtensionException + public PubsubTemplateData(PackageTemplateDataContext context, PubsubType pubsubType) + throws ZserioExtensionException { super(context, pubsubType); @@ -31,8 +32,10 @@ public static final class MessageTemplateData public MessageTemplateData(PackageTemplateDataContext context, PubsubType pubsubType, PubsubMessage pubsubMessage) throws ZserioExtensionException { - keyword = pubsubMessage.isPublished() && pubsubMessage.isSubscribed() ? - "pubsub" : pubsubMessage.isPublished() ? "publish" : "subscribe"; + keyword = pubsubMessage.isPublished() && pubsubMessage.isSubscribed() ? "pubsub" + : pubsubMessage.isPublished() + ? "publish" + : "subscribe"; symbol = SymbolTemplateDataCreator.createData(context, pubsubType, pubsubMessage); final ExpressionFormatter docExpressionFormatter = context.getExpressionFormatter(); topicDefinition = docExpressionFormatter.formatGetter(pubsubMessage.getTopicDefinitionExpr()); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewEmitter.java index bc712c74e..ce2211f5d 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewEmitter.java @@ -28,13 +28,12 @@ public RulesOverviewEmitter(OutputFileManager outputFileManager, DocExtensionPar this.outputFileManager = outputFileManager; final String outputDir = docParameters.getOutputDir(); - htmlContentDirectory = StringJoinUtil.joinStrings(outputDir, DocDirectories.CONTENT_DIRECTORY, - File.separator); + htmlContentDirectory = + StringJoinUtil.joinStrings(outputDir, DocDirectories.CONTENT_DIRECTORY, File.separator); docResourceManager.setCurrentOutputDir(htmlContentDirectory); final String htmlRootDirectory = ".."; - context = new ContentTemplateDataContext( - docParameters, htmlRootDirectory, docResourceManager); + context = new ContentTemplateDataContext(docParameters, htmlRootDirectory, docResourceManager); } @Override @@ -47,8 +46,8 @@ public boolean traverseTemplateInstantiations() public void endRoot(Root root) throws ZserioExtensionException { final File outputFile = new File(getRulesOverviewHtmlLink(htmlContentDirectory)); - final RulesOverviewTemplateData templateData = new RulesOverviewTemplateData( - context, root.getRootPackage(), packagesRuleGroups); + final RulesOverviewTemplateData templateData = + new RulesOverviewTemplateData(context, root.getRootPackage(), packagesRuleGroups); DocFreeMarkerUtil.processTemplate(RULES_OVERVIEW_TEMPLATE_SOURCE_NAME, templateData, outputFile); outputFileManager.registerOutputFile(outputFile); } @@ -58,7 +57,7 @@ public void endPackage(Package pkg) throws ZserioExtensionException { if (!currentPackageRuleGroups.isEmpty()) { - packagesRuleGroups.add(new PackageRulesTemplateData(context, pkg, currentPackageRuleGroups)); + packagesRuleGroups.add(new PackageRulesTemplateData(context, pkg, currentPackageRuleGroups)); currentPackageRuleGroups.clear(); } } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewTemplateData.java index 6887db628..d6927cabc 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/RulesOverviewTemplateData.java @@ -21,8 +21,8 @@ public RulesOverviewTemplateData(ContentTemplateDataContext context, Package roo jsDirectory = context.getJsDirectory(); stylesheetName = StylesheetEmitter.STYLESHEET_FILE_NAME; final boolean hasSchemaRules = true; // this is the rules view! - headerNavigation = new HeaderNavigationTemplateData(context, rootPackage, hasSchemaRules, - HeaderNavigationTemplateData.ActiveItem.RULES_ITEM); + headerNavigation = new HeaderNavigationTemplateData( + context, rootPackage, hasSchemaRules, HeaderNavigationTemplateData.ActiveItem.RULES_ITEM); this.packagesRuleGroups = packagesRuleGroups; } @@ -92,8 +92,8 @@ public Iterable getRuleGroups() return ruleGroups; } - private static class RuleGroupTemplateDataComparator implements - Comparator, Serializable + private static class RuleGroupTemplateDataComparator + implements Comparator, Serializable { private static final long serialVersionUID = 1L; @@ -106,8 +106,8 @@ public int compare(RuleGroupTemplateData lhs, RuleGroupTemplateData rhs) private final SymbolTemplateData packageSymbol; // we want to have sorted rule groups in the overview - private final Set ruleGroups = new TreeSet( - new RuleGroupTemplateDataComparator()); + private final Set ruleGroups = + new TreeSet(new RuleGroupTemplateDataComparator()); } private final String cssDirectory; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/ServiceTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/ServiceTemplateData.java index 16288a080..21cded093 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/ServiceTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/ServiceTemplateData.java @@ -12,7 +12,8 @@ */ public final class ServiceTemplateData extends PackageTemplateDataBase { - public ServiceTemplateData(PackageTemplateDataContext context, ServiceType serviceType) throws ZserioExtensionException + public ServiceTemplateData(PackageTemplateDataContext context, ServiceType serviceType) + throws ZserioExtensionException { super(context, serviceType); @@ -31,10 +32,10 @@ public MethodTemplateData(PackageTemplateDataContext context, ServiceType servic ServiceMethod serviceMethod) throws ZserioExtensionException { symbol = SymbolTemplateDataCreator.createData(context, serviceType, serviceMethod); - requestSymbol = SymbolTemplateDataCreator.createData(context, - serviceMethod.getRequestTypeReference()); - responseSymbol = SymbolTemplateDataCreator.createData(context, - serviceMethod.getResponseTypeReference()); + requestSymbol = + SymbolTemplateDataCreator.createData(context, serviceMethod.getRequestTypeReference()); + responseSymbol = + SymbolTemplateDataCreator.createData(context, serviceMethod.getResponseTypeReference()); docComments = new DocCommentsTemplateData(context, serviceMethod.getDocComments()); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/SqlTableTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/SqlTableTemplateData.java index 51c406c8b..719a42367 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/SqlTableTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/SqlTableTemplateData.java @@ -16,10 +16,11 @@ public SqlTableTemplateData(PackageTemplateDataContext context, SqlTableType sql super(context, sqlTableType); final SqlConstraint sqlConstraintType = sqlTableType.getSqlConstraint(); - final Expression sqlConstraintExpr = (sqlConstraintType == null) ? null : - sqlConstraintType.getConstraintExpr(); - sqlConstraint = (sqlConstraintExpr == null) ? "" : - context.getExpressionFormatter().formatGetter(sqlConstraintExpr); + final Expression sqlConstraintExpr = + (sqlConstraintType == null) ? null : sqlConstraintType.getConstraintExpr(); + sqlConstraint = (sqlConstraintExpr == null) + ? "" + : context.getExpressionFormatter().formatGetter(sqlConstraintExpr); virtualTableUsing = sqlTableType.getVirtualTableUsingString(); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/StylesheetEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/StylesheetEmitter.java index d94f71dd0..477959b35 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/StylesheetEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/StylesheetEmitter.java @@ -12,8 +12,8 @@ */ final class StylesheetEmitter { - static void emit(OutputFileManager outputFileManager, - DocExtensionParameters docParameters) throws ZserioExtensionException + static void emit(OutputFileManager outputFileManager, DocExtensionParameters docParameters) + throws ZserioExtensionException { final File outputDirectory = new File(docParameters.getOutputDir(), DocDirectories.CSS_DIRECTORY); final File outputFile = new File(outputDirectory, STYLESHEET_FILE_NAME); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/SubtypeTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/SubtypeTemplateData.java index d8e3f3a58..7ad83a9f3 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/SubtypeTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/SubtypeTemplateData.java @@ -8,7 +8,8 @@ */ public final class SubtypeTemplateData extends PackageTemplateDataBase { - public SubtypeTemplateData(PackageTemplateDataContext context, Subtype subtype) throws ZserioExtensionException + public SubtypeTemplateData(PackageTemplateDataContext context, Subtype subtype) + throws ZserioExtensionException { super(context, subtype); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/SymbolCollaborationDotEmitter.java b/compiler/extensions/doc/src/zserio/extension/doc/SymbolCollaborationDotEmitter.java index 4b2152d2e..d03b36b35 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/SymbolCollaborationDotEmitter.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/SymbolCollaborationDotEmitter.java @@ -1,6 +1,5 @@ package zserio.extension.doc; - import java.io.File; import java.util.Set; @@ -27,8 +26,8 @@ public static void emit(OutputFileManager outputFileManager, DocExtensionParamet emitDotDiagram(outputFileManager, docParameters, usedByCollector, context, node); } - public static boolean svgSymbolCollaborationDiagramExists(AstNode node, UsedByCollector usedByCollector, - boolean withSvgDiagrams) + public static boolean svgSymbolCollaborationDiagramExists( + AstNode node, UsedByCollector usedByCollector, boolean withSvgDiagrams) { return withSvgDiagrams && usedByCollector.getCollaboratingNodes().contains(node); } @@ -50,18 +49,18 @@ private static String getSymbolCollaborationHtmlLinkBase(AstNode node, String sy final String name = AstNodeNameMapper.getName(node); final String packageFileName = PackageFileNameMapper.getFileName(pkg); - return StringJoinUtil.joinStrings(symbolCollaborationDirectory, packageFileName, - typeName + "_" + name, File.separator); + return StringJoinUtil.joinStrings( + symbolCollaborationDirectory, packageFileName, typeName + "_" + name, File.separator); } private static void emitDotDiagram(OutputFileManager outputFileManager, DocExtensionParameters docParameters, UsedByCollector usedByCollector, TemplateDataContext context, AstNode node) throws ZserioExtensionException { - final SymbolCollaborationDotTemplateData templateData = new SymbolCollaborationDotTemplateData(context, - node, usedByCollector.getUsedSymbols(node), usedByCollector.getUsedBySymbols(node)); - final String dotHtmlLink = getDotSymbolCollaborationHtmlLink(node, - DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); + final SymbolCollaborationDotTemplateData templateData = new SymbolCollaborationDotTemplateData( + context, node, usedByCollector.getUsedSymbols(node), usedByCollector.getUsedBySymbols(node)); + final String dotHtmlLink = + getDotSymbolCollaborationHtmlLink(node, DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); final String outputDir = docParameters.getOutputDir(); final File outputDotFile = new File(outputDir, dotHtmlLink); @@ -70,8 +69,8 @@ private static void emitDotDiagram(OutputFileManager outputFileManager, if (docParameters.getWithSvgDiagrams()) { - final String svgHtmlLink = getSvgSymbolCollaborationHtmlLink(node, - DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); + final String svgHtmlLink = + getSvgSymbolCollaborationHtmlLink(node, DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); final File outputSvgFile = new File(outputDir, svgHtmlLink); DotToSvgConverter.convert(docParameters.getDotExecutable(), outputDotFile, outputSvgFile); outputFileManager.registerOutputFile(outputSvgFile); diff --git a/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateData.java b/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateData.java index ec496293d..cc739c30f 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateData.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateData.java @@ -10,8 +10,8 @@ */ public final class SymbolTemplateData implements Comparable { - public SymbolTemplateData(String name, String typeName, String htmlTitle, String htmlLinkPage, - String htmlLinkAnchor) + public SymbolTemplateData( + String name, String typeName, String htmlTitle, String htmlLinkPage, String htmlLinkAnchor) { this(name, typeName, htmlTitle, new HtmlLink(htmlLinkPage, htmlLinkAnchor), new ArrayList()); @@ -28,8 +28,8 @@ public SymbolTemplateData(String name, String typeName, String htmlTitle) this(name, typeName, htmlTitle, null, new ArrayList()); } - public SymbolTemplateData(String name, String typeName, String htmlTitle, - List templateArguments) + public SymbolTemplateData( + String name, String typeName, String htmlTitle, List templateArguments) { this(name, typeName, htmlTitle, null, templateArguments); } @@ -61,7 +61,7 @@ public int compareTo(SymbolTemplateData other) @Override public boolean equals(Object other) { - if ( !(other instanceof SymbolTemplateData) ) + if (!(other instanceof SymbolTemplateData)) return false; return (this == other) || compareTo((SymbolTemplateData)other) == 0; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateDataCreator.java b/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateDataCreator.java index a114e51d8..85730cdca 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateDataCreator.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/SymbolTemplateDataCreator.java @@ -51,25 +51,25 @@ public static SymbolTemplateData createData(TemplateDataContext context, AstNode final String htmlLinkPage = createHtmlLinkPage(context, pkg); final String htmlLinkAnchor = createHtmlAnchor(typeName, name); - return new SymbolTemplateData(alias, typeName, htmlTitle, htmlLinkPage, htmlLinkAnchor, - templateArguments); + return new SymbolTemplateData( + alias, typeName, htmlTitle, htmlLinkPage, htmlLinkAnchor, templateArguments); } } - public static SymbolTemplateData createData(TemplateDataContext context, ZserioType zserioType, - AstNode member) + public static SymbolTemplateData createData( + TemplateDataContext context, ZserioType zserioType, AstNode member) { return createData(context, zserioType, member, AstNodeNameMapper.getName(member)); } - public static SymbolTemplateData createData(TemplateDataContext context, ZserioType zserioType, - AstNode member, String memberName) + public static SymbolTemplateData createData( + TemplateDataContext context, ZserioType zserioType, AstNode member, String memberName) { return createData(context, zserioType, member, memberName, memberName); } - public static SymbolTemplateData createData(TemplateDataContext context, ZserioType zserioType, - AstNode member, String memberName, String alias) + public static SymbolTemplateData createData( + TemplateDataContext context, ZserioType zserioType, AstNode member, String memberName, String alias) { final String memberTypeName = AstNodeTypeNameMapper.getTypeName(member); @@ -143,8 +143,9 @@ public static SymbolTemplateData createData(TemplateDataContext context, Express } final String typeName = AstNodeTypeNameMapper.getTypeName(expression); - final String htmlTitle = (expressionZserioType == null) ? typeName : - typeName + " of type " + AstNodeNameMapper.getName(expressionZserioType); + final String htmlTitle = (expressionZserioType == null) + ? typeName + : typeName + " of type " + AstNodeNameMapper.getName(expressionZserioType); return new SymbolTemplateData(name, typeName, htmlTitle); } diff --git a/compiler/extensions/doc/src/zserio/extension/doc/TemplateDataContext.java b/compiler/extensions/doc/src/zserio/extension/doc/TemplateDataContext.java index b5ff9999e..21668a134 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/TemplateDataContext.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/TemplateDataContext.java @@ -22,8 +22,8 @@ public TemplateDataContext(DocExtensionParameters docParameters, String htmlRoot cssDirectory = getHtmlDirectory(htmlRootDirectory, DocDirectories.CSS_DIRECTORY); jsDirectory = getHtmlDirectory(htmlRootDirectory, DocDirectories.JS_DIRECTORY); resourcesDirectory = getHtmlDirectory(htmlRootDirectory, DocDirectories.RESOURCES_DIRECTORY); - symbolCollaborationDirectory = getHtmlDirectory(htmlRootDirectory, - DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); + symbolCollaborationDirectory = + getHtmlDirectory(htmlRootDirectory, DocDirectories.SYMBOL_COLLABORATION_DIRECTORY); } public boolean getWithSvgDiagrams() diff --git a/compiler/extensions/doc/src/zserio/extension/doc/UsedByChoiceCollector.java b/compiler/extensions/doc/src/zserio/extension/doc/UsedByChoiceCollector.java index a19dc2c23..f1656e3f9 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/UsedByChoiceCollector.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/UsedByChoiceCollector.java @@ -41,11 +41,11 @@ public void beginChoice(ChoiceType choiceType) { final Object symbolObject = choiceCaseExpression.getExpression().getExprSymbolObject(); if (symbolObject instanceof EnumItem) - addEnumItemToUsedByChoiceMap((EnumItem)symbolObject, choiceType, choiceCase, - choiceCaseExpression); + addEnumItemToUsedByChoiceMap( + (EnumItem)symbolObject, choiceType, choiceCase, choiceCaseExpression); else if (symbolObject instanceof BitmaskValue) - addBitmaskValueToUsedByChoiceMap((BitmaskValue)symbolObject, choiceType, choiceCase, - choiceCaseExpression); + addBitmaskValueToUsedByChoiceMap( + (BitmaskValue)symbolObject, choiceType, choiceCase, choiceCaseExpression); } } } @@ -66,8 +66,8 @@ public Set getUsedByChoices(BitmaskValue bitmaskValue) public static final class ChoiceCaseReference implements Comparable { - public ChoiceCaseReference(ChoiceType choiceType, ChoiceCase choiceCase, - ChoiceCaseExpression choiceCaseExpression) + public ChoiceCaseReference( + ChoiceType choiceType, ChoiceCase choiceCase, ChoiceCaseExpression choiceCaseExpression) { this.choiceType = choiceType; this.choiceCase = choiceCase; @@ -83,7 +83,7 @@ public int compareTo(ChoiceCaseReference other) @Override public boolean equals(Object other) { - if ( !(other instanceof ChoiceCaseReference) ) + if (!(other instanceof ChoiceCaseReference)) return false; return (this == other) || compareTo((ChoiceCaseReference)other) == 0; diff --git a/compiler/extensions/doc/src/zserio/extension/doc/UsedByCollector.java b/compiler/extensions/doc/src/zserio/extension/doc/UsedByCollector.java index 52de1981f..fc2bc9b79 100644 --- a/compiler/extensions/doc/src/zserio/extension/doc/UsedByCollector.java +++ b/compiler/extensions/doc/src/zserio/extension/doc/UsedByCollector.java @@ -146,7 +146,7 @@ public void beginBitmask(BitmaskType bitmaskType) { final Set usedSymbols = new LinkedHashSet(); addSymbol(bitmaskType.getTypeInstantiation().getTypeReference(), usedSymbols); - for (BitmaskValue value: bitmaskType.getValues()) + for (BitmaskValue value : bitmaskType.getValues()) { if (value.getValueExpression() != null) addSymbolsUsedInExpression(value.getValueExpression(), usedSymbols);