Callbacks.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRT_CALLBACKS_H_
#define PRT_CALLBACKS_H_

#include "prt/prt.h"
#include "prt/Status.h"
#include "prt/ContentType.h"
#include "prt/CGAErrorLevel.h"

#include <cstddef>
#include <cstdint>


namespace prt {
    class AttributeMap;


class PRT_EXPORTS_API Callbacks {
public:
    virtual Status generateError(size_t isIndex, Status status, const wchar_t* message) = 0;
    virtual Status assetError(size_t isIndex, CGAErrorLevel level, const wchar_t* key, const wchar_t* uri, const wchar_t* message) = 0;
    virtual Status cgaError(size_t isIndex, int32_t shapeID, CGAErrorLevel level, int32_t methodId, int32_t pc, const wchar_t* message) = 0;
    virtual Status cgaPrint(size_t isIndex, int32_t shapeID, const wchar_t* txt) = 0;
    virtual Status cgaReportBool(size_t isIndex, int32_t shapeID, const wchar_t* key, bool value) = 0;
    virtual Status cgaReportFloat(size_t isIndex, int32_t shapeID, const wchar_t* key, double value) = 0;
    virtual Status cgaReportString(size_t isIndex, int32_t shapeID, const wchar_t* key, const wchar_t* value) = 0;

    virtual Status attrBool(size_t isIndex, int32_t shapeID, const wchar_t* key, bool value) = 0;
    virtual Status attrFloat(size_t isIndex, int32_t shapeID, const wchar_t* key, double value) = 0;
    virtual Status attrString(size_t isIndex, int32_t shapeID, const wchar_t* key, const wchar_t* value) = 0;


    virtual Status attrBoolArray(size_t isIndex, int32_t shapeID, const wchar_t* key, const bool* ptr, size_t size, size_t nRows) = 0;
    virtual Status attrFloatArray(size_t isIndex, int32_t shapeID, const wchar_t* key, const double* ptr, size_t size, size_t nRows) = 0;
    virtual Status attrStringArray(size_t isIndex, int32_t shapeID, const wchar_t* key, const wchar_t* const* ptr, size_t size, size_t nRows) = 0;

    enum CoordSelector {
        PROJ_X,             
        PROJ_Y,             
        WGS84_LAT,          
        WGS84_LON,          
        WGS84_ALT_METER,    
        LAYER_X,            
        LAYER_Y,            
        LAYER_Z             
    };

    virtual double cgaGetCoord(size_t isIndex, CoordSelector sel, double x, double y, double z, Status* stat = 0);

    enum Continuation {
        CONTINUE,           
        CANCEL_AND_FINISH,  
        CANCEL_ASAP         
    };

    virtual Continuation progress(float percentageCompleted);


protected:
    Callbacks();
    virtual ~Callbacks();
};


class PRT_EXPORTS_API SimpleOutputCallbacks : public Callbacks {
public:
    enum StringEncoding {
        SE_NATIVE,  
        SE_UTF8,    
        SE_UTF16    
    };
    enum OpenMode {
        OPENMODE_ALWAYS,            
        OPENMODE_IF_NOT_EXISTING    
    };
    enum SeekOrigin {
        SO_BEGIN,   
        SO_CURRENT, 
        SO_END      
    };

    virtual bool canSeek() const = 0;
    virtual uint64_t open(const wchar_t* encoderId, const ContentType contentType, const wchar_t* name, StringEncoding enc = SE_NATIVE, OpenMode mode = OPENMODE_ALWAYS, prt::Status* stat = 0) = 0;
    virtual Status write(uint64_t handle, const wchar_t* string) = 0;
    virtual Status write(uint64_t handle, const uint8_t* buffer, size_t size) = 0;
    virtual Status seek(uint64_t handle, int64_t offset, SeekOrigin origin) = 0;
    virtual uint64_t tell(uint64_t handle, Status* stat = 0) = 0;
    virtual Status logStats(uint64_t handle, const size_t* isIndices, size_t isCount, ContentType contentType, const prt::AttributeMap* stats);
    virtual Status close(uint64_t handle, const size_t* isIndices, size_t isCount) = 0;

    virtual Status openCGAError(const wchar_t* name) = 0;
    virtual Status openCGAPrint(const wchar_t* name) = 0;
    virtual Status openCGAReport(const wchar_t* name) = 0;

    virtual Status closeCGAError() = 0;
    virtual Status closeCGAPrint() = 0;
    virtual Status closeCGAReport() = 0;

protected:
    SimpleOutputCallbacks();
    virtual ~SimpleOutputCallbacks();
};


} // namespace prt


#endif /* PRT_CALLBACKS_H_ */