Use help_entry to consistently format help output

We previously did manual line breaks that either suited the source code
line length or approximated the output line width. help_entry, however,
was specifically built to take care of this (and just wasn't widely
used). We can then also happily have clang-format take care of source
code formatting without impacting the resulting display.

Author: tautschnig

jbmc/src/janalyzer/janalyzer_parse_options.cpp

@@ -727,77 +727,86 @@ void janalyzer_parse_optionst::help()
     "\n"
     " janalyzer [-?] [-h] [--help] show help\n"
     " janalyzer\n"
-    HELP_JAVA_METHOD_NAME
-    " janalyzer\n"
-    HELP_JAVA_CLASS_NAME
-    " janalyzer\n"
-    HELP_JAVA_JAR
-    " janalyzer\n"
-    HELP_JAVA_GOTO_BINARY
-    "\n"
-    HELP_JAVA_CLASSPATH
-    HELP_FUNCTIONS
-    "\n"
+    << HELP_JAVA_METHOD_NAME
+    << " janalyzer\n"
+    << HELP_JAVA_CLASS_NAME
+    << " janalyzer\n"
+    << HELP_JAVA_JAR
+    << " janalyzer\n"
+    << HELP_JAVA_GOTO_BINARY
+    << "\n"
+    << HELP_JAVA_CLASSPATH
+    << HELP_FUNCTIONS
+    << "\n"
     "Task options:\n"
-    " --show                       display the abstract domains\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --verify                     use the abstract domains to check assertions\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --simplify file_name         use the abstract domains to simplify the program\n"
-    " --no-simplify-slicing        do not remove instructions from which no\n"
-    "                              property can be reached (use with --simplify)\n" // NOLINT(*)
-    " --unreachable-instructions   list dead code\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --unreachable-functions      list functions unreachable from the entry point\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --reachable-functions        list functions reachable from the entry point\n"
-    "\n"
+    << help_entry("--show", "display the abstract domains")
+    << help_entry("--verify", "use the abstract domains to check assertions")
+    << help_entry(
+      "--simplify file_name",
+      "use the abstract domains to simplify the program")
+    << help_entry(
+      "--no-simplify-slicing",
+      "do not remove instructions from which no property can be reached (use "
+      "with --simplify)")
+    << help_entry("--unreachable-instructions", "list dead code")
+    << help_entry(
+      "--unreachable-functions",
+      "list functions unreachable from the entry point")
+    << help_entry(
+      "--reachable-functions", "list functions reachable from the entry point")
+    << "\n"
     "Abstract interpreter options:\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --location-sensitive         use location-sensitive abstract interpreter\n"
-    " --concurrent                 use concurrency-aware abstract interpreter\n"
-    "\n"
+    << help_entry(
+      "--location-sensitive", "use location-sensitive abstract interpreter")
+    << help_entry("--concurrent", "use concurrency-aware abstract interpreter")
+    << "\n"
     "Domain options:\n"
-    " --constants                  constant domain\n"
-    " --intervals, --show-intervals\n"
-    "                              interval domain\n"
-    " --non-null, --show-non-null  non-null domain\n"
-    " --dependence-graph           data and control dependencies between instructions\n" // NOLINT(*)
-    "\n"
+    << help_entry("--constants", "constant domain")
+    << help_entry("--intervals, --show-intervals", "interval domain")
+    << help_entry("--non-null, --show-non-null", "non-null domain")
+    << help_entry(
+      "--dependence-graph",
+      "data and control dependencies between instructions")
+    << "\n"
     "Output options:\n"
-    " --text file_name             output results in plain text to given file\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --json file_name             output results in JSON format to given file\n"
-    " --xml file_name              output results in XML format to given file\n"
-    " --dot file_name              output results in DOT format to given file\n"
-    "\n"
+    << help_entry(
+      "--text file_name", "output results in plain text to given file")
+    << help_entry(
+      "--json file_name", "output results in JSON format to given file")
+    << help_entry(
+      "--xml file_name", "output results in XML format to given file")
+    << help_entry(
+      "--dot file_name", "output results in DOT format to given file")
+    << "\n"
     "Specific analyses:\n"
-    // NOLINTNEXTLINE(whitespace/line_length)
-    " --taint file_name            perform taint analysis using rules in given file\n"
-    " --show-taint                 print taint analysis results on stdout\n"
-    " --show-local-may-alias       perform procedure-local may alias analysis\n"
-    "\n"
+    << help_entry(
+      "--taint file_name", "perform taint analysis using rules in given file")
+    << help_entry(
+      "--show-taint", "print taint analysis results on stdout")
+    << help_entry(
+      "--show-local-may-alias", "perform procedure-local may alias analysis")
+    << "\n"
     "Java Bytecode frontend options:\n"
-    JAVA_BYTECODE_LANGUAGE_OPTIONS_HELP
-    "\n"
+    << JAVA_BYTECODE_LANGUAGE_OPTIONS_HELP
+    << "\n"
     "Platform options:\n"
-    HELP_CONFIG_PLATFORM
-    "\n"
+    << HELP_CONFIG_PLATFORM
+    << "\n"
     "Program representations:\n"
-    " --show-parse-tree            show parse tree\n"
-    " --show-symbol-table          show loaded symbol table\n"
-    HELP_SHOW_GOTO_FUNCTIONS
-    HELP_SHOW_PROPERTIES
-    "\n"
+    << help_entry("--show-parse-tree", "show parse tree")
+    << help_entry("--show-symbol-table", "show loaded symbol table")
+    << HELP_SHOW_GOTO_FUNCTIONS
+    << HELP_SHOW_PROPERTIES
+    << "\n"
     "Program instrumentation options:\n"
-    " --no-assertions              ignore user assertions\n"
-    " --no-assumptions             ignore user assumptions\n"
-    " --property id                enable selected properties only\n"
-    "\n"
+    << help_entry("--no-assertions", "ignore user assertions")
+    << help_entry("--no-assumptions", "ignore user assumptions")
+    << help_entry("--property id", "enable selected properties only")
+    << "\n"
     "Other options:\n"
-    " --version                    show version and exit\n"
-    " --verbosity #                verbosity level\n"
-    HELP_TIMESTAMP
-    "\n";
+    << help_entry("--version", "show version and exit")
+    << help_entry("--verbosity #", "verbosity level")
+    << HELP_TIMESTAMP
+    << "\n";
   // clang-format on
 }