BuildActionDefinition.h

#pragma once
#include <NDEVR/GenericOptionGroup.h>
#include <NDEVR/Model.h>
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/LogStream.h>
#include "BuildActions.h"
namespace NDEVR
{
    struct BuildActionUIDefinition
    {
        String ribbon_group;                
        String ribbon_sub_group;            
        bool show_on_ribbon = false;        
        bool show_in_tree = false;          
        bool show_at_bottom_of_tree = false;
    };

    class CommandLineRepresentation
    {
    public:
        CommandLineRepresentation() {};
        CommandLineRepresentation(const String& command);
        CommandLineRepresentation(const char* command);
        String toString() const;
        void toString(String& line) const;
        String command;         
        Buffer<String> args;    
    };
    class LogPtr;
    class BuildActionDefinition : public Model, public LogStream
    {
    public:
        BuildActionDefinition() {};
        BuildActionDefinition(const Model& model);
        BuildAction action() const;
        GenericOptionGroup options() const;
        void setAction(const BuildAction& action);
        void setOptions(const GenericOptionGroup& options);
        void setStartupCriteria(const StringView& label, ExecuteCriteria& criteria, const StringView& value = StringView());
        void setBuildProfile(const StringView& profile);
        StringView buildProfile() const;
        StringView startupCriteriaLabel() const;
        ExecuteCriteria startupCriteria() const;
        StringView startupCriteriaValue() const;
        BuildActionDefinition createChildBuildDefinition();
        bool shouldRun(bool ignore_unresolved) const;
        bool execute(const void* lock_ptr, LogPtr log = nullptr);
        void executeThreaded(const void* lock_ptr, LogPtr log = nullptr);
        virtual void setProgress(uint04 id, fltp04 progress) override;
        virtual void addMessage(uint04 id, const LogMessage& message) override;
        bool isActive() const;
        bool isSuccess() const;
        bool isFailure() const;
        void setIsSuccess(bool is_success, const void* lock_ptr);
        void setRunning(const void* lock_ptr);
        void setSuccessKeywords(const StringView& keywords);
        void setFailureKeywords(const StringView& keywords);
        StringView failureKeywords() const;
        StringView successKeywords() const;
        Buffer<CommandLineRepresentation> toCommandLine(bool is_internal = false) const;
        Buffer<CommandLineRepresentation> toCommandLine(BuildAction action, bool is_internal = false) const;
        void callFromCommandLine(LogPtr log);
        void setRetryCount(uint04 retry_count);
        void setRetryWait(const TimeSpan& span);
        void setOutputLogFile(const File& output_file);
        File outputLogFile() const;
        void setDelay(const TimeSpan& delay);
        TimeSpan delay() const;
        uint04 retryCount() const;
        TimeSpan retryWait() const;
        void setOnFailureExecute(const UUID& id);
        UUID onFailureExecute() const;
        void setOnFailureAction(const OnFailureAction& action);
        OnFailureAction failureAction() const;
        String defaultLogName() const;
        Buffer<VariableDefinition> variablesSet() const;
        void setupAsGitClone(const File& location, const StringView& repo, const StringView& branch = StringView());
        void setupAsRun(const File& location, const StringView& arguments = StringView());
        void setupAsGitPull(const File& location);
        void setLaunchOnShow(bool launch_on_show);
        bool launchOnShow() const;
        bool readFromLogFile(File file, LogPtr log);
        void updateEnabledVisual();
        String expandVar(String var) const;
        String expandString(StringView var, bool ignore = false) const;
        File expandFile(StringView var, bool ignore = false) const;
        void setVariable(StringView var, StringView value);
        BuildActionUIDefinition uiDefinition() const;
        void setUIDefinition(const BuildActionUIDefinition& def);
        void toJSON(JSONNode& node);
        void fromJSON(JSONNode& node);
    protected:
        bool executeChildren(const void* lock_ptr, LogPtr log);
        bool executeOnce(const void* lock_ptr, LogPtr log = nullptr);
        void setActive(bool is_active);
        void childrenToCommandLine(Buffer<CommandLineRepresentation>& actions, bool is_internal = false) const;
    public:
        static constexpr StringView TypeName() { return "build_action_definition"; }
    protected:
        GenericOptionGroup getOptions(BuildAction action) const;
    };
}