toolkit.h

// Name:        toolkit.h
// Author:      Laurent Pugin
// Created:     17/10/2013
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_TOOLKIT_H__
#define __VRV_TOOLKIT_H__
 
#include <string>
 
//----------------------------------------------------------------------------
 
#include "doc.h"
#include "docselection.h"
#include "toolkitdef.h"
#include "view.h"
 
//----------------------------------------------------------------------------
 
namespace vrv {
 
class EditorToolkit;
class RuntimeClock;
 
//----------------------------------------------------------------------------
// Toolkit
//----------------------------------------------------------------------------
 
class Toolkit {
public:
 
    Toolkit(bool initFont = true);
    virtual ~Toolkit();
 
 
 
    std::string GetID() { return m_doc.GetID(); }
 
    std::string GetResourcePath() const;
 
    bool SetResourcePath(const std::string &path);
 
    std::string GetLog();
 
    std::string GetVersion() const;
 
    void ResetXmlIdSeed(int seed);
 
 
 
    bool LoadFile(const std::string &filename);
 
    bool LoadData(const std::string &data);
 
    bool LoadZipDataBase64(const std::string &data);
 
    bool LoadZipDataBuffer(const unsigned char *data, int length);
 
    std::string ValidatePAEFile(const std::string &filename);
 
    std::string ValidatePAE(const std::string &data);
 
    int GetPageCount();
 
 
 
    std::string GetOptions() const;
 
    std::string GetDefaultOptions() const;
 
    std::string GetAvailableOptions() const;
 
    bool SetOptions(const std::string &jsonOptions);
 
    void ResetOptions();
 
    void PrintOptionUsage(const std::string &category, std::ostream &output) const;
 
    std::string GetOptionUsageString() const;
 
    bool SetScale(int scale);
 
    int GetScale() { return m_options->m_scale.GetValue(); }
 
    bool SetInputFrom(std::string const &inputFrom);
 
    bool SetOutputTo(std::string const &outputTo);
 
    bool Select(const std::string &selection);
 
 
 
    bool Edit(const std::string &editorAction);
 
    std::string EditInfo();
 
 
 
    std::string RenderData(const std::string &data, const std::string &jsonOptions);
 
    std::string RenderToSVG(int pageNo = 1, bool xmlDeclaration = false);
 
    bool RenderToSVGFile(const std::string &filename, int pageNo = 1);
 
    std::string RenderToMIDI();
 
    bool RenderToMIDIFile(const std::string &filename);
 
    std::string RenderToPAE();
 
    bool RenderToPAEFile(const std::string &filename);
 
    std::string RenderToTimemap(const std::string &jsonOptions = "");
 
    std::string RenderToExpansionMap();
 
    bool RenderToTimemapFile(const std::string &filename, const std::string &jsonOptions = "");
 
    bool RenderToExpansionMapFile(const std::string &filename);
 
 
 
    std::string GetHumdrum();
 
    std::string ConvertMEIToHumdrum(const std::string &meiData);
 
    std::string ConvertHumdrumToHumdrum(const std::string &humdrumData);
 
    std::string ConvertHumdrumToMIDI(const std::string &humdrumData);
 
    bool GetHumdrumFile(const std::string &filename);
 
 
 
    std::string GetMEI(const std::string &jsonOptions = "");
 
    bool SaveFile(const std::string &filename, const std::string &jsonOptions = "");
 
 
 
    std::string GetDescriptiveFeatures(const std::string &jsonOptions);
 
    std::string GetElementsAtTime(int millisec);
 
    int GetPageWithElement(const std::string &xmlId);
 
    std::string GetElementAttr(const std::string &xmlId);
 
    std::string GetNotatedIdForElement(const std::string &xmlId);
 
    std::string GetExpansionIdsForElement(const std::string &xmlId);
 
    int GetTimeForElement(const std::string &xmlId);
 
    std::string GetMIDIValuesForElement(const std::string &xmlId);
 
    std::string GetTimesForElement(const std::string &xmlId);
 
 
 
    void RedoLayout(const std::string &jsonOptions = "");
 
    void RedoPagePitchPosLayout();
 
 
    //------------------------------------------------//
    // Public methods not listed in the documentation //
    //------------------------------------------------//
 
 
    bool RenderToDeviceContext(int pageNo, DeviceContext *deviceContext);
 
    Options *GetOptionsObj() { return m_options; }
 
    void SetCString(const std::string &data);
 
    const char *GetCString();
 
    void GetHumdrum(std::ostream &output);
 
    void SetHumdrumBuffer(const char *contents);
 
    const char *GetHumdrumBuffer();
 
    void ClearHumdrumBuffer();
 
    void SetInputFrom(FileFormat format);
    int GetInputFrom() { return m_inputFrom; }
 
    int GetOutputTo() { return m_outputTo; }
 
    void SetLocale();
    void ResetLocale();
 
    void InitClock();
    void ResetClock();
    double GetRuntimeInSeconds() const;
    void LogRuntime() const;
 
 
protected:
    FileFormat IdentifyInputFrom(const std::string &data);
 
    void PrintOptionUsageOutput(const vrv::Option *option, std::ostream &output) const;
 
    void ResetLogBuffer();
 
    void LogRedirectStart();
 
    void LogRedirectStop();
 
    bool LoadData(const std::string &data, bool resetLogBuffer);
 
private:
    bool SetFont(const std::string &fontName);
    bool IsUTF16(const std::string &filename);
    bool LoadUTF16File(const std::string &filename);
    bool IsZip(const std::string &filename);
    bool LoadZipFile(const std::string &filename);
    bool LoadZipData(const std::vector<unsigned char> &bytes);
    void GetClassIds(const std::vector<std::string> &classStrings, std::vector<ClassId> &classIds);
 
    std::string GetOptions(bool defaultValues) const;
 
public:
    //
private:
    Doc m_doc;
    DocSelection m_docSelection;
    View m_view;
    FileFormat m_inputFrom;
    FileFormat m_outputTo;
 
    Options *m_options;
 
    std::optional<std::locale> m_previousLocale;
 
    char *m_cString;
 
    std::stringstream m_cerrCaptured;
 
    std::streambuf *m_cerrOriginalBuf;
 
    EditorToolkit *m_editorToolkit;
 
#ifndef NO_RUNTIME
 
    RuntimeClock *m_runtimeClock;
#endif
 
    //----------------//
    // Static members //
    //----------------//
 
    static char *m_humdrumBuffer;
};
 
} // namespace vrv
#endif