pghs975uc
/
infer_clone
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0c7249b992'
${ noResults }
infer_clone/infer/src/nullsafe/modelTables.ml

663 lines
30 KiB
Raw Normal View History Unescape

Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
(*
[copyright] Remove years Reviewed By: jvillard Differential Revision: D15771884 fbshipit-source-id: e2997e3a3
6 years ago
* Copyright (c) Facebook, Inc. and its affiliates.
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
*
Change license to MIT Summary: Change the license of the source code from BSD + PATENTS to MIT. Change `checkCopyright` to reflect the new license and learn some new file types. Generated with: ``` git grep BSD | xargs -n 1 ./scripts/checkCopyright -i ``` Reviewed By: jeremydubreil, mbouaziz, jberdine Differential Revision: D8071249 fbshipit-source-id: 97ca23a
7 years ago
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
*)
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
Divide Utils into Utils, Pp, and IStd Summary: Utils contains definitions intended to be in the global namespace for all of the infer code-base, as well as pretty-printing functions, and assorted utility functions mostly for dealing with files and processes. This diff changes the module opened into the global namespace to IStd (Std conflict with extlib), and moves the pretty-printing definitions from Utils to Pp. Reviewed By: jvillard Differential Revision: D4232457 fbshipit-source-id: 1e070e0
8 years ago
open! IStd
Open Core.Std by default, still use Caml Hashtbl, Map, Set Reviewed By: cristianoc Differential Revision: D4232458 fbshipit-source-id: 3d73c69
8 years ago
module Hashtbl = Caml.Hashtbl
Remove -open(Utils) compile flag hack Summary:public Eliminate the use of the -open Utils command line option passed to the compiler in favor of `open! Utils` in each source file. While slightly convenient, this option causes more headaches than it is worth with other tools e.g. merlin. Reviewed By: jvillard Differential Revision: D3168193 fb-gh-sync-id: 4285ef6 fbshipit-source-id: 4285ef6
9 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
(*
* This file is a big bunch of tables; they read better with really long lines.
* @nolint
*)
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(* the type should be treated as Nonnull *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
let o = false
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(* the type should be treated as Nullable *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
and n = true
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(* create signature where both return type and params are nonnull *)
let all_nonnull num_params = (o, List.init num_params ~f:(fun _ -> o))
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(* o<N> means signature with N nonnull params and nonnull return type *)
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o1 = all_nonnull 1
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o2 = all_nonnull 2
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o3 = all_nonnull 3
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o4 = all_nonnull 4
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o5 = all_nonnull 5
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o6 = all_nonnull 6
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o7 = all_nonnull 7
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o8 = all_nonnull 8
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o9 = all_nonnull 9
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o10 = all_nonnull 10
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o11 = all_nonnull 11
[nullsafe][android] warn when passing null to ImmutableList, ImmutableSet, and ImmutableMap Reviewed By: jeremydubreil Differential Revision: D13933976 fbshipit-source-id: 771fc985c
6 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let o12 = all_nonnull 12
(* n<N> stands for signature with nonnull return type and N nullable params *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
let n1 = (o, [n])
let n2 = (o, [n; n])
let n3 = (o, [n; n; n])
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(* the second argument is nullable, everything else is nonnull *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
let on = (o, [o; n])
[infer][eradicate] fix the position of the comments in the list of models Summary: The position of the comments was wrong. Reviewed By: sblackshear Differential Revision: D6127793 fbshipit-source-id: 415660a
7 years ago
(* container add *)
[nullsafe] consistent models for the scrict containers Reviewed By: mbouaziz Differential Revision: D13977297 fbshipit-source-id: a32be3431
6 years ago
let ca = if Config.nullsafe_strict_containers then (o, [o]) else (o, [n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[infer][eradicate] fix the position of the comments in the list of models Summary: The position of the comments was wrong. Reviewed By: sblackshear Differential Revision: D6127793 fbshipit-source-id: 415660a
7 years ago
(* container get *)
[nullsafe] consistent models for the scrict containers Reviewed By: mbouaziz Differential Revision: D13977297 fbshipit-source-id: a32be3431
6 years ago
let cg = if Config.nullsafe_strict_containers then (n, [o]) else (n, [n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[infer][eradicate] fix the position of the comments in the list of models Summary: The position of the comments was wrong. Reviewed By: sblackshear Differential Revision: D6127793 fbshipit-source-id: 415660a
7 years ago
(* container put *)
[nullsafe] consistent models for the scrict containers Reviewed By: mbouaziz Differential Revision: D13977297 fbshipit-source-id: a32be3431
6 years ago
let cp = if Config.nullsafe_strict_containers then (n, [o; o]) else (n, [n; n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
Eradicate: model get and remove as nullable for stdlib Map variants Reviewed By: jeremydubreil Differential Revision: D6083471 fbshipit-source-id: 08c133b
7 years ago
(* container remove *)
[nullsafe] consistent models for the scrict containers Reviewed By: mbouaziz Differential Revision: D13977297 fbshipit-source-id: a32be3431
6 years ago
let cr = if Config.nullsafe_strict_containers then (n, [o]) else (n, [n])
Eradicate: model get and remove as nullable for stdlib Map variants Reviewed By: jeremydubreil Differential Revision: D6083471 fbshipit-source-id: 08c133b
7 years ago
[infer][eradicate] fix the position of the comments in the list of models Summary: The position of the comments was wrong. Reviewed By: sblackshear Differential Revision: D6127793 fbshipit-source-id: 415660a
7 years ago
(* nullable getter *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
let ng = (n, [])
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_not_null_parameter_list, check_not_null_list =
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
(* The first integer in the tuple is the index (counting from 1) of the argument to be asserted.
Commonly it is 1.
*)
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let list =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[ ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.facebook.common.internal.Preconditions.checkNotNull(java.lang.Object,java.lang.Object):java.lang.Object"
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n; n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.facebook.common.internal.Preconditions.checkNotNull(java.lang.Object,java.lang.String,java.lang.Object[]):java.lang.Object"
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.facebook.common.internal.Preconditions.checkNotNull(java.lang.Object):java.lang.Object"
)
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n])
[nullsafe][EASY] correct the signature for Preconditions.checkNotNull() Summary: The one with Object as the second param is in `com.facebook.common.internal`. The one with String as the second param is in `com.facebook.common.preconditions`. (Don't ask :) ) Reviewed By: artempyanykh Differential Revision: D19087334 fbshipit-source-id: ba02c9101
5 years ago
, "com.facebook.common.preconditions.Preconditions.checkNotNull(java.lang.Object,java.lang.String):java.lang.Object"
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n; n])
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
, "com.facebook.common.preconditions.Preconditions.checkNotNull(java.lang.Object,java.lang.String,java.lang.Object[]):java.lang.Object"
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n])
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
, "com.facebook.common.preconditions.Preconditions.checkNotNull(java.lang.Object):java.lang.Object"
)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.google.common.base.Preconditions.checkNotNull(java.lang.Object,java.lang.Object):java.lang.Object"
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n; n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.google.common.base.Preconditions.checkNotNull(java.lang.Object,java.lang.String,java.lang.Object[]):java.lang.Object"
)
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n])
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
, "com.google.common.base.Preconditions.checkNotNull(java.lang.Object):java.lang.Object" )
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
; (1, (o, [n]), "com.google.common.base.Verify.verifyNotNull(java.lang.Object):java.lang.Object")
[eradicate] add model for com.google.common.base.Verify.verifyNotNull Reviewed By: ezgicicek Differential Revision: D13726750 fbshipit-source-id: 446ce1130
6 years ago
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n; n])
[eradicate] add model for com.google.common.base.Verify.verifyNotNull Reviewed By: ezgicicek Differential Revision: D13726750 fbshipit-source-id: 446ce1130
6 years ago
, "com.google.common.base.Verify.verifyNotNull(java.lang.Object,java.lang.String,java.lang.Object[]):java.lang.Object"
)
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
; (1, (o, [n]), "org.junit.Assert.assertNotNull(java.lang.Object):void")
; ( 2
, (* a non-traditional method - the second parameter is the object to be asserted, the first is the description *)
(o, [n; n])
, "org.junit.Assert.assertNotNull(java.lang.String,java.lang.Object):void" )
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
; ( 1
, (o, [n])
, "com.facebook.infer.annotation.Assertions.assertNotNull(java.lang.Object):java.lang.Object"
)
; ( 1
, (o, [n; o])
, "com.facebook.infer.annotation.Assertions.assertNotNull(java.lang.Object,java.lang.String):java.lang.Object"
)
; ( 1
, (o, [n])
, "com.facebook.infer.annotation.Assertions.assumeNotNull(java.lang.Object):java.lang.Object"
)
; ( 1
, (o, [n; o])
, "com.facebook.infer.annotation.Assertions.assumeNotNull(java.lang.Object,java.lang.String):java.lang.Object"
[nullsafe] Add androidx.core.util.Preconditions.checkNotNull models Summary: We already have a number of `[pkg].Preconditions.checkNotNull` modelled, but the one from `androidx` is missing yet widely used. Reviewed By: mityal Differential Revision: D18748550 fbshipit-source-id: 83d3317ae
5 years ago
)
[nullsafe] Add `nullsafe_FIXME` method to suppress nullability issues. Summary: This will help adoption of non-transitive strictification modes. The main use-case we are aiming with this function is: - During strictification, a method is made nullable, but it is not feasible to fix all callers straight away. Suppressing nullsafe with an appropriate task or comment will make it easier to unblock the strictification and move forward. Reviewed By: artempyanykh Differential Revision: D19599098 fbshipit-source-id: 3769bbd3d
5 years ago
; ( 1
, (o, [n; o])
, "com.facebook.infer.annotation.Assertions.nullsafeFIXME(java.lang.Object,java.lang.String):java.lang.Object"
)
[nullsafe] Add androidx.core.util.Preconditions.checkNotNull models Summary: We already have a number of `[pkg].Preconditions.checkNotNull` modelled, but the one from `androidx` is missing yet widely used. Reviewed By: mityal Differential Revision: D18748550 fbshipit-source-id: 83d3317ae
5 years ago
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n])
[nullsafe] Add androidx.core.util.Preconditions.checkNotNull models Summary: We already have a number of `[pkg].Preconditions.checkNotNull` modelled, but the one from `androidx` is missing yet widely used. Reviewed By: mityal Differential Revision: D18748550 fbshipit-source-id: 83d3317ae
5 years ago
, "androidx.core.util.Preconditions.checkNotNull(java.lang.Object):java.lang.Object" )
; ( 1
[nullsafe] Documentation and minor code cleanup around models for `checkNotNull` Summary: 1. I can not imagine a useful usecase for strict node, lets not complicate the code. 2. Add docs. Reviewed By: artempyanykh Differential Revision: D19599091 fbshipit-source-id: 1d37a717f
5 years ago
, (o, [n; n])
[nullsafe] Add androidx.core.util.Preconditions.checkNotNull models Summary: We already have a number of `[pkg].Preconditions.checkNotNull` modelled, but the one from `androidx` is missing yet widely used. Reviewed By: mityal Differential Revision: D18748550 fbshipit-source-id: 83d3317ae
5 years ago
, "androidx.core.util.Preconditions.checkNotNull(java.lang.Object,java.lang.Object):java.lang.Object"
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
) ]
in
(List.map ~f:(fun (x, _, z) -> (x, z)) list, List.map ~f:(fun (_, y, z) -> (y, z)) list)
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_state_list =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[ ((o, [n]), "Preconditions.checkState(boolean):void")
; ((o, [n]), "com.facebook.common.internal.Preconditions.checkState(boolean):void")
; ( (o, [n; n])
, "com.facebook.common.internal.Preconditions.checkState(boolean,java.lang.Object):void" )
; ( (o, [n; n; n])
, "com.facebook.common.internal.Preconditions.checkState(boolean,java.lang.String,java.lang.Object[]):void"
)
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
; ((o, [n]), "com.facebook.common.preconditions.Preconditions.checkState(boolean):void")
; ( (o, [n; n])
, "com.facebook.common.preconditions.Preconditions.checkState(boolean,java.lang.Object):void" )
; ( (o, [n; n; n])
, "com.facebook.common.preconditions.Preconditions.checkState(boolean,java.lang.String,java.lang.Object[]):void"
)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
; ((o, [n]), "com.google.common.base.Preconditions.checkState(boolean):void")
; ((o, [n; n]), "com.google.common.base.Preconditions.checkState(boolean,java.lang.Object):void")
; ( (o, [n; n; n])
, "com.google.common.base.Preconditions.checkState(boolean,java.lang.String,java.lang.Object[]):void"
)
; ((o, [n]), "com.facebook.infer.annotation.Assertions.assertCondition(boolean):void")
; ( (o, [n; o])
, "com.facebook.infer.annotation.Assertions.assertCondition(boolean,java.lang.String):void" )
; ((o, [n]), "com.facebook.infer.annotation.Assertions.assumeCondition(boolean):void")
; ( (o, [n; o])
[ocamlformat] Upgrade ocamlformat version Reviewed By: jvillard Differential Revision: D18162727 fbshipit-source-id: ffb9f7541
5 years ago
, "com.facebook.infer.annotation.Assertions.assumeCondition(boolean,java.lang.String):void" ) ]
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_argument_list =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[ ((o, [n]), "com.facebook.common.internal.Preconditions.checkArgument(boolean):void")
; ( (o, [n; n])
, "com.facebook.common.internal.Preconditions.checkArgument(boolean,java.lang.Object):void" )
; ( (o, [n; n; n])
, "com.facebook.common.internal.Preconditions.checkArgument(boolean,java.lang.String,java.lang.Object[]):void"
)
[nullsafe] Model com.facebook.common.Preconditions Reviewed By: artempyanykh Differential Revision: D18910582 fbshipit-source-id: 045367759
5 years ago
; ((o, [n]), "com.facebook.common.preconditions.Preconditions.checkArgument(boolean):void")
; ( (o, [n; n])
, "com.facebook.common.preconditions.Preconditions.checkArgument(boolean,java.lang.Object):void"
)
; ( (o, [n; n; n])
, "com.facebook.common.preconditions.Preconditions.checkArgument(boolean,java.lang.String,java.lang.Object[]):void"
)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
; ((o, [n]), "com.google.common.base.Preconditions.checkArgument(boolean):void")
; ( (o, [n; n])
, "com.google.common.base.Preconditions.checkArgument(boolean,java.lang.Object):void" )
; ( (o, [n; n; n])
, "com.google.common.base.Preconditions.checkArgument(boolean,java.lang.String,java.lang.Object[]):void"
) ]
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
(** Models for boolean functions that return true on null. *)
[nullsafe][EASY] functions that are modelled as @TrueOnNull should be also modelled for nullability. Summary: If we managed to whitelist a function as TrueOnNull, we should teach nullsafe the nullability of its arguments, otherwise it will ask not to pass null here. This fixes a silly FP warning, see the test. Reviewed By: dulmarod Differential Revision: D19770341 fbshipit-source-id: 0f861fae1
5 years ago
let true_on_null_list =
[eradicate] model com.google.common.base.Strings.isNullOrEmpty(...) Reviewed By: sblackshear Differential Revision: D7526376 fbshipit-source-id: da60808
7 years ago
[ (n1, "android.text.TextUtils.isEmpty(java.lang.CharSequence):boolean")
; (n1, "com.google.common.base.Strings.isNullOrEmpty(java.lang.String):boolean") ]
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
(** Models for Map.containsKey *)
let containsKey_list =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[ (n1, "com.google.common.collect.ImmutableMap.containsKey(java.lang.Object):boolean")
; (n1, "java.util.Map.containsKey(java.lang.Object):boolean") ]
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
Model Map.put() alongside Map.containsKey(). Summary: public Added special modelling for m.put(k,v) as assigning value v to map m at key k. The modelling is analogous to the one for containsKey: the variable used to represent m.get(k) is generated, and assigned the value v. Reviewed By: jberdine Differential Revision: D2743844 fb-gh-sync-id: 56d3581
9 years ago
(** Models for Map.put *)
let mapPut_list =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[ ( cp
, "com.google.common.collect.ImmutableMap.put(java.lang.Object,java.lang.Object):java.lang.Object"
)
; (cp, "java.util.Map.put(java.lang.Object,java.lang.Object):java.lang.Object") ]
Model Map.put() alongside Map.containsKey(). Summary: public Added special modelling for m.put(k,v) as assigning value v to map m at key k. The modelling is analogous to the one for containsKey: the variable used to represent m.get(k) is generated, and assigned the value v. Reviewed By: jberdine Differential Revision: D2743844 fb-gh-sync-id: 56d3581
9 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
[nullsafe] Error reporting: recommend non-nullable alternarives for known nullable methods Summary: This will help making error reporting more actionable. Often methods that are nullable in general (like View.findViewById) are used as not-nullable due to app-invariants. In such cases suggesting a non-nullable alternative that does an assertion under the hood makes the error report more actionable and provides necessary guidance with respect to coding best practices Follow up will include adding more methods to models. If this goes well, we might support it in user-defined area (nullability repository) Reviewed By: artempyanykh Differential Revision: D20001416 fbshipit-source-id: 46f03467c
5 years ago
type nonnull_alternative_method = {package_name: string; class_name: string; method_name: string}
[build] Fix test build failure due to use of polymorphic compare Reviewed By: skcho Differential Revision: D20067724 fbshipit-source-id: f873cf937
5 years ago
(* Nullable methods that have non-nullable signatures.
[nullsafe] Error reporting: recommend non-nullable alternarives for known nullable methods Summary: This will help making error reporting more actionable. Often methods that are nullable in general (like View.findViewById) are used as not-nullable due to app-invariants. In such cases suggesting a non-nullable alternative that does an assertion under the hood makes the error report more actionable and provides necessary guidance with respect to coding best practices Follow up will include adding more methods to models. If this goes well, we might support it in user-defined area (nullability repository) Reviewed By: artempyanykh Differential Revision: D20001416 fbshipit-source-id: 46f03467c
5 years ago
Format is a triple: (<nullability>, <method>, <alternative>), *)
let nullable_methods_with_nonnull_alternatives_list =
[ ( (n, [o])
, "android.view.View.findViewById(int):android.view.View"
, {package_name= "android.view"; class_name= "View"; method_name= "requireViewById"} )
; ( (n, [o])
, "android.app.Activity.findViewById(int):android.view.View"
, {package_name= "android.app"; class_name= "Activity"; method_name= "requireViewById"} ) ]
let nullable_method_with_nonnull_alternatives_nullability_list =
let result =
List.map nullable_methods_with_nonnull_alternatives_list
~f:(fun (nullability, method_descr, _) -> (nullability, method_descr))
in
List.iter result ~f:(fun ((ret_nullability, _param_nullability), _) ->
[build] Fix test build failure due to use of polymorphic compare Reviewed By: skcho Differential Revision: D20067724 fbshipit-source-id: f873cf937
5 years ago
if not (Bool.equal ret_nullability n) then
[nullsafe] Error reporting: recommend non-nullable alternarives for known nullable methods Summary: This will help making error reporting more actionable. Often methods that are nullable in general (like View.findViewById) are used as not-nullable due to app-invariants. In such cases suggesting a non-nullable alternative that does an assertion under the hood makes the error report more actionable and provides necessary guidance with respect to coding best practices Follow up will include adding more methods to models. If this goes well, we might support it in user-defined area (nullability repository) Reviewed By: artempyanykh Differential Revision: D20001416 fbshipit-source-id: 46f03467c
5 years ago
Logging.die Logging.InternalError "Function is expected to be nullable" ) ;
result
(* Methods with signatures that are not special enough to be described in one of lists above *)
let annotated_list_nullability_other =
[ (o1, "android.text.SpannableString.valueOf(java.lang.CharSequence):android.text.SpannableString")
; (o1, "android.app.AlarmManager.cancel(android.app.PendingIntent):void")
; (o1, "android.net.Uri.parse(java.lang.String):android.net.Uri")
; (n1, "android.os.Parcel.writeList(java.util.List):void")
; (n2, "android.os.Parcel.writeParcelable(android.os.Parcelable,int):void")
; (n1, "android.os.Parcel.writeString(java.lang.String):void")
; ( (o, [o; o; n; n; n])
, "com.android.sdklib.build.ApkBuilder.<init>(java.io.File,java.io.File,java.io.File,java.lang.String,java.io.PrintStream)"
)
; ( (o, [n])
, "com.android.manifmerger.ManifestMerger.xmlFileAndLine(org.w3c.dom.Node):com.android.manifmerger.IMergerLog$FileAndLine"
)
; ( on
, "com.android.util.CommandLineParser$Mode.process(com.android.util.CommandLineParser$Arg,java.lang.String):java.lang.Object"
)
; ( on
, "com.google.common.base.Objects$ToStringHelper.add(java.lang.String,java.lang.Object):com.google.common.base.Objects$ToStringHelper"
)
; (n2, "com.google.common.base.Objects.equal(java.lang.Object,java.lang.Object):boolean")
; ( n1
, "com.google.common.base.Optional.fromNullable(java.lang.Object):com.google.common.base.Optional"
)
; ((n, []), "com.google.common.base.Optional.orNull():java.lang.Object")
; (n1, "com.google.common.base.Strings.nullToEmpty(java.lang.String):java.lang.String")
; (cg, "com.google.common.collect.ImmutableMap.get(java.lang.Object):java.lang.Object")
; (* container get *)
( o1
, "com.google.common.collect.ImmutableList$Builder.add(java.lang.Object):com.google.common.collect.ImmutableList$Builder"
)
; ( o1
, "com.google.common.collect.ImmutableList$Builder.addAll(java.lang.Iterable):com.google.common.collect.ImmutableList$Builder"
)
; ( o1
, "com.google.common.collect.ImmutableList.of(java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o2
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o3
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o4
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o5
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o6
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o7
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o8
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o9
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o10
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o11
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o12
, "com.google.common.collect.ImmutableList.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o1
, "com.google.common.collect.ImmutableList.copyOf(java.lang.Iterable):com.google.common.collect.ImmutableList"
)
; ( o1
, "com.google.common.collect.ImmutableList.copyOf(java.util.Collection):com.google.common.collect.ImmutableList"
)
; ( o1
, "com.google.common.collect.ImmutableList.copyOf(java.util.Iterator):com.google.common.collect.ImmutableList"
)
; ( o1
, "com.google.common.collect.ImmutableList.copyOf(java.lang.Object):com.google.common.collect.ImmutableList"
)
; ( o2
, "com.google.common.collect.ImmutableList.sortedCopyOf(java.util.Comparator,java.lang.Iterable):com.google.common.collect.ImmutableList"
)
; ( o1
, "com.google.common.collect.ImmutableSet.of(java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o2
, "com.google.common.collect.ImmutableSet.of(java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o3
, "com.google.common.collect.ImmutableSet.of(java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o4
, "com.google.common.collect.ImmutableSet.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o5
, "com.google.common.collect.ImmutableSet.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o1
, "com.google.common.collect.ImmutableSet.copyOf(java.lang.Iterable):com.google.common.collect.ImmutableSet"
)
; ( o1
, "com.google.common.collect.ImmutableSet.copyOf(java.util.Collection):com.google.common.collect.ImmutableSet"
)
; ( o1
, "com.google.common.collect.ImmutableSet.copyOf(java.util.Iterator):com.google.common.collect.ImmutableSet"
)
; ( o1
, "com.google.common.collect.ImmutableSet.copyOf(java.lang.Object):com.google.common.collect.ImmutableSet"
)
; ( o1
, "com.google.common.collect.ImmutableSortedSet$Builder.add(java.lang.Object):com.google.common.collect.ImmutableSortedSet$Builder"
)
; ( o2
, "com.google.common.collect.ImmutableMap.of(java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableMap"
)
; ( o4
, "com.google.common.collect.ImmutableMap.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableMap"
)
; ( o6
, "com.google.common.collect.ImmutableMap.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableMap"
)
; ( o8
, "com.google.common.collect.ImmutableMap.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableMap"
)
; ( o10
, "com.google.common.collect.ImmutableMap.of(java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object,java.lang.Object):com.google.common.collect.ImmutableMap"
)
; ( o1
, "com.google.common.collect.ImmutableMap.copyOf(java.util.Map):com.google.common.collect.ImmutableMap"
)
; ( o1
, "com.google.common.collect.ImmutableMap.copyOf(java.lang.Iterable):com.google.common.collect.ImmutableMap"
)
; ( on
, "com.google.common.collect.Iterables.getFirst(java.lang.Iterable,java.lang.Object):java.lang.Object"
)
; ( o1
, "com.google.common.util.concurrent.SettableFuture.setException(java.lang.Throwable):boolean"
)
; (o1, "java.io.File.<init>(java.lang.String)")
; (n1, "java.io.PrintStream.print(java.lang.String):void")
; ((n, [o]), "java.lang.Class.getResource(java.lang.String):java.net.URL")
; (o1, "java.lang.Class.isAssignableFrom(java.lang.Class):boolean")
; (n1, "java.lang.Integer.equals(java.lang.Object):boolean")
; (o1, "java.lang.Integer.parseInt(java.lang.String):int")
; (o1, "java.lang.Long.parseLong(java.lang.String):long")
; (n1, "java.lang.Object.equals(java.lang.Object):boolean")
; (n2, "java.lang.RuntimeException.<init>(java.lang.String,java.lang.Throwable)")
; (n1, "java.lang.String.equals(java.lang.Object):boolean")
; (n1, "java.lang.StringBuilder.append(java.lang.String):java.lang.StringBuilder")
; ((n, [o]), "java.lang.System.getProperty(java.lang.String):java.lang.String")
; ((n, [o]), "java.lang.System.getenv(java.lang.String):java.lang.String")
; ( on
, "java.net.URLClassLoader.newInstance(java.net.URL[],java.lang.ClassLoader):java.net.URLClassLoader"
)
; (ng, "java.nio.file.Path.getParent():java.nio.file.Path")
; (n1, "java.util.AbstractList.equals(java.lang.Object):boolean")
; (ca, "java.util.ArrayList.add(java.lang.Object):boolean")
; (ca, "java.util.List.add(java.lang.Object):boolean")
; (cg, "java.util.Map.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.Map.remove(java.lang.Object):java.lang.Object")
; (cp, "java.util.Map.put(java.lang.Object,java.lang.Object):java.lang.Object")
; (cg, "java.util.HashMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.HashMap.remove(java.lang.Object):java.lang.Object")
; (cp, "java.util.HashMap.put(java.lang.Object,java.lang.Object):java.lang.Object")
; (cg, "java.util.concurrent.ConcurrentHashMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.concurrent.ConcurrentHashMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.AbstractMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.AbstractMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.concurrent.ConcurrentSkipListMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.concurrent.ConcurrentSkipListMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.EnumMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.EnumMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.Hashtable.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.Hashtable.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.IdentityHashMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.IdentityHashMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.LinkedHashMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.LinkedHashMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.TreeMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.TreeMap.remove(java.lang.Object):java.lang.Object")
; (cg, "java.util.WeakHashMap.get(java.lang.Object):java.lang.Object")
; (cr, "java.util.WeakHashMap.remove(java.lang.Object):java.lang.Object")
; ( (n, [o])
, "javax.lang.model.element.Element.getAnnotation(java.lang.Class):java.lang.annotation.Annotation"
)
; (ng, "javax.lang.model.element.Element.getEnclosingElement():javax.lang.model.element.Element")
; ( ng
, "javax.lang.model.element.ExecutableElement.getDefaultValue():javax.lang.model.element.AnnotationValue"
)
; ( ng
, "javax.lang.model.element.PackageElement.getEnclosingElement():javax.lang.model.element.Element"
)
; (ng, "javax.lang.model.element.VariableElement.getConstantValue():java.lang.Object")
; (ng, "javax.lang.model.type.WildcardType.getSuperBound():javax.lang.model.type.TypeMirror")
; ( (n, [o])
, "javax.lang.model.util.Elements.getPackageElement(java.lang.CharSequence):javax.lang.model.element.PackageElement"
)
; ( (n, [o])
, "javax.lang.model.util.Elements.getTypeElement(java.lang.CharSequence):javax.lang.model.element.TypeElement"
)
; ( (n, [o])
, "javax.lang.model.util.Elements.getDocComment(javax.lang.model.element.Element):java.lang.String"
)
; ( o1
, "javax.lang.model.util.Elements.getElementValuesWithDefaults(javax.lang.model.element.AnnotationMirror):java.util.Map"
)
; (o1, "javax.lang.model.util.Elements.isDeprecated(javax.lang.model.element.Element):boolean")
; ( o1
, "javax.lang.model.util.Elements.getBinaryName(javax.lang.model.element.TypeElement):javax.lang.model.element.Name"
)
; ( o1
, "javax.lang.model.util.Elements.getPackageOf(javax.lang.model.element.Element):javax.lang.model.element.PackageElement"
)
; ( o1
, "javax.lang.model.util.Elements.getAllMembers(javax.lang.model.element.TypeElement):java.util.List"
)
; ( o1
, "javax.lang.model.util.Elements.getAllAnnotationMirrors(javax.lang.model.element.Element):java.util.List"
)
; ( o2
, "javax.lang.model.util.Elements.hides(javax.lang.model.element.Element, \
javax.lang.model.element.Element):boolean" )
; ( o3
, "javax.lang.model.util.Elements.overrides(javax.lang.model.element.ExecutableElement, \
javax.lang.model.element.ExecutableElement, javax.lang.model.element.TypeElement):boolean" )
; ( o1
, "javax.lang.model.util.Types.asElement(javax.lang.model.type.TypeMirror):javax.lang.model.element.Element"
)
; ( o2
, "javax.lang.model.util.Types.isSameType(javax.lang.model.type.TypeMirror, \
javax.lang.model.type.TypeMirror):boolean" )
; ( o2
, "javax.lang.model.util.Types.isSubtype(javax.lang.model.type.TypeMirror, \
javax.lang.model.type.TypeMirror):boolean" )
; ( o2
, "javax.lang.model.util.Types.isAssignable(javax.lang.model.type.TypeMirror, \
javax.lang.model.type.TypeMirror):boolean" )
; ( o2
, "javax.lang.model.util.Types.contains(javax.lang.model.type.TypeMirror, \
javax.lang.model.type.TypeMirror):boolean" )
; ( o2
, "javax.lang.model.util.Types.isSubsignature(javax.lang.model.type.ExecutableType, \
javax.lang.model.type.ExecutableType):boolean" )
; ( o1
, "javax.lang.model.util.Types.directSupertypes(javax.lang.model.type.TypeMirror):java.util.List"
)
; ( o1
, "javax.lang.model.util.Types.erasure(javax.lang.model.type.TypeMirror):javax.lang.model.type.TypeMirror"
)
; ( o1
, "javax.lang.model.util.Types.boxedClass(javax.lang.model.type.PrimitiveType):javax.lang.model.element.TypeElement"
)
; ( o1
, "javax.lang.model.util.Types.unboxedType(javax.lang.model.type.TypeMirror):javax.lang.model.type.PrimitiveType"
)
; ( o1
, "javax.lang.model.util.Types.capture(javax.lang.model.type.TypeMirror):javax.lang.model.type.TypeMirror"
)
; ( o1
, "javax.lang.model.util.Types.getArrayType(javax.lang.model.type.TypeMirror):javax.lang.model.type.ArrayType"
)
; ( o2
, "javax.lang.model.util.Types.getWildcardType(javax.lang.model.type.TypeMirror, \
javax.lang.model.type.TypeMirror):javax.lang.model.type.WildcardType" )
; ( o2
, "javax.lang.model.util.Types.getDeclaredType(javax.lang.model.element.TypeElement, \
javax.lang.model.type.TypeMirror[]):javax.lang.model.type.DeclaredType" )
; ( o3
, "javax.lang.model.util.Types.getDeclaredType(javax.lang.model.type.DeclaredType, \
javax.lang.model.element.TypeElement, \
javax.lang.model.type.TypeMirror[]):javax.lang.model.type.DeclaredType" )
; ( o2
, "javax.lang.model.util.Types.asMemberOf(javax.lang.model.type.DeclaredType, \
javax.lang.model.element.Element):javax.lang.model.type.TypeMirror" )
; ( n3
, "javax.tools.JavaCompiler.getStandardFileManager(javax.tools.DiagnosticListener,java.util.Locale,java.nio.charset.Charset):javax.tools.StandardJavaFileManager"
)
; (ng, "javax.tools.JavaFileObject.getAccessLevel():javax.lang.model.element.Modifier")
; (ng, "javax.tools.JavaFileObject.getNestingKind():javax.lang.model.element.NestingKind")
; ( o2
, "com.sun.source.util.SourcePositions.getStartPosition(com.sun.source.tree.CompilationUnitTree, \
com.sun.source.tree.Tree):long" )
; ( o2
, "com.sun.source.util.SourcePositions.getEndPosition(com.sun.source.tree.CompilationUnitTree, \
com.sun.source.tree.Tree):long" )
; ( (n, [o; o])
, "com.sun.source.util.TreePath.getPath(com.sun.source.tree.CompilationUnitTree, \
com.sun.source.tree.Tree):com.sun.source.util.TreePath" )
; ( (n, [o; o])
, "com.sun.source.util.TreePath.getPath(com.sun.source.util.TreePath, \
com.sun.source.tree.Tree):com.sun.source.util.TreePath" )
; ( (n, [o])
, "com.sun.source.util.Trees.getTree(javax.lang.model.element.Element):com.sun.source.tree.Tree"
)
; ( (n, [o])
, "com.sun.source.util.Trees.getTree(javax.lang.model.element.TypeElement):com.sun.source.tree.ClassTree"
)
; ( (n, [o])
, "com.sun.source.util.Trees.getTree(javax.lang.model.element.ExecutableElement):com.sun.source.tree.MethodTree"
)
; ( (n, [o; o])
, "com.sun.source.util.Trees.getTree(javax.lang.model.element.Element, \
javax.lang.model.element.AnnotationMirror):com.sun.source.tree.Tree" )
; ( (n, [o; o; o])
, "com.sun.source.util.Trees.getTree(javax.lang.model.element.Element, \
javax.lang.model.element.AnnotationMirror, \
javax.lang.model.element.AnnotationValue):com.sun.source.tree.Tree" )
; ( o2
, "com.sun.source.util.Trees.getPath(com.sun.source.tree.CompilationUnitTree, \
com.sun.source.tree.Tree):com.sun.source.util.TreePath" )
; ( (n, [o])
, "com.sun.source.util.Trees.getPath(javax.lang.model.element.Element):com.sun.source.util.TreePath"
)
; ( (n, [o; o])
, "com.sun.source.util.Trees.getPath(javax.lang.model.element.Element, \
javax.lang.model.element.AnnotationMirror):com.sun.source.util.TreePath" )
; ( (n, [o; o; o])
, "com.sun.source.util.Trees.getPath(javax.lang.model.element.Element, \
javax.lang.model.element.AnnotationMirror, \
javax.lang.model.element.AnnotationValue):com.sun.source.util.TreePath" )
; ( (n, [o])
, "com.sun.source.util.Trees.getElement(com.sun.source.util.TreePath):javax.lang.model.element.Element"
)
; ( (n, [o])
, "com.sun.source.util.Trees.getTypeMirror(com.sun.source.util.TreePath):javax.lang.model.type.TypeMirror"
)
; ( (n, [o])
, "com.sun.source.util.Trees.getScope(com.sun.source.util.TreePath):com.sun.source.tree.Scope"
)
; ( (n, [o])
, "com.sun.source.util.Trees.getDocComment(com.sun.source.util.TreePath):java.lang.String" )
; ( o2
, "com.sun.source.util.Trees.isAccessible(com.sun.source.tree.Scope, \
javax.lang.model.element.TypeElement):boolean" )
; ( o3
, "com.sun.source.util.Trees.isAccessible(com.sun.source.tree.Scope, \
javax.lang.model.element.Element, javax.lang.model.type.DeclaredType):boolean" )
; ( o1
, "com.sun.source.util.Trees.getOriginalType(javax.lang.model.type.ErrorType):javax.lang.model.type.TypeMirror"
)
; ( (o, [o; o; o; o])
, "com.sun.source.util.Trees.printMessage(javax.tools.Diagnostic.Kind, java.lang.CharSequence, \
com.sun.source.tree.Tree, com.sun.source.tree.CompilationUnitTree):void" )
; ( o1
, "com.sun.source.util.Trees.getLub(com.sun.source.tree.CatchTree):javax.lang.model.type.TypeMirror"
)
; ( (n, [o; n; n])
, "org.w3c.dom.Document.setUserData(java.lang.String,java.lang.Object,org.w3c.dom.UserDataHandler):java.lang.Object"
)
; ( (n, [o; n; n])
, "org.w3c.dom.Node.setUserData(java.lang.String,java.lang.Object,org.w3c.dom.UserDataHandler):java.lang.Object"
)
; (* References *)
(ng, "java.lang.ref.Reference.get():java.lang.Object")
; (ng, "java.lang.ref.PhantomReference.get():java.lang.Object")
; (ng, "java.lang.ref.SoftReference.get():java.lang.Object")
; (ng, "java.lang.ref.WeakReference.get():java.lang.Object")
; (ng, "java.util.concurrent.atomic.AtomicReference.get():java.lang.Object") ]
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
(** Models for nullability *)
let annotated_list_nullability =
[nullsafe] Error reporting: recommend non-nullable alternarives for known nullable methods Summary: This will help making error reporting more actionable. Often methods that are nullable in general (like View.findViewById) are used as not-nullable due to app-invariants. In such cases suggesting a non-nullable alternative that does an assertion under the hood makes the error report more actionable and provides necessary guidance with respect to coding best practices Follow up will include adding more methods to models. If this goes well, we might support it in user-defined area (nullability repository) Reviewed By: artempyanykh Differential Revision: D20001416 fbshipit-source-id: 46f03467c
5 years ago
let result =
check_not_null_list @ check_state_list @ check_argument_list @ true_on_null_list
@ nullable_method_with_nonnull_alternatives_nullability_list @ annotated_list_nullability_other
in
List.find_a_dup result ~compare:(fun (_, descr1) (_, descr2) -> String.compare descr1 descr2)
|> Option.iter ~f:(fun (_, duplicate_method_descr) ->
Logging.die Logging.InternalError "Nullability table contains a duplicate %s"
duplicate_method_descr ) ;
result
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
[eradicate] Add support for methods that don't return (System.exit) Reviewed By: jeremydubreil Differential Revision: D4335991 fbshipit-source-id: 9b2af48
8 years ago
(** Models for methods that do not return *)
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
let noreturn_list = [((o, [o]), "java.lang.System.exit(int):void")]
[eradicate] Add support for methods that don't return (System.exit) Reviewed By: jeremydubreil Differential Revision: D4335991 fbshipit-source-id: 9b2af48
8 years ago
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
type model_table_t = (string, bool * bool list) Hashtbl.t
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let mk_table list =
let map = Hashtbl.create 1 in
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
List.iter ~f:(function v, pn_id -> Hashtbl.replace map pn_id v) list ;
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
map
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
[nullsafe] Don't mention "unannotated" in Models Summary: "Unannotated" is misleading and ambiguous concept, it can have different meanings depending on agreements. The current logic treats them as Nonnull, which is exactly what we want to preserve. (If we need to partially model some functions where we don't have opinion on some of types in the signature, we can explicitly model unknown nullability later on). Note that I am not aiming for substantial refactoring of modelsTables.ml; the scope of this diff is merely to clarify things. Reviewed By: ngorogiannis Differential Revision: D17449347 fbshipit-source-id: 43c798ce7
6 years ago
let annotated_table_nullability = mk_table annotated_list_nullability
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_not_null_table, check_not_null_parameter_table =
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
(mk_table check_not_null_list, mk_table check_not_null_parameter_list)
[ocamlformat] Use ocamlformat from github Summary: Install ocamlformat from github as part of `make devsetup`, and use it for formatting OCaml (and jbuild) code. Reviewed By: jvillard Differential Revision: D6092464 fbshipit-source-id: 4ba0845
7 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_state_table = mk_table check_state_list
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
Factor out modelTables module Summary: Separating the tables from the Models module into their own module with lint disabled, since these really read better with long lines.
10 years ago
let check_argument_table = mk_table check_argument_list
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
let containsKey_table = mk_table containsKey_list
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
Model Map.put() alongside Map.containsKey(). Summary: public Added special modelling for m.put(k,v) as assigning value v to map m at key k. The modelling is analogous to the one for containsKey: the variable used to represent m.get(k) is generated, and assigned the value v. Reviewed By: jberdine Differential Revision: D2743844 fb-gh-sync-id: 56d3581
9 years ago
let mapPut_table = mk_table mapPut_list
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[eradicate] Add support for methods that don't return (System.exit) Reviewed By: jeremydubreil Differential Revision: D4335991 fbshipit-source-id: 9b2af48
8 years ago
let noreturn_table = mk_table noreturn_list
Convert Reason to OCaml, and auto-format OCaml Summary: Conversion and reformat of infer source using ocamlformat auto-formatting tool. Current status: - Because Reason does not handle docstrings, the output of the conversion is not 'Warning 50'-clean, meaning that there are docstrings with ambiguous placement. I'll need to manually fix them just before landing. Reviewed By: jvillard Differential Revision: D5225546 fbshipit-source-id: 3bd2786
8 years ago
[Eradicate] Add support for modeling boolean functions that check if the argument is null. Summary: Added two annotations @TrueOnNull and @FalseOnNull to be used for boolean functions to specify what value is returned when the argument is null. Added model for TextUtils.isEmpty, which corresponds to the annotation @TrueOnNull static boolean isEmpty(@Nullable java.lang.CharSequence s)
10 years ago
let true_on_null_table = mk_table true_on_null_list
[nullsafe] Error reporting: recommend non-nullable alternarives for known nullable methods Summary: This will help making error reporting more actionable. Often methods that are nullable in general (like View.findViewById) are used as not-nullable due to app-invariants. In such cases suggesting a non-nullable alternative that does an assertion under the hood makes the error report more actionable and provides necessary guidance with respect to coding best practices Follow up will include adding more methods to models. If this goes well, we might support it in user-defined area (nullability repository) Reviewed By: artempyanykh Differential Revision: D20001416 fbshipit-source-id: 46f03467c
5 years ago
let nonnull_alternatives_table =
let method_descr_to_alternative =
List.map nullable_methods_with_nonnull_alternatives_list
~f:(fun (_, method_descr, alternative) -> (alternative, method_descr))
in
mk_table method_descr_to_alternative