FileLocationHandler.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  FileLocationHandler Copyright 2021 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
namespace FileLocationHandler {
public hashdecl FileHandlerOptionInfo {
    string type;
 
    bool required = False;
 
    string desc;
 
    auto default_value;
};
 
public hashdecl FileHandlerInfo {
    string scheme;
    *hash<string, hash<FileHandlerOptionInfo>> read_options;
    *hash<string, hash<FileHandlerOptionInfo>> write_options;
};
 
class AbstractFileLocationHandler {
 
public:
 
    string getTextFile(string scheme, string location, *hash<auto> opts);
 
 
 
    binary getBinaryFile(string scheme, string location, *hash<auto> opts);
 
 
 
    Qore::StreamReader getStreamReader(string scheme, string location, *hash<auto> opts);
 
 
 
    Qore::InputStream getBinaryStream(string scheme, string location, *hash<auto> opts);
 
 
 
    writeFile(string scheme, string location, data contents, *hash<auto> opts);
 
 
 
    OutputStreamWrapper getOutputStream(string scheme, string location, *hash<auto> opts);
 
 
 
    hash<string, hash<FileHandlerOptionInfo>> getReadOptions();
 
 
 
    hash<string, hash<FileHandlerOptionInfo>> getWriteOptions();
 
 
protected:
      static string forceEncoding(string str, *string encoding);
public:
 
 
 
protected:
     abstract string getTextFileImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
protected:
     abstract binary getBinaryFileImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
protected:
     abstract Qore::StreamReader getStreamReaderImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
protected:
     abstract Qore::InputStream getBinaryStreamImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
protected:
     abstract writeFileImpl(string scheme, string location, data contents, *hash<auto> opts);
public:
 
 
protected:
     abstract OutputStreamWrapper getOutputStreamImpl(string scheme, string location, *hash<auto> opts);
public:
 
 
protected:
     abstract hash<string, hash<FileHandlerOptionInfo>> getReadOptionsImpl();
public:
 
 
protected:
     abstract hash<string, hash<FileHandlerOptionInfo>> getWriteOptionsImpl();
public:
};
 
class FileLocationHandler {
 
public:
protected:
 
        static hash<string, AbstractFileLocationHandler> cache;
 
        static Mutex handler_lock();
 
        static bool dynamic_init;
 
public:
 
      static init();
 
 
      static registerHandler(string scheme, AbstractFileLocationHandler handler);
 
 
      static bool tryRegisterHandler(string scheme, AbstractFileLocationHandler handler);
 
 
      static list<string> getSupportedSchemes();
 
 
      static bool isSchemeSupported(string scheme);
 
 
      static string getTextFileFromLocation(string location);
 
 
      static binary getBinaryFileFromLocation(string location);
 
 
      static data getFileFromLocation(bool text, string location);
 
 
      static Qore::StreamReader getStreamReaderFromLocation(string location);
 
 
      static Qore::InputStream getBinaryStreamFromLocation(string location);
 
 
      static writeFileToLocation(string location, data contents);
 
 
      static OutputStreamWrapper getOutputStreamForLocation(string location);
 
 
      static list<string> getHandlerNames();
 
 
      static hash<string, hash<FileHandlerInfo>> getHandlers(*bool write);
 
 
      static hash<FileHandlerInfo> getHandlerInfo(string scheme);
 
 
protected:
      static hash<InternallLocationInfo> getInfo(string location, bool read);
public:
 
 
protected:
      static *hash<auto> getOptions(reference<string> location);
public:
 
 
protected:
      static checkDynamicInit();
public:
 
};
};
 
namespace Priv {
hashdecl InternallLocationInfo {
    string scheme;
    string location;
    *hash<auto> opts;
    AbstractFileLocationHandler handler;
}
};