Add ability to print out dependencies of a file as part of the evaluation

Author: mitchpaulus

src/IdfPlusExpVisitor.cs

@@ -39,7 +39,7 @@ public IdfPlusExpVisitor(string baseDirectory, FileType fileType)
             _variables[0]["fold"] = new FoldFunctionExpression();
             _variables[0]["keys"] = new KeysFunctionExpression();
             _variables[0]["has"] = new HasFunctionExpression();
-            _variables[0]["load"] = new LoadFunctionExpression(baseDirectory);
+            _variables[0]["load"] = new LoadFunctionExpression();
             _variables[0]["head"] = new ListHeadFunctionExpression();
             _variables[0]["tail"] = new ListTailFunctionExpression();
             _variables[0]["init"] = new ListInitFunctionExpression();

src/IdfPlusListener.cs

@@ -77,4 +77,4 @@ public override void EnterLambda_def(NeobemParser.Lambda_defContext context)
             // FunctionExpression funcExpression = new FunctionExpression(context);
         }
     }
-}
+}

src/IdfPlusVisitor.cs

@@ -34,7 +34,7 @@ public IdfPlusVisitor(string baseDirectory, FileType fileType, List<string> flag
              _environments[0]["fold"] = new FoldFunctionExpression();
              _environments[0]["keys"] = new KeysFunctionExpression();
              _environments[0]["has"] = new HasFunctionExpression();
-             _environments[0]["load"] = new LoadFunctionExpression(baseDirectory);
+             _environments[0]["load"] = new LoadFunctionExpression();
              _environments[0]["head"] = new ListHeadFunctionExpression();
              _environments[0]["tail"] = new ListTailFunctionExpression();
              _environments[0]["init"] = new ListInitFunctionExpression();
@@ -221,6 +221,8 @@ public override string VisitImport_statement(NeobemParser.Import_statementContex
                     throw new Exception( $"Could not read contents of {filePath} in import statement, line {context.Start.Line}.");
                 }
 
+                Dependencies.Set.Add(fileInfo.FullName);
+
                 // Read the imported file, with the current directory set to directory of the input file.
                 visitor = new IdfPlusVisitor(fileInfo.DirectoryName, _fileType, _flags);
             }
@@ -301,4 +303,9 @@ public override string VisitLog_statement(NeobemParser.Log_statementContext cont
             return "";
         }
     }
+
+    public static class Dependencies
+    {
+        public static HashSet<string> Set = new();
+    }
 }

src/LoadFunctionExpression.cs

@@ -9,7 +9,7 @@ namespace src
 {
     public class LoadFunctionExpression : FunctionExpression
     {
-        public LoadFunctionExpression(string baseDirectory) : base(new List<Dictionary<string, Expression>>(), new List<string>{ "options"}, FileType.Any)
+        public LoadFunctionExpression() : base(new List<Dictionary<string, Expression>>(), new List<string>{ "options"}, FileType.Any)
         {
         }
 
@@ -21,6 +21,8 @@ public override (string, Expression) Evaluate(List<Expression> inputs, string ba
             {
                 DelimitedFileReader reader = new();
                 var fullPath = Path.GetFullPath(stringExpression.Text, baseDirectory);
+
+                Dependencies.Set.Add(fullPath);
                 return EvaluateDelimitedFile(fullPath, reader, true, 0);
             }
             else if (inputs[0] is IdfPlusObjectExpression objectExpression)
@@ -69,6 +71,8 @@ public override (string, Expression) Evaluate(List<Expression> inputs, string ba
 
                     DelimitedFileReader reader = new(delimiter);
                     var fullPath = Path.GetFullPath(pathStringExpression.Text, baseDirectory);
+
+                    Dependencies.Set.Add(fullPath);
                     return EvaluateDelimitedFile(fullPath, reader, hasHeaderLine, skipLines);
                 }
                 else if (typeStringExpression.Text == "Excel")
@@ -107,12 +111,16 @@ public override (string, Expression) Evaluate(List<Expression> inputs, string ba
 
                     string filePath = ((StringExpression) objectExpression.Members["path"]).Text;
                     var fullFilePath = Path.GetFullPath(filePath, baseDirectory);
+
+                    Dependencies.Set.Add(fullFilePath);
+
                     return ("", ExcelDataLoader.Load( fullFilePath, worksheetName, range));
                 }
                 else if (objectExpression.Members["type"] is StringExpression {Text: "JSON"})
                 {
                     string filePath = ((StringExpression) objectExpression.Members["path"]).Text;
                     var fullFilePath = Path.GetFullPath(filePath, baseDirectory);
+                    Dependencies.Set.Add(fullFilePath);
                     string jsonData = File.ReadAllText(fullFilePath);
                     JsonDataLoader jsonLoader = new();
 
@@ -122,6 +130,7 @@ public override (string, Expression) Evaluate(List<Expression> inputs, string ba
                 {
                     string filePath = ((StringExpression) objectExpression.Members["path"]).Text;
                     var fullFilePath = Path.GetFullPath(filePath, baseDirectory);
+                    Dependencies.Set.Add(fullFilePath);
                     string jsonData = File.ReadAllText(fullFilePath);
                     XmlDataLoader xmlDataLoader = new();
 

src/Program.cs

@@ -5,7 +5,6 @@
 using System.Text;
 using Antlr4.Runtime;
 using Antlr4.Runtime.Tree;
-using OfficeOpenXml.FormulaParsing.LexicalAnalysis;
 
 namespace src
 {
@@ -58,6 +57,18 @@ static int Main(string[] args)
                     case "--doe2":
                         options.FileType = FileType.Doe2;
                         break;
+                    case "--deps":
+                         if (i + 1 < args.Length)
+                         {
+                             options.DependenciesFile = args[i + 1];
+                         }
+                         else
+                         {
+                             WriteLine("No file path given for --deps option.");
+                             return 1;
+                         }
+                         i++;
+                         break;
                     case "--flags":
                         if (i + 1 < args.Length)
                         {
@@ -203,6 +214,26 @@ static int Main(string[] args)
                 }
             }
 
+            if (!string.IsNullOrEmpty(options.DependenciesFile))
+            {
+                StringBuilder b = new();
+                foreach (var dep in Dependencies.Set.Order())
+                {
+                    b.Append(dep);
+                    b.Append('\n');
+                }
+
+                try
+                {
+                    File.WriteAllText(options.DependenciesFile, b.ToString());
+                }
+                catch (Exception)
+                {
+                    Console.Error.WriteLine($"Could not write dependencies output to {options.DependenciesFile}.");
+                    return 1;
+                }
+            }
+
             return 0;
         }
 
@@ -219,6 +250,7 @@ public class BempOptions
             public bool Tree = false;
             public List<string> Flags = new();
             public bool PrintObjects = false;
+            public string DependenciesFile = "";
         }
     }
 }

src/help.txt

@@ -7,6 +7,7 @@ If the input file is '-', input is read from standard input rather than from a f
 OPTIONS:
 
     --doe2              Parse input file in DOE-2 Building Description Language format
+    --deps <filename>   Print dependencies encountered in the input file to the specified file
 -h, --help              Show this help and exit
 -f, --fmt               Format file instead of compiling
     --flags <flags>     Set flags for simulation. Multiple flags can be set, comma separated.