add CI building .jar; parser quick'n'dirty compat with 3.8.4

.github/workflows/maven-build-jar.yml

@@ -0,0 +1,41 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Java CI with Maven
+
+on:
+  - push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up JDK
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: maven
+
+    - name: Build with Maven
+      run: mvn -B package
+
+    - name: Upload built jar as CI artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: jar
+        path: target/*.jar
+
+    - name: From tags, create GH release and attach built jar
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        files: target/*.jar

README.md

@@ -0,0 +1,9 @@
+# stellaris tech tree parser
+[![Java CI with Maven](https://github.com/azrdev/stellaris-technology-parser/actions/workflows/maven-build-jar.yml/badge.svg)](https://github.com/azrdev/stellaris-technology-parser/actions/workflows/maven-build-jar.yml)
+
+Usage:
+1. install a JDK and maven
+2. build the project using `mvn package` resulting in `target/stellaris-1.0.0-SNAPSHOT.jar`, or use the .jar built by GitHub Actions
+3. open a shell, change to a directory in which `files/` contains your Stellaris installation (e.g. `ln -Ts files ~/.steam/steam/steamapps/common/Stellaris`)
+4. Run `java -jar /path/to/your/target/stellaris-1.0.0-SNAPSHOT.jar`
+5. Collect the generated `*.json` files and `index.html` and publish to a webserver, e.g. add to https://github.com/turanar/stellaris-tech-tree/

pom.xml

@@ -46,6 +46,26 @@
 
     <build>
         <plugins>
+            <plugin>
+              <groupId>org.antlr</groupId>
+              <artifactId>antlr4-maven-plugin</artifactId>
+              <version>4.7.1</version>
+              <executions>
+                <execution>
+                  <goals>
+                    <goal>antlr4</goal>
+                  </goals>
+                  <configuration>
+                      <visitor>true</visitor>
+                      <arguments>
+                          <argument>-package</argument>
+                          <argument>net.turanar.stellaris.antlr</argument>
+                      </arguments>
+                  </configuration>
+                </execution>
+              </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
@@ -55,6 +75,27 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
-        </plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <version>2.1.4.RELEASE</version>
+                <configuration>
+                    <mainClass>${start-class}</mainClass>
+                </configuration>
+            </plugin>
+
+    </plugins>
+
     </build>
-</project>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.4.0</version>
+        <relativePath/>
+    </parent>
+
+    <properties>
+        <start-class>net.turanar.stellaris.App</start-class>
+    </properties>
+</project>

Stellaris.g4 → src/main/antlr4/Stellaris.g4

@@ -5,11 +5,12 @@ file
    ;
 
 map
-   : '{' (pair)* '}'
+   : '{' (pair | 'optimize_memory' )* '}'
    ;
 
 pair
    : BAREWORD SPECIFIER value
+   | NUMBER SPECIFIER value
    ;
 
 var
@@ -20,13 +21,18 @@ array
    : '{' value+ '}'
    ;
 
+valueSpec
+   : BAREWORD ':' BAREWORD (( '|' BAREWORD )* '|')?
+   ;
+
 value
    : NUMBER
    | BOOLEAN
    | DATE
    | STRING
    | VARIABLE
    | BAREWORD
+   | valueSpec
    | map
    | array
    ;
@@ -43,7 +49,7 @@ VARIABLE
    ;
 
 SPECIFIER
-   : '=' | '<>' | '>' | '<' | '<=' | '>=' ;
+   : '=' | '!=' | '<>' | '>' | '<' | '<=' | '>=' ;
 
 NUMBER
    : '-'?[0-9]+'%'
@@ -55,7 +61,7 @@ DATE
    : [0-9]+'.'[0-9]+'.'[0-9]+;
 
 BAREWORD
-   : [A-Za-z][@A-Za-z_0-9.%-]*
+   : [A-Za-z][@A-Za-z_0-9.%/-]*
    ;
 
 STRING
@@ -68,4 +74,4 @@ WS
 
 LINE_COMMENT
    : '#'~[\r\n]* -> channel(HIDDEN)
-   ;
+   ;

src/main/java/net/turanar/stellaris/Config.java

@@ -10,7 +10,9 @@
 import org.yaml.snakeyaml.Yaml;
 
 import java.io.IOException;
+import java.lang.RuntimeException;
 import java.util.HashMap;
+import java.util.Collections;
 import java.util.Map;
 import static net.turanar.stellaris.Global.*;
 
@@ -24,11 +26,21 @@ public Map<String,String> variables() throws IOException {
         HashMap<String,String> retval = new HashMap<>();
 
         parse("files/common/scripted_variables", "txt", p -> {
-            factory.getParser(p).file().var().forEach(v -> retval.put(v.VARIABLE().getText(), v.NUMBER().getText()));
+            try {
+                factory.getParser(p).file().var().forEach(v -> retval.put(v.VARIABLE().getText(), v.NUMBER().getText()));
+            }
+            catch (RuntimeException e) {
+                throw new RuntimeException("Error parsing file " + p.toString(), e);
+            }
         });
 
         parse("files/common/technology", "txt", p -> {
-            factory.getParser(p).file().var().forEach(v -> retval.put(v.VARIABLE().getText(), v.NUMBER().getText()));
+            try {
+                factory.getParser(p).file().var().forEach(v -> retval.put(v.VARIABLE().getText(), v.NUMBER().getText()));
+            }
+            catch (RuntimeException e) {
+                throw new RuntimeException("Error parsing file " + p.toString(), e);
+            }
         });
 
         return retval;
@@ -39,12 +51,20 @@ public Map<String,String> localisation() throws IOException {
         Map<String,String> retval = new HashMap<>();
 
         parse("files/localisation/english", "yml", path -> {
-            Yaml yaml = new Yaml();
-            Iterable<Object> data = yaml.loadAll(new StellarisYamlReader(path));
-            Map<String,Map<Object,Object>> map = (Map<String,Map<Object,Object>>)data.iterator().next();
-            map.get("l_english").forEach((k, v) -> {
-                retval.put(k.toString().toLowerCase(), v.toString());
-            });
+            try {
+                Yaml yaml = new Yaml();
+                Iterable<Object> data = yaml.loadAll(new StellarisYamlReader(path));
+                Map<String,Map<Object,Object>> map = (Map<String,Map<Object,Object>>)data.iterator().next();
+                Map english_l10n = map.getOrDefault("l_english", Collections.emptyMap());
+                if (english_l10n != null) {
+                    english_l10n.forEach((k, v) -> {
+                        retval.put(k.toString().toLowerCase(), v.toString());
+                    });
+                };
+            }
+            catch (RuntimeException e) {
+                throw new RuntimeException("Error parsing file " + path.toString(), e);
+            }
         });
 
         return retval;
@@ -55,7 +75,12 @@ public Map<String, StellarisParser.PairContext> scriptedTriggers() throws IOExce
         Map<String, StellarisParser.PairContext> retval = new HashMap<>();
 
         parse("files/common/scripted_triggers", "txt", path -> {
-            factory.getParser(path).file().pair().forEach(pair -> retval.put(pair.key(), pair));
+            try {
+                factory.getParser(path).file().pair().forEach(pair -> retval.put(key(pair), pair));
+            }
+            catch (RuntimeException e) {
+                throw new RuntimeException("Error parsing file " + path.toString(), e);
+            }
         });
 
         return retval;

src/main/java/net/turanar/stellaris/Global.java

@@ -31,6 +31,7 @@ public void init(Map<String,String> GLOBAL_VARIABLES, Map<String,String> GLOBAL_
     }
 
     public static String i18n(String key) {
+        if(key == null) return null;
         String retval = GLOBAL_STRINGS.get(key.toLowerCase());
         if(retval == null) return key;
         if(retval.contains("$")) {
@@ -74,6 +75,10 @@ public static String gs(StellarisParser.ValueContext value) {
         return null;
     }
 
+    public static String key(StellarisParser.PairContext pair) {
+        return pair.BAREWORD().getText();
+    }
+
     public static String variable(String key) {
         return GLOBAL_VARIABLES.get(key);
     }