Skip to content

Commit

Permalink
Add clang-format to the Doc extension project
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikir
mikir committed Jan 5, 2024
1 parent 20a351b commit 20a2538
Show file tree
Hide file tree
Showing 39 changed files with 258 additions and 229 deletions.
18 changes: 17 additions & 1 deletion compiler/extensions/doc/build.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
-->
Expand Down Expand Up @@ -184,7 +185,22 @@ spotbugs.home_dir - Location of the spotbugs tool. If not set, spotb
</copy>
</target>

<target name="spotbugs" depends="install" if="spotbugs.home_dir">
<target name="clang_format" depends="install" if="clang_format.exe_file">
<echo>
Command hints to reformat source using clang-format tool:
git clang-format
clang-format --style=file -i [SOURCE]
</echo>
<apply executable="${clang_format.exe_file}" failonerror="true">
<arg value="--style=file"/>
<arg value="--dry-run"/>
<arg value="--Werror"/>
<srcfile/>
<fileset dir="${zserio_doc.src_dir}" includes="**/*.java"/>
</apply>
</target>

<target name="spotbugs" depends="clang_format" if="spotbugs.home_dir">
<mkdir dir="${zserio_doc.spotbugs.out_dir}"/>
<taskdef classpath="${spotbugs.home_dir}/lib/spotbugs-ant.jar"
resource="edu/umd/cs/findbugs/anttask/tasks.properties"/>
Expand Down
10 changes: 6 additions & 4 deletions compiler/extensions/doc/src/zserio/extension/doc/AstNodeNameMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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";
}
Expand Down Expand Up @@ -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
{
Expand Down
6 changes: 4 additions & 2 deletions compiler/extensions/doc/src/zserio/extension/doc/AstNodePackageMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
10 changes: 6 additions & 4 deletions compiler/extensions/doc/src/zserio/extension/doc/AstNodeTypeNameMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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";
}
Expand Down Expand Up @@ -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
{
Expand Down
28 changes: 15 additions & 13 deletions compiler/extensions/doc/src/zserio/extension/doc/BeginPackageTemplateData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public final class BeginPackageTemplateData
{
public BeginPackageTemplateData(PackageTemplateDataContext context, Package pkg,
Map<Package, List<AstNode>> nodesMap, HeaderNavigationTemplateData headerNavigation)
throws ZserioExtensionException
throws ZserioExtensionException
{
cssDirectory = context.getCssDirectory();
isDefaultPackage = pkg.getPackageName().isEmpty();
Expand All @@ -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));
Expand Down Expand Up @@ -92,11 +93,11 @@ public Iterable<SymbolTemplateData> getTocSymbols()
return tocSymbols;
}

public static final class PackageSymbolOverviewTemplateData implements
Comparable<PackageSymbolOverviewTemplateData>
public static final class PackageSymbolOverviewTemplateData
implements Comparable<PackageSymbolOverviewTemplateData>
{
public PackageSymbolOverviewTemplateData(PackageTemplateDataContext context, Package pkg,
List<AstNode> packageSymbols)
public PackageSymbolOverviewTemplateData(
PackageTemplateDataContext context, Package pkg, List<AstNode> packageSymbols)
{
symbol = SymbolTemplateDataCreator.createData(context, pkg);
for (AstNode packageSymbol : packageSymbols)
Expand Down Expand Up @@ -141,8 +142,8 @@ public Iterable<SymbolTemplateData> 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());
Expand All @@ -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()
Expand Down
15 changes: 8 additions & 7 deletions compiler/extensions/doc/src/zserio/extension/doc/BitmaskTemplateData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<SeeSymbolTemplateData>();
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));
}
}
Expand Down
39 changes: 22 additions & 17 deletions compiler/extensions/doc/src/zserio/extension/doc/ChoiceTemplateData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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<CaseMemberTemplateData> getCaseMemberList()
Expand All @@ -55,17 +57,18 @@ 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<CaseTemplateData>();
final Iterable<ChoiceCaseExpression> caseExpressions = choiceCase.getExpressions();
for (ChoiceCaseExpression caseExpression : caseExpressions)
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<CaseTemplateData> getCaseList()
Expand All @@ -86,7 +89,7 @@ public static final class CaseTemplateData
{
public CaseTemplateData(PackageTemplateDataContext context, ChoiceType choiceType,
ChoiceCase choiceCase, Expression caseExpression, List<DocComment> docComments)
throws ZserioExtensionException
throws ZserioExtensionException
{
final ExpressionFormatter docExpressionFormatter = context.getExpressionFormatter();
final String expression = docExpressionFormatter.formatGetter(caseExpression);
Expand All @@ -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
Expand Down Expand Up @@ -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());
}
Expand Down
14 changes: 8 additions & 6 deletions compiler/extensions/doc/src/zserio/extension/doc/CompoundTypeTemplateData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -62,7 +62,8 @@ public Iterable<FunctionTemplateData> getFunctions()

public static final class TemplateParameterTemplateData
{
public TemplateParameterTemplateData(PackageTemplateDataContext context, TemplateParameter templateParameter)
public TemplateParameterTemplateData(
PackageTemplateDataContext context, TemplateParameter templateParameter)
{
name = templateParameter.getName();
}
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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());
Expand Down
3 changes: 2 additions & 1 deletion compiler/extensions/doc/src/zserio/extension/doc/ConstantTemplateData.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion compiler/extensions/doc/src/zserio/extension/doc/DocClassicToHtmlConverter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ private static String findHtmlTag(String text, int startIndex)
"</ul>",
"</var>",
"</video>",
"</wbr>"
"</wbr>",
};

private static final Set<String> startHtmlTagList = new HashSet<String>(Arrays.asList(startHtmlTags));
Expand Down
Loading

0 comments on commit 20a2538

Please sign in to comment.