tree: ad420e139ce49f9c44ff64ca8f87ae0c44c71fe1 [path history] [tgz]
  1. cmake/
  2. doc/
  3. harnesses/
  4. sample/
  5. src/
  6. test/
  7. tis-ci/
  8. windows/
  9. AUTHORS
  10. autogen.sh
  11. ChangeLog
  12. CMakeLists.txt
  13. compile
  14. config.guess
  15. config.sub
  16. configure.ac
  17. COPYING
  18. depcomp
  19. HISTORY
  20. index.html
  21. index_ja.html
  22. INSTALL
  23. install-sh
  24. make_win.bat
  25. make_win32.bat
  26. make_win64.bat
  27. Makefile.am
  28. missing
  29. NEWS
  30. onig-config.cmake.in
  31. onig-config.in
  32. oniguruma.pc.cmake.in
  33. oniguruma.pc.in
  34. README
  35. README.md
  36. README_japanese
  37. test-driver
  38. tis.config
vendor/onig_sys-69.8.1/oniguruma/README.md

Build Status Code Quality: Cpp Total Alerts Fuzzing Status TrustInSoft CI

Oniguruma

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

https://github.com/kkos/oniguruma

Oniguruma is a modern and flexible regular expressions library. It encompasses features from different regular expression implementations that 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.8 (== Master branch / unreleased)

  • Update Unicode version 14.0.0
  • Whole options
    • (?C) : ONIG_OPTION_DONT_CAPTURE_GROUP
    • (?I) : ONIG_OPTION_IGNORECASE_IS_ASCII
    • (?L) : ONIG_OPTION_FIND_LONGEST
  • Fixed some problems found by OSS-Fuzz

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)

License

BSD license.

Install

Case 1: Linux distribution packages

  • Fedora: dnf install oniguruma-devel
  • 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 --cflags onig-config --libs onig-config --prefix onig-config --exec-prefix

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

  • build library

    .\make_win.bat

    onig_s.lib: static link library onig.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) definition in oniguruma.h, define ONIG_ESCAPE_UCHAR_COLLISION and then include 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

FileDescription
sample/callout.cexample of callouts
sample/count.cexample of built-in callout *COUNT
sample/echo.cexample of user defined callouts of name
sample/encode.cexample of some encodings
sample/listcap.cexample of the capture history
sample/names.cexample of the named group callback
sample/posix.cPOSIX API sample
sample/regset.cexample of using RegSet API
sample/scan.cexample of using onig_scan()
sample/simple.cexample of the minimum (Oniguruma API)
sample/sql.cexample of the variable meta characters
sample/user_property.cexample of user defined Unicode property

Test Programs

FileDescription
sample/syntax.cPerl, Java and ASIS syntax test.
sample/crnl.c--enable-crnl-as-line-terminator test

Source Files

FileDescription
oniguruma.hOniguruma API header file (public)
onig-config.inconfiguration check program template
regenc.hcharacter encodings framework header file
regint.hinternal definitions
regparse.hinternal definitions for regparse.c and regcomp.c
regcomp.ccompiling and optimization functions
regenc.ccharacter encodings framework
regerror.cerror message function
regext.cextended API functions (deluxe version API)
regexec.csearch and match functions
regparse.cparsing functions.
regsyntax.cpattern syntax functions and built-in syntax definitions
regtrav.ccapture history tree data traverse functions
regversion.cversion info function
st.hhash table functions header file
st.chash table functions
oniggnu.hGNU regex API header file (public)
reggnu.cGNU regex API functions
onigposix.hPOSIX API header file (public)
regposerr.cPOSIX error message function
regposix.cPOSIX API functions
mktable.ccharacter type table generator
ascii.cASCII encoding
euc_jp.cEUC-JP encoding
euc_tw.cEUC-TW encoding
euc_kr.cEUC-KR, EUC-CN encoding
sjis.cShift_JIS encoding
big5.cBig5 encoding
gb18030.cGB18030 encoding
koi8.cKOI8 encoding
koi8_r.cKOI8-R encoding
cp1251.cCP1251 encoding
iso8859_1.cISO-8859-1 (Latin-1)
iso8859_2.cISO-8859-2 (Latin-2)
iso8859_3.cISO-8859-3 (Latin-3)
iso8859_4.cISO-8859-4 (Latin-4)
iso8859_5.cISO-8859-5 (Cyrillic)
iso8859_6.cISO-8859-6 (Arabic)
iso8859_7.cISO-8859-7 (Greek)
iso8859_8.cISO-8859-8 (Hebrew)
iso8859_9.cISO-8859-9 (Latin-5 or Turkish)
iso8859_10.cISO-8859-10 (Latin-6 or Nordic)
iso8859_11.cISO-8859-11 (Thai)
iso8859_13.cISO-8859-13 (Latin-7 or Baltic Rim)
iso8859_14.cISO-8859-14 (Latin-8 or Celtic)
iso8859_15.cISO-8859-15 (Latin-9 or West European with Euro)
iso8859_16.cISO-8859-16 (Latin-10)
utf8.cUTF-8 encoding
utf16_be.cUTF-16BE encoding
utf16_le.cUTF-16LE encoding
utf32_be.cUTF-32BE encoding
utf32_le.cUTF-32LE encoding
unicode.ccommon codes of Unicode encoding
unicode_fold_data.cUnicode folding data
windows/testc.cTest program for Windows (VC++)