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
|
# interface_definition.rnc: VyConf reference tree XML grammar
#
# Copyright (C) 2014 VyOS Development Group <maintainers@vyos.net>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
# USA
# The language of this file is compact form RELAX-NG
# http://relaxng.org/compact-tutorial-20030326.htm
# (unless converted to XML, then just RELAX-NG :)
# Interface definition starts with interfaceDefinition tag that may contain node tags
start = element interfaceDefinition
{
extendsAttr?, node*
}
# Interface definitions may extend other definitions
# In this case you specify a whitespace-separated path
extendsAttr = attribute extends
{
text
}
# Normal and tag nodes may have children
children = element children
{
(node | tagNode | leafNode)+
}
# Nodes may have properties
# For simplicity, any property is allowed in any node,
# but whether they are used or not is implementation-defined
properties = element properties
{
helpString?,
constraint?,
# These are meaningful only for leaf nodes
valueHelpString?,
(multi | valueless)?
}
# node tag may contain node, leafNode, or tagNode tags
# Those are intermediate configuration nodes that may only contain
# other nodes and must not have values
node = element node
{
(ownerAttr? & nodeNameAttr),
(properties? & children? )
}
# All nodes must have "name" attribute
nodeNameAttr = attribute name
{
text
}
# Ordinary nodes and tag nodes can have "owner" attribute.
# Owner is the component that is notified when node changes.
ownerAttr = attribute owner
{
text
}
# Tag and leaf nodes may have constraints on their names and values
# (respectively).
# When multiple constraints are listed, they work as logical OR
constraint = element constraint
{
(regex | validator)+ &
errorMessage?
}
# A constraint may be a regex pattern
regex = element regex
{
text
}
# A constraint may also use an external validator
validator = element validator
{
(validatorNameAttr & validatorArgumentAttr),
empty
}
# Validators are named
validatorNameAttr = attribute name
{
text
}
# An argument can be passed to validator, in addition to the value to be validated
validatorArgumentAttr = attribute argument
{
text
}
# When validation fails, a message can be shown
errorMessage = element errorMessage
{
text
}
# Tag nodes are containers for nodes without predefined names, like network interfaces
# or user names (e.g. "interfaces ethernet eth0" or "user jrandomhacker")
# Tag nodes may contain node and leafNode elements, and also nameConstraint tags
# They must not contain other tag nodes
tagNode = element tagNode
{
(ownerAttr? & nodeNameAttr),
(properties? & children )
}
# Leaf nodes are terminal configuration nodes that can't have children,
# but can have values.
# Leaf node may contain one or more valueConstraint tags
# If multiple valueConstraint tags are used, they work a logical OR
# Leaf nodes can have "multi" attribute that indicated that it can have
# more than one value
leafNode = element leafNode
{
nodeNameAttr,
properties
}
# Some leaf nodes may have more than one value
multi = element multi
{
empty
}
# Some leaf nodes may not have values (e.g. enable/disable flags)
valueless = element valueless
{
empty
}
# helpString tag contains brief description of the purpose of the node
# Must have description= attribute
helpString = element helpString
{
text
}
# valueHelpString tags contain information about acceptable value format
valueHelpString = element valueHelpString
{
text
}
|
