Fix MISRA 9.1 violation (#87)

leegeth · web-flow · commit 537d2ca72612 · 2021-02-25T13:14:34.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log for coreJSON Library
 
+## v3.0.1 (February 2021)
+ - [#86]([#84](https://github.com/FreeRTOS/coreJSON/pull/86) Fix MISRA 9.1 violation.
+ - [#84](https://github.com/FreeRTOS/coreJSON/pull/84), [#82](https://github.com/FreeRTOS/coreJSON/pull/82) and [#80](https://github.com/FreeRTOS/coreJSON/pull/80) Documentation updates and fixes.
+
 ## 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.
diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "coreJSON"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v3.0.0"
+PROJECT_NUMBER         = "v3.0.1"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
diff --git a/manifest.yml b/manifest.yml
@@ -1,5 +1,5 @@
 name : "coreJSON"
-version: "v3.0.0"
+version: "v3.0.1"
 description: |
   "A parser strictly enforcing the ECMA-404 JSON standard, suitable for microcontrollers. \n"
 license: "MIT"
diff --git a/source/core_json.c b/source/core_json.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.0
+ * coreJSON v3.0.1
  * 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
@@ -1620,7 +1620,7 @@ JSONStatus_t JSON_SearchConst( const char * buf,
                                JSONTypes_t * outType )
 {
     JSONStatus_t ret;
-    size_t value;
+    size_t value = 0U;
 
     if( ( buf == NULL ) || ( query == NULL ) ||
         ( outValue == NULL ) || ( outValueLength == NULL ) )
diff --git a/source/include/core_json.h b/source/include/core_json.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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 v3.0.0
+ * coreJSON v3.0.1
  * 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

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * coreJSON v3.0.0`
	`2`	`+ * coreJSON v3.0.1`
`3`	`3`	`* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.`
`4`	`4`	`*`
`5`	`5`	`* Permission is hereby granted, free of charge, to any person obtaining a copy of`
`@@ -1620,7 +1620,7 @@ JSONStatus_t JSON_SearchConst( const char * buf,`
`1620`	`1620`	`JSONTypes_t * outType )`
`1621`	`1621`	`{`
`1622`	`1622`	`JSONStatus_t ret;`
`1623`		`- size_t value;`
	`1623`	`+ size_t value = 0U;`
`1624`	`1624`
`1625`	`1625`	`if( ( buf == NULL ) \|\| ( query == NULL ) \|\|`
`1626`	`1626`	`( outValue == NULL ) \|\| ( outValueLength == NULL ) )`