docs/gir-1.2.rnc


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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

namespace core = "http://www.gtk.org/introspection/core/1.0"
namespace c = "http://www.gtk.org/introspection/c/1.0"
namespace glib = "http://www.gtk.org/introspection/glib/1.0"

grammar {
  start = Repository

  Repository =
    element repository {
      Include*
      & Package*
      & Alias*
      & Class*
      & Record*
      & Enum*
      & Function*
    }

  Include =
    element \include {
      attribute name { xsd:string }
      attribute version { xsd:string }
      empty
    }

  Package =
    element package {
      attribute name { xsd:string }
      empty
    }

  Alias =
    element alias {
      attribute name { xsd:string }
      attribute c:type { xsd:string }
      attribute introspectable { string "0" }?

      Doc?
      & Type
    }

  Class =
    element class {
      attribute name { xsd:string }
      attribute c:symbol-prefix { xsd:string }
      attribute c:type { xsd:string }
      attribute parent { xsd:string }
      attribute glib:type-name { xsd:string }
      attribute glib:get-type { xsd:string }
      attribute glib:type-struct { xsd:string }
      attribute introspectable { string "0" }?

      Doc?
      & DocDeprecated?
      & Implements*
      & Constructor?
      & Method*
      & Field*
      & Property*
      & Signal*
    }

  Record =
    element record {
      attribute name { xsd:string }
      attribute version { xsd:string }?
      attribute c:type { xsd:string }
      attribute disguised { xsd:string }?
      attribute glib:is-gtype-struct-for { xsd:string }?
      attribute introspectable { string "0" }?

      Field*
    }

  Property =
    element property {
      attribute name { xsd:string }
      attribute version { xsd:string }?
      attribute writable { string "0" | string "1" }?
      attribute readable { string "0" | string "1" }?

      Doc?
      & DocDeprecated?
      & Type
    }

  Signal =
    element glib:signal {
      attribute name { xsd:string }
      attribute version { xsd:string }?
      attribute when { string "first" | string "last" }
      attribute no-recurse { xsd:string }?

      Doc?
      & DocDeprecated
      & Callable.params?
      & Callable.return?
    }

  Field =
    element field {
      attribute name { xsd:string }
      attribute introspectable { xsd:string }?

      Type
      | Callback
    }

  Callback =
    element callback {
      attribute name { xsd:string }
      attribute introspectable { xsd:string }

      Callable.params?
      & Callable.return?

  Doc =
    element doc { text }

  DocDeprecated =
    element doc-deprecated { text }

  Implements  =
    element implements { attribute name { xsd:string } }

  Type =
    element type {
      attribute name { xsd:string }
      attribute c:type { xsd:string }
      attribute introspectable { xsd:string }?
      empty
    }

  ArrayType =
    element array {
      attribute c:type { xsd:string }
      attribute zero-terminated { string "0" | string "1" }?
      attribute fixed-size { xsd:string }?
      attribute introspectable { xsd:string }?
      Type
    }

  TransferOwnership =
    attribute transfer-ownership { string "none" | string "container" | string "full" }

  Constructor =
    element constructor {
      Callable.attrs
      & Callable.params?
      & Callable.return?
      & Doc?
      & DocDeprecated?
    }

  Callable.attrs &= attribute name { xsd:string }
  Callable.attrs &= attribute version { xsd:string }?
  Callable.attrs &= attribute c:identifier { xsd:string }
  Callable.attrs &= attribute deprecated { xsd:string }?
  Callable.attrs &= attribute deprecation-version { xsd:string }?
  Callable.attrs &= attribute introspectable { xsd:string }?

  Callable.params =
    element parameters {
      element parameter {
        attribute name { xsd:string }
        attribute nullable { xsd:string }?
        attribute allow-none { xsd:string }?
        attribute introspectable { xsd:string }
        TransferOwnership?

        Doc?
        & DocDeprecated?
        & (Type | ArrayType)
      }*

      & element instance-parameter {
        attribute name { xsd:string }
        TransferOwnership?
      }?
    }

  Callable.return =
    element return-value {
      attribute introspectable { xsd:string }
      TransferOwnership?
      & Doc?
      & (Type | ArrayType)
    }

  Function =
    element function {
      Callable.attrs
      & Callable.params?
      & Callable.return?
      & Doc?
      & DocDeprecated?
    }

  Method =
    element method {
      Callable.attrs
      & Callable.params
      & Callable.return?
      & Doc?
      & DocDeprecated?
    }

  Enum =
    element enumeration {
      attribute name { xsd:string }
      attribute glib:type-name { xsd:string }?
      attribute glib:get-type { xsd:string }?
      attribute c:type { xsd:string }

      Doc?
      & DocDeprecated?

      EnumMember+
    }

  EnumMember =
    element member {
      attribute name { xsd:string }
      attribute value { xsd:string }
      attribute c:identifier { xsd:string }
      attribute glib:nick { xsd:string }?

      Doc?
      & DocDeprecated?
    }
}