CodeSonar C++ API
Public Member Functions | Related Symbols | List of all members
cs::warningclass Class Reference

A warning class. More...

Public Member Functions

 warningclass (const warningclass &other)
 Copy constructor.
 
bool allowed () const
 Check: are WARNING_FILTER settings such that reported instances of this warning class will be submitted to the hub?
 
bool always_discarded () const
 Check: are WARNING_FILTER settings such that instances of this warning class will always be ignored?
 
std::string as_repr () const
 Get a representation of a warningclass object that includes information useful for debugging.
 
std::string as_string () const
 Get a simple string representation of a warningclass object.
 
int cmp (const warningclass &other) const
 Comparison function for warningclass.
 
cs_hash_t hash () const
 Hash function for warningclass.
 
csuint32 id () const
 Get the ID of a warning class.
 
std::string name () const
 Get the name of a warning class.
 
result report (const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with no association to a file or procedure.
 
result report (const std::vector< cs::cfg_path_node > &p)
 Report a warning with a path.
 
result report (const std::vector< cs::cfg_path_node > &p, const warning_retraction_info &ri)
 Report a warning with a path, providing retraction information.
 
result report (const std::vector< cs::locations_node > &p)
 Report a warning with a list of code locations.
 
result report (const std::vector< cs::locations_node > &p, const warning_retraction_info &ri)
 Report a warning with a list of code locations, providing retraction information.
 
result report (const std::vector< cs::locations_node > &p, procedure proc)
 Report a warning with a list of code locations in a specified procedure.
 
result report (const std::vector< cs::locations_node > &p, procedure proc, const warning_retraction_info &ri)
 Report a warning with a list of code locations in a specified procedure, providing retraction information.
 
result report (point p, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a point, providing retraction information.
 
result report (point p, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a point.
 
result report (sfileinst file, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning associated with a file instance, providing retraction information.
 
result report (sfileinst file, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning associated with a file instance.
 
result report (sfileinst file, line_number line, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning with a code location, providing retraction information.
 
result report (sfileinst file, line_number line, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with a code location.
 
result report (sfileinst file, line_number line, procedure proc, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a line in a specified procedure, providing retraction information.
 
result report (sfileinst file, line_number line, procedure proc, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a line in a specified procedure.
 
result report (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning with a code span location, providing retraction information.
 
result report (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with a code span location.
 
result report (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, procedure proc, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a span in a specified procedure, providing retraction information.
 
result report (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, procedure proc, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a span in a specified procedure.
 
result report (step_path p)
 Report a warning with a step path.
 
result report (step_path p, const warning_retraction_info &ri)
 Report a warning with a step path, providing retraction information.
 
warning report_return_warning (const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with no association to a file or procedure and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::cfg_path_node > &p)
 Report a warning with a path and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::cfg_path_node > &p, const warning_retraction_info &ri)
 Report a warning with a path, providing retraction information, and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::locations_node > &p)
 Report a warning with a list of code locations and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::locations_node > &p, const warning_retraction_info &ri)
 Report a warning with a list of code locations, providing retraction information, and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::locations_node > &p, procedure proc)
 Report a warning with a list of code locations in a specified procedure and return the reported warning object.
 
warning report_return_warning (const std::vector< cs::locations_node > &p, procedure proc, const warning_retraction_info &ri)
 Report a warning with a list of code locations in a specified procedure, providing retraction information, and return the reported warning object.
 
warning report_return_warning (point p, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a point, providing retraction information, and return the reported warning object.
 
warning report_return_warning (point p, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a point and return the reported warning object.
 
warning report_return_warning (sfileinst file, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning associated with a file instance, providing retraction information, and return the reported warning object.
 
warning report_return_warning (sfileinst file, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning associated with a file instance and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number line, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning with a code location, providing retraction information, and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number line, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with a code location and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number line, procedure proc, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a span in a specified procedure, providing retraction information, and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number line, procedure proc, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a span in a specified procedure and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning with a code location, providing retraction information, and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning with a code span location and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, procedure proc, const std::string &endbox, report_flags flags, const warning_retraction_info &ri)
 Report a warning at a span in a specified procedure, providing retraction information, and return the reported warning object.
 
warning report_return_warning (sfileinst file, line_number start_line, line_number end_line, column_number start_col, column_number end_col, procedure proc, const std::string &endbox, report_flags flags=report_flags::NONE)
 Report a warning at a span in a specified procedure and return the reported warning object.
 
warning report_return_warning (step_path p)
 Report a warning with a step path and return the reported warning object.
 
warning report_return_warning (step_path p, const warning_retraction_info &ri)
 Report a warning with a step path, providing retraction information, and return the reported warning object.
 

Related Symbols

(Note that these are not member symbols.)

bool operator!= (const warningclass &a, const warningclass &b)
 Inequality operator for warningclass.
 
bool operator< (const warningclass &a, const warningclass &b)
 Less-than operator for warningclass.
 
std::ostream & operator<< (std::ostream &out, const warningclass &a)
 
 
bool operator<= (const warningclass &a, const warningclass &b)
 Less-than-or-equal operator for warningclass.
 
bool operator== (const warningclass &a, const warningclass &b)
 Equality operator for warningclass.
 
bool operator> (const warningclass &a, const warningclass &b)
 Greater-than operator for warningclass.
 
bool operator>= (const warningclass &a, const warningclass &b)
 Greater-than-or-equal operator for warningclass.
 

Detailed Description

A warning class.

Use analysis::create_warningclass() to create new warningclass objects.

Report a warning with report() (which returns a result) or report_return_warning() (which returns the reported warning object). Both forms provide the option of specifying retraction information.

Warnings can be reported... report() and report_return_warning()
at a point
with a path
with a step path
at a code location
with a list of code locations
at a line in a specified procedure
at a code span in a specified procedure and file instance
at a code span in a specified file instance
with a list of code locations in a procedure
associated with a file instance
with no association to a file or procedure

Constructor & Destructor Documentation

◆ warningclass()

cs::warningclass::warningclass ( const warningclass &  other)
inline

Copy constructor.

Parameters
[in]otherThe warningclass object to copy.

This copy constructor is provided so that it can be used underlyingly at function calls when warningclass parameters are specified or warningclass return values are assigned. It is unlikely that you will need to call it directly.

Member Function Documentation

◆ allowed()

bool cs::warningclass::allowed ( ) const
inline

Check: are WARNING_FILTER settings such that reported instances of this warning class will be submitted to the hub?

Returns
true if reported instances of the class will be submitted to the hub, false otherwise.

If you have defined a custom warning class C in a plug-in, you can use a test based on C.allowed() to avoid unnecessary work in the case where C is ignored.

This is the complement of warningclass::always_discarded().

◆ always_discarded()

bool cs::warningclass::always_discarded ( ) const
inline

Check: are WARNING_FILTER settings such that instances of this warning class will always be ignored?

Returns
true if all instances of the class are being discarded, false otherwise.

If you have defined a custom warning class C in a plug-in, you can use a test based on C.always_discarded() to avoid unnecessary work in the case where C is ignored.

This is the complement of warningclass::allowed().

◆ as_repr()

std::string cs::warningclass::as_repr ( ) const
inline

Get a representation of a warningclass object that includes information useful for debugging.

Returns
The string representation.

◆ as_string()

std::string cs::warningclass::as_string ( ) const
inline

Get a simple string representation of a warningclass object.

Returns
The string representation.

◆ cmp()

int cs::warningclass::cmp ( const warningclass &  other) const
inline

Comparison function for warningclass.

Parameters
otherThe warningclass object to compare against.
Returns
An integer N, such that:
  • N<0 if this < other
  • N==0 if this == other
  • N>0 if this > other

◆ hash()

cs_hash_t cs::warningclass::hash ( ) const
inline

Hash function for warningclass.

Returns
A hash of the warning class.

◆ id()

csuint32 cs::warningclass::id ( ) const
inline

Get the ID of a warning class.

Returns
The ID of the warning class.

To get a warningclass given its ID, use analysis::lookup_warningclass(csuint32). Note that a single warning class may have different ID values in different analyses.

◆ name()

std::string cs::warningclass::name ( ) const
inline

Get the name of a warning class.

Returns
The warning class name.

◆ report() [1/21]

result cs::warningclass::report ( const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with no association to a file or procedure.

Parameters
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be always be automatically retracted during an incremental build, since the warning is against the entire analysis.

There are multiple methods for reporting a warning with no association to a file or procedure. See the table above for details.

◆ report() [2/21]

result cs::warningclass::report ( const std::vector< cs::cfg_path_node > &  p)
inline

Report a warning with a path.

Parameters
[in]pThe path associated with the warning, with each point on the path described by a cfg_path_node.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.
result::ERROR_INVALID_ARGUMENTif path argument p is empty.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first point in p has been modified.

There are multiple methods for reporting a warning with a path. See the table above for details.

◆ report() [3/21]

result cs::warningclass::report ( const std::vector< cs::cfg_path_node > &  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a path, providing retraction information.

Parameters
[in]pThe path associated with the warning, with each point on the path described by a cfg_path_node.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.
result::ERROR_INVALID_ARGUMENTif path argument p is empty.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

◆ report() [4/21]

result cs::warningclass::report ( const std::vector< cs::locations_node > &  p)
inline

Report a warning with a list of code locations.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first location in p has been modified.

There are multiple methods for reporting a warning with a list of code locations. See the table above for details.

◆ report() [5/21]

result cs::warningclass::report ( const std::vector< cs::locations_node > &  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a list of code locations, providing retraction information.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a list of code locations. See the table above for details.

◆ report() [6/21]

result cs::warningclass::report ( const std::vector< cs::locations_node > &  p,
procedure  proc 
)
inline

Report a warning with a list of code locations in a specified procedure.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]procThe procedure in which the warning occurs.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first location in p has been modified.

There are multiple methods for reporting a warning with a list of code locations in a specified procedure. See the table above for details.

◆ report() [7/21]

result cs::warningclass::report ( const std::vector< cs::locations_node > &  p,
procedure  proc,
const warning_retraction_info &  ri 
)
inline

Report a warning with a list of code locations in a specified procedure, providing retraction information.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]procThe procedure in which the warning occurs.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a list of code locations in a specified procedure. See the table above for details.

◆ report() [8/21]

result cs::warningclass::report ( point  p,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a point, providing retraction information.

Parameters
[in]pThe point where the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a point. See the table above for details.

◆ report() [9/21]

result cs::warningclass::report ( point  p,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a point.

Parameters
[in]pThe point where the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing p has been modified.

There are multiple methods for reporting a warning at a point. See the table above for details.

◆ report() [10/21]

result cs::warningclass::report ( sfileinst  file,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning associated with a file instance, providing retraction information.

Parameters
[in]fileThe file instance (sfileinst).
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning associated with a file instance. See the table above for details.

◆ report() [11/21]

result cs::warningclass::report ( sfileinst  file,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning associated with a file instance.

Parameters
[in]fileThe file instance (sfileinst).
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning associated with a file instance. See the table above for details.

◆ report() [12/21]

result cs::warningclass::report ( sfileinst  file,
line_number  line,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning with a code location, providing retraction information.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a code location. See the table above for details.

◆ report() [13/21]

result cs::warningclass::report ( sfileinst  file,
line_number  line,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with a code location.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning with a code location. See the table above for details.

◆ report() [14/21]

result cs::warningclass::report ( sfileinst  file,
line_number  line,
procedure  proc,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a line in a specified procedure, providing retraction information.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

◆ report() [15/21]

result cs::warningclass::report ( sfileinst  file,
line_number  line,
procedure  proc,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a line in a specified procedure.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

◆ report() [16/21]

result cs::warningclass::report ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning with a code span location, providing retraction information.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line where the warning starts.
[in]end_colThe column on end_line where the warning ends.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a code location. See the table above for details.

◆ report() [17/21]

result cs::warningclass::report ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with a code span location.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line where the warning starts.
[in]end_colThe column on end_line where the warning ends.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning with a code location. See the table above for details.

◆ report() [18/21]

result cs::warningclass::report ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
procedure  proc,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a span in a specified procedure, providing retraction information.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line on which the warning starts.
[in]end_colThe column on end_line on which the warning ends.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report() [19/21]

result cs::warningclass::report ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
procedure  proc,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a span in a specified procedure.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line on which the warning starts.
[in]end_colThe column on end_line on which the warning ends.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths) or, for the versions that accept spans, if the span is malformed.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

◆ report() [20/21]

result cs::warningclass::report ( step_path  p)
inline

Report a warning with a step path.

Parameters
[in]pThe step path (step_path) associated with the warning.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first point in p has been modified.

There are multiple methods for reporting a warning with a step path. See the table above for details.

◆ report() [21/21]

result cs::warningclass::report ( step_path  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a step path, providing retraction information.

Parameters
[in]pThe step path (step_path) associated with the warning.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.

Returns
A result, as follows:
  • result::SUCCESS if the warning was successfully queued for submission to the hub.
  • result::FILTERED_OUT if the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
  • result::TIMEOUT if the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
  • result::NO_SOURCE_CORRESPONDENCE if the warning was not submitted to the hub because no source location for the warning could be determined.
  • result::ELEMENT_ALREADY_PRESENT if the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
Exceptions
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a step path. See the table above for details.

◆ report_return_warning() [1/21]

warning cs::warningclass::report_return_warning ( const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with no association to a file or procedure and return the reported warning object.

Parameters
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be always be automatically retracted during an incremental build, since the warning is against the entire analysis.

There are multiple methods for reporting a warning with no association to a file or procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [2/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::cfg_path_node > &  p)
inline

Report a warning with a path and return the reported warning object.

Parameters
[in]pThe path associated with the warning, with each point on the path described by a cfg_path_node.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.
result::ERROR_INVALID_ARGUMENTif path argument p is empty.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first point in p has been modified.

There are multiple methods for reporting a warning with a path. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [3/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::cfg_path_node > &  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a path, providing retraction information, and return the reported warning object.

Parameters
[in]pThe path associated with the warning, with each point on the path described by a cfg_path_node.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.
result::ERROR_INVALID_ARGUMENTif path argument p is empty.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a path. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [4/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::locations_node > &  p)
inline

Report a warning with a list of code locations and return the reported warning object.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first location in p has been modified.

There are multiple methods for reporting a warning with a list of code locations. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [5/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::locations_node > &  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a list of code locations, providing retraction information, and return the reported warning object.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a list of code locations. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [6/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::locations_node > &  p,
procedure  proc 
)
inline

Report a warning with a list of code locations in a specified procedure and return the reported warning object.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]procThe procedure in which the warning occurs.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first location in p has been modified.

There are multiple methods for reporting a warning with a list of code locations in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [7/21]

warning cs::warningclass::report_return_warning ( const std::vector< cs::locations_node > &  p,
procedure  proc,
const warning_retraction_info &  ri 
)
inline

Report a warning with a list of code locations in a specified procedure, providing retraction information, and return the reported warning object.

Parameters
[in]pThe list of code locations (locations_node) associated with the warning.
[in]procThe procedure in which the warning occurs.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths), or if p is empty.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a list of code locations in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [8/21]

warning cs::warningclass::report_return_warning ( point  p,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a point, providing retraction information, and return the reported warning object.

Parameters
[in]pThe point where the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a point. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [9/21]

warning cs::warningclass::report_return_warning ( point  p,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a point and return the reported warning object.

Parameters
[in]pThe point where the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing p has been modified.

There are multiple methods for reporting a warning at a point. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [10/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning associated with a file instance, providing retraction information, and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst).
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning associated with a file instance. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [11/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning associated with a file instance and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst).
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning associated with a file instance. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [12/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  line,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning with a code location, providing retraction information, and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a code location. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [13/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  line,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with a code location and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning with a code location. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [14/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  line,
procedure  proc,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a span in a specified procedure, providing retraction information, and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [15/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  line,
procedure  proc,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a span in a specified procedure and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]lineThe line in file on which the warning occurs.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [16/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning with a code location, providing retraction information, and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line where the warning starts.
[in]end_colThe column on end_line where the warning ends.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a code location. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [17/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning with a code span location and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line on which the warning starts.
[in]end_colThe column on end_line on which the warning ends.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

This creates a single-event warning where the event is an end box.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning with a code span location. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [18/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
procedure  proc,
const std::string &  endbox,
report_flags  flags,
const warning_retraction_info &  ri 
)
inline

Report a warning at a span in a specified procedure, providing retraction information, and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line on which the warning starts.
[in]end_colThe column on end_line on which the warning ends.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [19/21]

warning cs::warningclass::report_return_warning ( sfileinst  file,
line_number  start_line,
line_number  end_line,
column_number  start_col,
column_number  end_col,
procedure  proc,
const std::string &  endbox,
report_flags  flags = report_flags::NONE 
)
inline

Report a warning at a span in a specified procedure and return the reported warning object.

Parameters
[in]fileThe file instance (sfileinst) containing the warning.
[in]start_lineThe line in file on which the warning starts.
[in]end_lineThe line in file on which the warning ends.
[in]start_colThe column on start_line on which the warning starts.
[in]end_colThe column on end_line on which the warning ends.
[in]procThe procedure in which the warning occurs.
[in]endboxA short explanation of why the warning has been issued.
[in]flagsreport_flags that characterize the report.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_ARGUMENTif warnings of this class have associated paths (and should therefore be reported with those paths).
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing file has been modified.

There are multiple methods for reporting a warning at a line in a specified procedure. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [20/21]

warning cs::warningclass::report_return_warning ( step_path  p)
inline

Report a warning with a step path and return the reported warning object.

Parameters
[in]pThe step path (step_path) associated with the warning.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if the compunit containing the first point in p has been modified.

There are multiple methods for reporting a warning with a step path. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

◆ report_return_warning() [21/21]

warning cs::warningclass::report_return_warning ( step_path  p,
const warning_retraction_info &  ri 
)
inline

Report a warning with a step path, providing retraction information, and return the reported warning object.

Parameters
[in]pThe step path (step_path) associated with the warning.
[in]riwarning_retraction_info describing the circumstances in which the warning should be retracted for subsequent incremental analyses.
Returns
The warning object corresponding to the reported warning.

Exceptions
result::FILTERED_OUTif the warning was not submitted to the hub because it matched a WARNING_FILTER discard rule in the configuration file.
result::TIMEOUTif the time limit specified by configuration file option TIME_LIMIT_RENDER expired.
result::NO_SOURCE_CORRESPONDENCEif the warning was not submitted to the hub because no source location for the warning could be determined.
result::ELEMENT_ALREADY_PRESENTif the warning was not submitted to the hub because configuration file option REPORT_SIMILAR_WARNINGS is set to No and a similar warning was previously submitted.
result::ERROR_INVALID_PHASE_FOR_OPERATIONif called from a drop visitor, cs_plug_main(), or your plug-in's top-level scope.

The warning will be automatically retracted in a subsequent incremental analysis if and only if one or more of the conditions expressed in ri is satisfied.

There are multiple methods for reporting a warning with a step path. See the table above for details.

Always invoke report_return_warning() methods inside a try block.

Friends And Related Symbol Documentation

◆ operator!=()

bool operator!= ( const warningclass &  a,
const warningclass &  b 
)
related

Inequality operator for warningclass.

Returns
false if a and b are equal according to warningclass::cmp(), true otherwise.

◆ operator<()

bool operator< ( const warningclass &  a,
const warningclass &  b 
)
related

Less-than operator for warningclass.

Returns
true if a < b according to warningclass::cmp() , false otherwise.

◆ operator<<()

std::ostream & operator<< ( std::ostream &  out,
const warningclass &  a 
)
related


Print a representation of a warningclass object to the specified stream.

Parameters
[in]outThe stream to print to.
[in]aThe warningclass object to print.
Returns
void

◆ operator<=()

bool operator<= ( const warningclass &  a,
const warningclass &  b 
)
related

Less-than-or-equal operator for warningclass.

Returns
true if a <= b according to warningclass::cmp() , false otherwise.

◆ operator==()

bool operator== ( const warningclass &  a,
const warningclass &  b 
)
related

Equality operator for warningclass.

Parameters
[in]aThe warningclass object to compare.
[in]bThe warningclass object to compare against.
Returns
true if a and b are equal according to warningclass::cmp(), false otherwise.

◆ operator>()

bool operator> ( const warningclass &  a,
const warningclass &  b 
)
related

Greater-than operator for warningclass.

Returns
true if a > b according to warningclass::cmp() , false otherwise.

◆ operator>=()

bool operator>= ( const warningclass &  a,
const warningclass &  b 
)
related

Greater-than-or-equal operator for warningclass.

Returns
true if a >= b according to warningclass::cmp() , false otherwise.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8