Abstract base class for visitors: functors that carry out actions on elements of the internal representation (IR) at various stages of the analysis. More...

Public Types
typedef T	visitee
	The type of IR element to which the visitor is applied. More...

Public Member Functions
	visitor ()
	Constructor.

	visitor (const visitor &)
	Copy constructor.

virtual void	operator() (T)=0
	For each IR element of type T that is visited, CodeSonar will invoke this function on the element. More...

Detailed Description

template<typename T> class cs::visitor< T >

Abstract base class for visitors: functors that carry out actions on elements of the internal representation (IR) at various stages of the analysis.

Template Parameters

T	The IR element type of interest. Must be one of the following: project compunit, sfileinst (covers both sfile and sfileinst visitors) procedure point symbol

The C++ API Getting Started page includes a visitor<point> usage example.

The CodeSonar Plug-In API Tutorial and AST Tutorial provide annotated example plug-ins involving various visitor types, along with installation and testing instructions.

To define a visitor class for IR elements of type T, subclass visitor<T> and define operator() to perform the actions you want the visitor to undertake for each element of type T in the internal representation.

Once you have defined your visitor class, create an instance and add it to the analysis with a suitable analysis::add_*_visitor() invocation. The analysis::add_*_visitor() method you use will depend on the visitor type and the phase in which you want to apply the visitor as shown in the following table.

visitor<project>	analysis::add_project_drop_visitor() analysis::add_project_drop_finish_visitor() analysis::add_project_visitor() analysis::add_project_finish_visitor() analysis::add_project_parallel_visitor() analysis::add_project_parallel_finish_visitor() analysis::add_project_bottom_up_visitor() analysis::add_project_bottom_up_finish_visitor() analysis::add_cache_cleanup_visitor()
visitor<compunit>	analysis::add_compunit_drop_visitor() analysis::add_compunit_visitor() analysis::add_compunit_finish_visitor() analysis::add_compunit_parallel_visitor() analysis::add_compunit_parallel_finish_visitor()
visitor<sfileinst>	analysis::add_sfile_visitor() analysis::add_sfile_finish_visitor() analysis::add_sfileinst_visitor() analysis::add_sfileinst_finish_visitor()
visitor<procedure>	analysis::add_procedure_drop_visitor() analysis::add_procedure_visitor() analysis::add_procedure_finish_visitor() analysis::add_procedure_parallel_visitor() analysis::add_procedure_parallel_finish_visitor() analysis::add_procedure_bottom_up_visitor() analysis::add_procedure_bottom_up_finish_visitor()
visitor<point>	analysis::add_point_visitor() analysis::add_point_parallel_visitor() analysis::add_point_bottom_up_visitor()
visitor<symbol>	analysis::add_global_symbol_drop_visitor() (globals only) analysis::add_symbol_visitor() analysis::add_symbol_parallel_visitor()

(Note that step visitors are defined by step_state objects rather than visitor<T> ones.)

Once you have passed a visitor object to one of these add_*_visitor() methods, do not subsequently delete it. CodeSonar may continue to use it indefinitely.

Unlike visitors of other types, program visitors are not applied during the analysis traversals but at various points before and after traversals. For details, see Visitors: Program Visitors.

Member Typedef Documentation

◆ visitee

template<typename T >

typedef T cs::visitor< T >::visitee

The type of IR element to which the visitor is applied.

Member Function Documentation

◆ operator()()

template<typename T >

virtual void cs::visitor< T >::operator() ( T )

pure virtual

For each IR element of type T that is visited, CodeSonar will invoke this function on the element.

When you subclass visitor<T> to create a visitor class, provide a definition for this. (If you don't, the visitor won't do anything!)

The analysis phase in which the visit occurs depends on the method used to add the visitor: see the table of methods above.

The documentation for this class was generated from the following files: