Comments and minor changes

lf-lang · Oct 1, 2023 · 764bde2 · 764bde2
1 parent c1b2ff7
commit 764bde2
Show file tree

Hide file tree

Showing 31 changed files with 59 additions and 55 deletions.
diff --git a/core/src/main/java/org/lflang/AbstractTargetProperty.java b/core/src/main/java/org/lflang/AbstractTargetProperty.java
@@ -180,9 +180,7 @@ public T get() {
    */
   protected abstract T fromString(String string, MessageReporter reporter);
 
-  /**
-   * Return a list of targets that support this target property.
-   */
+  /** Return a list of targets that support this target property. */
   public abstract List<Target> supportedTargets();
 
   /**

diff --git a/core/src/main/java/org/lflang/TargetProperty.java b/core/src/main/java/org/lflang/TargetProperty.java
@@ -78,7 +78,6 @@
 import org.lflang.target.property.TimeOutProperty;
 import org.lflang.target.property.TracingProperty;
 import org.lflang.target.property.WorkersProperty;
-import org.lflang.target.property.type.TargetPropertyType;
 import org.lflang.target.property.type.VerifyProperty;
 import org.lflang.validation.ValidatorMessageReporter;
 
@@ -360,7 +359,7 @@ public static List<TargetProperty> loaded(TargetConfig config) {
   }
 
   /**
-   * Constructs a TargetDecl by extracting the fields of the given TargetConfig.
+   * Constructs a {@code TargetDecl} by extracting the fields of the given {@code TargetConfig}.
    *
    * @param target The target to generate for.
    * @param config The TargetConfig to extract from.
@@ -377,8 +376,15 @@ public static TargetDecl extractTargetDecl(Target target, TargetConfig config) {
     return decl;
   }
 
-  private static KeyValuePair getKeyValuePair(
-      KeyValuePairs targetProperties, TargetProperty property) {
+  /**
+   * Retrieve a key-value pair from the given AST that matches the given target property.
+   *
+   * @param ast The AST retrieve the key-value pair from.
+   * @param property The target property of interest.
+   * @return The found key-value pair, or {@code null} if no matching pair could be found.
+   */
+  public static KeyValuePair getKeyValuePair(Model ast, TargetProperty property) {
+    var targetProperties = ast.getTarget().getConfig();
     List<KeyValuePair> properties =
         targetProperties.getPairs().stream()
             .filter(pair -> pair.getName().equals(property.toString()))
@@ -387,15 +393,19 @@ private static KeyValuePair getKeyValuePair(
     return properties.size() > 0 ? properties.get(0) : null;
   }
 
-  public static KeyValuePair getKeyValuePair(Model ast, TargetProperty property) {
-    return getKeyValuePair(ast.getTarget().getConfig(), property);
-  }
-
   /** Return a list containing the keys of all properties */
   public static List<String> getPropertyKeys() {
-    return Arrays.stream(TargetProperty.values()).map(TargetProperty::getKey).toList();
+    return Arrays.stream(TargetProperty.values()).map(TargetProperty::toString).toList();
   }
 
+  /**
+   * Validate the given key-value pairs and report issues via the given reporter.
+   *
+   * @param pairs The key-value pairs to validate.
+   * @param ast The root node of the AST from which the key-value pairs were taken.
+   * @param config A target configuration used to retrieve the corresponding target properties.
+   * @param reporter A reporter to report errors and warnings through.
+   */
   public static void validate(
       KeyValuePairs pairs, Model ast, TargetConfig config, ValidatorMessageReporter reporter) {
     pairs.getPairs().stream()
@@ -487,9 +497,4 @@ public String toString() {
     }
     return this.name().toLowerCase().replaceAll("_", "-");
   }
-
-  /** Interface for dictionary elements. It associates an entry with a type. */
-  public interface DictionaryElement {
-    TargetPropertyType getType();
-  }
 }
diff --git a/core/src/main/java/org/lflang/ast/ASTUtils.java b/core/src/main/java/org/lflang/ast/ASTUtils.java
@@ -61,7 +61,6 @@
 import org.lflang.InferredType;
 import org.lflang.MessageReporter;
 import org.lflang.Target;
-import org.lflang.target.TargetConfig;
 import org.lflang.TimeUnit;
 import org.lflang.TimeValue;
 import org.lflang.generator.CodeMap;
@@ -102,6 +101,7 @@
 import org.lflang.lf.Watchdog;
 import org.lflang.lf.WidthSpec;
 import org.lflang.lf.WidthTerm;
+import org.lflang.target.TargetConfig;
 import org.lflang.util.StringUtil;
 
 /**

diff --git a/core/src/main/java/org/lflang/federated/generator/FedGenerator.java b/core/src/main/java/org/lflang/federated/generator/FedGenerator.java
@@ -31,7 +31,6 @@
 import org.lflang.LFStandaloneSetup;
 import org.lflang.MessageReporter;
 import org.lflang.Target;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.federated.launcher.FedLauncherGenerator;
 import org.lflang.federated.launcher.RtiConfig;
@@ -58,6 +57,7 @@
 import org.lflang.lf.Reactor;
 import org.lflang.lf.TargetDecl;
 import org.lflang.lf.VarRef;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.CoordinationProperty.CoordinationMode;
 import org.lflang.util.Averager;
 

diff --git a/core/src/main/java/org/lflang/federated/generator/FedTargetConfig.java b/core/src/main/java/org/lflang/federated/generator/FedTargetConfig.java
@@ -5,10 +5,10 @@
 import java.nio.file.Path;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.TargetProperty;
 import org.lflang.generator.GeneratorUtils;
 import org.lflang.generator.LFGeneratorContext;
+import org.lflang.target.TargetConfig;
 import org.lflang.util.FileUtil;
 
 /**

diff --git a/core/src/main/java/org/lflang/federated/generator/FederateInstance.java b/core/src/main/java/org/lflang/federated/generator/FederateInstance.java
@@ -37,7 +37,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.TimeValue;
 import org.lflang.ast.ASTUtils;
 import org.lflang.federated.serialization.SupportedSerializers;
@@ -64,6 +63,7 @@
 import org.lflang.lf.TriggerRef;
 import org.lflang.lf.VarRef;
 import org.lflang.lf.Variable;
+import org.lflang.target.TargetConfig;
 
 /**
  * Class that represents an instance of a federate, i.e., a reactor that is instantiated at the top

diff --git a/core/src/main/java/org/lflang/federated/launcher/FedLauncherGenerator.java b/core/src/main/java/org/lflang/federated/launcher/FedLauncherGenerator.java
@@ -34,9 +34,9 @@
 import java.util.ArrayList;
 import java.util.List;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.federated.generator.FedFileConfig;
 import org.lflang.federated.generator.FederateInstance;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.ClockSyncModeProperty.ClockSyncMode;
 
 /**

diff --git a/core/src/main/java/org/lflang/generator/GeneratorBase.java b/core/src/main/java/org/lflang/generator/GeneratorBase.java
@@ -43,12 +43,12 @@
 import org.lflang.MainConflictChecker;
 import org.lflang.MessageReporter;
 import org.lflang.Target;
-import org.lflang.target.TargetConfig;
 import org.lflang.analyses.uclid.UclidGenerator;
 import org.lflang.ast.ASTUtils;
 import org.lflang.ast.AstTransformation;
 import org.lflang.graph.InstantiationGraph;
 import org.lflang.lf.*;
+import org.lflang.target.TargetConfig;
 import org.lflang.util.FileUtil;
 import org.lflang.validation.AbstractLFValidator;
 

diff --git a/core/src/main/java/org/lflang/generator/GeneratorUtils.java b/core/src/main/java/org/lflang/generator/GeneratorUtils.java
@@ -12,7 +12,7 @@
 import org.eclipse.xtext.xbase.lib.IteratorExtensions;
 import org.lflang.FileConfig;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
+import org.lflang.Target;
 import org.lflang.TargetProperty;
 import org.lflang.ast.ASTUtils;
 import org.lflang.generator.LFGeneratorContext.Mode;
@@ -23,6 +23,7 @@
 import org.lflang.lf.KeyValuePairs;
 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
@@ -118,7 +119,7 @@ public static LFResource getLFResource(
       MessageReporter messageReporter) {
     var target = ASTUtils.targetDecl(resource);
     KeyValuePairs config = target.getConfig();
-    var targetConfig = new TargetConfig(target);
+    var targetConfig = new TargetConfig(Target.fromDecl(target));
     if (config != null) {
       List<KeyValuePair> pairs = config.getPairs();
       TargetProperty.load(targetConfig, pairs != null ? pairs : List.of(), messageReporter);

diff --git a/core/src/main/java/org/lflang/generator/MainContext.java b/core/src/main/java/org/lflang/generator/MainContext.java
@@ -11,8 +11,8 @@
 import org.lflang.DefaultMessageReporter;
 import org.lflang.FileConfig;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.IntegratedBuilder.ReportProgress;
+import org.lflang.target.TargetConfig;
 
 /**
  * A {@code MainContext} is an {@code LFGeneratorContext} that is not nested in any other generator

diff --git a/core/src/main/java/org/lflang/generator/c/CCmakeGenerator.java b/core/src/main/java/org/lflang/generator/c/CCmakeGenerator.java
@@ -33,8 +33,8 @@
 import java.util.stream.Stream;
 import org.lflang.FileConfig;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.CodeBuilder;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.PlatformProperty.Platform;
 import org.lflang.util.FileUtil;
 

diff --git a/core/src/main/java/org/lflang/generator/c/CCompiler.java b/core/src/main/java/org/lflang/generator/c/CCompiler.java
@@ -35,11 +35,11 @@
 import java.util.stream.Stream;
 import org.lflang.FileConfig;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.GeneratorBase;
 import org.lflang.generator.GeneratorCommandFactory;
 import org.lflang.generator.GeneratorUtils;
 import org.lflang.generator.LFGeneratorContext;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.BuildTypeProperty;
 import org.lflang.target.property.PlatformProperty.Platform;
 import org.lflang.util.FileUtil;

diff --git a/core/src/main/java/org/lflang/generator/c/CEnvironmentFunctionGenerator.java b/core/src/main/java/org/lflang/generator/c/CEnvironmentFunctionGenerator.java
@@ -2,9 +2,9 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.CodeBuilder;
 import org.lflang.generator.ReactorInstance;
+import org.lflang.target.TargetConfig;
 
 /**
  * This class is in charge of code generating functions and global variables related to the

diff --git a/core/src/main/java/org/lflang/generator/c/CGenerator.java b/core/src/main/java/org/lflang/generator/c/CGenerator.java
@@ -52,7 +52,6 @@
 import org.eclipse.xtext.xbase.lib.StringExtensions;
 import org.lflang.FileConfig;
 import org.lflang.Target;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.ast.DelayedConnectionTransformation;
 import org.lflang.federated.extensions.CExtensionUtils;
@@ -86,6 +85,7 @@
 import org.lflang.lf.ReactorDecl;
 import org.lflang.lf.StateVar;
 import org.lflang.lf.Variable;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.PlatformProperty.Platform;
 import org.lflang.target.property.PlatformProperty.PlatformOption;
 import org.lflang.target.property.SchedulerProperty.SchedulerOption;

diff --git a/core/src/main/java/org/lflang/generator/c/CMainFunctionGenerator.java b/core/src/main/java/org/lflang/generator/c/CMainFunctionGenerator.java
@@ -2,8 +2,8 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.CodeBuilder;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.PlatformProperty.Platform;
 import org.lflang.util.StringUtil;
 

diff --git a/core/src/main/java/org/lflang/generator/c/CPreambleGenerator.java b/core/src/main/java/org/lflang/generator/c/CPreambleGenerator.java
@@ -3,8 +3,8 @@
 import static org.lflang.util.StringUtil.addDoubleQuotes;
 
 import java.nio.file.Path;
-import org.lflang.target.TargetConfig;
 import org.lflang.generator.CodeBuilder;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.PlatformProperty.Platform;
 import org.lflang.util.StringUtil;
 

diff --git a/core/src/main/java/org/lflang/generator/c/CReactionGenerator.java b/core/src/main/java/org/lflang/generator/c/CReactionGenerator.java
@@ -11,7 +11,6 @@
 import java.util.Set;
 import org.lflang.InferredType;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.federated.extensions.CExtensionUtils;
 import org.lflang.generator.CodeBuilder;
@@ -33,6 +32,7 @@
 import org.lflang.lf.VarRef;
 import org.lflang.lf.Variable;
 import org.lflang.lf.Watchdog;
+import org.lflang.target.TargetConfig;
 import org.lflang.util.StringUtil;
 
 public class CReactionGenerator {

diff --git a/core/src/main/java/org/lflang/generator/c/CTriggerObjectsGenerator.java b/core/src/main/java/org/lflang/generator/c/CTriggerObjectsGenerator.java
@@ -14,7 +14,6 @@
 import java.util.HashSet;
 import java.util.stream.Collectors;
 import org.lflang.AttributeUtils;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.federated.extensions.CExtensionUtils;
 import org.lflang.generator.CodeBuilder;
@@ -23,6 +22,7 @@
 import org.lflang.generator.ReactorInstance;
 import org.lflang.generator.RuntimeRange;
 import org.lflang.generator.SendRange;
+import org.lflang.target.TargetConfig;
 import org.lflang.target.property.LoggingProperty.LogLevel;
 
 /**

diff --git a/core/src/main/java/org/lflang/generator/c/CUtil.java b/core/src/main/java/org/lflang/generator/c/CUtil.java
@@ -39,7 +39,6 @@
 import org.lflang.FileConfig;
 import org.lflang.InferredType;
 import org.lflang.MessageReporter;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.generator.ActionInstance;
 import org.lflang.generator.GeneratorCommandFactory;
@@ -54,6 +53,7 @@
 import org.lflang.lf.VarRef;
 import org.lflang.lf.Variable;
 import org.lflang.lf.WidthTerm;
+import org.lflang.target.TargetConfig;
 import org.lflang.util.FileUtil;
 import org.lflang.util.LFCommand;
 

diff --git a/core/src/main/java/org/lflang/generator/python/PythonPreambleGenerator.java b/core/src/main/java/org/lflang/generator/python/PythonPreambleGenerator.java
@@ -3,11 +3,11 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
-import org.lflang.target.TargetConfig;
 import org.lflang.ast.ASTUtils;
 import org.lflang.generator.CodeBuilder;
 import org.lflang.generator.c.CPreambleGenerator;
 import org.lflang.lf.Preamble;
+import org.lflang.target.TargetConfig;
 
 /**
  * Generates user-defined preambles and #define and #include directives for the Python target.

diff --git a/core/src/main/java/org/lflang/target/TargetConfig.java b/core/src/main/java/org/lflang/target/TargetConfig.java
@@ -27,7 +27,6 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Properties;
-
 import org.lflang.MessageReporter;
 import org.lflang.Target;
 import org.lflang.TargetProperty;
@@ -87,8 +86,8 @@ public class TargetConfig {
    *
    * @param target AST node of a target declaration.
    */
-  public TargetConfig(TargetDecl target) { // FIXME: eliminate this constructor if we can
-    this.target = Target.fromDecl(target);
+  public TargetConfig(Target target) {
+    this.target = target;
   }
 
   /**
@@ -100,7 +99,7 @@ public TargetConfig(TargetDecl target) { // FIXME: eliminate this constructor if
    * @param messageReporter An error reporter to report problems.
    */
   public TargetConfig(Properties cliArgs, TargetDecl target, MessageReporter messageReporter) {
-    this(target);
+    this(Target.fromDecl(target));
     if (target.getConfig() != null) {
       List<KeyValuePair> pairs = target.getConfig().getPairs();
       TargetProperty.load(this, pairs, messageReporter);

diff --git a/core/src/main/java/org/lflang/target/property/ClockSyncOptionsProperty.java b/core/src/main/java/org/lflang/target/property/ClockSyncOptionsProperty.java
@@ -5,7 +5,6 @@
 import org.lflang.AbstractTargetProperty;
 import org.lflang.MessageReporter;
 import org.lflang.Target;
-import org.lflang.TargetProperty.DictionaryElement;
 import org.lflang.TimeUnit;
 import org.lflang.TimeValue;
 import org.lflang.ast.ASTUtils;
@@ -15,6 +14,7 @@
 import org.lflang.lf.LfFactory;
 import org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions;
 import org.lflang.target.property.type.DictionaryType;
+import org.lflang.target.property.type.DictionaryType.DictionaryElement;
 import org.lflang.target.property.type.PrimitiveType;
 import org.lflang.target.property.type.TargetPropertyType;
 

diff --git a/core/src/main/java/org/lflang/target/property/CoordinationOptionsProperty.java b/core/src/main/java/org/lflang/target/property/CoordinationOptionsProperty.java
@@ -6,7 +6,6 @@
 import org.lflang.AbstractTargetProperty;
 import org.lflang.MessageReporter;
 import org.lflang.Target;
-import org.lflang.TargetProperty.DictionaryElement;
 import org.lflang.TimeValue;
 import org.lflang.ast.ASTUtils;
 import org.lflang.lf.Element;
@@ -15,6 +14,7 @@
 import org.lflang.lf.LfFactory;
 import org.lflang.target.property.CoordinationOptionsProperty.CoordinationOptions;
 import org.lflang.target.property.type.DictionaryType;
+import org.lflang.target.property.type.DictionaryType.DictionaryElement;
 import org.lflang.target.property.type.PrimitiveType;
 import org.lflang.target.property.type.TargetPropertyType;