cli.h

Go to the documentation of this file.

#pragma once
 
#include <filesystem>
#include <functional>
#include <optional>
#include <string>
#include <vector>
 
struct CliOptions {
    enum class Mode {
        Help,
        ListCpp,
        ListJson,
        Cpp,
        Json
    };
 
    Mode mode = Mode::Help;
    std::string target;
    bool plot = true;
    bool verbose = false;
    std::vector<std::filesystem::path> jsonPathOverrides;
    std::vector<std::filesystem::path> extraSearchPaths;
    std::vector<std::filesystem::path> searchPaths;
};
 
using ExampleFn = std::function<void(bool plotting_enabled)>;
 
void initCliPaths(const char* argv0);
 
std::optional<std::filesystem::path> harmonyRepoRoot();
 
CliOptions parseCli(int argc, char* argv[]);
 
void printCliHelp();
 
void listCppExamples();
 
std::vector<std::string> cppExampleNames();
 
void listJsonFiles(const std::vector<std::filesystem::path>& searchPaths);
 
std::vector<std::filesystem::path> discoverJsonFiles(
    const std::vector<std::filesystem::path>& searchPaths);
 
bool validateJsonFile(const std::filesystem::path& jsonPath, std::string& errorOut);
 
int runCppExample(const std::string& name, bool plot, bool verbose);
 
int runJsonSimulation(
    const std::filesystem::path& jsonPath,
    bool verbose,
    bool plot = true,
    bool waitForPlotClose = true);
 
std::vector<std::filesystem::path> builtinJsonSearchPaths();
 
std::vector<std::filesystem::path> jsonSearchPathsFromEnvironment();
 
std::vector<std::filesystem::path> defaultJsonSearchPaths();
 
std::vector<std::filesystem::path> buildJsonSearchPaths(
    const std::vector<std::filesystem::path>& jsonPathOverrides,
    const std::vector<std::filesystem::path>& extraSearchPaths);
 
std::filesystem::path resolveJsonPath(
    const std::string& input,
    const std::vector<std::filesystem::path>& searchPaths);
 
void printJsonNotFoundHelp(
    const std::string& input,
    const std::vector<std::filesystem::path>& searchPaths);