Merge pull request #890 from reuk/include-order-fix

Include order fix

Author: kroening

CODING_STANDARD.md

@@ -103,6 +103,10 @@ Here a few minimalistic coding rules for the CPROVER source tree.
 - Prefer forward declaration to includes, but forward declare at the top of the
   header file rather than in line
 - Guard headers with `#ifndef CPROVER_DIRECTORIES_FILE_H`, etc
+- The corresponding header for a given source file should always be the *first*
+  include in the source file. For example, given `foo.h` and `foo.cpp`, the
+  line `#include "foo.h"` should precede all other include statements in
+  `foo.cpp`.
 
 # Makefiles
 - Each source file should appear on a separate line

src/analyses/ai.cpp

@@ -9,6 +9,8 @@ Author: Daniel Kroening, kroening@kroening.com
 /// \file
 /// Abstract Interpretation
 
+#include "ai.h"
+
 #include <cassert>
 #include <memory>
 #include <sstream>
@@ -19,8 +21,6 @@ Author: Daniel Kroening, kroening@kroening.com
 
 #include "is_threaded.h"
 
-#include "ai.h"
-
 jsont ai_domain_baset::output_json(
   const ai_baset &ai,
   const namespacet &ns) const

src/analyses/call_graph.cpp

@@ -9,11 +9,11 @@ Author: Daniel Kroening, kroening@kroening.com
 /// \file
 /// Function Call Graphs
 
+#include "call_graph.h"
+
 #include <util/std_expr.h>
 #include <util/xml.h>
 
-#include "call_graph.h"
-
 call_grapht::call_grapht()
 {
 }

src/analyses/constant_propagator.cpp

@@ -9,6 +9,8 @@ Author: Peter Schrammel
 /// \file
 /// Constant Propagation
 
+#include "constant_propagator.h"
+
 #ifdef DEBUG
 #include <iostream>
 #endif
@@ -17,8 +19,6 @@ Author: Peter Schrammel
 #include <util/arith_tools.h>
 #include <util/simplify_expr.h>
 
-#include "constant_propagator.h"
-
 exprt concatenate_array_id(
 		const exprt &array, const exprt &index,
 		const typet &type)

src/analyses/custom_bitvector_analysis.cpp

@@ -9,11 +9,11 @@ Author: Daniel Kroening, kroening@kroening.com
 /// \file
 /// Field-insensitive, location-sensitive bitvector analysis
 
+#include "custom_bitvector_analysis.h"
+
 #include <util/xml_expr.h>
 #include <util/simplify_expr.h>
 
-#include "custom_bitvector_analysis.h"
-
 #include <iostream>
 
 void custom_bitvector_domaint::set_bit(

src/analyses/dependence_graph.cpp

@@ -12,15 +12,15 @@ Date: August 2013
 /// \file
 /// Field-Sensitive Program Dependence Analysis, Litvak et al., FSE 2010
 
+#include "dependence_graph.h"
+
 #include <cassert>
 
 #include <util/json.h>
 #include <util/json_expr.h>
 
 #include "goto_rw.h"
 
-#include "dependence_graph.h"
-
 bool dep_graph_domaint::merge(
   const dep_graph_domaint &src,
   goto_programt::const_targett from,

src/analyses/dirty.cpp

@@ -11,10 +11,10 @@ Date: March 2013
 /// \file
 /// Local variables whose address is taken
 
-#include <util/std_expr.h>
-
 #include "dirty.h"
 
+#include <util/std_expr.h>
+
 void dirtyt::build(const goto_functiont &goto_function)
 {
   forall_goto_program_instructions(it, goto_function.body)

src/analyses/does_remove_const.cpp

@@ -9,15 +9,15 @@
 /// \file
 /// Analyses
 
+#include "does_remove_const.h"
+
 #include <goto-programs/goto_program.h>
 #include <util/type.h>
 #include <util/expr.h>
 #include <util/std_code.h>
 #include <util/base_type.h>
 #include <ansi-c/c_qualifiers.h>
 
-#include "does_remove_const.h"
-
 /// A naive analysis to look for casts that remove const-ness from pointers.
 /// \param goto_program: the goto program to check
 /// \param ns: the namespace of the goto program (used for checking type

src/analyses/does_remove_const.h

@@ -14,6 +14,8 @@
 #include <util/type.h>
 
 class goto_programt;
+class namespacet;
+class exprt;
 
 class does_remove_constt
 {

src/analyses/escape_analysis.cpp

@@ -9,10 +9,10 @@ Author: Daniel Kroening, kroening@kroening.com
 /// \file
 /// Field-insensitive, location-sensitive escape analysis
 
-#include <util/simplify_expr.h>
-
 #include "escape_analysis.h"
 
+#include <util/simplify_expr.h>
+
 bool escape_domaint::is_tracked(const symbol_exprt &symbol)
 {
   const irep_idt &identifier=symbol.get_identifier();