Qore Programming Language - C/C++ Library  0.9.14
QoreType.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreType.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2020 Qore Technologies, s.r.o.
8 
9  Permission is hereby granted, free of charge, to any person obtaining a
10  copy of this software and associated documentation files (the "Software"),
11  to deal in the Software without restriction, including without limitation
12  the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  and/or sell copies of the Software, and to permit persons to whom the
14  Software is furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  DEALINGS IN THE SOFTWARE.
26 
27  Note that the Qore library is released under a choice of three open-source
28  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29  information.
30 */
31 
32 #ifndef _QORE_QORETYPE_H
33 
34 #define _QORE_QORETYPE_H
35 
36 #include <qore/common.h>
37 #include <qore/node_types.h>
38 
39 #include <map>
40 
41 // global default values
42 DLLEXPORT extern QoreListNode* emptyList;
43 DLLEXPORT extern QoreHashNode* emptyHash;
44 DLLEXPORT extern QoreStringNode* NullString;
45 DLLEXPORT extern DateTimeNode* ZeroDate;
46 DLLEXPORT extern QoreNumberNode* ZeroNumber, * InfinityNumber, * NaNumber, * piNumber;
47 
48 DLLEXPORT extern QoreString NothingTypeString, NullTypeString, TrueString,
49  FalseString, EmptyHashString, EmptyListString;
50 
51 DLLEXPORT extern const QoreTypeInfo* anyTypeInfo,
52  *autoTypeInfo,
53  *bigIntTypeInfo,
54  *floatTypeInfo,
55  *boolTypeInfo,
56  *stringTypeInfo,
57  *binaryTypeInfo,
58  *dateTypeInfo,
59  *objectTypeInfo,
60  *hashTypeInfo,
61  *emptyHashTypeInfo,
62  *autoHashTypeInfo,
63  *listTypeInfo,
64  *autoListTypeInfo,
65  *emptyListTypeInfo,
66  *nothingTypeInfo,
67  *nullTypeInfo,
68  *numberTypeInfo,
69  *runTimeClosureTypeInfo,
70  *callReferenceTypeInfo,
71  *referenceTypeInfo,
72  *codeTypeInfo, // either closure or callref
73  *softBinaryTypeInfo, // converts to binary from string and null
74  *softBigIntTypeInfo, // converts to int from float, string, bool, number, and null
75  *softFloatTypeInfo, // converts to float from int, string, bool, number, and null
76  *softNumberTypeInfo, // converts to number from int, string, bool, float, and null
77  *softBoolTypeInfo, // converts to bool from int, float, string, number, and null
78  *softStringTypeInfo, // converts to string from int, float, bool, number, and null
79  *softDateTypeInfo, // converts to date from int, float, bool, string, number, and null
80  *softListTypeInfo, // converts NOTHING -> empty list, list -> the same list, and everything else: list(arg)
81  *softAutoListTypeInfo,
82  *dataTypeInfo, // either string or binary
83  *timeoutTypeInfo, // accepts int or date and returns int giving timeout in milliseconds
84  *bigIntOrFloatTypeInfo, // accepts int or float and returns the same
85  *bigIntFloatOrNumberTypeInfo, // accepts int or float and returns the same
86  *floatOrNumberTypeInfo, // accepts float or number and returns the same
87 
88  *bigIntOrNothingTypeInfo,
89  *floatOrNothingTypeInfo,
90  *numberOrNothingTypeInfo,
91  *stringOrNothingTypeInfo,
92  *boolOrNothingTypeInfo,
93  *binaryOrNothingTypeInfo,
94  *objectOrNothingTypeInfo,
95  *dateOrNothingTypeInfo,
96  *hashOrNothingTypeInfo,
97  *autoHashOrNothingTypeInfo,
98  *listOrNothingTypeInfo,
99  *autoListOrNothingTypeInfo,
100  *nullOrNothingTypeInfo,
101  *codeOrNothingTypeInfo,
102  *dataOrNothingTypeInfo,
103  *referenceOrNothingTypeInfo,
104 
105  *softBinaryOrNothingTypeInfo,
106  *softBigIntOrNothingTypeInfo,
107  *softFloatOrNothingTypeInfo,
108  *softNumberOrNothingTypeInfo,
109  *softBoolOrNothingTypeInfo,
110  *softStringOrNothingTypeInfo,
111  *softDateOrNothingTypeInfo,
112  *softListOrNothingTypeInfo,
113  *softAutoListOrNothingTypeInfo,
114  *timeoutOrNothingTypeInfo;
115 
116 DLLEXPORT qore_type_t get_next_type_id();
117 
119 DLLEXPORT bool compareHard(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
121 DLLEXPORT bool compareSoft(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
123 DLLEXPORT bool q_compare_soft(const QoreValue l, const QoreValue r, ExceptionSink* xsink);
124 
125 static inline QoreNumberNode* zero_number() {
126  ZeroNumber->ref();
127  return ZeroNumber;
128 }
129 
130 static inline DateTimeNode* zero_date() {
131  ZeroDate->ref();
132  return ZeroDate;
133 }
134 
135 static inline class QoreStringNode* null_string() {
136  NullString->ref();
137  return NullString;
138 }
139 
140 static inline QoreListNode* empty_list() {
141  emptyList->ref();
142  return emptyList;
143 }
144 
145 static inline QoreHashNode* empty_hash() {
146  emptyHash->ref();
147  return emptyHash;
148 }
149 
150 static inline QoreNumberNode* pi_number() {
151  piNumber->ref();
152  return piNumber;
153 }
154 
156 enum qore_type_result_e {
157  QTI_IGNORE = -2,
158  QTI_UNASSIGNED = -1,
159 
160  QTI_NOT_EQUAL = 0,
161  QTI_WILDCARD = 1,
162  QTI_AMBIGUOUS = 2,
163  QTI_NEAR = 3,
164  QTI_IDENT = 4
165 };
166 
167 DLLEXPORT int testObjectClassAccess(const QoreObject* obj, const QoreClass* classtoaccess);
168 
169 DLLEXPORT const QoreClass* typeInfoGetUniqueReturnClass(const QoreTypeInfo* typeInfo);
170 DLLEXPORT bool typeInfoHasType(const QoreTypeInfo* typeInfo);
171 DLLEXPORT const char* typeInfoGetName(const QoreTypeInfo* typeInfo);
172 DLLEXPORT const QoreTypeInfo* typeInfoGetElementType(const QoreTypeInfo* typeInfo);
173 DLLEXPORT const TypedHashDecl* typeInfoGetTypedHash(const QoreTypeInfo* typeInfo);
174 
175 DLLEXPORT qore_type_result_e typeInfoAcceptsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
176 DLLEXPORT qore_type_result_e typeInfoReturnsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
177 
178 DLLEXPORT const QoreTypeInfo* qore_get_or_nothing_type(const QoreTypeInfo* typeInfo);
179 
180 // @since %Qore 0.8.13
181 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_type(const QoreTypeInfo* valueTypeInfo);
182 // @since %Qore 0.8.13
183 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
184 // @since %Qore 0.8.13
185 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_type(const QoreTypeInfo* valueTypeInfo);
186 // @since %Qore 0.8.13
187 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
188 // @since %Qore 0.8.13
189 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_type(const QoreTypeInfo* valueTypeInfo);
190 // @since %Qore 0.8.13
191 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
192 // @since %Qore 0.8.13
193 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_type(const QoreTypeInfo* valueTypeInfo);
194 // @since %Qore 0.8.13
195 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
196 
197 // @since %Qore 0.9.4
198 DLLEXPORT const QoreTypeInfo* qore_get_type_from_string(const char* str, ExceptionSink& xsink);
199 
200 #endif // _QORE_QORETYPE_H
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
DLLEXPORT void ref() const
increments the reference count
Qore's parse tree/value type for date-time values, reference-counted, dynamically-allocated only.
Definition: DateTimeNode.h:45
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
defines a Qore-language class
Definition: QoreClass.h:239
This is the hash or associative list container type in Qore, dynamically allocated only,...
Definition: QoreHashNode.h:50
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
Qore's arbitrary-precision number value type, dynamically-allocated only, reference counted.
Definition: QoreNumberNode.h:51
the implementation of Qore's object data type, reference counted, dynamically-allocated only
Definition: QoreObject.h:61
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:81
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
typed hash declaration
Definition: TypedHashDecl.h:44
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode)
Definition: common.h:70
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:262