Mark includes that include-what-you-use spuriously suggests to remove

This is to make sure that we can run include-what-you-use without being
told to remove includes when doing so would fail the build.

Author: tautschnig

jbmc/src/janalyzer/janalyzer_parse_options.cpp

@@ -43,7 +43,7 @@ Author: Daniel Kroening, [email protected]
 #include <linking/static_lifetime_init.h>
 
 #include <cstdlib> // exit()
-#include <fstream>
+#include <fstream> // IWYU pragma: keep
 #include <iostream>
 #include <memory>
 

jbmc/src/java_bytecode/ci_lazy_methods_needed.cpp

@@ -11,13 +11,13 @@ Author: Chris Smowton, [email protected]
 
 #include "ci_lazy_methods_needed.h"
 
-#include <goto-programs/resolve_inherited_component.h>
-
 #include <util/namespace.h>
 #include <util/std_types.h>
 #include <util/symbol_table.h>
 
-#include "generic_parameter_specialization_map.h"
+#include <goto-programs/resolve_inherited_component.h>
+
+#include "generic_parameter_specialization_map.h" // IWYU pragma: keep
 #include "java_static_initializers.h"
 #include "java_types.h"
 #include "select_pointer_type.h"

jbmc/src/java_bytecode/java_bytecode_convert_method.cpp

@@ -13,17 +13,7 @@ Author: Daniel Kroening, [email protected]
 #include <iostream>
 #endif
 
-#include "bytecode_info.h"
-#include "java_bytecode_convert_method.h"
 #include "java_bytecode_convert_method_class.h"
-#include "java_expr.h"
-#include "java_static_initializers.h"
-#include "java_string_library_preprocess.h"
-#include "java_string_literal_expr.h"
-#include "java_types.h"
-#include "java_utils.h"
-#include "lambda_synthesis.h"
-#include "pattern.h"
 
 #include <util/arith_tools.h>
 #include <util/bitvector_expr.h>
@@ -34,14 +24,25 @@ Author: Daniel Kroening, [email protected]
 #include <util/invariant.h>
 #include <util/namespace.h>
 #include <util/prefix.h>
-#include <util/prefix_filter.h>
+#include <util/prefix_filter.h> // IWYU pragma: keep
 #include <util/std_expr.h>
 #include <util/threeval.h>
 
 #include <goto-programs/resolve_inherited_component.h>
 
 #include <analyses/uncaught_exceptions_analysis.h>
 
+#include "bytecode_info.h"
+#include "java_bytecode_convert_method.h"
+#include "java_expr.h"
+#include "java_static_initializers.h"
+#include "java_string_library_preprocess.h"
+#include "java_string_literal_expr.h"
+#include "java_types.h"
+#include "java_utils.h"
+#include "lambda_synthesis.h"
+#include "pattern.h"
+
 #include <algorithm>
 #include <limits>
 

jbmc/src/java_bytecode/java_bytecode_language.h

@@ -10,8 +10,16 @@ Author: Daniel Kroening, [email protected]
 #ifndef CPROVER_JAVA_BYTECODE_JAVA_BYTECODE_LANGUAGE_H
 #define CPROVER_JAVA_BYTECODE_JAVA_BYTECODE_LANGUAGE_H
 
+#include <util/json.h>
+#include <util/make_unique.h>
+#include <util/prefix_filter.h>
+#include <util/symbol.h> // IWYU pragma: keep
+
+#include <langapi/language.h>
+
 #include "ci_lazy_methods.h"
 #include "ci_lazy_methods_needed.h"
+#include "code_with_references.h" // IWYU pragma: keep
 #include "java_class_loader.h"
 #include "java_object_factory_parameters.h"
 #include "java_static_initializers.h"
@@ -21,12 +29,6 @@ Author: Daniel Kroening, [email protected]
 
 #include <memory>
 
-#include <util/json.h>
-#include <util/make_unique.h>
-#include <util/prefix_filter.h>
-
-#include <langapi/language.h>
-
 // clang-format off
 #define JAVA_BYTECODE_LANGUAGE_OPTIONS /*NOLINT*/ \
   "(disable-uncaught-exception-check)" \

jbmc/src/java_bytecode/java_entry_point.h

@@ -13,7 +13,7 @@ Author: Daniel Kroening, [email protected]
 #include <util/irep.h>
 #include <util/symbol.h>
 
-class code_blockt;
+class code_blockt; // IWYU pragma: keep
 class select_pointer_typet;
 class symbol_table_baset;
 struct java_object_factory_parameterst;

jbmc/src/java_bytecode/java_enum_static_init_unwind_handler.cpp

@@ -10,14 +10,15 @@ Author: Chris Smowton, [email protected]
 /// Unwind loops in static initializers
 
 #include "java_enum_static_init_unwind_handler.h"
-#include "java_utils.h"
 
 #include <util/invariant.h>
-#include <util/ssa_expr.h>
+#include <util/ssa_expr.h> // IWYU pragma: keep
 #include <util/suffix.h>
 
 #include <goto-symex/call_stack.h>
 
+#include "java_utils.h"
+
 /// Check if we may be in a function that loops over the cases of an
 /// enumeration (note we return a candidate function that matches a pattern;
 /// our caller must verify it really belongs to an enumeration).

jbmc/src/java_bytecode/java_static_initializers.cpp

@@ -19,7 +19,7 @@ Author: Chris Smowton, [email protected]
 #include <goto-programs/goto_instruction_code.h>
 
 #include "assignments_from_json.h"
-#include "ci_lazy_methods_needed.h"
+#include "ci_lazy_methods_needed.h" // IWYU pragma: keep
 #include "java_object_factory.h"
 #include "java_object_factory_parameters.h"
 #include "java_types.h"

jbmc/unit/java_bytecode/java_static_initializers/java_static_initializers.cpp

@@ -6,21 +6,20 @@ Author: Diffblue Ltd.
 
 \*******************************************************************/
 
-#include <java_bytecode/java_static_initializers.h>
+#include <util/arith_tools.h>
+#include <util/json.h>
+#include <util/symbol_table.h>
+
+#include <goto-programs/goto_instruction_code.h>
 
 #include <java_bytecode/ci_lazy_methods_needed.h>
+#include <java_bytecode/code_with_references.h> // IWYU pragma: keep
+#include <java_bytecode/java_static_initializers.h>
 #include <java_bytecode/java_types.h>
 #include <java_bytecode/java_utils.h>
-
 #include <testing-utils/expr_query.h>
 #include <testing-utils/use_catch.h>
 
-#include <goto-programs/goto_instruction_code.h>
-
-#include <util/arith_tools.h>
-#include <util/json.h>
-#include <util/symbol_table.h>
-
 SCENARIO("is_clinit_function", "[core][java_static_initializers]")
 {
   GIVEN("A function id that represents a clinit")

src/analyses/guard_bdd.h

@@ -13,7 +13,7 @@ Author: Romain Brenguier, [email protected]
 #ifndef CPROVER_ANALYSES_GUARD_BDD_H
 #define CPROVER_ANALYSES_GUARD_BDD_H
 
-#include <solvers/bdd/bdd.h>
+#include <solvers/bdd/bdd.h> // IWYU pragma: keep
 
 class bdd_exprt;
 class exprt;

src/analyses/reaching_definitions.cpp

@@ -15,16 +15,16 @@ Date: February 2013
 
 #include "reaching_definitions.h"
 
-#include <memory>
-
-#include <util/base_exceptions.h>
+#include <util/base_exceptions.h> // IWYU pragma: keep
 #include <util/make_unique.h>
 #include <util/pointer_offset_size.h>
 
 #include <pointer-analysis/value_set_analysis_fi.h>
 
-#include "is_threaded.h"
 #include "dirty.h"
+#include "is_threaded.h"
+
+#include <memory>
 
 /// This ensures that all domains are constructed with the appropriate pointer
 /// back to the analysis engine itself.  Using a factory is a tad verbose

src/analyses/variable-sensitivity/abstract_environment.h

@@ -17,9 +17,9 @@
 #ifndef CPROVER_ANALYSES_VARIABLE_SENSITIVITY_ABSTRACT_ENVIROMENT_H
 #define CPROVER_ANALYSES_VARIABLE_SENSITIVITY_ABSTRACT_ENVIROMENT_H
 
-#include <memory>
+#include "abstract_object.h"
 
-#include <analyses/variable-sensitivity/abstract_object.h>
+#include <memory>
 
 exprt simplify_vsd_expr(exprt src, const namespacet &ns);
 bool is_ptr_diff(const exprt &expr);

src/analyses/variable-sensitivity/abstract_value_object.cpp

@@ -6,20 +6,21 @@
 
 \*******************************************************************/
 
+#include <util/arith_tools.h>
+#include <util/bitvector_types.h>
+#include <util/ieee_float.h>
+#include <util/make_unique.h>
+#include <util/simplify_expr.h>
+
+#include <goto-programs/adjust_float_expressions.h>
+
 #include <analyses/variable-sensitivity/abstract_environment.h>
 #include <analyses/variable-sensitivity/abstract_value_object.h>
 #include <analyses/variable-sensitivity/constant_abstract_value.h>
-#include <analyses/variable-sensitivity/context_abstract_object.h>
 #include <analyses/variable-sensitivity/interval_abstract_value.h>
 #include <analyses/variable-sensitivity/value_set_abstract_object.h>
 
-#include <goto-programs/adjust_float_expressions.h>
-
-#include <util/arith_tools.h>
-#include <util/bitvector_types.h>
-#include <util/ieee_float.h>
-#include <util/make_unique.h>
-#include <util/simplify_expr.h>
+#include "context_abstract_object.h" // IWYU pragma: keep
 
 #include <algorithm>
 

src/analyses/variable-sensitivity/value_set_abstract_object.cpp

@@ -9,16 +9,17 @@
 /// \file
 /// Value Set Abstract Object
 
+#include <util/arith_tools.h>
+#include <util/make_unique.h>
+#include <util/simplify_expr.h>
+
 #include <analyses/variable-sensitivity/abstract_environment.h>
 #include <analyses/variable-sensitivity/constant_abstract_value.h>
-#include <analyses/variable-sensitivity/context_abstract_object.h>
 #include <analyses/variable-sensitivity/interval_abstract_value.h>
 #include <analyses/variable-sensitivity/value_set_abstract_object.h>
 #include <analyses/variable-sensitivity/widened_range.h>
 
-#include <util/arith_tools.h>
-#include <util/make_unique.h>
-#include <util/simplify_expr.h>
+#include "context_abstract_object.h" // IWYU pragma: keep
 
 #include <algorithm>
 

src/analyses/variable-sensitivity/value_set_pointer_abstract_object.cpp

@@ -9,14 +9,16 @@
 /// \file
 /// Value Set of Pointer Abstract Object
 
-#include <analyses/variable-sensitivity/constant_pointer_abstract_object.h>
-#include <analyses/variable-sensitivity/context_abstract_object.h>
-#include <analyses/variable-sensitivity/value_set_pointer_abstract_object.h>
-#include <numeric>
 #include <util/pointer_expr.h>
 #include <util/simplify_expr.h>
 
+#include <analyses/variable-sensitivity/constant_pointer_abstract_object.h>
+#include <analyses/variable-sensitivity/value_set_pointer_abstract_object.h>
+
 #include "abstract_environment.h"
+#include "context_abstract_object.h" // IWYU pragma: keep
+
+#include <numeric>
 
 static abstract_object_sett
 unwrap_and_extract_values(const abstract_object_sett &values);