OmniSciDB  addbbd5075
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ExtensionFunctionsWhitelist.h
Go to the documentation of this file.
1 /*
2  * Copyright 2017 MapD Technologies, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /*
18  * @file ExtensionFunctionsWhitelist.h
19  * @author Alex Suhan <alex@mapd.com>
20  * @brief Supported runtime functions management and retrieval.
21  *
22  * Copyright (c) 2016 MapD Technologies, Inc. All rights reserved.
23  */
24 
25 #ifndef QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
26 #define QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
27 
28 #include <string>
29 #include <unordered_map>
30 #include <unordered_set>
31 #include <vector>
32 
33 #include "../Shared/sqltypes.h"
34 
35 enum class ExtArgumentType {
36  Int8,
37  Int16,
38  Int32,
39  Int64,
40  Float,
41  Double,
42  Void,
43  PInt8,
44  PInt16,
45  PInt32,
46  PInt64,
47  PFloat,
48  PDouble,
49  Bool,
50  ArrayInt8,
51  ArrayInt16,
52  ArrayInt32,
53  ArrayInt64,
54  ArrayFloat,
56  GeoPoint,
58  Cursor,
59  GeoPolygon,
61 };
62 
64 
66  public:
67  ExtensionFunction(const std::string& name,
68  const std::vector<ExtArgumentType>& args,
69  const ExtArgumentType ret)
70  : name_(name), args_(args), ret_(ret) {}
71 
72  const std::string& getName() const { return name_; }
73 
74  const std::vector<ExtArgumentType>& getArgs() const { return args_; }
75 
76  const ExtArgumentType getRet() const { return ret_; }
77  std::string toString() const;
78 
79  private:
80  const std::string name_;
81  const std::vector<ExtArgumentType> args_;
83 };
84 
86  public:
87  static void add(const std::string& json_func_sigs);
88 
89  static void addUdfs(const std::string& json_func_sigs);
90 
91  static void clearRTUdfs();
92  static void addRTUdfs(const std::string& json_func_sigs);
93 
94  static std::vector<ExtensionFunction>* get(const std::string& name);
95 
96  static std::vector<ExtensionFunction>* get_udf(const std::string& name);
97 
98  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name);
99 
100  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
101  size_t arity);
102 
103  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
104  size_t arity,
105  const SQLTypeInfo& rtype);
106 
107  static std::string toString(const std::vector<ExtensionFunction>& ext_funcs,
108  std::string tab = "");
109  static std::string toString(const std::vector<SQLTypeInfo>& arg_types);
110  static std::string toString(const std::vector<ExtArgumentType>& sig_types);
111 
112  static std::vector<std::string> getLLVMDeclarations(
113  const std::unordered_set<std::string>& udf_decls);
114 
115  private:
116  static void addCommon(
117  std::unordered_map<std::string, std::vector<ExtensionFunction>>& sigs,
118  const std::string& json_func_sigs);
119 
120  private:
121  // Function overloading not supported, they're uniquely identified by name.
122  static std::unordered_map<std::string, std::vector<ExtensionFunction>> functions_;
123  static std::unordered_map<std::string, std::vector<ExtensionFunction>> udf_functions_;
124  static std::unordered_map<std::string, std::vector<ExtensionFunction>>
126 };
127 
128 #endif // QUERYENGINE_EXTENSIONFUNCTIONSWHITELIST_H
static void addUdfs(const std::string &json_func_sigs)
const std::vector< ExtArgumentType > & getArgs() const
const std::string & getName() const
static std::vector< ExtensionFunction > get_ext_funcs(const std::string &name)
static std::unordered_map< std::string, std::vector< ExtensionFunction > > udf_functions_
const ExtArgumentType getRet() const
static std::unordered_map< std::string, std::vector< ExtensionFunction > > rt_udf_functions_
const std::vector< ExtArgumentType > args_
static void add(const std::string &json_func_sigs)
static std::unordered_map< std::string, std::vector< ExtensionFunction > > functions_
static std::vector< ExtensionFunction > * get_udf(const std::string &name)
ExtensionFunction(const std::string &name, const std::vector< ExtArgumentType > &args, const ExtArgumentType ret)
static void addCommon(std::unordered_map< std::string, std::vector< ExtensionFunction >> &sigs, const std::string &json_func_sigs)
const ExtArgumentType ret_
static std::string toString(const std::vector< ExtensionFunction > &ext_funcs, std::string tab="")
static std::vector< std::string > getLLVMDeclarations(const std::unordered_set< std::string > &udf_decls)
SQLTypeInfo ext_arg_type_to_type_info(const ExtArgumentType ext_arg_type)
static void addRTUdfs(const std::string &json_func_sigs)