Add surface syntax for "this type" (shader-slang#1236)

Within the context of an aggregate type (or an `extension` of one), the programmer can use `this` to refer to the "current" instance of the surrounding type, but there is no easy way to utter the name of the type itself. This is especially relevant inside of an `interface`, where the type of `this` isn't actually the `interface` type, but rather a placeholder for the as-yet-unknown concrete type that will implement the interface.

This change adds a keyword `This` that works similarly to `this`, but names the current *type* instead of the current instance. It can be used to declare things like binary methods or factory functions in an interface:

```
interface IBasicMathType
{
    This absoluteValue();
    This sumWith(This left);
}

T doSomeMath<T:IBasicMathType>(T value)
{
    return value.sumWith(value.absoluteValue());
}
```

The `This` type is consistent with the type named `Self` in Rust and Swift (where Rust/Swift use `self` instead of `this`). Other names could be considered (e.g., `ThisType`) if we find that users don't like the name in this change.

Author: Tim Foley

source/slang/slang-check-expr.cpp

@@ -1677,6 +1677,12 @@ namespace Slang
                     expr->type.IsLeftValue = true;
                 }
             }
+            else if( auto typeOrExtensionDecl = as<AggTypeDeclBase>(containerDecl) )
+            {
+                expr->type.type = calcThisType(makeDeclRef(typeOrExtensionDecl));
+                return expr;
+            }
+#if 0
             else if (auto aggTypeDecl = as<AggTypeDecl>(containerDecl))
             {
                 ensureDecl(aggTypeDecl, DeclCheckState::CanUseAsType);
@@ -1706,11 +1712,35 @@ namespace Slang
                 expr->type.type = extensionDecl->targetType.type;
                 return expr;
             }
+#endif
 
             scope = scope->parent;
         }
 
         getSink()->diagnose(expr, Diagnostics::thisExpressionOutsideOfTypeDecl);
         return CreateErrorExpr(expr);
     }
+
+    RefPtr<Expr> SemanticsExprVisitor::visitThisTypeExpr(ThisTypeExpr* expr)
+    {
+        auto scope = expr->scope;
+        while (scope)
+        {
+            auto containerDecl = scope->containerDecl;
+            if( auto typeOrExtensionDecl = as<AggTypeDeclBase>(containerDecl) )
+            {
+                auto thisType = calcThisType(makeDeclRef(typeOrExtensionDecl));
+                auto thisTypeType = getTypeType(thisType);
+
+                expr->type.type = thisTypeType;
+                return expr;
+            }
+
+            scope = scope->parent;
+        }
+
+        getSink()->diagnose(expr, Diagnostics::thisTypeOutsideOfTypeDecl);
+        return CreateErrorExpr(expr);
+    }
+
 }

source/slang/slang-check-impl.h

@@ -1363,6 +1363,7 @@ namespace Slang
         RefPtr<Expr> visitInitializerListExpr(InitializerListExpr* expr);
 
         RefPtr<Expr> visitThisExpr(ThisExpr* expr);
+        RefPtr<Expr> visitThisTypeExpr(ThisTypeExpr* expr);
     };
 
     struct SemanticsStmtVisitor

source/slang/slang-diagnostic-defs.h

@@ -384,6 +384,7 @@ DIAGNOSTIC(38100, Error, typeDoesntImplementInterfaceRequirement, "type '$0' doe
 DIAGNOSTIC(38101, Error, thisExpressionOutsideOfTypeDecl, "'this' expression can only be used in members of an aggregate type")
 DIAGNOSTIC(38102, Error, initializerNotInsideType, "an 'init' declaration is only allowed inside a type or 'extension' declaration")
 DIAGNOSTIC(38102, Error, accessorMustBeInsideSubscriptOrProperty, "an accessor declaration is only allowed inside a subscript or property declaration")
+DIAGNOSTIC(38103, Error, thisTypeOutsideOfTypeDecl, "'This' type can only be used inside of an aggregate type")
 
 DIAGNOSTIC(38020, Error, mismatchEntryPointTypeArgument, "expecting $0 entry-point type arguments, provided $1.")
 DIAGNOSTIC(38021, Error, typeArgumentForGenericParameterDoesNotConformToInterface, "type argument `$0` for generic parameter `$1` does not conform to interface `$2`.")

source/slang/slang-expr-defs.h

@@ -203,4 +203,12 @@ SYNTAX_CLASS(TaggedUnionTypeExpr, Expr)
 RAW(
     List<TypeExp> caseTypes;
 )
+END_SYNTAX_CLASS()
+
+    /// A type expression of the form `This`
+    ///
+    /// Refers to the type of `this` in the current context.
+    ///
+SYNTAX_CLASS(ThisTypeExpr, Expr)
+    FIELD(RefPtr<Scope>, scope);
 END_SYNTAX_CLASS()

source/slang/slang-lower-to-ir.cpp

@@ -3004,6 +3004,12 @@ struct ExprLoweringVisitorBase : ExprVisitor<Derived, LoweredValInfo>
         UNREACHABLE_RETURN(LoweredValInfo());
     }
 
+    LoweredValInfo visitThisTypeExpr(ThisTypeExpr* /*expr*/)
+    {
+        SLANG_UNIMPLEMENTED_X("this-type expression during code generation");
+        UNREACHABLE_RETURN(LoweredValInfo());
+    }
+
     LoweredValInfo visitAssignExpr(AssignExpr* expr)
     {
         // Because our representation of lowered "values"

source/slang/slang-mangle.cpp

@@ -151,6 +151,11 @@ namespace Slang
             }
             emitRaw(context, "U");
         }
+        else if( auto thisType = dynamicCast<ThisType>(type) )
+        {
+            emitRaw(context, "t");
+            emitQualifiedName(context, thisType->interfaceDeclRef);
+        }
         else
         {
             SLANG_UNEXPECTED("unimplemented case in mangling");

source/slang/slang-parser.cpp

@@ -1794,6 +1794,19 @@ namespace Slang
         return parseTaggedUnionType(parser);
     }
 
+        /// Parse a `This` type expression
+    static RefPtr<Expr> parseThisTypeExpr(Parser* parser)
+    {
+        RefPtr<ThisTypeExpr> expr = new ThisTypeExpr();
+        expr->scope = parser->currentScope;
+        return expr;
+    }
+
+    static RefPtr<RefObject> parseThisTypeExpr(Parser* parser, void* /*userData*/)
+    {
+        return parseThisTypeExpr(parser);
+    }
+
     static TypeSpec parseTypeSpec(Parser* parser)
     {
         TypeSpec typeSpec;
@@ -1848,6 +1861,11 @@ namespace Slang
             typeSpec.expr = parseTaggedUnionType(parser);
             return typeSpec;
         }
+        else if(AdvanceIf(parser, "This"))
+        {
+            typeSpec.expr = parseThisTypeExpr(parser);
+            return typeSpec;
+        }
 
         Token typeName = parser->ReadToken(TokenType::Identifier);
 
@@ -4995,6 +5013,7 @@ namespace Slang
         addBuiltinSyntax<Expr>(session, scope, #KEYWORD, &CALLBACK)
 
         EXPR(this,  parseThisExpr);
+        EXPR(This,  parseThisTypeExpr);
         EXPR(true,  parseTrueExpr);
         EXPR(false, parseFalseExpr);
         EXPR(__TaggedUnion, parseTaggedUnionType);

tests/compute/this-type.slang

@@ -0,0 +1,48 @@
+// this-type.slang
+
+// Confirm that that `This` type works as expected
+
+//TEST(compute):COMPARE_COMPUTE:
+//TEST(compute):COMPARE_COMPUTE:-cpu
+
+interface IFrobable
+{
+	This frob();
+	int getValue();
+}
+
+struct Thing : IFrobable
+{
+	int value;
+
+	Thing frob()
+	{
+		Thing result = { value * 16 };
+		return result;
+	}
+
+	int getValue() { return value; }
+}
+
+int frobnicate<F:IFrobable>(F f)
+{
+	return f.frob().getValue();
+}
+
+int test(int value)
+{
+	Thing t = { value };
+	return frobnicate(t) + value;
+}
+
+//TEST_INPUT:ubuffer(data=[0 1 2 3], stride=4):out,name=outputBuffer
+RWStructuredBuffer<int> outputBuffer : register(u0);
+
+[numthreads(4, 1, 1)]
+void computeMain(uint3 dispatchThreadID : SV_DispatchThreadID)
+{
+	uint tid = dispatchThreadID.x;
+	int inVal = outputBuffer[tid];
+	int outVal = test(inVal);
+	outputBuffer[tid] = outVal;
+}

tests/compute/this-type.slang.expected.txt

@@ -0,0 +1,4 @@
+0
+11
+22
+33