Class Reporter

Class constructor that returns a new Reporter object.

The constructor may be called with any of the following named attributes as parameters:

 body
   the XML body of the report.  See the Inca Report schema for format.

 completed
   boolean indicating whether or not the reporter has completed
   generating the information it is intended to produce

 description
   a verbose description of the reporter

 fail_message
   a message describing why the reporter failed to complete its task

 name
   the name that identifies this reporter

 url
   URL to get more information about the reporter

 version
   the version of the reporter; defaults to '0'

Adds a command line argument (invocation syntax -name=value) to the reporter. If supplied, the optional description will be included in the reporter help XML and display. If supplied, default indicates that the argument is optional; the argValue method will return default if the command line does not include a value for the argument. The optional pattern specifies a pattern for recognizing valid argument values; the default is '.*', which means that any text is acceptable for the argument value.

Add one or more dependencies to the list of modules on which this reporter depends. Dependencies are reported as part of reporter help output to assist reporter repository tools in their retrievals. NOTE: dependencies on the standard Inca reporter library modules are added by the modules themselves, so a reporter only needs to invoke this method to report external dependencies. The Inca Reporter Instance Manager presently only supports dependencies on Inca repository packages.

Called after the processArgv method, this returns the value of the position'th instance (starting with 1) of the name command-line argument. Returns the value of the last instance if position is None. Returns None if name is not a recognized argument. Returns the default value for name if it has one and name is included fewer than position times on the command line.

Called after the processArgv method, this returns an array of all values specified for the name command-line argument. Returns None if name is not a recognized argument. Returns a single-element array containing the default value for name if it has one and name does not appear on the command line.

A convenience; compiles and runs a program, removes the source and exec files, and returns the program's combined stderr/out output. See compiledProgramStatusOutput for a list of recognized params.

A convenience; compiles and runs a program, removes the source and exec files, and returns a tuple that contains the program's exit code and its combined stderr/out output. Recognized params:

 code
   the code to compile; required

 compiler
   the compiler to invoke; defaults to cc

 language
   source file language--one of 'c', 'c++', 'fortran', or 'java';
   defaults to 'c'.

 out_switch
   the switch to use to specify the compiler output file; default '-o '

 switches
   additional switches to pass to the compiler; defaults to ''

 timeout
   max seconds compilation/execution may take; returns a non-zero exit
   status and any partial program output on time-out

Appends each element of msgs to the list of type log messages stored in the reporter. type must be one of 'debug', 'error', 'info', 'system', or 'warn'.

A convenience; appends cmd to the 'system'-type log messages stored in the reporter, then runs cmd and returns its combined stderr/stdout. If timeout is specified and the command doesn't complete within timeout seconds, aborts the execution of cmd and returns any partial output.

A convenience; appends cmd to the 'system'-type log messages stored in the reporter, then runs cmd and returns a tuple that contains its exit code and combined stderr/stdout. If timeout is specified and the command doesn't complete within timeout seconds, aborts the execution of cmd and returns a non-zero exit code and any partial output.

Processes argv which is a list of command-line arguments of the form -name=value

The following options are predefined:

 help
   yes
     Prints help information describing the reporter inputs, then
     forces the reporter to exit.  If the verbose level is 0, the
     output will be text; otherwise, it will be Inca Report XML.
   no (default)
     Normal reporter execution.

 log
   0 (default)
     log no messages
   1
     log error messages
   2
     log error and warning messages
   3
     log error, warning, and system messages
   4
     log error, warning, system, and info messages
   5
     log error, warning, system, info, and debug messages
   debug
     log only debug messages
   error
     log only error messages
   info
     log only info messages
   system
     log only system messages
   warn
     log only warning messages

 verbose
   0
     print will only produce "completed" or "failed".
   1 (default)
     print will produce Inca Report XML.
   2
     print will produce Inca Report XML that includes help information.

version
  yes
    Prints the reporter version number and exits.
  no (default)
    Normal reporter execution.

Returns report text or XML, depending on the value (0, 1, 2) of verbose. Uses the value of the -verbose switch if verbose is None.

Constructs and returns the XML contents of the report body. Child classes should override the default implementation, which returns None.

Sets the version of the reporter to version. Recognizes and parses CVS revision strings.

A convenience. Adds each element of paths to a list of temporary files that will be deleted automatically when the reporter is destroyed.

Returns the XML element name surrounding contents. escape should be true only for leaf elements; in this case, each special XML character (<>&) in contents is replaced by the equivalent XML entity.