Remove unnecessary @Formatter comments

Christian Wimmer · Christian Wimmer · commit 16a63497cf30 · 2022-01-07T13:04:21.000-08:00
diff --git a/substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/meta/AnalysisField.java b/substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/meta/AnalysisField.java
@@ -208,38 +208,6 @@ public TypeState getInstanceFieldTypeState() {
         return interceptTypeState(instanceFieldFlow.getState());
     }
 
-    // @formatter:off
-//    public TypeState getInstanceFieldTypeState() {
-//        if (instanceFieldTypeState == null) {
-//
-//            /* Collect the types of all instance field flows. */
-//            HashSet<AnalysisType> fieldTypes = new HashSet<>();
-//            boolean fieldCanBeNull = false;
-//
-//            fieldCanBeNull = collectInstanceFieldTypes(getDeclaringClass(), fieldTypes);
-//            instanceFieldTypeState = TypeState.forExactTypes(null, new ArrayList<>(fieldTypes), fieldCanBeNull);
-//
-//        }
-//        return instanceFieldTypeState;
-//    }
-
-//    private boolean collectInstanceFieldTypes(AnalysisType type, HashSet<AnalysisType> fieldTypes) {
-//        boolean fieldCanBeNull = false;
-//
-//        TypeFlow<?> fieldFlow = type.getAbstractObject().getInstanceFieldFlow(null, this, false);
-//        if (fieldFlow != null) {
-//            TypeState mergedState = fieldFlow.getState();
-//            mergedState.typesIterator().forEachRemaining(fieldTypes::add);
-//            fieldCanBeNull |= mergedState.canBeNull();
-//        }
-//
-//        for (AnalysisType subClass : type.subTypes) {
-//            fieldCanBeNull |= collectInstanceFieldTypes(subClass, fieldTypes);
-//        }
-//        return fieldCanBeNull;
-//    }
-    //@formatter:on
-
     public FieldTypeFlow getInitialInstanceFieldFlow() {
         return initialInstanceFieldFlow;
     }
diff --git a/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/elf/ELFObjectFile.java b/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/elf/ELFObjectFile.java
@@ -880,15 +880,13 @@ public String toString() {
             if (isNullEntry()) {
                 return "SHT NULL Entry";
             }
-            //@formatter:off
-            return new StringBuilder("SHT Entry: ").
-             append(String.format("\n  %s", type)).
-             append(String.format("\n  flags %#x", flags)).
-             append(String.format("\n  virtual address %#x", virtualAddress)).
-             append(String.format("\n  offset %#x (%1$d), size %d", fileOffset, sectionSize)).
-             append(String.format("\n  link %#x, info %#x, align %#x, entry size %#x (%4$d)", link, info, addrAlign, entrySize)).
-             append("\n").toString();
-            //@formatter:on
+            return new StringBuilder("SHT Entry: ")
+                            .append(String.format("\n  %s", type))
+                            .append(String.format("\n  flags %#x", flags))
+                            .append(String.format("\n  virtual address %#x", virtualAddress))
+                            .append(String.format("\n  offset %#x (%1$d), size %d", fileOffset, sectionSize))
+                            .append(String.format("\n  link %#x, info %#x, align %#x, entry size %#x (%4$d)", link, info, addrAlign, entrySize))
+                            .append("\n").toString();
         }
 
         public boolean isNullEntry() {
diff --git a/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachOObjectFile.java b/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachOObjectFile.java
@@ -42,6 +42,9 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.Platform;
+
 import com.oracle.objectfile.BasicProgbitsSectionImpl;
 import com.oracle.objectfile.BuildDependency;
 import com.oracle.objectfile.ElementImpl;
@@ -52,8 +55,6 @@
 import com.oracle.objectfile.SymbolTable;
 import com.oracle.objectfile.io.AssemblyBuffer;
 import com.oracle.objectfile.io.OutputAssembler;
-import org.graalvm.nativeimage.ImageSingletons;
-import org.graalvm.nativeimage.Platform;
 
 /**
  * Models a Mach-O relocatable object file.
@@ -1280,28 +1281,12 @@ private int overapproximateSize() {
             return size;
         }
 
-        //@formatter:off
-//        @Override
-//        public int getOrDecideSize(Map<Element, LayoutDecisionMap> alreadyDecided, int sizeHint) {
-//            /*
-//             * HACK HACK HACK: since the content is ULEB128 variable-length-encoded, we need to
-//             * compute our content before we can compute our size. BUT this gives us cyclic build
-//             * dependencies because of Mach-O's messed-up segment structure (FIXME: find out exactly
-//             * what is creating the cycles). So we overapproximate our size based on the biggest
-//             * function-to-function offset we think is likely.
-//             */
-//            return overapproximateSize();
-//        }
-        //@formatter:on
-
-        //@formatter:off
         @Override
         public int getOrDecideSize(java.util.Map<Element, LayoutDecisionMap> alreadyDecided, int sizeHint) {
             Object decidedContent = alreadyDecided.get(this).getDecidedValue(LayoutDecision.Kind.CONTENT);
             assert decidedContent != null;
             return ((byte[]) decidedContent).length;
         }
-        //@formatter:on
 
         @Override
         public Iterable<BuildDependency> getDependencies(Map<Element, LayoutDecisionMap> decisions) {
@@ -1520,8 +1505,7 @@ public long value() {
 
     public abstract class MachOSection extends ObjectFile.Section {
 
-        // @formatter:off
-        /* We have no fields except type & flags! Mach-O section64 struct's fields are
+        /*- We have no fields except type & flags! Mach-O section64 struct's fields are
          * modelled as follows:
          * sectname: in the ObjectFile's element name map
          * segname: explicitly if relocatable file, else in the ObjectFile's segments list
@@ -1534,7 +1518,6 @@ public abstract class MachOSection extends ObjectFile.Section {
          * flags: we DO have this one
          * reserved1, reserved2: saved for a "symbol stub section" subclass, if we need it
          */
-        // @formatter:on
 
         SectionType type;
         EnumSet<SectionFlag> flags;
@@ -2019,20 +2002,18 @@ protected void writePayload(OutputAssembler db, final Map<Element, LayoutDecisio
                  */
                 assert s.destinationSegmentName != null;
 
-                //@formatter:off
                 SectionInfoStruct si = new SectionInfoStruct(
-                    s.getName(),
-                    s.destinationSegmentName,
-                    s.getElement().isReferenceable() ? (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.VADDR) : 0,
-                    (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.SIZE),
-                    (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.OFFSET),
-                    logAlignment,
-                    ourRelocs == null ? 0 : (int) alreadyDecided.get(ourRelocs).getDecidedValue(LayoutDecision.Kind.OFFSET) + ourRelocs.startIndexFor(s) * ourRelocs.encodedEntrySize(),
-                    ourRelocs == null ? 0 : ourRelocs.countFor(s),
-                    (int) ObjectFile.flagSetAsLong(s.flags) | s.type.getValue(),
-                    /* reserved1 */ 0,
-                    /* reserved2 */ 0);
-                //@formatter:on
+                                s.getName(),
+                                s.destinationSegmentName,
+                                s.getElement().isReferenceable() ? (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.VADDR) : 0,
+                                (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.SIZE),
+                                (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.OFFSET),
+                                logAlignment,
+                                ourRelocs == null ? 0 : (int) alreadyDecided.get(ourRelocs).getDecidedValue(LayoutDecision.Kind.OFFSET) + ourRelocs.startIndexFor(s) * ourRelocs.encodedEntrySize(),
+                                ourRelocs == null ? 0 : ourRelocs.countFor(s),
+                                (int) ObjectFile.flagSetAsLong(s.flags) | s.type.getValue(),
+                                /* reserved1 */ 0,
+                                /* reserved2 */ 0);
                 int startPos = db.pos();
                 si.write(db);
                 assert db.pos() - startPos == SectionInfoStruct.DEFAULT_SIZE;
diff --git a/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachORelocationElement.java b/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachORelocationElement.java
@@ -322,13 +322,11 @@ public void write(OutputAssembler oa, @SuppressWarnings("unused") Map<Element, L
          * case-splitting for endianness.
          */
         int remainingWord = 0;
-        //@formatter:off
         remainingWord |= symbolNum & 0x00ffffff;
         remainingWord |= (kind.isPCRelative() ? 1 : 0) << 24;
-        remainingWord |=            (log2length & 0x3) << 25;
-        remainingWord |=          (isExtern() ? 1 : 0) << 27;
-        remainingWord |=       (kind.getValue() & 0xf) << 28;
-        //@formatter:on
+        remainingWord |= (log2length & 0x3) << 25;
+        remainingWord |= (isExtern() ? 1 : 0) << 27;
+        remainingWord |= (kind.getValue() & 0xf) << 28;
         oa.write4Byte(remainingWord);
         assert oa.pos() - startPos == 8; // check we wrote how much we expected
     }
diff --git a/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachOUserDefinedSection.java b/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachOUserDefinedSection.java
@@ -199,12 +199,10 @@ private void handleAArch64RelocationAddend(MachORelocationElement el, AssemblyBu
             case AARCH64_R_AARCH64_LDST8_ABS_LO12_NC:
             case AARCH64_R_AARCH64_ADD_ABS_LO12_NC:
                 if (addend != 0) {
-                    /*
+                    /*-
                      * According to the Mach-O ld code at:
                      *
-                     * @formatter:off
                      * https://opensource.apple.com/source/ld64/ld64-274.2/src/ld/parsers/macho_relocatable_file.cpp.auto.html
-                     * @formatter:on
                      *
                      * These relocations should use an explicit addend relocation record (ARM64_RELOC_ADDEND) instead of an
                      * implicit addend.
diff --git a/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/pecoff/PECoffMachine.java b/substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/pecoff/PECoffMachine.java
@@ -27,9 +27,9 @@
 
 import com.oracle.objectfile.ObjectFile.RelocationKind;
 import com.oracle.objectfile.ObjectFile.RelocationMethod;
-import com.oracle.objectfile.pecoff.PECoffRelocationTable.PECoffRelocationMethod;
 import com.oracle.objectfile.pecoff.PECoff.IMAGE_FILE_HEADER;
 import com.oracle.objectfile.pecoff.PECoff.IMAGE_RELOCATION;
+import com.oracle.objectfile.pecoff.PECoffRelocationTable.PECoffRelocationMethod;
 
 /**
  * PECoff machine type (incomplete). Each machine type also defines its set of relocation types.
@@ -93,8 +93,7 @@ public static PECoffMachine getSystemNativeValue() {
     }
 }
 
-/**
- * @formatter:off
+/*-
  *
  * IMAGE_REL_AMD64_ABSOLUTE 0x0000 // Reference is absolute, no relocation is necessary
  * IMAGE_REL_AMD64_ADDR64 0x0001   // 64-bit address (VA).
@@ -112,8 +111,6 @@ public static PECoffMachine getSystemNativeValue() {
  * IMAGE_REL_AMD64_TOKEN 0x000D    // 32 bit metadata token
  * IMAGE_REL_AMD64_SREL32 0x000E   // 32 bit signed span-dependent value emitted into object
  * IMAGE_REL_AMD64_PAIR 0x000F IMAGE_REL_AMD64_SSPAN32 0x0010 // 32 bit signed span-dependent value applied at link time
- *
- * @formatter:on
  */
 enum PECoffX86_64Relocation implements PECoffRelocationMethod {
     ADDR64 {
diff --git a/substratevm/src/com.oracle.svm.core.genscavenge/src/com/oracle/svm/core/genscavenge/HeapImpl.java b/substratevm/src/com.oracle.svm.core.genscavenge/src/com/oracle/svm/core/genscavenge/HeapImpl.java
@@ -296,7 +296,6 @@ static Log zapValuesToLog(Log log) {
         if (HeapParameters.getZapProducedHeapChunks() || HeapParameters.getZapConsumedHeapChunks()) {
             log.string("[Heap Chunk zap values: ").indent(true);
             /* Padded with spaces so the columns line up between the int and word variants. */
-            // @formatter:off
             if (HeapParameters.getZapProducedHeapChunks()) {
                 log.string("  producedHeapChunkZapInt: ")
                                 .string("  hex: ").spaces(8).hex(HeapParameters.getProducedHeapChunkZapInt())
@@ -321,7 +320,6 @@ static Log zapValuesToLog(Log log) {
                                 .string("  unsigned: ").unsigned(HeapParameters.getConsumedHeapChunkZapWord());
             }
             log.redent(false).string("]");
-            // @formatter:on
         }
         return log;
     }
diff --git a/substratevm/src/com.oracle.svm.core.genscavenge/src/com/oracle/svm/core/genscavenge/ObjectHeaderImpl.java b/substratevm/src/com.oracle.svm.core.genscavenge/src/com/oracle/svm/core/genscavenge/ObjectHeaderImpl.java
@@ -24,7 +24,6 @@
  */
 package com.oracle.svm.core.genscavenge;
 
-import com.oracle.svm.core.annotate.AlwaysInline;
 import org.graalvm.compiler.api.directives.GraalDirectives;
 import org.graalvm.compiler.api.replacements.Fold;
 import org.graalvm.compiler.core.common.CompressEncoding;
@@ -41,6 +40,7 @@
 import org.graalvm.word.WordFactory;
 
 import com.oracle.svm.core.SubstrateOptions;
+import com.oracle.svm.core.annotate.AlwaysInline;
 import com.oracle.svm.core.annotate.Uninterruptible;
 import com.oracle.svm.core.config.ConfigurationValues;
 import com.oracle.svm.core.config.ObjectLayout;
@@ -62,16 +62,13 @@
  * {@link Heap#isInImageHeap}.
  */
 public final class ObjectHeaderImpl extends ObjectHeader {
-    // @formatter:off
-    //                                Name                            Value
-    private static final UnsignedWord UNALIGNED_BIT                 = WordFactory.unsigned(0b001);
-    private static final UnsignedWord REMEMBERED_SET_BIT            = WordFactory.unsigned(0b010);
-    private static final UnsignedWord FORWARDED_BIT                 = WordFactory.unsigned(0b100);
-
-    private static final int RESERVED_BITS_MASK                     = 0b111;
-    private static final UnsignedWord MASK_HEADER_BITS              = WordFactory.unsigned(RESERVED_BITS_MASK);
-    private static final UnsignedWord CLEAR_HEADER_BITS             = MASK_HEADER_BITS.not();
-    // @formatter:on
+    private static final UnsignedWord UNALIGNED_BIT = WordFactory.unsigned(0b001);
+    private static final UnsignedWord REMEMBERED_SET_BIT = WordFactory.unsigned(0b010);
+    private static final UnsignedWord FORWARDED_BIT = WordFactory.unsigned(0b100);
+
+    private static final int RESERVED_BITS_MASK = 0b111;
+    private static final UnsignedWord MASK_HEADER_BITS = WordFactory.unsigned(RESERVED_BITS_MASK);
+    private static final UnsignedWord CLEAR_HEADER_BITS = MASK_HEADER_BITS.not();
 
     @Platforms(Platform.HOSTED_ONLY.class)
     ObjectHeaderImpl() {
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/SubstrateUtil.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/SubstrateUtil.java
@@ -362,16 +362,14 @@ public static String mangleName(String methodName) {
         }
         String mangled = out.toString();
         assert mangled.matches("[a-zA-Z\\._][a-zA-Z0-9_]*");
-        //@formatter:off
-        /*
+        /*-
          * To demangle, the following pipeline works for me (assuming no multi-byte characters):
          *
          * sed -r 's/\_([0-9a-f]{4})/\n\1\n/g' | sed -r 's#^[0-9a-f]{2}([0-9a-f]{2})#/usr/bin/printf "\\x\1"#e' | tr -d '\n'
          *
          * It's not strictly correct if the first characters after an escape sequence
          * happen to match ^[0-9a-f]{2}, but hey....
          */
-        //@formatter:on
         return mangled;
     }
 
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaAWTSubstitutions.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaAWTSubstitutions.java
@@ -212,14 +212,13 @@ public synchronized boolean init() {
                 fcm.populateFontConfig(fcCompFonts);
             }
 
-            // @formatter:off
-            /*
+            /*-
             The below code was part of the original method but has been removed in the substitution. In a native-image,
             java.home is set to null, so executing it would result in an exception.
             The #getInstalledFallbackFonts method is in charge of installing fallback fonts shipped with the JDK. If the
             fallback font directory does not exist, it is a no-op. As we do not have a JDK available at native-image
             runtime, we can safely remove the call.
-
+            
             // NB already in a privileged block from SGE
             String javaHome = System.getProperty("java.home");
             if (javaHome == null) {
@@ -228,7 +227,6 @@ public synchronized boolean init() {
             String javaLib = javaHome + File.separator + "lib";
             getInstalledFallbackFonts(javaLib);
              */
-            // @formatter:on
 
             return fcCompFonts != null; // couldn't load fontconfig.
         }
diff --git a/substratevm/src/com.oracle.svm.graal.hotspot.libgraal/src/com/oracle/svm/graal/hotspot/libgraal/LibGraalFeature.java b/substratevm/src/com.oracle.svm.graal.hotspot.libgraal/src/com/oracle/svm/graal/hotspot/libgraal/LibGraalFeature.java
@@ -159,16 +159,14 @@
 import jdk.vm.ci.services.Services;
 
 class LibGraalOptions {
-    // @formatter:off
     @Option(help = "Converts an exception triggered by the CrashAt option into a fatal error " +
-            "if a non-null pointer was passed in the _fatal option to JNI_CreateJavaVM. " +
-            "This option exists for the purpose of testing fatal error handling in libgraal.")
+                    "if a non-null pointer was passed in the _fatal option to JNI_CreateJavaVM. " +
+                    "This option exists for the purpose of testing fatal error handling in libgraal.") //
     static final RuntimeOptionKey<Boolean> CrashAtIsFatal = new RuntimeOptionKey<>(false);
     @Option(help = "The fully qualified name of a no-arg, void, static method to be invoked " +
-            "in HotSpot from libgraal when the libgraal isolate is being shutdown." +
-            "This option exists for the purpose of testing callbacks in this context.")
-            static final RuntimeOptionKey<String> OnShutdownCallback = new RuntimeOptionKey<>(null);
-    // @formatter:on
+                    "in HotSpot from libgraal when the libgraal isolate is being shutdown." +
+                    "This option exists for the purpose of testing callbacks in this context.") //
+    static final RuntimeOptionKey<String> OnShutdownCallback = new RuntimeOptionKey<>(null);
 }
 
 public final class LibGraalFeature implements com.oracle.svm.core.graal.GraalFeature {
diff --git a/substratevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/JNIJavaVMList.java b/substratevm/src/com.oracle.svm.jni/src/com/oracle/svm/jni/JNIJavaVMList.java
@@ -49,7 +49,7 @@
  * never shrinks.
  */
 public class JNIJavaVMList {
-    /* @formatter:off
+    /*-
      *
      * HEAD  -->  +------------------------+
      *            | capacity: UnsignedWord |
@@ -62,7 +62,6 @@ public class JNIJavaVMList {
      *                                             | ...      |
      *                                             | next     |  -->  null
      *                                             +----------+
-     * @formatter:on
      */
 
     private static final UnsignedWord INITIAL_CAPACITY = unsigned(8);

Original file line number	Diff line number	Diff line change
`@@ -199,12 +199,10 @@ private void handleAArch64RelocationAddend(MachORelocationElement el, AssemblyBu`
`199`	`199`	`case AARCH64_R_AARCH64_LDST8_ABS_LO12_NC:`
`200`	`200`	`case AARCH64_R_AARCH64_ADD_ABS_LO12_NC:`
`201`	`201`	`if (addend != 0) {`
`202`		`- /*`
	`202`	`+ /*-`
`203`	`203`	`* According to the Mach-O ld code at:`
`204`	`204`	`*`
`205`		`- * @formatter:off`
`206`	`205`	`* https://opensource.apple.com/source/ld64/ld64-274.2/src/ld/parsers/macho_relocatable_file.cpp.auto.html`
`207`		`- * @formatter:on`
`208`	`206`	`*`
`209`	`207`	`* These relocations should use an explicit addend relocation record (ARM64_RELOC_ADDEND) instead of an`
`210`	`208`	`* implicit addend.`
Original file line number	Diff line number	Diff line change
`@@ -296,7 +296,6 @@ static Log zapValuesToLog(Log log) {`
`296`	`296`	`if (HeapParameters.getZapProducedHeapChunks() \|\| HeapParameters.getZapConsumedHeapChunks()) {`
`297`	`297`	`log.string("[Heap Chunk zap values: ").indent(true);`
`298`	`298`	`/* Padded with spaces so the columns line up between the int and word variants. */`
`299`		`- // @formatter:off`
`300`	`299`	`if (HeapParameters.getZapProducedHeapChunks()) {`
`301`	`300`	`log.string(" producedHeapChunkZapInt: ")`
`302`	`301`	`.string(" hex: ").spaces(8).hex(HeapParameters.getProducedHeapChunkZapInt())`
`@@ -321,7 +320,6 @@ static Log zapValuesToLog(Log log) {`
`321`	`320`	`.string(" unsigned: ").unsigned(HeapParameters.getConsumedHeapChunkZapWord());`
`322`	`321`	`}`
`323`	`322`	`log.redent(false).string("]");`
`324`		`- // @formatter:on`
`325`	`323`	`}`
`326`	`324`	`return log;`
`327`	`325`	`}`
Original file line number	Diff line number	Diff line change
`@@ -362,16 +362,14 @@ public static String mangleName(String methodName) {`
`362`	`362`	`}`
`363`	`363`	`String mangled = out.toString();`
`364`	`364`	`assert mangled.matches("[a-zA-Z\\._][a-zA-Z0-9_]*");`
`365`		`- //@formatter:off`
`366`		`- /*`
	`365`	`+ /*-`
`367`	`366`	`* To demangle, the following pipeline works for me (assuming no multi-byte characters):`
`368`	`367`	`*`
`369`	`368`	`* sed -r 's/\_([0-9a-f]{4})/\n\1\n/g' \| sed -r 's#^[0-9a-f]{2}([0-9a-f]{2})#/usr/bin/printf "\\x\1"#e' \| tr -d '\n'`
`370`	`369`	`*`
`371`	`370`	`* It's not strictly correct if the first characters after an escape sequence`
`372`	`371`	`* happen to match ^[0-9a-f]{2}, but hey....`
`373`	`372`	`*/`
`374`		`- //@formatter:on`
`375`	`373`	`return mangled;`
`376`	`374`	`}`
`377`	`375`