wip [ci skip]

biojppm · Jan 22, 2025 · 220466f · 220466f
1 parent 0f93764
commit 220466f
Show file tree

Hide file tree

Showing 16 changed files with 485 additions and 77 deletions.
diff --git a/.github/workflows/infra.yml b/.github/workflows/infra.yml
@@ -42,3 +42,53 @@ jobs:
           echo "ERROR: generated workflows are out of date"
         fi
         exit $status
+  check_doc:
+    if: always()
+    continue-on-error: false
+    runs-on: ubuntu-24.04
+    env:
+      DOXY_VERSION: 1.12.0
+      DOXY_DIR: /tmp/doxydir/bin
+    steps:
+    - name: checkout (action)
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+    - name: install python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+    - name: install requirements
+      run: pip install -r doc/requirements.txt
+    - name: install wget
+      run: |
+        sudo apt-get update
+        sudo apt install -y wget
+    - name: install doxygen
+      run: |
+        ver=$DOXY_VERSION
+        uver=$(echo $ver | sed "s:\.:_:g")
+        name=$(dirname $DOXY_DIR)
+        dst=$(dirname $name)
+        url="https://github.com/doxygen/doxygen/releases/download/Release_$uver/doxygen-$ver.linux.bin.tar.gz"
+        ( \
+          cd $dst ; \
+          wget $url ; \
+          tar xvfz $(basename $url) ; \
+          ls -lFhp | grep dox ; \
+          mv -v doxygen-$ver $name ; \
+        )
+    - name: doxygen version
+      run: |
+        export PATH=$DOXY_DIR:$PATH
+        which doxygen
+        doxygen --version
+    - name: check doxygen docs
+      run: |
+        export PATH=$DOXY_DIR:$PATH
+        make -C doc doxy
+    - name: check sphinx
+      run: |
+        export PATH=$DOXY_DIR:$PATH
+        make -C doc html
diff --git a/.github/workflows/infra.ys b/.github/workflows/infra.ys
@@ -30,3 +30,48 @@ jobs:
             echo "ERROR: generated workflows are out of date"
           fi
           exit $status
+
+  check_doc:
+    :: setup-job('infra' 'check_doxygen')
+    runs-on: ubuntu-24.04
+    env:
+      DOXY_VERSION: 1.12.0
+      DOXY_DIR: /tmp/doxydir/bin
+    steps:
+      - :: checkout-action
+      - name: install python
+        uses: actions/setup-python@v5
+        with: {python-version: 3.9}
+      - name: install requirements
+        run: pip install -r doc/requirements.txt
+      - name: install wget
+        run: |
+          sudo apt-get update
+          sudo apt install -y wget
+      - name: install doxygen
+        run: |
+          ver=$DOXY_VERSION
+          uver=$(echo $ver | sed "s:\.:_:g")
+          name=$(dirname $DOXY_DIR)
+          dst=$(dirname $name)
+          url="https://github.com/doxygen/doxygen/releases/download/Release_$uver/doxygen-$ver.linux.bin.tar.gz"
+          ( \
+            cd $dst ; \
+            wget $url ; \
+            tar xvfz $(basename $url) ; \
+            ls -lFhp | grep dox ; \
+            mv -v doxygen-$ver $name ; \
+          )
+      - name: doxygen version
+        run: |
+          export PATH=$DOXY_DIR:$PATH
+          which doxygen
+          doxygen --version
+      - name: check doxygen docs
+        run: |
+          export PATH=$DOXY_DIR:$PATH
+          make -C doc doxy
+      - name: check sphinx
+        run: |
+          export PATH=$DOXY_DIR:$PATH
+          make -C doc html
diff --git a/changelog/current.md b/changelog/current.md
@@ -19,10 +19,15 @@
       ? explicit key
   : value   # this was not indented
   ```
-- [PR#492](https://github.com/biojppm/rapidyaml/pull/492):  fix parser reset for full reuse (`m_doc_empty` was not resetted), which would cause problems under specific scenarios in subsequent reuse.
+- [PR#492](https://github.com/biojppm/rapidyaml/pull/492): fix parser reset for full reuse (`m_doc_empty` was not resetted), which would cause problems under specific scenarios in subsequent reuse.
+- [PR#493](https://github.com/biojppm/rapidyaml/pull/493): add handling of Byte Order Marks.
+- [PR#485](https://github.com/biojppm/rapidyaml/pull/485): improve the CI workflows (thanks to @ingydotnet):
+  - amazing code reuse and organization, thanks to the use of YamlScript to generate the final workflows
+  - all optimization levels are now covered for gcc, clang and Visual Studio.
 
 
 ## Thanks
 
+- @ingydotnet
 - @Delian0
 - @perlpunk
diff --git a/doc/Doxyfile b/doc/Doxyfile
@@ -907,7 +907,7 @@ WARN_IF_UNDOC_ENUM_VAL = YES
 # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = FAIL_ON_WARNINGS
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
@@ -959,6 +959,7 @@ INPUT                  = \
                          ../ext/c4core/src/c4/charconv.hpp \
                          ../ext/c4core/src/c4/format.hpp \
                          ../ext/c4core/src/c4/base64.hpp \
+                         ../ext/c4core/src/c4/utf.hpp \
                          ../ext/c4core/src/c4/std/string.hpp \
                          ../ext/c4core/src/c4/std/string_view.hpp \
                          ../ext/c4core/src/c4/std/vector.hpp \

diff --git a/doc/index.rst b/doc/index.rst
@@ -72,11 +72,12 @@ API teaser
 Here's a short teaser from the API quickstart overview (`see on
 doxygen <doxygen/group__doc__quickstart.html>`_ / `see full code on
 github
-<https://github.com/biojppm/rapidyaml/blob/v0.5.0/samples/quickstart.cpp>`_):
+<https://github.com/biojppm/rapidyaml/blob/v0.7.2/samples/quickstart.cpp>`_):
 
 .. code-block:: c++
 
     // Parse YAML code in place, potentially mutating the buffer:
+    // (Byte Order Marks are not accepted)
     char yml_buf[] = "{foo: 1, bar: [2, 3], john: doe}";
     ryml::Tree tree = ryml::parse_in_place(yml_buf);
 

diff --git a/ext/c4core b/ext/c4core
diff --git a/src/c4/yml/common.hpp b/src/c4/yml/common.hpp
@@ -419,6 +419,20 @@ struct RYML_EXPORT Callbacks
 /** @} */
 
 
+//-----------------------------------------------------------------------------
+//-----------------------------------------------------------------------------
+//-----------------------------------------------------------------------------
+
+typedef enum {
+    NOBOM,
+    UTF8,
+    UTF16LE,
+    UTF16BE,
+    UTF32LE,
+    UTF32BE,
+} Encoding_e;
+
+
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
@@ -476,7 +490,6 @@ do                                                                      \
     } while(0)
 
 
-
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------