cmdx defined

cmdx defined cmd

Check whether a module for the specified command is either already loaded, or available. If a module can be found, and it not yet loaded, it is automatically loaded.

The return value is a boolean status code. No error is generated when the command cannot be resolved to a module.

cmdx exists

cmdx exists cmd

Check whether a module for the specified command is already loaded. No attempt is made to auto-load a module if it is not already loaded.

The return value is a boolean status code. No error is generated when the command cannot be resolved to a module.

cmdx get

cmdx get cmd attribute

cmdx get missed

Query the value of an attribute of the extension module. Tcl command extension modules are static. There are no cmdx create or cmdx set commands to define command extensions in a script, or to modify the attribute set of a module. The following attributes can be queried:

• address_city
  The city part of the author contact address.
• address_country
  The country part of the author contact address, following the ISO3166 standard.
• address_state
  The state part of the author contact address. Empty if not applicable.
• address_street
  The street address part of the author contact address. Includes floor, house number, etc.
• address_zip
  The ZIP code or other applicable postal code of the author contact address.
• affiliation
  The institution the author works for.
• affiliationduns
  The DUNS registration ID of the affiliated institution. This is primarily useful for US government projects.
• affiliationurl
  The URL of the affiliated institution.
• author
  The author of a command extension, as free text.
• authorurl
  A URL with information on the author, or an empty string if unset.
• category
  A category string to be used if the module is stored in a repository.
• classuuid
  The base class UUID of this module.
• comment
  A free-form comment.
• date
  The date of the last change of the module source code.
• doi
  A digital object identifier for the module, if defined.
• email
  An email address of the author to facilitate contact.
• infourl
  A URL with information on the module, or an empty string if unset.
• keywords
  A list of keywords associated with the module.
• license
  The license class associated with this module.
• licenseurl
  A URL with details about the module license.
• literature
  A free-form literature reference.
• name
  The name of the command.
• objectfile
  The full path name of the loaded object file.
• orcid
  The ORCID code of the author (see www.orcid.org).
• path
  The repository path for displaying hierarchical repository trees. This attribute is independent of any file system paths.
• phone
  A contact phone number of the author.
• references
  Cross references of the module. This is a nested list of class UUID s and reference type tags.
• regid
  In case this is a registered module, its official ID. Unregistered modules report zero.
• sourcefile
  The name of the source file of the module, if available.
• version
  Version information. This is a string in a 1.2.3 (or shortened) style.
• versionuuid
  The version UUID associated with this module.

The second variant with the missed special command name lists all commands which could not be resolved via load subcommands - which could have occurred implicitly via the standard (but extended to include cmdx load attempts) Tcl external command executable lookup function. The cmdx command maintains a cache of such misses in order to avoid searching the command extension path repeatedly, which can generate significant network traffic if this happens frequently. On the other hand, it also means that it is not possible to supply a cmdx module late during a script run when a command load attempt has already failed.

cmdx list

cmdx list ?pattern?

Get a list of all currently loaded Cactvs Tcl command extensions. This list does not include standard Tcl extensions. If desired, the list can be filtered by a string match pattern.

cmdx load

cmdx load cmd ?objectfile?

Explicitly load a command extension module. If the module is already loaded, the current version is unloaded first. If no specific object file (a shared library on Unix/Linux, a DLL on Windows, a bundle file for MacOSX) is specified, the standard name of the module file is automatically generated from the data type name, and then the file searched in the directories in the data type handler module path. The module path can be customized in the control variable ::cactvs(cmdxpath) .

After loading, the cmd command is available in the interpreter which executed the script command. It is essentially indistinguishable from built-in commands. Command extensions are global and automatically available both in Tcl slave interpreters (for scripted property computations) and forked threading Tcl interpreters, provided that these interpreters are created after the extension has been loaded into the main interpreter. Pre-existing interpreters of these types do not retroactively obtain access to the command when it is loaded into the main interpreter. Loading extensions directly into slave interpreters or thread interpreters is not possible, because these do not support the cmdx command. Because of these complications, command extensions should preferably be loaded at the very beginning of a script, before threads are forked or property slave interpreters are instantiated.

The return value of the command is the slot in the command extension table the module has been loaded into.

cmdx subcommands

cmdx subcommands

Return a list of all subcommands of the cmdx command.

cmdx unload

cmdx unload ?cmd?..

Unload one or more Tcl extension modules. It is an error to specify the name of a module which is not loaded. It is not advisable to unload a command extension which has already been exported to slave or thread interpreters, because this can lead to crashes if these interpreters attempt to use the extension after it has been unloaded.