OmniSciDB  1dac507f6e
 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,
60 };
61 
63 
65  public:
66  ExtensionFunction(const std::string& name,
67  const std::vector<ExtArgumentType>& args,
68  const ExtArgumentType ret)
69  : name_(name), args_(args), ret_(ret) {}
70 
71  const std::string& getName() const { return name_; }
72 
73  const std::vector<ExtArgumentType>& getArgs() const { return args_; }
74 
75  const ExtArgumentType getRet() const { return ret_; }
76  std::string toString() const;
77 
78  private:
79  const std::string name_;
80  const std::vector<ExtArgumentType> args_;
82 };
83 
85  public:
86  static void add(const std::string& json_func_sigs);
87 
88  static void addUdfs(const std::string& json_func_sigs);
89 
90  static void clearRTUdfs();
91  static void addRTUdfs(const std::string& json_func_sigs);
92 
93  static std::vector<ExtensionFunction>* get(const std::string& name);
94 
95  static std::vector<ExtensionFunction>* get_udf(const std::string& name);
96 
97  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name);
98 
99  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
100  size_t arity);
101 
102  static std::vector<ExtensionFunction> get_ext_funcs(const std::string& name,
103  size_t arity,
104  const SQLTypeInfo& rtype);
105 
106  static std::string toString(const std::vector<ExtensionFunction>& ext_funcs,
107  std::string tab = "");
108  static std::string toString(const std::vector<SQLTypeInfo>& arg_types);
109  static std::string toString(const std::vector<ExtArgumentType>& sig_types);
110 
111  static std::vector<std::string> getLLVMDeclarations(
112  const std::unordered_set<std::string>& udf_decls);
113 
114  private:
115  static void addCommon(
116  std::unordered_map<std::string, std::vector<ExtensionFunction>>& sigs,
117  const std::string& json_func_sigs);
118 
119  private:
120  // Function overloading not supported, they're uniquely identified by name.
121  static std::unordered_map<std::string, std::vector<ExtensionFunction>> functions_;
122  static std::unordered_map<std::string, std::vector<ExtensionFunction>> udf_functions_;
123  static std::unordered_map<std::string, std::vector<ExtensionFunction>>
125 };
126 
127 #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)