Upstream sync, mostly eager output interface cleanup

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
     - name: Cache checkout
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
@@ -52,7 +52,7 @@ jobs:
 
     steps:
     - name: Cache PCRE suite
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-pcre
       with:
         path: pcre-suite/${{ env.pcre2 }}
@@ -70,19 +70,20 @@ jobs:
         chmod -R ug-w pcre-suite
 
     - name: Cache converted PCRE tests
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-cvtpcre
       with:
         path: ${{ env.cvtpcre }}
         key: cvtpcre-bmake-${{ matrix.os }}-gcc-DEBUG-AUSAN-${{ github.sha }}-${{ env.pcre2 }}
 
-    - name: Fetch build
+    - name: Restore build
       if: steps.cache-cvtpcre.outputs.cache-hit != 'true'
-      uses: actions/cache@v4
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-bmake-${{ matrix.os }}-gcc-DEBUG-AUSAN-${{ github.sha }} # arbitrary build, just for cvtpcre
+        fail-on-cache-miss: true
 
     - name: Convert PCRE suite
       if: steps.cache-cvtpcre.outputs.cache-hit != 'true'
@@ -157,15 +158,16 @@ jobs:
             cc: gcc # -fsanitize=fuzzer is clang-only
 
     steps:
-    - name: Fetch checkout
-      uses: actions/cache@v4
+    - name: Restore checkout
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Cache build
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-build
       with:
         path: ${{ env.build }}
@@ -235,20 +237,26 @@ jobs:
             make: pmake # not packaged
 
     steps:
-    - name: Fetch checkout
-      uses: actions/cache@v4
+    - name: Restore checkout
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
     # An arbitary build.
-    - name: Fetch build
-      uses: actions/cache@v4
+    # Failing to fetch this is not fatal, we're testing Makefiles here.
+    # Some combinations of our options (pmake, EXPENSIVE_CHECKS, whatever)
+    # won't exist in cache because we didn't build those. That's okay for
+    # the purposes of this step, building those is harmless.
+    - name: Restore build
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-${{ matrix.make }}-${{ matrix.os }}-${{ matrix.cc }}-${{ matrix.debug }}-${{ matrix.san }}-${{ github.sha }}
+        fail-on-cache-miss: false
 
     # We don't need to build the entire repo to know that the makefiles work,
     # I'm just deleting a couple of .o files and rebuilding those instead.
@@ -324,12 +332,13 @@ jobs:
             san: MSAN # not supported
 
     steps:
-    - name: Fetch checkout
-      uses: actions/cache@v4
+    - name: Restore checkout
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Dependencies (Ubuntu)
       if: matrix.os == 'ubuntu-22.04'
@@ -346,12 +355,13 @@ jobs:
         brew install bmake pcre
         ${{ matrix.cc }} --version
 
-    - name: Fetch build
-      uses: actions/cache@v4
+    - name: Restore build
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-${{ matrix.make }}-${{ matrix.os }}-${{ matrix.cc }}-${{ matrix.debug }}-${{ matrix.san }}-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Get number of CPU cores
       uses: SimenB/github-actions-cpu-cores@v2
@@ -383,12 +393,13 @@ jobs:
             cc: gcc # it's clang anyway
 
     steps:
-    - name: Fetch checkout
-      uses: actions/cache@v4
+    - name: Restore checkout
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Dependencies (Ubuntu)
       if: matrix.os == 'ubuntu-22.04'
@@ -405,12 +416,13 @@ jobs:
         brew install bmake
         ${{ matrix.cc }} --version
 
-    - name: Fetch build
-      uses: actions/cache@v4
+    - name: Restore build
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-${{ matrix.make }}-${{ matrix.os }}-${{ matrix.cc }}-${{ matrix.debug }}-${{ matrix.san }}-${{ github.sha }}
+        fail-on-cache-miss: true
 
     # note we do the fuzzing unconditionally; each run adds to the corpus.
     #
@@ -421,7 +433,7 @@ jobs:
     # still run fuzzing, just from empty, and do not save their seeds.
     - name: Restore seeds (mode ${{ matrix.mode }})
       if: github.repository == 'katef/libfsm'
-      uses: actions/cache/restore@v4
+      uses: actions/cache/restore@v5
       id: cache-seeds
       with:
         path: ${{ env.seeds }}-${{ matrix.mode }}
@@ -458,7 +470,7 @@ jobs:
     # the same seeds for a given bug.
     # The explicit cache/restore and cache/save actions are just for that.
     - name: Save seeds (mode ${{ matrix.mode }}-${{ matrix.debug }})
-      uses: actions/cache/save@v4
+      uses: actions/cache/save@v5
       if: always()
       with:
         path: ${{ env.seeds }}-${{ matrix.mode }}
@@ -515,15 +527,16 @@ jobs:
         sudo apt-get install golang
         go version
 
-    - name: Fetch build
-      uses: actions/cache@v4
+    - name: Restore build
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-${{ matrix.make }}-${{ matrix.os }}-${{ matrix.cc }}-${{ matrix.debug }}-${{ matrix.san }}-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Fetch converted PCRE tests
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-cvtpcre
       with:
         path: ${{ env.cvtpcre }}
@@ -542,7 +555,7 @@ jobs:
 
     steps:
     - name: Cache docs
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-docs
       with:
         path: ${{ env.build }}
@@ -555,13 +568,14 @@ jobs:
         sudo apt-get update
         sudo apt-get install bmake libxml2-utils xsltproc docbook-xml docbook-xsl
 
-    - name: Fetch checkout
+    - name: Restore checkout
       if: steps.cache-docs.outputs.cache-hit != 'true'
-      uses: actions/cache@v4
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Get number of CPU cores
       if: steps.cache-docs.outputs.cache-hit != 'true'
@@ -597,7 +611,7 @@ jobs:
 
     steps:
     - name: Cache prefix
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       id: cache-prefix
       with:
         path: ${{ env.prefix }}
@@ -609,29 +623,32 @@ jobs:
         uname -a
         sudo apt-get install bmake
 
-    - name: Fetch checkout
+    - name: Restore checkout
       if: steps.cache-prefix.outputs.cache-hit != 'true'
-      uses: actions/cache@v4
+      uses: actions/cache/restore@v5
       id: cache-checkout
       with:
         path: ${{ env.wc }}
         key: checkout-${{ github.sha }}
+        fail-on-cache-miss: true
 
-    - name: Fetch build
+    - name: Restore build
       if: steps.cache-prefix.outputs.cache-hit != 'true'
-      uses: actions/cache@v4
+      uses: actions/cache/restore@v5
       id: cache-build
       with:
         path: ${{ env.build }}
         key: build-${{ env.make }}-${{ env.os }}-${{ env.cc }}-${{ env.debug }}-${{ env.san }}-${{ github.sha }}
+        fail-on-cache-miss: true
 
-    - name: Fetch docs
+    - name: Restore docs
       if: steps.cache-prefix.outputs.cache-hit != 'true'
-      uses: actions/cache@v4
+      uses: actions/cache/restore@v5
       id: cache-docs
       with:
         path: ${{ env.build }}
         key: docs-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Get number of CPU cores
       if: steps.cache-prefix.outputs.cache-hit != 'true'
@@ -670,12 +687,13 @@ jobs:
         sudo gem install --no-document fpm
         fpm -v
 
-    - name: Fetch prefix
-      uses: actions/cache@v4
+    - name: Restore prefix
+      uses: actions/cache/restore@v5
       id: cache-prefix
       with:
         path: ${{ env.prefix }}
         key: prefix-${{ env.make }}-${{ env.os }}-${{ env.cc }}-${{ env.debug }}-${{ env.san }}-${{ github.sha }}
+        fail-on-cache-miss: true
 
     - name: Find version
       # TODO: would get a tag or branch name here

Makefile

@@ -125,8 +125,7 @@ SUBDIR += tests/fsm
 SUBDIR += tests/glob
 SUBDIR += tests/like
 SUBDIR += tests/literal
-# FIXME: commenting this out for now due to Makefile error
-#SUBDIR += tests/lxpos
+SUBDIR += tests/lxpos
 SUBDIR += tests/minimise
 SUBDIR += tests/native
 SUBDIR += tests/pcre
@@ -137,6 +136,7 @@ SUBDIR += tests/pcre-repeat
 SUBDIR += tests/pred
 SUBDIR += tests/re_literal
 SUBDIR += tests/re_strings
+SUBDIR += tests/regressions
 SUBDIR += tests/reverse
 SUBDIR += tests/trim
 SUBDIR += tests/union
@@ -147,6 +147,7 @@ SUBDIR += tests/sql
 SUBDIR += tests/queue
 SUBDIR += tests/aho_corasick
 SUBDIR += tests/retest
+SUBDIR += tests/re_interpolate_groups
 SUBDIR += tests
 .if make(theft) || make(${BUILD}/theft/theft)
 SUBDIR += theft
@@ -190,6 +191,6 @@ STAGE_BUILD := ${STAGE_BUILD:Nbin/cvtpcre}
 
 .if make(test)
 .END::
-	grep FAIL ${BUILD}/tests/*/res*; [ $$? -ne 0 ]
+	grep -I FAIL ${BUILD}/tests/*/*res*; [ $$? -ne 0 ]
 .endif
 

README.md

@@ -4,12 +4,15 @@
     ; re -cb -pl dot '[Ll]ibf+(sm)*' '[Ll]ibre' | dot
 ![libfsm.svg](doc/tutorial/libfsm.svg)
 
+libfsm is not a drop-in replacement for other regex engines, and it only supports patterns that can be compiled to deterministic FSMs. In return, supported patterns run in linear time.
+
 Getting started:
 
  * See the [tutorial introduction](doc/tutorial/re.md) for a quick overview
    of the re(1) command line interface.
  * [Compilation phases](doc/tutorial/phases.md) for typical applications
    which compile regular expressions to code.
+ * [Advice on using libfsm](doc/advice.md) for suggestions around compilation time, unsupported features, common usage patterns, and examples.
 
 You get: