Cleanup options handling of count-eloc, list-eloc, print-path-lengths

Author: tautschnig

src/goto-instrument/count_eloc.cpp

@@ -20,6 +20,7 @@ Date: December 2012
 #include <util/file_util.h>
 
 #include <goto-programs/cfg.h>
+#include <goto-programs/goto_model.h>
 
 typedef std::unordered_set<irep_idt> linest;
 typedef std::unordered_map<irep_idt, linest> filest;

src/goto-instrument/count_eloc.h

@@ -14,10 +14,22 @@ Date: December 2012
 #ifndef CPROVER_GOTO_INSTRUMENT_COUNT_ELOC_H
 #define CPROVER_GOTO_INSTRUMENT_COUNT_ELOC_H
 
-#include <goto-programs/goto_model.h>
+class goto_modelt;
 
 void count_eloc(const goto_modelt &);
 void list_eloc(const goto_modelt &);
 void print_path_lengths(const goto_modelt &);
 
+#define OPT_GOTO_PROGRAM_STATS                                                 \
+  "(count-eloc)"                                                               \
+  "(list-eloc)"                                                                \
+  "(print-path-lengths)"
+
+#define HELP_GOTO_PROGRAM_STATS                                                \
+  " --count-eloc                 count effective lines of code\n"              \
+  " --list-eloc                  list full path names of lines "               \
+  "containing code\n"                                                          \
+  " --print-path-lengths         print statistics about control-flow graph "   \
+  "paths\n"
+
 #endif // CPROVER_GOTO_INSTRUMENT_COUNT_ELOC_H

src/goto-instrument/goto_instrument_parse_options.cpp

@@ -91,7 +91,6 @@ Author: Daniel Kroening, [email protected]
 #include "wmm/weak_memory.h"
 #include "call_sequences.h"
 #include "accelerate/accelerate.h"
-#include "count_eloc.h"
 #include "horn_encoding.h"
 #include "thread_instrumentation.h"
 #include "skip_loops.h"
@@ -1454,15 +1453,14 @@ void goto_instrument_parse_optionst::help()
     " --dump-cpp                   generate C++ source\n"
     " --dot                        generate CFG graph in DOT format\n"
     " --interpreter                do concrete execution\n"
-    " --count-eloc                 count effective lines of code\n"
-    " --list-eloc                  list full path names of lines containing code\n" // NOLINT(*)
     "\n"
     "Diagnosis:\n"
     " --show-loops                 show the loops in the program\n"
     HELP_SHOW_PROPERTIES
     " --show-symbol-table          show loaded symbol table\n"
     " --list-symbols               list symbols with type information\n"
     HELP_SHOW_GOTO_FUNCTIONS
+    HELP_GOTO_PROGRAM_STATS
     " --drop-unused-functions      drop functions trivially unreachable from main function\n" // NOLINT(*)
     " --print-internal-representation\n" // NOLINTNEXTLINE(*)
     "                              show verbose internal representation of the program\n"
@@ -1471,8 +1469,6 @@ void goto_instrument_parse_optionst::help()
     " --show-natural-loops         show natural loop heads\n"
     // NOLINTNEXTLINE(whitespace/line_length)
     " --list-calls-args            list all function calls with their arguments\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --print-path-lengths         print statistics about control-flow graph paths\n"
     " --call-graph                 show graph of function calls\n"
     // NOLINTNEXTLINE(whitespace/line_length)
     " --reachable-call-graph       show graph of function calls potentially reachable from main function\n"

src/goto-instrument/goto_instrument_parse_options.h

@@ -27,6 +27,8 @@ Author: Daniel Kroening, [email protected]
 
 #include <goto-programs/generate_function_bodies.h>
 
+#include "count_eloc.h"
+
 // clang-format off
 #define GOTO_INSTRUMENT_OPTIONS \
   "(all)" \
@@ -81,17 +83,18 @@ Author: Daniel Kroening, [email protected]
   "(accelerate)(constant-propagator)" \
   "(k-induction):(step-case)(base-case)" \
   "(show-call-sequences)(check-call-sequence)" \
-  "(interpreter)(show-reaching-definitions)(count-eloc)(list-eloc)" \
+  "(interpreter)(show-reaching-definitions)" \
   "(list-symbols)(list-undefined-functions)" \
   "(z3)(add-library)(show-dependence-graph)" \
   "(horn)(skip-loops):(apply-code-contracts)(model-argc-argv):" \
-  "(show-threaded)(list-calls-args)(print-path-lengths)" \
+  "(show-threaded)(list-calls-args)" \
   "(undefined-function-is-assume-false)" \
   "(remove-function-body):"\
   OPT_FLUSH \
   "(splice-call):" \
   OPT_REMOVE_CALLS_NO_BODY \
-  OPT_REPLACE_FUNCTION_BODY
+  OPT_REPLACE_FUNCTION_BODY \
+  OPT_GOTO_PROGRAM_STATS
 
 // clang-format on