Qore Programming Language - C/C++ Library 2.0.0
Loading...
Searching...
No Matches
QoreType.h
1/* -*- mode: c++; indent-tabs-mode: nil -*- */
2/*
3 QoreType.h
4
5 Qore Programming Language
6
7 Copyright (C) 2003 - 2024 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
42DLLEXPORT extern QoreListNode* emptyList;
43DLLEXPORT extern QoreHashNode* emptyHash;
44DLLEXPORT extern QoreStringNode* NullString;
45DLLEXPORT extern DateTimeNode* ZeroDate;
46DLLEXPORT extern QoreNumberNode* ZeroNumber, * InfinityNumber, * NaNumber, * piNumber;
47
48DLLEXPORT extern QoreString NothingTypeString, NullTypeString, TrueString,
49 FalseString, EmptyHashString, EmptyListString;
50
51DLLEXPORT 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 *hexBinaryTypeInfo,
74 *base64BinaryTypeInfo,
75 *base64UrlBinaryTypeInfo,
76 *softBinaryTypeInfo, // converts to binary from string and null
77 *softBigIntTypeInfo, // converts to int from float, string, bool, number, and null
78 *softFloatTypeInfo, // converts to float from int, string, bool, number, and null
79 *softNumberTypeInfo, // converts to number from int, string, bool, float, and null
80 *softBoolTypeInfo, // converts to bool from int, float, string, number, and null
81 *softStringTypeInfo, // converts to string from int, float, bool, number, and null
82 *softDateTypeInfo, // converts to date from int, float, bool, string, number, and null
83 *softListTypeInfo, // converts NOTHING -> empty list, list -> the same list, and everything else: list(arg)
84 *softAutoListTypeInfo,
85 *dataTypeInfo, // either string or binary
86 *timeoutTypeInfo, // accepts int or date and returns int giving timeout in milliseconds
87 *bigIntOrFloatTypeInfo, // accepts int or float and returns the same
88 *bigIntFloatOrNumberTypeInfo, // accepts int or float and returns the same
89 *floatOrNumberTypeInfo, // accepts float or number and returns the same
90
91 *bigIntOrNothingTypeInfo,
92 *floatOrNothingTypeInfo,
93 *numberOrNothingTypeInfo,
94 *stringOrNothingTypeInfo,
95 *boolOrNothingTypeInfo,
96 *binaryOrNothingTypeInfo,
97 *objectOrNothingTypeInfo,
98 *dateOrNothingTypeInfo,
99 *hashOrNothingTypeInfo,
100 *autoHashOrNothingTypeInfo,
101 *listOrNothingTypeInfo,
102 *autoListOrNothingTypeInfo,
103 *nullOrNothingTypeInfo,
104 *codeOrNothingTypeInfo,
105 *dataOrNothingTypeInfo,
106 *referenceOrNothingTypeInfo,
107
108 *hexBinaryOrNothingTypeInfo,
109 *base64BinaryOrNothingTypeInfo,
110 *base64UrlBinaryOrNothingTypeInfo,
111 *softBinaryOrNothingTypeInfo,
112 *softBigIntOrNothingTypeInfo,
113 *softFloatOrNothingTypeInfo,
114 *softNumberOrNothingTypeInfo,
115 *softBoolOrNothingTypeInfo,
116 *softStringOrNothingTypeInfo,
117 *softDateOrNothingTypeInfo,
118 *softListOrNothingTypeInfo,
119 *softAutoListOrNothingTypeInfo,
120 *timeoutOrNothingTypeInfo;
121
122DLLEXPORT qore_type_t get_next_type_id();
123
125DLLEXPORT bool compareHard(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
127DLLEXPORT bool compareSoft(const AbstractQoreNode* l, const AbstractQoreNode* r, ExceptionSink* xsink);
129DLLEXPORT bool q_compare_soft(const QoreValue l, const QoreValue r, ExceptionSink* xsink);
130
131static inline QoreNumberNode* zero_number() {
132 ZeroNumber->ref();
133 return ZeroNumber;
134}
135
136static inline DateTimeNode* zero_date() {
137 ZeroDate->ref();
138 return ZeroDate;
139}
140
141static inline class QoreStringNode* null_string() {
142 NullString->ref();
143 return NullString;
144}
145
146static inline QoreListNode* empty_list() {
147 emptyList->ref();
148 return emptyList;
149}
150
151static inline QoreHashNode* empty_hash() {
152 emptyHash->ref();
153 return emptyHash;
154}
155
156static inline QoreNumberNode* pi_number() {
157 piNumber->ref();
158 return piNumber;
159}
160
162enum qore_type_result_e {
163 QTI_IGNORE = -2,
164 QTI_UNASSIGNED = -1,
165
166 QTI_NOT_EQUAL = 0,
167 QTI_WILDCARD = 1,
168 QTI_AMBIGUOUS = 2,
169 QTI_NEAR = 3,
170 QTI_IDENT = 4
171};
172
173DLLEXPORT int testObjectClassAccess(const QoreObject* obj, const QoreClass* classtoaccess);
174
175DLLEXPORT const QoreClass* typeInfoGetUniqueReturnClass(const QoreTypeInfo* typeInfo);
176DLLEXPORT bool typeInfoHasType(const QoreTypeInfo* typeInfo);
177DLLEXPORT const char* typeInfoGetName(const QoreTypeInfo* typeInfo);
178DLLEXPORT const QoreTypeInfo* typeInfoGetElementType(const QoreTypeInfo* typeInfo);
179DLLEXPORT const TypedHashDecl* typeInfoGetTypedHash(const QoreTypeInfo* typeInfo);
180
181DLLEXPORT qore_type_result_e typeInfoAcceptsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
182DLLEXPORT qore_type_result_e typeInfoReturnsType(const QoreTypeInfo* typeInfo, const QoreTypeInfo* otherTypeInfo);
183
184// Returns a non "or nothing" type for the given "or nothing" type
189DLLEXPORT const QoreTypeInfo* qore_get_value_type(const QoreTypeInfo* typeInfo);
190
191DLLEXPORT const QoreTypeInfo* qore_get_or_nothing_type(const QoreTypeInfo* typeInfo);
192
193// @since %Qore 0.8.13
194DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_type(const QoreTypeInfo* valueTypeInfo);
195// @since %Qore 0.8.13
196DLLEXPORT const QoreTypeInfo* qore_get_complex_hash_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
197// @since %Qore 0.8.13
198DLLEXPORT const QoreTypeInfo* qore_get_complex_list_type(const QoreTypeInfo* valueTypeInfo);
199// @since %Qore 0.8.13
200DLLEXPORT const QoreTypeInfo* qore_get_complex_list_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
201// @since %Qore 0.8.13
202DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_type(const QoreTypeInfo* valueTypeInfo);
203// @since %Qore 0.8.13
204DLLEXPORT const QoreTypeInfo* qore_get_complex_softlist_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
205// @since %Qore 0.8.13
206DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_type(const QoreTypeInfo* valueTypeInfo);
207// @since %Qore 0.8.13
208DLLEXPORT const QoreTypeInfo* qore_get_complex_reference_or_nothing_type(const QoreTypeInfo* valueTypeInfo);
209
210// @since %Qore 0.9.4
211DLLEXPORT const QoreTypeInfo* qore_get_type_from_string(const char* str, ExceptionSink& xsink);
212
213// @since %Qore 1.0
214DLLEXPORT const QoreClass* type_info_get_return_class(const QoreTypeInfo* typeInfo);
215
216#endif // _QORE_QORETYPE_H
The base class for all value and parse types in Qore expression trees.
Definition AbstractQoreNode.h:57
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:47
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition ExceptionSink.h:50
defines a Qore-language class
Definition QoreClass.h:310
This is the hash or associative list container type in Qore, dynamically allocated only,...
Definition QoreHashNode.h:51
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:93
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:76
The main value class in Qore, designed to be passed by value.
Definition QoreValue.h:279