Set nullableContextOptions (#687)

* Set nullableContextOptions

* Read NullableContextOptions from csproj

* Add --nullable option

* Update template

* Update CompilationContext.cs

* Revert some changes

* Remove most of the MSBuild logic

---------

Co-authored-by: Shargon <shargon@gmail.com>
Co-authored-by: Jimmy <jimmy@r3e.network>

Author: 3 people

src/Neo.Compiler.CSharp/CompilationContext.cs

@@ -38,7 +38,7 @@ public class CompilationContext
         private static readonly MetadataReference[] commonReferences;
         private static readonly Dictionary<string, MetadataReference> metaReferences = new();
         private readonly Compilation compilation;
-        private string? assemblyName, displayName, className;
+        private string? displayName, className;
         private bool scTypeFound;
         private readonly List<Diagnostic> diagnostics = new();
         private readonly HashSet<string> supportedStandards = new();
@@ -57,8 +57,7 @@ public class CompilationContext
 
         public bool Success => diagnostics.All(p => p.Severity != DiagnosticSeverity.Error);
         public IReadOnlyList<Diagnostic> Diagnostics => diagnostics;
-        public string? ContractName => displayName ?? assemblyName ?? className;
-        public bool Checked { get; private set; } = false;
+        public string? ContractName => displayName ?? Options.BaseName ?? className;
         private string? Source { get; set; }
         internal Options Options { get; private set; }
         internal IEnumerable<IFieldSymbol> StaticFieldSymbols => staticFields.OrderBy(p => p.Value).Select(p => p.Key);
@@ -153,8 +152,7 @@ internal static CompilationContext Compile(IEnumerable<string> sourceFiles, IEnu
         {
             IEnumerable<SyntaxTree> syntaxTrees = sourceFiles.OrderBy(p => p).Select(p => CSharpSyntaxTree.ParseText(File.ReadAllText(p), options: options.GetParseOptions(), path: p));
             if (IsSingleAbstractClass(syntaxTrees)) throw new FormatException("The given class is abstract, no valid neo SmartContract found.");
-
-            CSharpCompilationOptions compilationOptions = new(OutputKind.DynamicallyLinkedLibrary, deterministic: true);
+            CSharpCompilationOptions compilationOptions = new(OutputKind.DynamicallyLinkedLibrary, deterministic: true, nullableContextOptions: options.Nullable);
             CSharpCompilation compilation = CSharpCompilation.Create(null, syntaxTrees, references, compilationOptions);
             CompilationContext context = new(compilation, options);
             context.Compile();
@@ -168,16 +166,16 @@ public static CompilationContext CompileSources(string[] sourceFiles, Options op
             return Compile(sourceFiles, references, options);
         }
 
-        public static Compilation GetCompilation(string csproj, Options options, out XDocument document)
+        public static Compilation GetCompilation(string csproj, Options options)
         {
             string folder = Path.GetDirectoryName(csproj)!;
             string obj = Path.Combine(folder, "obj");
             HashSet<string> sourceFiles = Directory.EnumerateFiles(folder, "*.cs", SearchOption.AllDirectories)
                 .Where(p => !p.StartsWith(obj))
                 .ToHashSet(StringComparer.OrdinalIgnoreCase);
             List<MetadataReference> references = new(commonReferences);
-            CSharpCompilationOptions compilationOptions = new(OutputKind.DynamicallyLinkedLibrary, deterministic: true);
-            document = XDocument.Load(csproj);
+            CSharpCompilationOptions compilationOptions = new(OutputKind.DynamicallyLinkedLibrary, deterministic: true, nullableContextOptions: options.Nullable);
+            XDocument document = XDocument.Load(csproj);
             sourceFiles.UnionWith(document.Root!.Elements("ItemGroup").Elements("Compile").Attributes("Include").Select(p => Path.GetFullPath(p.Value, folder)));
             Process.Start(new ProcessStartInfo
             {
@@ -234,7 +232,7 @@ public static Compilation GetCompilation(string csproj, Options options, out XDo
                     case "project":
                         string msbuildProject = assets["libraries"]![name]!["msbuildProject"]!.GetString();
                         msbuildProject = Path.GetFullPath(msbuildProject, folder);
-                        reference = GetCompilation(msbuildProject, options, out _).ToMetadataReference();
+                        reference = GetCompilation(msbuildProject, options).ToMetadataReference();
                         break;
                     default:
                         throw new NotSupportedException();
@@ -246,10 +244,8 @@ public static Compilation GetCompilation(string csproj, Options options, out XDo
 
         public static CompilationContext CompileProject(string csproj, Options options)
         {
-            Compilation compilation = GetCompilation(csproj, options, out XDocument document);
+            Compilation compilation = GetCompilation(csproj, options);
             CompilationContext context = new(compilation, options);
-            context.assemblyName = document.Root!.Elements("PropertyGroup").Elements("AssemblyName").Select(p => p.Value).FirstOrDefault() ?? Path.GetFileNameWithoutExtension(csproj);
-            context.Checked = document.Root!.Elements("PropertyGroup").Elements("CheckForOverflowUnderflow").Select(p => bool.Parse(p.Value)).FirstOrDefault();
             context.Compile();
             return context;
         }

src/Neo.Compiler.CSharp/MethodConvert.cs

@@ -67,7 +67,7 @@ public MethodConvert(CompilationContext context, IMethodSymbol symbol)
         {
             this.Symbol = symbol;
             this.context = context;
-            this._checkedStack.Push(context.Checked);
+            this._checkedStack.Push(context.Options.Checked);
         }
 
         private byte AddLocalVariable(ILocalSymbol symbol)

src/Neo.Compiler.CSharp/Options.cs

@@ -8,6 +8,7 @@
 // Redistribution and use in source and binary forms with or without
 // modifications are permitted.
 
+using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using System.Collections.Generic;
 
@@ -17,6 +18,8 @@ public class Options
     {
         public string? Output { get; set; }
         public string? BaseName { get; set; }
+        public NullableContextOptions Nullable { get; set; }
+        public bool Checked { get; set; }
         public bool Debug { get; set; }
         public bool Assembly { get; set; }
         public bool NoOptimize { get; set; }

src/Neo.Compiler.CSharp/Program.cs

@@ -30,6 +30,8 @@ static int Main(string[] args)
                 new Argument<string[]>("paths", "The path of the project file, project directory or source files."),
                 new Option<string>(new[] { "-o", "--output" }, "Specifies the output directory."),
                 new Option<string>("--base-name", "Specifies the base name of the output files."),
+                new Option<NullableContextOptions>("--nullable", () => NullableContextOptions.Annotations, "Represents the default state of nullable analysis in this compilation."),
+                new Option<bool>("--checked", "Indicates whether to check for overflow and underflow."),
                 new Option<bool>(new[] { "-d", "--debug" }, "Indicates whether to generate debugging information."),
                 new Option<bool>("--assembly", "Indicates whether to generate assembly."),
                 new Option<bool>("--no-optimize", "Instruct the compiler not to optimize the code."),

src/Neo.SmartContract.Template/templates/neocontract/ProjectName.csproj

@@ -9,13 +9,17 @@
   </ItemGroup>
 
   <PropertyGroup>
+    <BaseNameArgument Condition="'$(AssemblyName)' != ''">--base-name $(AssemblyName)</BaseNameArgument>
+    <BaseNameArgument Condition="'$(AssemblyName)' == ''">--base-name $(MSBuildProjectName)</BaseNameArgument>
+    <NullableArgument Condition="'$(Nullable)' != ''">--nullable $(Nullable)</NullableArgument>
+    <CheckedArgument Condition="'$(CheckForOverflowUnderflow)' == 'true'">--checked</CheckedArgument>
     <DebugArgument Condition="'$(Configuration)' == 'Debug'">-d</DebugArgument>
   </PropertyGroup>
 
   <Target Name="PostBuild" AfterTargets="PostBuildEvent">
     <Message Text="Start NeoContract converter, Source File: $(ProjectPath)" Importance="high">
     </Message>
-    <Exec Command="nccs $(DebugArgument) &quot;$(ProjectPath)&quot;" />
+    <Exec Command="nccs $(BaseNameArgument) $(NullableArgument) $(CheckedArgument) $(DebugArgument) &quot;$(ProjectPath)&quot;" />
   </Target>
 
 </Project>