֥󥿡ե Version 4.7.1   2007/07/04

#include <oniguruma.h>


# int onig_init(void)

  饤֥ν

  onig_new()ǸƤӽФΤǡδؿŪ˸ƤӽФʤƤ褤


# int onig_error_code_to_str(UChar* err_buf, int err_code, ...)

  顼å롣

  δؿonig_new()η̤ФƸƤӽФˤϡonig_new()pattern
  ˸ƤӽФʤФʤʤ

  ｪλ: 顼åʸΥХĹ

  
  1 err_buf:              顼åǼΰ
                          (ɬפʥ: ONIG_MAX_ERROR_MESSAGE_LEN)
  2 err_code:             顼
  3 err_info (optional):  onig_new()err_info


# void onig_set_warn_func(OnigWarnFunc func)

  ٹδؿ򥻥åȤ롣

  ٹ:
    '[', '-', ']' in character class without escape.
    ']' in pattern without escape.

  
  1 func:    ٹؿ    void (*func)(char* warning_message)


# void onig_set_verb_warn_func(OnigWarnFunc func)

  ܺٷٹδؿ򥻥åȤ롣

  ܺٷٹ:
    redundant nested repeat operator.

  
  1 func:    ܺٷٹؿ    void (*func)(char* warning_message)


# int onig_new(regex_t** reg, const UChar* pattern, const UChar* pattern_end,
            OnigOptionType option, OnigEncoding enc, OnigSyntaxType* syntax,
            OnigErrorInfo* err_info)

  ɽ֥(regex)롣

  ｪλ: ONIG_NORMAL

  
  1 reg:         줿ɽ֥Ȥ֤ɥ쥹
  2 pattern:     ɽѥʸ
  3 pattern_end: ɽѥʸνüɥ쥹(pattern + pattern length)
  4 option:      ɽѥץ

      ONIG_OPTION_NONE               ץʤ
      ONIG_OPTION_SINGLELINE         '^' -> '\A', '$' -> '\Z'
      ONIG_OPTION_MULTILINE          '.'Ԥ˥ޥå
      ONIG_OPTION_IGNORECASE         ۣޥå 
      ONIG_OPTION_EXTEND             ѥĥ
      ONIG_OPTION_FIND_LONGEST       Ĺޥå
      ONIG_OPTION_FIND_NOT_EMPTY     ޥå̵
      ONIG_OPTION_NEGATE_SINGLELINE
            ONIG_SYNTAX_POSIX_BASIC, ONIG_SYNTAX_POSIX_EXTENDED,
            ONIG_SYNTAX_PERL, ONIG_SYNTAX_PERL_NG, ONIG_SYNTAX_JAVA
            ǥեȤͭONIG_OPTION_SINGLELINE򥯥ꥢ롣

      ONIG_OPTION_DONT_CAPTURE_GROUP ̾դͼΤ
      ONIG_OPTION_CAPTURE_GROUP      ̵̾ͼ

  5 enc:        ʸ󥳡ǥ

      ONIG_ENCODING_ASCII         ASCII
      ONIG_ENCODING_ISO_8859_1    ISO 8859-1
      ONIG_ENCODING_ISO_8859_2    ISO 8859-2
      ONIG_ENCODING_ISO_8859_3    ISO 8859-3
      ONIG_ENCODING_ISO_8859_4    ISO 8859-4
      ONIG_ENCODING_ISO_8859_5    ISO 8859-5
      ONIG_ENCODING_ISO_8859_6    ISO 8859-6
      ONIG_ENCODING_ISO_8859_7    ISO 8859-7
      ONIG_ENCODING_ISO_8859_8    ISO 8859-8
      ONIG_ENCODING_ISO_8859_9    ISO 8859-9
      ONIG_ENCODING_ISO_8859_10   ISO 8859-10
      ONIG_ENCODING_ISO_8859_11   ISO 8859-11
      ONIG_ENCODING_ISO_8859_13   ISO 8859-13
      ONIG_ENCODING_ISO_8859_14   ISO 8859-14
      ONIG_ENCODING_ISO_8859_15   ISO 8859-15
      ONIG_ENCODING_ISO_8859_16   ISO 8859-16
      ONIG_ENCODING_UTF8          UTF-8
      ONIG_ENCODING_UTF16_BE      UTF-16BE
      ONIG_ENCODING_UTF16_LE      UTF-16LE
      ONIG_ENCODING_UTF32_BE      UTF-32BE
      ONIG_ENCODING_UTF32_LE      UTF-32LE
      ONIG_ENCODING_EUC_JP        EUC-JP
      ONIG_ENCODING_EUC_TW        EUC-TW
      ONIG_ENCODING_EUC_KR        EUC-KR
      ONIG_ENCODING_EUC_CN        EUC-CN
      ONIG_ENCODING_SJIS          Shift_JIS
      ONIG_ENCODING_KOI8          KOI8
      ONIG_ENCODING_KOI8_R        KOI8-R
      ONIG_ENCODING_BIG5          Big5
      ONIG_ENCODING_GB18030       GB 18030

      ޤϡ桼OnigEncodingTypeǡΥɥ쥹

  6 syntax:     ɽѥʸˡ

      ONIG_SYNTAX_ASIS              plain text
      ONIG_SYNTAX_POSIX_BASIC       POSIX Basic RE
      ONIG_SYNTAX_POSIX_EXTENDED    POSIX Extended RE
      ONIG_SYNTAX_EMACS             Emacs
      ONIG_SYNTAX_GREP              grep
      ONIG_SYNTAX_GNU_REGEX         GNU regex
      ONIG_SYNTAX_JAVA              Java (Sun java.util.regex)
      ONIG_SYNTAX_PERL              Perl
      ONIG_SYNTAX_PERL_NG           Perl + ̾դͼ
      ONIG_SYNTAX_RUBY              Ruby
      ONIG_SYNTAX_DEFAULT           default (== Ruby)
                                    onig_set_default_syntax()

      ޤϡ桼OnigSyntaxTypeǡΥɥ쥹

  7 err_info: 顼֤Υɥ쥹
              onig_error_code_to_str()λܤΰȤƻѤ


# int onig_new_deluxe(regex_t** reg, const UChar* pattern, const UChar* pattern_end,
                      OnigCompileInfo* ci, OnigErrorInfo* einfo)

  ɽ֥(regex)롣
  δؿϡonig_new()Υǥåǡ

  ｪλ: ONIG_NORMAL

  
  1 reg:         줿ɽ֥Ȥ֤ɥ쥹
  2 pattern:     ɽѥʸ
  3 pattern_end: ɽѥʸνüɥ쥹(pattern + pattern length)
  4 ci:          ѥ

    ci->num_of_elements: ciǿ (ߤǤǤ: 5)
    ci->pattern_enc:     ѥʸʸ󥳡ǥ
    ci->target_enc:      оʸʸ󥳡ǥ
    ci->syntax:          ɽѥʸˡ
    ci->option:          ɽѥץ
    ci->ambig_flag:      ONIG_OPTION_IGNORECASE⡼ɤǤ
                         ʸۣޥåӥåȥե饰

       ONIGENC_AMBIGUOUS_MATCH_NONE:          ̵ۣ
       ONIGENC_AMBIGUOUS_MATCH_ASCII_CASE:    ASCIIʸʸ
       ONIGENC_AMBIGUOUS_MATCH_NONASCII_CASE: ASCIIʳʸʸ
       ONIGENC_AMBIGUOUS_MATCH_FULL:          Ƥۣե饰ͭ
       ONIGENC_AMBIGUOUS_MATCH_DEFAULT:       (ASCII | NONASCII)
                                              onig_set_default_ambig_flag()

  5 err_info:    顼֤Υɥ쥹
                 onig_error_code_to_str()λܤΰȤƻѤ


  ۤʤʸ󥳡ǥ󥰤Ȥ߹碌ϡʲξˤΤߵ롣

    pattern_enc: ASCII, ISO_8859_1
    target_enc:  UTF16_BE, UTF16_LE, UTF32_BE, UTF32_LE

    pattern_enc: UTF16_BE/LE
    target_enc:  UTF16_LE/BE

    pattern_enc: UTF32_BE/LE
    target_enc:  UTF32_LE/BE


# void onig_free(regex_t* reg)

  ɽ֥ȤΥ롣

  
  1 reg: ɽ֥



# int onig_search(regex_t* reg, const UChar* str, const UChar* end, const UChar* start,
                   const UChar* range, OnigRegion* region, OnigOptionType option)

  ɽʸ򸡺̤ȥޥåΰ֤

  ｪλ: ޥå (p - str >= 0)
  :       ONIG_MISMATCH (< 0)

  
  1 reg:    ɽ֥
  2 str:    оʸ
  3 end:    оʸνüɥ쥹
  4 start:  оʸθƬֳϥɥ쥹
  5 range:  оʸθƬֽüɥ쥹
    õ  (start <= õʸƬ < range)
    õ  (range <= õʸƬ <= start)
  6 region: ޥåΰ(region)  (NULL)
  7 option: ץ

    ONIG_OPTION_NOTBOL        ʸƬ(str)Ƭȴʤ
    ONIG_OPTION_NOTEOL        ʸνü(end)ȴʤ
    ONIG_OPTION_POSIX_REGION  regionPOSIX APIregmatch_t[]ˤ


# int onig_match(regex_t* reg, const UChar* str, const UChar* end, const UChar* at,
		 OnigRegion* region, OnigOptionType option)

  ʸλ֤ǥޥå󥰤Ԥ̤ȥޥåΰ֤

  ｪλ: ޥåХĹ (>= 0)
  not match:      ONIG_MISMATCH      ( < 0)

  
  1 reg:    ɽ֥
  2 str:    оʸ
  3 end:    оʸνüɥ쥹
  4 at:     оʸθɥ쥹
  5 region: ޥåΰ(region)  (NULL)
  6 option: ץ

    ONIG_OPTION_NOTBOL        ʸƬ(str)Ƭȴʤ
    ONIG_OPTION_NOTEOL        ʸνü(end)ȴʤ
    ONIG_OPTION_POSIX_REGION  regionPOSIX APIregmatch_t[]ˤ


# OnigRegion* onig_region_new(void)

  ޥåΰ(region)롣


# void onig_region_free(OnigRegion* region, int free_self)

  ޥåΰ(region)ǻѤƤ롣

  
  1 region:    ޥåΰ󥪥֥
  2 free_self:  [1: regionȤޤƲ, 0: regionȤϲʤ]


# void onig_region_copy(OnigRegion* to, OnigRegion* from)

  ޥåΰ(region)ʣ롣

  
  1 to:   оΰ
  2 from: ΰ


# void onig_region_clear(OnigRegion* region)

  ޥåΰ(region)̣򥯥ꥢ롣

  
  1 region: оΰ


# int onig_region_resize(OnigRegion* region, int n)

  ޥåΰ(region)ͼ(롼)ѹ롣

  ｪλ: ONIG_NORMAL

  
  1 region: оΰ
  2 n:      


# int onig_name_to_group_numbers(regex_t* reg, const UChar* name, const UChar* name_end,
                                  int** num_list)

  ꤷ̾Ф̾դͼ(롼)
  롼ֹꥹȤ֤
  ̾դͼϡ(?<name>....)ˤäǤ롣

  ｪλ:  ꤵ줿̾Ф륰롼׿
                   ( /(?<x>..)(?<x>..)/  ==>  2)
  ̾Ф륰롼פ¸ߤʤ: -1

  
  1 reg:       ɽ֥
  2 name:      ͼ(롼)̾
  3 name_end:  ͼ(롼)̾νüɥ쥹
  4 num_list:  ֹꥹȤ֤ɥ쥹


# int onig_name_to_backref_number(regex_t* reg, const UChar* name, const UChar* name_end,
                                  OnigRegion *region)

  ꤵ줿̾θ(\k<name>)Фͼ(롼)ֹ֤
  ̾ФơʣΥޥåΰ褬ͭǤСκֹ֤
  ̾Фͼ礬ĤʤȤˤϡбޥåΰ褬ͭ
  ɤ˴طʤֹ֤(äơregionˤNULLϤƤ褤)

  ｪλ: ֹ

  
  1 reg:       ɽ֥
  2 name:      ͼ(롼)̾
  3 name_end:  ͼ(롼)̾νüɥ쥹
  4 region:    search/match̤Υޥåΰ


# int onig_foreach_name(regex_t* reg,
                        int (*func)(const UChar*, const UChar*, int,int*,regex_t*,void*),
                        void* arg)

  Ƥ̾ФƥХåؿƤӽФ¹Ԥ롣

  ｪλ: 0
  顼:         Хåؿ

  
  1 reg:     ɽ֥
  2 func:    Хåؿ
             func(name, name_end, <number of groups>, <group number's list>,
                  reg, arg);

             func0ʳ֤ͤȡʹߤΥХåϹԤʤ鷺
             λ롣

  3 arg:     funcФɲð


# int onig_number_of_names(regex_t* reg)

  ѥ줿̾ο֤
  Ĥ̾¿ϰĤȴ

  
  1 reg:    ɽ֥


# OnigEncoding    onig_get_encoding(regex_t* reg)
# OnigOptionType  onig_get_options(regex_t* reg)
# OnigAmbigType   onig_get_ambig_flag(regex_t* reg)
# OnigSyntaxType* onig_get_syntax(regex_t* reg)

  ɽ֥ȤФơб֤ͤ

  
  1 reg:    ɽ֥


# int onig_number_of_captures(regex_t* reg)

  ѥ줿ͥ롼פο֤

  
  1 reg:    ɽ֥


# int onig_number_of_capture_histories(regex_t* reg)

  ѥ줿(?@...)ο֤

  Ѥʸˡǽͭ(ONIG_SYN_OP2_ATMARK_CAPTURE_HISTORY)
  ǤʤСǽϻѤǤʤ

  
  1 reg:    ɽ֥


# OnigCaptureTreeNode* onig_get_capture_tree(OnigRegion* region)

  ǡΥ롼ȥΡɤ֤

  ޥåԤƤˤϡͤǤ롣

  
  1 region: ޥåΰ


# int onig_capture_tree_traverse(OnigRegion* region, int at,
                  int(*func)(int,int,int,int,int,void*), void* arg)

  ǡڤ󤷤ƥХå롣

  ｪλ: 0
  顼:         Хåؿ

  
  1 region:  ޥåΰ
  2 at:      ХåԤʤߥ

    ONIG_TRAVERSE_CALLBACK_AT_FIRST:
        ǽ˥ХåơҥΡɤ
    ONIG_TRAVERSE_CALLBACK_AT_LAST:
        ҥΡɤ󤷤ơХå
    ONIG_TRAVERSE_CALLBACK_AT_BOTH:
        ǽ˥ХåơҥΡɤ󡢺Ǹˤ⤦٥Хå

  3 func:    Хåؿ
             func0ʳ֤ͤȡʹߤνϹԤʤ鷺
             λ롣

             int func(int group, int beg, int end, int level, int at,
                      void* arg)
               group: 롼ֹ
               beg:   ޥåϰ
               end    ޥåλ
               level: ͥȥ٥ (0)
               at:    ХåƤӽФ줿ߥ
                      ONIG_TRAVERSE_CALLBACK_AT_FIRST
                      ONIG_TRAVERSE_CALLBACK_AT_LAST
               arg:   ɲð

  4 arg;     funcФɲð


# int onig_noname_group_capture_is_active(regex_t* reg)

  ̾ʤ͵ǽͭɤ֤

  ͭ: 1
  ̵: 0

  
  1 reg:    ɽ֥


  ץONIG_OPTION_DONT_CAPTURE_GROUPON --> ̵

  ѥ̾ĤѤƤ
  AND ʸˡǡONIG_SYN_CAPTURE_ONLY_NAMED_GROUPON
  AND ץONIG_OPTION_CAPTURE_GROUPOFF
  --> ̵

  嵭ʳξ --> ͭ


# UChar* onigenc_get_prev_char_head(OnigEncoding enc, const UChar* start, const UChar* s)

  ʸʬʸ֤֤

  
  1 enc:   ʸ󥳡ǥ
  2 start: ʸƬɥ쥹
  3 s:     ʸΰ


# UChar* onigenc_get_left_adjust_char_head(OnigEncoding enc,
                                           const UChar* start, const UChar* s)

  ʸƬХȰ֤ˤʤ褦˺¦Ĵɥ쥹֤

  
  1 enc:   ʸ󥳡ǥ
  2 start: ʸƬɥ쥹
  3 s:     ʸΰ


# UChar* onigenc_get_right_adjust_char_head(OnigEncoding enc,
                                            const UChar* start, const UChar* s)

  ʸƬХȰ֤ˤʤ褦˱¦Ĵɥ쥹֤

  
  1 enc:   ʸ󥳡ǥ
  2 start: ʸƬɥ쥹
  3 s:     ʸΰ


# int onigenc_strlen(OnigEncoding enc, const UChar* s, const UChar* end)
# int onigenc_strlen_null(OnigEncoding enc, const UChar* s)

  ʸʸ֤


# int onigenc_str_bytelen_null(OnigEncoding enc, const UChar* s)

  ʸΥХȿ֤


# int onig_set_default_syntax(OnigSyntaxType* syntax)

  ǥեȤɽѥʸˡ򥻥åȤ롣

  
  1 syntax: ɽѥʸˡ


# void onig_copy_syntax(OnigSyntaxType* to, OnigSyntaxType* from)

  ɽѥʸˡ򥳥ԡ롣

  
  1 to:   о
  2 from: 


# unsigned int onig_get_syntax_op(OnigSyntaxType* syntax)
# unsigned int onig_get_syntax_op2(OnigSyntaxType* syntax)
# unsigned int onig_get_syntax_behavior(OnigSyntaxType* syntax)
# OnigOptionType onig_get_syntax_options(OnigSyntaxType* syntax)

# void onig_set_syntax_op(OnigSyntaxType* syntax, unsigned int op)
# void onig_set_syntax_op2(OnigSyntaxType* syntax, unsigned int op2)
# void onig_set_syntax_behavior(OnigSyntaxType* syntax, unsigned int behavior)
# void onig_set_syntax_options(OnigSyntaxType* syntax, OnigOptionType options)

  ɽѥʸˡǤ򻲾/롣

  
  1 syntax:                     ɽѥʸˡ
  2 op, op2, behavior, options: Ǥ


# void onig_copy_encoding(OnigEncoding to, OnigOnigEncoding from)

  ʸ󥳡ǥ󥰤򥳥ԡ롣

  
  1 to:   о
  2 from: 


# int onig_set_meta_char(OnigEncoding enc, unsigned int what,
                         OnigCodePoint code)

  ᥿ʸꤷɥݥͤ˥åȤ롣
  ONIG_SYN_OP_VARIABLE_META_CHARACTERSɽѥʸˡͭ
  ʤäƤʤˤϡʸơǻꤷ᥿ʸ
  ǽʤ(ȹߤʸˡǤͭˤƤʤ)

  ｪλ: ONIG_NORMAL

  
  1 enc:  оʸ󥳡ǥ
  2 what: ᥿ʸǽλ

          ONIG_META_CHAR_ESCAPE
          ONIG_META_CHAR_ANYCHAR
          ONIG_META_CHAR_ANYTIME
          ONIG_META_CHAR_ZERO_OR_ONE_TIME
          ONIG_META_CHAR_ONE_OR_MORE_TIME
          ONIG_META_CHAR_ANYCHAR_ANYTIME

  3 code: ᥿ʸΥɥݥ ޤ ONIG_INEFFECTIVE_META_CHAR.


# OnigAmbigType onig_get_default_ambig_flag()

  ǥեȤۣޥåե饰롣


# int onig_set_default_ambig_flag(OnigAmbigType ambig_flag)

  ǥեȤۣޥåե饰򥻥åȤ롣

  
  1 ambig_flag: ۣޥåե饰


# unsigned int onig_get_match_stack_limit_size(void)

  ޥååκ֤ͤ
  (ǥե: 0 == ̵)


# int onig_set_match_stack_limit_size(unsigned int size)

  ޥååκͤꤹ롣
  (size = 0: ̵)

  ｪλ: ONIG_NORMAL


# int onig_end(void)

  饤֥λѤλ롣

  ｪλ: ONIG_NORMAL

  onig_init()ٸƤӽФƤ⡢˺ɽ֥
  Ѥ뤳ȤϤǤʤ


# const char* onig_version(void)

  Сʸ֤( "2.2.8")

// END