Class type Cil.cilVisitor

class type cilVisitor = object .. end

A visitor interface for traversing CIL trees. Create instantiations of this type by specializing the class Cil.nopCilVisitor. Each of the specialized visiting functions can also call the queueInstr to specify that some instructions should be inserted before the current instruction or statement. Use syntax like self#queueInstr to call a method associated with the current object.

Important Note for Frama-C Users: Unless you really know what you are doing, you should probably inherit from the Visitor.generic_frama_c_visitor instead of Cil.genericCilVisitor or Cil.nopCilVisitor
Consult the Plugin Development Guide for additional details.

method behavior : visitor_behavior

the kind of behavior expected for the behavior.
Consult the Plugin Development Guide for additional details.

method project : Project.t option

Project the visitor operates on. Non-nil for copy visitor.
Since Oxygen-20120901

method plain_copy_visitor : cilVisitor

a visitor who only does copies of the nodes according to behavior

method vfile : Cil_types.file -> Cil_types.file visitAction

visit a whole file.
Consult the Plugin Development Guide for additional details.

method vvdec : Cil_types.varinfo -> Cil_types.varinfo visitAction

Invoked for each variable declaration. The children to be traversed are those corresponding to the type and attributes of the variable. Note that variable declarations are GVar, GVarDecl, GFun and GFunDecl globals, the formals of functions prototypes, and the formals and locals of function definitions. This means that the list of formals of a function may be traversed multiple times if there exists both a declaration and a definition, or multiple declarations.
Consult the Plugin Development Guide for additional details.

method vvrbl : Cil_types.varinfo -> Cil_types.varinfo visitAction

Invoked on each variable use. Here only the SkipChildren and ChangeTo actions make sense since there are no subtrees. Note that the type and attributes of the variable are not traversed for a variable use.
Consult the Plugin Development Guide for additional details.

method vexpr : Cil_types.exp -> Cil_types.exp visitAction

Invoked on each expression occurrence. The subtrees are the subexpressions, the types (for a Cast or SizeOf expression) or the variable use.
Consult the Plugin Development Guide for additional details.

method vlval : Cil_types.lval -> Cil_types.lval visitAction

Invoked on each lvalue occurrence

method voffs : Cil_types.offset -> Cil_types.offset visitAction

Invoked on each offset occurrence that is *not* as part of an initializer list specification, i.e. in an lval or recursively inside an offset.
Consult the Plugin Development Guide for additional details.

method vinitoffs : Cil_types.offset -> Cil_types.offset visitAction

Invoked on each offset appearing in the list of a CompoundInit initializer.

method vinst : Cil_types.instr -> Cil_types.instr list visitAction

Invoked on each instruction occurrence. The ChangeTo action can replace this instruction with a list of instructions

method vstmt : Cil_types.stmt -> Cil_types.stmt visitAction

Control-flow statement. The default DoChildren action does not create a new statement when the components change. Instead it updates the contents of the original statement. This is done to preserve the sharing with Goto and Case statements that point to the original statement. If you use the ChangeTo action then you should take care of preserving that sharing yourself.
Consult the Plugin Development Guide for additional details.

method vblock : Cil_types.block -> Cil_types.block visitAction

Block.

method vfunc : Cil_types.fundec -> Cil_types.fundec visitAction

Function definition. Replaced in place.

method vglob : Cil_types.global -> Cil_types.global list visitAction

Global (vars, types, etc.)
Consult the Plugin Development Guide for additional details.

method vinit : Cil_types.varinfo ->
       Cil_types.offset -> Cil_types.init -> Cil_types.init visitAction

Initializers for globals, pass the global where this occurs, and the offset

method vtype : Cil_types.typ -> Cil_types.typ visitAction

Use of some type. For typedef, struct, union and enum, the visit is done once at the global defining the type. Thus, children of TComp, TEnum and TNamed are not visited again.

method vcompinfo : Cil_types.compinfo -> Cil_types.compinfo visitAction

declaration of a struct/union

method venuminfo : Cil_types.enuminfo -> Cil_types.enuminfo visitAction

declaration of an enumeration

method vfieldinfo : Cil_types.fieldinfo -> Cil_types.fieldinfo visitAction

visit the declaration of a field of a structure or union

method venumitem : Cil_types.enumitem -> Cil_types.enumitem visitAction

visit the declaration of an enumeration item

method vattr : Cil_types.attribute -> Cil_types.attribute list visitAction

Attribute. Each attribute can be replaced by a list

method vattrparam : Cil_types.attrparam -> Cil_types.attrparam visitAction

Attribute parameters.

method queueInstr : Cil_types.instr list -> unit

Add here instructions while visiting to queue them to preceede the current statement or instruction being processed. Use this method only when you are visiting an expression that is inside a function body, or a statement, because otherwise there will no place for the visitor to place your instructions.

method unqueueInstr : unit -> Cil_types.instr list

Gets the queue of instructions and resets the queue. This is done automatically for you when you visit statments.

method current_stmt : Cil_types.stmt option

link to the current statement being visited.

NB: for copy visitor, the stmt is the original one (use get_stmt to obtain the corresponding copy)

method current_kinstr : Cil_types.kinstr

Kstmt stmt when visiting statement stmt, Kglobal when called outside of a statement.
Since Carbon-20101201
Consult the Plugin Development Guide for additional details.

method push_stmt : Cil_types.stmt -> unit

method pop_stmt : Cil_types.stmt -> unit

method current_func : Cil_types.fundec option

link to the current function being visited.

NB: for copy visitors, the fundec is the original one.

method set_current_func : Cil_types.fundec -> unit

method reset_current_func : unit -> unit

method vlogic_type : Cil_types.logic_type -> Cil_types.logic_type visitAction

method vmodel_info : Cil_types.model_info -> Cil_types.model_info visitAction

method videntified_term : Cil_types.identified_term -> Cil_types.identified_term visitAction

method vterm : Cil_types.term -> Cil_types.term visitAction

method vterm_node : Cil_types.term_node -> Cil_types.term_node visitAction

method vterm_lval : Cil_types.term_lval -> Cil_types.term_lval visitAction

method vterm_lhost : Cil_types.term_lhost -> Cil_types.term_lhost visitAction

method vterm_offset : Cil_types.term_offset -> Cil_types.term_offset visitAction

method vlogic_label : Cil_types.logic_label -> Cil_types.logic_label visitAction

method vlogic_info_decl : Cil_types.logic_info -> Cil_types.logic_info visitAction