Merge pull request #4 from tgauth/update-0.11.0

Update 0.11.0

Author: tgauth

.circleci/config.yml

@@ -4,8 +4,9 @@ commands:
   linux-setup:
     steps:
     - run: sudo apt-get update
-    - run: sudo apt-get install -y cmake ${TOOLCHAIN_PACKAGES}
-    - run: sudo apt install libcmocka-dev libcjson-dev
+    # NEEDRESTART_MODE prevents automatic restarts which seem to hang.
+    - run: sudo NEEDRESTART_MODE=l apt-get install -y cmake ${TOOLCHAIN_PACKAGES}
+    - run: sudo NEEDRESTART_MODE=l apt-get install -y libcmocka-dev libcjson-dev
   build:
     steps:
     - run: >
@@ -32,14 +33,14 @@ orbs:
 
 jobs:
   static-test:
-    machine:
-      image: ubuntu-2204:2022.10.2
+    machine: &default-machine
+      image: ubuntu-2204:2023.07.2
     environment:
       TOOLCHAIN_PACKAGES: g++
     steps:
       - checkout
       - linux-setup
-      - run: sudo apt-get install -y clang-format doxygen cppcheck
+      - run: sudo NEEDRESTART_MODE=l apt-get install -y clang-format doxygen cppcheck
       - run: cppcheck --inline-suppr --error-exitcode=1 .
       - run: bash clang-format.sh --verbose
       - run: >
@@ -61,14 +62,14 @@ jobs:
 
   build-and-test:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     environment:
       TOOLCHAIN_PACKAGES: g++
       CMAKE_COVERAGE: ON
     steps:
       - checkout
       - linux-setup
-      - run: sudo apt-get install -y valgrind
+      - run: sudo NEEDRESTART_MODE=l apt-get install -y valgrind
       - build
       - test
       - run: ctest -T Coverage
@@ -82,7 +83,7 @@ jobs:
 
   build-and-test-clang:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     environment:
       TOOLCHAIN_PACKAGES: clang
       CC: clang
@@ -95,11 +96,11 @@ jobs:
 
   build-and-test-32b:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     steps:
       - checkout
       - run: sudo apt-get update
-      - run: sudo apt-get install -y cmake gcc-multilib g++-multilib libc6-dev-i386
+      - run: sudo NEEDRESTART_MODE=l apt-get install -y cmake gcc-multilib g++-multilib libc6-dev-i386
       # Make cmocka from source w/ 32b setup
       - run: git clone https://git.cryptomilk.org/projects/cmocka.git ~/cmocka
       - run: >
@@ -118,7 +119,7 @@ jobs:
 
   build-and-test-release-clang:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     environment:
       TOOLCHAIN_PACKAGES: clang
       CC: clang
@@ -131,7 +132,7 @@ jobs:
 
   llvm-coverage:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     environment:
       TOOLCHAIN_PACKAGES: clang
       CC: clang
@@ -146,7 +147,7 @@ jobs:
 
   build-and-test-arm:
     machine:
-      image: ubuntu-2204:2022.10.2
+      <<: *default-machine
     environment:
       TOOLCHAIN_PACKAGES: g++
     resource_class: arm.medium
@@ -158,7 +159,7 @@ jobs:
 
   build-bazel:
     machine:
-      image: ubuntu-2204:2022.10.2
+      image: ubuntu-2204:2023.07.2
     environment:
       TOOLCHAIN_PACKAGES: g++
     steps:

.cirrus.yml

@@ -0,0 +1,26 @@
+freebsd_task:
+    install_script:
+    - ASSUME_ALWAYS_YES=yes pkg bootstrap -f && pkg install -y cmocka cmake ninja
+    build_script:
+    - mkdir build
+    - cd build
+    - cmake -GNinja -DWITH_TESTS=ON
+      -DCBOR_CUSTOM_ALLOC=ON
+      -DCMAKE_BUILD_TYPE=Debug
+      -DSANITIZE=OFF
+      ..
+    - ninja -j $(sysctl -n hw.ncpu)
+    test_script:
+    - cd build
+    - ctest -VV
+    matrix:
+    # From gcloud compute images list --project freebsd-org-cloud-dev --no-standard-images
+    - name: freebsd-13-2
+      freebsd_instance:
+        image_family: freebsd-13-2
+    - name: freebsd-14-0
+      freebsd_instance:
+        image_family: freebsd-14-0
+    - name: freebsd-15-0-snap
+      freebsd_instance:
+        image_family: freebsd-15-0-snap

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: doc/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+   - requirements: doc/source/requirements.txt

CHANGELOG.md

@@ -3,7 +3,19 @@ Template:
 
 Next
 ---------------------
+
+0.11.0 (2024-02-04)
+---------------------
 - [Updated documentation to refer to RFC 8949](https://github.com/PJK/libcbor/issues/269)
+- Improvements to `cbor_describe`
+  - [Bytestring data will now be printed as well](https://github.com/PJK/libcbor/pull/281) by  [akallabeth](https://github.com/akallabeth)
+  - [Formatting consistency and clarity improvements](https://github.com/PJK/libcbor/pull/285)
+- [Fix `cbor_string_set_handle` not setting the codepoint count](https://github.com/PJK/libcbor/pull/286)
+- BREAKING: [`cbor_load` will no longer fail on input strings that are well-formed but not valid UTF-8](https://github.com/PJK/libcbor/pull/286)
+  - If you were relying on the validation, please check the result using `cbor_string_codepoint_count` instead 
+- BREAKING: [All decoders like `cbor_load` and `cbor_stream_decode` will accept all well-formed tag values](https://github.com/PJK/libcbor/pull/308) (bug discovered by [dskern-github](https://github.com/dskern-github))
+  - Previously, decoding of certain values would fail with `CBOR_ERR_MALFORMATED` or `CBOR_DECODER_ERROR`
+  - This also makes decoding symmetrical with serialization, which already accepts all values
 
 0.10.2 (2023-01-31)
 ---------------------
@@ -118,7 +130,7 @@ Next
 Breaks build & header compatibility due to:
 
 - Improved build configuration and feature check macros
-- Endianess configuration fixes (by Erwin Kroon and David Grigsby)
+- Endianness configuration fixes (by Erwin Kroon and David Grigsby)
 - pkg-config compatibility (by Vincent Bernat)
 - enable use of versioned SONAME (by Vincent Bernat)
 - better fuzzer (wasn't random until now, ooops)

CMakeLists.txt

@@ -1,14 +1,18 @@
 cmake_minimum_required(VERSION 3.0)
+
 project(libcbor)
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/")
 include(CTest)
+include(GNUInstallDirs) # Provides CMAKE_INSTALL_ variables
 
 SET(CBOR_VERSION_MAJOR "0")
-SET(CBOR_VERSION_MINOR "10")
-SET(CBOR_VERSION_PATCH "2")
+SET(CBOR_VERSION_MINOR "11")
+SET(CBOR_VERSION_PATCH "0")
 SET(CBOR_VERSION ${CBOR_VERSION_MAJOR}.${CBOR_VERSION_MINOR}.${CBOR_VERSION_PATCH})
 
-set(CMAKE_SKIP_INSTALL_ALL_DEPENDENCY true)
+option(CMAKE_SKIP_INSTALL_ALL_DEPENDENCY "cmake --build --target install does not depend on cmake --build" true)
+option(BUILD_SHARED_LIBS "Build as a shared library" false)
+
 include(CheckIncludeFiles)
 
 include(TestBigEndian)
@@ -19,10 +23,10 @@ endif()
 
 option(CBOR_CUSTOM_ALLOC "Custom, dynamically defined allocator support" OFF)
 if(CBOR_CUSTOM_ALLOC)
-    message(WARNING 
+    message(WARNING
         "CBOR_CUSTOM_ALLOC has been deprecated. Custom allocators are now enabled by default."
         "The flag is a no-op and will be removed in the next version. "
-        "Please remove CBOR_CUSTOM_ALLOC from your build configuation.")
+        "Please remove CBOR_CUSTOM_ALLOC from your build configuration.")
 endif(CBOR_CUSTOM_ALLOC)
 
 option(CBOR_PRETTY_PRINTER "Include a pretty-printing routine" ON)
@@ -142,9 +146,8 @@ add_compile_options(/Qspectre) # add Spectre mitigation compiler option. (https:
 
 # We want to generate configuration.h from the template and make it so that it is accessible using the same
 # path during both library build and installed header use, without littering the source dir.
-# Using cbor/configuration.h in the build dir works b/c headers will be installed to <prefix>/cbor
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/cbor/configuration.h.in ${PROJECT_BINARY_DIR}/cbor/configuration.h)
-install(FILES ${PROJECT_BINARY_DIR}/cbor/configuration.h DESTINATION include/cbor)
+install(FILES ${PROJECT_BINARY_DIR}/cbor/configuration.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/cbor)
 # Make the header visible at compile time
 include_directories(${PROJECT_BINARY_DIR})
 

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 libcbor is maintained by [@PJK](https://github.com/PJK) in his spare time on a best-effort basis.
 
-Community contributions are welcome as long as they align with the [project priorities](https://github.com/PJK/libcbor#main-features) and [goals](https://libcbor.readthedocs.io/en/latest/development.html#goals) and follow the guidelines described belows. 
+Community contributions are welcome as long as they align with the [project priorities](https://github.com/PJK/libcbor#main-features) and [goals](https://libcbor.readthedocs.io/en/latest/development.html#goals) and follow the guidelines described below. 
 
 ## Principles
 

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = libcbor
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.10.2
+PROJECT_NUMBER         = 0.11.0
 
 # 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

cgmanifest.json

@@ -5,7 +5,7 @@
                 "Type": "other",
                 "Other": {
                     "Name": "libcbor",
-                    "Version": "0.10.1",
+                    "Version": "0.11.0",
                     "DownloadUrl": "https://github.com/PJK/libcbor"
                 }
             },

doc/source/conf.py

@@ -33,7 +33,8 @@
     'breathe',
     'sphinx.ext.mathjax',
     'sphinx.ext.autodoc',
-    'sphinx.ext.ifconfig'
+    'sphinx.ext.ifconfig',
+    'sphinx_rtd_theme'
 ]
 
 import subprocess, os
@@ -76,8 +77,8 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.10'
-release = '0.10.2'
+version = '0.11'
+release = '0.11.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -127,7 +128,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -285,12 +286,3 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
-
-
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# otherwise, readthedocs.org uses their theme by default, so no need to specify it
-

doc/source/development.rst

@@ -23,7 +23,7 @@ Goals
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Standard conformance and full feature support
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Anything the standard allows, libcbor can do.
 

doc/source/internal.rst

@@ -32,7 +32,7 @@ and also borrowing from
 
 General notes on the API design
 --------------------------------
-The API design has two main driving priciples:
+The API design has two main driving principles:
 
  1. Let the client manage the memory as much as possible
  2. Behave exactly as specified by the standard

doc/source/requirements.txt

@@ -1,31 +1,31 @@
-alabaster==0.7.12
-Babel==2.9.1
-breathe==4.33.1
-certifi==2022.12.7
-charset-normalizer==2.0.12
-colorama==0.4.4
-docutils==0.17.1
-idna==3.3
-imagesize==1.3.0
-importlib-metadata==4.11.3
-Jinja2==3.0.3
+alabaster==0.7.13
+Babel==2.13.1
+breathe==4.35.0
+certifi==2023.11.17
+charset-normalizer==3.3.2
+colorama==0.4.6
+docutils==0.18.1
+idna==3.4
+imagesize==1.4.1
+importlib-metadata==6.8.0
+Jinja2==3.1.2
 livereload==2.6.3
-MarkupSafe==2.1.1
-packaging==21.3
-Pygments==2.11.2
-pyparsing==3.0.7
+MarkupSafe==2.1.3
+packaging==23.2
+Pygments==2.16.1
+pyparsing==3.1.1
 pytz==2021.3
-requests==2.27.1
+requests==2.31.0
 snowballstemmer==2.2.0
-Sphinx==4.4.0
+Sphinx==7.2.6
 sphinx-autobuild==2021.3.14
-sphinx-rtd-theme==1.0.0
-sphinxcontrib-applehelp==1.0.2
-sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.0
+sphinx-rtd-theme==1.3.0
+sphinxcontrib-applehelp==1.0.7
+sphinxcontrib-devhelp==1.0.5
+sphinxcontrib-htmlhelp==2.0.4
 sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.5
-tornado==6.1
-urllib3==1.26.9
-zipp==3.7.0
+sphinxcontrib-qthelp==1.0.6
+sphinxcontrib-serializinghtml==1.1.9
+tornado==6.3.3
+urllib3==2.1.0
+zipp==3.17.0

examples/bazel/third_party/libcbor/cbor/configuration.h

@@ -2,8 +2,8 @@
 #define LIBCBOR_CONFIGURATION_H
 
 #define CBOR_MAJOR_VERSION 0
-#define CBOR_MINOR_VERSION 10
-#define CBOR_PATCH_VERSION 2
+#define CBOR_MINOR_VERSION 11
+#define CBOR_PATCH_VERSION 0
 
 #define CBOR_BUFFER_GROWTH 2
 #define CBOR_MAX_STACK_SIZE 2048

examples/cjson2cbor.c

@@ -7,7 +7,7 @@
 
 /**
  * This code demonstrates how cJSON (https://github.com/DaveGamble/cJSON)
- * callbacks can be used in conjuction with the streaming parser to translate
+ * callbacks can be used in conjunction with the streaming parser to translate
  * JSON to CBOR. Please note that cbor_builder_* APIs are internal and thus
  * subject to change.
  *