Fixed #515: Added bash autocomplete script.

This change cleans up the option handling. All options are now placed in
`InsightsOptions.def`. This patch added a new option `--autocomplete` which
roughly follows Clang's `--autocomplete` option. Except that it solely prints
all available C++ Insights options and exists.

Please note that Clang tooling options like `-p` are not part of the output.
The new script `scripts/bash-autocomplete.sh` can be downloaded and put into
your bash's completion directory, and you can autocomplete C++ Insights and
Clang options passable to C++ Insights.

Author: andreasfertig

.github/workflows/ci.yml

@@ -549,6 +549,7 @@ jobs:
 
     - name: Run tests
       if:  matrix.config.run_tests == 'Yes'
+      shell: bash
       id: run_tests
       run: |
           cmake --build build --target tests

CMakeLists.txt

@@ -656,7 +656,8 @@ else()
         ${CMAKE_CURRENT_BINARY_DIR}/$<TARGET_FILE_NAME:insights> --cxx ${CMAKE_CXX_COMPILER} ${TEST_FAILURE_IS_OK} ${TEST_USE_LIBCPP} ${LLVM_PROF_DIR}
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/testSTDIN.sh ${CMAKE_CURRENT_BINARY_DIR}/$<TARGET_FILE_NAME:insights>
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/testInvalidOption.sh ${CMAKE_CURRENT_BINARY_DIR}/$<TARGET_FILE_NAME:insights>
-        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/$<TARGET_FILE_NAME:insights> ${CMAKE_CURRENT_SOURCE_DIR}/tests/runTest.py
+        COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell/test-bash-completion.sh ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell ${CMAKE_CURRENT_SOURCE_DIR}/scripts/bash-autocomplete.sh ${TEST_FAILURE_IS_OK}
+        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/$<TARGET_FILE_NAME:insights> ${CMAKE_CURRENT_SOURCE_DIR}/tests/runTest.py ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell/test-bash-completion.sh
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests
         COMMENT "Running tests" VERBATIM
     )
@@ -667,7 +668,8 @@ if (NOT WIN32)
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/runTest.py --insights ${CMAKE_CURRENT_BINARY_DIR}/insights --cxx ${CMAKE_CXX_COMPILER} --update-tests ${TEST_FAILURE_IS_OK}
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/testSTDIN.sh ${CMAKE_CURRENT_BINARY_DIR}/insights
         COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/testInvalidOption.sh ${CMAKE_CURRENT_BINARY_DIR}/insights
-        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/insights ${CMAKE_CURRENT_SOURCE_DIR}/tests/runTest.py
+        COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell/test-bash-completion.sh ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell ${CMAKE_CURRENT_SOURCE_DIR}/scripts/bash-autocomplete.sh
+        DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/insights ${CMAKE_CURRENT_SOURCE_DIR}/tests/runTest.py ${CMAKE_CURRENT_SOURCE_DIR}/tests/shell/test-bash-completion.sh
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests
         COMMENT "Running tests" VERBATIM
     )

Insights.cpp

@@ -55,16 +55,6 @@ static llvm::cl::OptionCategory gInsightEduCategory(
     "This transformations are only for education purposes. The resulting code most likely does not compile."sv);
 //-----------------------------------------------------------------------------
 
-static llvm::cl::opt<bool> gStdinMode("stdin",
-                                      llvm::cl::desc("Read the input from <stdin>."sv),
-                                      llvm::cl::init(false),
-                                      llvm::cl::cat(gInsightCategory));
-//-----------------------------------------------------------------------------
-
-static llvm::cl::opt<bool>
-    gUseLibCpp("use-libc++", llvm::cl::desc("Use libc++."sv), llvm::cl::init(false), llvm::cl::cat(gInsightCategory));
-//-----------------------------------------------------------------------------
-
 #define INSIGHTS_OPT(option, name, deflt, description, category)                                                       \
     static llvm::cl::opt<bool, true> g##name(option,                                                                   \
                                              llvm::cl::desc(std::string_view{description}),                            \
@@ -397,7 +387,17 @@ extern struct __mptr* __vtbl_array[];
     auto opExpected = CommonOptionsParser::create(argc, argv, gInsightCategory);
 
     if(auto err = opExpected.takeError()) {
-        llvm::errs() << toString(std::move(err)) << "\n";
+        if(gAutoComplete) {
+#define INSIGHTS_OPT(option, name, deflt, description, category) llvm::outs() << "--" << option << " ";
+
+#include "InsightsOptions.def"
+
+            return 0;
+        } else {
+
+            llvm::errs() << toString(std::move(err)) << "\n";
+        }
+
         return 1;
     }
 

InsightsOptions.def

@@ -31,4 +31,9 @@ INSIGHTS_OPT("edu-show-coroutine-transformation",
              gInsightEduCategory)
 INSIGHTS_OPT("edu-show-cfront", UseShow2C, false, "Show transformation to C", gInsightEduCategory)
 INSIGHTS_OPT("edu-show-lifetime", ShowLifetime, false, "Show lifetime of objects", gInsightEduCategory)
+
+INSIGHTS_OPT("stdin", StdinMode, false, "Read the input from <stdin>.", gInsightCategory)
+INSIGHTS_OPT("use-libc++", UseLibCpp, false, "Use libc++ (LLVM) instead of libstdc++ (GNU).", gInsightCategory)
+INSIGHTS_OPT("autocomplete", AutoComplete, false, "Generate list of options for autocomplete and exit.", gInsightCategory)
+
 #undef INSIGHTS_OPT

Readme.md

@@ -263,6 +263,16 @@ At least for macOS, you can install C++ Insights via Homebrew thanks to [this fo
 brew install cppinsights
 ```
 
+## Bash autocomplete
+
+There is a bash autocomplete script. It autocompletes the C++ Insights options as well as the Clang options provided after `--`.
+You can download it with the following commands:
+
+```
+cd <YOUR_BASH_COMPLETION.D>
+curl -o insights https://github.com/andreasfertig/cppinsights/tree/main/scripts/bash-autocomplete.sh
+```
+
 
 ## Compatibility
 

docs/CommandLineOptions.md

@@ -2,6 +2,7 @@
 
 * [alt-syntax-for](@ref alt_syntax_for)
 * [alt-syntax-subscription](@ref alt_syntax_subscription)
+* [autocomplete](@ref autocomplete)
 * [edu-show-cfront](@ref edu_show_cfront)
 * [edu-show-coroutine-transformation](@ref edu_show_coroutine_transformation)
 * [edu-show-initlist](@ref edu_show_initlist)
@@ -10,3 +11,5 @@
 * [edu-show-padding](@ref edu_show_padding)
 * [show-all-callexpr-template-parameters](@ref show_all_callexpr_template_parameters)
 * [show-all-implicit-casts](@ref show_all_implicit_casts)
+* [stdin](@ref stdin)
+* [use-libc++](@ref use_libc++)

docs/cmdl-examples/autocomplete.cpp

@@ -0,0 +1 @@
+// Just prints out all the C++ Insights options.

docs/cmdl-examples/edu-show-cfront.cpp

@@ -1,5 +1,3 @@
-// cmdlineinsights:-edu-show-cfront
-
 #include <cstdio>
 
 class A

docs/cmdl-examples/edu-show-coroutine-transformation.cpp

@@ -1,18 +1,8 @@
-#if __has_include(<coroutine>)
 #include <coroutine>
-#elif __has_include(<experimental/coroutine>)
-#include <experimental/coroutine>
-
-namespace std {
-using namespace std::experimental;
-}
-#else
-#error "No coroutine header"
-#endif
-
 #include <cstdio>
 #include <exception>
 #include <new>
+#include <utility>
 
 struct generator
 {
@@ -35,7 +25,7 @@ struct generator
 
     generator(generator const&) = delete;
     generator(generator&& rhs)
-    : p{std::exchange(rhs.p, nullptr)}
+    : handle{std::exchange(rhs.handle, nullptr)}
     {
     }
 

docs/cmdl-examples/stdin.cpp

@@ -0,0 +1,4 @@
+int main()
+{
+    // Nothing going on here.
+}