From 85eed6770603990135d718fe5cda096935bc25ed Mon Sep 17 00:00:00 2001
From: Junichi Yamamoto <junichi11@apache.org>
Date: Mon, 10 Jul 2023 22:50:04 +0900
Subject: [PATCH] Fix "Fix Imports" issue with declare statements #5578

- https://github.com/apache/netbeans/issues/5578

Example:
```php
<?php
namespace NS1;

declare(ticks=1) {
    $test = 1;
}
declare(ticks=2) {
    $test = 1;
}
class DeclareTest1 {
    public function test() {
        declare(ticks=2) {

        }
        $test = new \NS2\DeclareTest2;
    }
}
```

Before:
```php
<?php
namespace NS1;

declare(ticks=1) {
    $test = 1;
}
use NS2\DeclareTest2;
declare(ticks=2) {
    $test = 1;
}
class DeclareTest1 {
    public function test() {
        declare(ticks=2) {

        }
        $test = new DeclareTest2;
    }
}
```

After:
```php
<?php
namespace NS1;

declare(ticks=1) {
    $test = 1;
}
declare(ticks=2) {
    $test = 1;
}

use NS2\DeclareTest2;

class DeclareTest1 {
    public function test() {
        declare(ticks=2) {

        }
        $test = new DeclareTest2;
    }
}
```
---
 .../php/editor/actions/FixUsesPerformer.java  | 45 +++++++++++++++++--
 .../declare03/testGH5578_declare03.php        | 40 +++++++++++++++++
 .../testGH5578_declare03.php.fixUses          | 42 +++++++++++++++++
 .../declare04/testGH5578_declare04.php        | 39 ++++++++++++++++
 .../testGH5578_declare04.php.fixUses          | 41 +++++++++++++++++
 .../declare05/testGH5578_declare05.php        | 39 ++++++++++++++++
 .../testGH5578_declare05.php.fixUses          | 41 +++++++++++++++++
 .../editor/actions/FixUsesPerformerTest.java  | 21 +++++++++
 8 files changed, 305 insertions(+), 3 deletions(-)
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php.fixUses
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php.fixUses
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php.fixUses

diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/actions/FixUsesPerformer.java b/php/php.editor/src/org/netbeans/modules/php/editor/actions/FixUsesPerformer.java
index 952900c172dc..5101be74251e 100644
--- a/php/php.editor/src/org/netbeans/modules/php/editor/actions/FixUsesPerformer.java
+++ b/php/php.editor/src/org/netbeans/modules/php/editor/actions/FixUsesPerformer.java
@@ -590,9 +590,7 @@ private static int processDeclareStatementsOffset(NamespaceScope namespaceScope,
         // function foo() {
         //     declare(ticks=1) {}
         // }
-        int maxDeclareOffset = namespaceScope.getElements().isEmpty()
-                ? namespaceScope.getBlockRange().getEnd()
-                : namespaceScope.getElements().get(0).getOffset();
+        int maxDeclareOffset = getMaxDeclareOffset(namespaceScope, checkVisitor);
         for (DeclareStatement declareStatement : checkVisitor.getDeclareStatements()) {
             if (maxDeclareOffset < declareStatement.getStartOffset()) {
                 break;
@@ -602,6 +600,47 @@ private static int processDeclareStatementsOffset(NamespaceScope namespaceScope,
         return result;
     }
 
+    private static int getMaxDeclareOffset(NamespaceScope namespaceScope, CheckVisitor checkVisitor) {
+        int maxDeclareOffset = namespaceScope.getBlockRange().getEnd();
+        if (!namespaceScope.getElements().isEmpty()) {
+            for (ModelElement element : namespaceScope.getElements()) {
+                if (isInDeclare(element.getOffset(), checkVisitor.getDeclareStatements())) {
+                    maxDeclareOffset = getDeclareEndPosition(element.getOffset(), checkVisitor.getDeclareStatements());
+                    continue;
+                }
+                maxDeclareOffset = element.getOffset();
+                break;
+            }
+        }
+        return maxDeclareOffset;
+    }
+
+    private static boolean isInDeclare(int offset, List<DeclareStatement> declareStatements) {
+        // e.g.
+        // declare(ticks=1) {
+        //     $test = 1; // is this element in declare?
+        // }
+        for (DeclareStatement declareStatement : declareStatements) {
+            if (isInDeclare(offset, declareStatement)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    private static boolean isInDeclare(int offset, DeclareStatement declareStatement) {
+        return declareStatement.getStartOffset() < offset && offset < declareStatement.getEndOffset();
+    }
+
+    private static int getDeclareEndPosition(int offset, List<DeclareStatement> declareStatements) {
+        for (DeclareStatement declareStatement : declareStatements) {
+            if (isInDeclare(offset, declareStatement)) {
+                return declareStatement.getEndOffset();
+            }
+        }
+        return -1;
+    }
+
     @CheckForNull
     private static ModelElement getLastUse(NamespaceScope namespaceScope, boolean group) {
         ModelElement offsetElement = null;
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php
new file mode 100644
index 000000000000..5df3a81f1e4c
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php
@@ -0,0 +1,40 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+    $test = 1;
+}
+declare(ticks=2) {
+    $test = 1;
+}
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new \NS2\DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php.fixUses b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php.fixUses
new file mode 100644
index 000000000000..172128cf90b0
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare03/testGH5578_declare03.php.fixUses
@@ -0,0 +1,42 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+    $test = 1;
+}
+declare(ticks=2) {
+    $test = 1;
+}
+
+use NS2\DeclareTest2;
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php
new file mode 100644
index 000000000000..efad688fe3ae
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php
@@ -0,0 +1,39 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+}
+declare(ticks=2) {
+    $test = 1;
+}
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new \NS2\DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php.fixUses b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php.fixUses
new file mode 100644
index 000000000000..24cfc5925cc0
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare04/testGH5578_declare04.php.fixUses
@@ -0,0 +1,41 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+}
+declare(ticks=2) {
+    $test = 1;
+}
+
+use NS2\DeclareTest2;
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php
new file mode 100644
index 000000000000..f75e0f9d335a
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php
@@ -0,0 +1,39 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+    $test = 1;
+}
+declare(ticks=2) {
+}
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new \NS2\DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php.fixUses b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php.fixUses
new file mode 100644
index 000000000000..97ad241fd58c
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/actions/testGH5578/declare05/testGH5578_declare05.php.fixUses
@@ -0,0 +1,41 @@
+<?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.
+ */
+namespace NS1;
+
+declare(ticks=1) {
+    $test = 1;
+}
+declare(ticks=2) {
+}
+
+use NS2\DeclareTest2;
+
+class DeclareTest1 {
+    public function test() {
+        declare(ticks=2) {
+            
+        }
+        $test = new DeclareTest2;
+    }
+}
+
+namespace NS2;
+
+class DeclareTest2 {}
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/actions/FixUsesPerformerTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/actions/FixUsesPerformerTest.java
index 5c719ce98c44..0e89b69e319d 100644
--- a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/actions/FixUsesPerformerTest.java
+++ b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/actions/FixUsesPerformerTest.java
@@ -620,6 +620,27 @@ public void testGH5578_declare02() throws Exception {
         performTest("^// test", selections, true, options);
     }
 
+    public void testGH5578_declare03() throws Exception {
+        List<Selection> selections = new ArrayList<>();
+        selections.add(new Selection("\\NS2\\DeclareTest2", ItemVariant.Type.CLASS));
+        Options options = new Options.Builder(PhpVersion.PHP_81).build();
+        performTest("class DeclareTest1 ^{", selections, true, options);
+    }
+
+    public void testGH5578_declare04() throws Exception {
+        List<Selection> selections = new ArrayList<>();
+        selections.add(new Selection("\\NS2\\DeclareTest2", ItemVariant.Type.CLASS));
+        Options options = new Options.Builder(PhpVersion.PHP_81).build();
+        performTest("class DeclareTest1 ^{", selections, true, options);
+    }
+
+    public void testGH5578_declare05() throws Exception {
+        List<Selection> selections = new ArrayList<>();
+        selections.add(new Selection("\\NS2\\DeclareTest2", ItemVariant.Type.CLASS));
+        Options options = new Options.Builder(PhpVersion.PHP_81).build();
+        performTest("class DeclareTest1 ^{", selections, true, options);
+    }
+
     private String getTestResult(final String fileName, final String caretLine, final List<Selection> selections, final boolean removeUnusedUses, final Options options) throws Exception {
         FileObject testFile = getTestFile(fileName);