pghs975uc
/
infer_clone
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[typ] prefer pretty printing to string building

Browse Source 
Summary:
My spidey senses were tingling. Next diff uses the `pp` functions
everywhere it was kind of obvious how to change the code to do so. It
doesn't improve perf but is less clowny that way. It might lessen memory
pressure since allocating strings is expensive and this code was doing a
lot of it.

Reviewed By: ngorogiannis

Differential Revision: D17450324

fbshipit-source-id: 632cee584
master
Jules Villard 5 years ago committed by Facebook Github Bot
parent a01639e098
commit 088b083d87
1 changed files with 143 additions and 119 deletions
Show Stats Download Patch File Download Diff File

262
infer/src/IR/Typ.ml
Unescape View File

@ -626,31 +626,33 @@ module Procname = struct
(** A type is a pair (package, type_name) that is translated in a string package.type_name *) (** A type is a pair (package, type_name) that is translated in a string package.type_name *)
let type_to_string_verbosity p verbosity = let pp_type_verbosity verbosity fmt p =
match p with match p with
| {package= Some package; type_name} when is_verbose verbosity -> | {package= Some package; type_name} when is_verbose verbosity ->
package ^ "." ^ type_name F.fprintf fmt "%s.%s" package type_name
| {type_name} -> | {type_name} ->
type_name F.pp_print_string fmt type_name
(** Given a list of types, it creates a unique string of types separated by commas *) (** Given a list of types, it creates a unique string of types separated by commas *)
let rec param_list_to_string inputList verbosity = let rec pp_param_list verbosity fmt inputList =
match inputList with match inputList with
| [] -> | [] ->
"" ()
| [head] -> | [head] ->
type_to_string_verbosity head verbosity pp_type_verbosity verbosity fmt head
| head :: rest -> | head :: rest ->
type_to_string_verbosity head verbosity ^ "," ^ param_list_to_string rest verbosity pp_type_verbosity verbosity fmt head ;
F.pp_print_string fmt "," ;
pp_param_list verbosity fmt rest
let java_type_of_name class_name = Name.Java.Split.of_string (Name.name class_name) let java_type_of_name class_name = Name.Java.Split.of_string (Name.name class_name)
(** It is the same as java_type_to_string_verbosity, but Java return types are optional because (** It is the same as java_type_to_string_verbosity, but Java return types are optional because
of constructors without type *) of constructors without type *)
let return_type_to_string j verbosity = let pp_return_type verbosity fmt j =
match j.return_type with None -> "" | Some typ -> type_to_string_verbosity typ verbosity match j.return_type with None -> () | Some typ -> pp_type_verbosity verbosity fmt typ
let get_class_name j = Name.name j.class_name let get_class_name j = Name.name j.class_name
@ -669,21 +671,17 @@ module Procname = struct
let replace_return_type ret_type j = {j with return_type= Some ret_type} let replace_return_type ret_type j = {j with return_type= Some ret_type}
let get_return_type j = return_type_to_string j Verbose
let get_parameters j = j.parameters let get_parameters j = j.parameters
(** Prints a string of a java procname with the given level of verbosity *) (** Prints a string of a java procname with the given level of verbosity *)
let to_string ?(withclass = false) j verbosity = let pp ?(withclass = false) verbosity fmt j =
match verbosity with match verbosity with
| Verbose | Non_verbose -> | Verbose | Non_verbose ->
(* if verbose, then package.class.method(params): rtype, (* if verbose, then package.class.method(params): rtype,
else rtype package.class.method(params) else rtype package.class.method(params)
verbose is used for example to create unique filenames, non_verbose to create reports *) verbose is used for example to create unique filenames, non_verbose to create reports *)
let return_type = return_type_to_string j verbosity in let pp_class_name verbosity fmt j =
let params = param_list_to_string j.parameters verbosity in pp_type_verbosity verbosity fmt (Name.Java.split_typename j.class_name)
let class_name =
type_to_string_verbosity (Name.Java.split_typename j.class_name) verbosity
in in
let separator = let separator =
match (j.return_type, verbosity) with match (j.return_type, verbosity) with
@ -694,22 +692,26 @@ module Procname = struct
| _ -> | _ ->
" " " "
in in
let output = class_name ^ "." ^ j.method_name ^ "(" ^ params ^ ")" in if not (equal_detail_level verbosity Verbose) then
if equal_detail_level verbosity Verbose then output ^ separator ^ return_type F.fprintf fmt "%a%s" (pp_return_type verbosity) j separator ;
else return_type ^ separator ^ output F.fprintf fmt "%a.%s(%a)" (pp_class_name verbosity) j j.method_name
(pp_param_list verbosity) j.parameters ;
if equal_detail_level verbosity Verbose then
F.fprintf fmt "%s%a" separator (pp_return_type verbosity) j
| Simple -> | Simple ->
(* methodname(...) or without ... if there are no parameters *) (* methodname(...) or without ... if there are no parameters *)
let cls_prefix = let pp_class_prefix ~withclass verbosity fmt j =
if withclass then if withclass then
type_to_string_verbosity (Name.Java.split_typename j.class_name) verbosity ^ "." F.fprintf fmt "%a." (pp_type_verbosity verbosity)
else "" (Name.Java.split_typename j.class_name)
in in
let params = match j.parameters with [] -> "" | _ -> "..." in let params = match j.parameters with [] -> "" | _ -> "..." in
let method_name = let pp_method_name ~withclass verbosity fmt j =
if String.equal j.method_name "<init>" then get_simple_class_name j if String.equal j.method_name "<init>" then
else cls_prefix ^ j.method_name F.pp_print_string fmt (get_simple_class_name j)
else F.fprintf fmt "%a%s" (pp_class_prefix ~withclass verbosity) j j.method_name
in in
method_name ^ "(" ^ params ^ ")" F.fprintf fmt "%a(%s)" (pp_method_name ~withclass verbosity) j params
let get_return_typ pname_java = let get_return_typ pname_java =
@ -738,7 +740,7 @@ module Procname = struct
| typ_str -> | typ_str ->
mk (Tstruct (Name.Java.from_string typ_str)) mk (Tstruct (Name.Java.from_string typ_str))
in in
let typ = java_from_string (get_return_type pname_java) in let typ = java_from_string (F.asprintf "%a" (pp_return_type Verbose) pname_java) in
match typ.desc with Tstruct _ -> mk (Tptr (typ, Pk_pointer)) | _ -> typ match typ.desc with Tstruct _ -> mk (Tptr (typ, Pk_pointer)) | _ -> typ
@ -808,11 +810,25 @@ module Procname = struct
match typ.T.desc with T.Tptr ({desc= Tstruct name}, Pk_pointer) -> Some name | _ -> None match typ.T.desc with T.Tptr ({desc= Tstruct name}, Pk_pointer) -> Some name | _ -> None
let parameters_to_string parameters = let pp_parameters fmt parameters =
let string_pars = if List.exists ~f:Option.is_some parameters then
List.filter_map ~f:(fun name_opt -> Option.map ~f:Name.to_string name_opt) parameters (* the tests rely on the fact that we discard non-pointer-to-struct types for some reason,
in hence the slight re-implementation of [Pp.seq] to avoid building the list of [Some] items
if List.is_empty string_pars then "" else "(" ^ String.concat ~sep:"," string_pars ^ ")" explicitly *)
let rec pp_parameters_aux fmt = function
| [] ->
()
| [Some param] ->
F.pp_print_string fmt (Name.to_string param)
| None :: parameters ->
pp_parameters_aux fmt parameters
| (Some _ as param_some) :: None :: parameters ->
pp_parameters_aux fmt (param_some :: parameters)
| Some param :: (Some _ :: _ as parameters) ->
F.fprintf fmt "%s," (Name.to_string param) ;
pp_parameters_aux fmt parameters
in
F.fprintf fmt "(%a)" pp_parameters_aux parameters
let clang_param_of_name class_name : clang_parameter = Some class_name let clang_param_of_name class_name : clang_parameter = Some class_name
@ -883,32 +899,30 @@ module Procname = struct
let is_operator_equal {method_name} = String.is_substring ~substring:"operator=" method_name let is_operator_equal {method_name} = String.is_substring ~substring:"operator=" method_name
let kind_to_verbose_string = function let pp_verbose_kind fmt = function
| CPPMethod {mangled} | CPPDestructor {mangled} -> | CPPMethod {mangled} | CPPDestructor {mangled} ->
"(" ^ Option.value ~default:"" mangled ^ ")" F.fprintf fmt "(%s)" (Option.value ~default:"" mangled)
| CPPConstructor {mangled; is_constexpr} -> | CPPConstructor {mangled; is_constexpr} ->
"{" ^ Option.value ~default:"" mangled F.fprintf fmt "{%s%s}"
^ (if is_constexpr then "|constexpr" else "") (Option.value ~default:"" mangled)
^ "}" (if is_constexpr then "|constexpr" else "")
| ObjCClassMethod -> | ObjCClassMethod ->
"class" F.pp_print_string fmt "class"
| ObjCInstanceMethod -> | ObjCInstanceMethod ->
"instance" F.pp_print_string fmt "instance"
| ObjCInternalMethod -> | ObjCInternalMethod ->
"internal" F.pp_print_string fmt "internal"
let to_string osig detail_level = let pp verbosity fmt osig =
match detail_level with match verbosity with
| Simple -> | Simple ->
osig.method_name F.pp_print_string fmt osig.method_name
| Non_verbose -> | Non_verbose ->
Name.name osig.class_name ^ "::" ^ osig.method_name F.fprintf fmt "%s::%s" (Name.name osig.class_name) osig.method_name
| Verbose -> | Verbose ->
let m_str = kind_to_verbose_string osig.kind in F.fprintf fmt "%s::%s%a%a" (Name.name osig.class_name) osig.method_name
Name.name osig.class_name ^ "::" ^ osig.method_name Parameter.pp_parameters osig.parameters pp_verbose_kind osig.kind
^ Parameter.parameters_to_string osig.parameters
^ m_str
let get_parameters osig = osig.parameters let get_parameters osig = osig.parameters
@ -936,20 +950,16 @@ module Procname = struct
; template_args= NoTemplate } ; template_args= NoTemplate }
(** to_string for C_function type *) let pp verbosity fmt {name; mangled; parameters} =
let to_string {name; mangled; parameters} verbose =
let plain = QualifiedCppName.to_qual_string name in let plain = QualifiedCppName.to_qual_string name in
match verbose with match verbosity with
| Simple -> | Simple ->
plain ^ "()" F.fprintf fmt "%s()" plain
| Non_verbose -> | Non_verbose ->
plain F.pp_print_string fmt plain
| Verbose -> ( | Verbose ->
match mangled with let pp_mangled fmt = function None -> () | Some s -> F.fprintf fmt "{%s}" s in
| None -> F.fprintf fmt "%s%a%a" plain Parameter.pp_parameters parameters pp_mangled mangled
plain ^ Parameter.parameters_to_string parameters
| Some s ->
plain ^ Parameter.parameters_to_string parameters ^ "{" ^ s ^ "}" )
let get_parameters c = c.parameters let get_parameters c = c.parameters
@ -965,14 +975,14 @@ module Procname = struct
let make name parameters = {name; parameters} let make name parameters = {name; parameters}
let to_string bsig detail_level = let pp verbosity fmt bsig =
match detail_level with match verbosity with
| Simple -> | Simple ->
"block" F.pp_print_string fmt "block"
| Non_verbose -> | Non_verbose ->
bsig.name F.pp_print_string fmt bsig.name
| Verbose -> | Verbose ->
bsig.name ^ Parameter.parameters_to_string bsig.parameters F.fprintf fmt "%s%a" bsig.name Parameter.pp_parameters bsig.parameters
let get_parameters block = block.parameters let get_parameters block = block.parameters
@ -1144,79 +1154,94 @@ module Procname = struct
None None
let with_blocks_parameters_to_string base blocks to_string_f =
let base_id = to_string_f base in
String.concat ~sep:"_" (base_id :: blocks)
(** Very verbose representation of an existing Procname.t *) (** Very verbose representation of an existing Procname.t *)
let rec to_unique_id pn = let rec pp_unique_id fmt = function
match pn with
| Java j -> | Java j ->
Java.to_string j Verbose Java.pp Verbose fmt j
| C osig -> | C osig ->
C.to_string osig Verbose C.pp Verbose fmt osig
| ObjC_Cpp osig -> | ObjC_Cpp osig ->
ObjC_Cpp.to_string osig Verbose ObjC_Cpp.pp Verbose fmt osig
| Block bsig -> | Block bsig ->
Block.to_string bsig Verbose Block.pp Verbose fmt bsig
| WithBlockParameters (base, blocks) -> | WithBlockParameters (base, []) ->
with_blocks_parameters_to_string base blocks to_unique_id pp_unique_id fmt base
| WithBlockParameters (base, (_ :: _ as blocks)) ->
pp_unique_id fmt base ;
F.pp_print_string fmt "_" ;
Pp.seq ~sep:"_" F.pp_print_string fmt blocks
| Linters_dummy_method -> | Linters_dummy_method ->
"Linters_dummy_method" F.pp_print_string fmt "Linters_dummy_method"
let to_unique_id proc_name = F.asprintf "%a" pp_unique_id proc_name
(** Convert a proc name to a string for the user to see *) (** Convert a proc name to a string for the user to see *)
let rec to_string p = let rec pp fmt = function
match p with
| Java j -> | Java j ->
Java.to_string j Non_verbose Java.pp Non_verbose fmt j
| C osig -> | C osig ->
C.to_string osig Non_verbose C.pp Non_verbose fmt osig
| ObjC_Cpp osig -> | ObjC_Cpp osig ->
ObjC_Cpp.to_string osig Non_verbose ObjC_Cpp.pp Non_verbose fmt osig
| Block bsig -> | Block bsig ->
Block.to_string bsig Non_verbose Block.pp Non_verbose fmt bsig
| WithBlockParameters (base, blocks) -> | WithBlockParameters (base, []) ->
with_blocks_parameters_to_string base blocks to_string pp fmt base
| WithBlockParameters (base, (_ :: _ as blocks)) ->
pp fmt base ;
F.pp_print_string fmt "_" ;
Pp.seq ~sep:"_" F.pp_print_string fmt blocks
| Linters_dummy_method -> | Linters_dummy_method ->
to_unique_id p pp_unique_id fmt Linters_dummy_method
let to_string proc_name = F.asprintf "%a" pp proc_name
(** Convenient representation of a procname for external tools (e.g. eclipse plugin) *) (** Convenient representation of a procname for external tools (e.g. eclipse plugin) *)
let rec to_simplified_string ?(withclass = false) p = let rec pp_simplified_string ?(withclass = false) fmt = function
match p with
| Java j -> | Java j ->
Java.to_string ~withclass j Simple Java.pp ~withclass Simple fmt j
| C osig -> | C osig ->
C.to_string osig Simple C.pp Simple fmt osig
| ObjC_Cpp osig -> | ObjC_Cpp osig ->
ObjC_Cpp.to_string osig Simple ObjC_Cpp.pp Simple fmt osig
| Block bsig -> | Block bsig ->
Block.to_string bsig Simple Block.pp Simple fmt bsig
| WithBlockParameters (base, _) -> | WithBlockParameters (base, _) ->
to_simplified_string base pp_simplified_string fmt base
| Linters_dummy_method -> | Linters_dummy_method ->
to_unique_id p pp_unique_id fmt Linters_dummy_method
let to_simplified_string ?withclass proc_name =
F.asprintf "%a" (pp_simplified_string ?withclass) proc_name
let from_string_c_fun func = C (C.from_string func) let from_string_c_fun func = C (C.from_string func)
let hashable_name p = let java_inner_class_prefix_regex = Str.regexp "\\$[0-9]+"
match p with
| Java pname -> let hashable_name proc_name =
match proc_name with
| Java pname -> (
(* Strip autogenerated anonymous inner class numbers in order to keep the bug hash (* Strip autogenerated anonymous inner class numbers in order to keep the bug hash
invariant when introducing new anonymous classes *) invariant when introducing new anonymous classes *)
Str.global_replace (Str.regexp "\\$[0-9]+") "$_" let name = F.asprintf "%a" (Java.pp ~withclass:true Simple) pname in
(Java.to_string ~withclass:true pname Simple) match Str.search_forward java_inner_class_prefix_regex name 0 with
| _ ->
Str.global_replace java_inner_class_prefix_regex "$_" name
| exception Caml.Not_found ->
name )
| ObjC_Cpp m when ObjC_Cpp.is_objc_method m -> | ObjC_Cpp m when ObjC_Cpp.is_objc_method m ->
(* In Objective C, the list of parameters is part of the method name. To prevent the bug (* In Objective C, the list of parameters is part of the method name. To prevent the bug
hash to change when a parameter is introduced or removed, only the part of the name hash to change when a parameter is introduced or removed, only the part of the name
before the first colon is used for the bug hash *) before the first colon is used for the bug hash *)
List.hd_exn (String.split_on_chars (to_simplified_string ~withclass:true p) ~on:[':']) let name = F.asprintf "%a" (pp_simplified_string ~withclass:true) proc_name in
List.hd_exn (String.split_on_chars name ~on:[':'])
| _ -> | _ ->
(* Other cases for C and C++ method names *) (* Other cases for C and C++ method names *)
to_simplified_string ~withclass:true p F.asprintf "%a" (pp_simplified_string ~withclass:true) proc_name
let rec get_parameters procname = let rec get_parameters procname =
@ -1284,9 +1309,6 @@ module Procname = struct
Parameter.ClangParameter (Parameter.clang_param_of_name class_name) Parameter.ClangParameter (Parameter.clang_param_of_name class_name)
(** Pretty print a proc name *)
let pp f pn = F.pp_print_string f (to_string pn)
let describe f pn = let describe f pn =
let name = hashable_name pn in let name = hashable_name pn in
match String.lsplit2 ~on:'<' name with match String.lsplit2 ~on:'<' name with
@ -1334,30 +1356,32 @@ module Procname = struct
(** Convert a proc name to a filename *) (** Convert a proc name to a filename *)
let to_concrete_filename ?crc_only pname = let to_filename ?crc_only pname =
(* filenames for clang procs are REVERSED qualifiers with '#' as separator *) (* filenames for clang procs are REVERSED qualifiers with '#' as separator *)
let get_qual_name_str pname = let pp_rev_qualified fmt pname =
get_qualifiers pname |> QualifiedCppName.to_rev_list |> String.concat ~sep:"#" let rev_qualifiers = get_qualifiers pname |> QualifiedCppName.to_rev_list in
Pp.seq ~sep:"#" F.pp_print_string fmt rev_qualifiers
in in
let proc_id = let proc_id =
match pname with match pname with
| C {parameters; mangled} -> | C {parameters; mangled} ->
(get_qual_name_str pname ^ Parameter.parameters_to_string parameters) let pp_mangled fmt = function
:: Option.to_list mangled | None ->
|> String.concat ~sep:"#" ()
| Some mangled ->
F.fprintf fmt "#%s" mangled
in
F.asprintf "%a%a%a" pp_rev_qualified pname Parameter.pp_parameters parameters pp_mangled
mangled
| ObjC_Cpp objc_cpp -> | ObjC_Cpp objc_cpp ->
get_qual_name_str pname F.asprintf "%a%a#%a" pp_rev_qualified pname Parameter.pp_parameters objc_cpp.parameters
^ Parameter.parameters_to_string objc_cpp.parameters ObjC_Cpp.pp_verbose_kind objc_cpp.kind
^ "#"
^ ObjC_Cpp.kind_to_verbose_string objc_cpp.kind
| _ -> | _ ->
to_unique_id pname F.asprintf "%a" pp_unique_id pname
in in
Escape.escape_filename @@ DB.append_crc_cutoff ?crc_only proc_id Escape.escape_filename @@ DB.append_crc_cutoff ?crc_only proc_id
let to_filename ?crc_only pname = to_concrete_filename ?crc_only pname
module SQLite = struct module SQLite = struct
module T = struct module T = struct
type nonrec t = t type nonrec t = t
@ -1366,7 +1390,7 @@ module Procname = struct
let hash = hash let hash = hash
let sexp_of_t p = Sexp.Atom (to_string p) let sexp_of_t p = Sexp.Atom (F.asprintf "%a" pp p)
end end
module Serializer = SqliteUtils.MarshalledDataForComparison (T) module Serializer = SqliteUtils.MarshalledDataForComparison (T)

Write Preview
Loading…
Cancel
Save