kindwolf.org Git repositories pecoregex / master document / v1 / schema.yaml
master

Tree @master (Download .tar.gz)

schema.yaml @master — raw · history · blame 

  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
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
schema: https://json-schema.org/draft/2020-12/schema
$id: https://raw.githubusercontent.org/xavierog/pecoregex/master/document/v1/schema.yaml
title: Pecoregex document
description: |-
  A Pecoregex documents holds 1 to n PCRE (Perl-Compatible Regular Expression) patterns.
  Each pattern is associated with 0 to n subject strings.

# Start of definitions
$defs:
  pcre_pattern_string:
    type: string
    description: PCRE pattern string
  subject_string:
    type: string
    description: subject string to be matched against a PCRE pattern
  pcre_option_string:
   type: string
   description: |-
    1 to n PCRE_* constant, separated using pipe characters ('|'); spaces are ignored, case is irrelevant and the
    "PCRE_" prefix can be omitted
  pcre_option_array:
    type: array
    description: set of PCRE options
    items:
      $ref: '#/$defs/pcre_option_string'

  # References to reusable items:
  compile_option_ref:
    type: integer
    minimum: 0
    description: index of a PCRE option set in the "compile_options" property
  execute_option_ref:
    type: integer
    minimum: 0
    description: index of a PCRE option set in the "execute_options" property
  pattern_string_ref:
    type: integer
    minimum: 0
    description: index of a PCRE pattern string in the "pattern_strings" property
  subject_string_ref:
    type: integer
    minimum: 0
    description: index of a subject string in the "subject_strings" property

  captures:
    type: object
    properties:
      by_index:
        type: array
        items:
          type: string
          description: numbered captures
      by_name:
        type: object
        description: named captures
        patternProperties:
          '^[a-zA-Z0-9_]{1,32}$':
            type:
            - string
            - 'null'

  pattern:
    type: object
    properties:
      value:
        oneOf:
        - $ref: '#/$defs/pattern_string_ref'
        - $ref: '#/$defs/pcre_pattern_string'
      options:
        oneOf:
        - $ref: '#/$defs/compile_option_ref'
        - $ref: '#/$defs/pcre_option_array'
        - $ref: '#/$defs/pcre_option_string'
      compile:
        type: boolean
        description: True if the pattern successfully compiled, false otherwise.
      error:
        type: object
        properties:
          message:
            type:
            - string
            - 'null'
            description: error message provided by pcre_compile()
          offset:
            type:
            - integer
            - 'null'
            description: Offset at which the error was detected within the PCRE pattern to compile
      execute:
        $ref: '#/$defs/execute'
    required:
    - value

  execute:
    type: array
    items:
      type: object
      properties:
        subject:
          oneOf:
          - $ref: '#/$defs/subject_string_ref'
          - $ref: '#/$defs/subject_string'
        options:
          oneOf:
          - $ref: '#/$defs/execute_option_ref'
          - $ref: '#/$defs/pcre_option_array'
          - $ref: '#/$defs/pcre_option_string'
        match:
          type: boolean
          description: True if the subject string matched against its parent pattern, false otherwise.
        captures:
          $ref: '#/$defs/captures'
      required:
      - subject
# End of definitions

type: object
properties:
  # Containers for reusable items:
  pattern_strings:
    type: array
    description: array of PCRE patterns that can be referenced later in the document
    items:
      $ref: '#/$defs/pcre_pattern_string'
  compile_options:
    type: array
    description: array of PCRE options compatible with pcre_compile()
    items:
      anyOf:
      - $ref: '#/$defs/pcre_option_string'
      - $ref: '#/$defs/pcre_option_array'
  subject_strings:
    type: array
    description: array of subject strings that can be referenced later in the document
    items:
      $ref: '#/$defs/subject_string'
  execute_options:
    type: array
    description: array of PCRE options compatible with pcre_exec()
    items:
      anyOf:
      - $ref: '#/$defs/pcre_option_string'
      - $ref: '#/$defs/pcre_option_array'
  # PCRE patterns to compile and execute:
  patterns:
    type: array
    description: array of PCRE patterns to compile and optionally execute
    items:
      $ref: '#/$defs/pattern'
required:
- patterns