Up  

Class type Printer_api.extensible_printer_type

class type extensible_printer_type = object .. end
The class type that a printer must implement.
val mutable logic_printer_enabled : bool
Local logical annotation (function specifications and code annotations are printed only if logic_printer_enabled is set to true.
val mutable force_brace : bool
If set to true (default is false, some additional braces are printed.
val mutable verbose : bool
more info is displayed when on verbose mode. This flag is synchronized with Frama-C's kernel being on debug mode.
val mutable is_ghost : bool
are we printing ghost code?
method reset : unit -> unit
method private current_function : Cil_types.varinfo option
Returns the varinfo corresponding to the function being printed
method private current_behavior : Cil_types.funbehavior option
Returns the funbehavior being pretty-printed.
method private has_annot : bool
true if current_stmt has some annotations attached to it.
method private current_stmt : Cil_types.stmt option
Returns the stmt being printed
method private may_be_skipped : Cil_types.stmt -> bool
This is called to check that a given statement may be compacted with another one. For example this is called whenever a while(1) followed by a conditional if (cond) break; may be compacted into while (cond).
method private require_braces : ?has_annot:bool -> Cil_types.block -> bool
Returns true if the given block must be enclosed in a block. has_annot indicates if the stmt corresponding to the block may have annotations (default is true).
Change in Fluorine-20130401: optional arguments has been modified.
method private inline_block : ?has_annot:bool -> Cil_types.block -> bool
Returns true if the given block may be inlined in a single line. has_annot indicates if the stmt corresponding to the block may have annotations (default is true).
Change in Fluorine-20130401: optional arguments has been modified.
method private get_instr_terminator : unit -> string
What terminator to print after an instruction. sometimes we want to print sequences of instructions separated by comma
method private set_instr_terminator : string -> unit
method private opt_funspec : Format.formatter -> Cil_types.funspec -> unit
method location : Format.formatter -> Cil_types.location -> unit
method constant : Format.formatter -> Cil_types.constant -> unit
method varname : Format.formatter -> string -> unit
Invoked each time an identifier name is to be printed. Allows for various manipulation of the name, such as unmangling.
method vdecl : Format.formatter -> Cil_types.varinfo -> unit
Invoked for each variable declaration. Note that variable declarations are all the GVar, GVarDecl, GFun, GFunDecl, all the varinfo in formals of function types, and the formals and locals for function definitions.
method varinfo : Format.formatter -> Cil_types.varinfo -> unit
Invoked on each variable use.
method lval : Format.formatter -> Cil_types.lval -> unit
Invoked on each lvalue occurence
method field : Format.formatter -> Cil_types.fieldinfo -> unit
method offset : Format.formatter -> Cil_types.offset -> unit
Invoked on each offset occurence. The second argument is the base.
method global : Format.formatter -> Cil_types.global -> unit
Global (vars, types, etc.). This can be slow.
method fieldinfo : Format.formatter -> Cil_types.fieldinfo -> unit
A field declaration
method storage : Format.formatter -> Cil_types.storage -> unit
method ikind : Format.formatter -> Cil_types.ikind -> unit
method fkind : Format.formatter -> Cil_types.fkind -> unit
method typ : ?fundecl:Cil_types.varinfo ->
       (Format.formatter -> unit) option ->
       Format.formatter -> Cil_types.typ -> unit
Use of some type in some declaration. fundecl is the name of the function which is declared with the corresponding type. The second argument is used to print the declared element, or is None if we are just printing a type with no name being declared. If fundecl is not None, second argument must also have a value.
method attrparam : Format.formatter -> Cil_types.attrparam -> unit
Attribute paramter
method attribute : Format.formatter -> Cil_types.attribute -> bool
Attribute. Also return an indication whether this attribute must be printed inside the __attribute__ list or not.
method attributes : Format.formatter -> Cil_types.attributes -> unit
Attribute lists
method label : Format.formatter -> Cil_types.label -> unit
Label
method line_directive : ?forcefile:bool -> Format.formatter -> Cil_types.location -> unit
Print a line-number. This is assumed to come always on an empty line. If the forcefile argument is present and is true then the file name will be printed always. Otherwise the file name is printed only if it is different from the last time this function is called. The last file name is stored in a private field inside the cilPrinter object.
method stmt_labels : Format.formatter -> Cil_types.stmt -> unit
Print only the labels of the statement. Used by annotated_stmt.
method annotated_stmt : Cil_types.stmt -> Format.formatter -> Cil_types.stmt -> unit
Print an annotated statement. The code to be printed is given in the last Cil_types.stmt argument. The initial Cil_types.stmt argument records the statement which follows the one being printed.
method stmtkind : Cil_types.stmt -> Format.formatter -> Cil_types.stmtkind -> unit
Print a statement kind. The code to be printed is given in the Cil_types.stmtkind argument. The initial Cil_types.stmt argument records the statement which follows the one being printed; defaultCilPrinterClass uses this information to prettify statement printing in certain special cases. The boolean flag indicated whether the statement has labels (which have already been printed)
method instr : Format.formatter -> Cil_types.instr -> unit
Invoked on each instruction occurrence.
method stmt : Format.formatter -> Cil_types.stmt -> unit
Control-flow statement. annot is true iff the printer prints the annotations of the stmt.
method next_stmt : Cil_types.stmt -> Format.formatter -> Cil_types.stmt -> unit
method block : ?braces:bool -> Format.formatter -> Cil_types.block -> unit
Prints a block. Enclose the block braces '{' and '}' according to the optional argument. If it is not set, braces are put only when required.
Change in Fluorine-20130401: optional arguments has been modified.
method exp : Format.formatter -> Cil_types.exp -> unit
Print expressions
method unop : Format.formatter -> Cil_types.unop -> unit
method binop : Format.formatter -> Cil_types.binop -> unit
method init : Format.formatter -> Cil_types.init -> unit
Print initializers. This can be slow.
method file : Format.formatter -> Cil_types.file -> unit
method logic_constant : Format.formatter -> Cil_types.logic_constant -> unit
method logic_type : (Format.formatter -> unit) option ->
       Format.formatter -> Cil_types.logic_type -> unit
method logic_type_def : Format.formatter -> Cil_types.logic_type_def -> unit
method model_info : Format.formatter -> Cil_types.model_info -> unit
method term_binop : Format.formatter -> Cil_types.binop -> unit
method relation : Format.formatter -> Cil_types.relation -> unit
method identified_term : Format.formatter -> Cil_types.identified_term -> unit
method term : Format.formatter -> Cil_types.term -> unit
method term_node : Format.formatter -> Cil_types.term -> unit
method term_lval : Format.formatter -> Cil_types.term_lval -> unit
method model_field : Format.formatter -> Cil_types.model_info -> unit
method term_offset : Format.formatter -> Cil_types.term_offset -> unit
method logic_label : Format.formatter -> Cil_types.logic_label -> unit
method logic_info : Format.formatter -> Cil_types.logic_info -> unit
method logic_var : Format.formatter -> Cil_types.logic_var -> unit
method quantifiers : Format.formatter -> Cil_types.quantifiers -> unit
method predicate : Format.formatter -> Cil_types.predicate -> unit
method predicate_named : Format.formatter -> Cil_types.predicate Cil_types.named -> unit
method identified_predicate : Format.formatter -> Cil_types.identified_predicate -> unit
method behavior : Format.formatter -> Cil_types.funbehavior -> unit
method requires : Format.formatter -> Cil_types.identified_predicate -> unit
method complete_behaviors : Format.formatter -> string list -> unit
method disjoint_behaviors : Format.formatter -> string list -> unit
method terminates : Format.formatter -> Cil_types.identified_predicate -> unit
method post_cond : Format.formatter ->
       Cil_types.termination_kind * Cil_types.identified_predicate -> unit
pretty prints a post condition according to the exit kind it represents
Change in Boron-20100401: replaces pEnsures
method assumes : Format.formatter -> Cil_types.identified_predicate -> unit
method funspec : Format.formatter -> Cil_types.funspec -> unit
method assigns : string ->
       Format.formatter -> Cil_types.identified_term Cil_types.assigns -> unit
first parameter is the introducing keyword (e.g. loop_assigns or assigns).
method allocation : isloop:bool ->
       Format.formatter -> Cil_types.identified_term Cil_types.allocation -> unit
first parameter is the introducing keyword (e.g. loop_allocates, loop_frees, allocates or free)
Since Oxygen-20120901.
method from : string ->
       Format.formatter -> Cil_types.identified_term Cil_types.from -> unit
prints an assignment with its dependencies.
method code_annotation : Format.formatter -> Cil_types.code_annotation -> unit
method global_annotation : Format.formatter -> Cil_types.global_annotation -> unit
method decreases : Format.formatter -> Cil_types.term Cil_types.variant -> unit
method variant : Format.formatter -> Cil_types.term Cil_types.variant -> unit
method pp_keyword : Format.formatter -> string -> unit

Modifying pretty-printer behavior

All C99 keywords except types "char", "int", "long", "signed", "short", "unsigned", "void" and "_XXX" (like "_Bool") *

method pp_acsl_keyword : Format.formatter -> string -> unit
All ACSL keywords except logic types
method pp_open_annotation : ?block:bool -> ?pre:Pretty_utils.sformat -> Format.formatter -> unit
method pp_close_annotation : ?block:bool -> ?suf:Pretty_utils.sformat -> Format.formatter -> unit
Called before/after printing an annotation comment. Put the annotation in a block according to the optional argument. If it is not set, the annotation is put in a block. *
method without_annot : 'a. (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a -> unit
self#without_annot printer fmt x pretty prints x by using printer, without pretty-printing its function contracts and code annotations.
method force_brace : 'a. (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a -> unit
self#force_brace printer fmt x pretty prints x by using printer, but add some extra braces '{' and '}' which are hidden by default.