API Notes: Add support for having the this parameter anywhere

jacob-carlborg · May 10, 2024 · 08741e1 · 08741e1
1 parent 10d6176
commit 08741e1
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 14 deletions.
diff --git a/dstep/translator/ApiNotes.d b/dstep/translator/ApiNotes.d
@@ -84,11 +84,9 @@ struct Function
 
     bool isInstanceMethod() =>
         context.isPresent &&
-        arguments.length > 0 &&
-        (
-            arguments[0] == "this" ||
-            arguments[0] == "self"
-        );
+        !arguments.save.find!isThis.empty;
+
+    auto indexOfThis() => arguments.save.countUntil!isThis;
 
 private:
 
@@ -234,3 +232,5 @@ mixin template ToString()
         return format!"%s(%-(%s, %))"(typeof(this).stringof, formattedFields);
     }
 }
+
+bool isThis(string value) => value == "this" || value == "self";
diff --git a/dstep/translator/ApiNotesTranslator.d b/dstep/translator/ApiNotesTranslator.d
@@ -65,8 +65,23 @@ struct ApiNotesTranslator
             const firstParamType = cursor.func.parameters.first.type;
             const thisArg = firstParamType.isPointer ? "&this" : "this";
 
+
+            string[] parameterNames;
+            parameterNames.reserve(cursor.func.parameters.length);
+            size_t paramCount;
+
+            foreach (param ; cursor.func.parameters)
+            {
+                if (paramCount == func.indexOfThis)
+                    parameterNames ~= param.type.isPointer ? "&this" : "this";
+                else
+                    parameterNames ~= translateIdentifier(param.spelling);
+
+                paramCount++;
+            }
+
             output.subscopeStrong(wrapperResult.extent, wrapperResult.makeString) in {
-                output.singleLine("return %s(%s, __traits(parameters));", originalName, thisArg);
+                output.singleLine("return %s(%-(%s, %));", originalName, parameterNames);
             };
 
             addOriginalFunction(cursor, output, originalName);

diff --git a/dstep/translator/Translator.d b/dstep/translator/Translator.d
@@ -476,8 +476,11 @@ SourceNode translateFunction (
         params ~= Parameter(type, param.spelling);
     }
 
-    const parameterStart = func.apiNotesFunction.isInstanceMethod.or(false) ? 1 : 0;
-    params = params[parameterStart .. $];
+    if (func.apiNotesFunction.isInstanceMethod.or(false))
+    {
+        auto index = func.apiNotesFunction.indexOfThis.or(ptrdiff_t(-1));
+        params = params.remove(index);
+    }
 
     auto returnType = func.canonicalizeReturnType ?
         func.cursor.resultType.canonical : func.cursor.resultType;

diff --git a/tests/unit/ApiNotes.d b/tests/unit/ApiNotes.d
@@ -160,17 +160,25 @@ YAML";
 {
     @"when the D name contains a context"
     {
-        @"when the D name contains a 'this'" unittest
+        @"when the D name of the first argument is 'this'" unittest
         {
-            auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(this)");
+            auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(this:)");
             auto func = Function.parse(rawFunc);
 
             assert(func.isInstanceMethod);
         }
 
-        @"when the D name contains a 'self'" unittest
+        @"when the D name of the first argument is 'self'" unittest
         {
-            auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(self)");
+            auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(self:)");
+            auto func = Function.parse(rawFunc);
+
+            assert(func.isInstanceMethod);
+        }
+
+        @"when the D name of another argument is 'this'" unittest
+        {
+            auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(foo:this:bar:)");
             auto func = Function.parse(rawFunc);
 
             assert(func.isInstanceMethod);
@@ -232,6 +240,25 @@ YAML";
     }
 }
 
+@"Function.indexOfThis"
+{
+    @"when the D name contains 'this' or 'self'" unittest
+    {
+        auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(foo:this:bar:)");
+        auto func = Function.parse(rawFunc);
+
+        assert(func.indexOfThis == 1);
+    }
+
+    @"when the D name does not contain 'this' or 'self'" unittest
+    {
+        auto rawFunc = RawFunction(name: "foo", dName: "Foo.bar(foo:bar:)");
+        auto func = Function.parse(rawFunc);
+
+        assert(func.indexOfThis == -1);
+    }
+}
+
 @"renaming free function" unittest
 {
     auto options = Options(apiNotes:
@@ -276,7 +303,7 @@ struct Bar
 {
     void foo (int a)
     {
-        return __foo(this, __traits(parameters));
+        return __foo(this, a);
     }
 
     extern (C) private static pragma(mangle, "foo")
@@ -306,7 +333,7 @@ struct Bar
 {
     void foo (int a)
     {
-        return __foo(&this, __traits(parameters));
+        return __foo(&this, a);
     }
 
     extern (C) private static pragma(mangle, "foo")