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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
namespace eval ::helpdoc::schema {
# here is the definition of Tcl-commands that are used in schema
proc rootelement {name code} { uplevel 1 [list ::helpdoc::rootelement $name $code] }
proc element {name code} { uplevel 1 [list ::helpdoc::element $name $code] }
proc attribute {name code} { uplevel 1 [list ::helpdoc::attribute $name $code] }
proc define {name code} { uplevel 1 [list ::helpdoc::define $name $code] }
proc text {} { uplevel 1 [list ::helpdoc::text] }
proc string {} { uplevel 1 [list ::helpdoc::String] }
proc ref {name} { uplevel 1 [list ::helpdoc::ref $name] }
proc ident {} { uplevel 1 [list ::helpdoc::ident] }
proc optional {code} { uplevel 1 [list ::helpdoc::optional $code] }
proc interleave {code} { uplevel 1 [list ::helpdoc::interleave $code] }
proc choice {code} { uplevel 1 [list ::helpdoc::choice $code] }
proc ancestorElements {} { uplevel 1 [list ::helpdoc::ancestorElements] }
proc ? {code} { uplevel 1 [list ::helpdoc::? $code] }
proc * {code} { uplevel 1 [list ::helpdoc::* $code] }
proc + {code} { uplevel 1 [list ::helpdoc::+ $code] }
}
# actual implementation of commands ...
proc ::helpdoc::rootelement {name code} {
variable elemList
variable itemList
variable stackArr
variable state
parseMsg_ $name; puts ""
incr state(depth)
if { $state(rootVisited) } {
::tclu::abort "more than one rootelement; there can be only one !"
}
set state(rootVisited) 1
set state(rootElem) $name
lappend elemList $name
lappend itemList $name
$stackArr(currentElem) push $name
#eval $code
namespace eval schema $code
$stackArr(currentElem) pop
incr state(depth) -1
parseMsgOK_ $name
}
proc ::helpdoc::element {name code} {
variable elemList
variable itemList
variable state
variable stackArr
variable elemArr
parseMsg_ $name; puts ""
incr state(depth)
# check that $name does not exists
if { [::tclu::lpresent $elemList $name] } {
::tclu::abort "element \"$name\" already defined"
}
lappend elemList $name
lappend itemList $name
$stackArr(optional) push 0
$stackArr(interleave) push 0
set parentElem [$stackArr(currentElem) peek]
lappend elemArr(ELEMLIST,$parentElem) $name
lappend elemArr(OPTIONAL,$parentElem,$name) [$stackArr(optional) peek]
lappend elemArr(INTERLEAVE,$parentElem,$name) [$stackArr(interleave) peek]
lappend elemArr(REPETITION,$parentElem,$name) [$stackArr(repetition) peek]
$stackArr(currentElem) push $name
#eval $code
namespace eval schema $code
$stackArr(currentElem) pop
$stackArr(optional) pop
$stackArr(interleave) pop
incr state(depth) -1
parseMsgOK_ $name
}
proc ::helpdoc::attribute {name code} {
# so far we assume attributes have arbitrary values (which means
# we ignore code)
variable itemList
variable stackArr
variable elemArr
parseMsg_ $name
set currentElem [$stackArr(currentElem) peek]
lappend itemList $name
lappend elemArr(ATTRLIST,$currentElem) $name
lappend attrArr(OPTIONAL,$currentElem) [$stackArr(optional) peek]
puts ok
}
proc ::helpdoc::define {name code} {
variable defineArr
variable itemList
parseMsg_ $name;
lappend itemList $name
set defineArr($name) $code
puts ok
}
proc ::helpdoc::text {} {
# BEWARE: so far can be called only from element (because
# attribute does not yet support ...)
variable stackArr
variable elemArr
set currentElem [$stackArr(currentElem) peek]
set elemArr(TEXT,$currentElem) 1
}
proc ::helpdoc::String {} {
# BEWARE: so far can be called only from element (because
# attribute does not yet support ...)
variable stackArr
variable elemArr
set currentElem [$stackArr(currentElem) peek]
set elemArr(STRING,$currentElem) 1
}
proc ::helpdoc::ref {name} {
variable stackArr
variable elemArr
variable defineArr
parseMsg_ $name;
if { [info exists defineArr($name)] } {
puts ""
# the ref points to define, evaluate it
#eval $defineArr($name)
namespace eval schema $defineArr($name)
parseMsgOK_;
return
}
set currentElem [$stackArr(currentElem) peek]
if { $currentElem != "" } {
lappend elemArr(REFLIST,$currentElem) $name
lappend elemArr(OPTIONAL,$currentElem,$name) [$stackArr(optional) peek]
lappend elemArr(INTERLEAVE,$currentElem,$name) [$stackArr(interleave) peek]
lappend elemArr(REPETITION,$currentElem,$name) [$stackArr(repetition) peek]
} else {
::tclu::abort "can't use \"ref\" outside element definition"
}
puts ok
}
proc ::helpdoc::ident {} {
variable stackArr
variable elemArr
set currentElem [$stackArr(currentElem) peek]
if { $currentElem != "" } {
set elemArr(IDENT,$currentElem) 1
} else {
::tclu::abort "can't use \"ident\" outside element definition"
}
}
proc ::helpdoc::optional {code} {
variable stackArr
variable state
parseMsg_; puts ""
incr state(depth)
$stackArr(optional) push 1
# eval $code
namespace eval schema $code
$stackArr(optional) pop
incr state(depth) -1
parseMsgOK_
}
proc ::helpdoc::interleave {code} {
variable stackArr
variable state
parseMsg_; puts ""
incr state(depth)
$stackArr(interleave) push 1
# eval $code
namespace eval schema $code
$stackArr(interleave) pop
incr state(depth) -1
parseMsgOK_
}
proc ::helpdoc::choice {code} {
variable stackArr
variable state
# TODO: implement the CHOICE; so far this proc is dummy
parseMsg_; puts ""
incr state(depth)
#eval $code
namespace eval schema $code
incr state(depth) -1
parseMsgOK_
}
proc ::helpdoc::ancestorElements {} {
parseMsg_
# DO nothing (this means no validation for correctness will be done)
puts ok
}
proc ::helpdoc::? {code} {
repetition_ $code
}
proc ::helpdoc::* {code} {
repetition_ $code
}
proc ::helpdoc::+ {code} {
repetition_ $code
}
proc ::helpdoc::repetition_ {code} {
variable stackArr
variable state
set type [tag -2]
uplevel 1 "parseMsg_; puts {}"
incr state(depth)
$stackArr(repetition) push $type
#eval $code
namespace eval schema $code
$stackArr(repetition) pop
incr state(depth) -1
uplevel 1 "parseMsgOK_"
}
proc ::helpdoc::assignRefs_ {} {
variable elemList
variable elemArr
foreach elem $elemList {
if { [info exists elemArr(REFLIST,$elem)] } {
# we have a ref
puts -nonewline " $elem --> "
foreach ref $elemArr(REFLIST,$elem) {
# check if ref points to "define"
lappend elemArr(ELEMLIST,$elem) $ref
puts -nonewline "$ref "
# check that $ref exists
if { ! [::tclu::lpresent $elemList $ref] } {
puts ""
::tclu::abort "the \"$ref\" element has not been defined, yet it is referenced"
}
}
puts ""
}
}
}
proc ::helpdoc::createTagCmds_ {} {
variable state
variable elemList
if { $state(rootElem) == {} } {
::tclu::abort "rootelement was not defined"
}
# create the rootelement cmd
puts " creating $state(rootElem) cmd ... ok"
proc ::helpdoc::tag::$state(rootElem) {args} {
eval ::helpdoc::rootnameTag_ $args
}
# create all elements cmds
foreach elem $elemList {
if { $elem != $state(rootElem) } {
puts -nonewline " creating $elem cmd ... "
proc ::helpdoc::tag::$elem {args} {
eval ::helpdoc::elementTag_ $args
}
puts ok
}
}
}
# for the time being ...
proc helpdoc::parseMsg_ {{name {}}} {
variable state
set indent [::textutil::blank [expr (1+$state(depth)) * 3]]
set tag [string toupper [tag -2]]
puts -nonewline "${indent}parsing $tag $name ... "
}
proc helpdoc::parseMsgOK_ {{name {}}} {
variable state
set indent [::textutil::blank [expr (1+$state(depth)) * 3]]
set tag [string toupper [tag -2]]
if { $name == "" } {
puts "${indent}OK - parsing $tag completed"
} else {
puts "${indent}OK - parsing $tag $name completed"
}
}
|
