MdeModulePkg: Regular expression protocol

[mirror_edk2.git] / MdeModulePkg / Universal / RegularExpressionDxe / Oniguruma / README

README  2007/05/31\r
\r
Oniguruma  ----   (C) K.Kosako <sndgk393 AT ybb DOT ne DOT jp>\r
\r
http://www.geocities.jp/kosako3/oniguruma/\r
\r
Oniguruma is a regular expressions library.\r
The characteristics of this library is that different character encoding\r
for every regular expression object can be specified.\r
\r
Supported character encodings:\r
\r
  ASCII, UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE,\r
  EUC-JP, EUC-TW, EUC-KR, EUC-CN,\r
  Shift_JIS, Big5, GB18030, KOI8-R, CP1251,\r
  ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5,\r
  ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-10,\r
  ISO-8859-11, ISO-8859-13, ISO-8859-14, ISO-8859-15, ISO-8859-16\r
\r
* GB18030: contributed by KUBO Takehiro\r
* CP1251:  contributed by Byte\r
------------------------------------------------------------\r
\r
License\r
\r
   BSD license.\r
\r
\r
Install\r
\r
 Case 1: Unix and Cygwin platform\r
\r
   1. ./configure\r
   2. make\r
   3. make install\r
\r
   * uninstall\r
\r
     make uninstall\r
\r
   * test (ASCII/EUC-JP)\r
\r
     make atest\r
\r
   * configuration check\r
\r
     onig-config --cflags\r
     onig-config --libs\r
     onig-config --prefix\r
     onig-config --exec-prefix\r
\r
\r
\r
 Case 2: Win32 platform (VC++)\r
\r
   1. copy win32\Makefile Makefile\r
   2. copy win32\config.h config.h\r
   3. nmake\r
\r
      onig_s.lib:  static link library\r
      onig.dll:    dynamic link library\r
\r
  * test (ASCII/Shift_JIS)\r
   4. copy win32\testc.c testc.c\r
   5. nmake ctest\r
\r
\r
\r
Regular Expressions\r
\r
  See doc/RE (or doc/RE.ja for Japanese).\r
\r
\r
Usage\r
\r
  Include oniguruma.h in your program. (Oniguruma API)\r
  See doc/API for Oniguruma API.\r
\r
  If you want to disable UChar type (== unsigned char) definition\r
  in oniguruma.h, define ONIG_ESCAPE_UCHAR_COLLISION and then \r
  include oniguruma.h.\r
\r
  If you want to disable regex_t type definition in oniguruma.h,\r
  define ONIG_ESCAPE_REGEX_T_COLLISION and then include oniguruma.h.\r
\r
  Example of the compiling/linking command line in Unix or Cygwin,\r
  (prefix == /usr/local case)\r
\r
    cc sample.c -L/usr/local/lib -lonig\r
\r
\r
  If you want to use static link library(onig_s.lib) in Win32,\r
  add option -DONIG_EXTERN=extern to C compiler.\r
\r
\r
\r
Sample Programs\r
\r
  sample/simple.c    example of the minimum (Oniguruma API)\r
  sample/names.c     example of the named group callback.\r
  sample/encode.c    example of some encodings.\r
  sample/listcap.c   example of the capture history.\r
  sample/posix.c     POSIX API sample.\r
  sample/sql.c       example of the variable meta characters.\r
                     (SQL-like pattern matching)\r
\r
Test Programs\r
  sample/syntax.c    Perl, Java and ASIS syntax test.\r
  sample/crnl.c      --enable-crnl-as-line-terminator test\r
\r
\r
Source Files\r
\r
  oniguruma.h        Oniguruma API header file. (public)\r
  onig-config.in     configuration check program template.\r
\r
  regenc.h           character encodings framework header file.\r
  regint.h           internal definitions\r
  regparse.h         internal definitions for regparse.c and regcomp.c\r
  regcomp.c          compiling and optimization functions\r
  regenc.c           character encodings framework.\r
  regerror.c         error message function\r
  regext.c           extended API functions. (deluxe version API)\r
  regexec.c          search and match functions\r
  regparse.c         parsing functions.\r
  regsyntax.c        pattern syntax functions and built-in syntax definitions.\r
  regtrav.c          capture history tree data traverse functions.\r
  regversion.c       version info function.\r
  st.h               hash table functions header file\r
  st.c               hash table functions\r
\r
  oniggnu.h          GNU regex API header file. (public)\r
  reggnu.c           GNU regex API functions\r
\r
  onigposix.h        POSIX API header file. (public)\r
  regposerr.c        POSIX error message function.\r
  regposix.c         POSIX API functions.\r
\r
  enc/mktable.c      character type table generator.\r
  enc/ascii.c        ASCII encoding.\r
  enc/euc_jp.c       EUC-JP encoding.\r
  enc/euc_tw.c       EUC-TW encoding.\r
  enc/euc_kr.c       EUC-KR, EUC-CN encoding.\r
  enc/sjis.c         Shift_JIS encoding.\r
  enc/big5.c         Big5      encoding.\r
  enc/gb18030.c      GB18030   encoding.\r
  enc/koi8.c         KOI8      encoding.\r
  enc/koi8_r.c       KOI8-R    encoding.\r
  enc/cp1251.c       CP1251    encoding.\r
  enc/iso8859_1.c    ISO-8859-1  encoding. (Latin-1)\r
  enc/iso8859_2.c    ISO-8859-2  encoding. (Latin-2)\r
  enc/iso8859_3.c    ISO-8859-3  encoding. (Latin-3)\r
  enc/iso8859_4.c    ISO-8859-4  encoding. (Latin-4)\r
  enc/iso8859_5.c    ISO-8859-5  encoding. (Cyrillic)\r
  enc/iso8859_6.c    ISO-8859-6  encoding. (Arabic)\r
  enc/iso8859_7.c    ISO-8859-7  encoding. (Greek)\r
  enc/iso8859_8.c    ISO-8859-8  encoding. (Hebrew)\r
  enc/iso8859_9.c    ISO-8859-9  encoding. (Latin-5 or Turkish)\r
  enc/iso8859_10.c   ISO-8859-10 encoding. (Latin-6 or Nordic)\r
  enc/iso8859_11.c   ISO-8859-11 encoding. (Thai)\r
  enc/iso8859_13.c   ISO-8859-13 encoding. (Latin-7 or Baltic Rim)\r
  enc/iso8859_14.c   ISO-8859-14 encoding. (Latin-8 or Celtic)\r
  enc/iso8859_15.c   ISO-8859-15 encoding. (Latin-9 or West European with Euro)\r
  enc/iso8859_16.c   ISO-8859-16 encoding.\r
                     (Latin-10 or South-Eastern European with Euro)\r
  enc/utf8.c         UTF-8    encoding.\r
  enc/utf16_be.c     UTF-16BE encoding.\r
  enc/utf16_le.c     UTF-16LE encoding.\r
  enc/utf32_be.c     UTF-32BE encoding.\r
  enc/utf32_le.c     UTF-32LE encoding.\r
  enc/unicode.c      Unicode information data.\r
\r
  win32/Makefile     Makefile for Win32 (VC++)\r
  win32/config.h     config.h for Win32\r
\r
\r
\r
ToDo\r
\r
  ? case fold flag: Katakana <-> Hiragana.\r
  ? add ONIG_OPTION_NOTBOS/NOTEOS. (\A, \z, \Z)\r
 ?? \X (== \PM\pM*)\r
 ?? implement syntax behavior ONIG_SYN_CONTEXT_INDEP_ANCHORS.\r
 ?? transmission stopper. (return ONIG_STOP from match_at())\r
\r
and I'm thankful to Akinori MUSHA.\r
\r
\r
Mail Address: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>\r