PHP: Added autocompletion for the use keyword in the body of a class, trait, and enum

php/php.editor/src/org/netbeans/modules/php/editor/completion/PHPCodeCompletion.java

@@ -1344,6 +1344,9 @@ private void autoCompleteInClassContext(
         if (!foundConst && !foundFunction) {
             autoCompleteKeywords(completionResult, request, PHP_SET_VISIBILITY_KEYWORDS);
             autoCompleteKeywords(completionResult, request, PHP_ASYMMETRIC_VISIBILITY_KEYWORDS);
+            if (!completeAfterModificatorsKeywords(tokenSequence, caretOffset, th, info.getSnapshot().getSource().getFileObject())){
+                autoCompleteKeywords(completionResult, request, Arrays.asList("use"));
+            }
         }
         if (offerMagicAndInherited(tokenSequence, caretOffset, th)) {
             EnclosingClass enclosingClass = findEnclosingClass(info, lexerToASTOffset(info, caretOffset));
@@ -1551,6 +1554,29 @@ private boolean completeFieldTypes(TokenSequence<PHPTokenId> tokenSequence, int
         return completeTypes;
     }
 
+    private boolean completeAfterModificatorsKeywords(TokenSequence<PHPTokenId> tokenSequence, int caretOffset, TokenHierarchy<?> th, FileObject fileObject) {
+        boolean completeAfterModificatorsKeywords = false;
+        tokenSequence.move(caretOffset);
+        if (!(!tokenSequence.moveNext() && !tokenSequence.movePrevious())) {
+            Token<PHPTokenId> token = tokenSequence.token();
+            int tokenIdOffset = tokenSequence.token().offset(th);
+            completeAfterModificatorsKeywords = CompletionContextFinder.lineContainsAny(token, caretOffset - tokenIdOffset, tokenSequence, Arrays.asList(
+                PHPTokenId.PHP_PUBLIC,
+                PHPTokenId.PHP_PUBLIC_SET,
+                PHPTokenId.PHP_PRIVATE,
+                PHPTokenId.PHP_PRIVATE_SET,
+                PHPTokenId.PHP_PROTECTED,
+                PHPTokenId.PHP_PROTECTED_SET,
+                PHPTokenId.PHP_ABSTRACT,
+                PHPTokenId.PHP_STATIC,
+                PHPTokenId.PHP_VAR,
+                PHPTokenId.PHP_READONLY,
+                PHPTokenId.PHP_FINAL
+            ));
+        }
+        return completeAfterModificatorsKeywords;
+    }
+
     private static Set<String> toNames(Set<? extends PhpElement> elements) {
         Set<String> names = new HashSet<>();
         for (PhpElement elem : elements) {

php/php.editor/test/unit/data/testfiles/completion/lib/_base/clsDeclaration02.php.testClsDeclaration_10.completion

@@ -69,6 +69,7 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/clsDeclaration02.php.testClsDeclaration_13.completion

@@ -69,6 +69,7 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/clsDeclaration02.php.testClsDeclaration_9.completion

@@ -69,6 +69,7 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/issue153707.php.testIssue153707_01.completion

@@ -82,6 +82,8 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
+CLASS      UseKeywordEnum                  [PUBLIC]   useKeywordInEnum.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/issue153867.php.testIssue153867.completion

@@ -73,6 +73,8 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
+CLASS      UseKeywordEnum                  [PUBLIC]   useKeywordInEnum.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/issue200795.php.testIssue200795.completion

@@ -68,6 +68,7 @@ CLASS      TestIssue145206                 [PUBLIC]   issue145206.php
 CLASS      TestIssue146176                 [PUBLIC]   issue146176.php
 CLASS      TestOptionalArgsClass           [PUBLIC]   optional_args.php
 CLASS      TypesinPHPDoc                   [PUBLIC]   types_in_phpdoc.php
+CLASS      UseKeywordClass                 [PUBLIC]   useKeywordInClass.php
 CLASS      User                            [PUBLIC]   issue142051.php
 CLASS      User147427                      [PUBLIC]   issue147427.php
 CLASS      VarAdvancedTest                 [PUBLIC]   varAssignment2.php

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInClass.php

@@ -0,0 +1,9 @@
+<?php
+
+class UseKeywordClass {
+    use TestKeywordTrait;
+}
+
+
+trait TestKeywordTrait {}
+

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInClass.php.testUseKeywordInClass.completion

@@ -0,0 +1,5 @@
+Code completion result for source line:
+u|se TestKeywordTrait;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+------------------------------------
+KEYWORD    use                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInEnum.php

@@ -0,0 +1,8 @@
+<?php
+
+enum UseKeywordEnum {
+    use TestKeywordTrait;
+}
+
+trait TestKeywordTrait {}
+

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInEnum.php.testUseKeywordInEnum.completion

@@ -0,0 +1,5 @@
+Code completion result for source line:
+u|se TestKeywordTrait;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+------------------------------------
+KEYWORD    use                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+interface UseKeywordInterface {
+    use TestKeywordTrait;
+}
+
+trait TestKeywordTrait {}
+

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInInterface.php.testUseKeywordInInterface.completion

@@ -0,0 +1,3 @@
+Code completion result for source line:
+u|se TestKeywordTrait;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInTrait.php

@@ -0,0 +1,8 @@
+<?php
+
+trait UseKeywordTrait {
+    use TestKeywordTrait;
+}
+
+trait TestKeywordTrait {}
+

php/php.editor/test/unit/data/testfiles/completion/lib/_base/useKeywordInTrait.php.testUseKeywordInTrait.completion

@@ -0,0 +1,5 @@
+Code completion result for source line:
+u|se TestKeywordTrait;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+------------------------------------
+KEYWORD    use                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/php70/base/anonymousClass01.php.testAnonymousClass01h.completion

@@ -34,4 +34,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/php81/testReadonlyPropertiesTyping01/readonlyPropertiesTyping01.php.testReadonlyPropertiesTyping01.completion

@@ -34,4 +34,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/php84/testAsymmetricVisibilityClass01/testAsymmetricVisibilityClass01.php.testAsymmetricVisibilityClass01_01a.completion

@@ -34,4 +34,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/php84/testAsymmetricVisibilityClassTyping01/testAsymmetricVisibilityClassTyping01.php.testAsymmetricVisibilityClassTyping01.completion

@@ -34,4 +34,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/test209117/issue209117.php.testUseCase1.completion

@@ -35,4 +35,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/data/testfiles/completion/lib/test233756/issue233756.php.testUseCase1.completion

@@ -37,4 +37,5 @@ KEYWORD    public protected(set)                      null
 KEYWORD    public(set)                                null
 KEYWORD    readonly                                   null
 KEYWORD    static                                     null
+KEYWORD    use                                        null
 KEYWORD    var                                        null

php/php.editor/test/unit/src/org/netbeans/modules/php/editor/completion/PHPCodeCompletionTest.java

@@ -869,6 +869,21 @@ public void testIssue202281() throws Exception {
         checkCompletion("testfiles/completion/lib/_base/issue202281.php", "function^Name($myInt);", false);
     }
 
+    public void testUseKeywordInClass() throws Exception {
+        checkCompletion("testfiles/completion/lib/_base/useKeywordInClass.php", "u^se", false);
+    }
+
+    public void testUseKeywordInTrait() throws Exception {
+        checkCompletion("testfiles/completion/lib/_base/useKeywordInTrait.php", "u^se", false);
+    }
+
+    public void testUseKeywordInEnum() throws Exception {
+        checkCompletion("testfiles/completion/lib/_base/useKeywordInEnum.php", "u^se", false);
+    }
+    public void testUseKeywordInInterface() throws Exception {
+        checkCompletion("testfiles/completion/lib/_base/useKeywordInInterface.php", "u^se", false);
+    }
+
     @Override
     protected Map<String, ClassPath> createClassPathsForTest() {
         //just test them as standalone files (just PHP Platform in index)