summaryrefslogtreecommitdiff
path: root/doc/CALLOUTS.BUILTIN.ja
blob: d371beb6e9a59f1b736b366b76e7ee5c5efb8049 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
CALLOUTS.BUILTIN.ja               2018/03/26


* FAIL    (前進)

  (*FAIL)

  常に失敗する


* MISMATCH    (前進)

  (*MISMATCH)

  照合を中止する
  検索は継続する


* ERROR    (前進)

  (*ERROR{n::LONG})

  検索/照合を中止する
  戻り値は引数'n'の値。(-1より小さい負の値でなければならない)
  'n'はオプション引数で、デフォルト値はONIG_ABORT


* MAX    (前進/後退)

  (*MAX{n::LONG/TAG, c::CHAR})

  成功(デフォルト)、前進または後退回数を制限する
  'n'がTAGのときは、そのTAGのcalloutのslot 0の値が使用される
  'c'引数の値によって、slot 0の値が変化する
  'c'はオプション引数で、デフォルト値は'X'

  例:  "(?:(*COUNT[T]{X})a)*(?:(*MAX{T})c)*"

  [callout data]
  slot 0: '>': 前進回数, '<': 後退回数, 'X': 成功回数(デフォルト)


* COUNT    (前進/後退)

  (*COUNT{c::CHAR})

  カウンタ
  'c'引数の値によって、slot 0の値が変化する
  'c'はオプション引数で、デフォルト値は'>'

  [callout data]
  slot 0: '>': 前進回数(デフォルト), '<': 後退回数, 'X': 成功回数
  slot 1: 前進回数
  slot 2: 後退回数

  (* 成功回数 = 前進回数 - 後退回数)

  ** ONIG_OPTION_FIND_LONGEST または ONIG_OPTION_FIND_NOT_EMPTY が使用されると
     正確な動作ができなくなる


* TOTAL_COUNT    (前進/後退)

  (*TOTAL_COUNT{c::CHAR})

  これはCOUNTとほとんど同じ
  しかし、カウントが検索過程で積算される
  'c'はオプション引数で、デフォルト値は'>'

  [callout data]
  slot 0: '>': 前進回数(デフォルト), '<': 後退回数, 'X': 成功回数
  slot 1: 前進回数
  slot 2: 後退回数

  ** ONIG_OPTION_FIND_LONGEST または ONIG_OPTION_FIND_NOT_EMPTY が使用されると
     正確な動作ができなくなる


* CMP    (前進)

  (*CMP{x::TAG/LONG, op::STRING, y::TAG/LONG})

  xの値とyの値をop演算子で比較する
  x, yがTAGのときにはそのcalloutのslot 0の値が参照される

  op: '==', '!=', '>', '<', '>=', '<='

  例: "(?:(*MAX[TA]{7})a|(*MAX[TB]{5})b)*(*CMP{TA,>=,4})"

  [callout data]
  slot 0: op値 (src/regexec.c の中の enum OP_CMP)

//END