Added documentation to cPredicate.mli

Reviewed By: dulmarod

Differential Revision: D7567708

fbshipit-source-id: 0b93c14

infer/src/clang/cPredicates.ml

@@ -229,7 +229,7 @@ let is_objc_extension lcxt =
   CGeneral_utils.is_objc_extension lcxt.CLintersContext.translation_unit_context
 
 
-let is_syntactically_global_var an =
+let is_global_var an =
   match an with Ctl_parser_types.Decl d -> CAst_utils.is_syntactically_global_var d | _ -> false
 
 

infer/src/clang/cPredicates.mli

@@ -11,85 +11,123 @@ open! IStd
 
 type t = ALVar.formula_id * ALVar.alexp list [@@deriving compare]
 
-(* (name, [param1,...,paramK]) *)
+(** (name, [param1,...,paramK]) *)
 
 val captured_variables_cxx_ref : Ctl_parser_types.ast_node -> Clang_ast_t.named_decl_info list
+(** list of cxx references captured by an ObjC Block *)
 
 val call_method : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'call_method an m an' is true iff node an is a call to an ObjC method with name containing string m *)
 
 val call_class_method : Ctl_parser_types.ast_node -> ALVar.alexp -> ALVar.alexp -> bool
+(** 'call_class_method an cname mname' is true iff node an is a call to an ObjC method of class cname 
+and the name of the method contains mname *)
 
 val call_instance_method : Ctl_parser_types.ast_node -> ALVar.alexp -> ALVar.alexp -> bool
+(** 'call_instance_method an cname mname' is true iff  an is a node calling an ObjC method of an 
+   object of class cname and the method name  contains mname
+*)
 
 val declaration_name : Clang_ast_t.decl -> string option
+(** 'declaration_name d' returns the name of declaration d *)
 
 val is_enum_constant : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'is_enum_constant an name' is true iff an is an EnumConstant with name containing 'name' *)
 
 val is_enum_constant_of_enum : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
 
 val is_objc_interface_named : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'is_objc_interface_named an expected_name' is true iff an is an objc interface with name expected_name *)
 
 val is_objc_extension : CLintersContext.context -> bool
 
-val is_syntactically_global_var : Ctl_parser_types.ast_node -> bool
+val is_global_var : Ctl_parser_types.ast_node -> bool
+(** 'is_global_var an' is true iff an is a global variable (but not a static local) *)
 
 val is_const_expr_var : Ctl_parser_types.ast_node -> bool
+(** 'is_const_expr_var an' is true iff an is a 'const' variable declaration *)
 
 val call_function : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'call_function an name' is true iff an is a call to a function whose name contains 'name' *)
 
 val is_strong_property : Ctl_parser_types.ast_node -> bool
+(** 'is_strong_property an' is true iff an denotes a objc property declaration with 'strong' attribute *)
 
 val is_strong_ivar : Ctl_parser_types.ast_node -> bool
+(** 'is_strong_ivar an' is true iff an denotes a objc ivar with 'strong' attribute *)
 
 val is_weak_property : Ctl_parser_types.ast_node -> bool
+(** 'is_weak_property an' is true iff an denotes a objc property declaration with 'weak' attribute *)
 
 val is_assign_property : Ctl_parser_types.ast_node -> bool
+(** 'is_assign_property an' is true iff an denotes a objc property declaration with 'assign' attribute *)
 
 val is_property_pointer_type : Ctl_parser_types.ast_node -> bool
+(** 'is_property_pointer_type an' is true iff an denotes a objc property declaration with type pointer *)
 
 val context_in_synchronized_block : CLintersContext.context -> bool
+(** true if the current node is in the context of a synchronized objc block *)
 
 val is_ivar_atomic : Ctl_parser_types.ast_node -> bool
+(** 'is_ivar_atomic an' is true iff an denotes an atomi objc ivar *)
 
 val is_method_property_accessor_of_ivar :
   Ctl_parser_types.ast_node -> CLintersContext.context -> bool
 
 val is_in_block : CLintersContext.context -> bool
+(** true if the current node is in the context of an objc block *)
 
 val is_in_cxx_constructor : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_cxx_constructor context name' is true if the curent node is within a CXX constructor whose name contains 'name' *)
 
 val is_in_cxx_destructor : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_destructor_constructor context name' is true if the curent node is within a CXX destructor whose name contains 'name' *)
 
 val is_in_cxx_method : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_cxx_method context name' is true if the curent node is within a CXX method whose name contains 'name' *)
 
 val is_in_function : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_function context name' is true if the curent node is within a function whose name contains 'name' *)
 
 val is_in_objc_method : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_objc_method context name' is true if the curent node is within an ObjC method whose name contains 'name' *)
 
 val is_objc_constructor : CLintersContext.context -> bool
+(** 'is_in_objc_constructor context' is true if the curent node is within an ObjC constructor *)
 
 val is_objc_dealloc : CLintersContext.context -> bool
+(** 'is_in_objc_dealloc context' is true if the curent node is within an ObjC dealloc method *)
 
 val is_in_objc_subclass_of : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_objc_subclass_of context cname' is true if the current node is within the context of a subclass of class cname*)
 
 val is_in_objc_class_named : CLintersContext.context -> ALVar.alexp -> bool
+(** 'is_in_objc_class_named context cname' is true if the current node is within the context of a of class cname*)
 
 val captures_cxx_references : Ctl_parser_types.ast_node -> bool
+(** 'captures_cxx_references an' is true iff the node an captures some CXX references *)
 
 val is_binop_with_kind : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'is_binop_with_kind an binop' is true iff an denotes a binary operator of kind binop *)
 
 val is_unop_with_kind : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'is_unop_of_kind an unop' is true iff an denotes a unary operator of kind unop *)
 
 val has_cast_kind : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'has_cast_kind an cast' is true iff an denotes a cast operation of kind cast *)
 
 val isa : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(**  node an is of class classname *)
 
 val is_node : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'is_node an nodename' is true iff an is a node of kind nodename *)
 
 val declaration_has_name : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
 
 val declaration_ref_name :
   ?kind:Clang_ast_t.decl_kind -> Ctl_parser_types.ast_node -> ALVar.alexp -> bool
+(** 'declaration_ref_has_name an n' is true iff node an is a DeclRefExpr with name containing string n. The optional parameter kind 
+allow to distinguish between special kind of decl_ref_exprs like 'is_enum_constant'. *)
 
 val is_class : Ctl_parser_types.ast_node -> ALVar.alexp -> bool
 
@@ -138,6 +176,7 @@ val within_available_class_block : CLintersContext.context -> Ctl_parser_types.a
 val has_type_const_ptr_to_objc_class : Ctl_parser_types.ast_node -> bool
 
 val is_decl : Ctl_parser_types.ast_node -> bool
+(** is_decl an is true iff an is a node denoting a declaration *)
 
 val get_ast_node_type_ptr : Ctl_parser_types.ast_node -> Clang_ast_t.type_ptr option
 

infer/src/clang/cTL.ml

@@ -1005,7 +1005,7 @@ let rec eval_Atomic pred_name_ args an lcxt =
   | "is_enum_constant_of_enum", [name], an ->
       CPredicates.is_enum_constant_of_enum an name
   | "is_global_var", [], an ->
-      CPredicates.is_syntactically_global_var an
+      CPredicates.is_global_var an
   | "is_in_block", [], _ ->
       CPredicates.is_in_block lcxt
   | "is_in_cxx_constructor", [name], _ ->