Product Documentation
Cadence SKILL Development Reference
Product Version IC23.1, June 2023

skTabulate

skTabulate( 
?fileNames g_tabulatedFileNames
[ ?reportFile t_reportFile ] 
[ ?showFile g_showFile ] 
[ ?dontResolveSymLink g_dontResolveSymLink ] 
[ ?customerInfo l_customerInfo ] 
[ ?printFiltered g_printFiltered ] 
[ ?ext l_ext ] 
[ ?infoFile g_infoFile ] 
[ ?defnFile g_defnFile ] 
[ ?recurse g_recurse ] 
[ ?exclude g_exclude ] 
[ ?recurseExclude g_recurseExclude ] 
[ ?sendReport g_sendReport ] 
=> t 

Description

Runs the SKILL Tabulator in batch mode.

Arguments

?fileNames g_tabulatedFileNames

The names of the files or directories to be tabulated. Should be a string or a list of strings.

?reportFile t_reportFile

The name of the generated report file. Defaults to "./skillTab.out".

?showFile g_showFile

Specifies whether to display the generated report file. Defaults to nil.

?dontResolveSymLink g_dontResolveSymLink

Specifies whether to resolve symbolic links. Defaults to nil.

?customerInfo l_customerInfo

A disembodied property list containing customer information, in the following form:

'(nil customerEmail <t_email>
customerName  <t_name> 
companyLocation <t_location> 
companyName <t_compName> 
customerPhone <t_phone> 
custProjName <t_projName> 

custProjInfo <t_projInfo>)

?printFiltered g_printFiltered

Specifies whether to print user defined functions. Defaults to t.

?ext l_ext

List of file extensions to be tabulated. The default options are ".il", "ile", and "cdsinit".

?infoFile g_infoFile

The file name for the information file, which contains the names of the files that refer each function.

?defnFile g_defnFile

The file name for the definition file, which contains the names of the files that define each function.

?recurse g_recurse

Specifies whether to recurse directories. Defaults to t.

?exclude g_exclude

List of files to be excluded from tabulation. Defaults to nil.

?recurseExclude g_recurseExclude

List of recursively excluded files. Defaults to nil.

?sendReport g_sendReport

Specifies whether to send the generated report to Cadence. Defaults to nil.

Value Returned

t

Always returns t.

Examples

skTabulate(
    list("./file1.il" "file2.il")
    ?reportFile "./myTabOutput.txt"
    ?showFile nil
    ?dontResolveSymLink nil
    ?customerInfo '(nil customerEmail "user@xyz.com" customerName "AN"
       companyLocation "SJ" companyName "myCompany" customerPhone "123456" 
       custProjName "" custProjInfo "")
    ?printFiltered t
    ?defnFile "./myDefnFile.txt"
    ?recurseExclude nil
    ?infoFile "./myInfoFile.txt"
    ?ext '("il")
    ?sendReport t
     );

Related Topics

Tabulator Functions


Return to top
 ⠀
X