Merge branch '2.x' into 3.x

Author: cowtowncoder

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORGenerator.java

@@ -25,6 +25,8 @@ public class CBORGenerator extends GeneratorBase
 {
     private final static int[] NO_INTS = new int[0];
 
+    private final static BigInteger BI_MINUS_ONE = BigInteger.ONE.negate();
+
     /**
      * Let's ensure that we have big enough output buffer because of safety
      * margins we need for UTF-8 encoding.
@@ -1034,14 +1036,17 @@ public JsonGenerator writeNumber(BigInteger v) throws JacksonException {
     // Main write method isolated so that it can be called directly
     // in cases where that is needed (to encode BigDecimal)
     protected void _write(BigInteger v) throws JacksonException {
-        /*
-         * Supported by using type tags, as per spec: major type for tag '6'; 5
+        /* Supported by using type tags, as per spec: major type for tag '6'; 5
          * LSB either 2 for positive bignum or 3 for negative bignum. And then
          * byte sequence that encode variable length integer.
          */
         if (v.signum() < 0) {
             _writeByte(BYTE_TAG_BIGNUM_NEG);
-            v = v.negate();
+            if (isEnabled(CBORWriteFeature.ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING)) {
+                v = BI_MINUS_ONE.subtract(v);
+            } else {
+                v = v.negate();
+            }
         } else {
             _writeByte(BYTE_TAG_BIGNUM_POS);
         }

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORMapper.java

@@ -43,23 +43,21 @@ protected MapperBuilderState _saveState() {
         /******************************************************************
          */
 
-        // 19-Feb-2021, tatu: No parser features for CBOR, yet
-        /*
-        public Builder enable(CBORParser.Feature... features) {
-            for (CBORParser.Feature f : features) {
+        public Builder enable(CBORReadFeature... features) {
+            for (CBORReadFeature f : features) {
                 _formatReadFeatures |= f.getMask();
             }
             return this;
         }
 
-        public Builder disable(CBORParser.Feature... features) {
-            for (CBORParser.Feature f : features) {
+        public Builder disable(CBORReadFeature... features) {
+            for (CBORReadFeature f : features) {
                 _formatReadFeatures &= ~f.getMask();
             }
             return this;
         }
 
-        public Builder configure(CBORParser.Feature feature, boolean state)
+        public Builder configure(CBORReadFeature feature, boolean state)
         {
             if (state) {
                 _formatReadFeatures |= feature.getMask();
@@ -68,7 +66,6 @@ public Builder configure(CBORParser.Feature feature, boolean state)
             }
             return this;
         }
-        */
 
         public Builder enable(CBORWriteFeature... features) {
             for (CBORWriteFeature f : features) {

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORParser.java

@@ -110,6 +110,9 @@ public int getFirstTag() {
 
     private final static int[] UTF8_UNIT_CODES = CBORConstants.sUtf8UnitLengths;
 
+    // @since 2.20
+    private final static BigInteger BI_MINUS_ONE = BigInteger.ONE.negate();
+
     // Constants for handling of 16-bit "mini-floats"
     private final static double MATH_POW_2_10 = Math.pow(2, 10);
     private final static double MATH_POW_2_NEG14 = Math.pow(2, -14);
@@ -122,6 +125,18 @@ public int getFirstTag() {
     protected final static JacksonFeatureSet<StreamReadCapability> CBOR_READ_CAPABILITIES =
             DEFAULT_READ_CAPABILITIES.with(StreamReadCapability.EXACT_FLOATS);
 
+    /*
+    /**********************************************************************
+    /* Configuration
+    /**********************************************************************
+     */
+    
+    /**
+     * Bit flag composed of bits that indicate which
+     * {@link CBORReadFeature}s are enabled.
+     */
+    protected final int _formatFeatures;
+
     /*
     /**********************************************************************
     /* Parsing state
@@ -141,7 +156,6 @@ public int getFirstTag() {
 
     /**
      * We will keep track of tag values for possible future use.
-     * @since 2.15
      */
     protected TagList _tagValues = new TagList();
 
@@ -160,8 +174,6 @@ public int getFirstTag() {
     /**
      * Type to keep track of a list of string references. A depth is stored to know when to pop the
      * references off the stack for nested namespaces.
-     *
-     * @since 2.15
      */
     protected static final class StringRefList
     {
@@ -175,8 +187,6 @@ public StringRefList(int depth) {
 
     /**
      * Type to keep a stack of string refs based on namespaces within the document.
-     *
-     * @since 2.15
      */
     protected static final class StringRefListStack {
         public void push(boolean hasNamespace) {
@@ -207,13 +217,11 @@ public boolean empty() {
 
     /**
      * Stack of text and binary string references.
-     * @since 2.15
      */
     protected StringRefListStack _stringRefs = new StringRefListStack();
 
     /**
      * Shared string that should be used in place of _textBuffer when a string reference is used.
-     * @since 2.15
      */
     protected String _sharedString;
 
@@ -255,7 +263,7 @@ public boolean empty() {
     /**
      * Symbol table that contains field names encountered so far
      */
-    final protected ByteQuadsCanonicalizer _symbols;
+    protected final ByteQuadsCanonicalizer _symbols;
 
     /**
      * Temporary buffer used for name parsing.
@@ -274,8 +282,6 @@ public boolean empty() {
      * is used: usually due to set of symbols
      * (Object property names) is unbounded and will not benefit from
      * canonicalization attempts.
-     *
-     * @since 2.13
      */
     protected final boolean _symbolsCanonical;
 
@@ -292,6 +298,7 @@ public CBORParser(ObjectReadContext readCtxt, IOContext ioCtxt,
             boolean bufferRecyclable)
     {
         super(readCtxt, ioCtxt, parserFeatures);
+        _formatFeatures = cborFeatures;
         _symbols = sym;
         _symbolsCanonical = sym.isCanonicalizing();
 
@@ -845,9 +852,15 @@ protected JsonToken _handleTaggedBinary(TagList tags) throws JacksonException
             _numberBigInt = BigInteger.ZERO;
         } else {
             _streamReadConstraints.validateIntegerLength(_binaryValue.length);
-            BigInteger nr = new BigInteger(_binaryValue);
+            final BigInteger nr;
             if (neg) {
-                nr = nr.negate();
+                if (CBORReadFeature.DECODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING.enabledIn(_formatFeatures)) {
+                    nr = BI_MINUS_ONE.subtract(new BigInteger(1, _binaryValue));
+                } else {
+                    nr = new BigInteger(_binaryValue).negate();
+                }
+            } else {
+                nr = new BigInteger(_binaryValue);
             }
             _numberBigInt = nr;
         }

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORReadFeature.java

@@ -0,0 +1,66 @@
+package tools.jackson.dataformat.cbor;
+
+import tools.jackson.core.FormatFeature;
+
+/**
+ * Enumeration that defines all togglable features for CBOR parser.
+ *<p>
+ * NOTE: in Jackson 2.x this was named {@code CBORParser.Feature}.
+ */
+public enum CBORReadFeature implements FormatFeature
+{
+    /**
+     * Feature that determines how binary tagged negative BigInteger values are
+     * decoded: either assuming CBOR standard encoding logic (as per spec),
+     * or the legacy Jackson encoding logic (encoding up to Jackson 2.19).
+     * When enabled, ensures proper encoding of negative values
+     * (e.g., {@code [0xC3, 0x41, 0x00]} is decoded as -1)
+     * When disabled, maintains backwards compatibility with existing implementations
+     * (e.g., {@code [0xC3, 0x41, 0x00]} is decoded as 0).
+     *<p>
+     * Note that there is the counterpart
+     * {@link CBORWriteFeature#ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING}
+     * for encoding.
+     *<p>
+     * The default value is {@code false} for backwards compatibility.
+     */
+    DECODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING(false),
+    ;
+
+    private final boolean _defaultState;
+    private final int _mask;
+
+    /**
+     * Method that calculates bit set (flags) of all features that are
+     * enabled by default.
+     */
+    public static int collectDefaults() {
+        int flags = 0;
+        for (CBORReadFeature f : values()) {
+            if (f.enabledByDefault()) {
+                flags |= f.getMask();
+            }
+        }
+        return flags;
+    }
+
+    private CBORReadFeature(boolean defaultState) {
+        _defaultState = defaultState;
+        _mask = (1 << ordinal());
+    }
+
+    @Override
+    public boolean enabledByDefault() {
+        return _defaultState;
+    }
+
+    @Override
+    public boolean enabledIn(int flags) {
+        return (flags & getMask()) != 0;
+    }
+
+    @Override
+    public int getMask() {
+        return _mask;
+    }
+}

cbor/src/main/java/tools/jackson/dataformat/cbor/CBORWriteFeature.java

@@ -5,7 +5,7 @@
 /**
  * Enumeration that defines all togglable features for CBOR generator.
  *<p>
- * NOTE: in Jackson 2.x this was named {@code CBORParser.Feature}.
+ * NOTE: in Jackson 2.x this was named {@code CBORGenerator.Feature}.
  */
 public enum CBORWriteFeature implements FormatFeature
 {
@@ -61,6 +61,24 @@ public enum CBORWriteFeature implements FormatFeature
      * 8-byte values.
      */
     WRITE_MINIMAL_DOUBLES(false),
+
+    /**
+     * Feature that determines how binary tagged negative BigInteger values are
+     * encoded: either using CBOR standard encoding logic (as per spec),
+     * or using legacy Jackson encoding logic (encoding up to Jackson 2.19).
+     * When enabled, uses CBOR standard specified encoding of negative values
+     * (e.g., -1 is encoded {@code [0xC3, 0x41, 0x00]}).
+     * When disabled, maintains backwards compatibility with existing implementations
+     * (e.g., -1 is encoded {@code [0xC3, 0x41, 0x01]}) and uses legacy Jackson encoding.
+     *<p>
+     * Note that there is the counterpart
+     * {@link CBORReadFeature#DECODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING}
+     * for encoding.
+     *<p>
+     * Default value is {@code false} for backwards-compatibility.
+     */
+    ENCODE_USING_STANDARD_NEGATIVE_BIGINT_ENCODING(false),
+
     ;
 
     private final boolean _defaultState;