Merge pull request #19 in G/truffle from ~CHRISTIAN.HUMER_ORACLE.COM/truffle:pr/update-format-to-eclipse-45 to master

The Travis gate already uses already the new formatter and fails because of that.
The new formatter changes comment formatting slightly, as well as whitespace handling in some corner cases.
This patch is the result of running mx gate with ECLIPSE_EXE pointing to an Eclipse 4.5.2
Signed-off-by: Stefan Marr [email protected]

* commit '3ae44b7d5fb30c7c7b7bd3668f335b982292a2b5':
  Use 4.5.2 instead of 4.5.1.
  Update hocon file to use 4.5.1 as Eclipse version.
  Update Truffle formatter to Eclipse 4.5.2

Author: chumer

ci.hocon

@@ -2,7 +2,7 @@ java7 : {name : oraclejdk, version : "7",    platformspecific: true}
 java8 : {name : oraclejdk, version : "8u66", platformspecific: true}
 #java9 : {name : oraclejdk, version : "9",    platformspecific: true}
 ecj : {name: ecj, version: "4.5.1", platformspecific: false}
-eclipse : {name: eclipse, version: "4.3.0", platformspecific: true}
+eclipse : {name: eclipse, version: "4.5.2", platformspecific: true}
 
 common : {
   packages : {

truffle/com.oracle.truffle.api.debug/src/com/oracle/truffle/api/debug/Debugger.java

@@ -288,7 +288,8 @@ void prepareStepInto(int stepCount) {
      * <li>User breakpoints are enabled.</li>
      * <li>Execution will continue until either:
      * <ol>
-     * <li>execution arrives at the nearest enclosing call site on the stack, <strong>or</strong></li>
+     * <li>execution arrives at the nearest enclosing call site on the stack, <strong>or</strong>
+     * </li>
      * <li>execution completes.</li>
      * </ol>
      * <li>StepOut mode persists only through one resumption, and reverts by default to Continue

truffle/com.oracle.truffle.api.debug/src/com/oracle/truffle/api/debug/SuspendedEvent.java

@@ -143,7 +143,8 @@ public void prepareContinue() {
      * <li>User breakpoints are disabled.</li>
      * <li>Execution will continue until either:
      * <ol>
-     * <li>execution arrives at a node with the tag {@link Debugger#HALT_TAG}, <strong>or:</strong></li>
+     * <li>execution arrives at a node with the tag {@link Debugger#HALT_TAG}, <strong>or:</strong>
+     * </li>
      * <li>execution completes.</li>
      * </ol>
      * <li>StepInto mode persists only through one resumption (i.e. {@code stepIntoCount} steps),
@@ -165,7 +166,8 @@ public void prepareStepInto(int stepCount) {
      * <li>User breakpoints are enabled.</li>
      * <li>Execution will continue until either:
      * <ol>
-     * <li>execution arrives at the nearest enclosing call site on the stack, <strong>or</strong></li>
+     * <li>execution arrives at the nearest enclosing call site on the stack, <strong>or</strong>
+     * </li>
      * <li>execution completes.</li>
      * </ol>
      * <li>StepOut mode persists only through one resumption, and reverts by default to Continue

truffle/com.oracle.truffle.api.debug/src/com/oracle/truffle/api/debug/package-info.java

@@ -30,10 +30,13 @@
  */
 
 /**
- * Control over {@link com.oracle.truffle.api.debug.Debugger debugging} of your {@link com.oracle.truffle.api.vm.PolyglotEngine}. Each {@link com.oracle.truffle.api.vm.PolyglotEngine}
- * is inherently capable to run in debugging mode - there is just one thing
- * to do - the {@link com.oracle.truffle.api.vm.PolyglotEngine.Builder creator of the virtual machine}
- * needs to turn debugging on when constructing its polyglot execution engine:
+ * Control over {@link com.oracle.truffle.api.debug.Debugger debugging} of your
+ * {@link com.oracle.truffle.api.vm.PolyglotEngine}. Each
+ * {@link com.oracle.truffle.api.vm.PolyglotEngine} is inherently capable to run in debugging mode -
+ * there is just one thing to do - the {@link com.oracle.truffle.api.vm.PolyglotEngine.Builder
+ * creator of the virtual machine} needs to turn debugging on when constructing its polyglot
+ * execution engine:
+ * 
  * <pre>
  * vm = {@link com.oracle.truffle.api.vm.PolyglotEngine#buildNew()}.
  *     {@link com.oracle.truffle.api.vm.PolyglotEngine.Builder#onEvent(com.oracle.truffle.api.vm.EventConsumer) onEvent}(<b>new</b> {@link com.oracle.truffle.api.vm.EventConsumer EventConsumer}
@@ -49,59 +52,61 @@
  *         }
  *     }).{@link com.oracle.truffle.api.vm.PolyglotEngine.Builder#build() build()};
  * </pre>
- * The debugging is controlled by events emitted by the Truffle virtual machine
- * at important moments. The {@link com.oracle.truffle.api.debug.ExecutionEvent}
- * is sent when a call to {@link com.oracle.truffle.api.vm.PolyglotEngine#eval(com.oracle.truffle.api.source.Source)}
- * is made and allows one to configure {@link com.oracle.truffle.api.debug.Breakpoint breakpoints} and/or decide whether the
- * program should {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto() step-into} or
- * {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareContinue() just run}. Once the execution is suspended a
- * {@link com.oracle.truffle.api.debug.SuspendedEvent} is generated which
- * allows one to inspect the stack and choose the further execution mode
- * ({@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepInto(int) step-into}, {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOver(int) step-over},
- *  {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOut() step-out}, {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareContinue() continue}).
+ * 
+ * The debugging is controlled by events emitted by the Truffle virtual machine at important
+ * moments. The {@link com.oracle.truffle.api.debug.ExecutionEvent} is sent when a call to
+ * {@link com.oracle.truffle.api.vm.PolyglotEngine#eval(com.oracle.truffle.api.source.Source)} is
+ * made and allows one to configure {@link com.oracle.truffle.api.debug.Breakpoint breakpoints}
+ * and/or decide whether the program should
+ * {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto() step-into} or
+ * {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareContinue() just run}. Once the
+ * execution is suspended a {@link com.oracle.truffle.api.debug.SuspendedEvent} is generated which
+ * allows one to inspect the stack and choose the further execution mode (
+ * {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepInto(int) step-into},
+ * {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOver(int) step-over},
+ * {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOut() step-out},
+ * {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareContinue() continue}).
  * <p>
- * The events methods are only available when the event is being delivered and
- * shouldn't be used anytime later. Both events however provide access to
- * {@link com.oracle.truffle.api.debug.Debugger} which can be kept and used
- * during whole existence of the {@link com.oracle.truffle.api.vm.PolyglotEngine}.
- * {@link com.oracle.truffle.api.debug.Debugger} is the central class that
- * keeps information about {@link com.oracle.truffle.api.debug.Debugger#getBreakpoints() registered breakpoints}
- * and allows one create new {@link com.oracle.truffle.api.debug.Breakpoint ones}.
+ * The events methods are only available when the event is being delivered and shouldn't be used
+ * anytime later. Both events however provide access to
+ * {@link com.oracle.truffle.api.debug.Debugger} which can be kept and used during whole existence
+ * of the {@link com.oracle.truffle.api.vm.PolyglotEngine}.
+ * {@link com.oracle.truffle.api.debug.Debugger} is the central class that keeps information about
+ * {@link com.oracle.truffle.api.debug.Debugger#getBreakpoints() registered breakpoints} and allows
+ * one create new {@link com.oracle.truffle.api.debug.Breakpoint ones}.
  *
  * <h4>Turning on Stepping Mode</h4>
  *
  * In case you want your execution to pause on first statement, register for
- * {@link com.oracle.truffle.api.debug.ExecutionEvent} and once delivered
- * call {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto()}.
+ * {@link com.oracle.truffle.api.debug.ExecutionEvent} and once delivered call
+ * {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto()}.
  *
  * <h4>Register a {@link com.oracle.truffle.api.debug.Breakpoint}</h4>
  *
  * Wait for execution to be started - which generates an
  * {@link com.oracle.truffle.api.debug.ExecutionEvent}. Use its
- * {@link com.oracle.truffle.api.debug.Debugger ev.getDebugger}()
- * methods to submit breakpoints.
+ * {@link com.oracle.truffle.api.debug.Debugger ev.getDebugger}() methods to submit breakpoints.
  *
  * <h4>Enable Debugging for your Language</h4>
  *
- * The platform's core support for 
- * {@link com.oracle.truffle.api.debug.Debugger debugging} is language-agnostic. A
- * {@link com.oracle.truffle.api.TruffleLanguage language implementation} enables debugging by supplying
- * extra information in every AST that configures debugger behavior for code written in that particular language.
+ * The platform's core support for {@link com.oracle.truffle.api.debug.Debugger debugging} is
+ * language-agnostic. A {@link com.oracle.truffle.api.TruffleLanguage language implementation}
+ * enables debugging by supplying extra information in every AST that configures debugger behavior
+ * for code written in that particular language.
  * <p>
  * This extra information is expressed as
- * {@linkplain com.oracle.truffle.api.source.SourceSection#withTags(java.lang.String...) tags}.
- * The language implementation applies tags to the 
- * {@link com.oracle.truffle.api.source.SourceSection source information} associated with
- * {@link com.oracle.truffle.api.nodes.Node nodes} relevant to debugging. 
- * At this time the debugger requries two tags for basic behavior; more tags may be required in the future
- * as the debugger acquires more functionality.
+ * {@linkplain com.oracle.truffle.api.source.SourceSection#withTags(java.lang.String...) tags}. The
+ * language implementation applies tags to the {@link com.oracle.truffle.api.source.SourceSection
+ * source information} associated with {@link com.oracle.truffle.api.nodes.Node nodes} relevant to
+ * debugging. At this time the debugger requries two tags for basic behavior; more tags may be
+ * required in the future as the debugger acquires more functionality.
  * <ul>
- * <li>{@link com.oracle.truffle.api.debug.Debugger#HALT_TAG}: must be applied to every Node where the debugger
- * should halt during ordinary <em>stepping</em>.  This typically corresponds to "statements" in each language.</li>
- * <li>{@link com.oracle.truffle.api.debug.Debugger#CALL_TAG}: must be applied to every Node where the debugger
- * should halt when either <em>returning</em> or <em>stepping out</em> from a call.  This typically corresponds
- * to function/method calls in each language.</li>
+ * <li>{@link com.oracle.truffle.api.debug.Debugger#HALT_TAG}: must be applied to every Node where
+ * the debugger should halt during ordinary <em>stepping</em>. This typically corresponds to
+ * "statements" in each language.</li>
+ * <li>{@link com.oracle.truffle.api.debug.Debugger#CALL_TAG}: must be applied to every Node where
+ * the debugger should halt when either <em>returning</em> or <em>stepping out</em> from a call.
+ * This typically corresponds to function/method calls in each language.</li>
  * </ul>
  */
 package com.oracle.truffle.api.debug;
-

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/CachedTest.java

@@ -366,7 +366,7 @@ public void testCachesOrder() {
     static class CachedError1 extends ValueNode {
         @Specialization
         static int do1(int value, @ExpectError("Incompatible return type int. The expression type must be equal to the parameter type double.")//
-                        @Cached("value") double cachedValue) {
+        @Cached("value") double cachedValue) {
             return value;
         }
     }

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/ExecuteMethodTest.java

@@ -35,8 +35,8 @@
 
 public class ExecuteMethodTest {
 
-    private static final String ERROR_NO_EXECUTE = "No accessible and overridable generic execute method found. Generic execute methods usually have the signature 'public abstract {Type} "
-                    + "execute(VirtualFrame)' and must not throw any checked exceptions.";
+    private static final String ERROR_NO_EXECUTE = "No accessible and overridable generic execute method found. Generic execute methods usually have the signature 'public abstract {Type} " +
+                    "execute(VirtualFrame)' and must not throw any checked exceptions.";
 
     @TypeSystem({int.class})
     @DSLOptions

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/NoTypeSystemTest.java

@@ -261,8 +261,8 @@ int s2(Object arg0) {
         }
     }
 
-    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. "
-                    + "The following execute methods do not provide all evaluated values for the expected signature size 1: [execute()].")
+    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. " +
+                    "The following execute methods do not provide all evaluated values for the expected signature size 1: [execute()].")
     abstract static class ErrorMissingNodeChild1 extends Node {
 
         abstract int execute();
@@ -273,8 +273,8 @@ int s1(int arg0) {
         }
     }
 
-    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. "
-                    + "The following execute methods do not provide all evaluated values for the expected signature size 2: [execute(int)].")
+    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. " +
+                    "The following execute methods do not provide all evaluated values for the expected signature size 2: [execute(int)].")
     @NodeChild(type = DummyChild.class)
     abstract static class ErrorMissingNodeChild2 extends Node {
 
@@ -286,8 +286,8 @@ int s1(int arg0, int arg1) {
         }
     }
 
-    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. "
-                    + "The following execute methods do not provide all evaluated values for the expected signature size 1: [execute()].")
+    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. " +
+                    "The following execute methods do not provide all evaluated values for the expected signature size 1: [execute()].")
     abstract static class ErrorMissingNodeChild3 extends Node {
 
         abstract int execute();
@@ -314,8 +314,8 @@ int s1(int arg0) {
     }
 
     @NodeChild(type = DummyChild.class)
-    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. "
-                    + "The following execute methods do not provide all evaluated values for the expected signature size 2: [execute(int)].")
+    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. " +
+                    "The following execute methods do not provide all evaluated values for the expected signature size 2: [execute(int)].")
     abstract static class ErrorAdditionalNodeChild2 extends Node {
 
         abstract int execute(int arg0);

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/NodeChildTest.java

@@ -73,8 +73,8 @@ abstract static class Base2Node extends ValueNode {
 
     }
 
-    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. "
-                    + "The following execute methods do not provide all evaluated values for the expected signature size 3:%")
+    @ExpectError("Not enough child node declarations found. Please annotate the node class with addtional @NodeChild annotations or remove all execute methods that do not provide all evaluated values. " +
+                    "The following execute methods do not provide all evaluated values for the expected signature size 3:%")
     @NodeChildren({@NodeChild(value = "child2", type = ValueNode.class)})
     abstract static class Child2Node extends Base1Node {
 

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/SpecializationFallthroughTest.java

@@ -366,8 +366,8 @@ int do4(int a) {
     @NodeChildren({@NodeChild("a")})
     static class FallthroughExceptionType2 extends ValueNode {
 
-        @ExpectError("A checked exception 'java.lang.Throwable' is thrown but is not specified using the rewriteOn property. "
-                        + "Checked exceptions that are not used for rewriting are not handled by the DSL. Use RuntimeExceptions for this purpose instead.")
+        @ExpectError("A checked exception 'java.lang.Throwable' is thrown but is not specified using the rewriteOn property. " +
+                        "Checked exceptions that are not used for rewriting are not handled by the DSL. Use RuntimeExceptions for this purpose instead.")
         @Specialization
         int do4(int a) throws Throwable {
             return a;

truffle/com.oracle.truffle.api.dsl.test/src/com/oracle/truffle/api/dsl/test/examples/RubyCall.java

@@ -197,7 +197,7 @@ public String toString() {
 
     }
 
-    public static final class RubyClass /* this would extend RubyModule */{
+    public static final class RubyClass /* this would extend RubyModule */ {
 
         private final String name;
         private final RubyClass parent; // this would be a RubyModule