FileLocationHandler.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
/* FileLocationHandler Copyright 2022 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.
*/
// minimum required Qore version
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// strict argument handling
// enable all warnings
namespace FileLocationHandler {
class FileLocationHandler {
public:
protected:
static hash<string, code> cache;
static Mutex handler_lock();
public:
static registerHandler(string scheme, code 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);
protected:
static data getTextOrBin(data d, bool text, *string encoding);
public:
protected:
static *hash<auto> getOptions(reference<string> location);
public:
protected:
static string forceEncoding(string str, *string encoding);
public:
};
};
FileLocationHandler::FileLocationHandler::getFileFromLocation
static data getFileFromLocation(bool text, string location)
Returns the file data from the given location.
FileLocationHandler::FileLocationHandler::isSchemeSupported
static bool isSchemeSupported(string scheme)
Returns True if the scheme is supported.
FileLocationHandler::FileLocationHandler::cache
static hash< string, code > cache
The location handler cache; scheme -> handler;.
Definition: FileLocationHandler.qc.dox.h:41
FileLocationHandler::FileLocationHandler::getSupportedSchemes
static list< string > getSupportedSchemes()
Retuns a list of supported schemes.
FileLocationHandler::FileLocationHandler::getTextOrBin
static data getTextOrBin(data d, bool text, *string encoding)
Helper method to eturn data in the expected format.
FileLocationHandler::FileLocationHandler::getOptions
static *hash< auto > getOptions(reference< string > location)
Returns a hash option options from the location string.
FileLocationHandler::FileLocationHandler::registerHandler
static registerHandler(string scheme, code handler)
Register a new location handler.
FileLocationHandler::FileLocationHandler::getBinaryFileFromLocation
static binary getBinaryFileFromLocation(string location)
Returns binary data for the given file location.
FileLocationHandler::FileLocationHandler::handler_lock
static Mutex handler_lock()
The location handler lock to ensure atomic operations.
FileLocationHandler::FileLocationHandler::forceEncoding
static string forceEncoding(string str, *string encoding)
Returns a string tagged with the given encoding, if any.
FileLocationHandler::FileLocationHandler::getTextFileFromLocation
static string getTextFileFromLocation(string location)
Returns string data for the given file location.
binary
binary binary()
FileLocationHandler
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:32