Application.h

Go to the documentation of this file.

 
#pragma once
 
#include "config.h"
 
#include <memory>
#include <string>
#include <vector>
 
#include <miktex/App/vi/Version>
#include <miktex/Core/LibraryVersion>
#include <miktex/Core/Session>
#include <miktex/PackageManager/PackageManager>
#include <miktex/Trace/TraceCallback>
 
MIKTEX_APP_BEGIN_NAMESPACE;
 
class MIKTEXAPPTYPEAPI(Application) :
    public MiKTeX::Core::IFindFileCallback,
    public MiKTeX::Packages::PackageInstallerCallback,
    public MiKTeX::Trace::TraceCallback
{
 
public:
 
    MIKTEXAPPEXPORT MIKTEXTHISCALL Application();
    Application(const Application& other) = delete;
    Application& operator=(const Application& other) = delete;
    Application(Application && other) = delete;
    Application& operator=(Application && other) = delete;
    virtual MIKTEXAPPEXPORT MIKTEXTHISCALL ~Application() noexcept;
 
    virtual MIKTEXAPPTHISAPI(std::string) ExamineArgs(std::vector<const char*>&args, MiKTeX::Core::Session::InitInfo& initInfo);
 
    virtual MIKTEXAPPTHISAPI(std::string) ExamineArgs(std::vector<char*>&args, MiKTeX::Core::Session::InitInfo& initInfo);
 
    virtual MIKTEXAPPTHISAPI(void) Init(const MiKTeX::Core::Session::InitInfo& initInfo, std::vector<const char*>&args);
 
    virtual MIKTEXAPPTHISAPI(void) Init(const MiKTeX::Core::Session::InitInfo& initInfo, std::vector<char*>&args);
 
    virtual MIKTEXAPPTHISAPI(void) Init(const MiKTeX::Core::Session::InitInfo& initInfo);
 
    virtual MIKTEXAPPTHISAPI(void) Init(std::vector<const char*>&args);
 
    virtual MIKTEXAPPTHISAPI(void) Init(std::vector<char*>&args);
 
    virtual MIKTEXAPPTHISAPI(void) Init(const std::string& programInvocationName);
 
    virtual MIKTEXAPPTHISAPI(void) Init(const std::string& programInvocationName, const std::string& theNameOfTheGame);
 
    virtual MIKTEXAPPTHISAPI(void) Finalize();
 
    virtual MIKTEXAPPTHISAPI(void) Finalize2(int exitCode);
 
    virtual void GetLibraryVersions(std::vector<MiKTeX::Core::LibraryVersion>&versions) const
    {
        versions.push_back(MiKTeX::App::vi::Version::GetLibraryVersion());
        auto deps = MiKTeX::App::vi::Runtime::GetDependencies();
        versions.insert(std::end(versions), std::begin(deps), std::end(deps));
    }
 
    virtual MIKTEXAPPTHISAPI(void) ShowLibraryVersions() const;
 
    MIKTEXAPPTHISAPI(bool) InstallPackage(const std::string& packageId, const MiKTeX::Util::PathName& trigger, MiKTeX::Util::PathName& installRoot) override;
 
    MIKTEXAPPTHISAPI(bool) TryCreateFile(const MiKTeX::Util::PathName& fileName, MiKTeX::Core::FileType fileType) override;
 
    MIKTEXAPPTHISAPI(void) ReportLine(const std::string& message) override;
 
    MIKTEXAPPTHISAPI(bool) OnRetryableError(const std::string& message) override;
 
    MIKTEXAPPTHISAPI(bool) OnProgress(MiKTeX::Packages::Notification nf) override;
 
    MIKTEXAPPTHISAPI(bool) Trace(const TraceCallback::TraceMessage& traceMessage) override;
 
    MIKTEXAPPTHISAPI(void) EnableInstaller(MiKTeX::Configuration::TriState tri);
 
    MIKTEXNORETURN MIKTEXAPPCEEAPI(void) FatalError(const std::string& message);
 
    MIKTEXAPPCEEAPI(void) Warning(const std::string& message);
 
    MIKTEXAPPCEEAPI(void) SecurityRisk(const std::string& message);
 
    MIKTEXAPPTHISAPI(void) InvokeEditor(const MiKTeX::Util::PathName& editFileName, int editLineNumber, MiKTeX::Core::FileType editFileType, const MiKTeX::Util::PathName& transcriptFileName) const;
 
    MIKTEXAPPTHISAPI(void) Sorry(const std::string& name, const MiKTeX::Core::MiKTeXException& ex);
 
    MIKTEXAPPTHISAPI(void) Sorry(const std::string& name, const std::exception& ex);
 
    MIKTEXAPPTHISAPI(void) Sorry(const std::string& name, const std::string& description, const std::string& remedy, const std::string& url);
 
    void Sorry(const std::string& name)
    {
        Sorry(name, "", "", "");
    }
 
    MIKTEXAPPTHISAPI(bool) GetQuietFlag() const;
 
    MIKTEXAPPTHISAPI(void) SetQuietFlag(bool b);
 
    MIKTEXAPPTHISAPI(std::shared_ptr<MiKTeX::Core::Session>) GetSession() const;
 
    MIKTEXAPPTHISAPI(MiKTeX::Configuration::TriState) GetEnableInstaller() const;
 
    MIKTEXAPPTHISAPI(void) LogInfo(const std::string& message) const;
 
    MIKTEXAPPTHISAPI(void) LogWarn(const std::string& message) const;
 
    MIKTEXAPPTHISAPI(void) LogError(const std::string& message) const;
 
    MIKTEXAPPTHISAPI(void) CheckCancel();
 
    static MIKTEXAPPCEEAPI(Application*) GetApplication();
 
protected:
 
    static MIKTEXAPPCEEAPI(bool) Cancelled();
 
private:
 
    void FlushPendingTraceMessages();
    void TraceInternal(const MiKTeX::Trace::TraceCallback::TraceMessage& traceMessage);
    void ConfigureLogging();
    void AutoMaintenance();
    void AutoDiagnose();
 
    class impl;
    std::unique_ptr<impl> pimpl;
};
 
MIKTEX_APP_END_NAMESPACE;