Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▶Ncs	Namespace for CodeSonar/CodeSurfer API
Caccess_path	An access path describes a memory location as a sequence of steps from some base symbol, with each step represented by a access_path object
Canalysis	Manages the warning classes (warningclass) and visitors (visitor) for the analysis
Canalysis_mode	Enumeration class describing the mode of a CodeSonar analysis process
Cast	An Abstract Syntax Tree (AST)
Cast_bindings	The result of an ast_pattern::match() query: bindings from ast_pattern variables to AST fields (ast_field)
Cast_class	Enumeration class for AST classes
Cast_family	Enumeration class for AST family
Cast_field	A field (child or attribute) of an Abstract Syntax Tree (class ast)
Cast_field_not_found_error	Describe an error where an ast_field lookup failed
Cast_field_type	Enumeration class for AST field (child or attribute; ast_field) types
Cast_iterator	Iterator over the Abstract Syntax Trees (ASTs, ast) in the tree rooted at a particular ast
Cast_ordinal	Enumeration class for AST ordinals: used to designate a field (ast_field) of an ast
Cast_pattern	An AST Pattern
Cast_pattern_compilation_error	Describe an error in compiling an ast_pattern
Cast_traverse_directives	Flag class: specifies behavior during traversal with an ast_iterator
Cast_traverse_flags	Flag class: specifies what kind of traversal an ast_iterator will carry out
Ccfg_edge_set	A set of cfg_edge
Ccfg_edge_set_iterator	Iterator over the cfg_edge elements of a cfg_edge_set
Ccfg_path_node	A node on a CFG path
Ccfg_path_node_flags	Flag class: characterizes a cfg_path_node
Ccompunit	A compilation unit
Ccompunit_global_iterator	Iterator over the global symbols (symbol) in a compilation unit (compunit)
Ccompunit_metricclass	A compunit granularity metric class
Ccompunit_metricclass_iterator	Iterator over the compunit-granularity metric classes (compunit_metricclass) managed by a compunit_metricclass_manager
Ccompunit_metricclass_manager	Manages the compunit granularity metric classes (compunit_metricclass) associated with an analysis
Ccompunit_procedure_iterator	Iterator over the procedures (procedure) in a compilation unit (compunit)
Ccsurf_info	Information about the CodeSurfer installation
Cdirectory	A directory
Cdirectory_children_iterator	Iterator over the immediate subdirectories (directory) of a directory (directory)
Cdirectory_files_iterator	Iterator over the files (sfile) immediately contained in a directory (directory)
Cedge_label	Denotes the conditions under which control can flow along an edge: a component of a cfg_edge
Cfunc_attrs	Flag class: describes the attributes of a symbol of kind symbol_kind::FUNCTION
Cint_pair_set	Used to store pairs of integers, each of which represents a range of locations in a source file
Cint_pair_set_iterator	Iterator over the int_pair elements of a int_pair_set
Cint_pairs_to_points_map	A map int_pair_set -> point_set, where each entry represents the mapping from a source position to the set of points at that source position
Clanguage	Enumeration class: identifies the source language the compilation unit is in
Cline_counts	A collection of line count statistics
Clocations_node	Used by warningclass report() and report_return_warnings() methods that report a warning with a list of code locations
Clocations_node_flags	Flag class: describes properties of a locations_node
Cmetric_function	The calculation function for a metric class
Cmetricclass_flags	Flag class: characterizes a metric class (procedure_metricclass, sfile_metricclass, compunit_metricclass, project_metricclass)
Cmultiprocess_mode	Enumeration class describing the multiprocess mode of a CodeSonar analysis process
Cobject_pager	Management for IO buffering
Cpoint	A single program point
Cpoint_adjusted_callees_iterator	An iterator over the callee procedures (procedure) from a specific point, taking into account any translations incurred by csonar_replace_*() calls and the FUNCTION_MAP configuration file variable
Cpoint_adjusted_callees_no_reroute_iterator	An iterator over the callee procedures (procedure) from a specific point, ignoring any translations incurred by csonar_replace_*() calls and the FUNCTION_MAP configuration file variable
Cpoint_kind	Enumeration class: program point (point) kind
Cpoint_set	A set of points (point)
Cpoint_set_iterator	Iterator over the point elements of a point_set
Cpoint_syntax_element	Enumeration class: the element of source code statement from which a point was generated
Cpoint_syntax_kind	Enumeration class: the syntax kind associated with a program point (point), indicating the kind of source code statement from which the point was generated
Cprocedure	A single procedure/function/method
Cprocedure_adjusted_callers_iterator	An iterator over the direct and indirect call sites (point of kind point_kind::CALL_SITE or point_kind::INDIRECT_CALL) whose target is a particular procedure, taking into account any translations incurred by csonar_replace_*() calls and the FUNCTION_MAP configuration file variable
Cprocedure_call_sites_flags	Flag class: specifies call site types
Cprocedure_call_sites_iterator	Iterator over the call sites (point of kind point_kind::CALL_SITE) in a procedure
Cprocedure_callers_iterator	Iterator over the call sites (point of kind point_kind::CALL_SITE) whose target is a particular procedure
Cprocedure_kind	Enumeration class: the "kind" of a procedure
Cprocedure_locals_iterator	Iterator over the local variables (symbol) that are declared in a procedure
Cprocedure_metricclass	A procedure granularity metric class
Cprocedure_metricclass_iterator	Iterator over the procedure-granularity metric classes (procedure_metricclass) managed by a procedure_metricclass_manager
Cprocedure_metricclass_manager	Manages the procedure granularity metric classes (procedure_metricclass) associated with an analysis
Cproject	A CodeSonar or CodeSurfer project
Cproject_compunits_iterator	Iterator over all the compilation units (compunit) in a project
Cproject_metricclass	A project granularity metric class
Cproject_metricclass_iterator	Iterator over the project-granularity metric classes (project_metricclass) managed by a project_metricclass_manager
Cproject_metricclass_manager	Manages the project granularity metric classes (project_metricclass) associated with an analysis
Cproject_procedures_iterator	Iterator over all the procedures (procedure) in a project
Cproject_root_directories_iterator	Iterator over the set of root directories(directory) in a project (deduced by inspecting all source file paths in the project)
Cproject_sfiles_iterator	Iterator over all the source files (sfile) in a project
Creport_flags	Flag class used by a number of warningclass report() and report_return_warning() methods
Cresult	The result of an API operation
Crpc_handler	Handles remote procedure calls (RPCs)
Cset_kind	Enumeration class: the kind of a set
Csfile	A source file
Csfile_instance_iterator	Iterator over the instances (sfileinst) of a source file (sfile)
Csfile_metricclass	A sfile granularity metric class
Csfile_metricclass_iterator	Iterator over the sfile-granularity metric classes (sfile_metricclass) managed by a sfile_metricclass_manager
Csfile_metricclass_manager	Manages the sfile granularity metric classes (sfile_metricclass) associated with an analysis
Csfileinst	A source file instance
Csfileinst_children_iterator	Iterator over the include-tree children (sfileinst) of a source file instance
Csfileinst_color_map_iterator	Iterator over the spans (position_range) of a specific syntax_kind within a source file instance (sfileinst)
Csfileinst_range	A range of (contiguous) locations in a single source file instance
Cstep_path	Used by the warningclass report() and report_return_warnings() methods that report a warning with a step path, and by step visitors (step_state), as added with analysis::add_step_bottom_up_visitor()
Cstep_state	Abstract base class for step visitors, as added with analysis::add_step_bottom_up_visitor(): subclass to define your own step visitors
Cstep_xform	A program state transform along a path in the CFG
Cstring_pair	A pair of strings
Csymbol	A function or variable
Csymbol_kind	Enumeration class: the kind of a symbol
Csymbol_set	A set of symbols (symbol)
Csymbol_set_iterator	Iterator over the symbol elements of a symbol_set
Csymbol_universe_iterator	Iterator over all the symbols (symbol) in a project
Csyntax_kind	Enumeration class: the kind of a span within a source file instance (sfileinst)
Csysinfo	Information about the local system
Cvar_attrs	Flag class: describes the attributes of a symbol of any kind EXCEPT symbol_kind::FUNCTION
Cvisitor	Abstract base class for visitors: functors that carry out actions on elements of the internal representation (IR) at various stages of the analysis
Cwarning	A warning instance
Cwarning_retraction_info	Describes the cases in which a warning instance should be retracted
Cwarning_significance	Enumeration class describing the significance setting for a warning class
Cwarningclass	A warning class
Cwarningclass_flags	Flag class: describes properties of a warningclass
Cxform_expr	Specifies parts of a query expression for step_xform::query() or step_xform::query_bounds()
Cxform_expr_mode	Enumeration class: the evaluation mode for an xform_expr
Cxform_operator	Enumeration class: an operator that can be used in a transform query with step_xform::query()
Cxform_query_bounds_result	The return type of step_xform::query_bounds()
Cxform_query_result	Enumeration class: the possible outcomes of a transform query with step_xform::query()
Cxr_def_iter_flags	Flag class: properties for an xr_definition_iterator
Cxr_definition_iterator	Iterator over the definitions (xr_tuple) of a token
Cxr_file_query	A collection of filters used to restrict a xr_query
Cxr_homonym_iterator	Iterator over the homonyms (xr_tuple) of a token
Cxr_intra_definition_iterator	Iterator over the definitions (xr_tuple) of a token
Cxr_kind	Enumeration class: describes the kind of a (non-keyword) token
Cxr_kind_role	Enumeration class: describes a valid token kind-role (kind-usage) pair
Cxr_occ_iter_flags	Flag class: properties for xr_occurrence_iterator and xr_homonym_iterator iterators
Cxr_occurrence_iterator	Iterator over the occurrences (xr_tuple) of a token
Cxr_query	Fully specifies a cross-referencing query over the tokens in an analyzed project
Cxr_query_flags	Flag class: additional properties for an xr_query
Cxr_query_iterator	Iterator over the results (xr_tuple) of an xr_query
Cxr_role	Enumeration class: describes the role that a token is playing at a particular occurrence of that token
Cxr_tuple	Describes an occurrence of a token in a particular kind-role and the definition corresponding to that occurrence
Cxr_tuple_comparator	Abstract base class for xref_tuple comparators: functors that specify an ordering on the results (xr_tuple) of an xr_query
Cxtype_render_style	Flag class for selecting type rendering styles