Module IR.ProcAttributes

type access =
| Default
| Public
| Private
| Protected

Visibility modifiers.

val compare_access : access -> access -> int
val equal_access : access -> access -> bool
type objc_accessor_type =
| Objc_getter of Struct.field
| Objc_setter of Struct.field
type var_data = {
name : Mangled.t;
typ : Typ.t;
modify_in_block : bool;

__block attribute of Objective-C variables, means that it will be modified inside a block

is_constexpr : bool;
is_declared_unused : bool;

variable declared with attribute unused

}
type specialized_with_blocks_info = {
orig_proc : Procname.t;
formals_to_procs_and_new_formals : (Procname.t * (Mangled.t * Typ.t) list) IR.Mangled.Map.t;
}
val compare_specialized_with_blocks_info : specialized_with_blocks_info -> specialized_with_blocks_info -> int
type t = {
access : access;

visibility access

captured : CapturedVar.t list;

name, type, and mode of variables captured in blocks and lambdas

exceptions : string list;

exceptions thrown by the procedure

formals : (Mangled.t * Typ.t) list;

name and type of formal parameters

const_formals : int list;

list of indices of formals that are const-qualified

is_abstract : bool;

the procedure is abstract

is_biabduction_model : bool;

the procedure is a model for the biabduction analysis

is_bridge_method : bool;

the procedure is a bridge method

is_defined : bool;

true if the procedure is defined, and not just declared

is_java_synchronized_method : bool;

the procedure is a Java synchronized method

passed_as_noescape_block_to : Procname.t option;

Present if the procedure is an Objective-C block that has been passed to the given method in a position annotated with the NS_NOESCAPE attribute.

is_no_return : bool;

the procedure is known not to return

is_objc_arc_on : bool;

the ObjC procedure is compiled with ARC

is_specialized : bool;

the procedure is a clone specialized for dynamic dispatch handling

is_synthetic_method : bool;

the procedure is a synthetic method

is_variadic : bool;

the procedure is variadic, only supported for Clang procedures

sentinel_attr : (int * int) option;

__attribute__((sentinel(int, int)))

specialized_with_blocks_info : specialized_with_blocks_info option;

the procedure is a clone specialized with calls to concrete closures, with link to the original procedure, and a map that links the original formals to the elements of the closure used to specialize the procedure.

clang_method_kind : ClangMethodKind.t;

the kind of method the procedure is

loc : IBase.Location.t;

location of this procedure in the source code

translation_unit : IBase.SourceFile.t;

source file where the procedure was captured

mutable locals : var_data list;

name, type and attributes of local variables

method_annotation : Annot.Method.t;

annotations for all methods

objc_accessor : objc_accessor_type option;

type of ObjC accessor, if any

proc_name : Procname.t;

name of the procedure

ret_type : Typ.t;

return type

has_added_return_param : bool;

whether or not a return param was added

is_ret_type_pod : bool;

whether or not the return type is POD

is_ret_constexpr : bool;

whether the (C++) function or method is declared as constexpr

}
val default : IBase.SourceFile.t -> Procname.t -> t

Create a proc_attributes with default values.

val pp : Stdlib.Format.formatter -> t -> unit
val get_access : t -> access

Return the visibility attribute

val get_formals : t -> (Mangled.t * Typ.t) list

Return name and type of formal parameters

val get_annotated_formals : t -> ((Mangled.t * Typ.t) * Annot.Item.t) list
val get_loc : t -> IBase.Location.t

Return loc information for the procedure

val get_proc_name : t -> Procname.t
module SQLite : IBase.SqliteUtils.Data with type t = t