util/X86LINUX64/man/man3/Tcl_RegisterConfig.3

   1 '\"
   2 '\" Copyright (c) 2002 Andreas Kupries <andreas_kupries@users.sourceforge.net>
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated by tabs.
  57 .\"
  58 .\" .SE
  59 .\"     End of list of standard options for a Tk widget.
  60 .\"
  61 .\" .OP cmdName dbName dbClass
  62 .\"     Start of description of a specific option.  cmdName gives the
  63 .\"     option's name as specified in the class command, dbName gives
  64 .\"     the option's name in the option database, and dbClass gives
  65 .\"     the option's class in the option database.
  66 .\"
  67 .\" .UL arg1 arg2
  68 .\"     Print arg1 underlined, then print arg2 normally.
  69 .\"
  70 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 '\" Note:  do not modify the .SH NAME line immediately below!
 277 .SH NAME
 278 Tcl_RegisterConfig \- procedures to register embedded configuration information
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tcl.h>\fR
 282 .sp
 283 void
 284 \fBTcl_RegisterConfig\fR(\fIinterp, pkgName, configuration, valEncoding\fR)
 285 .sp
 286 .SH ARGUMENTS
 287 .AS Tcl_Interp *configuration
 288 .AP Tcl_Interp *interp in
 289 Refers to the interpreter the embedded configuration information is
 290 registered for. Must not be NULL.
 291 .AP "const char" *pkgName in
 292 Contains the name of the package registering the embedded
 293 configuration as ASCII string. This means that this information is in
 294 UTF-8 too. Must not be NULL.
 295 .AP "const Tcl_Config" *configuration in
 296 Refers to an array of Tcl_Config entries containing the information
 297 embedded in the binary library. Must not be NULL. The end of the array
 298 is signaled by either a key identical to NULL, or a key referring to
 299 the empty string.
 300 .AP "const char" *valEncoding in
 301 Contains the name of the encoding used to store the configuration
 302 values as ASCII string. This means that this information is in UTF-8
 303 too. Must not be NULL.
 304 .BE
 305 .SH DESCRIPTION
 306 .PP
 307 The function described here has its base in TIP 59 and provides
 308 extensions with support for the embedding of configuration
 309 information into their binary library and the generation of a
 310 Tcl-level interface for querying this information.
 311 .PP
 312 To embed configuration information into their binary library an
 313 extension has to define a non-volatile array of Tcl_Config entries in
 314 one if its source files and then call \fBTcl_RegisterConfig\fR to
 315 register that information.
 316 .PP
 317 \fBTcl_RegisterConfig\fR takes four arguments; first, a reference to
 318 the interpreter we are registering the information with, second, the
 319 name of the package registering its configuration information, third,
 320 a pointer to an array of structures, and fourth a string declaring the
 321 encoding used by the configuration values.
 322 .PP
 323 The string \fIvalEncoding\fR contains the name of an encoding known to
 324 Tcl.  All these names are use only characters in the ASCII subset of
 325 UTF-8 and are thus implicitly in the UTF-8 encoding. It is expected
 326 that keys are legible English text and therefore using the ASCII
 327 subset of UTF-8. In other words, they are expected to be in UTF-8
 328 too. The values associated with the keys can be any string
 329 however. For these the contents of \fIvalEncoding\fR define which
 330 encoding was used to represent the characters of the strings.
 331 .PP
 332 Each element of the \fIconfiguration\fR array refers to two strings
 333 containing the key and the value associated with that key. The end of
 334 the array is signaled by either an empty key or a key identical to
 335 NULL. The function makes \fBno\fR copy of the \fIconfiguration\fR
 336 array. This means that the caller has to make sure that the memory
 337 holding this array is never released. This is the meaning behind the
 338 word \fBnon-volatile\fR used earlier. The easiest way to accomplish
 339 this is to define a global static array of Tcl_Config entries. See the file
 340 .QW generic/tclPkgConfig.c
 341 in the sources of the Tcl core for an example.
 342 .PP
 343 When called \fBTcl_RegisterConfig\fR will
 344 .IP (1)
 345 create a namespace having the provided \fIpkgName\fR, if not yet
 346 existing.
 347 .IP (2)
 348 create the command \fBpkgconfig\fR in that namespace and link it to
 349 the provided information so that the keys from \fIconfiguration\fR and
 350 their associated values can be retrieved through calls to
 351 \fBpkgconfig\fR.
 352 .PP
 353 The command \fBpkgconfig\fR will provide two subcommands, \fBlist\fR
 354 and \fBget\fR:
 355 .RS
 356 .TP
 357 ::\fIpkgName\fR::\fBpkgconfig\fR list
 358 Returns a list containing the names of all defined keys.
 359 .TP
 360 ::\fIpkgName\fR::\fBpkgconfig\fR get \fIkey\fR
 361 Returns the configuration value associated with the specified
 362 \fIkey\fR.
 363 .RE
 364 .SH TCL_CONFIG
 365 .PP
 366 The \fBTcl_Config\fR structure contains the following fields:
 367 .PP
 368 .CS
 369 typedef struct Tcl_Config {
 370     const char *\fIkey\fR;
 371     const char *\fIvalue\fR;
 372 } \fBTcl_Config\fR;
 373 .CE
 374 .\" No cross references yet.
 375 .\" .SH "SEE ALSO"
 376 .SH KEYWORDS
 377 embedding, configuration, binary library