-
Notifications
You must be signed in to change notification settings - Fork 258
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support all option types in the project file (#4506)
### Changes - Support all option types in the project file by parsing the project file options in the same way as the CLI parses them ### Testing - Added a case that uses an enum option to an existing test <small>By submitting this pull request, I confirm that my contribution is made under the terms of the [MIT license](https://github.com/dafny-lang/dafny/blob/master/LICENSE.txt).</small>
- Loading branch information
1 parent
65bccc1
commit 08e5fc1
Showing
10 changed files
with
122 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
using System; | ||
using System.Collections.Generic; | ||
using System.IO; | ||
using System.Linq; | ||
using Tomlyn.Model; | ||
|
||
namespace DafnyCore.Generic; | ||
|
||
public static class TomlUtil { | ||
|
||
public static bool TryGetValueFromToml(TextWriter errorWriter, string sourceDir, string tomlPath, Type type, object tomlValue, out object value) { | ||
if (tomlValue == null) { | ||
value = null; | ||
return false; | ||
} | ||
|
||
if (type.IsAssignableFrom(typeof(List<string>))) { | ||
return TryGetListValueFromToml<string>(errorWriter, sourceDir, tomlPath, (TomlArray)tomlValue, out value); | ||
} | ||
if (type.IsAssignableFrom(typeof(List<FileInfo>))) { | ||
return TryGetListValueFromToml<FileInfo>(errorWriter, sourceDir, tomlPath, (TomlArray)tomlValue, out value); | ||
} | ||
|
||
if (tomlValue is string tomlString) { | ||
if (type == typeof(FileInfo)) { | ||
// Need to make sure relative paths are interpreted relative to the source of the value, | ||
// not the current directory. | ||
var fullPath = sourceDir != null ? Path.GetFullPath(tomlString, sourceDir) : tomlString; | ||
value = new FileInfo(fullPath); | ||
return true; | ||
} | ||
|
||
if (typeof(Enum).IsAssignableFrom(type)) { | ||
try { | ||
value = Enum.Parse(type, tomlString); | ||
return true; | ||
} catch (ArgumentException) { | ||
value = null; | ||
return false; | ||
} | ||
} | ||
} | ||
|
||
if (!type.IsInstanceOfType(tomlValue)) { | ||
if (type == typeof(string)) { | ||
value = tomlValue.ToString(); | ||
return true; | ||
} | ||
errorWriter.WriteLine( | ||
$"Error: property '{tomlPath}' is of type '{tomlValue.GetType()}' but should be of type '{type}'"); | ||
value = null; | ||
return false; | ||
} | ||
|
||
value = tomlValue; | ||
return true; | ||
} | ||
|
||
private static bool TryGetListValueFromToml<T>(TextWriter errorWriter, string sourceDir, string tomlPath, TomlArray tomlValue, out object value) { | ||
var success = true; | ||
value = tomlValue.Select((e, i) => { | ||
if (TryGetValueFromToml(errorWriter, sourceDir, $"{tomlPath}[{i}]", typeof(T), e, out var elementValue)) { | ||
return (T)elementValue; | ||
} | ||
success = false; | ||
return default(T); | ||
}).ToList(); | ||
return success; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
The Dafny IDE now has improved behavior when working with a Dafny file that's part of a Dafny project. A Dafny file is part of a project if a `dfyconfig.toml` can be found somewhere in the file's path hierarchy, such as in the same folder or in the parent folder. A `dfyconfig.toml` can specify which Dafny options to use for that project, and can specify which Dafny files are part of the project. By default, the project will include all .dfy files reachable from the folder in which the `dfyconfig.toml` resides. Project related features of the IDE are: | ||
- Whenever one file in the project is opened, diagnostics for all files in the Dafny project are shown. When including a file with errors that's part of the same project, the message "the included file contains errors" is no longer shown. Instead, the included file's errors are shown directly. | ||
- If any file in the project in changed, diagnostics for all files in the project are updated. Without a project, changing an included file will not update diagnostics for the including file until the including file is also changed. | ||
- If any file in the project is resolved, all files in the project are resolved. Opening a file in a project that's already resolved means the opened file is resolved instantly. | ||
- The IDE's memory consumption stays the same regardless of how many files in a project are opened. Without a project, the IDE increases it's memory usage for each open file. | ||
- If any file in the project is changed, diagnostics for all files in the project are updated. Without a project, changing an included file will not update diagnostics for the including file until the including file is also changed. | ||
- The find references feature (also added in this release), works better in files that are part of a project, since only then can it find references that are inside files that include the current file. | ||
- The assisted rename feature (also added in this release), only works for files that are part of a project. | ||
- For files that are part of a project, the Dafny IDE does not require the use of include directives to work, and neither does the CLI if you run it using the project file. This means that Dafny projects can be used without use include directives for files inside the project. When using library files that are outside the project, it's still necessary to use includes. | ||
- When using a project file, it is no longer necessary to use include directives. In the previous version of Dafny, it was already the case that the Dafny CLI, when passed a Dafny project file, does not require include directives to process the Dafny program. The same now holds for the Dafny IDE when working with Dafny files for which a project file can be found. | ||
- If any file in the project is resolved, all files in the project are resolved. Opening a file in a project that's already resolved means the opened file is resolved instantly. | ||
- The IDE's memory consumption stays the same regardless of how many files in a project are opened. Without a project, the IDE increases it's memory usage for each open file. | ||
|
||
Try out the IDE's project support now by creating an empty `dfyconfig.toml` file in the root of your project repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Support all types of options in the Dafny project file (dfyconfig.toml) |