interface_interface
Home
Binary distributions
Source distribution
Documentation
DESCRIPTION
An interface (see interface) is defined by a compound command (an object) in the interfaces namespace
with a name consisting of the name of the interface and its version number.
This interface defining object must support the "interface" interface, that basically includes
returning information about the interface and testing it.
The interface package contains some commands to easily
implement interfaces in Tcl.
THE INTERFACE INTERFACE
- objectName doc
- Returns the documentation of the interface in XML format (TMML).
- objectName test objectName ?options?
- Test whether the given object objectName fully supports the interface.
The options depend completely on the interface
being tested, and can be used to provide necessary parameters or to allow the exclusion of
certain tests. Some of these options can be mandatory.
The command should put information about tests being conducted to stdout. The command must return
the number of tests that failed. errors should be logged using the interface::logerror command,
and skipped tests with the interface::logskip command:
- interface::logerror interface description errormessage
- log an error for a test for the given interface
- interface::logskip interface description condition
- log a skipped test for the given interface
SEE ALSO
KEYWORDS
- interface
- interface_interface