input_help.h

Go to the documentation of this file.

#ifndef INPUT_HELP_H
#define INPUT_HELP_H
 
#include <iostream>
#include <map>
#include <mutex>
#include <string>
#include <vector>
 
namespace ModuleIO {
 
struct ParameterMetadata {
    std::string name;
    std::string type;
    std::string description;
    std::string default_value;
    std::string category;
    std::string unit;         // Empty string if no unit
    std::string availability; // Empty string if always available
    std::string name_lowercase; // Pre-computed lowercase for fast fuzzy matching
};
 
class ParameterHelp {
public:
    static void initialize();
 
    static bool show_parameter_help(const std::string& key, std::ostream& os = std::cout);
 
    static std::vector<std::string> search_parameters(const std::string& query);
 
    static void show_general_help(std::ostream& os = std::cout);
 
    static void generate_yaml(std::ostream& os = std::cout);
 
    static ParameterMetadata get_metadata(const std::string& key);
 
    static std::vector<std::string> find_similar_parameters(const std::string& query,
                                                             int max_suggestions = 5,
                                                             int max_distance = 3);
 
private:
    static std::map<std::string, ParameterMetadata> registry_;
    static std::map<std::string, std::string> lowercase_to_actual_;
    static std::once_flag init_flag_;
 
    static void build_registry();
 
    static std::map<std::string, ParameterMetadata>::const_iterator
    find_case_insensitive(const std::string& key);
 
    static std::string to_lowercase(const std::string& str);
 
    static int levenshtein_distance(const std::string& s1, const std::string& s2);
};
 
} // namespace ModuleIO
 
#endif // INPUT_HELP_H