PR feedback, changelog addition, and version increment

FreeRTOS · Dec 8, 2020 · b507350 · b507350
1 parent 673cb3c
commit b507350
Show file tree

Hide file tree

Showing 27 changed files with 41 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log for coreJSON Library
 
+## v3.0.0 (December 2020)
+ - [#74](https://github.com/FreeRTOS/coreJSON/pull/74) Add `JSON_Iterate` function to iterate over items in a JSON collection.
+ - [#74](https://github.com/FreeRTOS/coreJSON/pull/74) Add `JSONInvalid` enum with the value 0 to `JSONTypes_t`. This change is not backwards compatible.
+
 ## v2.0.0 (November 2020)
 
 ### Updates
@@ -13,4 +17,4 @@
 
 ## v1.0.0 (September 2020)
 
-This is the first release of the coreJSON library, a parser that strictly enforces the [ECMA-404 JSON standard](https://www.json.org/json-en.html) and is suitable for low memory footprint embedded devices.
+This is the first release of the coreJSON library, a parser that strictly enforces the [ECMA-404 JSON standard](https://www.json.org/json-en.html) and is suitable for low memory footprint embedded devices.
diff --git a/source/core_json.c b/source/core_json.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/source/include/core_json.h b/source/include/core_json.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/core_json_annex.h b/test/cbmc/include/core_json_annex.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/skipGeneric.h b/test/cbmc/include/skipGeneric.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Iterate/JSON_Iterate_harness.c b/test/cbmc/proofs/JSON_Iterate/JSON_Iterate_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Search/JSON_Search_harness.c b/test/cbmc/proofs/JSON_Search/JSON_Search_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Validate/JSON_Validate_harness.c b/test/cbmc/proofs/JSON_Validate/JSON_Validate_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipAnyLiteral/skipAnyLiteral_harness.c b/test/cbmc/proofs/skipAnyLiteral/skipAnyLiteral_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipCollection/skipCollection_harness.c b/test/cbmc/proofs/skipCollection/skipCollection_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipEscape/skipEscape_harness.c b/test/cbmc/proofs/skipEscape/skipEscape_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipNumber/skipNumber_harness.c b/test/cbmc/proofs/skipNumber/skipNumber_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipSpace/skipSpace_harness.c b/test/cbmc/proofs/skipSpace/skipSpace_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipSpaceAndComma/skipSpaceAndComma_harness.c b/test/cbmc/proofs/skipSpaceAndComma/skipSpaceAndComma_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipString/skipString_harness.c b/test/cbmc/proofs/skipString/skipString_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipUTF8/skipUTF8_harness.c b/test/cbmc/proofs/skipUTF8/skipUTF8_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipAnyLiteral.c b/test/cbmc/stubs/skipAnyLiteral.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipAnyScalar.c b/test/cbmc/stubs/skipAnyScalar.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipCollection.c b/test/cbmc/stubs/skipCollection.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipEscape.c b/test/cbmc/stubs/skipEscape.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipGeneric.c b/test/cbmc/stubs/skipGeneric.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipNumber.c b/test/cbmc/stubs/skipNumber.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipSpace.c b/test/cbmc/stubs/skipSpace.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipSpaceAndComma.c b/test/cbmc/stubs/skipSpaceAndComma.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipString.c b/test/cbmc/stubs/skipString.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipUTF8.c b/test/cbmc/stubs/skipUTF8.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/unit-test/core_json_utest.c b/test/unit-test/core_json_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v2.0.0
+ * coreJSON v3.0.0
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -949,7 +949,7 @@ void test_JSON_Iterate_Legal_Array_Documents( void )
     size_t start = 0, next = 0;
     JSONPair_t pair = { 0 };
 
-#define doIterate( type, answer )                                    \
+#define iterateArray( type, answer )                                 \
     jsonStatus = JSON_Iterate( JSON_DOC_LEGAL_ARRAY,                 \
                                JSON_DOC_LEGAL_ARRAY_LENGTH,          \
                                &start,                               \
@@ -964,12 +964,12 @@ void test_JSON_Iterate_Legal_Array_Documents( void )
                                   pair.value,                        \
                                   pair.valueLength );
 
-    doIterate( ARRAY_ELEMENT_0_TYPE, ARRAY_ELEMENT_0 );
-    doIterate( ARRAY_ELEMENT_1_TYPE, ARRAY_ELEMENT_1 );
-    doIterate( ARRAY_ELEMENT_2_TYPE, ARRAY_ELEMENT_2 );
-    doIterate( ARRAY_ELEMENT_3_TYPE, ARRAY_ELEMENT_3 );
-    doIterate( ARRAY_ELEMENT_4_TYPE, ARRAY_ELEMENT_4 );
-    doIterate( ARRAY_ELEMENT_5_TYPE, ARRAY_ELEMENT_5 );
+    iterateArray( ARRAY_ELEMENT_0_TYPE, ARRAY_ELEMENT_0 );
+    iterateArray( ARRAY_ELEMENT_1_TYPE, ARRAY_ELEMENT_1 );
+    iterateArray( ARRAY_ELEMENT_2_TYPE, ARRAY_ELEMENT_2 );
+    iterateArray( ARRAY_ELEMENT_3_TYPE, ARRAY_ELEMENT_3 );
+    iterateArray( ARRAY_ELEMENT_4_TYPE, ARRAY_ELEMENT_4 );
+    iterateArray( ARRAY_ELEMENT_5_TYPE, ARRAY_ELEMENT_5 );
 
     jsonStatus = JSON_Iterate( JSON_DOC_LEGAL_ARRAY,
                                JSON_DOC_LEGAL_ARRAY_LENGTH,
@@ -988,7 +988,7 @@ void test_JSON_Iterate_Legal_Object_Documents( void )
     size_t start = 0, next = 0;
     JSONPair_t pair = { 0 };
 
-#define doIterate2( key_, type, answer )                             \
+#define iterateObject( key_, type, answer )                          \
     jsonStatus = JSON_Iterate( JSON_NESTED_OBJECT,                   \
                                JSON_NESTED_OBJECT_LENGTH,            \
                                &start,                               \
@@ -1005,8 +1005,8 @@ void test_JSON_Iterate_Legal_Object_Documents( void )
                                   pair.value,                        \
                                   pair.valueLength );
 
-    doIterate2( FIRST_QUERY_KEY, ARRAY_ELEMENT_2_SUB_0_TYPE, ARRAY_ELEMENT_2_SUB_0 );
-    doIterate2( SECOND_QUERY_KEY, ARRAY_ELEMENT_2_SUB_1_TYPE, ARRAY_ELEMENT_2_SUB_1 );
+    iterateObject( FIRST_QUERY_KEY, ARRAY_ELEMENT_2_SUB_0_TYPE, ARRAY_ELEMENT_2_SUB_0 );
+    iterateObject( SECOND_QUERY_KEY, ARRAY_ELEMENT_2_SUB_1_TYPE, ARRAY_ELEMENT_2_SUB_1 );
 
     jsonStatus = JSON_Iterate( JSON_NESTED_OBJECT,
                                JSON_NESTED_OBJECT_LENGTH,