add option to turn of legacy support for omitting root braces

Author: laktak

assets/charset_test.hjson

@@ -1,6 +1,8 @@
-ql-ascii: ! "#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
-js-ascii: "! \"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
-ml-ascii:
-  '''
-  ! "#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
-  '''
+{
+  ql-ascii: ! "#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+  js-ascii: "! \"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+  ml-ascii:
+    '''
+    ! "#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+    '''
+}

assets/failJSON24_test.json

@@ -0,0 +1,5 @@
+{
+  # invalid string containing a newline
+  foo : "
+  "
+}

assets/failStr7a_test.hjson

@@ -20,7 +20,6 @@ failJSON20_test.json
 failJSON21_test.json
 failJSON22_test.json
 failJSON23_test.json
-failJSON24_test.json
 failJSON26_test.json
 failJSON28_test.json
 failJSON29_test.json
@@ -61,6 +60,7 @@ failStr6a_test.hjson
 failStr6b_test.hjson
 failStr6c_test.hjson
 failStr6d_test.hjson
+failStr7a_test.hjson
 kan_test.hjson
 keys_test.hjson
 mltabs_test.json
@@ -70,7 +70,6 @@ pass2_test.json
 pass3_test.json
 pass4_test.json
 passSingle_test.hjson
-root_test.hjson
 stringify1_test.hjson
 strings_test.hjson
 trail_test.hjson
@@ -80,4 +79,5 @@ stringify/quotes_keys_test.hjson
 stringify/quotes_strings_ml_test.json
 stringify/quotes_strings_test.hjson
 extra/notabs_test.json
-extra/separator_test.json
+extra/root_test.hjson
+extra/separator_test.json

assets/root_result.hjson

@@ -1,2 +1,4 @@
-// the following line contains trailing whitespace:
-foo:     0   -- this string starts at 0 and ends at 1, preceding and trailing whitespace is ignored --   1 	  	       
+{
+  // the following line contains trailing whitespace:
+  foo:     0   -- this string starts at 0 and ends at 1, preceding and trailing whitespace is ignored --   1 	  	       
+}

assets/root_result.json

@@ -27,40 +27,57 @@
 public class HjsonOptions {
 
   private IHjsonDsfProvider[] dsf;
+  private boolean legacyRoot;
 
   public HjsonOptions() {
     dsf=new IHjsonDsfProvider[0];
+    legacyRoot=true;
   }
 
   /**
-   * Detects whether root braces should be emitted.
+   * Returns the DSF providers.
+   *
+   * @return providers.
+   */
+  public IHjsonDsfProvider[] getDsfProviders() { return dsf.clone(); }
+
+  /**
+   * Sets the DSF providers.
+   *
+   * @param value value
+   */
+  public void setDsfProviders(IHjsonDsfProvider[] value) { dsf=value.clone(); }
+
+  /**
+   * Detects whether objects without root braces are supported.
    *
-   * @deprecated will always return true.
    * @return <code>true</code> if this feature is enabled.
    */
-  @Deprecated
-  public boolean getEmitRootBraces() { return true; }
+  public boolean getParseLegacyRoot() { return legacyRoot; }
 
   /**
    * Sets whether root braces should be emitted.
    *
-   * @deprecated root braces are always emitted.
    * @param value value
    */
-  @Deprecated
-  public void setEmitRootBraces(boolean value) { }
+  public void setParseLegacyRoot(boolean value) { legacyRoot=value; }
 
   /**
-   * Returns the DSF providers.
+   * Detects whether root braces should be emitted.
    *
-   * @return providers.
+   * @deprecated will always return true.
+   * @return <code>true</code> if this feature is enabled.
    */
-  public IHjsonDsfProvider[] getDsfProviders() { return dsf.clone(); }
+  @Deprecated
+  public boolean getEmitRootBraces() { return true; }
 
   /**
-   * Sets the DSF providers.
+   * Sets whether root braces should be emitted.
    *
+   * @deprecated root braces are always emitted.
    * @param value value
    */
-  public void setDsfProviders(IHjsonDsfProvider[] value) { dsf=value.clone(); }
+  @Deprecated
+  public void setEmitRootBraces(boolean value) { }
+
 }

assets/root_test.hjson

@@ -37,14 +37,20 @@ class HjsonParser {
   private int current;
   private StringBuilder captureBuffer, peek;
   private boolean capture;
+  private boolean legacyRoot;
 
   private IHjsonDsfProvider[] dsfProviders;
 
   HjsonParser(String string, HjsonOptions options) {
     buffer=string;
     reset();
-    if (options!=null) dsfProviders=options.getDsfProviders();
-    else dsfProviders=new IHjsonDsfProvider[0];
+    if (options!=null) {
+      dsfProviders=options.getDsfProviders();
+      legacyRoot=options.getParseLegacyRoot();
+    } else {
+      dsfProviders=new IHjsonDsfProvider[0];
+      legacyRoot=true;
+    }
   }
 
   HjsonParser(Reader reader, HjsonOptions options) throws IOException {
@@ -75,23 +81,27 @@ JsonValue parse() throws IOException {
     read();
     skipWhiteSpace();
 
-    switch (current) {
-      case '[':
-      case '{':
-        return checkTrailing(readValue());
-      default:
-        try {
-          // assume we have a root object without braces
-          return checkTrailing(readObject(true));
-        } catch (Exception exception) {
-          // test if we are dealing with a single JSON value instead (true/false/null/num/"")
-          reset();
-          read();
-          skipWhiteSpace();
-          try { return checkTrailing(readValue()); }
-          catch (Exception exception2) { }
-          throw exception; // throw original error
-        }
+    if (legacyRoot) {
+      switch (current) {
+        case '[':
+        case '{':
+          return checkTrailing(readValue());
+        default:
+          try {
+            // assume we have a root object without braces
+            return checkTrailing(readObject(true));
+          } catch (Exception exception) {
+            // test if we are dealing with a single JSON value instead (true/false/null/num/"")
+            reset();
+            read();
+            skipWhiteSpace();
+            try { return checkTrailing(readValue()); }
+            catch (Exception exception2) { }
+            throw exception; // throw original error
+          }
+      }
+    } else {
+      return checkTrailing(readValue());
     }
   }