Merge pull request github#12103 from michaelnebel/csharp/scopedmodfier

C# 11: Scoped parameters and local variables.

Author: michaelnebel

csharp/downgrades/cd877b8cc2fb8327499f96fbefd01bb988b2ed63/old.dbscheme

@@ -0,0 +1,3 @@
+description: Remove a relation for scoped annotations.
+compatibility: backwards
+scoped_annotation.rel: delete

csharp/downgrades/cd877b8cc2fb8327499f96fbefd01bb988b2ed63/semmlecode.csharp.dbscheme

@@ -59,6 +59,19 @@ protected void PopulateRefKind(TextWriter trapFile, RefKind kind)
             }
         }
 
+        protected void PopulateScopedKind(TextWriter trapFile, ScopedKind kind)
+        {
+            switch (kind)
+            {
+                case ScopedKind.ScopedRef:
+                    trapFile.scoped_annotation(this, Kinds.ScopedAnnotation.ScopedRef);
+                    break;
+                case ScopedKind.ScopedValue:
+                    trapFile.scoped_annotation(this, Kinds.ScopedAnnotation.ScopedValue);
+                    break;
+            }
+        }
+
         protected void ExtractCompilerGenerated(TextWriter trapFile)
         {
             if (Symbol.IsImplicitlyDeclared)

csharp/downgrades/cd877b8cc2fb8327499f96fbefd01bb988b2ed63/upgrade.properties

@@ -33,7 +33,8 @@ public override void Populate(TextWriter trapFile)
             PopulateRefKind(trapFile, Symbol.RefKind);
 
             var unboundFieldKey = Field.Create(Context, Symbol.OriginalDefinition);
-            trapFile.fields(this, (Symbol.IsConst ? 2 : 1), Symbol.Name, ContainingType, Type.TypeRef, unboundFieldKey);
+            var kind = Symbol.IsConst ? VariableKind.Const : VariableKind.None;
+            trapFile.fields(this, kind, Symbol.Name, ContainingType, Type.TypeRef, unboundFieldKey);
 
             PopulateModifiers(trapFile);
 

csharp/extractor/Semmle.Extraction.CSharp/Entities/CachedSymbol.cs

@@ -23,17 +23,23 @@ public override void Populate(TextWriter trapFile) { }
         public void PopulateManual(Expression parent, bool isVar)
         {
             var trapFile = Context.TrapWriter.Writer;
-            var (kind, type) = Symbol is ILocalSymbol l
-                ? (l.IsRef ? 3 : l.IsConst ? 2 : 1, l.GetAnnotatedType())
-                : (1, parent.Type);
-            trapFile.localvars(this, kind, Symbol.Name, isVar ? 1 : 0, Type.Create(Context, type).TypeRef, parent);
+            var @var = isVar ? 1 : 0;
 
             if (Symbol is ILocalSymbol local)
             {
+                var kind = local.IsRef ? Kinds.VariableKind.Ref : local.IsConst ? Kinds.VariableKind.Const : Kinds.VariableKind.None;
+                var type = local.GetAnnotatedType();
+                trapFile.localvars(this, kind, Symbol.Name, @var, Type.Create(Context, type).TypeRef, parent);
+
                 PopulateNullability(trapFile, local.GetAnnotatedType());
+                PopulateScopedKind(trapFile, local.ScopedKind);
                 if (local.IsRef)
                     trapFile.type_annotation(this, Kinds.TypeAnnotation.Ref);
             }
+            else
+            {
+                trapFile.localvars(this, Kinds.VariableKind.None, Symbol.Name, @var, Type.Create(Context, parent.Type).TypeRef, parent);
+            }
 
             trapFile.localvar_location(this, Location);
 

csharp/extractor/Semmle.Extraction.CSharp/Entities/Field.cs

@@ -100,6 +100,7 @@ public override void Populate(TextWriter trapFile)
             PopulateAttributes();
             PopulateNullability(trapFile, Symbol.GetAnnotatedType());
             PopulateRefKind(trapFile, Symbol.RefKind);
+            PopulateScopedKind(trapFile, Symbol.ScopedKind);
 
             if (Symbol.Name != Original.Symbol.Name)
                 Context.ModelError(Symbol, "Inconsistent parameter declaration");

csharp/extractor/Semmle.Extraction.CSharp/Entities/LocalVariable.cs

@@ -0,0 +1,8 @@
+namespace Semmle.Extraction.Kinds;
+
+public enum ScopedAnnotation
+{
+    None = 0,
+    ScopedRef = 1,
+    ScopedValue = 2
+}

csharp/extractor/Semmle.Extraction.CSharp/Entities/Parameter.cs

@@ -0,0 +1,8 @@
+namespace Semmle.Extraction.Kinds;
+
+public enum VariableKind
+{
+    None = 1,
+    Const = 2,
+    Ref = 3
+}

csharp/extractor/Semmle.Extraction.CSharp/Kinds/ScopedAnnotation.cs

@@ -191,8 +191,8 @@ internal static void anonymous_types(this TextWriter trapFile, Type type) =>
         internal static void field_location(this TextWriter trapFile, Field field, Location location) =>
             trapFile.WriteTuple("field_location", field, location);
 
-        internal static void fields(this TextWriter trapFile, Field field, int @const, string name, Type declaringType, Type fieldType, Field unboundKey) =>
-            trapFile.WriteTuple("fields", field, @const, name, declaringType, fieldType, unboundKey);
+        internal static void fields(this TextWriter trapFile, Field field, VariableKind kind, string name, Type declaringType, Type fieldType, Field unboundKey) =>
+            trapFile.WriteTuple("fields", field, (int)kind, name, declaringType, fieldType, unboundKey);
 
         internal static void general_type_parameter_constraints(this TextWriter trapFile, TypeParameterConstraints constraints, int hasKind) =>
             trapFile.WriteTuple("general_type_parameter_constraints", constraints, hasKind);
@@ -227,8 +227,8 @@ internal static void local_functions(this TextWriter trapFile, LocalFunction fn,
         internal static void localvar_location(this TextWriter trapFile, LocalVariable var, Location location) =>
             trapFile.WriteTuple("localvar_location", var, location);
 
-        internal static void localvars(this TextWriter trapFile, LocalVariable key, int @const, string name, int @var, Type type, Expression expr) =>
-            trapFile.WriteTuple("localvars", key, @const, name, @var, type, expr);
+        internal static void localvars(this TextWriter trapFile, LocalVariable key, VariableKind kind, string name, int @var, Type type, Expression expr) =>
+            trapFile.WriteTuple("localvars", key, (int)kind, name, @var, type, expr);
 
         public static void metadata_handle(this TextWriter trapFile, IEntity entity, Location assembly, int handleValue) =>
             trapFile.WriteTuple("metadata_handle", entity, assembly, handleValue);
@@ -462,5 +462,8 @@ internal static void locations_mapped(this System.IO.TextWriter trapFile, NonGen
 
         internal static void file_extraction_mode(this System.IO.TextWriter trapFile, Entities.File file, ExtractorMode mode) =>
             trapFile.WriteTuple("file_extraction_mode", file, mode);
+
+        internal static void scoped_annotation(this TextWriter trapFile, IEntity element, ScopedAnnotation @scoped) =>
+            trapFile.WriteTuple("scoped_annotation", element, (int)@scoped);
     }
 }