PHP 8.3 Support: Arbitrary static variable initializers (Part 2)

- apache#6701
- apache#8073
- https://wiki.php.net/rfc/arbitrary_static_variable_initializers
- Fix the formatter
- Add unit tests
  - Formatter
  - Code Completion
  - GotoDeclaration and MarkOccurrences

php/php.editor/src/org/netbeans/modules/php/editor/indent/FormatVisitor.java

@@ -280,11 +280,18 @@ public void visit(StaticStatement node) {
         List<Expression> expressions = node.getExpressions();
         for (Expression expression : expressions) {
             addAllUntilOffset(expression.getStartOffset());
+            // e.g. static $variable = new class() {}
+            boolean addIndent = !(expression instanceof Assignment
+                    && isAnonymousClass(((Assignment) expression).getRightHandSide()));
             if (moveNext() && lastIndex < ts.index()) {
                 addFormatToken(formatTokens); // add the first token of the expression and then add the indentation
-                formatTokens.add(new FormatToken.IndentToken(ts.offset() + ts.token().length(), options.continualIndentSize));
+                if (addIndent) {
+                    formatTokens.add(new FormatToken.IndentToken(ts.offset() + ts.token().length(), options.continualIndentSize));
+                }
                 scan(expression);
-                formatTokens.add(new FormatToken.IndentToken(expression.getEndOffset(), -1 * options.continualIndentSize));
+                if (addIndent) {
+                    formatTokens.add(new FormatToken.IndentToken(expression.getEndOffset(), -1 * options.continualIndentSize));
+                }
             }
         }
     }

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.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.
+ */
+function test(): void {
+}
+
+class Example {
+    private int $field = 1;
+
+    public function method(): int {
+        return 1;
+    }
+
+    public function run(int $param1) : void {
+        static $example1 = test();
+        static $example2 = $param1;
+        static $example3 = $this->field;
+        static $example4 = $this->method();
+        static $example5 = new class() {};
+        static $example6 = new stdClass(...[0]);
+        static $example6 = new stdClass($param1);
+        static $example7 = new (Test);
+        static $example8 = new static;
+        static $example9 = $param1 <= 100 ? run($param1 + 1) : "Test $param1";
+        static $example10 = test(), $example11 = test();
+    }
+}
+
+$variable = 1;
+static $example1 = test();
+static $example2 = $variable;

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example1 = te|st();
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     test()                          [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_02.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example2 = $para|m1;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+VARIABLE   int $param1                     [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_03.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example3 = $this->fi|eld;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+VARIABLE   int field                       [PRIVATE]  Example

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_04.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example4 = $this->metho|d();
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     method()                        [PUBLIC]   Example

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_05.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example6 = new stdClass($param|1);
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+VARIABLE   int $param1                     [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_06.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example9 = $param1 <= 100 ? ru|n($param1 + 1) : "Test $param1";
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     run(int $param1)                [PUBLIC]   Example

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_07.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example9 = $param1 <= 100 ? run($param1 + 1) : "Test $param|1";
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+VARIABLE   int $param1                     [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_08.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example10 = tes|t(), $example11 = test();
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     test()                          [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_09.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example10 = test(), $example11 = tes|t();
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     test()                          [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_10.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example1 = te|st();
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+METHOD     test()                          [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/completion/lib/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_11.completion

@@ -0,0 +1,4 @@
+Code completion result for source line:
+static $example2 = $variab|le;
+(QueryType=COMPLETION, prefixSearch=true, caseSensitive=true)
+VARIABLE   int $variable                   [PUBLIC]   testArbitraryStaticVariableInitializers.php

php/php.editor/test/unit/data/testfiles/formatting/php83/arbitraryStaticVariableInitializers_01.php

@@ -0,0 +1,45 @@
+<?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.
+ */
+
+class Example {
+    private int $field = 1;
+
+    public function method(): int {
+        return 1;
+    }
+
+    public function run(int $param1) : void {
+static  $example1 =    rand();
+                static $example2 = $param1;
+          static $example3 =          $this->field;
+         static $example4 = $this-> method();
+            static $example5 =     new class() {};
+            static $example6 =     new stdClass(...[0]);
+        static $example6 =    new stdClass($param1);
+                   static $example7 =  new (Test);
+        static             $example8 =            new static;
+        static $example9 = $param1 <= 100 ?           run($param1 + 1) :          "Test $param1";
+                       static $example10 = rand(),           $example11 = rand();
+    }
+}
+
+$variable = 1;
+   static           $example1 =          rand();
+   static $example2                = $variable;

php/php.editor/test/unit/data/testfiles/formatting/php83/arbitraryStaticVariableInitializers_01.php.testArbitraryStaticVariableInitializers_01a.formatted

@@ -0,0 +1,49 @@
+<?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.
+ */
+
+class Example {
+
+    private int $field = 1;
+
+    public function method(): int {
+        return 1;
+    }
+
+    public function run(int $param1): void {
+        static $example1 = rand();
+        static $example2 = $param1;
+        static $example3 = $this->field;
+        static $example4 = $this->method();
+        static $example5 = new class() {
+
+        };
+        static $example6 = new stdClass(...[0]);
+        static $example6 = new stdClass($param1);
+        static $example7 = new (Test);
+        static $example8 = new static;
+        static $example9 = $param1 <= 100 ? run($param1 + 1) : "Test $param1";
+        static $example10 = rand(), $example11 = rand();
+    }
+}
+
+$variable = 1;
+static $example1 = rand();
+static $example2 = $variable;

php/php.editor/test/unit/data/testfiles/gotodeclaration/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php

@@ -0,0 +1,45 @@
+<?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.
+ */
+
+class Example {
+    private int $field = 1;
+
+    public function method(): int {
+        return 1;
+    }
+
+    public function run(int $param1) : void {
+        static $example1 = rand();
+        static $example2 = $param1;
+        static $example3 = $this->field;
+        static $example4 = $this->method();
+        static $example5 = new class() {};
+        static $example6 = new stdClass(...[0]);
+        static $example6 = new stdClass($param1);
+        static $example7 = new (Test);
+        static $example8 = new static;
+        static $example9 = $param1 <= 100 ? run($param1 + 1) : "Test $param1";
+        static $example10 = rand(), $example11 = rand();
+    }
+}
+
+$variable = 1;
+static $example1 = rand();
+static $example2 = $variable;

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php

@@ -0,0 +1,45 @@
+<?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.
+ */
+
+class Example {
+    private int $field = 1;
+
+    public function method(): int {
+        return 1;
+    }
+
+    public function run(int $param1) : void {
+        static $example1 = rand();
+        static $example2 = $param1;
+        static $example3 = $this->field;
+        static $example4 = $this->method();
+        static $example5 = new class() {};
+        static $example6 = new stdClass(...[0]);
+        static $example6 = new stdClass($param1);
+        static $example7 = new (Test);
+        static $example8 = new static;
+        static $example9 = $param1 <= 100 ? run($param1 + 1) : "Test $param1";
+        static $example10 = rand(), $example11 = rand();
+    }
+}
+
+$variable = 1;
+static $example1 = rand();
+static $example2 = $variable;

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01a.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:par^am1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:param1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:param1<|);
+        static $example9 = $|>MARK_OCCURRENCES:param1<| <= 100 ? run($|>MARK_OCCURRENCES:param1<| + 1) : "Test $|>MARK_OCCURRENCES:param1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01b.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:param1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:para^m1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:param1<|);
+        static $example9 = $|>MARK_OCCURRENCES:param1<| <= 100 ? run($|>MARK_OCCURRENCES:param1<| + 1) : "Test $|>MARK_OCCURRENCES:param1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01c.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:param1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:param1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:para^m1<|);
+        static $example9 = $|>MARK_OCCURRENCES:param1<| <= 100 ? run($|>MARK_OCCURRENCES:param1<| + 1) : "Test $|>MARK_OCCURRENCES:param1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01d.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:param1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:param1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:param1<|);
+        static $example9 = $|>MARK_OCCURRENCES:para^m1<| <= 100 ? run($|>MARK_OCCURRENCES:param1<| + 1) : "Test $|>MARK_OCCURRENCES:param1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01e.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:param1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:param1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:param1<|);
+        static $example9 = $|>MARK_OCCURRENCES:param1<| <= 100 ? run($|>MARK_OCCURRENCES:p^aram1<| + 1) : "Test $|>MARK_OCCURRENCES:param1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_01f.occurrences

@@ -0,0 +1,4 @@
+    public function run(int $|>MARK_OCCURRENCES:param1<|) : void {
+        static $example2 = $|>MARK_OCCURRENCES:param1<|;
+        static $example6 = new stdClass($|>MARK_OCCURRENCES:param1<|);
+        static $example9 = $|>MARK_OCCURRENCES:param1<| <= 100 ? run($|>MARK_OCCURRENCES:param1<| + 1) : "Test $|>MARK_OCCURRENCES:para^m1<|";

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_02a.occurrences

@@ -0,0 +1,2 @@
+    private int $|>MARK_OCCURRENCES:fie^ld<| = 1;
+        static $example3 = $this->|>MARK_OCCURRENCES:field<|;

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_02b.occurrences

@@ -0,0 +1,2 @@
+    private int $|>MARK_OCCURRENCES:field<| = 1;
+        static $example3 = $this->|>MARK_OCCURRENCES:fiel^d<|;

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_03a.occurrences

@@ -0,0 +1,2 @@
+    public function |>MARK_OCCURRENCES:met^hod<|(): int {
+        static $example4 = $this->|>MARK_OCCURRENCES:method<|();

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_03b.occurrences

@@ -0,0 +1,2 @@
+    public function |>MARK_OCCURRENCES:method<|(): int {
+        static $example4 = $this->|>MARK_OCCURRENCES:meth^od<|();

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_04a.occurrences

@@ -0,0 +1,2 @@
+$|>MARK_OCCURRENCES:vari^able<| = 1;
+static $example2 = $|>MARK_OCCURRENCES:variable<|;

php/php.editor/test/unit/data/testfiles/markoccurences/php83/testArbitraryStaticVariableInitializers/testArbitraryStaticVariableInitializers.php.testArbitraryStaticVariableInitializers_04b.occurrences

@@ -0,0 +1,2 @@
+$|>MARK_OCCURRENCES:variable<| = 1;
+static $example2 = $|>MARK_OCCURRENCES:varia^ble<|;