Qore Programming Language - C/C++ Library  0.9.3
QoreType.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreType.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2018 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  *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 QoreNumberNode* zero_number() {
124  ZeroNumber->ref();
125  return ZeroNumber;
126 }
127 
128 static inline DateTimeNode* zero_date() {
129  ZeroDate->ref();
130  return ZeroDate;
131 }
132 
133 static inline class QoreStringNode* null_string() {
134  NullString->ref();
135  return NullString;
136 }
137 
138 static inline QoreListNode* empty_list() {
139  emptyList->ref();
140  return emptyList;
141 }
142 
143 static inline QoreHashNode* empty_hash() {
144  emptyHash->ref();
145  return emptyHash;
146 }
147 
148 static inline QoreNumberNode* pi_number() {
149  piNumber->ref();
150  return piNumber;
151 }
152 
154 enum qore_type_result_e {
155  QTI_IGNORE = -2,
156  QTI_UNASSIGNED = -1,
157 
158  QTI_NOT_EQUAL = 0,
159  QTI_WILDCARD = 1,
160  QTI_AMBIGUOUS = 2,
161  QTI_NEAR = 3,
162  QTI_IDENT = 4
163 };
164 
165 DLLEXPORT int testObjectClassAccess(const QoreObject* obj, const QoreClass* classtoaccess);
166 
167 DLLEXPORT const QoreClass* typeInfoGetUniqueReturnClass(const QoreTypeInfo* typeInfo);
168 DLLEXPORT bool typeInfoHasType(const QoreTypeInfo* typeInfo);
169 DLLEXPORT const char* typeInfoGetName(const QoreTypeInfo* typeInfo);
170 DLLEXPORT qore_type_result_e typeInfoAcceptsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
171 DLLEXPORT qore_type_result_e typeInfoReturnsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
172 
173 DLLEXPORT const QoreTypeInfo* qore_get_or_nothing_type(const QoreTypeInfo* typeInfo);
174 
175 // @since %Qore 0.8.13
176 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_type(const QoreTypeInfo* valueTypeInfo);
177 // @since %Qore 0.8.13
178 DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
179 // @since %Qore 0.8.13
180 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_type(const QoreTypeInfo* valueTypeInfo);
181 // @since %Qore 0.8.13
182 DLLEXPORT const QoreTypeInfo* qore_get_complex_list_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
183 // @since %Qore 0.8.13
184 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_type(const QoreTypeInfo* valueTypeInfo);
185 // @since %Qore 0.8.13
186 DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
187 // @since %Qore 0.8.13
188 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_type(const QoreTypeInfo* valueTypeInfo);
189 // @since %Qore 0.8.13
190 DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
191 
192 // @since %Qore 0.8.13.1
193 DLLEXPORT const QoreTypeInfo* qore_get_type_from_string(const char* str);
194 
195 #endif // _QORE_QORETYPE_H
Qore's arbitrary-precision number value type, dynamically-allocated only, reference counted.
Definition: QoreNumberNode.h:51
This is the hash or associative list container type in Qore, dynamically allocated only,...
Definition: QoreHashNode.h:50
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
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
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
Qore'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:237
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:262
the implementation of Qore's object data type, reference counted, dynamically-allocated only
Definition: QoreObject.h:61
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:46
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:70