Merge pull request #3 from zbynek/code-style

Improve code style of generated stream classes
javacc · Sep 17, 2023 · aed1a05 · aed1a05
2 parents 0942ada + 1677363
commit aed1a05
Show file tree

Hide file tree

Showing 25 changed files with 1,598 additions and 1,487 deletions.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -23,3 +23,5 @@ jobs:
         distribution: 'adopt'
     - name: Build with Maven
       run: mvn -B package --file pom.xml
+    - name: Run integration tests
+      run: mvn install
diff --git a/examples/Gwt/checkstyle-suppress.xml b/examples/Gwt/checkstyle-suppress.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+    <suppress checks="MultipleVariableDeclarations" files="." />
+    <suppress checks="AbbreviationAsWordInName" files="." />
+    <suppress checks="MemberName" files="." />
+    <suppress checks="MethodName" files="." />
+
+    <suppress checks="Indentation" files=".*Gwt.*TokenManager.java"/>
+    <suppress checks="Indentation" files=".*Gwt.*Parser.java"/>
+</suppressions>
diff --git a/examples/Gwt/pom.xml b/examples/Gwt/pom.xml
@@ -89,6 +89,31 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>3.3.0</version>
+				<configuration>
+					<configLocation>google_checks.xml</configLocation>
+					<violationSeverity>warning</violationSeverity>
+					<sourceDirectories>target/generated-sources/java</sourceDirectories>
+					<suppressionsLocation>checkstyle-suppress.xml</suppressionsLocation>
+					<suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
+					<encoding>UTF-8</encoding>
+					<consoleOutput>true</consoleOutput>
+					<failsOnError>true</failsOnError>
+					<linkXRef>false</linkXRef>
+				</configuration>
+				<executions>
+					<execution>
+						<id>validate</id>
+						<phase>generate-sources</phase>
+						<goals>
+							<goal>check</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 	<name>JavaCC examples Java Simple</name>

diff --git a/examples/Gwt/src/main/javacc/GwtSimpleParser.jj b/examples/Gwt/src/main/javacc/GwtSimpleParser.jj
@@ -57,7 +57,7 @@ import java.io.PrintStream;
 public class GwtSimpleParser {
 
   /** Main entry point. */
-  public static void main(String args[]) throws ParseException, IOException {
+  public static void main(String[] args) throws ParseException, IOException {
     PrintStream output = System.out;
     PrintStream error = System.err;
     PrintStream prevOutput = null;
@@ -76,8 +76,12 @@ public class GwtSimpleParser {
     } catch (Exception e) {
       error.println(e.getMessage());
     } finally {
-      if (prevOutput != null) System.setOut(prevOutput);
-      if (prevError != null)  System.setErr(prevError);
+      if (prevOutput != null) {
+        System.setOut(prevOutput);
+      }
+      if (prevError != null) {
+        System.setErr(prevError);
+      }
     }
   }
 

diff --git a/examples/Gwt/src/main/javacc/GwtUnicodeParser.jj b/examples/Gwt/src/main/javacc/GwtUnicodeParser.jj
@@ -57,7 +57,7 @@ import java.io.PrintStream;
 public class GwtUnicodeParser {
 
   /** Main entry point. */
-  public static void main(String args[]) throws ParseException, IOException {
+  public static void main(String[] args) throws ParseException, IOException {
     PrintStream output = System.out;
     PrintStream error = System.err;
     PrintStream prevOutput = null;
@@ -76,8 +76,12 @@ public class GwtUnicodeParser {
     } catch (Exception e) {
       error.println(e.getMessage());
     } finally {
-      if (prevOutput != null) System.setOut(prevOutput);
-      if (prevError != null)  System.setErr(prevError);
+      if (prevOutput != null) {
+        System.setOut(prevOutput);
+      }
+      if (prevError != null) {
+        System.setErr(prevError);
+      }
     }
   }
 

diff --git a/examples/JavaCC/checkstyle-suppress.xml b/examples/JavaCC/checkstyle-suppress.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+    <suppress checks="MultipleVariableDeclarations" files="." />
+    <suppress checks="AbbreviationAsWordInName" files="." />
+    <suppress checks="MemberName" files="." />
+    <suppress checks="MethodName" files="." />
+
+    <suppress checks="Indentation|LineLength" files=".*JavaCC.*TokenManager.java"/>
+    <suppress checks="Indentation|MissingJavadocMethod|LineLength" files=".*JavaCC.*Parser.java"/>
+</suppressions>
diff --git a/examples/JavaCC/pom.xml b/examples/JavaCC/pom.xml
@@ -28,6 +28,31 @@
 					</arguments>
 				</configuration>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>3.3.0</version>
+				<configuration>
+					<configLocation>google_checks.xml</configLocation>
+					<violationSeverity>warning</violationSeverity>
+					<sourceDirectories>target/generated-sources/java</sourceDirectories>
+					<suppressionsLocation>checkstyle-suppress.xml</suppressionsLocation>
+					<suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
+					<encoding>UTF-8</encoding>
+					<consoleOutput>true</consoleOutput>
+					<failsOnError>true</failsOnError>
+					<linkXRef>false</linkXRef>
+				</configuration>
+				<executions>
+					<execution>
+						<id>validate</id>
+						<phase>generate-sources</phase>
+						<goals>
+							<goal>check</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 </project>
diff --git a/examples/JavaCC/src/main/javacc/JavaCC.jj b/examples/JavaCC/src/main/javacc/JavaCC.jj
@@ -33,9 +33,12 @@ options {
 
 PARSER_BEGIN(JavaCCParser)
 
+/**
+ * Parser for JavaCC grammar.
+ */
 public class JavaCCParser {
 
-  public static void main(String args[]) {
+  public static void main(String[] args) {
     JavaCCParser parser;
     if (args.length == 0) {
       System.out.println("JavaCC Parser:  Reading from standard input . . .");
@@ -69,21 +72,21 @@ public class JavaCCParser {
    * Returns true if the next token is not in the FOLLOW list of "expansion".
    * It is used to decide when the end of an "expansion" has been reached.
    */
-  static private boolean notTailOfExpansionUnit() {
+  private static boolean notTailOfExpansionUnit() {
     Token t;
     t = getToken(1);
-    if (t.kind == BIT_OR || t.kind == COMMA || t.kind == RPAREN || t.kind == RBRACE || t.kind == RBRACKET) return false;
-    return true;
+    return  !(t.kind == BIT_OR || t.kind == COMMA || t.kind == RPAREN
+        || t.kind == RBRACE || t.kind == RBRACKET);
   }
 
 }
 
 PARSER_END(JavaCCParser)
 
 
-/**********************************************
- * THE JAVACC TOKEN SPECIFICATION STARTS HERE *
- **********************************************/
+/*--------------------------------------------
+ * THE JAVACC TOKEN SPECIFICATION STARTS HERE
+ *-------------------------------------------*/
 
 /* JAVACC RESERVED WORDS: These are the only tokens in JavaCC but not in Java */
 
@@ -350,9 +353,9 @@ TOKEN :
 | < BIT_OR: "|" >
 | < XOR: "^" >
 | < REM: "%" >
-//	| < LSHIFT: "<<" >
-//	| < RSIGNEDSHIFT: ">>" >
-//	| < RUNSIGNEDSHIFT: ">>>" >
+//  | < LSHIFT: "<<" >
+//  | < RSIGNEDSHIFT: ">>" >
+//  | < RUNSIGNEDSHIFT: ">>>" >
 | < PLUSASSIGN: "+=" >
 | < MINUSASSIGN: "-=" >
 | < STARASSIGN: "*=" >
@@ -361,15 +364,15 @@ TOKEN :
 | < ORASSIGN: "|=" >
 | < XORASSIGN: "^=" >
 | < REMASSIGN: "%=" >
-//	| < LSHIFTASSIGN: "<<=" >
-//	| < RSIGNEDSHIFTASSIGN: ">>=" >
-//	| < RUNSIGNEDSHIFTASSIGN: ">>>=" >
+//  | < LSHIFTASSIGN: "<<=" >
+//  | < RSIGNEDSHIFTASSIGN: ">>=" >
+//  | < RUNSIGNEDSHIFTASSIGN: ">>>=" >
 }
 
 
-/************************************************
- * THE JAVACC GRAMMAR SPECIFICATION STARTS HERE *
- ************************************************/
+/*-----------------------------------------------
+ * THE JAVACC GRAMMAR SPECIFICATION STARTS HERE
+ *----------------------------------------------*/
 
 void javacc_input() :
 {}
@@ -503,9 +506,9 @@ void expansion() :
 }
 
 void local_lookahead() :
-	{
-	  boolean commaAtEnd = false, emptyLA = true;
-	}
+  {
+    boolean commaAtEnd = false, emptyLA = true;
+  }
 {
   [
     /*
@@ -516,27 +519,28 @@ void local_lookahead() :
      */
     LOOKAHEAD(1)
     IntegerLiteral()
-	{
-	  emptyLA = false;
-	}
+  {
+    emptyLA = false;
+  }
   ]
   [ LOOKAHEAD(0, { !emptyLA && (getToken(1).kind != RPAREN) } )
     ","
-	{
-	  commaAtEnd = true;
-	}
+  {
+    commaAtEnd = true;
+  }
   ]
   [ LOOKAHEAD(0, { getToken(1).kind != RPAREN && getToken(1).kind != LBRACE } )
     expansion_choices()
-	{
-	  emptyLA = false; commaAtEnd = false;
-	}
+  {
+    emptyLA = false;
+    commaAtEnd = false;
+  }
   ]
   [ LOOKAHEAD(0, { !emptyLA && !commaAtEnd && (getToken(1).kind != RPAREN) } )
     ","
-	{
-	  commaAtEnd = true;
-	}
+  {
+    commaAtEnd = true;
+  }
   ]
   [ LOOKAHEAD(0, { emptyLA || commaAtEnd } )
     "{" Expression() "}"
@@ -628,9 +632,9 @@ void identifier() :
 }
 
 
-/**********************************************
- * THE JJTREE PRODUCTIONS START HERE          *
- **********************************************/
+/*-----------------------------------
+ * THE JJTREE PRODUCTIONS START HERE
+ *-----------------------------------*/
 
 void node_descriptor() :
 {}
@@ -653,19 +657,22 @@ void node_descriptor_expression()
     if (tok.kind == 0) {
       throw new ParseException();
     }
-    if (tok.kind == LPAREN) nesting++;
-    if (tok.kind == RPAREN) {
+    if (tok.kind == LPAREN) {
+      nesting++;
+    } else if (tok.kind == RPAREN) {
       nesting--;
-      if (nesting == 0) break;
+      if (nesting == 0) {
+        break;
+      }
     }
     tok = getNextToken();
   }
 }
 
 
-/**********************************************
- * THE JAVA GRAMMAR SPECIFICATION STARTS HERE *
- **********************************************/
+/*--------------------------------------------
+ * THE JAVA GRAMMAR SPECIFICATION STARTS HERE
+ *--------------------------------------------*/
 
 /*
  * The Java grammar is modified to use sequences of tokens

diff --git a/java.iml b/java.iml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="AdditionalModuleElements">
+    <content url="file://$MODULE_DIR$" dumb="true">
+      <sourceFolder url="file://$MODULE_DIR$/bugs/bug001/target/generated-sources/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/bugs/bug002/target/generated-sources/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/Gwt/target/generated-sources/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/JavaCC/target/generated-sources/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/Lookahead/target/generated-sources/java" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/Transformer/target/generated-sources/java" isTestSource="false" />
+    </content>
+  </component>
+</module>
diff --git a/pom.xml b/pom.xml
@@ -64,6 +64,7 @@
 						<plugin>
 							<groupId>org.apache.maven.plugins</groupId>
 							<artifactId>maven-invoker-plugin</artifactId>
+							<version>3.6.0</version>
 						</plugin>
 					</plugins>
 				</pluginManagement>

diff --git a/src/main/java/org/javacc/java/JavaCodeBuilder.java b/src/main/java/org/javacc/java/JavaCodeBuilder.java
@@ -59,7 +59,7 @@ JavaCodeBuilder addImportName(String importName) {
 
   @Override
   protected final void build() {
-    StringBuffer buffer = new StringBuffer();
+    StringBuffer buffer = new StringBuffer("\n");
 
     if (packageName.length() > 0) {
       buffer.append("package ").append(packageName).append(";\n\n");