Oniguruma

For a long time, Oniguruma has been under attack on Google search. (Issue #234)

https://github.com/kkos/oniguruma

Oniguruma is a modern and flexible regular expressions library. Itencompasses features from different regular expression implementationsthat traditionally exist in different languages.

Character encoding can be specified per regular expression object.

Supported character encodings:

ASCII, UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE,EUC-JP, EUC-TW, EUC-KR, EUC-CN,Shift_JIS, Big5, GB18030, KOI8-R, CP1251,ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5,ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-10,ISO-8859-11, ISO-8859-13, ISO-8859-14, ISO-8859-15, ISO-8859-16

• GB18030: contributed by KUBO Takehiro
• CP1251: contributed by Byte
• doc/SYNTAX.md: contributed by seanofw

Notice (from 6.9.6)

When using configure script, if you have the POSIX API enabled in an earlier version (disabled by default in 6.9.5) and you need application binary compatibility with the POSIX API, specify "--enable-binary-compatible-posix-api=yes" instead of "--enable-posix-api=yes". Starting in 6.9.6, "--enable-posix-api=yes" only supports source-level compatibility for 6.9.5 and earlier about POSIX API. (Issue #210)

Version 6.9.7

• NEW API: ONIG_OPTION_CALLBACK_EACH_MATCH
• NEW API: ONIG_OPTION_IGNORECASE_IS_ASCII
• NEW API: ONIG_SYNTAX_PYTHON
• Fixed some problems found by OSS-Fuzz

Version 6.9.6

• NEW: configure option --enable-binary-compatible-posix-api=[yes/no]
• NEW API: Limiting the maximum number of calls of subexp-call
• NEW API: ONIG_OPTION_NOT_BEGIN_STRING / NOT_END_STRING / NOT_BEGIN_POSITION
• Fixed behavior of ONIG_OPTION_NOTBOL / NOTEOL
• Fixed many problems found by OSS-Fuzz
• Fixed many problems found by Coverity
• Fixed CVE-2020-26159 (This turned out not to be a problem later. #221)
• Under cygwin and mingw, generate and install the libonig.def file (Issue #220)

Version 6.9.5 revised 1

• Fixed Issue #192

Version 6.9.5

• POSIX API disabled by default for Unix (* Enabled by: configure --enable-posix-api=yes)
• Update Unicode version 13.0.0
• NEW: Code point sequence notation \x{HHHH HHHH ...}, \o{OOOO OOOO ...}
• NEW API: retry limit in search functions
• NEW API: maximum nesting level of subexp call
• Fixed behavior of isolated options in Perl and Java syntaxes. /...(?i).../

Version 6.9.4

• NEW API: RegSet (set of regexes)
• Fixed CVE-2019-19012
• Fixed CVE-2019-19203 (Does not affect UTF-8, UTF-16 and UTF-32 encodings)
• Fixed CVE-2019-19204 (Affects only PosixBasic, Emacs and Grep syntaxes)
• Fixed CVE-2019-19246
• Fixed some problems (found by libFuzzer test)

Version 6.9.3 (security fix release)

• Fixed CVE-2019-13224
• Fixed CVE-2019-13225
• Fixed CVE-2019-16163
• Fixed many problems (found by libFuzzer test)

Version 6.9.2 (Reiwa)

• add doc/SYNTAX.md
• Direct threaded code (for GCC and Clang)
• Update Unicode version 12.1.0
• NEW: Unicode Text Segment mode option (?y{g}) (?y{w}) (*original)

Version 6.9.1

• Speed improvement (* especially UTF-8)

Version 6.9.0

• Update Unicode version 11.0.0
• NEW: add Emoji properties

License

BSD license.

Install

Case 1: Linux distribution packages

• Fedora: dnf install oniguruma
• RHEL/CentOS: yum install oniguruma
• Debian/Ubuntu: apt install libonig5
• Arch: pacman -S oniguruma
• openSUSE: zypper install oniguruma

Case 2: Manual compilation on Linux, Unix, and Cygwin platform

1. autoreconf -vfi (* case: configure script is not found.)

2. ./configure

3. make

4. make install

• uninstall

  make uninstall

• configuration check

  onig-config --cflagsonig-config --libsonig-config --prefixonig-config --exec-prefix

Case 3: Windows 64/32bit platform (Visual Studio)

• build library

  .\make_win.bat

  onig_s.lib: static link libraryonig.dll: dynamic link library

• make test programs

  .\make_win.bat all-test

Alternatively, you can build and install oniguruma using vcpkg dependency manager:

1. git clone https://github.com/Microsoft/vcpkg.git
2. cd vcpkg
3. ./bootstrap-vcpkg.bat
4. ./vcpkg integrate install
5. ./vcpkg install oniguruma

The oniguruma port in vcpkg is kept up to date by microsoft team members and community contributors.If the version is out of date, please create an issue or pull request on the vcpkg repository.

Regular Expressions

See doc/RE or doc/RE.ja for Japanese.

Usage

Include oniguruma.h in your program. (Oniguruma API)See doc/API for Oniguruma API.

If you want to disable UChar type (== unsigned char) definitionin oniguruma.h, define ONIG_ESCAPE_UCHAR_COLLISION and theninclude oniguruma.h.

If you want to disable regex_t type definition in oniguruma.h,define ONIG_ESCAPE_REGEX_T_COLLISION and then include oniguruma.h.

Example of the compiling/linking command line in Unix or Cygwin,(prefix == /usr/local case)

cc sample.c -L/usr/local/lib -lonig

If you want to use static link library(onig_s.lib) in Win32,add option -DONIG_EXTERN=extern to C compiler.

Sample Programs

Test Programs

Source Files