[NETBEANS-5599] PHP 8.1 Support: Never type (Part 2)

https://issues.apache.org/jira/browse/NETBEANS-5599 RFC: https://wiki.php.net/rfc/noreturn_type - Fix the code completion - Add and fix unit tests for the code completion
jirkabs · Nov 27, 2021 · 419c0ed · 419c0ed
1 parent ab498d4
commit 419c0ed
Show file tree

Hide file tree

Showing 48 changed files with 310 additions and 0 deletions.
diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/completion/CompletionContextFinder.java b/php/php.editor/src/org/netbeans/modules/php/editor/completion/CompletionContextFinder.java
@@ -1157,6 +1157,7 @@ private static boolean isType(Token<PHPTokenId> token) {
                 || id == PHPTokenId.PHP_TYPE_INT
                 || id == PHPTokenId.PHP_TYPE_STRING
                 || id == PHPTokenId.PHP_TYPE_VOID
+                || id == PHPTokenId.PHP_TYPE_NEVER
                 || id == PHPTokenId.PHP_TYPE_OBJECT
                 || id == PHPTokenId.PHP_TYPE_MIXED
                 || id == PHPTokenId.PHP_SELF

diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/completion/PHPCodeCompletion.java b/php/php.editor/src/org/netbeans/modules/php/editor/completion/PHPCodeCompletion.java
@@ -534,8 +534,10 @@ public CodeCompletionResult complete(CodeCompletionContext completionContext) {
                     typesForReturnTypeName.remove(Type.FALSE);
                     typesForReturnTypeName.remove(Type.NULL);
                     typesForReturnTypeName.remove(Type.VOID);
+                    typesForReturnTypeName.remove(Type.NEVER);
                 } else if (context == CompletionContext.RETURN_UNION_TYPE_NAME) {
                     typesForReturnTypeName.remove(Type.VOID);
+                    typesForReturnTypeName.remove(Type.NEVER);
                     typesForReturnTypeName.remove(Type.MIXED);
                 }
                 autoCompleteKeywords(completionResult, request, typesForReturnTypeName);

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType01.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType01.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType03.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType03.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType05.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType05.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType07.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType07.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType12.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType12.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType13.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType13.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType14.completion b/...unit/data/testfiles/completion/lib/php70/base/returnTypes.php.testReturnType14.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping01.php.testReturnTypesTyping01.completion b/...iles/completion/lib/php70/base/returnTypesTyping01.php.testReturnTypesTyping01.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping02.php.testReturnTypesTyping02.completion b/...iles/completion/lib/php70/base/returnTypesTyping02.php.testReturnTypesTyping02.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping03.php.testReturnTypesTyping03.completion b/...iles/completion/lib/php70/base/returnTypesTyping03.php.testReturnTypesTyping03.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping04.php.testReturnTypesTyping04a.completion b/...les/completion/lib/php70/base/returnTypesTyping04.php.testReturnTypesTyping04a.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping04.php.testReturnTypesTyping04b.completion b/...les/completion/lib/php70/base/returnTypesTyping04.php.testReturnTypesTyping04b.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping05.php.testReturnTypesTyping05.completion b/...iles/completion/lib/php70/base/returnTypesTyping05.php.testReturnTypesTyping05.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping06.php.testReturnTypesTyping06.completion b/...iles/completion/lib/php70/base/returnTypesTyping06.php.testReturnTypesTyping06.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping07.php.testReturnTypesTyping07.completion b/...iles/completion/lib/php70/base/returnTypesTyping07.php.testReturnTypesTyping07.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping08.php.testReturnTypesTyping08a.completion b/...les/completion/lib/php70/base/returnTypesTyping08.php.testReturnTypesTyping08a.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping08.php.testReturnTypesTyping08b.completion b/...les/completion/lib/php70/base/returnTypesTyping08.php.testReturnTypesTyping08b.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping09.php.testReturnTypesTyping09.completion b/...iles/completion/lib/php70/base/returnTypesTyping09.php.testReturnTypesTyping09.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping10.php.testReturnTypesTyping10.completion b/...iles/completion/lib/php70/base/returnTypesTyping10.php.testReturnTypesTyping10.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...iles/completion/lib/php70/base/returnTypesTyping11.php.testReturnTypesTyping11.completion b/...iles/completion/lib/php70/base/returnTypesTyping11.php.testReturnTypesTyping11.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping12.php.testReturnTypesTyping12a.completion b/...les/completion/lib/php70/base/returnTypesTyping12.php.testReturnTypesTyping12a.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...les/completion/lib/php70/base/returnTypesTyping12.php.testReturnTypesTyping12b.completion b/...les/completion/lib/php70/base/returnTypesTyping12.php.testReturnTypesTyping12b.completion
@@ -55,6 +55,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...ion/lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Class01.completion b/...ion/lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Class01.completion
@@ -12,6 +12,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/.../lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Function01.completion b/.../lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Function01.completion
@@ -12,6 +12,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Interface01.completion b/...lib/php71/testVoidReturnType/voidReturnType.php.testVoidReturnType_Interface01.completion
@@ -12,6 +12,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...ib/php72/testObjectTypeHint/objectTypeHint.php.testObjectTypeHint_ReturnType02.completion b/...ib/php72/testObjectTypeHint/objectTypeHint.php.testObjectTypeHint_ReturnType02.completion
@@ -11,6 +11,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...pletion/lib/php74/testArrowFunctions/arrowFunctions.php.testArrowFunctions_05a.completion b/...pletion/lib/php74/testArrowFunctions/arrowFunctions.php.testArrowFunctions_05a.completion
@@ -11,6 +11,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...ta/testfiles/completion/lib/php80/testMixedType/mixedType.php.testMixedType_05.completion b/...ta/testfiles/completion/lib/php80/testMixedType/mixedType.php.testMixedType_05.completion
@@ -11,6 +11,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_04.completion b/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_04.completion
@@ -13,6 +13,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_09.completion b/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_09.completion
@@ -13,6 +13,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_15.completion b/...p80/testUnionTypesFunctions/unionTypesFunctions.php.testUnionTypesFunctions_15.completion
@@ -13,6 +13,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    string                                     null

diff --git a/...lib/php80/testUnionTypesMethods/unionTypesMethods.php.testUnionTypesMethods_07.completion b/...lib/php80/testUnionTypesMethods/unionTypesMethods.php.testUnionTypesMethods_07.completion
@@ -18,6 +18,7 @@ KEYWORD    float                                      null
 KEYWORD    int                                        null
 KEYWORD    iterable                                   null
 KEYWORD    mixed                                      null
+KEYWORD    never                                      null
 KEYWORD    null                                       null
 KEYWORD    object                                     null
 KEYWORD    parent                                     null

diff --git a/...tor/test/unit/data/testfiles/completion/lib/php81/testNeverReturnType/neverReturnType.php b/...tor/test/unit/data/testfiles/completion/lib/php81/testNeverReturnType/neverReturnType.php
@@ -0,0 +1,47 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// PHP 8.1 Never type
+// https://wiki.php.net/rfc/noreturn_type
+
+function returnType(): never { // func
+}
+
+function invalidInParameter(never $never): never { // func
+}
+
+class TestClass {
+    public function returnType(): never { // class
+    }
+    public function invalidInParameter(never $never): never { // class
+    }
+}
+
+trait TestTrait {
+    public function returnType(): never { // trait
+    }
+    public function invalidInParameter(never $never): never { // trait
+    }
+}
+
+interface TestInterface {
+    public function returnType(): never; // interface
+    public function invalidInParameter(never $never): never; // interface
+}
diff --git a/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class01.completion b/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class01.completion
@@ -0,0 +1,22 @@
+Code completion result for source line:
+public function returnType(): |never { // class
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+CLASS      TestClass                       [PUBLIC]   neverReturnType.php
+CLASS      TestInterface                   [PUBLIC]   neverReturnType.php
+------------------------------------
+KEYWORD    array                                      null
+KEYWORD    bool                                       null
+KEYWORD    callable                                   null
+KEYWORD    false                                      null
+KEYWORD    float                                      null
+KEYWORD    int                                        null
+KEYWORD    iterable                                   null
+KEYWORD    mixed                                      null
+KEYWORD    never                                      null
+KEYWORD    null                                       null
+KEYWORD    object                                     null
+KEYWORD    parent                                     null
+KEYWORD    self                                       null
+KEYWORD    static                                     null
+KEYWORD    string                                     null
+KEYWORD    void                                       null
diff --git a/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class02.completion b/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class02.completion
@@ -0,0 +1,5 @@
+Code completion result for source line:
+public function returnType(): neve|r { // class
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+------------------------------------
+KEYWORD    never                                      null
diff --git a/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class03.completion b/.../lib/php81/testNeverReturnType/neverReturnType.php.testNeverReturnType_Class03.completion
@@ -0,0 +1,3 @@
+Code completion result for source line:
+public function invalidInParameter(ne|ver $never): never { // class
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)