URI.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 PRTX_URI_H_
#define PRTX_URI_H_

#include "prtx/prtx.h"

#include <string>
#include <vector>
#include <memory>
#include <map>

#ifdef _MSC_VER
#   pragma warning(push)
#   pragma warning(disable : 4251 4231 4660)
#endif


namespace prtx {


class URI;
typedef std::shared_ptr<URI> URIPtr;        
typedef std::vector<URIPtr>  URIPtrVector;  


class PRTX_EXPORTS_API URI {
public:
    static const std::wstring   SCHEME_FILE;            
    static const std::wstring   SCHEME_SAMBA;           
    static const std::wstring   SCHEME_UNC;             
    static const std::wstring   SCHEME_MEMORY;          
    static const std::wstring   SCHEME_RPK;             
    static const std::wstring   SCHEME_ZIP;             
    static const std::wstring   SCHEME_DATA;            
    static const std::wstring   SCHEME_BUILTIN;         

    static const std::wstring   QUERY_TEXTURE_WIDTH;
    static const std::wstring   QUERY_TEXTURE_HEIGHT;
    static const std::wstring   QUERY_TEXTURE_FORMAT;
    static const std::wstring   QUERY_TEXTURE_NAME;

    static const std::wstring   DELIM_SCHEME;           
    static const std::wstring   DELIM_QUERY;            
    static const std::wstring   DELIM_QUERY_ITEM;       
    static const std::wstring   DELIM_FRAGMENT;         
    static const std::wstring   DELIM_FRAGMENT_ITEM;    
    static const std::wstring   DELIM_ENTRY;            

public:
    static URIPtr create();


    static URIPtr create(const std::wstring& fullURI);


    // -- STATE OBSERVERS

    virtual bool isValid() const = 0;

    virtual bool isFilePath() const = 0;


    // -- COMPOSITE SUPPORT

    virtual bool isComposite() const = 0;

    virtual URIPtr getNestedURI() const = 0;


    // -- STRING OUTPUT

    virtual const std::wstring& wstring() const = 0;

    virtual std::string string() const = 0;

    virtual std::wstring getNativeFormat() const = 0;


    // --- COMPONENT OBSERVERS

    virtual const std::wstring& getScheme() const = 0;

    virtual const std::wstring& getHost() const = 0;

    virtual std::wstring getPath() const = 0;

    virtual std::wstring getBaseName() const = 0;

    virtual const std::wstring& getExtension() const = 0;

    virtual bool hasQuery() const = 0;

    virtual const std::wstring& getQuery() const = 0;

    virtual std::wstring getQuery(const std::wstring& key) const = 0;

    virtual bool hasFragment() const = 0;

    virtual const std::wstring& getFragment() const = 0;

    virtual std::wstring getFragment(const std::wstring &key) const = 0;

public:
    virtual ~URI() = default;

protected:
    URI() = default;
    URI(const URI&) = default;
};


namespace URIUtils {


PRTX_EXPORTS_API URIPtr createFileURI(const std::wstring& percentEncodedAbsolutePath);


PRTX_EXPORTS_API URIPtr createBuiltinURI(const std::wstring& name);


PRTX_EXPORTS_API URIPtr createMemoryURI(const uint8_t* ptr, size_t size, const std::wstring& ext);


PRTX_EXPORTS_API URIPtr createDataURI(const std::string& mediaType, bool base64, const uint8_t* data, size_t dataSize);


PRTX_EXPORTS_API URIPtr createCompositeURI(
        const URIPtr&       nestedURI,
        const std::wstring& outerScheme,       
        const std::wstring& outerPath,         
        const std::wstring& outerQuery = {},   
        const std::wstring& outerFragment = {} 
);


PRTX_EXPORTS_API URIPtr replaceFilename(const URIPtr& uri, const std::wstring& newFileName);


PRTX_EXPORTS_API URIPtr replaceExtension(const URIPtr& uri, const std::wstring& newExtWithSep);


PRTX_EXPORTS_API URIPtr addQuery(const URIPtr& uri, const std::wstring& key, const std::wstring& value);


PRTX_EXPORTS_API URIPtr addQuery(const URIPtr& uri, const std::map<std::wstring, std::wstring>& queries);


PRTX_EXPORTS_API URIPtr addQuery(const URIPtr& uri, const std::wstring& query);


PRTX_EXPORTS_API URIPtr removeQuery(const URIPtr& uri);


PRTX_EXPORTS_API URIPtr addFragment(const URIPtr& uri, const std::wstring& key, const std::wstring& value);


PRTX_EXPORTS_API URIPtr addFragment(const URIPtr& uri, const std::map<std::wstring, std::wstring>& fragments);


PRTX_EXPORTS_API URIPtr addFragment(const URIPtr& uri, const std::wstring& fragment);


PRTX_EXPORTS_API URIPtr removeFragment(const URIPtr& uri);


PRTX_EXPORTS_API void parseMemoryURI(
        const URIPtr&   uri,        
        const uint8_t*& address,    
        size_t&         byteCount   
);


PRTX_EXPORTS_API std::string percentEncode(const std::string& s);


PRTX_EXPORTS_API std::wstring percentEncode(const std::wstring& s);


PRTX_EXPORTS_API std::string percentDecode(const std::string& percentEncodedString);


PRTX_EXPORTS_API uint64_t getUniqueId();


} // namespace URIUtils


} // namespace prtx


#ifdef _MSC_VER
#   pragma warning(pop)
#endif


#endif /* PRTX_URI_H_ */