| Category | Reporting |
| Class | cov_engine |
| Class Library | coverage.vcx |
| Base Class | formset |
| Parent Class | scov_formset |
This formset is not a subclass of _formset therefore the Coverage Profiler runs in both Microsoft Visual FoxPro 5.0 and Visual FoxPro 6.0.
Remarks
This class is subclassed from the Visual FoxPro formset class. Though it provides no visible components it provides the datatsession of a formset class and includes provisions for feedback on coverage log processing through WAIT WINDOW NOWAIT and MESSAGEBOX( ) and subclasses of MSComDlg.CommonDialog. This formset has one member, a toolbar, that remains hidden while providing a container for custom objects such as CusRegistry or Dialog subclasses. Cov_standard, a subclass of cov_engine, provides a sample user interface, the Coverage Profiler application. You can subclass either cov_engine or cov_standard to fit your requirements.
This one-dimensional array holds a list of registered AddIn files.
Default .F. (the array will be dimensioned [1])
This two-dimensional array holds a list of the file types (extensions) the Coverage Profiler handles. The first column holds the extension listed in the coverage text log (such as .fxp or .vct). The second column holds the extension of the matching source code file (such as .prg or .vcx) that the Coverage Profiler must locate in order to analyze the code. This array is filled at startup by the FillFileTypeArray( ) method.
Default: .F. (the array will be dimensioned [1, 2])
Specifies the AddIn last run successfully. At startup, this property can be set by an AddIn passed to the Coverage Profiler application as a parameter and run in the Init. Otherwise, if addin file names have been previously stored to the registry, this property is filled using the aAddIns array.
Default: ""
Specifies a base font name for any interface elements. The default for this attribute when no preference has been saved to the registry is the #DEFINE constant COV_DEFAULT_BASE_FONTNAME in COV_TUNE.H.
Default: MS Sans Serif
Specifies a base font name for any interface elements that require a monospaced font.
The default for this attribute when no preference has been saved to the registry is, first, any Visual FoxPro resource file entry for MODIFY COMMAND window preferences. Otherwise, the coverage engine looks for a Visual FoxPro registry entry for the Trace window. If one of these is not found, the coverage engine uses the #DEFINE constant COV_DEFAULT_MONO_FONTNAME in COV_TUNE.H.
Default: Courier New
Specifies the name of the cursor holding names of source files the Coverage Profiler should not locate and analyze. The engine fills this cursor with a set of file names, using the CreateCoverageFileNameCursor( ) and FillCoverageFileNameCursor( ) methods. You can use the coverage engine abstract AdjustCoverageFileNameCursor( ) method to add file names to the set.
Default: IgnoredFiles
Specifies the path to cSourceFile. Supplies the default path for any file output of the Coverage Profiler.
Default: ""
Specifies the character(s) that mark lines of code that executed according to the current coverage log. Although this property defaults to an empty string, the engine uses the SetMarks( ) procedure to adjust the length of cMarkExecuted and cMarkNotExecuted to equal lengths so the appearance of marked code is unspoiled. At startup, therefore, cMarkExecuted’s value is SPACE(4), to match the default length of cMarkNotExecuted.
Default: ""
Specifies the character(s) that marks lines of code not run during the current coverage log.
Default: |+SPACE(3)
Specifies the name of the table (.dbf) file that contains the list of source files skipped during coverage analysis.
Default: ""
Specifies the name of the table (.dbf) file that contains the coverage results.
Default: ""
Specifies the name of the cursor, which holds names of source files the Coverage Profiler could not locate or analyze. The engine fills this cursor using the CreateSkippedCursor( ) method and saves it to disk using the SaveSkippedCursor( ) method.
Default: SkippedFiles
Specifies the name of the source, which holds the appended and processed records stored by the coverage text log. The engine creates this cursor in the CreateSourceCursor( ) method, and provides the abstract AdjustSourceCursor( ) method so you can add fields, index tags, and so on. Then the engine proceeds to fill the cursor with records from the text log in the FillSourceCursor( ) method.
Default: FromLog
Specifies the name of the file to be analyzed. You can specify this value as the first parameter of the DO (_COVERAGE) WITH command.
Default: ""
Specifies the name of the current coverage log (SET(COVERAGE)) if the Coverage Profiler suspends coverage data logging. This property is set with the SuspendCoverage( ) method.
Default: ""
Specifies the target cursor, which holds the names of classes, source file names, coverage-marked procedure source code, and coverage statistics. The engine creates this cursor in the CreateTargetCursor( ) method, and provides the abstract AdjustTargetCursor( ) method so you can add fields, tags, and so on. Then the coverage engine locates and analyses source code in the FillTargetCursor( ) method.
Default: MarkedCode
Specifies the length of the field in the source work file that contains information about the object and method name that is running covered lines of code, when the #DEFINE COV_TOPSPEED in COV_TUNE.H is false (.F.). You can decrease the default value, with care, if your fully-qualified object names and your method names are short, and if you wish to conserve the disk space used by the Profiler work files. See COV_TUNE.H for more information about this value. See Conserving Disk Space during Coverage Runs for more information on using iLenExecuting.
Default: 115
Specifies the length of the Hostfile field in source, target, and project work files that holds the name of the fully-qualified Visual FoxPro file holding the source code, when the #DEFINE COV_TOPSPEED in COV_TUNE.H is false (.F.). You can decrease the default value, with care, if your source files don't have long paths and if you wish to conserve the disk space used by the Profiler work files. See COV_TUNE.H for more information about this value. See Conserving Disk Space during Coverage Runs for more information on using iLenHostFile.
Default: 115
Specifies the length of a field in the source and target work files that holds information about the object executing Covered lines of code, when the #DEFINE COV_TOPSPEED in COV_TUNE.H is false (.F.). To conserve the disk space used by the Profiler work files, you can decrease the default value, with care, if your object names are short. You can do this even when object names are fully-qualified by their container hierarchy. See COV_TUNE.H for more information about this value. See Conserving Disk Space during Coverage Runs for more information on using iLenObjClass.
Default: 115
Specifies a base font attribute (bold) for any displayed characters.
Default: .F.
Specifies a base font attribute (italic) for any displayed characters.
Default: .F.
Specifies a base font attribute (bold) for any displayed characters that require a monospaced font.
Default: .F.
Specifies a base font attribute (italic) for any displayed characters that require a monospaced font.
Default: .F.
A flag that specifies an error occurred, set by the Error method and checked by critical operations during processing.
Default: .F.
Specifies whether the Coverage Profiler opens in the main Visual FoxPro window. The default displays Coverage Profiler elements in a separate window.
Default: .F.
Specifies whether the Coverage Profiler analyzes the coverage log for profiling characteristics. In the default setting, the Coverage Profiler analyses for coverage characteristics.
Default: .F.
Specifies whether all source code is marked when a target file is loaded. In the default setting, individual source code records are marked one at a time as required by the user.
Default: .F.
Specifies whether the engine retains a reference to directories in which you have located files.
Default: .T.
Specifies how the lInProfileMode property is set when each coverage log loads. This value is significant when the property lMarkAllOnLoad is set to true (.T.).
Default: .F.
Specifies whether the Coverage Profiler issued SET TRBETWEEN OFF during its processing.
Default: .F.
Specifies whether user options are saved to and restored from the Windows registry.
Default: .T.
Determines whether feedback messages during processing are displayed in the status bar or as a WAIT WINDOW NOWAIT message. The status bar is used when the Coverage Profiler runs in the main Visual FoxPro window or in unattended mode and STATUS BAR is ON.
Default: .F.
Specifies whether the Coverage Profiler is running under Visual FoxPro version 5.0.
Default: (ATC("FoxPro 05",VERSION( )) > 0)
Specifies a base font size for any displayed characters.
Default: 8
A reference to the Coverage Frame window when the Coverage Profiler exists in a separate window. The engine ensures that this window exists before displaying any related dialog boxes or other elements (including common dialog subclasses, SET TALK display, and so on).
Default: .NULL.
Extracts the directory information from the passed file name, TcFileName, to concatenate into the current SET(PATH).
Syntax: AddPath(tcFileName)
Return: none
Arguments: TcFileName specifies a file name.
Adds a file name, TcFileToAdd, to the aAddIns array when called by the RunAddIn( ) method after an AddIn runs successfully.
Syntax: AddRegisteredAddin(tcFileToAdd)
Return: none
Arguments: tcFileToAdd specifies the file to add to the AddIn array.
Enables you to add files that you don’t want analyzed to the cursor’s file list when called by the CreateCoverageFilenameCursor( ) method. See the cCovFilesAlias property.
Syntax: AdjustCoverageFilenameCursor(tcTarget)
Return: NOT THIS.lReturn
Arguments: tcTarget specifies the name of the cursor you want to modify.
Abstract method that enables you to add index tags and custom fields to the source cursor when called by the CreateSourceCursor( ) method.
Syntax: AdjustSourceCursor(tcSource)
Return: NOT THIS.lReturn
Arguments: tcSource specifies the name of the cursor containing the source records.
Abstract method called by the CreateTargetCursor( ) method enables you to add index tags and custom fields to the target cursor.
Syntax: AdjustTargetCursor(tcTarget)
Return: NOT THIS.lReturn
Arguments: tcTarget specifies the name of the table being modified.
Removes a message from the status bar or performs a CLEAR WAIT WINDOW command. See lUsingStatusBar property.
Syntax: ClearStatus( )
Return: none
Arguments: none
Creates a cursor to hold the names of source files that the Coverage Profiler should not locate and analyze. See the cCovFilesAlias property.
Syntax: CreateCoverageFileNameCursor( )
Return: lReturn AND NOT THIS.lError
Arguments: none
At startup, displays the Coverage Profiler window after workfiles have been set up if the coverage engine is not in unattended mode. In the coverage engine base class, this method creates only the Coverage frame (if the engine is not running in the Visual FoxPro window). Subclasses can augment this method to add their own dialogs.
Syntax: CreateForms( )
Return: none
Arguments: none
The engine creates this cursor by looking for deleted records in the Source table, because skipped records are deleted when the engine encounters file names that cannot be Located or that are in the Ignored files list during its load of the log file. See the CSkippedAlias property.
Syntax: CreateSkippedCursor(tcSource, tcSkipped)
Return: NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcSkipped specifies the alias of the cursor containing the skipped records.
Creates a source cursor in the following format:
CREATE CURSOR(cSource) ;
(Duration n(7,3), ;
ObjClass c(COV_LEN_OBJCLASS), ;
Executing c(COV_LEN_EXECUTING), ;
Procline i, ;
Hostfile c(COV_LEN_HOSTFILE), ;
Stacklevel I, ;
FileType c(4) )
The Stacklevel field is excluded when the value of the lVFP5 property is true (.T.). See COV_TUNE.H for #DEFINE field lengths.
Syntax: CreateSourceCursor(tcSource)
Return: lReturn AND NOT THIS.lError
Arguments: tcSource specifies the name of the cursor containing the source records.
Creates a target cursor in the following format:
CREATE CURSOR (cTarget) ;
(Hostfile c(COV_LEN_HOSTFILE), ;
ObjClass c(COV_LEN_OBJCLASS), ;
FileType c(4), ;
Marked m, ;
Profiled m, ;
SourceCode m, ;
Coverable i, ;
Covered i, ;
ObjTotal i, ;
ObjHits i)
See COV_TUNE.H for #DEFINE field lengths.
The target file contains one record for each of the following in the coverage log:
Syntax: CreateTargetCursor(tcSource, tcTarget)
Return: NOT THIS.lError
Arguments
TcSource specifies the name of the file to analyze.
tcTarget specifies the name of the file you want to modify.
Syntax: DeleteRegisteredAddin(tcFileToDelete)
Return: none
Arguments:
tcFileToDelete specifies the AddIn to remove from the registry.
Removes a file name from the aAddIns array. Called by the RunAddIn method after an AddIn does not run successfully, whether the Registry is currently in use or not.
Enables reporting after project statistics have been gathered in GetProjectStatistics( ).
Syntax: DisplayProjectStatistics(tcSource, tcTarget, tcProject)
Return: NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
tcProject specifies the alias of the project being analyzed.
Displays tcMessage. If the Coverage Profiler is running in unattended mode, the message is displayed in a WAIT WINDOW TIMEOUT window so it doesn’t prevent further processing. You can specify the timeout value using COV_TIMEOUT_SECS (a #DEFINE in COV_TUNE.H).
Syntax: DoMessage(tcMessage [,tnMessageBoxOptions [,tcMessageBoxTitle]])
Return: liReturn
Arguments
tcMessage specifies the message that appears in the MESSAGEBOX.
tnMessageBoxOptions specifies the MESSAGEBOX nDialogBoxType setting.
tcMessageBoxTitle specifies the MESSAGEBOX cTitleBarText setting.
liReturn specifies any return value from MESSAGEBOX( ), or 0 if a WAIT WINDOW executes.
Sets the dialog error flag. Depending on the value of COV_DEBUG (a #DEFINE in COV_TUNE.H), will display an error MESSAGEBOX and release the engine or display a WAIT WINDOW with error information and invoke the native Visual FoxPro error handler to allow the developer to cancel, suspend, or ignore the current error.
Syntax: Error(nError, cMethod, nLine)
Return: none
Arguments
nError specifies the Visual FoxPro error number.
cMethod specifies the name of the method that caused the error.
nLine specifies the line number where the error occurred.
CreateCoverageFileNameCursor( ) calls this method to add the names of the coverage engine file set to the group of files that should be ignored during processing. This method is a hard-coded set of INSERTs in the base coverage engine. You can override this set in a subclass designed to read in a set of file names from a text file generated from the Coverage.pjx file list.
Syntax: FillCoverageFileNameCursor( )
Return: RETURN NOT THIS.lError
Arguments: none
Initializes the aFileTypes array with known file extensions. See the aFileTypes property.
Syntax: FillFileTypeArray( )
Return: NOT(EMPTY(THIS.aFileTypes[1,1]) OR THIS.lError)
Arguments: none
Places the unmarked source code for a target record into the appropriate memo field, for later marking, using a different strategy to find the right code for each type of source code. When COV_TOPSPEED is not #DEFINEd true (.T.), this method also places certain initial statistics into the Target file.
Syntax: FillOneTargetRecord(tcSource, tcTarget, tlFillingAll)
Return: lReturn AND(NOT THIS.lError)
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
tlFillingAll specifies whether all records are processed in a loop, which changes the user feedback and displayed character handling.
APPENDs the coverage log contents to the coverage analysis source file. This method calls the SourceAvailable( ) method to eliminate records that refer to source files unavailable for analysis. It marks these records deleted in the source cursor.
Syntax: FillSourceCursor(tcSource)
Return: lReturn
Arguments: tcSource specifies the name of the source file.
Calls the FillOneTargetRecord( ) method for all target records in a loop. Replicates the ObjHits statistics from the CreateTargetCursor( ) method for additional records referring to the same source files with the target files. See the CreateTargetCursor( ) method.
Syntax: FillTargetCursor(tcTarget)
Return: (THIS.iTargetReccount > 0 AND NOT THIS.lError)
Arguments: TcTarget specifies the target file that receives the processed results.
Provides a placeholder for future enhancements. It can be called either when a log loads or in response to a user action, with or without the Coverage Profiler application. This method is abstract in the engine.
Syntax: FilterListByLocation( )
Return: NOT THIS.lError
Arguments: none
Returns either a currently used alias or the default alias of one of the Coverage Profiler workfile types. The valid workfile types include the following:
"SOURCE"
"TARGET"
"SKIPPED"
"COVFILES"
"PROJECT"
(The list of types is #DEFINEd in COV_SPEC.H as COV_KNOWN_ALIAS_PROPERTIES.) Each workfile type matches one c…Alias property to specify the default alias for this workfile.
The Coverage Profiler usually has a cursor open using each one of the workfile default aliases. However, the Coverage Profiler is capable of handling many sets of workfiles at the same time, within its data session, as long as you specify separate aliases for each one. The GetAlias( ) method and the system of defined work types plus c…Alias properties allows you to have default alias names without the default aliases being hardcoded.
The engine methods that process the workfiles use aliases as parameters, so you can specify which source, target, or other file you are interested in at any time. Since you are usually interested only in one set of workfiles, however, these methods all use the GetAlias( ) methods to specify which alias and workfile default type to seek if you do not pass them a specific alias or aliases.
Syntax: GetAlias(tAlias, tcWhichProp)
Return: cReturn
Arguments
tAlias specifies the alias of a file.
tcWhichProp specifies the workfile type (currently, either Source or Target) of the current default.
Instantiates a common dialog subclass to ask the user to set font properties. If lUsingOCXs is false (.F.) or there has been an error instantiating the common dialog, the method uses the GETFONT( ) method. If the first parameter, tlBaseMonoFont, is true (.T.), the method shows only monospaced fonts and fills the monospaced font attribute properties of the engine. If this parameter is false (.F.), the second set of base font attribute properties is filled from a list of all available screen fonts.
Refer to the GetResourceLocation( ) method for more information on the lUsingOCXs property.
Syntax: GetFontsFromUser(tlBaseMonoFont, toMemberHost )
Return: lFontChange AND NOT THIS.lError
Arguments
tlBaseMonoFont specifies the default monospace font style.
toMemberHost specifies a reference to the current Coverage object.
Creates a cursor containing information about the files in a particular Visual FoxPro project, of this format:
CREATE CURSOR(cProject) ;
(Hostfile c(COV_LEN_HOSTFILE), ;
FileType c(4), ;
Coverable n(8), ;
Covered n(8), ;
ObjTotal n(8), ;
ObjHits n(8))
Creates a header file in this cursor, indicating the project to which this cursor applies. Fills this cursor with statistics drawn from the current coverage log that apply to each source file in the project. If necessary, calls MarkOneTargetRecord( ) for any project files that have not yet had their source code marked.
Syntax: GetStatistics(tcSource, tcTarget, tcProject)
Return: lReturn
Arguments
tcSource specifies the name of the alias containing the source records.
tcTarget specifies the name of the alias being modified.
tcProject specifies the project containing the source files.
Fills the aAddIns array and the cAddIn property.
Syntax: GetRegisteredAddins( )
Return: none
Arguments: none
This method, usually used at startup, uses the registry-handling member of the toolbar in the engine formset to get a registry key value for a user option. It converts the registry value to other TYPE( )s as required, and compares this TYPE( ) to the passed value, tDefaultValue. It returns the registry value or the default value if the registry value is not found or is of the wrong type.
Syntax: GetRegistryKeyValue(tcOption, tDefaultValue, tcPath)
Return: vReturn
Arguments
tcOption specifies the file type option.
tDefaultValue specifies the default registry value.
tcPath specifies RegKey.
Specifies whether GETFILE( )/ShowOpen( ) strategy or PUTFILE( )/ShowSave( ) strategy is followed. Note that this method provides for additional dialog subclasses, showing a Help file or print dialog, to be instantiated and used in the future.
toMemberHost specifies an optional form reference that can be passed to indicate where the dialog is displayed. If toMemberHost is not passed, the file dialog will display relative to the Coverage frame (if the Coverage frame exists) or to the first form in the formset collection (if the Coverage Profiler is in the Visual FoxPro window).
Adds a member of the appropriate common dialog subclass (depending on the value of tcWhichDialog) if this is the first call. The dialog subclasses differ in how they set various flags.
If a common dialog subclass or .ocx-related error occur in the Coverage Profiler, this method sets the lUsingOCXs property to false (.F.) and uses GETFILE( )/PUTFILE( ).
You can set the #DEFINE COV_USE_OCXS if you prefer to default to the native Visual FoxPro functions even if there are no OCX errors.
Syntax: GetResourceLocation(tcHost, tcTitle, tcCDLFilter, tcFileName, tcWhichDialog, [toMemberHost] )
Return: lcFileName
Arguments
tcHost specifies the name of the file name the method is starting from usually seeking the matching file name of the uncompiled version of the code. If it is passed, it provides information for the common file dialog .InitDir property.
tcTitle specifies the title to use in the dialog or, in the GETFILE( )/PUTFILE( ) version, to use as a WAIT WINDOW NOWAIT prompt. If tcHost is also passed and includes a file name, this information is added to the dialog title or prompt.
tcCDLFilter specifies the file types allowed in the dialog. This parameter is expressed in the format required by the common dialog filter expression. If the GETFILE( )/PUTFILE( ) is called, the method parses the common dialog filter to put it into appropriate format for the two Visual FoxPro functions.
tcFileName specifies the default file name to display.
tcWhichDialog GETFILE or PUTFILE.
This method allows the coverage engine to generate file names with which to save its work to disk without overwriting existing files. Normally, it just supplies file name defaults, but in unattended mode this method creates the file names without user intervention. Each method that saves a file to disk calls GetTableName( ) with a specific suffix; for example, in the SaveSkippedCursor:
cDBFName = ; THIS.GetTableName(COV_SKIPFILEDBF_SUFFIX)
GetTableName( ) uses the path and stem of the current log file name (THIS.cSourceFile) and attaches the appropriate suffix to this stem plus a digit, followed by the DBF extension.
For example, Testlog.txt would produce TESTLOG_SKIP1.DBF in the above example.
GetTableName( ) then increments the digit if the generated file name exists, until it finds a name that does not exist.
The default suffixes are #DEFINEs in COV_TUNE.H.
Syntax: GetTableName(tcWhichSuffix)
Return: cLogfileStem+SUFFIX[+n]+.dbf
Arguments: tcWhichSuffix specifies which file extension to use.
Freezes or releases LockScreen properties and MousePointer properties for all members of _Screen during various long procedures.
Syntax: LockScreens(tlOn)
Return: .T.
Arguments: tlOn specifies whether Lockscreen is locked.
Calls the MarkOneTargetRecord( ) method for all target records in a loop. Can be called because lMarkAllOnLoad is true (.T.) or because the coverage engine is in unattended mode.
Syntax: MarkAllTargetRecords(tcSource, tcTarget)
Return: NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
Creates a marked-up version of a line of code plus coverage statistics. In Coverage mode, marks code as Executed if tiExecuted is a positive number and not Executed if tiExecuted is 0. In Profile mode, marks coverage statistics appropriately for the line. In either mode, marks code as uncoverable (just padded in front with spaces) if tiExecuted is .NULL..
Returns the marked up code in cMarkedLine.
Syntax: MarkCodeLine(tcLine, tiExecuted, tnFirst, tnAverage)
Return: cMarkedLine
Arguments
tcLine specifies the line of code.
tiExecuted specifies the number of times tcLine was run.
tnAverage specifies the average length of time to run.
Determines whether the current target record, tcTarget, is already marked in the current coverage mode and, if not, passes the relevant information to the MarkTargetCoverage( ) method for processing.
Syntax: MarkOneTargetRecord(tcSource, tcTarget, tlFillingAll)
Return: lReturn AND (NOT THIS.lError)
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the record being modified.
tlFillingAll specifies whether other target records are being processed. If all records are processed in a loop, the user feedback and handling of displayed characters changes.
Creates a marked-up version of tcSource and REPLACEs a memo field in the Target file, tcTarget, (whether the code is for a class or a full procedure file).
To perform this action, the method starts with the sourcecode memo. The memo field REPLACEd depends on whether Coverage Profiler is marking Profiler or Coverage information, since the Target record retains both sets of marked-up code. This method parses the source code and evaluates its statistics line by line. By default, this method calls the MarkCodeLine( ) method to actually mark each line once it has the appropriate statistics. However, the way this method marks the code line is #DEFINEd as COV_MARK_CODE_LINE in COV_TUNE.H, not directly implemented as a call to the MarkCodeLine( ) method. This allows you to replace the call to the MarkCodeLine( ) method with a different marking system. A second #DEFINE, COV_TOPSPEED, in COV_TUNE.H also allows you to switch the MarkCodeLine( ) call to a simpler, in-line marking system for fastest response time.
MarkTargetCoverage( ) evaluates each line to find out whether it was executed, how many times it was executed, and its execution timings (first and average) when in Profile mode. However, many lines are considered uncoverable in Coverage Profiler. These lines, such as comments, DEFINE CLASS and ELSE statements, and lines within TEXT … ENDTEXT do not appear in coverage logs because they are not executable. This method sets the number of times these lines run to .NULL. These lines are not considered when Coverage Profiler compiles statistics. Also, lines broken by continuation symbols (semicolons) are considered as a single line of code and marked only on the last line.
Syntax: MarkTargetCoverage(tcSource, tcTarget)
Return: NOT (EMPTY(cMemo) OR THIS.lError)
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
This method provides a placeholder for future enhancements and subclasses and is abstract in the engine.
Syntax: OrderListByTime( )
Return: NOT THIS.lError
Arguments: none
Test at startup to determine whether passed parameters are appropriate to the class. If any passed parameters are not appropriate TYPE( ), provides a MESSAGEBOX showing what parameters may be passed, and RETURNs false (.F.), preventing any further coverage processing as well as the instantiation of the class.
This method uses a MESSAGEBOX for feedback and stops processing even if the Coverage Profiler is starting up in Unattended mode. If you are setting up the Coverage Profiler for automated testing, be sure your calling program sends correct parameters or the analysis will not proceed.
Syntax: PassedProperParams(tcFile, tlUnattended, tcAddIn)
Return: lReturn
Arguments
TcFile specifies the name of the log file.
TlUnattended specifies whether to run in unattended mode.
TcAddIn specifies the AddIn file name(s).
If the Coverage Profiler previously suspended coverage logging, this method gives the user a chance to resume coverage logging when the Coverage Profiler releases. The user can choose to overwrite this previous log, append new log entries to it, or not resume coverage logging at that time.
Syntax: RestoreCoverage( )
Return: none
Arguments: none
Runs a file (.scx, .fxp, .app, .prg, .qpx, .qpr, .mpx, or .mpr) that adds functionality to the Coverage object. If no file name is passed, this method runs the file specified by the cAddIn property.
The file must accept an object reference because the file is run by passing a reference to the coverage form, as in the following examples (depending on the file type):
DO (cFileName) WITH THIS
DO FORM (cFileName) WITH THIS
Syntax: RunAddin(tcAddin)
Return: lReturn AND NOT THIS.lError
Arguments: TcAddin specifies the name of the file to run.
This method can be called any time the user’s current values should be saved to the registry. It saves the following user preferences:
lStartInProfileMode
lSmartPath
lMarkAllOnLoad
cMarkExecuted
cMarkNotExecuted
lRegisterAddIn
Font name, size, italic, bold for base monospace font
There are a few registry settings not saved by this method, because they have to be done at specific moments during the life of the engine. These are:
Coverage or main Visual FoxPro frame (must be done when the user makes a choice and will be in effect next session, but does not correspond to or affect any of the coverage property values for this session).
Registered addins (this array is manipulated over the life of the session, and the full set of file names it contains is saved to the registry at the end of the session).
Syntax: SaveOptionsToRegistry( )
Return: lSuccess
Arguments: none
Saves the skipped files cursor to disk if it contains any records, and places the name of the table on disk in the cSavedSkipFiles property. See the cSkippedAlias and cSavedSkipFiles properties.
Syntax: SaveSkippedCursor(tcSkipped)
Return: RETURN NOT THIS.lError
Arguments: tcSkipped specifies the cursor containing skipped records.
Saves the output (target) file, including marked-up code and statistics, to disk.
Syntax: SaveTargetToDisk(tcTarget)
Return: lReturn and NOT THIS.lError
Arguments: tcTarget specifies the name of the modified table.
Sets up initial font attribute values using registry key values and other defaults. See cBaseFontName and cBaseMonoFontName for information on how the coverage engine derives these defaults.
Syntax: SetFontValues( )
Return: NOT THIS.lError
Arguments none
Attempts to set up a file for analysis.
If you pass no string value, the SET COVERAGE value is used. If there is no current log file, the method prompts for a file name. If a log file can be successfully set, the method returns .T. If the user designates no log file, the method returns. F. If no new log is specified, the Coverage Engine returns to the currently loaded log, if one is loaded, or releases, if no log is loaded.
Syntax: SetLogFile(tcFile)
Return: lReturn
Arguments: TcFile specifies the name of the file to analyze.
Synchronizes the lengths of cMarkExecuted and cMarkNotExecuted and returns the values of either or both properties to a default if they are not character-type or both properties are empty. If user options are not available from the registry, this method gets defaults from the #DEFINE values, COV_DEFAULT_MARKNOTEXECUTED and COV_DEFAULT_MARKEXECUTED, which you can set in COV_TUNE.H. A third #DEFINE, COV_DEFAULT_MARKSPACING, ensures that there is space between the marks and the line of code.
Syntax: SetMarks( )
Return: NOT THIS.lError
Arguments: none
Saves the file names in the aAddIns array to registry values.
Syntax: SetRegisteredAddins( )
Return: none
Arguments: none
This method uses the registry-handling member of the toolbar in the engine formset to set a registry key value from a user option. It converts all values to string type before sending them to the registry-handler to apply to the registry.
Syntax: SetRegistryKeyValue(tcWhichOption, tValue)
Return: NOT THIS.lError
Arguments
tcWhichOption specifies the user option to be accessed.
tValue specifies the value of tcWhichOption.
Abstract in the engine, called by SetUiOptions, designed to allow the user font preferences saved in the various Base and BaseMont font properties to be applied to appropriate displayed characters .
Syntax: SetUIFonts( )
Return: NOT THIS.lError
Arguments: none
Sets up initial UI options according to user preferences or defaults after initial setup of workfiles. This group of options includes fonts and the array of registered AddIns. It is required for UI display and user interaction with the workfiles, after they have been processed.
Syntax: SetUIOptions( )
Return: lReturn and NOT THIS.lError
Arguments: none
Abstract in the engine, called at the end of SetupWorkFiles( ) to allow UI to show current Target record in the newly loaded log.
Syntax: SetUIToShowCode(tcTarget)
Return: NOT THIS.lError
Arguments: none
Abstract in the engine, called at the end of SetupWorkFiles( ) to allow UI to indicate success or failure or current attempt to load a log.
Syntax: SetUIToShowFileStates(tcSource, tcTarget)
Return: NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
This method sets and validates a coverage log, and then creates and fills the source and target work files for this text log. If the user choice is the same as the log file currently loaded, the method asks the user whether the log should be reloaded and analyzed. It checks that the log is not open in a text window before loading the log. If the user specifies lMarkAllOnLoad, it marks all records in the current mode (Coverage or Profile) after successfully filling the target file with source code entries. If Coverage Profiler is in unattended mode, it marks all records in both Coverage and Profile mode after successfully filling the target file. If the load succeeds, this method also sets the cDefaultWritePath to mark the path of the text log and the cSourceFile property to hold the name of this text log.
Syntax: SetupWorkFiles(tcLogFile, tcSource, tcTarget)
Return: lReturn AND NOT THIS.lError
Arguments
TcLogFile specifies the name of the text log to analyze.
tcSource specifies the name of the file to use as source.
tcTarget specifies the name of the cursor being modified.
Sets up initial options according to user preferences or defaults before initial setup of workfiles. This group of options includes coverage marks and initial coverage mode, and is required for processing the work files.
Syntax: SetWorkOptions( )
Return: NOT THIS.lError
Arguments: none
Calls GetProjectStatistics( ) and DisplayProjectStatistics( ) to run coverage analysis figures against a specific Visual FoxPro project set of files.
Syntax: ShowStatistics(tcSource, tcTarget, tcProject)
Return: lReturn AND NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.
tcProject specifies the project containing tcSource.
Abstract in the base engine.
Syntax: ShowStatistics( )
Return: NOT THIS.lError
Arguments: none
Places a message in the status bar or a WAIT WINDOW. See lUsingStatusBar property.
Syntax: ShowStatus(cMessage)
Return:
Arguments: cMessage specifies the message to display in the status bar or WAIT WINDOW
Replaces the current Source log compiled file name with the full path name of the file holding the uncompiled source code. Calls GetSourceLoc( ) if necessary to Locate uncompiled source code. If the lSmarthPath property is true (.T.), uses AddPath( ) to adjust SET (PATH) as the user specifies directories in which to find source files. RETURNs false (.F.) if the source file is on the Ignored Files list, if the file is of an unknown type, or if the uncompiled source code cannot be found.
Syntax: SourceAvailable( )
Return: lReturn
Arguments: none
Checks the file name held in the cSourceFile property for valid coverage log format.
Syntax: SourceFileIsLog( )
Return: lReturn
Arguments: none
Sets cSuspendedLog to the name of the current log, and temporarily stops Visual FoxPro from writing this log, in one of the following cases:
Syntax: SuspendCoverage( )
Return: none
Arguments: none
If the lMarkAllOnLoad property is true (.T.), marks all target records in the new mode.
Syntax: ToggleCoverageProfileMode(tcSource, tcTarget)
Return: RETURN NOT THIS.lError
Arguments
tcSource specifies the name of the table containing the source records.
tcTarget specifies the name of the table being modified.