Run spotless on LFC and add check to CI (#201)

* Apply formatting with spotless

* Check formatting of compiler in CI

Author: erlingrj

.github/workflows/ci.yml

@@ -28,10 +28,13 @@ jobs:
       # Uncomment to SSH into the runner.
       # - name: Setup upterm session
       #   uses: lhotari/action-upterm@v1
-      - name: Format check
+      - name: Runtime format check
         run: |
           clang-format --version
           make format-check
+      
+      - name: LFC format check
+        run: cd lfc && ./gradlew spotlessCheck
 
       - name: Run unit tests
         run: make unit-test

lfc/README.md

@@ -5,4 +5,4 @@ code-generate for `reactor-uc`. Since this is a subdirectory within reactor-uc
 we are not copying reactor-uc into the src-gen directories but rather expecting
 an environment variable REACTOR_UC_PATH to be defined.
 
-The goal is to eventually merge this upstream.
+The goal is to eventually merge this upstream.

lfc/build.gradle

@@ -7,7 +7,7 @@ plugins {
 spotless {
     format 'misc', {
         target rootProject.fileTree(rootProject.rootDir) {
-            include '**/*.gradle', '**/*.md', '.gitignore', '**/*.yml', '**/*.sh', '**/*.psi'
+            include '**/*.gradle', '**/*.md', '.gitignore', '**/*.yml', '**/*.sh', '**/*.psi', '**/uc/**'
             exclude '**/reactor-cpp/**', '**/reactor-c/**', '**/reactor-rs/**', '**/lf-python-support/**',
                     '**/src-gen/**', '**/fed-gen/**', '**/test-gen/**', '**/build/**',
                     'test/*/include', 'test/*/bin/', 'test/*/share', 'test/*/lib'
@@ -41,4 +41,4 @@ assemble.dependsOn('installDist')
 // Alias tasks for simpler access
 tasks.register('runLfc', JavaExec) {
     dependsOn('cli:lfc:run')
-}
+}

lfc/cli/lfc/src/main/java/org/lflang/cli/Lfc.java

@@ -357,7 +357,6 @@ public GeneratorArguments getArgs() {
         lint,
         quiet,
         getRtiUri(),
-        List.of(
-            new Argument<>(BuildTypeProperty.INSTANCE, getBuildType())));
+        List.of(new Argument<>(BuildTypeProperty.INSTANCE, getBuildType())));
   }
 }

lfc/core/src/main/java/org/lflang/AttributeUtils.java

@@ -26,7 +26,6 @@
 package org.lflang;
 
 import static org.lflang.ast.ASTUtils.factory;
-import static org.lflang.ast.ASTUtils.toInteger;
 
 import java.util.HashMap;
 import java.util.List;
@@ -116,11 +115,11 @@ public static List<Attribute> findAttributesByName(EObject node, String name) {
   public static List<Attribute> findAttributesByNameStartingWith(EObject node, String name) {
     List<Attribute> attrs = getAttributes(node);
     return attrs.stream()
-            .filter(
-                    it ->
-                            it.getAttrName().contains(name)) // case-insensitive search (more user-friendly)
-            .toList();
+        .filter(
+            it -> it.getAttrName().contains(name)) // case-insensitive search (more user-friendly)
+        .toList();
   }
+
   /**
    * Return the first argument specified for the attribute.
    *

lfc/core/src/main/java/org/lflang/ModelInfo.java

@@ -30,9 +30,6 @@
 
 import java.util.ArrayList;
 import java.util.HashSet;
-import java.util.LinkedHashSet;
-import java.util.LinkedList;
-import java.util.List;
 import java.util.Set;
 import org.lflang.ast.ASTUtils;
 import org.lflang.graph.InstantiationGraph;
@@ -82,7 +79,7 @@ public class ModelInfo {
   public Set<Parameter> overflowingParameters;
 
   /** Cycles found during topology analysis. */
-//  private Set<NamedInstance<?>> topologyCycles = new LinkedHashSet<NamedInstance<?>>();
+  //  private Set<NamedInstance<?>> topologyCycles = new LinkedHashSet<NamedInstance<?>>();
 
   /** Whether or not the model information has been updated at least once. */
   public boolean updated;
@@ -97,31 +94,32 @@ public void update(Model model, MessageReporter reporter) {
     this.model = model;
     this.instantiationGraph = new InstantiationGraph(model, true);
 
-//    if (this.instantiationGraph.getCycles().size() == 0) {
-//      List<ReactorInstance> topLevelReactorInstances = new LinkedList<>();
-//      var main =
-//          model.getReactors().stream().filter(it -> it.isMain() || it.isFederated()).findFirst();
-//      if (main.isPresent()) {
-//        var inst = new ReactorInstance(main.get(), reporter);
-//        topLevelReactorInstances.add(inst);
-//      } else {
-//        model
-//            .getReactors()
-//            .forEach(it -> topLevelReactorInstances.add(new ReactorInstance(it, reporter)));
-//      }
-//      // don't store the graph into a field, only the cycles.
-//      for (ReactorInstance top : topLevelReactorInstances) {
-//        this.topologyCycles.addAll(top.getCycles());
-//      }
-//    }
+    //    if (this.instantiationGraph.getCycles().size() == 0) {
+    //      List<ReactorInstance> topLevelReactorInstances = new LinkedList<>();
+    //      var main =
+    //          model.getReactors().stream().filter(it -> it.isMain() ||
+    // it.isFederated()).findFirst();
+    //      if (main.isPresent()) {
+    //        var inst = new ReactorInstance(main.get(), reporter);
+    //        topLevelReactorInstances.add(inst);
+    //      } else {
+    //        model
+    //            .getReactors()
+    //            .forEach(it -> topLevelReactorInstances.add(new ReactorInstance(it, reporter)));
+    //      }
+    //      // don't store the graph into a field, only the cycles.
+    //      for (ReactorInstance top : topLevelReactorInstances) {
+    //        this.topologyCycles.addAll(top.getCycles());
+    //      }
+    //    }
 
     // may be null if the target is invalid
     var target = Target.forName(model.getTarget().getName()).orElse(null);
 
     // Perform C-specific traversals.
-//    if (target == Target.C) {
-//      this.collectOverflowingNodes();
-//    }
+    //    if (target == Target.C) {
+    //      this.collectOverflowingNodes();
+    //    }
 
     checkCaseInsensitiveNameCollisions(model, reporter);
   }
@@ -151,9 +149,9 @@ private String getName(Reactor r) {
         : FileUtil.nameWithoutExtension(FileUtil.toPath(model.eResource().getURI()));
   }
 
-//  public Set<NamedInstance<?>> topologyCycles() {
-//    return this.topologyCycles;
-//  }
+  //  public Set<NamedInstance<?>> topologyCycles() {
+  //    return this.topologyCycles;
+  //  }
 
   /**
    * Collect all assignments, deadlines, and parameters that can cause the time interval of a

lfc/core/src/main/java/org/lflang/ast/ASTUtils.java

@@ -59,7 +59,6 @@
 import org.eclipse.xtext.xbase.lib.IteratorExtensions;
 import org.eclipse.xtext.xbase.lib.StringExtensions;
 import org.lflang.InferredType;
-import org.lflang.MessageReporter;
 import org.lflang.TimeUnit;
 import org.lflang.TimeValue;
 import org.lflang.generator.CodeMap;
@@ -99,7 +98,6 @@
 import org.lflang.lf.WidthSpec;
 import org.lflang.lf.WidthTerm;
 import org.lflang.target.Target;
-import org.lflang.target.TargetConfig;
 import org.lflang.util.StringUtil;
 
 /**
@@ -511,14 +509,14 @@ public static List<Mode> allModes(Reactor definition) {
     return ASTUtils.collectElements(definition, featurePackage.getReactor_Modes());
   }
 
-//  public static List<ReactorInstance> recursiveChildren(ReactorInstance r) {
-//    List<ReactorInstance> ret = new ArrayList<>();
-//    ret.add(r);
-//    for (var child : r.children) {
-//      ret.addAll(recursiveChildren(child));
-//    }
-//    return ret;
-//  }
+  //  public static List<ReactorInstance> recursiveChildren(ReactorInstance r) {
+  //    List<ReactorInstance> ret = new ArrayList<>();
+  //    ret.add(r);
+  //    for (var child : r.children) {
+  //      ret.addAll(recursiveChildren(child));
+  //    }
+  //    return ret;
+  //  }
 
   /**
    * Return all the superclasses of the specified reactor in deepest-first order. For example, if A
@@ -606,37 +604,39 @@ public static <T extends EObject> List<T> collectElements(
    * This will also assign levels to reactions, then, if the program is federated, perform an AST
    * transformation to disconnect connections between federates.
    */
-//  public static ReactorInstance createMainReactorInstance(
-//      Instantiation mainDef,
-//      List<Reactor> reactors,
-//      MessageReporter messageReporter,
-//      TargetConfig targetConfig) {
-//    if (mainDef != null) {
-//      // Recursively build instances.
-//      ReactorInstance main =
-//          new ReactorInstance(toDefinition(mainDef.getReactorClass()), messageReporter, reactors);
-//      var reactionInstanceGraph = main.assignLevels();
-//      if (reactionInstanceGraph.nodeCount() > 0) {
-//        messageReporter
-//            .nowhere()
-//            .error("Main reactor has causality cycles. Skipping code generation.");
-//        return null;
-//      }
-//      // Inform the run-time of the breadth/parallelism of the reaction graph
-//      var breadth = reactionInstanceGraph.getBreadth();
-//      if (breadth == 0) {
-//        messageReporter.nowhere().warning("The program has no reactions");
-//      } else {
-//        CompileDefinitionsProperty.INSTANCE.update(
-//            targetConfig,
-//            Map.of(
-//                "LF_REACTION_GRAPH_BREADTH", String.valueOf(reactionInstanceGraph.getBreadth())));
-//      }
-//      return main;
-//    }
-//    return null;
-//  }
-//
+  //  public static ReactorInstance createMainReactorInstance(
+  //      Instantiation mainDef,
+  //      List<Reactor> reactors,
+  //      MessageReporter messageReporter,
+  //      TargetConfig targetConfig) {
+  //    if (mainDef != null) {
+  //      // Recursively build instances.
+  //      ReactorInstance main =
+  //          new ReactorInstance(toDefinition(mainDef.getReactorClass()), messageReporter,
+  // reactors);
+  //      var reactionInstanceGraph = main.assignLevels();
+  //      if (reactionInstanceGraph.nodeCount() > 0) {
+  //        messageReporter
+  //            .nowhere()
+  //            .error("Main reactor has causality cycles. Skipping code generation.");
+  //        return null;
+  //      }
+  //      // Inform the run-time of the breadth/parallelism of the reaction graph
+  //      var breadth = reactionInstanceGraph.getBreadth();
+  //      if (breadth == 0) {
+  //        messageReporter.nowhere().warning("The program has no reactions");
+  //      } else {
+  //        CompileDefinitionsProperty.INSTANCE.update(
+  //            targetConfig,
+  //            Map.of(
+  //                "LF_REACTION_GRAPH_BREADTH",
+  // String.valueOf(reactionInstanceGraph.getBreadth())));
+  //      }
+  //      return main;
+  //    }
+  //    return null;
+  //  }
+  //
   /**
    * Adds the elements into the given list at a location matching to their textual position.
    *
@@ -1657,9 +1657,9 @@ public static boolean isInCode(INode node) {
    *
    * @param instance The instance to check.
    */
-//  public static boolean isTopLevel(NamedInstance instance) {
-//    return instance.getParent() == null;
-//  }
+  //  public static boolean isTopLevel(NamedInstance instance) {
+  //    return instance.getParent() == null;
+  //  }
 
   /** Return true if the given node starts on the same line as the given other node. */
   public static Predicate<INode> sameLine(ICompositeNode compNode) {

lfc/core/src/main/java/org/lflang/generator/GeneratorBase.java

@@ -26,45 +26,32 @@
 
 import com.google.common.base.Objects;
 import com.google.common.collect.Iterables;
-import com.google.common.collect.Iterators;
-
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.Set;
-import java.util.stream.Collectors;
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.resource.Resource;
-import org.eclipse.emf.ecore.util.EcoreUtil;
 import org.eclipse.lsp4j.DiagnosticSeverity;
 import org.eclipse.xtext.xbase.lib.IterableExtensions;
 import org.eclipse.xtext.xbase.lib.IteratorExtensions;
-import org.eclipse.xtext.xbase.lib.StringExtensions;
-
-import org.lflang.AttributeUtils;
-import org.lflang.FileConfig;
 import org.lflang.MainConflictChecker;
 import org.lflang.MessageReporter;
-//import org.lflang.ast.ASTUtils;
+// import org.lflang.ast.ASTUtils;
 import org.lflang.ast.ASTUtils;
 import org.lflang.ast.AstTransformation;
 import org.lflang.graph.InstantiationGraph;
-import org.lflang.lf.Attribute;
-import org.lflang.lf.Connection;
 import org.lflang.lf.Instantiation;
 import org.lflang.lf.LfFactory;
-import org.lflang.lf.Mode;
 import org.lflang.lf.Reaction;
 import org.lflang.lf.Reactor;
 import org.lflang.target.Target;
 import org.lflang.target.TargetConfig;
-import org.lflang.util.FileUtil;
 import org.lflang.validation.AbstractLFValidator;
 
 /**
@@ -79,7 +66,7 @@
 public abstract class GeneratorBase extends AbstractLFValidator {
 
   /** The main (top-level) reactor instance. */
-//  public ReactorInstance main;
+  //  public ReactorInstance main;
 
   /** An error reporter for reporting any errors or warnings during the code generation */
   public MessageReporter messageReporter;
@@ -226,33 +213,33 @@ public void doGenerate(Resource resource, LFGeneratorContext context) {
 
     Set<Resource> allResources = GeneratorUtils.getResources(reactors);
 
-//    GeneratorUtils.accommodatePhysicalActionsIfPresent(
-//        allResources,
-//        getTarget().setsKeepAliveOptionAutomatically(),
-//        targetConfig,
-//        messageReporter);
+    //    GeneratorUtils.accommodatePhysicalActionsIfPresent(
+    //        allResources,
+    //        getTarget().setsKeepAliveOptionAutomatically(),
+    //        targetConfig,
+    //        messageReporter);
 
     // Load target properties for all resources.
     allResources.forEach(r -> loadTargetProperties(r));
 
-//    for (AstTransformation transformation : astTransformations) {
-//      transformation.applyTransformation(reactors);
-//    }
+    //    for (AstTransformation transformation : astTransformations) {
+    //      transformation.applyTransformation(reactors);
+    //    }
 
     // Transform connections that reside in mutually exclusive modes and are otherwise conflicting
     // This should be done before creating the instantiation graph
-//    transformConflictingConnectionsInModalReactors(allResources);
+    //    transformConflictingConnectionsInModalReactors(allResources);
 
     // Invoke these functions a second time because transformations
     // may have introduced new reactors!
     setReactorsAndInstantiationGraph(context.getMode());
 
     // Check for existence and support of modes
-//    hasModalReactors = IterableExtensions.exists(reactors, it -> !it.getModes().isEmpty());
-//    checkModalReactorSupport(false);
+    //    hasModalReactors = IterableExtensions.exists(reactors, it -> !it.getModes().isEmpty());
+    //    checkModalReactorSupport(false);
 
     // Check for the existence and support of watchdogs
-//    hasWatchdogs = IterableExtensions.exists(reactors, it -> !it.getWatchdogs().isEmpty());
+    //    hasWatchdogs = IterableExtensions.exists(reactors, it -> !it.getWatchdogs().isEmpty());
   }
 
   /**

lfc/core/src/main/java/org/lflang/generator/GeneratorUtils.java

@@ -10,13 +10,10 @@
 import org.eclipse.xtext.xbase.lib.IteratorExtensions;
 import org.lflang.MessageReporter;
 import org.lflang.generator.LFGeneratorContext.Mode;
-import org.lflang.lf.Action;
-import org.lflang.lf.ActionOrigin;
 import org.lflang.lf.ImportedReactor;
 import org.lflang.lf.Instantiation;
 import org.lflang.lf.Reactor;
 import org.lflang.lf.TargetDecl;
-import org.lflang.target.TargetConfig;
 
 /**
  * A helper class with functions that may be useful for code generators. This is created to ease our