Qore FileLocationHandler Module Reference  1.0
FileLocationHandler.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* FileLocationHandler Copyright 2020 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 // minimum required Qore version
26 // assume local scope for variables, do not use "$" signs
27 // require type definitions everywhere
28 // strict argument handling
29 // enable all warnings
30 
35 
36 public:
37 protected:
39 
41  static hash<string, code> cache;
42 
44  static Mutex handler_lock();
45 
46 public:
47 
49 
55  static registerHandler(string scheme, code handler);
56 
58 
60  static list<string> getSupportedSchemes();
61 
63 
67  static bool isSchemeSupported(string scheme);
68 
70 
76  static string getTextFileFromLocation(string location);
77 
79 
85  static binary getBinaryFileFromLocation(string location);
86 
88 
93  static data getFileFromLocation(bool text, string location);
94 
96 
102 protected:
103  static data getTextOrBin(data d, bool text, *string encoding);
104 public:
105 
106 
108 protected:
109  static *hash<auto> getOptions(reference<string> location);
110 public:
111 
112 
114 protected:
115  static string forceEncoding(string str, *string encoding);
116 public:
117 
118 };
119 };
binary binary()
static hash< string, code > cache
The location handler cache; scheme -> handler;.
Definition: FileLocationHandler.qc.dox.h:41
Contains all public definitions in the FileLocationHandler module.
Definition: FileLocationHandler.qc.dox.h:32