Rule Reporting Macros

You can use the following macros in SK_RULE macros to report errors, warnings, hints, and information to the user in the same format that SKILL Lint uses when generating standard messages:

SK_ERROR( type format arg ...) 

SK_WARNING( type format arg ...) 

SK_HINT( type format arg ...) 

SK_INFO( type format arg ...)

The arguments are as follows:

type	Message identifier
format	Format string (as used by printf)
arg ...	One or more printing arguments

For example:

SK_WARNING( GGTESTDATA "This function now requires 3 arguments: %L\n" SK_FORM())

This macro prints a message of the following form:

WARN (GGTESTDATA) myFile.il line 32 : This function now requires 3 arguments: ggTestData(abc 78.6)

You should use these macros in rules commands to report messages to the user when problems are encountered.

To allow the user to control the reporting of these messages the way they can with other SKILL Lint messages, use the SK_REGISTER macro outside the SK_RULE macro as follows:

SK_RULE(…
   ruleReportingMacro( type … )
)
SK_REGISTER( type )

For example:

SK_RULE( ggTestData
   length(SK_ARGS()) == 2
   SK_ERROR( GGTESTDATA “This function now requires 3 arguments: %L\n” SK_FORM())
)
SK_REGISTER( GGTESTDATA )

Related Topics

SKILL Lint Rules

Rule Structure - SK_RULE Macro

Rule Access Macros

Advanced Rule Macros

Return to top