Displays the location of the ArKanjo cache directory. More...
#include <preprocessor_path.hpp>
Inheritance diagram for PreprocessorPath:
Collaboration diagram for PreprocessorPath:
Public Member Functions | |
| PreprocessorPath () | |
| bool | validate (const ParsedOptions &options) override |
| Validate the arguments already analyzed. More... | |
| bool | run (const ParsedOptions &options) override |
| Executes the main logic of the command. More... | |
| Public Member Functions inherited from CommandBase< PreprocessorPath > | |
| virtual void | print_help (const std::string command_name, const OptionsCollector *collector) const |
| const CliOption * | options () const final |
| bool | do_run (const std::string command_name, const ParsedOptions &options, const OptionsCollector *collector=nullptr) override |
| Public Member Functions inherited from ICommand | |
| virtual | ~ICommand ()=default |
| virtual const CliOption * | options () const =0 |
| virtual std::string_view | description () const =0 |
| virtual bool | validate (const ParsedOptions &options)=0 |
| Validate the arguments already analyzed. More... | |
| virtual bool | run (const ParsedOptions &options)=0 |
| Executes the main logic of the command. More... | |
| virtual bool | do_run (const std::string command_name, const ParsedOptions &options, const OptionsCollector *collector=nullptr)=0 |
Detailed Description
Displays the location of the ArKanjo cache directory.
Handles the execution of the 'path' command, which retrieves and cleanly prints the base cache path configuration to standard output.
Definition at line 20 of file preprocessor_path.hpp.
Constructor & Destructor Documentation
◆ PreprocessorPath()
| PreprocessorPath::PreprocessorPath | ( | ) |
Definition at line 4 of file preprocessor_path.cpp.
Member Function Documentation
◆ run()
|
overridevirtual |
Executes the main logic of the command.
You must use the validated arguments to perform the action desired by the command.
- Parameters
-
options The ParsedOptions structure will be populated with the arguments.
- Returns
- True if the execution is successful, false if an error occurs.
Implements ICommand.
Definition at line 10 of file preprocessor_path.cpp.
◆ validate()
|
overridevirtual |
Validate the arguments already analyzed.
Verify that all required options have been selected and that the values provided are valid.
- Parameters
-
options The ParsedOptions structure will be populated with the arguments.
- Returns
- True if the arguments are valid, false otherwise.
Implements ICommand.
Definition at line 6 of file preprocessor_path.cpp.
The documentation for this class was generated from the following files:
- src/commands/pre/path/preprocessor_path.hpp
- src/commands/pre/path/preprocessor_path.cpp
