summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/pt/include/export/config/tclparam.inc
blob: cec07e8fe266322f356ff002c477a467adae0ebd (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
[section Configuration]

The Tcl/PARAM export plugin recognizes the following configuration
variables and changes its behaviour as they specify.

[list_begin arguments]

[arg_def string template]

If this configuration variable is set it is assumed to contain a
string into which to put the generated code and other configuration
data. The various locations are expected to be specified with the
following placeholders:

[list_begin definitions]

[def [const @user@]]
To be replaced with the value of the configuration variable [option user].

[def [const @format@]]
To be replaced with the the constant [const Tcl/PARAM].

[def [const @file@]]
To be replaced with the value of the configuration variable [option file].

[def [const @name@]]
To be replaced with the value of the configuration variable [option name].

[def [const @code@]]
To be replaced with the generated Tcl code.

[list_end]

The following configuration variables are special, in that they will
occur within the generated code, and are replaced there as well.

[list_begin definitions]

[def [const @runtime@]]
To be replaced with the value of the configuration variable [option runtime-command].

[def [const @self@]]
To be replaced with the value of the configuration variable [option self-command].

[def [const @def@]]
To be replaced with the value of the configuration variable [option proc-command].

[def [const @ns@]]
To be replaced with the value of the configuration variable [option namespace].

[def [const @main@]]
To be replaced with the value of the configuration variable [option main].

[def [const @prelude@]]
To be replaced with the value of the configuration variable [option prelude].

[list_end]

[para]

If this configuration variable is not set, or empty, then the plugin
falls back to a standard template, which is defined as "[const @code@]".

[list_end]

[emph Note] that this plugin may ignore the standard configuration
variables [var user], [var format], [var file], and their values,
depending on the chosen template.

[para]

The content of the standard configuration variable [var name], if set,
is used as name of the grammar in the output. Otherwise the plugin
falls back to the default name [const a_pe_grammar].