{"id":6698,"date":"2022-12-20T19:33:27","date_gmt":"2022-12-20T22:33:27","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/tcl_registerconfig-man3\/"},"modified":"2022-12-20T19:33:27","modified_gmt":"2022-12-20T22:33:27","slug":"tcl_registerconfig-man3","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/tcl_registerconfig-man3\/","title":{"rendered":"Tcl_RegisterConfig (man3)"},"content":{"rendered":"

Tcl_RegisterConfig<\/h1>\n

NAME<\/a>
SYNOPSIS<\/a>
ARGUMENTS<\/a>
DESCRIPTION<\/a>
TCL_CONFIG<\/a>
KEYWORDS<\/a> <\/p>\n

\n

______________________________________________________________________________<\/p>\n

NAME <\/a> <\/h2>\n

Tcl_RegisterConfig \u2212 procedures to register embedded configuration information<\/p>\n

SYNOPSIS <\/a> <\/h2>\n

#include <\/b><\/p>\n

void
Tcl_RegisterConfig<\/b>(interp, pkgName, configuration, valEncoding<\/i>)<\/p>\n

ARGUMENTS <\/a> <\/h2>\n\n\n\n\n\n
<\/td>\n\n

Tcl_Interp *interp<\/i> (in)<\/p>\n<\/td>\n

<\/td>\n\n

Refers to the interpreter the embedded configuration information is registered for. Must not be NULL.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

const char *pkgName<\/i> (in)<\/p>\n<\/td>\n

<\/td>\n\n

Contains the name of the package registering the embedded configuration as ASCII string. This means that this information is in UTF-8 too. Must not be NULL.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

const Tcl_Config *configuration<\/i> (in)<\/p>\n<\/td>\n

<\/td>\n\n

Refers to an array of Tcl_Config entries containing the information embedded in the binary library. Must not be NULL. The end of the array is signaled by either a key identical to NULL, or a key referring to the empty string.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

const char *valEncoding<\/i> (in)<\/p>\n<\/td>\n

<\/td>\n\n

Contains the name of the encoding used to store the configuration values as ASCII string. This means that this information is in UTF-8 too. Must not be NULL.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

______________________________________________________________________________<\/p>\n

DESCRIPTION <\/a> <\/h2>\n

The function described here has its base in TIP 59 and provides extensions with support for the embedding of configuration information into their binary library and the generation of a Tcl-level interface for querying this information.<\/p>\n

To embed configuration information into their binary library an extension has to define a non-volatile array of Tcl_Config entries in one if its source files and then call Tcl_RegisterConfig<\/b> to register that information.<\/p>\n

Tcl_RegisterConfig<\/b> takes four arguments; first, a reference to the interpreter we are registering the information with, second, the name of the package registering its configuration information, third, a pointer to an array of structures, and fourth a string declaring the encoding used by the configuration values.<\/p>\n

The string valEncoding<\/i> contains the name of an encoding known to Tcl. All these names are use only characters in the ASCII subset of UTF-8 and are thus implicitly in the UTF-8 encoding. It is expected that keys are legible English text and therefore using the ASCII subset of UTF-8. In other words, they are expected to be in UTF-8 too. The values associated with the keys can be any string however. For these the contents of valEncoding<\/i> define which encoding was used to represent the characters of the strings.<\/p>\n

Each element of the configuration<\/i> array refers to two strings containing the key and the value associated with that key. The end of the array is signaled by either an empty key or a key identical to NULL. The function makes no<\/b> copy of the configuration<\/i> array. This means that the caller has to make sure that the memory holding this array is never released. This is the meaning behind the word non-volatile<\/b> used earlier. The easiest way to accomplish this is to define a global static array of Tcl_Config entries. See the file \u201cgeneric\/tclPkgConfig.c\u201d in the sources of the Tcl core for an example.<\/p>\n

When called Tcl_RegisterConfig<\/b> will<\/p>\n\n\n\n
<\/td>\n\n

(1)<\/p>\n<\/td>\n

<\/td>\n\n

create a namespace having the provided pkgName<\/i>, if not yet existing.<\/p>\n<\/td>\n<\/tr>\n

<\/td>\n\n

(2)<\/p>\n<\/td>\n

<\/td>\n\n

create the command pkgconfig<\/b> in that namespace and link it to the provided information so that the keys from configuration<\/i> and their associated values can be retrieved through calls to pkgconfig<\/b>.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

The command pkgconfig<\/b> will provide two subcommands, list<\/b> and get<\/b>:<\/p>\n

::pkgName<\/i>::pkgconfig<\/b> list<\/p>\n

Returns a list containing the names of all defined keys.<\/p>\n

::pkgName<\/i>::pkgconfig<\/b> get key<\/i><\/p>\n

Returns the configuration value associated with the specified key<\/i>.<\/p>\n

TCL_CONFIG <\/a> <\/h2>\n

The Tcl_Config<\/b> structure contains the following fields:<\/p>\n

typedef struct Tcl_Config {
const char *key<\/i>;
const char *value<\/i>;
} Tcl_Config<\/b>;<\/p>\n

KEYWORDS <\/a> <\/h2>\n

embedding, configuration, binary library<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

Tcl_RegisterConfig \u2212 procedures to register embedded configuration information <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2536],"tags":[2538,3007,3076],"class_list":["post-6698","post","type-post","status-publish","format-standard","hentry","category-3-llamadas-de-bibliotecas","tag-2538","tag-man3","tag-tcl_registerconfig"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6698","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=6698"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/6698\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=6698"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=6698"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=6698"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}