Merge pull request apache#5731 from junichi11/php-gh-4611-formatter-b…

…efore-class-end

Prioritize "Before Class End" of Blank Lines Option apache#4611

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

@@ -600,7 +600,7 @@ public void visit(Block node) {
                 formatTokens.add(new FormatToken.IndentToken(ts.offset(), options.indentSize));
             }
 
-            if (parent instanceof ClassDeclaration || parent instanceof InterfaceDeclaration || parent instanceof TraitDeclaration) {
+            if (isTypeNode(parent)) {
                 formatTokens.add(new FormatToken(FormatToken.Kind.WHITESPACE_AFTER_CLASS_LEFT_BRACE, ts.offset()));
             } else if (isAnonymousClass(parent)) {
                 formatTokens.add(new FormatToken(FormatToken.Kind.WHITESPACE_AFTER_ANONYMOUS_CLASS_LEFT_BRACE, ts.offset()));

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

@@ -742,7 +742,7 @@ public void run() {
                                         indentRule = true;
                                         ws = countWhiteSpaceBeforeRightBrace(
                                                 docOptions.classDeclBracePlacement,
-                                                newLines,
+                                                docOptions.blankLinesBeforeClassEnd + 1, // GH-46111 ignore existing newLines to prioritize this option
                                                 docOptions.blankLinesBeforeClassEnd,
                                                 indent,
                                                 formatTokens,

php/php.editor/test/unit/data/testfiles/formatting/alignment/alignmentKeywords01.php.formatted

@@ -67,7 +67,6 @@ class Example {
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/alignmentKeywords02.php.formatted

@@ -67,7 +67,6 @@ class Example {
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/alignmentKeywords03.php.formatted

@@ -82,7 +82,6 @@ class Example
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/alignmentKeywords04.php.formatted

@@ -71,7 +71,6 @@ class Example
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/groupAlignmentArrayInit01.php.formatted

@@ -35,7 +35,6 @@ class test {
             "shor"     => 222
         );
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/groupAlignmentAssignment01.php.formatted

@@ -35,7 +35,6 @@ class test {
             "shor" => 222
         );
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/issue209030.php.formatted

@@ -11,7 +11,6 @@ class Foo {
             //
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/issue211482.php.formatted

@@ -26,7 +26,6 @@ class A {
 
         $quiteLongVariable = "long";
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/alignment/issue218847.php.formatted

@@ -36,7 +36,6 @@ abstract
             function functionName3() {
 
     }
-
 }
 
 class Foo {
@@ -52,7 +51,6 @@ trait Trt {
             function foo() {
 
     }
-
 }
 
 interface Iface {

php/php.editor/test/unit/data/testfiles/formatting/alignment/issue230798.php.formatted

@@ -5,7 +5,6 @@ class Dummy {
     private $barbarbarbar = 'b';
     protected $snafu      = 'c';
     public $foo           = 'a';
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/anonymousClass.php.formatted

@@ -24,7 +24,6 @@ class MyClass extends BaseClass {
             }
         };
     }
-
 }
 
 $anonClass = new class {

php/php.editor/test/unit/data/testfiles/formatting/arrays3.php.formatted

@@ -20,7 +20,6 @@ class Test {
       "Item 3" => 3
   );
   public $number2 = 1;
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/arrays5.php.formatted

@@ -9,7 +9,6 @@ class Test {
             echo "false";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/arrowFunctions01.php.formatted

@@ -98,5 +98,4 @@ class ArrowFunctions {
     public static function new() {
         return new ArrowFunctions();
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/BracePlacement01.php.formatted

@@ -74,7 +74,6 @@ class Example
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/BracePlacement02.php.formatted

@@ -74,7 +74,6 @@ class Example
             echo 'Caught exception: ' . $e->getMessage() . "\n";
             }
         }
-
     }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/BracePlacement03.php.formatted

@@ -56,7 +56,6 @@ class Example {
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Class01.php.formatted

@@ -10,7 +10,6 @@ class BaseClass {
     final public function moreTesting() {
         echo "BaseClass::moreTesting() called\n";
     }
-
 }
 
 final class ChildClass extends BaseClass {
@@ -21,13 +20,11 @@ final class ChildClass extends BaseClass {
     public function method1() {
 
     }
-
 }
 
 final class ChildClass2 extends BaseClass {
 
     public $field2 = 22;
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Class03.php.formatted

@@ -64,7 +64,6 @@ class Example
             echo 'Caught exception: ' . $e->getMessage() . "\n";
         }
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility01.php.formatted

@@ -6,5 +6,4 @@ class ClassConstantVisibility {
     public const PUBLIC_CONST = 1;
     private const PRIVATE_CONST = [1, 2];
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility02.php.formatted

@@ -6,5 +6,4 @@ class ClassConstantVisibility {
     public const PUBLIC_CONST = 1;
     private const PRIVATE_CONST = [1, 2];
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility03.php.formatted

@@ -21,5 +21,4 @@ class ClassConstantVisibility {
      * PROTECTED_CONST
      */
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility04.php.formatted

@@ -21,5 +21,4 @@ class ClassConstantVisibility {
      * PROTECTED_CONST
      */
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility05.php.formatted

@@ -9,5 +9,4 @@ class ClassConstantVisibility {
     private const PRIVATE_CONST = [1, 2];
 
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility06.php.formatted

@@ -9,5 +9,4 @@ class ClassConstantVisibility {
     private const PRIVATE_CONST = [1, 2];
 
     protected const PROTECTED_CONST = "";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility07.php.formatted

@@ -13,5 +13,4 @@ class ClassConstantVisibility {
     public function publicFunction() {
 
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/ClassConstantVisibility08.php.formatted

@@ -10,5 +10,4 @@ class ClassConstantVisibility {
     public function publicFunction() {
 
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields01.php.formatted

@@ -3,5 +3,4 @@
 class Simple {
 
     public $field1 = 22;
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields02.php.formatted

@@ -4,5 +4,4 @@ class Simple {
 
     public $field1 = 22;
     public $field2 = "ahoj";
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields03.php.formatted

@@ -7,5 +7,4 @@ class Simple {
      * @var int
      */
     public $field1 = 22;
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields04.php.formatted

@@ -7,5 +7,4 @@ class Simple {
      * @var int
      */
     public $field1 = 22;
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields05.php.formatted

@@ -8,5 +8,4 @@ class Simple {
     // comment 3
 
     public $field2;
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields06.php.formatted

@@ -11,5 +11,4 @@ class Simple {
     public function method01() {
 
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields07.php.formatted

@@ -13,5 +13,4 @@ class Simple {
     public function method01() {
 
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields08.php.formatted

@@ -28,5 +28,4 @@ class Test {
         $this->field2 = $field2;
         $this->field3 = $field3;
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields09.php.formatted

@@ -34,5 +34,4 @@ class Test {
         $this->field2 = $field2;
         $this->field3 = $field3;
     }
-
 }

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields10.php.formatted

@@ -11,7 +11,6 @@ class Connection {
      * comment for field2
      */
     public $field2;
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Fields11.php.formatted

@@ -6,7 +6,6 @@ class Connection {
 
 
     public $field2;
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/Function04.php.formatted

@@ -9,7 +9,6 @@ final class TestFianl extends Bla {
     public function test2() {
 
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass01.php.formatted

@@ -9,7 +9,6 @@ class SimpleClass {
     public function displayVar() {
         echo $this->var;
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass02.php.formatted

@@ -12,7 +12,6 @@ class SimpleClass {
     public function displayVar() {
         echo $this->var;
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass04.php.formatted

@@ -20,7 +20,6 @@ class Item {
         return "You ordered ($this->qty) '$this->name'" . ($this->qty == 1 ? "" : "s") .
                 " at \$$this->price, for a total of: \$$this->total.";
     }
-
 }
 
 echo (new Item("Widget 22", 4.90, 2));

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass11.php.formatted

@@ -4,6 +4,5 @@ class class_name {
     public function test() {
 
     }
-
 }
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass13.php.formatted

@@ -5,7 +5,6 @@ class class_name { // test
     public function test() {
 
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass14.php.formatted

@@ -5,7 +5,6 @@ class class_name {
     public function test() {
 
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass15.php.formatted

@@ -5,7 +5,6 @@ class class_name {
     public function test() {
 
     }
-
 }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass16.php.formatted

@@ -7,7 +7,6 @@ class class_name
         {
 
         }
-
     }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleClass17.php.formatted

@@ -7,7 +7,6 @@
             {
 
             }
-
         }
 
 ?>

php/php.editor/test/unit/data/testfiles/formatting/blankLines/SimpleTrait01.php.formatted

@@ -9,7 +9,6 @@ trait SimpleClass {
     public function displayVar() {
         echo $this->var;
     }
-
 }
 
 ?>