TCL command line arguments

Syntax

coveragescannertcl [<cs-options>] <application arguments>

Arguments and options

  • <application arguments>: Tcl-based application including optional arguments
  • <cs-options>: Any of the following options:
    • --cs-output=<STRING>: Base name of the generated .csmes and .csexe files
    • --cs-exclude-path=<STRING>: Exclude files located in specified directory
    • --cs-include-path=<STRING>: Override exclusion of files based on specified directory
    • --cs-exclude-file-abs-regexp=<STRING>: Exclude file if absolute file name matches regular expression
    • --cs-include-file-abs-regexp=<STRING>: Override exclusion of file if absolute name matches regular expression
    • --cs-exclude-file-abs-wildcard=<STRING>: Exclude file if absolute name matches wildcard
    • --cs-include-file-abs-wildcard=<STRING>: Override exclusion of file if absolute name matches wildcard
    • --cs-include-code-regexp=<STRING>: Regular expression of code that will be instrumented even if it is excluded
    • --cs-exclude-code-regexp=<STRING>: Regular expression of code that will not be instrumented
    • --cs-include-code-wildcard=<STRING>: Wildcard of code that will be instrumented even if it is excluded
    • --cs-exclude-code-wildcard=<STRING>: Wildcard of code that will be instrumented even if it is excluded
    • --cs-include-init-scripts: Enable code instrumentation for standard Tcl initialization scripts
    • --cs-include-unnamed: Instrument Tcl code even if it has no or just an ambiguous file name set. By default, such code is ignored as it is typically just temporary code generated for e.g. an Tk event handler or results from nested eval calls.
    • @<path>: Read command line options from the file at <path> and insert them at the position of this option. The options file is a text file with one option per line. Leading and trailing blanks and empty lines are ignored.

CoverageScannerTcl is a utility which collects code coverage information of a Tcl-based execution. It will collect all scripts parsed by the embedded Tcl interpreter and determine which parts were actually executed.

Once the application exits, a pair of .csmes and .csexe files will be written out that contain the code instrumentation information and execution data, respectively.

If the --cs-output switch is omitted, the base name of the output files will be the same as the <application> name.

See Coco TCL tutorial for a recommended set of --cs-exclude-code-regexp switches for typical Tcl/Tk applications.