CFG_EDGE_SET: cs_cfg_edge

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.0p0 Hot Tips

CONFIDENTIAL

CodeSecure Inc

CFG_EDGE_SET: cs_cfg_edge_set.h

Defines cs_cfg_edge_set operations for CodeSonar (see the Utility Functions page for cs_edge_label manipulation functions).

Links
Defines
Types
Functions
Function Descriptions

Defines

#define CS_CFG_EDGE_SET_H

Types

typedef cs_cfg_edge_set_iter

Definition	typedef struct cs_cfg_edge_set_iter_t cs_cfg_edge_set_iter
Notes	A structure to handle a cs_cfg_edge_set traversal. Used by: cs_cfg_edge_set_iter_first() cs_cfg_edge_set_iter_next() cs_cfg_edge_set_iter_close()

Definition

typedef struct cs_cfg_edge_set_iter_t cs_cfg_edge_set_iter

Notes

A structure to handle a cs_cfg_edge_set traversal.

Used by:

On Separate Pages

struct cs_cfg_edge_set_iter_t

Functions

cs_result	cs_cfg_edge_set_incr ( cs_cfg_edge_set cfg_edge_set ) Increment the reference count of a cs_cfg_edge_set.
cs_result	cs_cfg_edge_set_close ( cs_cfg_edge_set cfg_edge_set ) Close a cs_cfg_edge_set.
cs_boolean	cs_cfg_edge_set_equal ( cs_const_cfg_edge_set cfg_edge_set1, cs_const_cfg_edge_set cfg_edge_set2 ) Check two cs_cfg_edge_set sets for equality.
cs_boolean	cs_cfg_edge_set_same_instance ( cs_const_cfg_edge_set cfg_edge_set1, cs_const_cfg_edge_set cfg_edge_set2 ) Determine whether two cs_cfg_edge_set sets are the exact same object.
cs_hash_t	cs_cfg_edge_set_hash ( cs_const_cfg_edge_set cfg_edge_set ) Hash function for cs_cfg_edge_set.
cs_result	cs_cfg_edge_set_iter_first ( const cs_const_cfg_edge_set * cfg_edge_set, cs_pdg_vertex * pdg_vertex, cs_edge_label * edge_label, cs_cfg_edge_set_iter * cfg_edge_set_iter ) Retrieve the first cs_pdg_vertex and cs_edge_label from a cs_cfg_edge_set and open a cs_cfg_edge_set_iter for the rest of the set.
cs_result	cs_cfg_edge_set_iter_next ( cs_pdg_vertex * pdg_vertex, cs_edge_label * edge_label, cs_cfg_edge_set_iter * cfg_edge_set_iter ) Retrieve the next cs_pdg_vertex and cs_edge_label from a cs_cfg_edge_set_iter.
cs_result	cs_cfg_edge_set_iter_close ( cs_cfg_edge_set_iter * cfg_edge_set_iter ) Close a cs_cfg_edge_set_iter iterator.
cs_size_t	cs_cfg_edge_set_cardinality ( cs_const_cfg_edge_set cfg_edge_set ) Return the number of elements in a cs_cfg_edge_set.
cs_boolean	cs_cfg_edge_set_empty ( cs_const_cfg_edge_set set ) Check: is the specified cs_cfg_edge_set empty?
cs_boolean	cs_cfg_edge_set_member ( cs_const_cfg_edge_set set, cs_cfg_edge edge ) Check: is the specified cs_cfg_edge a member of the specified cs_cfg_edge_set?
cs_size_t	cs_cfg_edge_set_get_outstanding_references ( ) Get the number of cs_cfg_edge_set objects allocated by the C API.

Function Descriptions

Function cs_cfg_edge_set_incr

cs_result cs_cfg_edge_set_incr (

cs_cfg_edge_set cfg_edge_set )

Increment the reference count of a cs_cfg_edge_set.

Parameters

cfg_edge_set

[in]

The cs_cfg_edge_set subject to increment.

Returns

CS_SUCCESS on success.

Notes

Increment function for cs_cfg_edge_set: increments the reference count for cfg_edge_set.

Function cs_cfg_edge_set_close

cs_result cs_cfg_edge_set_close (

cs_cfg_edge_set cfg_edge_set )

Close a cs_cfg_edge_set.

Parameters

cfg_edge_set

[in]

The cs_cfg_edge_set to close.

Returns

CS_SUCCESS on success.

Notes

Decrements the reference count for cfg_edge_set. If this brings the reference count to 0 (zero), frees the set.

Function cs_cfg_edge_set_equal

cs_boolean cs_cfg_edge_set_equal (

cs_const_cfg_edge_set cfg_edge_set1,
cs_const_cfg_edge_set cfg_edge_set2 )

Check two cs_cfg_edge_set sets for equality.

Parameters

cfg_edge_set1	[in]	First argument to equality check.
cfg_edge_set2	[in]	Second argument to equality check.

Returns

cs_true if cfg_edge_set1 and cfg_edge_set2 are equal; cs_false if not.

Function cs_cfg_edge_set_same_instance

cs_boolean cs_cfg_edge_set_same_instance (

cs_const_cfg_edge_set cfg_edge_set1,
cs_const_cfg_edge_set cfg_edge_set2 )

Determine whether two cs_cfg_edge_set sets are the exact same object.

Parameters

cfg_edge_set1	[in]	First argument to same-object check.
cfg_edge_set2	[in]	Second argument to same-object check.

Returns

cs_true if cfg_edge_set1 and cfg_edge_set2 are the same object; cs_false if not.

Notes

cs_cfg_edge_set_same_instance( a, b ) implies cs_cfg_edge_set_equal ( a, b ).

Function cs_cfg_edge_set_hash

cs_hash_t cs_cfg_edge_set_hash (

cs_const_cfg_edge_set cfg_edge_set )

Hash function for cs_cfg_edge_set.

Parameters

cfg_edge_set

[in]

A cs_cfg_edge_set to hash.

Returns

A hash of cfg_edge_set.

Notes

Two sets with the same contents will have the same hash.

Function cs_cfg_edge_set_iter_first

cs_result cs_cfg_edge_set_iter_first (

const cs_const_cfg_edge_set * cfg_edge_set,
cs_pdg_vertex * pdg_vertex,
cs_edge_label * edge_label,
cs_cfg_edge_set_iter * cfg_edge_set_iter )

Retrieve the first cs_pdg_vertex and cs_edge_label from a cs_cfg_edge_set and open a cs_cfg_edge_set_iter for the rest of the set.

Parameters

cfg_edge_set	[in]	The cs_cfg_edge_set from which to obtain the first cs_pdg_vertex.
pdg_vertex	[out]	The first cs_pdg_vertex in cfg_edge_set.
edge_label	[out]	The first cs_edge_label in cfg_edge_set.
cfg_edge_set_iter	[out]	An iterator for cfg_edge_set.

Returns

A cs_result:

CS_OUT_OF_ELEMENTS if cfg_edge_set is empty,
CS_SUCCESS otherwise.

Notes

Retrieve the first cs_pdg_vertex and cs_edge_label from cfg_edge_set. This function opens cfg_edge_set_iter, which is required by cs_cfg_edge_set_iter_next(). Use cs_cfg_edge_set_iter_close() to close cfg_edge_set_iter.

Function cs_cfg_edge_set_iter_next

cs_result cs_cfg_edge_set_iter_next (

cs_pdg_vertex * pdg_vertex,
cs_edge_label * edge_label,
cs_cfg_edge_set_iter * cfg_edge_set_iter )

Retrieve the next cs_pdg_vertex and cs_edge_label from a cs_cfg_edge_set_iter.

Parameters

pdg_vertex	[out]	The next cs_pdg_vertex.
edge_label	[out]	The next cs_edge_label.
cfg_edge_set_iter	[inout]	The cs_cfg_edge_set_iter from which to retrieve pdg_vertex and edge_label.