Autocompletion of configure.py

[ChunYen-Chen]

It is hard to memorize all the option names since configure.py has too many options. Now, you do not need to memorize the options anymore!
By simply pressing tab key, the available options will be shown and be autocompleted if there is only one available option.

Other updates

• -lh shows the help message in alphabetical order.
• Makefile.log will not be generated with -h, -lh, and --autocomplete_info arguments.
• Add the verbose compilation mode argument --verbose_make
• The common prefix and suffix of the simulation options can be assigned in parser.add_argument()
• Separate long string

[technic960183]

Thanks for the work on this PR.
After I try to use it, I found that it only support --arg option.
Is it possible to support --arg=option?
If compgen does not support it. Can we achieve this by modifing the top level option when = is detected after a valid arg?

[ChunYen-Chen]

@technic960183 Thanks for the comment and review. I have updated the code accordingly.

[technic960183]

Thanks for the update, --arg=option works great. And I don't have any idea of a better implementation now.
Since our wiki use python configure.py as examples, I think support python configure.py is necessary.

[technic960183]

To avoid autocomplete being triggered on unrelated scripts named configure.py, I suggest verifying whether the configure.py being executed is the intended one.

I propose two possible solutions:

• Use an Identifier for Validation
  Add or utilize an identifier to confirm the script. For example:

If ./configure.py -h outputs 2023 Computational Astrophysics Lab, NTU. All rights reserved. at the end, you can validate it by checking for Computational Astrophysics Lab.
Alternatively, introduce a new option such as --version and verify if the output matches a predefined pattern.

• Verify Without Executing the Script
  This approach avoids calling configure.py altogether, which can be important if the other script has side effects (e.g., writing logs) when executed.

Use the sha1sum of configure.py, for instance:

026c866b02f873dad60290a43336ee555119a834  configure.py

Hard-code this hash into the autocomplete script and compare it. However, note that the hash would need to be updated every time configure.py is modified.
The above resolutions are suggestions. The choice of implementation is up to you and @hyschive to decide based on the project's priorities and constraints.

[ChunYen-Chen]

@technic960183 Thanks for the detailed comments. The python configure.py and python3 configure.py are now supported autocompletion.

My current strategy to verify the script is:

1. Check if this directory is a git directory.
2. Check if the very first commit hash is the GAMER first commit hash.
3. Check if the very first commit hash of configure.py is the configure.py for generating Makefile.

[technic960183]

Thanks for the contribution.
There are some bugs of side effects outside the GAMER directory related to falling back to the default behavior of auto-completition.
Checking the very first commit hash to verify the file is a brilliant idea!

[ChunYen-Chen]

@technic960183 I can not reproduce the bugs you found. I guess these bugs are due to the different version behavior. May I know your git and bash versions?

My environment:

• git version 1.8.3.1
• GNU bash, version 4.2.46(2)-release (x86_64-redhat-linux-gnu)

[technic960183]

@technic960183 I can not reproduce the bugs you found. I guess these bugs are due to the different version behavior. May I know your git and bash versions?

My environment:

• git version 1.8.3.1
• GNU bash, version 4.2.46(2)-release (x86_64-redhat-linux-gnu)

@ChunYen-Chen
By git --version and bash --version on our machine:

git version 2.34.1
GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)

[technic960183]

Thanks for the bug fix.
I left some comments for improving efficiency and UX.

[technic960183]

I found some possible edge cases and some consideration on the beginners.
Feel free to reject these suggestion.

[technic960183]

Tests done:

• The installation process on Wiki.
• Correct behavior of the autocompletion.
• Does not affect other python, python3 command.
• Does not affect other ./configure.py (in athena for example)
• Build the Wiki for a preview.

Although I approved this PR, please notice that a bug can be triggered if there is an alias of python.

[hyschive]

@ChunYen-Chen This is super useful! I've left some inline comments. Additionally, please address the following points before merging:

• Do not declare empty symbolic constants like -DGPU_COMPUTE_CAPABILITY= in the Makefile when disabling the corresponding options (e.g., --gpu).
• File an issue report for this bug
• Several option choices have changed due to the newly added prefix feature (e.g., --dual, --elbdm_scheme, --wave_scheme, --gramfe_scheme, --hybrid_scheme). Please update both the Wiki page and generate_make.sh accordingly.

@technic960183 Thanks for the careful review!