GUIDOEngineAdapter.h

Go to the documentation of this file.

#ifndef GUIDOENGINEADAPTER_H
#define GUIDOENGINEADAPTER_H
/*
  GUIDO Library
  Copyright (C) 2014    Grame
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
 
*/
 
#include <string>
#include <ostream>
#include "GUIDOEngine.h"
 
class GuidoParser;
class GuidoStream;
 
 
typedef struct {
    int line;
    int col;
    std::string msg;
} ParserError;
 
typedef struct {
    int major;
    int minor;
    int sub;
    std::string str;
} GuidoVersion;
 
class_export GuidoEngineAdapter
{
    public:
        GuidoEngineAdapter();
        virtual ~GuidoEngineAdapter();
 
 
            GuidoErrCode init(GuidoInitDesc * desc);
 
            GuidoErrCode init();
 
            void     shutdown();
 
            GuidoErrCode ar2gmn(ARHandler ar, std::ostream& to);
 
            GRHandler ar2gr(ARHandler ar);
 
            GRHandler ar2gr(ARHandler ar, const GuidoLayoutSettings &settings);
 
            GuidoErrCode updateGR(GRHandler gr);
 
            GuidoErrCode updateGR(GRHandler gr, const GuidoLayoutSettings &settings);
 
            void freeAR(ARHandler ar);
 
            void freeGR(GRHandler gr);
 
            std::string getErrorString(GuidoErrCode errCode);
 
            GuidoLayoutSettings getDefaultLayoutSettings();
 
            GuidoErrCode showElement( GRHandler gr, int elt, bool status);
            int countVoices(CARHandler inHandleAR);
 
            int getPageCount(CGRHandler inHandleGR);
 
            int getSystemCount(CGRHandler inHandleGR, int page);
 
            GuidoDate duration(CGRHandler inHandleGR);
 
            int findEventPage(CGRHandler inHandleGR, const GuidoDate& date);
 
            int findPageAt(CGRHandler inHandleGR, const GuidoDate& date);
 
            GuidoDate getPageDate(CGRHandler inHandleGR, int pageNum);
            GuidoErrCode onDraw(GuidoOnDrawDesc * desc);
 
            std::string gr2SVG( const GRHandler handle, int page, std::ostream& out, int w, int h, bool embedFont = true );
 
            GuidoErrCode gr2SVG( const GRHandler handle, int page, std::ostream& out, bool embedFont = true, const char* font = 0, const int mappingMode = 0 );
 
            std::string gr2SVG(const GRHandler handle, int page, bool embedfont = true, const int mappingMode = 0);
 
            std::string gr2SVGColored(const GRHandler handle, int page, int r, int g, int b, bool embedfont=true);
 
            GuidoErrCode abstractExport(const GRHandler handle, int page, std::ostream& out);
 
            std::string abstractExport(const GRHandler handle, int page);
 
            GuidoErrCode binaryExport(const GRHandler handle, int page, std::ostream& out);
 
            std::string binaryExport(const GRHandler handle, int page);
 
#ifdef CANVASSYSTEM
 
            GuidoErrCode javascriptExport(const GRHandler handle, int page);
#endif
 
            void setDrawBoundingBoxes(int bbMap);
 
            int getDrawBoundingBoxes();
 
            GuidoPageFormat getPageFormat(CGRHandler inHandleGR, int pageNum);
 
            void setDefaultPageFormat(const GuidoPageFormat &format);
 
            GuidoPageFormat getDefaultPageFormat();
 
 
            float unit2CM(float val);
 
            float cm2Unit(float val);
 
            float unit2Inches(float val);
 
            float inches2Unit(float val);
 
            GuidoErrCode resizePageToMusic( GRHandler inHandleGR );
            GuidoVersion    getVersion();
            std::string     getVersionStr();
 
            GuidoErrCode checkVersionNums(int major, int minor, int sub);
 
 
            float getLineSpace();
 
 
            GuidoErrCode markVoice( ARHandler inHandleAR, int voicenum,
                                                    const GuidoDate & date, const GuidoDate & duration,
                                                    unsigned char red, unsigned char green, unsigned char blue );
 
 
            GuidoErrCode setSymbolPath(ARHandler inHandleAR, const std::vector<std::string> &inPaths);
 
 
            std::vector<std::string> getSymbolPath(const ARHandler inHandleAR);
 
            long getParsingTime (const ARHandler ar);
 
            long getAR2GRTime(const GRHandler gr);
 
            long getOnDrawTime(const GRHandler gr);
 
            GuidoParser * openParser();
 
            GuidoErrCode closeParser(GuidoParser *p);
 
            ARHandler file2AR(GuidoParser *parser, const std::string &file);
 
            ARHandler string2AR(GuidoParser *parser, const std::string &gmnCode);
 
            std::string getStream(const GuidoStream *gStream) const;
 
            ARHandler stream2AR(GuidoParser *p, GuidoStream* stream);
 
            ParserError parserGetErrorCode(GuidoParser *p);
 
            GuidoStream * openStream ();
 
            GuidoErrCode closeStream (GuidoStream *s);
 
            GuidoErrCode writeStream (GuidoStream *s, const std::string &str);
 
            GuidoErrCode resetStream (GuidoStream *s);
 
};
#endif // GUIDOENGINEADAPTER_H