Qore Programming Language - C/C++ Library  0.8.13.2
QoreType.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreType.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2017 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 QoreBigIntNode* Zero;
47 DLLEXPORT extern QoreFloatNode* ZeroFloat;
48 DLLEXPORT extern QoreNumberNode* ZeroNumber, * InfinityNumber, * NaNumber, * piNumber;
49 
50 DLLEXPORT extern QoreString NothingTypeString, NullTypeString, TrueString,
51  FalseString, EmptyHashString, EmptyListString;
52 
53 DLLEXPORT extern const QoreTypeInfo* anyTypeInfo,
54  *autoTypeInfo,
55  *bigIntTypeInfo,
56  *floatTypeInfo,
57  *boolTypeInfo,
58  *stringTypeInfo,
59  *binaryTypeInfo,
60  *dateTypeInfo,
61  *objectTypeInfo,
62  *hashTypeInfo,
63  *autoHashTypeInfo,
64  *listTypeInfo,
65  *autoListTypeInfo,
66  *nothingTypeInfo,
67  *nullTypeInfo,
68  *numberTypeInfo,
69  *runTimeClosureTypeInfo,
70  *callReferenceTypeInfo,
71  *referenceTypeInfo,
72  *codeTypeInfo, // either closure or callref
73  *softBigIntTypeInfo, // converts to int from float, string, bool, number, and null
74  *softFloatTypeInfo, // converts to float from int, string, bool, number, and null
75  *softNumberTypeInfo, // converts to number from int, string, bool, float, and null
76  *softBoolTypeInfo, // converts to bool from int, float, string, number, and null
77  *softStringTypeInfo, // converts to string from int, float, bool, number, and null
78  *softDateTypeInfo, // converts to date from int, float, bool, string, number, and null
79  *softListTypeInfo, // converts NOTHING -> empty list, list -> the same list, and everything else: list(arg)
80  *softAutoListTypeInfo,
81  *dataTypeInfo, // either string or binary
82  *timeoutTypeInfo, // accepts int or date and returns int giving timeout in milliseconds
83  *bigIntOrFloatTypeInfo, // accepts int or float and returns the same
84  *bigIntFloatOrNumberTypeInfo, // accepts int or float and returns the same
85  *floatOrNumberTypeInfo, // accepts float or number and returns the same
86 
87  *bigIntOrNothingTypeInfo,
88  *floatOrNothingTypeInfo,
89  *numberOrNothingTypeInfo,
90  *stringOrNothingTypeInfo,
91  *boolOrNothingTypeInfo,
92  *binaryOrNothingTypeInfo,
93  *objectOrNothingTypeInfo,
94  *dateOrNothingTypeInfo,
95  *hashOrNothingTypeInfo,
96  *autoHashOrNothingTypeInfo,
97  *listOrNothingTypeInfo,
98  *autoListOrNothingTypeInfo,
99  *nullOrNothingTypeInfo,
100  *codeOrNothingTypeInfo,
101  *dataOrNothingTypeInfo,
102  *referenceOrNothingTypeInfo,
103 
104  *softBigIntOrNothingTypeInfo,
105  *softFloatOrNothingTypeInfo,
106  *softNumberOrNothingTypeInfo,
107  *softBoolOrNothingTypeInfo,
108  *softStringOrNothingTypeInfo,
109  *softDateOrNothingTypeInfo,
110  *softListOrNothingTypeInfo,
111  *softAutoListOrNothingTypeInfo,
112  *timeoutOrNothingTypeInfo;
113 
114 DLLEXPORT qore_type_t get_next_type_id();
115 
117 DLLEXPORT bool compareHard(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
119 DLLEXPORT bool compareSoft(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
121 DLLEXPORT bool q_compare_soft(const QoreValue l, const QoreValue r, ExceptionSink* xsink);
122 
123 static inline AbstractQoreNode* boolean_false() {
124  return &False;
125 }
126 
127 static inline AbstractQoreNode* boolean_true() {
128  return &True;
129 }
130 
131 static inline QoreBigIntNode* zero() {
132  Zero->ref();
133  return Zero;
134 }
135 
136 static inline QoreFloatNode* zero_float() {
137  ZeroFloat->ref();
138  return ZeroFloat;
139 }
140 
141 static inline QoreNumberNode* zero_number() {
142  ZeroNumber->ref();
143  return ZeroNumber;
144 }
145 
146 static inline DateTimeNode* zero_date() {
147  ZeroDate->ref();
148  return ZeroDate;
149 }
150 
151 static inline class QoreStringNode* null_string() {
152  NullString->ref();
153  return NullString;
154 }
155 
156 static inline QoreListNode* empty_list() {
157  emptyList->ref();
158  return emptyList;
159 }
160 
161 static inline QoreHashNode* empty_hash() {
162  emptyHash->ref();
163  return emptyHash;
164 }
165 
166 static inline QoreNumberNode* pi_number() {
167  piNumber->ref();
168  return piNumber;
169 }
170 
172 enum qore_type_result_e {
173  QTI_IGNORE = -2,
174  QTI_UNASSIGNED = -1,
175 
176  QTI_NOT_EQUAL = 0,
177  QTI_WILDCARD = 1,
178  QTI_AMBIGUOUS = 2,
179  QTI_NEAR = 3,
180  QTI_IDENT = 4
181 };
182 
183 DLLEXPORT int testObjectClassAccess(const QoreObject* obj, const QoreClass* classtoaccess);
184 
185 DLLEXPORT const QoreClass* typeInfoGetUniqueReturnClass(const QoreTypeInfo* typeInfo);
186 DLLEXPORT bool typeInfoHasType(const QoreTypeInfo* typeInfo);
187 DLLEXPORT const char* typeInfoGetName(const QoreTypeInfo* typeInfo);
188 DLLEXPORT qore_type_result_e typeInfoAcceptsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
189 DLLEXPORT qore_type_result_e typeInfoReturnsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
190 
191 DLLEXPORT const QoreTypeInfo* qore_get_or_nothing_type(const QoreTypeInfo* typeInfo);
192 
193 // @since %Qore 0.8.13
194 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_type(const QoreTypeInfo* valueTypeInfo);
195 // @since %Qore 0.8.13
196 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
197 // @since %Qore 0.8.13
198 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_type(const QoreTypeInfo* valueTypeInfo);
199 // @since %Qore 0.8.13
200 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
201 // @since %Qore 0.8.13
202 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_type(const QoreTypeInfo* valueTypeInfo);
203 // @since %Qore 0.8.13
204 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
205 // @since %Qore 0.8.13
206 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_type(const QoreTypeInfo* valueTypeInfo);
207 // @since %Qore 0.8.13
208 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
209 
210 // @since %Qore 0.8.13.1
211 DLLEXPORT const QoreTypeInfo* qore_get_type_from_string(const char* str);
212 
213 #endif // _QORE_QORETYPE_H
Qore&#39;s arbitrary-precision number value type, dynamically-allocated only, reference counted...
Definition: QoreNumberNode.h:51
Qore&#39;s floating-point value type, dynamically-allocated only, reference counted.
Definition: QoreFloatNode.h:39
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:50
DLLEXPORT QoreBoolFalseNode False
Qore&#39;s boolean false value.
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
Qore&#39;s string type supported by the QoreEncoding class.
Definition: QoreString.h:82
Qore&#39;s string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
DLLEXPORT QoreBoolTrueNode True
Qore&#39;s boolean true value.
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
Qore&#39;s parse tree/value type for date-time values, reference-counted, dynamically-allocated only...
Definition: DateTimeNode.h:45
defines a Qore-language class
Definition: QoreClass.h:214
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:112
the implementation of Qore&#39;s object data type, reference counted, dynamically-allocated only ...
Definition: QoreObject.h:62
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:47
DLLEXPORT void ref() const
increments the reference count
int16_t qore_type_t
used to identify unique Qore data and parse types (descendents of AbstractQoreNode) ...
Definition: common.h:71
this class implements Qore&#39;s 64-bit integer data type, reference-counted, dynamically-allocated only ...
Definition: QoreBigIntNode.h:41