similar_function_finder.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <string>
#include <vector>
 
#include <arkanjo/base/function.hpp>
#include <arkanjo/base/path.hpp>
#include <arkanjo/base/similarity_table.hpp>
#include <arkanjo/utils/utils.hpp>
 
#include <arkanjo/cli/cli_error.hpp>
#include <arkanjo/commands/command_base.hpp>
 
class SimilarFunctionFinder : public CommandBase<SimilarFunctionFinder> {
    static constexpr const char* TEMPLATE_EMPTY_FUNCTION =
      "There is no functions that resembles the "
      "name: {pattern:function}\n"
      "Value incorrected passed or there is no "
      "duplication code with this function";
    static constexpr const char* TEMPLATE_COUNT =
      "The total number of functions that are "
      "similar to the found one is {count}. "
      "More info about them are listed below.";
    static constexpr const char* REFERENCE_PATH_MESSAGE = "The following function was found:"; 
 
    Similarity_Table* similarity_table; 
    std::string function_pattern;       
    bool open_folder;
    bool show_mode;
    bool no_numbers;
    Path path;                          
 
    void find_path_that_meets_pattern();
 
    void print_empty_path_message() const;
 
    Function get_reference_function(const Path& path) const;
 
    void print_reference_path();
 
    void print_similar_functions(const std::vector<Path>& similar_paths);
 
    void print_similar_functions();
 
    void handle_show_mode();
 
  public:
    static constexpr CliOption options_[] = {
        {"function_name", 0, PositionalArgument, "The tool will match the parameter with any function that has the `FUNCTION_NAME` as a substring."},
        {"open", 'o', NoArgument, "Open the folder where the function is located."},
        {"show", 's', NoArgument, "Show detailed information and the full source code of the function."},
        {"no-numbers", 0, NoArgument, "Hide line numbers in the displayed source code."},
        OPTION_END
    };
    COMMAND_DESCRIPTION("Search for functions using a substring match.")
 
    
    explicit SimilarFunctionFinder(Similarity_Table* _similarity_table);
 
    bool validate(const ParsedOptions& options) override;
 
    bool run(const ParsedOptions& options) override;
};