# pcre2_finder

**Repository Path**: mirrors_brechtsanders/pcre2_finder

## Basic Information

- **Project Name**: pcre2_finder
- **Description**: Cross-platform C library for finding (and replacing) multiple patterns in a stream of data (using the pcre2 library).
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

pcre2_finder
============
Cross-platform C library for finding (and replacing) multiple patterns in a stream of data.

Description
-----------
The pcre2_finder library is cross-platform C library that allows searching a stream of data for multiple search patterns.
The actual searching is done using the PCRE2 library.
Multiple patterns can be searched at the same time, and multiple searches can be layered.
Layered searches means that the output of the first search is presented as input for the second search, and so on.

Goal
----
The library was written with the following goals in mind:
- written in standard C, but allows being used by C++
- speed
- small footprint
- portable across different platforms (Windows, Mac, *nix)

Libraries
---------
The following libraries are provided:
- `-lpcre2_finder` - requires `#include <pcre2_finder.h>`

Command line utilities
----------------------
Some command line utilities are included:
- `pcre2_finder_count` - counts how much time a pattern appears
- `pcre2_finder_replace` - replaces patterns with other patterns

Dependancies
------------
This project has only one external depencancy:
- PCRE2 - https://www.pcre.org/

Building from source
--------------------
Requirements:
- a C compiler like gcc or clang, on Windows MinGW and MinGW-w64 are supported
- a shell environment, on Windows MSYS is supported
- CMake version 2.6 or higher

Building with CMake
- configure by running `cmake -G"Unix Makefiles"` (or `cmake -G"MSYS Makefiles"` on Windows) optionally followed by:
  + `-DCMAKE_INSTALL_PREFIX:PATH=<path>` Base path were files will be installed
  + `-DBUILD_STATIC:BOOL=OFF` - Don't build static libraries
  + `-DBUILD_SHARED:BOOL=OFF` - Don't build shared libraries
  + `-DBUILD_TOOLS:BOOL=OFF` - Don't build tools (only libraries)
- build and install by running `make install` (or `make install/strip` to strip symbols)

For Windows prebuilt binaries are also available for download (both 32-bit and 64-bit)

License
-------
pcre2_finder is released under the terms of the 3-clause BSD license, see LICENSE.txt.

This means you are free to use pcre2_finder in any of your projects, from open source to commercial.